DescribeLiveStreamAuthChecking - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the authentication status of an active stream.

Operation description

QPS limit

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. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

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

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The ingest domain or streaming domain.	demo.aliyundoc.com
Url	string	Yes	The complete ingest URL or streaming URL.	http://example.com/live/test.flv?auth_key=1664248******

Response parameters

Parameter	Type	Description	Example
	object
Description	string	The error message for failed authentication.	INVALID AUTH_KEY
RequestId	string	The request ID.	16F08B4E-14FD-5D72-AB2F-BAFA4C4D57F1
Status	string	Indicates whether the signed URL is valid. Valid values: pass: valid. false: invalid.	pass

Error codes for failed authentication

Error code	Description
INVALID AUTH_KEY	The auth_key field of the signed URL is invalid.
INVALID TIMESTAMP	The timestamp of the signed URL is invalid.
INVALID ALIAUTH	The type of URL signing is invalid.
INVALID MD5HASH	The hash value calculated by using the MD5 algorithm is invalid.

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2023-03-14	The Error code has changed	View Change Details