Queries the domain names for CDN within your Alibaba Cloud account based on the specified conditions.

Usage note

This operation returns all domain names or all domains of one domain type. You can specify the domain type (liveVideo or liveEdge) in the request. If you do not specify the domain type, all domains are returned.

QPS limit

A single user can perform a maximum of 100 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveUserDomains

The operation that you want to perform. Set the value to DescribeLiveUserDomains.

LiveDomainType String No liveVideo

The type of the domain name. Valid values:

  • liveVideo: streaming domain
  • liveEdge: edge ingest domain
PageSize Integer No 20

The number of entries to return on each page. Default value: 20. Maximum value: 50.

PageNumber Integer No 1

The number of the page to return. Valid values: 1 to 100000.

DomainName String No *.aliyundoc.com

The streaming domain and ingest domain. The value of this parameter is used as a filter condition for a fuzzy match. If you do not set this parameter, all domain names for CDN within your Alibaba Cloud account are queried.

RegionName String No cn-beijing

The ID of the region where the streaming domains reside.
DomainSearchType String No fuzzy_match

The search method. Valid values:

  • fuzzy_match: fuzzy match. This is the default value.
  • pre_match: prefix match.
  • suf_match: suffix match.
  • full_match: exact match.
DomainStatus String No online

The status of the domain names. Valid values:

  • online: enabled domain names.
  • offline: disabled domain names.
  • configuring: domain names that are being configured.
Tag.N.Key String No TestKey

The key of the tag.
Tag.N.Value String No TestValue

The value of the tag.

Response parameters

Parameter Type Example Description
Domains Array of PageData

The information about the retrieved domain names.
PageData
Cname String learn.developer.aliyundoc.com

The canonical name (CNAME) generated for the domain name.
Description String test

The description of the domain name.
DomainName String example.aliyundoc.com.w.alikunlun.net

The streaming domain or ingest domain.
GmtCreated String 2017-08-29T12:15:36Z

The time when the domain name was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

GmtModified String 2017-12-29T12:15:36Z

The time when the domain name was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

LiveDomainStatus String online

The status of the domain name. Valid values:

  • online: The domain name is enabled.
  • offline: The domain name is disabled.
  • configuring: The domain name is being configured.
LiveDomainType String liveVideo

The type of the domain name. Valid values:

  • liveVideo: streaming domain
  • liveEdge: edge ingest domain
RegionName String cn-beijing

The ID of the region where the streaming domain resides.
PageNumber Long 1

The page number of the returned page.
PageSize Long 100

The number of entries returned per page.
RequestId String E4EBD2BF-5EB0-4476-8829-9D94E1B15267

The ID of the request.
TotalCount Long 2

The total number of the returned entries.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveUserDomains
&<Common request parameters>

Sample success responses

XML format 

<DescribeLiveUserDomainsResponse>
  <Domains>
        <PageData>
              <LiveDomainStatus>online</LiveDomainStatus>
              <Description>test</Description>
              <RegionName>cn-beijing</RegionName>
              <LiveDomainType>liveVideo</LiveDomainType>
              <DomainName>demo.aliyundoc.com</DomainName>
              <GmtModified>2017-12-29T12:15:36Z</GmtModified>
              <GmtCreated>2017-08-29T12:15:36Z</GmtCreated>
              <Cname>example.aliyundoc.com.w.alikunlun.net</Cname>
        </PageData>
  </Domains>
  <TotalCount>2</TotalCount>
  <PageSize>100</PageSize>
  <RequestId>E4EBD2BF-5EB0-4476-8829-9D94E1B15267</RequestId>
  <PageNumber>1</PageNumber>
</DescribeLiveUserDomainsResponse>

JSON format 

{
    "Domains": {
        "PageData": [{
            "LiveDomainStatus": "online",
            "Description": "test",
            "RegionName": "cn-beijing",
            "LiveDomainType": "liveVideo",
            "DomainName": "demo.aliyundoc.com",
            "GmtModified": "2017-12-29T12:15:36Z",
            "GmtCreated": "2017-08-29T12:15:36Z",
            "Cname": "example.aliyundoc.com.w.alikunlun.net"
        }]
    },
    "TotalCount": "2",
    "PageSize": "100",
    "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B15267",
    "PageNumber": "1"
}

Error codes

For a list of error codes, visit the API Error Center.