All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodUserDomains

Last Updated:May 22, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:DescribeVodUserDomainsList
  • Domain
    acs:vod:*:{#accountId}:domain/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries per page. Default value: 20. Maximum value: 50. Valid values: 1 to 50.

20
PageNumberintegerNo

The page number.

1
DomainNamestringNo

The domain name. The value of this parameter is used as a filter condition for a fuzzy match.

example.aliyundoc.com
DomainStatusstringNo

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
DomainSearchTypestringNo

The search method. Valid values:

  • fuzzy_match (default): fuzzy match.
  • pre_match: prefix match
  • suf_match: suffix match
  • full_match: exact match
fuzzy_match
Tagobject []No

The tags.

KeystringNo

The key of tag N. Valid values of N: 1 to 20.

By default, all tag keys are queried.

key
ValuestringNo

The value of tag N. Valid values of N: 1 to 20.

By default, all tag values are queried.

value

Response parameters

ParameterTypeDescriptionExample
object

The returned results.

RequestIdstring

The ID of the request.

E4EBD2BF-5EB0-4476-****-9D94E1B15267
PageNumberlong

The page number.

1
PageSizelong

The number of entries per page.

20
TotalCountlong

The total number of entries.

2
Domainsobject []

The detailed information about each domain name for CDN. The returned information is displayed in the format that is specified by the PageData parameter.

GmtCreatedstring

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
SslProtocolstring

Indicates whether HTTPS is enabled.

  • on: HTTPS is enabled.
  • off: HTTPS is not eabled.
on
Descriptionstring

The remarks.

Zhejiang ICP Filing No. ****
Sandboxstring

Indicates whether the accelerated domain name was in a sandbox.

normal
Cnamestring

The CNAME that is assigned to the domain name for CDN.

learn.developer.aliyundoc.com
DomainStatusstring

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
GmtModifiedstring

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
DomainNamestring

The domain name for CDN.

example.aliyundoc.com
Sourcesobject []

The information about the origin server.

Typestring

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
Prioritystring

The priority of the origin server.

5
Portinteger

The port number. Valid values: 443 and 80.

80
Contentstring

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 timeSummary of changesOperation
2022-10-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400

Common errors

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

Error codeError messageHTTP status codeDescription
InvalidPageNumber.ValueNotSupportedThe specified value of parameter PageNumber is not supported.400The error message returned because the value of the PageNumber parameter is invalid.
InvalidPageSize.ValueNotSupportedThe specified value of parameter PageSize is not supported.400The error message returned because the value of the PageSize parameter is invalid.
InvalidDomainName.MalformedThe specific value of parameter DomainName is malformed.400The error message returned because the value of the DomainName parameter is invalid.
InvalidDomainStatus.ValueNotSupportedThe specified value of parameter DomainStatus is not supported.400The error message returned because the value of the DomainStatus parameter is invalid.
InvalidDomainSearchType.ValueNotSupportedThe specified value of parameter DomainSearchType is not supported.400The error message returned because the value of the DomainSearchType parameter is invalid.