tencent cloud

Feedback

BindLiveDomainCert

Last updated: 2022-07-06 17:17:53
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to bind a domain name certificate.
Note: you need to call the CreateLiveCert API first to add a certificate. After getting the certificate ID, call this API for binding.

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 Params. The value used for this API: BindLiveDomainCert.
Version Yes String Common Params. The value used for this API: 2018-08-01.
Region No String Common Params. This parameter is not required for this API.
CertId Yes Integer Certificate ID, which can be obtained through the CreateLiveCert API.
DomainName Yes String Playback domain name.
Status No Integer HTTPS status. 0: disabled, 1: enabled.

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=BindLiveDomainCert
&CertId=1000
&DomainName=5000.livepush.myqcloud.com
&Status=1
&<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

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.
InvalidParameter Invalid parameter.
InvalidParameter.CrtDateInUsing The certificate is in use.
InvalidParameter.CrtDateNotLegal The certificate is invalid.
InvalidParameterValue Invalid parameter value.
MissingParameter Parameter missing.
ResourceNotFound.CrtDateNotFound The certificate does not exist.
ResourceNotFound.DomainNotExist The domain name does not exist or is not matched.
ResourceNotFound.ForbidService
ResourceNotFound.FreezeService
ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService