DescribeSharedCNAME

1. API Description

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

Query the shared CNAME list, support fuzzy search, paginate, and sort.

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: DescribeSharedCNAME.
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	Shared CNAME associated site ID.
Filters.N	No	Array of AdvancedFilter	Filter criteria. The maximum value of Filters.Values is 20. The detailed filter criteria are as follows: shared-cname Filter by [shared CNAME]. Type: String Required: No type Filter by [shared CNAME type]. type: String Required: No Description Filter by [description]. Type: String Required: No
Direction	No	String	List sort method. Valid values: asc: ascending order; desc: Sort in descending order. The default value is `asc`.
Match	No	String	Match mode. Valid values: all: Returns the shared CNAME that matches all query conditions. any: Returns the shared CNAME that matches any query condition. Default value is all.
Order	No	String	Sorting basis. Valid values: create-time: Creation time; shared-cname: Shared CNAME. Default sorting order is based on the shared-cname attribute.
Offset	No	Integer	Offset of paginated query. Default value: 0.
Limit	No	Integer	Number limit of paginated query. Default value: 20. Upper limit: 200.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of shared CNAMEs that meet filtering criteria.
SharedCNAMEInfo	Array of SharedCNAMEInfo	Shared CNAME table detail.
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 shared CNAME list

Query the shared CNAME list

Input Example

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

{
    "Direction": "desc",
    "ZoneId": "zone-20hyebgyfsko",
    "Limit": 10,
    "Filters": [
        {
            "Fuzzy": true,
            "Values": [
                "qq.com"
            ],
            "Name": "shared-cname"
        }
    ],
    "Offset": 0,
    "Order": "create-time",
    "Match": "all"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "SharedCNAMEInfo": [
            {
                "SharedCNAME": "qq.com.share.eo.dnse5.com",
"Description": "Used for Business A scenario"
                "BindDomainCount": 3
            }
        ]
    }
}

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
UnauthorizedOperation.Unknown	An unknown error occurred in the backend server.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Querying the shared CNAME list
5. Developer Resources
SDK
Command Line Interface
6. Error Code