tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeRules

最后更新时间：2023-07-13 15:25:26

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

This API (DescribeRules) is used to query all rule information of a listener, including the domain names, paths, and list of bound origin servers. For version 3.0 connections, this API returns the advanced authentication configuration information of the domain name.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeRules.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
ListenerId Yes String Layer-7 listener ID.

3. Output Parameters

Parameter Name Type Description
DomainRuleSet Array of DomainRuleSet Rule information list classified by domain name type
TotalCount Integer Total quantity of domain names under this listener
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying forwarding rule information

Input Example

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRules
<Common request parameters>

{
    "ListenerId": "listener-9jt0rtv9"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "DomainRuleSet": [
            {
                "GaapCertificateAlias": "xx",
                "Http3Supported": 0,
                "Domain": "xx",
                "CertificateId": "xx",
                "PolyRealServerCertificateAliasInfo": [
                    {
                        "CertificateId": "xx",
                        "CertificateAlias": "xx"
                    }
                ],
                "RealServerCertificateId": "xx",
                "BanStatus": "xx",
                "CertificateAlias": "xx",
                "ClientCertificateId": "xx",
                "GaapCertificateId": "xx",
                "BasicAuth": 1,
                "BasicAuthConfAlias": "xx",
                "BasicAuthConfId": "xx",
                "RealServerCertificateAlias": "xx",
                "RuleSet": [
                    {
                        "BindStatus": 1,
                        "Domain": "xx",
                        "RealServerType": "xx",
                        "ForwardHost": "xx",
                        "RuleId": "xx",
                        "HealthCheck": 1,
                        "ServerNameIndication": "xx",
                        "ListenerId": "xx",
                        "CheckParams": {
                            "Domain": "xx",
                            "ConnectTimeout": 1,
                            "BlockInter": 1,
                            "FailedThreshold": 1,
                            "Path": "xx",
                            "FailedCountInter": 1,
                            "Method": "xx",
                            "DelayLoop": 1,
                            "StatusCode": [
                                1,
                                1,
                                1,
                                1,
                                1
                            ]
                        },
                        "ForcedRedirect": "1",
                        "Scheduler": "xx",
                        "Path": "xx",
                        "RuleStatus": 1,
                        "ServerNameIndicationSwitch": "xx",
                        "RealServerSet": [
                            {
                                "RealServerStatus": 0,
                                "RealServerPort": 234,
                                "RealServerId": "xx",
                                "RealServerFailoverRole": "xx",
                                "DownIPList": [
                                    "xx"
                                ],
                                "RealServerWeight": 1,
                                "RealServerIP": "xx"
                            },
                            {
                                "RealServerStatus": 0,
                                "RealServerPort": 424,
                                "RealServerId": "xx",
                                "RealServerWeight": 1,
                                "RealServerFailoverRole": "xx",
                                "DownIPList": [
                                    "xx"
                                ],
                                "RealServerIP": "xx"
                            }
                        ]
                    }
                ],
                "PolyClientCertificateAliasInfo": [
                    {
                        "CertificateId": "xx",
                        "CertificateAlias": "xx"
                    }
                ],
                "GaapAuth": 1,
                "ClientCertificateAlias": "xx",
                "RealServerAuth": 1,
                "RealServerCertificateDomain": "xx",
                "DomainStatus": 1
            }
        ],
        "RequestId": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款