Queries configurations of stream-level region blocking.
Usage notes
Obtain the streaming domain and then call this operation to query configurations of stream-level region blocking.
QPS limit
You can call this operation up to 50 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 limit on an API operation in ApsaraVideo Live.
Request parameters
Parameter | Type | Required | Description |
Action | String | Yes | The operation that you want to perform. Set the value to DescribeStreamLocationBlock. |
DomainName | String | Yes | The streaming domain. |
AppName | String | No | The name of the application to which the live stream belongs. |
StreamName | String | No | The name of the live stream. |
BlockType | String | No | The blocking type. Valid values: blacklist and whitelist. |
PageNum | Integer | No | The page number. Default value: 1. |
PageSize | Integer | No | The number of entries per page. Valid values: integers from 1 to 100. |
Response parameters
Parameter | Type | Description |
RequestId | String | The request ID. |
Count | Integer | The total number of stream-level region blocking configurations that meet the specified conditions. |
PageNum | Integer | The page number. |
PageSize | Integer | The number of entries per page. |
TotalPage | Integer | The total number of pages returned. |
StreamBlockList | StreamBlock[] | The details. |
DomainName | String | The accelerated domain name. |
AppName | String | The name of the application in which the blocking applies. |
StreamName | String | The name of the stream. |
BlockType | String | The blocking type. Valid values: blacklist and whitelist. |
LocationList | String | The blocked region. If multiple regions are specified, such as CN and AS, they are separated by commas (,). |
Status | Integer | The blocking status. Valid values: 0 (not started), 1 (blocking), 2 (successful), 3 (failed), 4 (expired), and 5 (deleting). |
ReleaseTime | String | The time when the blocking ends. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
UpdateTime | String | The time when the configuration was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Special error codes
Error code | Error message | HTTP status code | Description |
InternalError | The request processing has failed due to some unknown error. | 500 | The error message returned because an unknown error occurred. |
InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The error message returned because the domain name is not found within your Alibaba Cloud account. |
InvalidParam | Parameter invalid. | 400 | The error message returned because one or more parameters are invalid. |
Examples
Sample request
https://live.aliyuncs.com?Action=DescribeStreamLocationBlock&DomainName=example.com&<Common request parameters>Sample response
{
"RequestId": "0D70427D-91E4-4349-AAD3-5511A5BB823B",
"Count": 2,
"StreamBlockList": {
"StreamBlock": [
{
"DomainName": "example.com",
"AppName": "test",
"StreamName": "test",
"BlockType": "whitelist",
"LocationList": "CN,AS",
"Status": 2,
"ReleaseTime": "2023-03-14T03:02:48Z"
},
{
"DomainName": "example.com",
"AppName": "test",
"StreamName": "test1",
"BlockType": "whitelist",
"LocationList": "CN,AS",
"Status": 2,
"ReleaseTime": "2023-03-14T03:02:48Z"
}
]
}
}