tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeForwardRuleList

最后更新时间：2024-11-07 18:45:56

1. API Description

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

This API is used to query the forwarding rule list.

A maximum of 10 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: DescribeForwardRuleList.
Version Yes String Common Params. The value used for this API: 2020-10-28.
Region No String Common Params. This parameter is not required for this API.
Offset No Integer Pagination offset, starting from 0.
Limit No Integer Pagination limit. Maximum value: 100. Default value: 20.
Filters.N No Array of Filter Filter parameters.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of private domains.
ForwardRuleSet Array of ForwardRule Private domain list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining the Private Domain List

Input Example

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

{
    "Limit": 200,
    "Offset": 0,
    "Filters": [
        {
            "Name": "RuleName",
            "Values": [
                "Haha."
            ]
        },
        {
            "Name": "RuleType",
            "Values": [
                "DOWN"
            ]
        },
        {
            "Name": "ZoneId",
            "Values": [
                "zone-04jlawty"
            ]
        },
        {
            "Name": "EndPointId",
            "Values": [
                "eid-asdfadaf"
            ]
        },
        {
            "Name": "EndPointName",
            "Values": [
                "zdjdhhh"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "8a4ea9cc-b1df-f8f8-ffe7efbe98f9ff85",
        "TotalCount": 5,
        "ForwardRuleSet": [
            {
                "Domain": "qq.com",
                "ZoneId": "zone-s8cs72d9",
                "RuleId": "fid-af2skm96n",
                "ForwardAddress": [
                    "1.1.1.1:53"
                ],
                "RuleType": "UP",
                "VpcSet": [
                    {
                        "Region": "ap-guangzhou",
                        "UniqVpcId": "vpc-dus89eks"
                    }
                ],
                "EndPointName": "Endpoint 1.",
                "EndPointId": "eid-fxiuf872bsp",
                "RuleName": "Forwarding rule name.",
                "UpdatedAt": "2022-09-09 10:45:44",
                "CreatedAt": "2022-09-09 10:45:44",
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ]
            }
        ]
    }
}

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 Error with CAM signature/authentication.
FailedOperation Operation failed.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
UnauthorizedOperation.UnauthorizedAccount Unverified user.
UnknownParameter Unknown parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款