DescribeVodUserDomains - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the domain names for CDN within your Alibaba Cloud account.

Operation description

You can filter domain names by name and status. Fuzzy match is supported for domain name-based query.
This operation is available only in the China (Shanghai) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 50. Valid values: 1 to 50.	20
PageNumber	integer	No	The page number.	1
DomainName	string	No	The domain name. The value of this parameter is used as a filter condition for a fuzzy match.	example.aliyundoc.com
DomainStatus	string	No	The status of the domain name. Value 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
DomainSearchType	string	No	The search method. 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 object of the tag.
Key	string	No	The key of tag N. Valid values of N: 1 to 20. By default, all tag keys are queried.	key
Value	string	No	The value of tag N. Valid values of N: 1 to 20. By default, all tag values are queried.	value

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
RequestId	string	The ID of the request.	E4EBD2BF-5EB0-4476-****-9D94E1B15267
PageNumber	long	The page number.	1
PageSize	long	The number of entries per page.	20
TotalCount	long	The total number of entries.	2
Domains	array<object>	The detailed information about each domain name for CDN. The returned information is displayed in the format that is specified by the PageData parameter.
	object	The returned datas.
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	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-10-27	The Error code has changed	View Change Details

Common errors

The following table describes the common errors that this operation can return.

Error code	Error message	HTTP status code	Description
InvalidPageNumber.ValueNotSupported	The specified value of parameter PageNumber is not supported.	400	The error message returned because the value of the PageNumber parameter is invalid.
InvalidPageSize.ValueNotSupported	The specified value of parameter PageSize is not supported.	400	The error message returned because the value of the PageSize parameter is invalid.
InvalidDomainName.Malformed	The specific value of parameter DomainName is malformed.	400	The error message returned because the value of the DomainName parameter is invalid.
InvalidDomainStatus.ValueNotSupported	The specified value of parameter DomainStatus is not supported.	400	The error message returned because the value of the DomainStatus parameter is invalid.
InvalidDomainSearchType.ValueNotSupported	The specified value of parameter DomainSearchType is not supported.	400	The error message returned because the value of the DomainSearchType parameter is invalid.