Querying the HTTPS Certificate Configuration of a Specified Domain Name

Function

API for querying 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	Streaming domain name

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	Certificate format. The default value is PEM. Currently, only PEM is supported.
certificate	String	Certificate
certificate_key	String	Private key
force_redirect	Boolean	Whether to enable redirection. The default value is false.
gm_certificate	GmCertificateInfo object	Chinese (SM) certificate settings. Configure one international certificate, one Chinese (SM) certificate, or one international certificate and one Chinese (SM) certificate.
tls_certificate	TlsCertificateInfo object	Chinese (SM) certificate settings. Configure one international certificate, one Chinese (SM) certificate, or one international certificate and one Chinese (SM) certificate. If this field is specified, you can skip the settings of certificate and certificate_key.

**Table 5** GmCertificateInfo
Parameter	Type	Description
source	String	Certificate source. Options are scm (Cloud Certificate Manager, CCM) and user (default, the user's own certificate).
cert_name	String	(Optional) SCM certificate name.
cert_id	String	SCM certificate ID. This parameter is mandatory when the certificate source is scm.
sign_certificate	String	Chinese (SM) signature certificate body
sign_certificate_key	String	Chinese (SM) signature private key
enc_certificate	String	Chinese (SM) encryption certificate body
enc_certificate_key	String	Chinese (SM) encryption private key

**Table 6** TlsCertificateInfo
Parameter	Type	Description
source	String	Certificate source. Options are scm (Cloud Certificate Manager, CCM) and user (default, the user's own certificate).
cert_name	String	SCM certificate name. This parameter is available when the certificate source is scm.
cert_id	String	SCM certificate ID. This parameter is mandatory when the certificate source is scm.
certificate	String	Certificate body. This parameter is mandatory when the certificate source is user.
certificate_key	String	Private key. This parameter is mandatory when the certificate source is user.

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