更新时间:2024-04-26 GMT+08:00
分享

购买SSL证书

功能介绍

购买SSL证书。

调试

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

URI

POST /v3/scm/certificates/buy

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:32

最大长度:2097152

表2 请求Body参数

参数

是否必选

参数类型

描述

cert_brand

String

证书品牌,取值如下:

  • GEOTRUST

  • GLOBALSIGN

  • SYMANTEC

  • CFCA

  • TRUSTASIA

  • VTRUS

最小长度:0

最大长度:32

cert_type

String

证书类型,取值如下:

  • DV_SSL_CERT

  • DV_SSL_CERT_BASIC

  • EV_SSL_CERT

  • EV_SSL_CERT_PRO

  • OV_SSL_CERT

  • OV_SSL_CERT_PRO

最小长度:0

最大长度:32

domain_type

String

域名类型,取值如下:

  • SINGLE_DOMAIN:单域名类型。

  • MULTI_DOMAIN:多域名类型。

  • WILDCARD:泛域名类型。

最小长度:0

最大长度:32

effective_time

Integer

证书有效期(年)。

最小值:1

最大值:3

domain_numbers

Integer

域名数量。

  • 当“domain_type”选择的是“SINGLE_DOMAIN”或“WILDCARD”类型的证书时,域名数量取值为“1”。

  • 当“domain_type”选择的是“MULTI_DOMAIN”类型的证书时,域名数量取值范围为“2~100”。

最小值:1

最大值:100

order_number

Integer

购买的证书数量。取值范围为1~100。

最小值:1

最大值:100

agree_privacy_protection

Boolean

是否同意隐私协议,此处仅能设置为true才能成功购买证书。

  • true:同意隐私协议。

  • false:不同意隐私协议。

primary_domain_type

String

多域名中的主域名类型

  • SINGLE_DOMAIN:主单域名

  • WILDCARD_DOMAIN:主泛域名

最小长度:0

最大长度:63

single_domain_number

Integer

附加单域名数量。

最小值:1

最大值:100

wildcard_domain_number

Integer

附加泛域名数量。

最小值:1

最大值:100

is_auto_pay

Boolean

是否开启自动支付。

  • true:开启自动支付。

  • false:不开启自动支付。

enterprise_project_id

String

企业多项目ID。用户未开通企业多项目时,不需要输入该字段。 用户开通企业多项目时,查询资源可以输入该字段。 若用户不输入该字段,默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段,取值满足以下任一条件.

取值为“all”

取值为“0”

满足正则匹配:“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”

最小长度:0

最大长度:36

order_id

String

订单号。仅组合购场景使用

最小长度:0

最大长度:63

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

order_id

String

订单号。

最小长度:0

最大长度:63

cert

Array of CertDetail objects

证书列表,详情请参见CertDetail字段数据结构说明。

数组长度:0 - 1000

表4 CertDetail

参数

参数类型

描述

cert_id

String

证书ID。

最小长度:16

最大长度:16

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

请求示例

{
  "cert_brand" : "GLOBALSIGN",
  "cert_type" : "OV_SSL_CERT",
  "domain_type" : "MULTI_DOMAIN",
  "effective_time" : 1,
  "domain_numbers" : 5,
  "order_number" : 1,
  "agree_privacy_protection" : true
}

响应示例

状态码: 200

正常返回。

{
  "order_id" : "CS1803192259ROA8U",
  "cert" : [ {
    "cert_id" : "scs1481110651012"
  } ]
}

状态码: 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

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

错误码

请参见错误码

分享:

    相关文档

    相关产品