DescribeLivePlayAuthKey

Last updated: 2020-01-13 15:45:20

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to query the playback authentication key.

A maximum of 500 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeLivePlayAuthKey
Version Yes String Common parameter. The value used for this API: 2018-08-01
Region No String Common parameter. This parameter is not required for this API.
DomainName Yes String Domain name.

3. Output Parameters

Parameter Name Type Description
PlayAuthKeyInfo PlayAuthKeyInfo Playback authentication key information.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLivePlayAuthKey
&DomainName=5000.livepush.myqcloud.com
&<Common request parameter>

Output Example

{
  "Response": {
    "PlayAuthKeyInfo": {
      "DomainName": "5000.livepush.myqcloud.com",
      "Enable": 1,
      "AuthKey": "xxxx",
      "AuthDelta": 300,
      "AuthBackKey": "xxx"
    },
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InternalError.ConnectDbError DB connection error.
InternalError.DBError DB execution error.
InternalError.PlayDomainNoRecord The playback domain name does not exist.
InvalidParameter Invalid parameter.
InvalidParameterValue Wrong parameter value.
MissingParameter Missing parameter.