提交证书申请。
接口说明
- 发起请求前,请确保您已购买对应规格的证书资源包。关于如何购买证书资源包,请参见购买证书资源包。您可以调用 DescribePackageState 查询指定规格的证书资源包的使用概况,包含已购买该规格证书资源包的总数、已提交证书申请的次数、成功签发证书的次数。
- 调用本接口提交证书申请并成功签发证书后,将会消耗您已购买的对应规格的证书资源包的个数。您在发起请求时,可以通过 ProductCode 参数指定要申请的证书规格。
- 调用本接口提交证书申请后,您还需要调用 DescribeCertificateState 接口,获取完成域名验证所需要的信息,并在域名的 DNS 管理平台(DNS 验证方式)或者域名服务器(文件验证方式)手动完成验证,然后证书申请订单才会进入 CA 中心审核环节。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cert:CreateCertificateForPackageRequest | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Csr | string | 否 | 您使用 OpenSSL 或 Keytool 工具为域名手动生成的 CSR 文件的内容。CSR 文件的密钥类型必须是 RSA、ECC 算法,且 RSA 算法的密钥长度必须大于等于 2048。关于 CSR 文件的制作方法,请参见创建 CSR。如果不设置该参数,表示由 SSL 证书服务自动为您创建 CSR。 CSR(Certificate Signing Request)是证书签名请求文件,包含了您的服务器信息和公司信息。申请证书时需要将您证书的 CSR 文件提交给 CA 认证中心审核,CA 中心对 CSR 文件进行根证书私钥签名后,会生成证书公钥文件(即签发给您的 SSL 证书)。 注意
CSR 中的 CN 字段表示证书绑定的域名。您设置 CSR 参数时,该字段为必填字段。
| -----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST----- |
ProductCode | string | 否 | 要申请的证书规格。取值:
| digicert-free-1-free |
Username | string | 否 | 申请联系人的姓名。 如果不设置该参数,表示从信息管理模块中选择使用最新添加的一条联系人信息。关于在信息管理模块中添加联系人的具体操作,请参见管理联系人。 | Tom |
Phone | string | 否 | 申请联系人的手机号码。后续 CA 中心工作人员可能会通过该电话联系您,验证您的证书申请信息。 如果不设置该参数,表示从信息管理模块中选择使用最新添加的一条联系人信息。关于在信息管理模块中添加联系人的具体操作,请参见管理联系人。 | 1390000**** |
string | 否 | 申请联系人的邮箱地址。CA 中心收到您的证书申请后,将向该邮箱发送一封证书申请验证邮件。您需要登录该邮箱,查收相关邮件,并按照邮件提示完成验证。 如果不设置该参数,表示从信息管理模块中选择使用最新添加的一条联系人信息。关于在信息管理模块中添加联系人的具体操作,请参见管理联系人。 | username@example.com | |
Domain | string | 否 | 证书要绑定的域名。具体要求如下:
注意
证书绑定多个域名时,该参数为必填项。该参数与 Csr 参数不允许同时为空。如果您同时设置了该参数和 Csr 参数,则取 Csr 中的 CN 字段值作为证书绑定的域名。
| aliyundoc.com |
CompanyName | string | 否 | 证书申请公司的名称。 说明
该参数仅适用于申请 OV 证书。申请 OV 证书时,您必须先在数字证书管理服务控制台的信息管理模块添加公司信息,具体操作,请参见管理公司信息。申请 DV 证书时,无需添加公司信息。
申请 OV 证书时,如果您在此处设置了公司名称,则表示使用信息管理模块中对应的公司信息;如果您没有设置该参数,则表示从信息管理模块中选择使用最新添加的一条公司信息。 | 某公司 |
ValidateType | string | 否 | 域名所有权的验证方式。取值:
关于两种验证方式的更多信息,请参见如何配置域名授权验证?。 | DNS |
Tags | array<object> | 否 | 标签列表。 | |
object | 否 | 要查询的 Tags 列表,采用 JSON 字符串的形式,最多包含 20 个子项。 | ||
Key | string | 否 | 标签键。 | runtime |
Value | string | 否 | 标签的 Value 值。支持查询多个标签 Value 值。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": 2021010,
"RequestId": "5890029B-938A-589E-98B9-3DEC7BA7C400"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-20 | OpenAPI 描述信息更新 | 查看变更详情 |