Help Center/ Web Application Firewall/ API Reference/ APIs/ Certificate Management/ Applying a Certificate to a Domain Name
Updated on 2025-08-19 GMT+08:00

Applying a Certificate to a Domain Name

Function

This API is used to apply a certificate to a domain name.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/waf/certificate/{certificate_id}/apply-to-hosts

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Constraints

N/A

Range

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

certificate_id

Yes

String

Definition

ID of the HTTPS certificate. You can call the ListCertificates API to obtain the certificate ID.

Constraints

N/A

Range

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps.

Constraints

N/A

Range

  • 0: the default enterprise project.

  • all_granted_eps: all enterprise projects.

  • A specific enterprise project ID: Enter a maximum of 36 characters.

Default Value

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

cloud_host_ids

No

Array of strings

Definition

ID of the HTTPS domain name in cloud mode. It can be obtained by calling the ListHost API.

Constraints

N/A

Range

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

premium_host_ids

No

Array of strings

Definition

ID of the HTTPS domain name in dedicated mode. It can be obtained by calling the ListPremiumHost API.

Constraints

N/A

Range

Enter 32 characters. Only letters and digits are allowed.

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Definition

Certificate ID.

Range

N/A

name

String

Definition

Certificate name.

Range

N/A

timestamp

Long

Definition

Certificate upload timestamp.

Range

13-bit millisecond timestamp.

expire_time

Long

Definition

Timestamp when the certificate expires

Range

N/A

bind_host

Array of CertificateBundingHostBody objects

Domain name list

Table 6 CertificateBundingHostBody

Parameter

Type

Description

id

String

Domain name ID

hostname

String

Domain name

waf_type

String

WAF mode (Cloud: cloud; Dedicated: premium)

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 8 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 10 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 12 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

The following example shows how to use a certificate for two domain names in a project. The project ID is specified by project_id, and certificate ID is specified by certificate_id The ID of the domain name protected in cloud mode is 85e554189d494c0f97789e93531c9f90, and the ID of the domain name protected in dedicated mode is 4e9e97c425fc463c8f374b90124e8392.

POST https://{Endpoint}/v1/{project_id}/waf/certificate/{certificate_id}/apply-to-hosts?enterprise_project_id=0

{
  "cloud_host_ids" : [ "85e554189d494c0f97789e93531c9f90" ],
  "premium_host_ids" : [ "4e9e97c425fc463c8f374b90124e8392" ]
}

Example Responses

Status code: 200

OK

{
  "id" : "3ac1402300374a63a05be68c641e92c8",
  "name" : "www.abc.com",
  "timestamp" : 1636343349139,
  "expire_time" : 1650794100000,
  "bind_host" : [ {
    "id" : "e350cf556da34adab1f017523d1c05ed",
    "hostname" : "www.demo.com",
    "waf_type" : "cloud"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to use a certificate for two domain names in a project. The project ID is specified by project_id, and certificate ID is specified by certificate_id The ID of the domain name protected in cloud mode is 85e554189d494c0f97789e93531c9f90, and the ID of the domain name protected in dedicated mode is 4e9e97c425fc463c8f374b90124e8392.

 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
54
55
56
57
58
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class ApplyCertificateToHostSolution {

    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);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        ApplyCertificateToHostRequest request = new ApplyCertificateToHostRequest();
        request.withCertificateId("{certificate_id}");
        ApplyCertificateToHostRequestBody body = new ApplyCertificateToHostRequestBody();
        List<String> listbodyPremiumHostIds = new ArrayList<>();
        listbodyPremiumHostIds.add("4e9e97c425fc463c8f374b90124e8392");
        List<String> listbodyCloudHostIds = new ArrayList<>();
        listbodyCloudHostIds.add("85e554189d494c0f97789e93531c9f90");
        body.withPremiumHostIds(listbodyPremiumHostIds);
        body.withCloudHostIds(listbodyCloudHostIds);
        request.withBody(body);
        try {
            ApplyCertificateToHostResponse response = client.applyCertificateToHost(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());
        }
    }
}

The following example shows how to use a certificate for two domain names in a project. The project ID is specified by project_id, and certificate ID is specified by certificate_id The ID of the domain name protected in cloud mode is 85e554189d494c0f97789e93531c9f90, and the ID of the domain name protected in dedicated mode is 4e9e97c425fc463c8f374b90124e8392.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ApplyCertificateToHostRequest()
        request.certificate_id = "{certificate_id}"
        listPremiumHostIdsbody = [
            "4e9e97c425fc463c8f374b90124e8392"
        ]
        listCloudHostIdsbody = [
            "85e554189d494c0f97789e93531c9f90"
        ]
        request.body = ApplyCertificateToHostRequestBody(
            premium_host_ids=listPremiumHostIdsbody,
            cloud_host_ids=listCloudHostIdsbody
        )
        response = client.apply_certificate_to_host(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

The following example shows how to use a certificate for two domain names in a project. The project ID is specified by project_id, and certificate ID is specified by certificate_id The ID of the domain name protected in cloud mode is 85e554189d494c0f97789e93531c9f90, and the ID of the domain name protected in dedicated mode is 4e9e97c425fc463c8f374b90124e8392.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ApplyCertificateToHostRequest{}
	request.CertificateId = "{certificate_id}"
	var listPremiumHostIdsbody = []string{
        "4e9e97c425fc463c8f374b90124e8392",
    }
	var listCloudHostIdsbody = []string{
        "85e554189d494c0f97789e93531c9f90",
    }
	request.Body = &model.ApplyCertificateToHostRequestBody{
		PremiumHostIds: &listPremiumHostIdsbody,
		CloudHostIds: &listCloudHostIdsbody,
	}
	response, err := client.ApplyCertificateToHost(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

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.