DescribeAliasDomains

1. API Description

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

This API is used to query the information of alias domain names.

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: DescribeAliasDomains.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	The site ID.
Offset	No	Integer	The page offset. Default value: 0
Limit	No	Integer	The paginated query limit. Default value: 20. Maximum value: 1000.
Filters.N	No	Array of AdvancedFilter	Filter conditions. The maximum value for Filters.Values is 20. The detailed conditions are as follows: target-name: Filter by the target domain name; alias-name: Filter by the alias of the domain name. Fuzzy queries are only supported for the field name alias-name.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total eligible alias domain names.
AliasDomains	Array of AliasDomain	Information of the eligible alias domain names.
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 Querying the list of alias domain names

Input Example

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

{
    "ZoneId": "zone-28569s6od5na",
    "Limit": 20,
    "Filters": [
        {
            "Values": [
                "bbb.test.com"
            ],
            "Name": "alias-name"
        }
    ],
    "Offset": 0
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "5ce6ee51-cda5-4e0d-a338-cff57a00bb3a",
        "AliasDomains": [
            {
                "Status": "pending",
                "ModifiedOn": "2020-09-22T00:00:00+00:00",
                "TargetName": "aaa.example.com",
                "CreatedOn": "2020-09-22T00:00:00+00:00",
                "ZoneId": "zone-28569s6od5na",
                "AliasName": "bbb.test.com",
                "ForbidMode": 0
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	Internal error.
InternalError.ProxyServer	An unknown error occurred in the backend server.
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.
UnauthorizedOperation.Unknown	An unknown error occurred in the backend server.