SetLiveStreamBlock-阿里云帮助中心

Operation description

You can configure up to 200 live stream area blocking rules for a domain name. If duplicate rules with the same AppName and StreamName exist in the live stream area blocking rules, the most recently updated rule takes effect.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If this limit is exceeded, the API invocations are throttled, which may affect your business. Invoke this operation appropriately.

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:SetLiveStreamBlock

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs. You can view the AppName on the Stream Management page.	liveApp****
StreamName	string	Yes	The name of the live stream. You can view the StreamName on the Stream Management page.	liveStream****
BlockType	string	Yes	The blocking mode. Valid values: blacklist: blacklist. whitelist: whitelist. Valid values: blacklist : Blacklist. whitelist : Whitelist.	blacklist
LocationList	string	Yes	The blocked regions, such as CN and AS. Separate multiple regions with commas (,).	CN
ReleaseTime	string	No	The end time of the blocking period in UTC. If this parameter is not specified, the blocking lasts for 7 days by default.	2016-06-29T19:00:00Z

Response elements

Element	Type	Description	Example
	object
Description	string	The result description. Success: ok. Failure: failure details.	ok
RequestId	string	The request ID.	3be7ade8-d907-483c-b24a-0dad4595beaf
Status	string	The task status. Valid values: ok: succeeded. fail: failed. Note The task is considered failed if any single subtask fails to be created.	ok

Examples

Success response

JSON format

{
  "Description": "ok",
  "RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf",
  "Status": "ok"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidReleaseTime.Malformed	Specified ReleaseTime is malformed.
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.