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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
live:DescribeLiveUserDomains | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
LiveDomainType | string | No | The type of the domain name. Valid values:
Note
If you leave this parameter empty, all ingest domains and streaming domains within your Alibaba Cloud account are queried by default.
| liveVideo |
PageSize | integer | No | The number of entries per page. Default value: 20. Maximum value: 50. | 20 |
PageNumber | integer | No | The page number. Valid values: 1 to 100000. | 1 |
DomainName | string | No | The domain name that is used as a keyword to filter domain names. Fuzzy match is supported. Note
| *.aliyundoc.com |
RegionName | string | No | The ID of the region in which the domain name resides. | cn-beijing |
DomainSearchType | string | No | The search mode. Valid values:
| fuzzy_match |
DomainStatus | string | No | The status of the domain name. Valid values:
| online |
Tag | array<object> | No | The tags. | |
object | No | The list of tags. | ||
Key | string | No | The key of the tag. | TestKey |
Value | string | No | The value of the tag. | TestValue |
ResourceGroupId | string | No | The ID of the resource group. | rg-aek2egyoep3jp7a |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidPageNumber.ValueNotSupported | The specified value of parameter PageNumber is not supported. | The value of the specified PageNumber parameter is not supported. |
400 | InvalidPageSize.ValueNotSupported | The specified value of parameter PageSize is not supported. | - |
400 | InvalidDomainStatus.ValueNotSupported | The specified value of parameter DomainStatus is not supported. | - |
400 | InvalidDomainName.Malformed | The specific value of parameter DomainName is malformed. | - |
400 | InvalidDomainSearchType.ValueNotSupported | The specified value of parameter DomainSearchType is not supported. | - |
400 | InvalidDomainSearchType.Malformed | he specified value of parameter DomainSearchType is invalid. | - |
400 | InvalidLiveDomainType.ValueNotSupported | The specified value of parameter LiveDomainType is not supported. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-27 | API Description Update. The Error code has changed | View Change Details |
2024-09-25 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |