Help Center/ Live/ Cloud Live API Reference/ HTTPS Certificate Management/ Querying the HTTPS Certificate Configuration of a Specified Domain Name
Updated on 2024-09-03 GMT+08:00

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"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class ShowDomainHttpsCertSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDomainHttpsCertRequest request = new ShowDomainHttpsCertRequest();
        try {
            ShowDomainHttpsCertResponse response = client.showDomainHttpsCert(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDomainHttpsCertRequest()
        response = client.show_domain_https_cert(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDomainHttpsCertRequest{}
	response, err := client.ShowDomainHttpsCert(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.