Queries the blacklist of live stream URLs under a main streaming domain.

Usage note

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

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 DescribeLiveStreamsBlockList

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

DomainName String Yes example.com

The main streaming domain.

PageNum Integer No 2

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

PageSize Integer No 10

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

Response parameters

Parameter Type Example Description
DomainName String example.com

The main streaming domain.

StreamUrls List example.com/liveApp****/liveStream****

The complete URL of each live stream.

PageNum Integer 2

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 9D855EC8-CF71-4615-B164-F7DFCB23B41D

The ID of the request.

TotalNum Integer 11

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

TotalPage Integer 2

The total number of returned pages.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeLiveStreamsBlockListResponse>
      <DomainName>example.com</DomainName>
      <PageNum>2</PageNum>
      <PageSize>10</PageSize>
      <RequestId>9D855EC8-CF71-4615-B164-F7DFCB23B41D</RequestId>
      <StreamUrls>
            <StreamUrl>example.com/liveApp****/liveStream****</StreamUrl>
      </StreamUrls>
      <TotalNum>11</TotalNum>
      <TotalPage>2</TotalPage>
</DescribeLiveStreamsBlockListResponse>

JSON format

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

Error codes

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