Help Center/ Live/ Cloud Live API Reference/ HTTPS Certificate Management/ Querying the HTTPS Certificate Configuration of a Specified Domain Name

Updated on 2026-04-22 GMT+08:00

Querying the HTTPS Certificate Configuration of a Specified Domain Name

Function

This API is used to query the HTTPS certificate configuration of a specified domain name.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/guard/https-cert

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Definition Streaming domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
certificate_format	String	Definition Certificate format. Constraints Only the PEM format is supported. Range PEM Default value: PEM
certificate	String	Definition Certificate content. Constraints If a value is specified for tls_certificate, this field is invalid. Range N/A Default Value N/A
certificate_key	String	Definition Private key content. Constraints If a value is specified for tls_certificate, this field is invalid. Range N/A Default Value N/A
force_redirect	Boolean	Definition Whether redirection is enabled. Constraints N/A Range true: enabled false: disabled Default Value false
gm_certificate	GmCertificateInfo object	Definition Chinese (SM) certificate settings. Constraints At least one international or Chinese (SM) certificate must be configured.
tls_certificate	TlsCertificateInfo object	Definition Chinese (SM) certificate settings. Constraints You need to configure an international certificate, a Chinese (SM) certificate, or both. If the current field is specified, certificate and certificate_key at the same level are ignored.

**Table 5** GmCertificateInfo
Parameter	Type	Description
source	String	Definition Certificate source. Constraints N/A Range scm: Cloud Certificate & Manager (CCM) user: self-owned certificate, which is the default value Default Value N/A
cert_name	String	Definition (Optional) SCM certificate name. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
cert_id	String	Definition SCM certificate ID. This parameter is mandatory when the certificate source is scm. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
sign_certificate	String	Definition Chinese (SM) signature certificate body. Constraints N/A Range Length: 0 to 12,288 characters Default Value N/A
sign_certificate_key	String	Definition Chinese (SM) signature private key. Constraints N/A Range Length: 0 to 8,096 characters Default Value N/A
enc_certificate	String	Definition Chinese (SM) encryption certificate body. Constraints N/A Range Length: 0 to 12,288 characters Default Value N/A
enc_certificate_key	String	Definition Chinese (SM) encryption private key. Constraints N/A Range Length: 0 to 8,096 characters Default Value N/A

**Table 6** TlsCertificateInfo
Parameter	Type	Description
source	String	Definition Certificate source. Constraints N/A Range scm: Cloud Certificate & Manager (CCM) user: self-owned certificate, which is the default value Length: 0 to 128 characters Default Value N/A
cert_name	String	Definition SCM certificate name. Constraints This parameter is optional when the certificate source is scm. Range Length: 0 to 128 characters Default Value N/A
cert_id	String	Definition SCM certificate ID. Constraints This parameter is mandatory when the certificate source is scm. Range Length: 0 to 128 characters Default Value N/A
certificate	String	Definition Certificate content. Constraints This parameter is mandatory when the certificate source is user. Range Length: 0 to 12,288 characters Default Value N/A
certificate_key	String	Definition Private key. Constraints This parameter is mandatory when the certificate source is user. Range Length: 0 to 8,096 characters Default Value N/A

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

Queries the HTTPS certificate configuration of a specified domain name.

GET https://{endpoint}/v1/{project_id}/guard/https-cert?domain=play.example.huawei.com

Example Responses

Status code: 200

Query succeeded.

Note: If certificate_key is not returned, the value is empty.

{
  "certificate_format" : "PEM",
  "certificate" : "",
  "certificate_key" : "",
  "force_redirect" : false
}

Status code: 400

Parameter verification failed. For example, the input domain value is empty or the certificate verification failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status code: 401

The API is not authorized to access resources.

{
  "error_code" : "LIVE.100011003",
  "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions"
}

Status code: 404

The resource to be accessed does not exist. For example, the domain name does not exist.

{
  "error_code" : "LIVE.103011019",
  "error_msg" : "The resource to access is not exists"
}

Status code: 500

Internal service error.

{
  "error_code" : "LIVE.100011005",
  "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve"
}

Status Codes

Status Code	Description
200	Query succeeded. Note: If certificate_key is not returned, the value is empty.
400	Parameter verification failed. For example, the input domain value is empty or the certificate verification failed.
401	The API is not authorized to access resources.
404	The resource to be accessed does not exist. For example, the domain name does not exist.
500	Internal service error.

Error Codes

See Error Codes.

Parent Topic: HTTPS Certificate Management

Previous topic: Modifying the HTTPS Certificate Configuration of a Specified Domain Name

Next topic: Deleting the HTTPS Certificate Configuration of a Specified Domain Name

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.