All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveUserDomains

Last Updated:Nov 14, 2024

Queries domain names of ApsaraVideo Live in your Alibaba Cloud account.

Operation description

Usage notes

You can call this operation to query all domain names of ApsaraVideo Live within your Alibaba Cloud account. The supported types of domain names are streaming domains and edge ingest domains.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
live:DescribeLiveUserDomainsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LiveDomainTypestringNo

The type of the domain name. Valid values:

  • liveVideo: streaming domain
  • liveEdge: ingest domain
Note If you leave this parameter empty, all ingest domains and streaming domains within your Alibaba Cloud account are queried by default.
liveVideo
PageSizeintegerNo

The number of entries per page. Default value: 20. Maximum value: 50.

20
PageNumberintegerNo

The page number. Valid values: 1 to 100000.

1
DomainNamestringNo

The domain name that is used as a keyword to filter domain names. Fuzzy match is supported.

Note
  • If you set LiveDomainType to liveVideo and leave this parameter empty, the streaming domains are queried. - If you set LiveDomainType to liveEdge and leave this parameter empty, the ingest domains are queried.
*.aliyundoc.com
RegionNamestringNo

The ID of the region in which the domain name resides.

cn-beijing
DomainSearchTypestringNo

The search mode. Valid values:

  • fuzzy_match (default): fuzzy match
  • pre_match: prefix match
  • suf_match: suffix match
  • full_match: exact match
fuzzy_match
DomainStatusstringNo

The status of the domain name. Valid values:

  • online
  • offline
  • configuring
online
Tagarray<object>No

The tags.

objectNo

The list of tags.

KeystringNo

The key of the tag.

TestKey
ValuestringNo

The value of the tag.

TestValue
ResourceGroupIdstringNo

The ID of the resource group.

rg-aek2egyoep3jp7a

Response parameters

ParameterTypeDescriptionExample
object
Domainsarray<object>

The domain names.

PageDataobject

The information about the domain name.

Cnamestring

The CNAME generated for the domain name.

learn.developer.aliyundoc.com
Descriptionstring

The description.

test
DomainNamestring

The domain name.

demo.aliyundoc.com
GmtCreatedstring

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.

2017-08-29T12:15:36Z
GmtModifiedstring

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.

2017-12-29T12:15:36Z
LiveDomainStatusstring

The status of the domain name. Valid values:

  • online
  • offline
  • configuring
online
LiveDomainTypestring

The type of the domain name. Valid values:

  • liveVideo: streaming domain
  • liveEdge: ingest domain
liveVideo
RegionNamestring

The ID of the region in which the domain name resides.

cn-beijing
ResourceGroupIdstring

The ID of the resource group.

rg-aekzvyjetyjjmla
PageNumberlong

The page number.

1
PageSizelong

The number of entries per page.

100
RequestIdstring

The ID of the request.

E4EBD2BF-5EB0-4476-8829-9D94E1B15267
TotalCountlong

The total number of entries.

1

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidPageNumber.ValueNotSupportedThe specified value of parameter PageNumber is not supported.The value of the specified PageNumber parameter is not supported.
400InvalidPageSize.ValueNotSupportedThe specified value of parameter PageSize is not supported.-
400InvalidDomainStatus.ValueNotSupportedThe specified value of parameter DomainStatus is not supported.-
400InvalidDomainName.MalformedThe specific value of parameter DomainName is malformed.-
400InvalidDomainSearchType.ValueNotSupportedThe specified value of parameter DomainSearchType is not supported.-
400InvalidDomainSearchType.Malformedhe specified value of parameter DomainSearchType is invalid.-
400InvalidLiveDomainType.ValueNotSupportedThe specified value of parameter LiveDomainType is not supported.-

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

Change history

Change timeSummary of changesOperation
2024-09-27API Description Update. The Error code has changedView Change Details
2024-09-25The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details