文档首页/ 云证书管理服务 CCM/ API参考/ API说明/ 管理私有证书/ 私有证书管理/ 申请证书

更新时间：2024-10-24 GMT+08:00

在线调试

CLI示例

查看PDF

申请证书

功能介绍

申请证书。

调试

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

URI

POST /v1/private-certificates

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：32 最大长度：2097152

表2 请求Body参数
参数	是否必选	参数类型	描述
issuer_id	是	String	父CA证书ID。最小长度：36 最大长度：36
key_algorithm	否	String	密钥算法。若用户不输入该字段，默认使用签发CA的密钥算法。可选值如下： RSA2048 : RSA算法，密钥长度2048位； RSA4096 : RSA算法，密钥长度4096位； EC256 : 椭圆曲线算法（Elliptic Curve Digital Signature Algorithm (ECDSA)），密钥长度256位； EC384 : 椭圆曲线算法（Elliptic Curve Digital Signature Algorithm (ECDSA)），密钥长度384位； SM2 : 国家密码管理局颁发的椭圆曲线算法（签名哈希算法SM3），密钥长度256位。
signature_algorithm	否	String	签名哈希算法。若用户不输入该字段，默认使用签发CA的签名哈希算法。可选值如下： SHA256 SHA384 SHA512 SM3
distinguished_name	是	CertDistinguishedName object	证书名称配置，详情请参见CertDistinguishedName字段数据结构说明。
validity	是	Validity object	证书有效期，详情请参见Validity字段数据结构说明。
key_usages	否	Array of strings	密钥用法，具体标准参见RFC 5280中:4.2.1.3节。 digitalSignature : 数字签名； nonRepudiation : 不可抵赖； keyEncipherment : 密钥用于加密密钥数据； dataEncipherment : 用于加密数据； keyAgreement : 密钥协商； keyCertSign : 签发证书； cRLSign : 签发吊销列表； encipherOnly : 仅用于加密； decipherOnly : 仅用于解密。
subject_alternative_names	否	Array of SubjectAlternativeName objects	主体备用名称，详情请参见SubjectAlternativeName字段数据结构说明。 array大小：[0,20]。数组长度：0 - 20
extended_key_usage	否	ExtendedKeyUsage object	增强型密钥用法，详情请参见ExtendedKeyUsage字段数据结构说明。
customized_extension	否	CustomizedExtension object	自定义扩展信息，详情请参见CustomizedExtension字段数据结构说明。
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}$”

表3 CertDistinguishedName
参数	是否必选	参数类型	描述
common_name	是	String	证书通用名称（CN），名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成，长度不能超过64位字符。最小长度：1 最大长度：64
country	否	String	国家编码，只能由英文组成，长度为2位字符。若不传入，则默认继承父CA对应的值。最小长度：2 最大长度：2
state	否	String	省市名称，名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成，长度不能超过128位字符。若不传入，则默认继承父CA对应的值。最小长度：1 最大长度：128
locality	否	String	地区名称，名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成，长度不能超过128位字符。若不传入，则默认继承父CA对应的值。最小长度：1 最大长度：128
organization	否	String	组织名称，名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成，长度不能超过64位字符。若不传入，则默认继承父CA对应的值。最小长度：1 最大长度：64
organizational_unit	否	String	组织单元名称，名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成，长度不能超过64位字符。若不传入，则默认继承父CA对应的值。最小长度：1 最大长度：64

表4 Validity
参数	是否必选	参数类型	描述
type	是	String	有效期类型，为必填值： YEAR : 年（12个月） MONTH : 月（统一按31天） DAY : 日 HOUR : 小时
value	是	Integer	证书有效期值，与type对应的类型值，换算成年需满足以下规则：根CA，有效期小于等于30年；从属CA与私有证书，有效期小于等于20年。
start_from	否	Integer	起始时间，为可选值: 格式为时间戳（毫秒级），如1645146939688代表2022-02-18 09:15:39；不早于当前时间5分钟，即start_from > (current_time - 5min)。

表5 SubjectAlternativeName
参数	是否必选	参数类型	描述
type	是	String	备用名称类型，当前仅支持DNS、IP、EMAIL、URI。 DNS IP EMAIL URI
value	是	String	对应备用名称类型的值。 DNS类型，长度为不超过253； IP类型，长度不超过39，支持IPV4、IPV6； EMAIL类型，长度不超过256； URI类型，长度不超过253。

表6 ExtendedKeyUsage
参数	是否必选	参数类型	描述
server_auth	否	Boolean	服务器身份验证，OID为：1.3.6.1.5.5.7.3.1。 true false 说明：服务器证书请启用本增强型密钥用法，默认为false。缺省值：false
client_auth	否	Boolean	客户端身份验证，OID为：1.3.6.1.5.5.7.3.2。 true false 说明：客户端证书请启用本增强型密钥用法，默认为false。缺省值：false
code_signing	否	Boolean	代码签名，OID为：1.3.6.1.5.5.7.3.3。 true false 说明：签署可下载的可执行代码客户端认证，默认为false。缺省值：false
email_protection	否	Boolean	安全电子邮件，OID为：1.3.6.1.5.5.7.3.4。 true false 说明：电子邮件保护，默认为false。缺省值：false
time_stamping	否	Boolean	时间戳，OID为：1.3.6.1.5.5.7.3.8。 true false 说明：将一个对象的哈希绑定到一个时间，默认为false。缺省值：false

表7 CustomizedExtension
参数	是否必选	参数类型	描述
object_identifier	否	String	对象标识符。说明：本参数需要满足ASN1规范的点分十进制符号格式的字符串，如1.3.6.1.4.1.2011.4.99。最小长度：1 最大长度：64
value	否	String	自定义属性内容。最小长度：1 最大长度：64

响应参数

状态码： 200

表8 响应Body参数
参数	参数类型	描述
certificate_id	String	当前签发的证书ID。最小长度：36 最大长度：36

状态码： 400

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误请求返回的错误码。最小长度：3 最大长度：36
error_msg	String	错误请求返回的错误信息。最小长度：0 最大长度：1024

状态码： 401

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误请求返回的错误码。最小长度：3 最大长度：36
error_msg	String	错误请求返回的错误信息。最小长度：0 最大长度：1024

状态码： 403

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误请求返回的错误码。最小长度：3 最大长度：36
error_msg	String	错误请求返回的错误信息。最小长度：0 最大长度：1024

状态码： 404

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误请求返回的错误码。最小长度：3 最大长度：36
error_msg	String	错误请求返回的错误信息。最小长度：0 最大长度：1024

状态码： 500

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误请求返回的错误码。最小长度：3 最大长度：36
error_msg	String	错误请求返回的错误信息。最小长度：0 最大长度：1024

请求示例

申请证书，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。

POST https://{Endpoint}/v1/private-certificates

{
  "key_algorithm" : "RSA2048",
  "distinguished_name" : {
    "country" : "CN",
    "state" : "Sichuan",
    "locality" : "Chengdu",
    "organization" : "TestA",
    "organizational_unit" : "CloudBU",
    "common_name" : "TestCert"
  },
  "subject_alternative_names" : [ {
    "type" : "IP",
    "value" : "156.127.116.38"
  } ],
  "signature_algorithm" : "SHA256",
  "validity" : {
    "type" : "YEAR",
    "value" : 3
  },
  "issuer_id" : "2cb2878b-6cd1-460d-bd25-afe655159bdc",
  "key_usages" : [ "digitalSignature", "nonRepudiation" ]
}

响应示例

状态码： 200

请求已成功

{
  "certificate_id" : "ae9a326a-b61e-4446-854d-cda30ffe31f5"
}

状态码： 400

请求参数有误。

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

状态码： 401

被请求的页面需要鉴权。

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

状态码： 403

认证失败。

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

状态码： 404

资源不存在或资源未找到。

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

状态码： 500

服务内部错误。

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

状态码

状态码	描述
200	请求已成功
400	请求参数有误。
401	被请求的页面需要鉴权。
403	认证失败。
404	资源不存在或资源未找到。
500	服务内部错误。

错误码

请参见错误码。

父主题： 私有证书管理

上一篇：查询私有证书列表

下一篇：通过CSR签发证书

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

申请证书

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线