Help Center/ Live/ Cloud Live API Reference/ HTTPS Certificate Management/ Modifying the HTTPS Certificate Configuration of a Specified Domain Name
Updated on 2026-04-22 GMT+08:00

Modifying the HTTPS Certificate Configuration of a Specified Domain Name

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    live:domain:updateCDNConfig

    Write

    -

    -

    -

    -

URI

PUT /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.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

certificate_format

No

String

Definition

Certificate format.

Constraints

Only the PEM format is supported.

Range

  • PEM

Default value:

PEM

certificate

No

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

No

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

No

Boolean

Definition

Whether redirection is enabled.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

false

gm_certificate

No

GmCertificateInfo object

Definition

Chinese (SM) certificate settings.

Constraints

At least one international or Chinese (SM) certificate must be configured.

tls_certificate

No

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

Mandatory

Type

Description

source

No

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

No

String

Definition

(Optional) SCM certificate name.

Constraints

N/A

Range

Length: 0 to 128 characters

Default Value

N/A

cert_id

No

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

No

String

Definition

Chinese (SM) signature certificate body.

Constraints

N/A

Range

Length: 0 to 12,288 characters

Default Value

N/A

sign_certificate_key

No

String

Definition

Chinese (SM) signature private key.

Constraints

N/A

Range

Length: 0 to 8,096 characters

Default Value

N/A

enc_certificate

No

String

Definition

Chinese (SM) encryption certificate body.

Constraints

N/A

Range

Length: 0 to 12,288 characters

Default Value

N/A

enc_certificate_key

No

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

Mandatory

Type

Description

source

No

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

No

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

No

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

No

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

No

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

Response Parameters

Status code: 200

Updated.

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

Modifies the HTTPS certificate configuration of a specified domain name.

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

{
  "certificate_format" : "PEM",
  "certificate" : "your cert",
  "certificate_key" : "your cert key",
  "force_redirect" : true
}

Example Responses

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.

Modifies the HTTPS certificate configuration of a specified domain name.

 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
48
49
50
51
52
53
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 UpdateDomainHttpsCertSolution {

    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();
        UpdateDomainHttpsCertRequest request = new UpdateDomainHttpsCertRequest();
        DomainHttpsCertInfo body = new DomainHttpsCertInfo();
        body.withForceRedirect(true);
        body.withCertificateKey("your cert key");
        body.withCertificate("your cert");
        body.withCertificateFormat(DomainHttpsCertInfo.CertificateFormatEnum.fromValue("PEM"));
        request.withBody(body);
        try {
            UpdateDomainHttpsCertResponse response = client.updateDomainHttpsCert(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());
        }
    }
}

Modifies the HTTPS certificate configuration of a specified domain name.

 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
# 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 = UpdateDomainHttpsCertRequest()
        request.body = DomainHttpsCertInfo(
            force_redirect=True,
            certificate_key="your cert key",
            certificate="your cert",
            certificate_format="PEM"
        )
        response = client.update_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)

Modifies the HTTPS certificate configuration of a specified domain name.

 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 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.UpdateDomainHttpsCertRequest{}
	forceRedirectDomainHttpsCertInfo:= true
	certificateKeyDomainHttpsCertInfo:= "your cert key"
	certificateDomainHttpsCertInfo:= "your cert"
	certificateFormatDomainHttpsCertInfo:= model.GetDomainHttpsCertInfoCertificateFormatEnum().PEM
	request.Body = &model.DomainHttpsCertInfo{
		ForceRedirect: &forceRedirectDomainHttpsCertInfo,
		CertificateKey: &certificateKeyDomainHttpsCertInfo,
		Certificate: &certificateDomainHttpsCertInfo,
		CertificateFormat: &certificateFormatDomainHttpsCertInfo,
	}
	response, err := client.UpdateDomainHttpsCert(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

Updated.

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.