文档

CreateWHClientCertificate - 申请证书仓库中客户端证书

更新时间:

一般用户证书仓库中,申请签发单个客户端证书。

接口说明

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cert:CreateWHClientCertificateWrite
  • 全部资源
    acs:yundun-cert:*:{#accountId}:*

请求参数

名称类型必填描述示例值
SanTypelong

客户端证书支持的扩展信息 SAN(Subject Alternative Name)类型。取值:

  • 1:表示邮箱。
  • 2:表示域名。
  • 6:表示统一资源标志符 URI(Uniform Resource Identifier)。
  • 7:表示 IP 地址。
2
SanValuestring

客户端证书的具体扩展信息。支持输入多个扩展信息,如果您需要输入多个扩展信息,请用半角逗号(,)将其隔开。

example.com
CommonNamestring

客户端证书的公用名。支持使用中文、英文字符等。

aliyun
Algorithmstring

客户端证书的密钥算法。密钥算法使用<加密算法>_<密钥长度>格式表示。取值:

  • RSA_1024:对应签名算法为 Sha256WithRSA。
  • RSA_2048 :对应签名算法为 Sha256WithRSA。
  • RSA_4096:对应签名算法为 Sha256WithRSA。
  • ECC_256:对应签名算法为 Sha256WithECDSA。
  • ECC_384:对应签名算法为 Sha256WithECDSA。
  • ECC_512:对应签名算法为 Sha256WithECDSA。
  • SM2_256:对应签名算法为 SM3WithSM2。

客户端证书的加密算法必须与子 CA 证书一致,密钥长度可以不一致。例如:子 CA 证书的密钥算法为 RSA_2048,则客户端证书的密钥算法必须是 RSA_1024、RSA_2048、RSA_4096 中的一种。

RSA_2048
Csrstring

CSR 内容。您可以通过 OpenSSL 工具或者 Keytool 工具生成 CSR。

-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
ParentIdentifierstring

签发该证书的子 CA 证书的唯一识别码。

273ae6bb538d538c70c01f81jh2****
Dayslong

客户端证书的有效期。单位:天。

Days、BeforeTime、AfterTime 参数不能同时为空,并且 BeforeTime、AfterTime 参数必须同时为空或者同时设置。该参数具体设置说明如下:

  • 当设置 Days 参数时,您可以选择同时设置 BeforeTime、AfterTime 参数或者不设置 BeforeTime、AfterTime 参数。
  • 当不设置 Days 参数时,您必须设置 BeforeTime、AfterTime 参数。
说明 当您同时设置 Days、BeforeTime、AfterTime 参数时,客户端证书的有效期以 Days 参数的值为准。
365
BeforeTimelong

客户端证书的签发时间,使用时间戳格式,默认为您调用该接口的时间。单位:秒。

说明 BeforeTime 和 AfterTime 参数必须同时为空或者同时设置。
1634283958
AfterTimelong

客户端证书的服务到期时间,使用时间戳格式。单位:秒。

说明 BeforeTime 和 AfterTime 参数必须同时为空或者同时设置。
1665819958
Organizationstring

根 CA 证书关联的组织机构(对应您的企业或单位)的名称。支持使用中文、英文字符等。

阿里巴巴网络技术有限公司
OrganizationUnitstring

证书所属的公司或组织名称。

IT
Countrystring

购买证书的用户所属的公司或组织所在的国家。

CN
Statestring

组织机构所在省份、直辖市或自治区的名称。支持使用中文、英文字符等。

Zhejiang
Localitystring

组织机构所在城市的名称。支持使用中文、英文字符等。

Hangzhou
Yearslong

证书有效期。单位:年。

1
Monthslong

证书有效期。单位:月。

12
Immediatelylong

立即返回数字证书。

  • 0,不返回。默认值。
  • 1,返回证书。
  • 2, 返回证书及其证书链 。
1

返回参数

名称类型描述示例值
object

对象。

Identifierstring

客户端证书的唯一识别码。

190ae6bb538d538c70c01f81dcf2****
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

8C467B38-3910-447D-87BC-AC049166F216
RootX509Certificatestring

根 CA 证书的内容。

-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----
ParentX509Certificatestring

子 CA 证书的内容。

-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----
X509Certificatestring

客户端证书的内容。

-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----
CertificateChainstring

CA 证书链。

-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n

示例

正常返回示例

JSON格式

{
  "Identifier": "190ae6bb538d538c70c01f81dcf2****",
  "RequestId": "8C467B38-3910-447D-87BC-AC049166F216",
  "RootX509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
  "ParentX509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
  "X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
  "CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)