DescribeStreamLocationBlock - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries configurations of stream-level region blocking.

Operation description

Queries 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.

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.

Debug

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:DescribeStreamLocationBlock		Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	No	The name of the application to which the live stream belongs.	liveApp****
StreamName	string	No	The name of the live stream.	stream
BlockType	string	No	The blocking type. Valid values: blacklist whitelist	blacklist
PageSize	integer	No	The number of entries per page. Valid values: integers from 1 to 100.	5
PageNum	integer	No	The page number. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
Count	integer	The total number of entries that meet the specified conditions.	2
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	5
RequestId	string	The request ID.	C7C69682-7F88-40DD-A198-10D0309E439B
StreamBlockList	array<object>	The configurations.
StreamBlock	object	The details of the configuration.
AppName	string	The name of the application in which the blocking applies.	liveApp****
BlockType	string	The blocking type. Valid values: blacklist whitelist	blacklist
DomainName	string	The accelerated domain name.	example.com
LocationList	string	The blocked region. If multiple regions are specified, such as CN and AS, they are separated by commas (,).	CN
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.	2023-08-13T09:27Z
Status	integer	The blocking status. Valid values: 0 (not started), 1 (blocking), 2 (successful), 3 (failed), 4 (expired), and 5 (deleting).	0
StreamName	string	The name of the stream.	stream
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.	2023-08-14T09:27Z
TotalPage	integer	The total number of pages.	1

Examples

Sample success responses

JSONformat

{
  "Count": 2,
  "PageNum": 1,
  "PageSize": 5,
  "RequestId": "C7C69682-7F88-40DD-A198-10D0309E439B",
  "StreamBlockList": {
    "StreamBlock": [
      {
        "AppName": "liveApp****",
        "BlockType": "blacklist",
        "DomainName": "example.com",
        "LocationList": "CN",
        "ReleaseTime": "2023-08-13T09:27Z",
        "Status": 0,
        "StreamName": "stream",
        "UpdateTime": "2023-08-14T09:27Z"
      }
    ]
  },
  "TotalPage": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	Parameter invalid.	Illegal input parameters
500	InternalError	The request processing has failed due to backend service exception.	-

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

Change history

Change time	Summary of changes	Operation

No change history