ModifyLivePushAuthKey

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-01-27 15:18:33

Download PDF

1. API Description

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

This API is used to modify the LVB push authentication key.

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: ModifyLivePushAuthKey.
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	Push domain name.
Enable	No	Integer	Whether to enable. 0: disabled; 1: enabled. If this parameter is left empty, the current value will not be modified.
MasterAuthKey	No	String	Master authentication key. If this parameter is left empty, the current value will not be modified.
BackupAuthKey	No	String	Backup authentication key. If this parameter is left empty, the current value will not be modified.
AuthDelta	No	Integer	Validity period in seconds.

3. Output Parameters

Parameter Name	Type	Description
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=ModifyLivePushAuthKey
&DomainName=5000.livepush.myqcloud.com
&Enable=0
&MasterAuthKey=xxxx
&BackupAuthKey=xxx
&AuthDelta=300
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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	Database connection error.
InternalError.DBError	DB execution error.
InternalError.PushDomainNoRecord	The push domain name does not exist.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Parameter missing.
ResourceNotFound.PushDomainNoRecord	The push domain name does not exist.

Recent Pages