Use DescribeCdnDomainDetail to query accelerated domain name details - CDN

Queries an accelerated domain name.

Operation description

Note

Each account can call this operation up to 30 times per second.

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:DescribeCdnDomainDetail

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify only one domain name.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	18CF38AA-1275-451D-A12B-4EC0BF1C5E30
GetDomainDetailModel	object	The details about the accelerated domain name.
GmtCreated	string	The time when the domain name was created.	2015-06-25T03:30:50Z
Description	string	The description of the domain name.	Streaming domain
HttpsCname	string	The CNAME for which HTTPS is enabled.	example.com.w.kunlunle.com
ResourceGroupId	string	The ID of the resource group.	abcd1234abcd1234
ServerCertificateStatus	string	Indicates whether the SSL certificate is enabled. Valid values: on off	on
Scope	string	The acceleration region.	domestic
DomainStatus	string	The status of the accelerated domain name. Valid values: online offline configuring configure_failed checking check_failed stopping deleting	online
Cname	string	The CNAME that is assigned to the accelerated domain name. You must add the CNAME record in the system of your DNS service provider to map the accelerated domain name to the CNAME.	example.com.w.kunlunle.com
GmtModified	string	The time when the domain name was last modified.	2017-06-25T03:30:50Z
CdnType	string	The workload type of the accelerated domain name. Valid values: web: images and small files download: large files video: on-demand video and audio streaming	web
DomainName	string	The accelerated domain name.	example.com
SourceModels	object
SourceModel	array<object>	The information about the origin server.
	object
Type	string	The type of the origin server. Valid values: ipaddr: an origin IP address domain: an origin domain name oss: the domain name of an Object Storage Service (OSS) bucket fc_domain: a Function Compute domain name	domain
Weight	string	The weight of the origin server if multiple origin servers have been specified.	10
Enabled	string	The status.	online
Priority	string	The priority.	20
Port	integer	The port over which requests are redirected to the origin server. Ports 443 and 80 are supported.	80
Content	string	The address of the origin server.	example.com

Examples

Success response

JSON format

{
  "RequestId": "18CF38AA-1275-451D-A12B-4EC0BF1C5E30",
  "GetDomainDetailModel": {
    "GmtCreated": "2015-06-25T03:30:50Z",
    "Description": "Live streaming domain",
    "HttpsCname": "example.com.w.kunlunle.com",
    "ResourceGroupId": "abcd1234abcd1234",
    "ServerCertificateStatus": "on",
    "Scope": "domestic",
    "DomainStatus": "online",
    "Cname": "example.com.w.kunlunle.com",
    "GmtModified": "2017-06-25T03:30:50Z",
    "CdnType": "web",
    "DomainName": "example.com",
    "SourceModels": {
      "SourceModel": [
        {
          "Type": "domain",
          "Weight": "10",
          "Enabled": "online",
          "Priority": "20",
          "Port": 80,
          "Content": "example.com"
        }
      ]
    }
  }
}

Error response

JSON format

{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8","HostId":"cdn.aliyuncs.com","Code":"InternalError","Message":"The request processing has failed due to some unknown error."}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.