基于系统自动生成的CSR签发单个客户端证书。
接口说明
调用本接口前,您必须已经调用 CreateRootCACertificate 创建了根 CA 证书,并且调用 CreateSubCACertificate 创建了子 CA 证书。只有子 CA 证书才能签发客户端证书。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cert:CreateClientCertificate |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SanType | integer | 否 | 客户端证书支持的扩展信息 SAN(Subject Alternative Name)类型。取值:
| 1 |
SanValue | string | 否 | 客户端证书的具体扩展信息。支持输入多个扩展信息,如果您需要输入多个扩展信息,请用半角逗号(,)将其隔开。 | somebody@example.com |
Organization | string | 否 | 机构名称,默认:Alibaba Inc。 | 阿里云 |
OrganizationUnit | string | 否 | 部门名称,默认:Aliyun CDN。 | IT |
Country | string | 否 | 所属国家,默认:CN。 | CN |
CommonName | string | 否 | 表示证书使用者的名称。客户端认证(ClientAuth)证书使用者一般是自然人、公司、组织或某个应用,建议填写使用者的通用名称。例如,张三、阿里巴巴、阿里云密码平台、天猫精灵等。 | aliyun |
State | string | 否 | 设置证书组织机构所在省份或州的名称。支持使用中文、英文字符等。默认为签发该证书的子 CA 证书组织机构所在省份或州的名称。 | Zhejiang |
Locality | string | 否 | 设置证书组织机构所在城市的名称。支持使用中文、英文字符等。 默认为签发该证书的子 CA 证书的组织机构所在城市的名称。 | 杭州市 |
Algorithm | string | 否 | 客户端证书的密钥算法。密钥算法使用
客户端证书的加密算法必须与子 CA 证书一致,密钥长度可以不一致。例如:子 CA 证书的密钥算法为 RSA_2048,则客户端证书的密钥算法必须是 RSA_1024、RSA_2048、RSA_4096 中的一种。 说明
您可以调用 DescribeCACertificate 查询子 CA 证书的密钥算法。
| RSA_2048 |
ParentIdentifier | string | 否 | 签发该证书的子 CA 证书的唯一识别码。 说明
您可以调用[DescribeCACertificateList]查询子 CA 证书的唯一识别码。
| 273ae6bb538d538c70c01f81jh2**** |
Years | integer | 否 | 购买证书的时长。单位:年。 | 5 |
Months | integer | 否 | 购买证书的时长。单位:月。 | 1 |
Days | integer | 否 | 客户端证书的有效期。单位:天。 Days、BeforeTime、AfterTime 参数不能同时为空,并且 BeforeTime、AfterTime 参数必须同时为空或者同时设置。该参数具体设置说明如下:
说明
| 365 |
BeforeTime | long | 否 | 客户端证书的签发时间,使用时间戳格式,默认为您调用该接口的时间。单位:秒。 说明
BeforeTime 和 AfterTime 参数必须同时为空或者同时设置。
| 1634283958 |
AfterTime | long | 否 | 客户端证书的服务到期时间,使用时间戳格式。单位:秒。 说明
BeforeTime 和 AfterTime 参数必须同时为空或者同时设置。
| 1665819958 |
Immediately | integer | 否 | 立即返回数字证书。
| 1 |
EnableCrl | long | 否 | 是否包含 CRL 地址 0 - 否 1 - 是 | 1 |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。
调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON
格式
{
"X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
"CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n",
"Identifier": "190ae6bb538d538c70c01f81dcf2****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"RequestId": "8C467B38-3910-447D-87BC-AC049166F216"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-20 | OpenAPI 描述信息更新 | 查看变更详情 |
2023-09-05 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-07-13 | OpenAPI 入参发生变更 | 查看变更详情 |