更新时间:2024-05-16 GMT+08:00
分享

部署证书

功能介绍

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

接口约束

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

调试

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

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

状态码

状态码

描述

200

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

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

错误码

请参见错误码

分享:

    相关文档

    相关产品