DescribeLiveStreamAuthChecking - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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

get

*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 ingest domain or streaming domain.	demo.aliyundoc.com
Url	string	Yes	The complete ingest or streaming URL. You can use the URL generator to generate a URL.	http://example.com/live/test.flv?auth_key=1664248******

Response elements

Element	Type	Description	Example
	object
Description	string	The error message returned if authentication failed.	INVALID AUTH_KEY
RequestId	string	The request ID.	16F08B4E-14FD-5D72-AB2F-BAFA4C4D57F1
Status	string	Indicates whether the authentication is passed. pass: The authentication is passed. false: The authentication failed.	pass

Reasons for authentication failure

Reason	Description
INVALID AUTH_KEY	The auth_key parameter in the signed URL is invalid.
INVALID TIMESTAMP	The timestamp in the signed URL is invalid.
INVALID ALIAUTH	The configured authentication method is invalid.
INVALID MD5HASH	The string calculated using the MD5 algorithm is invalid.

Examples

Success response

JSON format

{
  "Description": "INVALID AUTH_KEY",
  "RequestId": "16F08B4E-14FD-5D72-AB2F-BAFA4C4D57F1",
  "Status": "pass"
}

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.