Use DescribeVodUserDomains to query CDN domain names - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the list of all acceleration domain names under your account for ApsaraVideo VOD.

Operation description

Supports fuzzy match filtering by domain name and filtering by domain name status.
This operation currently supports only the following region: 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:DescribeVodUserDomains

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 50. Valid values: any integer from 1 to 50.	20
PageNumber	integer	No	The number of the page to return.	1
DomainName	string	No	The accelerated domain name for ApsaraVideo VOD. Fuzzy match filtering is supported.	example.aliyundoc.com
DomainStatus	string	No	The domain name status filter. Valid values: online: Enabled. offline: Disabled. configuring: Being configured. configure_failed: Configuration failed. checking: Being reviewed. check_failed: Review failed.	online
DomainSearchType	string	No	The domain name query type. Valid values: fuzzy_match (default): fuzzy match. pre_match: prefix match. suf_match: suffix match. full_match: exact match.	fuzzy_match
Tag	array<object>	No	The tags.
	object	No	The tag object.
Key	string	No	The tag key. Valid values of N: 1 to 20. By default, all tag keys are queried.	key
Value	string	No	The tag value. Valid values of N: 1 to 20. By default, all tag values are queried.	value

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E4EBD2BF-5EB0-4476-****-9D94E1B15267
PageNumber	integer	The page number of the returned data.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	2
Domains	object
PageData	array<object>	The array of PageData objects that contains the status information of ApsaraVideo VOD domain names.
	array<object>	The returned information.
GmtCreated	string	The time when the domain name for CDN was added. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-08-29T08:40:53Z
SslProtocol	string	Indicates whether HTTPS is enabled. on: HTTPS is enabled. off: HTTPS is not eabled.	on
Description	string	The remarks.	Zhejiang ICP Filing No. ****
Sandbox	string	Indicates whether the accelerated domain name was in a sandbox.	normal
Cname	string	The CNAME that is assigned to the domain name for CDN.	learn.developer.aliyundoc.com
DomainStatus	string	The status of the domain name for CDN. Valid values: online: indicates that the domain name is enabled. offline: indicates that the domain name is disabled. configuring: indicates that the domain name is being configured. configure_failed: indicates that the domain name failed to be configured. checking: indicates that the domain name is under review. check_failed: indicates that the domain name failed the review.	online
GmtModified	string	The last time when the domain name for CDN was modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-29T09:24:12Z
DomainName	string	The domain name for CDN.	example.aliyundoc.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: an IP address. domain: an origin domain name oss: the OSS domain of an Object Storage Service (OSS) bucket	oss
Priority	string	The priority of the origin server.	5
Port	integer	The port number. Valid values: 443 and 80.	80
Content	string	The address of the origin server.	192.168.0.1

Examples

Success response

JSON format

{
  "RequestId": "E4EBD2BF-5EB0-4476-****-9D94E1B15267",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2,
  "Domains": {
    "PageData": [
      {
        "GmtCreated": "2017-08-29T08:40:53Z",
        "SslProtocol": "on",
        "Description": "Zhejiang ICP Filing No. ****",
        "Sandbox": "normal",
        "Cname": "learn.developer.aliyundoc.com",
        "DomainStatus": "online",
        "GmtModified": "2017-12-29T09:24:12Z",
        "DomainName": "example.aliyundoc.com",
        "Sources": {
          "Source": [
            {
              "Type": "oss",
              "Priority": "5",
              "Port": 80,
              "Content": "192.168.0.1"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidPageNumber.ValueNotSupported	The specified value of PageNumber is not supported.
400	InvalidPageSize.ValueNotSupported	The specified value of PageSize is invalid.
400	InvalidDomainStatus.ValueNotSupported	The specified value of DomainStatus is invalid.
400	InvalidDomainName.Malformed	The specified DomainName is invalid.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of DomainSearchType is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.