DescribeStreamLocationBlock - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries region blocking configurations of a specific live stream.

Operation description

This operation is used to query information about location-based blocking for a specific stream.

QPS limit

You can call this operation up to 50 times per second per user. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeStreamLocationBlock

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	No	The AppName of the live stream.	liveApp****
StreamName	string	No	The name of the live stream.	stream
BlockType	string	No	The blocking method. Valid values: blacklist whitelist	blacklist
PageSize	integer	No	The number of entries to return on each page. Valid values: integers from 1 to 100.	5
PageNum	integer	No	The number of the page to return. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
Count	integer	The total number of entries that meet the specified criteria.	2
PageNum	integer	The page number.	1
PageSize	integer	The number of entries on each page.	5
RequestId	string	The request ID.	C7C69682-7F88-40DD-A198-10D0309E439B
StreamBlockList	object
StreamBlock	array<object>	The configuration details.
	object	The configuration details.
AppName	string	The blocked AppName.	liveApp****
BlockType	string	The blocking method. Valid values: blacklist whitelist	blacklist
DomainName	string	The accelerated domain name.	example.com
LocationList	string	A comma-separated list of region codes to block or allow.	CN
ReleaseTime	string	The time when the block will be automatically lifted, in UTC format.	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 blocked stream.	stream
UpdateTime	string	The time when the configuration was last modified. The time is in UTC.	2023-08-14T09:27Z
TotalPage	integer	The total number of pages returned.	1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.