Call DescribeVodDomainDetail to query CDN domain details - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Retrieves the basic configuration information of a specified China domain name for video-on-demand (VOD) acceleration.

Operation description

Currently, the China service address supports only China (Shanghai).

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

vod:DescribeVodDomainDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The VOD acceleration domain name.	example.com

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	09ABE829-6CD3-4FE0-556113E2****
DomainDetail	object	The basic configuration information of the domain name.
GmtCreated	string	The time when the domain name was created. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-11-27T06:51:26Z
Weight	string	The back-to-origin weight.	1
SSLPub	string	The public key of the HTTPS certificate. This parameter is returned only if HTTPS secure acceleration is enabled.	yourSSLPub
Description	string	The description of the VOD acceleration domain name.	testDescription
SSLProtocol	string	Indicates whether the SSL certificate is enabled. Valid values: on: Enabled. off: Disabled.	on
CertName	string	The name of the HTTPS certificate. This parameter is returned only if HTTPS secure acceleration is enabled.	testCertName
Scope	string	The acceleration region. Valid values: domestic (default): the Chinese mainland only. overseas: global (excluding the Chinese mainland). global: global.	domestic
Cname	string	The CNAME assigned to the accelerated domain name. You must add a CNAME record with your DNS provider to map the accelerated domain name to this CNAME. For more information, see Configure a CNAME record.	example.com.w.alikunlun.net
DomainStatus	string	The status of the accelerated domain name. Valid values: online: enabled. offline: disabled. configuring: being configured. configure_failed: configuration failed. checking: being reviewed. check_failed: review failed.	online
GmtModified	string	The time when the domain name was last modified. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-11-27T06:55:26Z
DomainName	string	The VOD acceleration domain name.	example.com
Sources	object
Source	array<object>	The information about the origin server.
	object	The information about the origin server.
Type	string	The type of the origin server. Valid values: ipaddr: a server that you can access by using an IP address. domain: a server that you can access by using a domain name. oss: the URL of an Object Storage Service (OSS) bucket.	oss
Priority	string	The priority of the origin server.	50
Port	integer	The port number. Valid values: 443 and 80.	80
Content	string	The address of the origin server.	****.oss-cn-hangzhou.aliyuncs.com
Enabled	string	The status of the origin server. Valid values: online: indicates that the origin server is enabled. offline: indicates that the origin server is disabled.	online
Weight	string	The weight of the origin server if multiple origin servers have been specified.	10

Examples

Success response

JSON format

{
  "RequestId": "09ABE829-6CD3-4FE0-556113E2****",
  "DomainDetail": {
    "GmtCreated": "2017-11-27T06:51:26Z",
    "Weight": "1",
    "SSLPub": "yourSSLPub",
    "Description": "testDescription",
    "SSLProtocol": "on",
    "CertName": "testCertName",
    "Scope": "domestic",
    "Cname": "example.com.w.alikunlun.net",
    "DomainStatus": "online",
    "GmtModified": "2017-11-27T06:55:26Z",
    "DomainName": "example.com",
    "Sources": {
      "Source": [
        {
          "Type": "oss",
          "Priority": "50",
          "Port": 80,
          "Content": "****.oss-cn-hangzhou.aliyuncs.com",
          "Enabled": "online",
          "Weight": "10"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDomain.NotFound	The domain provided does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.