购买SSL证书 - SubscribeCertificate
功能介绍
购买SSL证书。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
 - 如果使用身份策略授权,需具备如下身份策略权限。
 
URI
POST /v3/scm/certificates/buy
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        cert_brand  | 
      
        是  | 
      
        String  | 
      
        证书品牌,取值如下: 最小长度:0 最大长度:32  | 
     
| 
        cert_type  | 
      
        是  | 
      
        String  | 
      
        证书类型,取值如下: 最小长度:0 最大长度:32  | 
     
| 
        domain_type  | 
      
        是  | 
      
        String  | 
      
        域名类型,取值如下: 最小长度:0 最大长度:32  | 
     
| 
        effective_time  | 
      
        是  | 
      
        Integer  | 
      
        证书有效期(年)。 最小值:1 最大值:3  | 
     
| 
        domain_numbers  | 
      
        是  | 
      
        Integer  | 
      
        域名数量。 最小值:1 最大值:100  | 
     
| 
        order_number  | 
      
        是  | 
      
        Integer  | 
      
        购买的证书数量。取值范围为1~100。 最小值:1 最大值:100  | 
     
| 
        agree_privacy_protection  | 
      
        是  | 
      
        Boolean  | 
      
        是否同意隐私协议,此处仅能设置为true才能成功购买证书。  | 
     
| 
        primary_domain_type  | 
      
        否  | 
      
        String  | 
      
        多域名中的主域名类型。 最小长度:0 最大长度:63  | 
     
| 
        single_domain_number  | 
      
        否  | 
      
        Integer  | 
      
        附加单域名数量。 最小值:1 最大值:100  | 
     
| 
        wildcard_domain_number  | 
      
        否  | 
      
        Integer  | 
      
        附加泛域名数量。 最小值:1 最大值:100  | 
     
| 
        is_auto_pay  | 
      
        否  | 
      
        Boolean  | 
      
        是否开启自动支付。  | 
     
| 
        enterprise_project_id  | 
      
        否  | 
      
        String  | 
      
        企业多项目ID。用户未开通企业多项目时,不需要输入该字段。 用户开通企业多项目时,查询资源可以输入该字段。 若用户不输入该字段,默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段,取值满足以下任一条件。 最小长度:0 最大长度:36  | 
     
| 
        order_id  | 
      
        否  | 
      
        String  | 
      
        订单号。仅组合购买场景使用。 最小长度:0 最大长度:63  | 
     
| 
        tags  | 
      
        否  | 
      
        Array of ScsResourceTag objects  | 
      
        标签列表。 数组长度:0 - 10  | 
     
响应参数
状态码:200
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        order_id  | 
      
        String  | 
      
        订单号。 最小长度:0 最大长度:63  | 
     
| 
        cert  | 
      
        Array of CertDetail objects  | 
      
        证书列表,详情请参见CertDetail字段数据结构说明。 数组长度:0 - 1000  | 
     
状态码:401
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误请求返回的错误码。 最小长度:3 最大长度:36  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误请求返回的错误信息。 最小长度:0 最大长度:1024  | 
     
状态码:403
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误请求返回的错误码。 最小长度:3 最大长度:36  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误请求返回的错误信息。 最小长度:0 最大长度:1024  | 
     
状态码:500
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        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  | 
      
        请求未完成,服务器内部异常。  | 
     
错误码
请参见错误码。