更新时间:2025-11-28 GMT+08:00
分享

部署证书 - DeployCertificate

功能介绍

部署SSL证书到弹性负载均衡(Elastic Load Balance,简称ELB)、Web应用防火墙(Web Application Firewall,WAF)、CDN(Content Delivery Network,内容分发网络)等其它华为云产品中。

接口约束

  • 上传证书与3个月有效期测试证书,部署其他云产品中,部署费用30元/域名。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    scm:cert:deployResources

    Write

    cert *

    g:ResourceTag/<tag-key>

    -

    -

    -

    g:EnterpriseProjectId

URI

POST /v3/scm/certificates/{certificate_id}/deploy

表1 路径参数

参数

是否必选

参数类型

描述

certificate_id

String

证书id。

最小长度:16

最大长度:16

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:32

最大长度:2097152

表3 请求Body参数

参数

是否必选

参数类型

描述

project_name

String

部署的资源所在的项目名称,若在主项目下,则该值为region id。

最小长度:1

最大长度:255

service_name

String

证书推送的目标服务,当前仅支持:CDN、WAF、ELB。

最小长度:1

最大长度:64

resources

Array of DeployedResource objects

所要部署的资源列表。

数组长度:1 - 20

表4 DeployedResource

参数

是否必选

参数类型

描述

id

String

资源Id,部署WAF与ELB时,必传此字段。

最小长度:0

最大长度:63

type

String

资源类型,当前仅部署WAF资源时需传入,即独享模式(premium)与云模式(cloud)。

最小长度:0

最大长度:63

domain_name

String

需部署的域名,当前仅部署CDN时需传入,即需加速的域名,域名与证书必须可匹配。

最小长度:0

最大长度:63

enterprise_project_id

String

需部署的资源所属的企业项目ID,当前仅部署WAF资源时,需传入。

最小长度:0

最大长度:63

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

failure_list

Array of FaiureResource objects

部署失败的资源列表。

数组长度:1 - 20

表6 FaiureResource

参数

参数类型

描述

resource

String

部署失败的资源信息,部署WAF与ELB时,此字段为资源ID,部署CDN时,本字段为加速域名。

最小长度:0

最大长度:63

failure_info

String

失败原因,一般为目标服务返回的错误码信息。

最小长度:0

最大长度:255

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

请求示例

{
  "service_name" : "ELB",
  "project_name" : "cn-north-7",
  "resources" : [ {
    "id" : "982b8a6a6ebc43809d82a46ca99aaeb7"
  } ]
}

响应示例

状态码:200

正常返回。

{
  "failure_list" : [ {
    "resource" : "982b8a6a6ebc43809d82a46ca99aaeb7",
    "failure_info" : "ELB.8904:certificate 982b8a6a6ebc43809d82a46ca99aaeb7 does not exist"
  } ]
}

状态码:401

认证失败。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码:403

禁止访问。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码:500

请求未完成,服务器内部异常。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

SDK代码示例

SDK代码示例如下。

Java

 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.GlobalCredentials;
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.scm.v3.region.ScmRegion;
import com.huaweicloud.sdk.scm.v3.*;
import com.huaweicloud.sdk.scm.v3.model.*;

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

public class DeployCertificateSolution {

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

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ScmClient client = ScmClient.newBuilder()
                .withCredential(auth)
                .withRegion(ScmRegion.valueOf("<YOUR REGION>"))
                .build();
        DeployCertificateRequest request = new DeployCertificateRequest();
        request.withCertificateId("{certificate_id}");
        DeployCertificateRequestBody body = new DeployCertificateRequestBody();
        List<DeployedResource> listbodyResources = new ArrayList<>();
        listbodyResources.add(
            new DeployedResource()
                .withId("982b8a6a6ebc43809d82a46ca99aaeb7")
        );
        body.withResources(listbodyResources);
        body.withServiceName("ELB");
        body.withProjectName("cn-north-7");
        request.withBody(body);
        try {
            DeployCertificateResponse response = client.deployCertificate(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());
        }
    }
}

Python

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

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkscm.v3.region.scm_region import ScmRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkscm.v3 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"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = DeployCertificateRequest()
        request.certificate_id = "{certificate_id}"
        listResourcesbody = [
            DeployedResource(
                id="982b8a6a6ebc43809d82a46ca99aaeb7"
            )
        ]
        request.body = DeployCertificateRequestBody(
            resources=listResourcesbody,
            service_name="ELB",
            project_name="cn-north-7"
        )
        response = client.deploy_certificate(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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/global"
    scm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := scm.NewScmClient(
        scm.ScmClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DeployCertificateRequest{}
	request.CertificateId = "{certificate_id}"
	idResources:= "982b8a6a6ebc43809d82a46ca99aaeb7"
	var listResourcesbody = []model.DeployedResource{
        {
            Id: &idResources,
        },
    }
	projectNameDeployCertificateRequestBody:= "cn-north-7"
	request.Body = &model.DeployCertificateRequestBody{
		Resources: listResourcesbody,
		ServiceName: "ELB",
		ProjectName: &projectNameDeployCertificateRequestBody,
	}
	response, err := client.DeployCertificate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

请求未完成,服务器内部异常。

错误码

请参见错误码

相关文档