All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveStreamsBlockList

Last Updated:Dec 05, 2024

Queries the live streams that are blacklisted under a domain name.

Operation description

The stream URLs refer to the URLs for playing in particular.

QPS limit

A single user can perform a maximum of 50 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

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

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com
PageNumintegerNo

The number of the page to return. Default value: 1.

2
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 3000. Default value: 2000.

10

Response parameters

ParameterTypeDescriptionExample
object
PageNuminteger

The page number of the returned page.

2
RequestIdstring

The ID of the request.

9D855EC8-CF71-4615-B164-F7DFCB23B41D
TotalPageinteger

The total number of returned pages.

2
PageSizeinteger

The number of entries returned per page.

10
TotalNuminteger

The total number of live stream URLs that meet the specified conditions.

11
DomainNamestring

The main streaming domain.

example.com
StreamUrlsarray

The complete URL of each live stream.

StreamUrlstring
example.com/liveApp****/liveStream****

Examples

Sample success responses

JSONformat

{
  "PageNum": 2,
  "RequestId": "9D855EC8-CF71-4615-B164-F7DFCB23B41D",
  "TotalPage": 2,
  "PageSize": 10,
  "TotalNum": 11,
  "DomainName": "example.com",
  "StreamUrls": {
    "StreamUrl": [
      "example.com/liveApp****/liveStream****"
    ]
  }
}

Error codes

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