DescribeLiveDomainCert

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-19 14:59:34

Download PDF

1. API Description

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

This API is used to get the domain name certificate information.

A maximum of 500 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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeLiveDomainCert.
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	Playback domain name.

3. Output Parameters

Parameter Name	Type	Description
DomainCertInfo	DomainCertInfo	Certificate 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=DescribeLiveDomainCert
&DomainName=5000.livepush.myqcloud.com
&<Common request parameters>

Output Example

{
  "Response": {
    "DomainCertInfo": {
      "CertId": 1000,
      "CertName": "testName",
      "Description": "testDesc",
      "CreateTime": "2018-11-30T15:50:12Z",
      "HttpsCrt": "xxx",
      "CertType": 0,
      "CertExpireTime": "2018-12-30T15:50:12Z",
      "DomainName": "5000.livepush.play.com",
      "Status": 1
    },
    "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
FailedOperation.InvokeVideoApiFail	An exception occurred while manipulating the VOD API.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Parameter missing.
ResourceNotFound.CrtDomainNotFound	No certificate was found.

Recent Pages