DescribeDomainCname - CDN - Alibaba Cloud Documentation Center

You can call this API to query the CNAME record of an accelerated domain name and verify its configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeDomainCname

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain names to query. To query multiple domain names, separate them with commas (,).	example.com,example.org

Response elements

Element	Type	Description	Example
	object	The results of the check.
RequestId	string	The request ID.	06D29681-B7CD-4034-A8CC-28AFFA213539
CnameDatas	object
Data	array<object>	An array of canonical name (CNAME) check results.
	object	The CNAME information.
Status	integer	The result of the CNAME check. Valid values: 0: The CNAME record assigned to the domain name was detected. 1: The CNAME record assigned to the domain name was not detected. -1: The CNAME check timed out.	0
Domain	string	The accelerated domain name in the request.	a.com
Cname	string	The CNAME record that is assigned to the domain name by Alibaba Cloud CDN.	a.com.w.alikunlun.net
Passed	string	Indicates whether the CNAME record passed the check. Valid values: true: Passed. false: Failed. timeout: Timed out.	true
ErrMsg	string	The error message returned if the CNAME check fails or times out.	timeout

Examples

Success response

JSON format

{
  "RequestId": "06D29681-B7CD-4034-A8CC-28AFFA213539",
  "CnameDatas": {
    "Data": [
      {
        "Status": 0,
        "Domain": "a.com",
        "Cname": "a.com.w.alikunlun.net",
        "Passed": "true",
        "ErrMsg": "timeout"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	DomainNameOverLimit	A maximum of 30 domains are supported for each request.
403	InvaildParameter	The parameter you provided is invalid.	The format of the domain name is invalid. Correct the format and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.