文档首页/ 云证书管理服务 CCM/ API参考/ API/ 管理SSL证书/ 证书申请管理/ 申请证书
更新时间：2024-12-18 GMT+08:00
查看PDF
分享

申请证书

功能介绍

申请证书。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

certificate_id

是

String

证书id。

最小长度：16

最大长度：16

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

最小长度：32

最大长度：2097152
表3 请求Body参数

参数

是否必选

参数类型

描述

domain

是

String

该证书绑定的域名。

  • 当购买的证书为“单域名”或“泛域名”类型的证书时，请直接填写单域名或泛域名即可。

  • 当购买的证书为“多域名”类型的证书时，需要选择1个域名作为主域名。

    示例：www.example.com

最小长度：0

最大长度：255

sans

否

String

绑定多域名类型证书的附加域名。

当购买的证书为“多域名”类型的证书，且有可增加附加域名的额度时，才需要设置该值。

多个域名需要以“;”隔开。

示例：www.example.com;www.example1.com;www.example2.com

最小长度：0

最大长度：4096

csr

否

String

证书CSR串，与域名必须匹配。

最小长度：0

最大长度：5120

company_name

否

String

公司名称，OV和EV型证书必填。字符长度为0~63位。

最小长度：0

最大长度：63

company_unit

否

String

部门名称。字符长度为0~63位。

最小长度：0

最大长度：63

company_province

否

String

公司所在省份，OV和EV型证书必填。字符长度为0~63位。

最小长度：0

最大长度：63

company_city

否

String

公司所在市区，OV和EV型证书必填。字符长度为0~63位。

最小长度：0

最大长度：63

country

否

String

OV和EV型证书必填,国家编码，需符合正则"[A-Za-z]{2}"。

最小长度：2

最大长度：2

applicant_name

是

String

申请人的姓名。请输入中文、英文字符，下划线，中划线，英文逗号，英文句点，且长度为4到100字节。

最小长度：0

最大长度：63

applicant_phone

是

String

申请人的电话号码。示例：13212345678

最小长度：0

最大长度：63

applicant_email

是

String

申请人的邮箱。示例：example@huawei.com

最小长度：0

最大长度：256

contact_name

否

String

技术联系人的姓名。字符长度为0~63位。

最小长度：0

最大长度：63

contact_phone

否

String

技术联系人的电话号码。示例：13212345678

最小长度：0

最大长度：63

contact_email

否

String

技术联系人的邮箱。示例：example@huawei.com

最小长度：0

最大长度：256

auto_dns_auth

否

Boolean

是否将DNS验证信息推送到华为云解析服务。

  • true：推送。

  • false：不推送。

agree_privacy_protection

是

Boolean

是否同意授权隐私协议。此处仅能设置为true才能成功申请证书。

  • true：同意隐私协议。

  • false：不同意隐私协议。

domain_method

是

String

域名验证方式。

  • DNS: DNS验证，指在域名管理平台通过解析指定的DNS记录，验证域名所有权。

  • FILE: 文件验证，指通过在服务器上创建指定文件的方式来验证域名所有权。

  • EMAIL: 邮箱验证，指登录域名管理员邮箱，接收域名确认邮件并根据提示进行操作来验证域名所有权。

    DV域名型和DV基础版证书（GeoTrust入门级SSL证书和DigiCert免费SSL证书）默认通过“DNS验证”方式进行验证。

    纯IP（公网IP）的证书仅支持通过“文件验证”方式进行验证，且仅纯IP证书支持“文件验证”方式验证。

最小长度：0

最大长度：32

key_algorithm

否

String

密钥算法。默认RSA_2048

最小长度：0

最大长度：32

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_info

String

请求结果。

最小长度：0

最大长度：63

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

请求示例

{
  "domain" : "www.test.com",
  "company_name" : "xx公司",
  "company_province" : "四川",
  "company_city" : "成都",
  "applicant_name" : "xx",
  "applicant_phone" : "12312345678",
  "applicant_email" : "example@test.com",
  "csr" : "",
  "sans" : "",
  "country" : "CN",
  "company_unit" : "IT",
  "contact_name" : "test",
  "contact_phone" : "12312345678",
  "contact_email" : "example@test.com",
  "auto_dns_auth" : false,
  "agree_privacy_protection" : true
}

响应示例

状态码： 200

正常返回。

{
  "request_info" : "success"
}

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

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

错误码

请参见错误码。

父主题： 证书申请管理

相关文档