文档

CreateServerCertificate - 基于系统自动生成的CSR签发单个服务端证书

更新时间:

基于系统自动生成的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:CreateServerCertificateWrite
  • 全部资源
    acs:yundun-cert:*:{#accountId}:*

请求参数

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

服务端证书的扩展域名、扩展 IP 地址。为证书添加扩展信息后,您可以将证书应用到多个域名、IP 地址。

多个域名、IP 地址之间需用半角逗号(,)隔开。

example.com
Organizationstring

机构名称,默认:Alibaba Inc。

阿里云
OrganizationUnitstring

部门名称,默认:Aliyun CDN。

IT
Countrystring

国家代码,如 CN,US。

CN
CommonNamestring

表示证书使用者的名称。服务端认证(ServerAuth)证书使用者是服务器,建议填写服务器绑定的域名或 IP。

www.example.com
Statestring

设置证书组织机构所在省份、直辖市或自治区的名称。支持使用中文、英文字符等。默认为签发该证书的子 CA 证书组织机构所在省份、直辖市或自治区的名称。

Zhejiang
Localitystring

设置证书组织机构所在城市的名称。支持使用中文、英文字符等。 默认为签发该证书的子 CA 证书的组织机构所在城市的名称。

Hangzhou
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 中的一种。

说明 您可以调用 DescribeCACertificate 查询子 CA 证书的密钥算法。
RSA_2048
ParentIdentifierstring

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

说明 您可以调用 DescribeCACertificateList 查询子 CA 证书的唯一识别码。
271ae6bb538d538c70c01f81dg3****
Yearsinteger

证书有效期。单位:年。

1
Monthsinteger

证书有效期。单位:月。

12
Daysinteger

服务端证书的有效期。单位:天。 DaysBeforeTimeAfterTime 参数不能同时为空,并且 BeforeTimeAfterTime 参数必须同时为空或者同时设置。该参数具体设置说明如下:

  • 当设置 Days 参数时,您可以选择同时设置 BeforeTimeAfterTime 参数或者不设置 BeforeTimeAfterTime 参数。

  • 当不设置 Days 参数时,您必须设置 BeforeTimeAfterTime 参数。

说明
  • 当您同时设置 DaysBeforeTimeAfterTime 参数时,服务端证书的有效期以 Days 参数的值为准。
    • 服务端证书的有效期不能超过子 CA 证书的有效期。您可以调用 DescribeCACertificate 查看子 CA 证书的有效期。
    365
    BeforeTimelong

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

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

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

    说明 BeforeTimeAfterTime 参数必须同为空或者同时设置。
    1665819958
    Immediatelyinteger

    立即返回数字证书。

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

    是否包含 CRL 地址

    0 - 否

    1 - 是

    1

    调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。

    调用 API 的请求格式,请参见本文示例中的请求示例。

    返回参数

    名称类型描述示例值
    object

    CreateCertificateResponse

    X509Certificatestring

    服务端证书的内容。

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

    CA 证书链。

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

    服务端证书的唯一识别码。

    160ae6bb538d538c70c01f81dcf2****
    SerialNumberstring

    证书序列号。

    084bde9cd233f0ddae33adc438cfbbbd****
    RequestIdstring

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

    15C66C7B-671A-4297-9187-2C4477247A74

    示例

    正常返回示例

    JSON格式

    {
      "X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
      "CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n",
      "Identifier": "160ae6bb538d538c70c01f81dcf2****",
      "SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
      "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-09-05OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:EnableCrl
    2023-07-13OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      删除入参:Csr
    • 本页导读 (1)
    文档反馈