CreateLeafInstance - 创建私有证书实例--证书中心-火山引擎

文档中心

证书中心

私有证书

CreateLeafInstance - 创建私有证书实例

调用本接口签发一本私有证书。

请求说明

接口名称：CreateLeafInstance
请求方式：POST
请求地址：
- IPv4网络接入：pca.volcengineapi.com
- 双栈网络接入（IPv4/IPv6）：pca.volcengine-api.com

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	CreateLeafInstance	要执行的操作，取值：CreateLeafInstance。
Version	String	是	2025-10-01	API的版本，取值：2025-10-01。

Body

参数	类型	是否必填	示例值	描述
CsrCommon	Object	否	-	设置私有证书的申请信息。
Contact	Object	否	-	设置私有证书的联系人信息。
KeyAlg	String	否	RSA	设置私有证书的密钥算法。该参数有以下取值： RSA ECDSA SM2
KeyParam	String	否	2048	设置私有证书的密钥强度。根据 key_alg 的值，该参数有不同的取值。 key_alg 为 RSA 时，该参数的取值有：2048、3072、4096。 key_alg 为 ECDSA 时，该参数的取值有：P256、P384、P521。 key_alg 为 SM2 时，该参数无需设置。
HashAlg	String	是	SHA256	设置私有证书的签名算法。该参数有以下取值： SHA256 SHA384 SHA512
Quantity	Integer	是	10	设置私有证书的有效时长。最小为1小时，最大为30年，并且必须小于上一级CA（即子CA）的有效时长。假设私有子CA将于10天后到期，则私有证书的有效期不能超过10天。
DurationType	String	是	day	设置有效时长（quantity）的单位。该参数有以下取值： hour day month year
NotBefore	String	否	1678778206	私有证书开始生效的时间。使用秒级时间戳表示。
NotAfter	String	否	1681401599	私有证书过期的时间。使用秒级时间戳表示。
Tag	String	否	doc-test-RootCA	私有证书的备注。
Csr	String	否	`-----BEGIN CERTIFICATE REQUEST-----`	PEM 格式的 CSR（Base64 编码）。
OmitCsrContent	Boolean	否	true	是否使用传参覆盖CSR信息。
IssuerId	String	是	pca_sub_MlRaK****	上一级CA实例（子CA实例）的ID。您可以调用 ListSubInstances 接口获取所有子CA实例的ID。
IdempotenceToken	String	否	123e4567-e89b-12d3-a456-426614174000	幂等性token，重放请求时只处理一个。
UseQuota	Boolean	否	true	是否使用配额签发证书。
Extensions	Object	否	-	设置私有证书的扩展信息。
ProjectName	String	否	default	设置私有证书实例所属的项目组。
Tags	Array of Object	否	-	设置资源的标签。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstanceId	String	pca_leaf_M6gaihuZRcO****	私有证书实例的ID。该ID是证书中心为私有证书实例分配的，用于唯一标识私有证书。
PrivateKey	String	`-----BEGIN RSA PRIVATE KEY----- MIIE……1Q== -----END RSA PRIVATE KEY-----`	私有证书的私钥。对于国密算法证书（key_alg 为 SM2），该参数表示用于签名的证书私钥。
EncryptionPrivateKey	String	true	用于加密的证书私钥。只有当您创建国密算法证书（key_alg 为 SM2）时，该参数才会返回。
Certificate	String	`-----BEGIN CERTIFICATE----- MIID……SI4= -----END CERTIFICATE-----`	私有证书的内容。对于国密算法证书（key_alg 为 SM2），该参数表示用于签名的证书。
EncryptionCertificate	String	null	用于加密的证书。只有当您创建国密算法证书（key_alg 为 SM2）时，该参数才会返回。
ParentCertificate	String	`-----BEGIN CERTIFICATE----- MIID……XWlZ -----END CERTIFICATE-----`	对应的子CA证书的内容。
RootCertificate	String	`-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----`	对应的根CA证书的内容。
Chain	String	`-----BEGIN CERTIFICATE----- MIID……SI4= -----END CERTIFICATE----- ,-----BEGIN CERTIFICATE----- MIID……XWlZ -----END CERTIFICATE----- ,-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----`	证书链的内容。证书链由 PEM 格式的叶子证书、中间根证书和根证书组成。对于国密算法证书（key_alg 为 SM2），该参数表示用于签名的证书链。

请求示例

POST /?Action=CreateLeafInstance&Version=2025-10-01 HTTP/1.1
Host: pca.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251030T062536Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251030/cn-beijing/pca/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "CsrCommon": {
    "Subject": {
      "Country": [
        "CN"
      ],
      "Organization": [
        "Volcano\n"
      ],
      "OrganizationalUnit": [
        "ti"
      ],
      "Locality": [
        "北京"
      ],
      "Province": [
        "北京"
      ],
      "StreetAddress": [
        "某某路某某号"
      ],
      "PostalCode": [
        "100080"
      ],
      "SerialNumber": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",
      "CommonName": "Volcengine CA"
    },
    "Email": "zhangsan@example.com",
    "San": [
      "www.example.com"
    ]
  },
  "Contact": {
    "Name": "张三",
    "Email": "zhangsan@example.com",
    "PhoneNumber": "131****1111"
  },
  "KeyAlg": "RSA",
  "KeyParam": "2048",
  "HashAlg": "SHA256",
  "Quantity": 10,
  "DurationType": "day",
  "NotBefore": "1678778206",
  "NotAfter": "1681401599",
  "Tag": "doc-test-RootCA",
  "Csr": "`-----BEGIN CERTIFICATE REQUEST-----`",
  "OmitCsrContent": true,
  "IssuerId": "pca_sub_MlRaK****",
  "IdempotenceToken": "123e4567-e89b-12d3-a456-426614174000",
  "UseQuota": true,
  "Extensions": {
    "KeyUsages": {
      "DigitalSignature": true,
      "NonRepudiation": true,
      "KeyEncipherment": true,
      "DataEncipherment": true,
      "KeyAgreement": true,
      "KeyCertSign": true,
      "CrlSign": true,
      "EncipherOnly": true,
      "DecipherOnly": true
    },
    "ExtendedKeyUsages": {
      "ServerAuth": true,
      "ClientAuth": true,
      "CodeSigning": true,
      "EmailProtection": true,
      "TimeStamping": true,
      "OCSPSigning": true
    },
    "CustomExtensions": {
      "Critical": true,
      "ObjectIdentifier": "1.3.6.1.4.1.55555.1.1",
      "Value": "example_value"
    }
  },
  "ProjectName": "default",
  "Tags": [
    {
      "Key": "env",
      "Value": "test"
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20251030142541203240099254B59BA8",
    "Action": "CreateLeafInstance",
    "Version": "2025-10-01",
    "Service": "pca",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "pca_leaf_M6gaihuZRcO****",
    "PrivateKey": "`-----BEGIN RSA PRIVATE KEY----- MIIE……1Q== -----END RSA PRIVATE KEY-----`",
    "EncryptionPrivateKey": "true",
    "Certificate": "`-----BEGIN CERTIFICATE----- MIID……SI4= -----END CERTIFICATE-----`",
    "EncryptionCertificate": "null",
    "ParentCertificate": "`-----BEGIN CERTIFICATE----- MIID……XWlZ -----END CERTIFICATE-----`",
    "RootCertificate": "`-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----`",
    "Chain": "`-----BEGIN CERTIFICATE----- MIID……SI4= -----END CERTIFICATE----- ,-----BEGIN CERTIFICATE----- MIID……XWlZ -----END CERTIFICATE----- ,-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----`"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	QuotaExceeded	%s has exceeded the quota. example: The memory size of the specified disk has exceeded the quota.	资源超出配额限制。

最近更新时间：2026.01.07 17:39:54

这个页面对您有帮助吗？

有用

无用

证书中心

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #