DownloadLeafInstance - 下载私有证书实例--证书中心-火山引擎

文档中心

立即注册

证书中心

私有证书

DownloadLeafInstance - 下载私有证书实例

调用本接口下载已签发的私有证书实例。

使用说明

通过下载私有证书，您可以获取私有证书的私钥；而在查询私有证书详情时，您无法获取私有证书的私钥。
私有证书只有处于正常运行状态，才允许被下载。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
DownloadType	String	是	pem	下载私有证书为指定的格式。该参数的取值固定为`pem`。
IsTarball	Boolean	是	true	是否以压缩包形式下载私有证书。该参数有以下取值： true：只返回以Base64编码后的压缩包文件流。 false：分别返回证书、证书链、证书私钥等内容。
Password	String	否	123456	为证书私钥设置一个加密密码。如果您未设置密码，则私钥将以明文形式返回。如果您设置了密码，那么私钥内容将基于PKCS#8方式进行加密后再返回给您。您可以使用您设置的密码进行解密，从而获得私钥内容。
InstanceId	String	是	pca_leaf_3WdHJps3YYB****	要下载的私有证书实例的ID。您可以调用 ListLeafInstances 接口获取所有私有证书实例的ID。

返回参数

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

参数	类型	示例值	描述
Certificate	String	`-----BEGIN CERTIFICATE----- MIIE……fytY= -----END CERTIFICATE-----`	私有证书的内容。
CertificateChain	String	`-----BEGIN CERTIFICATE----- MIIE……fytY= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIE……tS9Y -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIID……qA== -----END CERTIFICATE-----`	私有证书的证书链。证书链由PEM格式的叶子证书、中间根证书和根证书组成。对于国密证书，该参数表示用于签名的证书链。
PrivateKey	String	`-----BEGIN ENCRYPTED PRIVATE KEY----- MIIF……2Chv -----END ENCRYPTED PRIVATE KEY-----`	证书证书的私钥。对于国密证书，该参数表示用于签名的证书私钥。如果您在请求参数中指定了`password`，那么私钥内容是基于PKCS#8方式进行加密的。
EncryptCertificate	String	null	对于国密证书，该参数表示用于加密的证书链。对于非国密证书，该参数值为空。证书链由PEM格式的叶子证书、中间根证书和根证书组成。
EncryptPrivateKey	String	null	对于国密证书，该参数表示用于加密的证书私钥。对于非国密证书，该参数值为空。如果您在请求参数中指定了`password`，那么私钥内容是基于PKCS#8方式进行加密的。
TarballBytes	String	null	Base64编码后的压缩包文件流。

请求示例

POST /?Action=DownloadLeafInstance&Version=2025-10-01 HTTP/1.1
Host: pca.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251030T061626Z
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

{
  "DownloadType": "pem",
  "IsTarball": true,
  "Password": "123456",
  "InstanceId": "pca_leaf_3WdHJps3YYB****"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202510301416310950010500792AB8DD",
    "Action": "DownloadLeafInstance",
    "Version": "2025-10-01",
    "Service": "pca",
    "Region": "cn-beijing"
  },
  "Result": {
    "Certificate": "-----BEGIN CERTIFICATE----- MIIE……fytY= -----END CERTIFICATE----- ",
    "CertificateChain": "-----BEGIN CERTIFICATE----- MIIE……fytY= -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIIE……tS9Y -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- MIID……qA== -----END CERTIFICATE-----",
    "PrivateKey": "-----BEGIN ENCRYPTED PRIVATE KEY----- MIIF……2Chv -----END ENCRYPTED PRIVATE KEY-----",
    "EncryptCertificate": "null",
    "EncryptPrivateKey": "null",
    "TarballBytes": "null"
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	MissingParameter	The required parameter %s is missing.	缺少必填参数。
200	MalformedRequest	The request is malformed	请求参数格式不合法。
200	InternalError	The request has failed due to an unknown error.	未知错误。
200	InvalidParameter	The specified parameter %s is invalid.	指定的参数值无效。

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

这个页面对您有帮助吗？

有用

无用

证书中心

使用说明 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #