You need to enable JavaScript to run this app.
导航
下载私有证书
最近更新时间:2023.10.31 14:35:41首次发布时间:2023.08.11 19:16:09

API 说明

API 名称:DownloadLeafInstance
API 域名:open.volcengineapi.com
API 描述:调用本接口下载已签发的私有证书。

说明

通过下载私有证书,您可以获取私有证书的私钥;而在查询私有证书详情时,您无法获取私有证书的私钥。

请求方法

POST

使用限制

  • 私有证书只有处于正常运行状态,才允许被下载。
  • 节流限制:暂无。

公共请求头参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下三个请求头(header)参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
示例
Region
String
服务地区。该参数的取值是 cn-north-1
cn-north-1
ServiceName
String
服务名称。该参数的取值是 pca
pca

请求参数

参数名称
数据类型
是否必选
参数说明
示例
Action
String
API 的名称。该参数的取值是 DownloadLeafInstance
DownloadLeafInstance
Version
String
API 的版本。该参数的取值是 2023-05-01
2023-05-01

请求正文

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

响应正文

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

示例

请求示例

GET https://open.volcengineapi.com/?Action=DownloadLeafInstance&Version=2023-05-01&<其他公共请求参数>

{
    "instance_id": "pca_leaf_3WdHJps3YYB****",
    "download_type": "pem",
    "is_tarball": false,
    "password": "12345"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202308101138486CCC0CCDB4D383FD90C2",
        "Action": "DownloadLeafInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-beijing"
    },
    "Result": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIEADCCAuigAwIBAgIUbe02xg03ewCWysZ9CwdFB22sakUwDQYJKoZIhvcNAQEL\nBQAwWzEYMBYGA1UEAwwPUlNBIERFRkFVTFQgU1VCMQswCQYDVQQKDAJRQzELMAkG\nA1UECwwCUUMxCzAJBgNVBAYTAkNOMQswCQYDVQQIDAJRQzELMAkGA1UEBwwCUUMw\nHhcNMjMwNTExMDMxMDA0WhcNMjMwODE5MDMxMDA0WjBcMRkwFwYDVQQDDBBSU0Eg\nREVGQVVMVCBMRUFGMQswCQYDVQQKDAJRQzELMAkGA1UECwwCUUMxCzAJBgNVBAYT\nAkNOMQswCQYDVQQIDAJRQzELMAkGA1UEBwwCUUMwggEiMA0GCSqGSIb3DQEBAQUA\nA4IBDwAwggEKAoIBAQCjDwkMbyhK8d4NikIQYa+jAd2FnvVGiX3C7ak7Qugx8zIq\nnVThVpDkmzHOWw2K8qF9iyZq1Dh49nizYFza2fNbl3x8KPSim0QEw70WG+dhNW9Y\nqbwYQDx73yW2W4pvLUbZ89fQl0R44rEVilmcP6xecR+uo5CrFuv64wIhjjcSTxBu\nmkVnU0bM+szWhX4nl0SfNPC2BRcD7VAGJY6Gou7awuzwJDe7H4IGHl0x11qUztgE\ntJGo6F2a9JbZot48gfGD4kXpngSsOHvY52t50AmImh1xay12UVtexj1Q5Xg0xtWZ\nDmY9ddzM92xSxSMJDoyReMZ6wqYviEWAh3DCJRvnAgMBAAGjgbowgbcwDgYDVR0P\nAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjBSBgNVHR8E\nSzBJMEegRaBDhkFodHRwOi8vY3JsLndlYnBraS5uZXQ/c249M0VDNzRGNjRCRTRD\nODYzMjc3OTk2NjVBNTY0QjE5RDI3MThCQUU5QTAyBggrBgEFBQcBAQQmMCQwIgYI\nKwYBBQUHMAGGFmh0dHA6Ly9vY3NwLndlYnBraS5uZXQwDQYJKoZIhvcNAQELBQAD\nggEBAJ8Ig80zW7vHpfX2In4vLp1pFgcNs4gyBiGjFOcdN575085scDNUMUXx3yYi\n9z51i1VjESPCarm3D18nxbNS8LqHY734EEaql/u15PUCWq6wQooVxF8EoQWa7Ljs\nYg5/Prn5kUHjLMi39OGiiKbWGeelHYjxDpYNoY2+VtIkcux+Q7dfiTjt5VVO6VA9\nPD0oDN4LM96nEA77VohRjQJMmDm9B0uQhq52skHY4rSy8/rgrgpCyJyf/Pmb1kKy\nuZdoy7HsnzqagZf7OXTaXPTQQNdwQHBKQm5cCEdICswSxUB89uuSY3tJFIsIEw4t\nfMHHwsYOmmjR8X7FGCfxWE3fytY=\n-----END CERTIFICATE-----\n",
        "certificate_chain": "-----BEGIN CERTIFICATE-----\nMIIEADCCAuigAwIBAgIUbe02xg03ewCWysZ9CwdFB22sakUwDQYJKoZIhvcNAQEL\nBQAwWzEYMBYGA1UEAwwPUlNBIERFRkFVTFQgU1VCMQswCQYDVQQKDAJRQzELMAkG\nA1UECwwCUUMxCzAJBgNVBAYTAkNOMQswCQYDVQQIDAJRQzELMAkGA1UEBwwCUUMw\nHhcNMjMwNTExMDMxMDA0WhcNMjMwODE5MDMxMDA0WjBcMRkwFwYDVQQDDBBSU0Eg\nREVGQVVMVCBMRUFGMQswCQYDVQQKDAJRQzELMAkGA1UECwwCUUMxCzAJBgNVBAYT\nAkNOMQswCQYDVQQIDAJRQzELMAkGA1UEBwwCUUMwggEiMA0GCSqGSIb3DQEBAQUA\nA4IBDwAwggEKAoIBAQCjDwkMbyhK8d4NikIQYa+jAd2FnvVGiX3C7ak7Qugx8zIq\nnVThVpDkmzHOWw2K8qF9iyZq1Dh49nizYFza2fNbl3x8KPSim0QEw70WG+dhNW9Y\nqbwYQDx73yW2W4pvLUbZ89fQl0R44rEVilmcP6xecR+uo5CrFuv64wIhjjcSTxBu\nmkVnU0bM+szWhX4nl0SfNPC2BRcD7VAGJY6Gou7awuzwJDe7H4IGHl0x11qUztgE\ntJGo6F2a9JbZot48gfGD4kXpngSsOHvY52t50AmImh1xay12UVtexj1Q5Xg0xtWZ\nDmY9ddzM92xSxSMJDoyReMZ6wqYviEWAh3DCJRvnAgMBAAGjgbowgbcwDgYDVR0P\nAQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjBSBgNVHR8E\nSzBJMEegRaBDhkFodHRwOi8vY3JsLndlYnBraS5uZXQ/c249M0VDNzRGNjRCRTRD\nODYzMjc3OTk2NjVBNTY0QjE5RDI3MThCQUU5QTAyBggrBgEFBQcBAQQmMCQwIgYI\nKwYBBQUHMAGGFmh0dHA6Ly9vY3NwLndlYnBraS5uZXQwDQYJKoZIhvcNAQELBQAD\nggEBAJ8Ig80zW7vHpfX2In4vLp1pFgcNs4gyBiGjFOcdN575085scDNUMUXx3yYi\n9z51i1VjESPCarm3D18nxbNS8LqHY734EEaql/u15PUCWq6wQooVxF8EoQWa7Ljs\nYg5/Prn5kUHjLMi39OGiiKbWGeelHYjxDpYNoY2+VtIkcux+Q7dfiTjt5VVO6VA9\nPD0oDN4LM96nEA77VohRjQJMmDm9B0uQhq52skHY4rSy8/rgrgpCyJyf/Pmb1kKy\nuZdoy7HsnzqagZf7OXTaXPTQQNdwQHBKQm5cCEdICswSxUB89uuSY3tJFIsIEw4t\nfMHHwsYOmmjR8X7FGCfxWE3fytY=\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIEATCCAumgAwIBAgIUPsdPZL5MhjJ3mWZaVksZ0nGLrpowDQYJKoZIhvcNAQEL\nBQAwXDEZMBcGA1UEAwwQUlNBIERFRkFVTFQgUk9PVDELMAkGA1UECgwCUUMxCzAJ\nBgNVBAsMAlFDMQswCQYDVQQGEwJDTjELMAkGA1UECAwCUUMxCzAJBgNVBAcMAlFD\nMB4XDTIzMDUxMTAzMDg1NVoXDTI0MDUxMTE1NTk1OVowWzEYMBYGA1UEAwwPUlNB\nIERFRkFVTFQgU1VCMQswCQYDVQQKDAJRQzELMAkGA1UECwwCUUMxCzAJBgNVBAYT\nAkNOMQswCQYDVQQIDAJRQzELMAkGA1UEBwwCUUMwggEiMA0GCSqGSIb3DQEBAQUA\nA4IBDwAwggEKAoIBAQDX7RA9wIPMCDFN2qiEKRy1jHHwpeeI4se8raCqXaWqeRqd\nFk7XUMCjsBjnwpWnVV6z3fd2kaVfFiZnY/4HheCz3J35Q9OfyauzCC37k1H/2nED\nyNVagmcpy8qnwvRaD46pDHtZwr6hOV0fhxbC/Y8ZWyp+SN1cegCuz4Qudpb/7GIG\nan6abz7HBqo8kP3xB6MFnpaTZ/4bJ+8Iw478gnld/zoYD5RXr+uM8aFuL3j4FLA2\nP6LvsxkCBPG6z6raGsvgeNxYKXg3zH3fORqA6SiM/sMFFWMRSJt/RrdS4FcmY9yp\n3Sm8JEf12owB+QCmEE3acZwW9bf2R+dOth3sxqubAgMBAAGjgbswgbgwDwYDVR0T\nBAgwBgEB/wIB/zAMBgNVHQ8EBQMDB/+AMA8GA1UdJQQIMAYGBFUdJQAwUgYDVR0f\nBEswSTBHoEWgQ4ZBaHR0cDovL2NybC53ZWJwa2kubmV0P3NuPTE0MTE2NjFBQzg0\nQTI2MDRDREMzOUIyQjM0MTUyMTg5NzMyNzg3NUUwMgYIKwYBBQUHAQEEJjAkMCIG\nCCsGAQUFBzABhhZodHRwOi8vb2NzcC53ZWJwa2kubmV0MA0GCSqGSIb3DQEBCwUA\nA4IBAQACsX4+AmmDfJnuu92lbD+mYvg/QCdIY8sWrAsb/aQFIbXjZKXNeDGzGBbe\nHLDnYtGaS8IIrRlgQ1gZCTUbziG0NHPftsx7ITAZbw8ErZRay7USyNrmNnTB5dRC\nXb+609a6DQAVZCAJjl2GoPBo6j7mErakPP5bu1wXmXJ5S7VfL+Kt0s82GNfOoc2h\neVxmAyymBrQj5wutIzsnXAxEq/O/Ms4MyWJQ0P2fX49cpCywsDBXTwF76F/DUE3N\nKheAv2ZyJVZSLKxhV6AA7bDVXYEbE4+tmolGCZ4WAkp2JI8EF5T88MZ4hV7BHWHq\nTNMTxzdlGFGWTzxiVDQmpa1+tS9Y\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIID/zCCAuegAwIBAgIUFBFmGshKJgTNw5srNBUhiXMnh14wDQYJKoZIhvcNAQEL\nBQAwXDEZMBcGA1UEAwwQUlNBIERFRkFVTFQgUk9PVDELMAkGA1UECgwCUUMxCzAJ\nBgNVBAsMAlFDMQswCQYDVQQGEwJDTjELMAkGA1UECAwCUUMxCzAJBgNVBAcMAlFD\nMB4XDTIzMDUxMTAzMDgxNloXDTI0MDUxMTE1NTk1OVowXDEZMBcGA1UEAwwQUlNB\nIERFRkFVTFQgUk9PVDELMAkGA1UECgwCUUMxCzAJBgNVBAsMAlFDMQswCQYDVQQG\nEwJDTjELMAkGA1UECAwCUUMxCzAJBgNVBAcMAlFDMIIBIjANBgkqhkiG9w0BAQEF\nAAOCAQ8AMIIBCgKCAQEAweF6Bg8c2IyXe3e5xtgreFTZ1UkZ5DQRh1S7qzibGZiN\n0Ey/ivYxdtvJnYmaQJvK9S2Q7jZi8Wh/FUmolrOIDPEPr4/51YbZe8vkAfg/rYDo\nJw878/P678NzjZUeemIojPk3xUG7h208y+sLs9a/lKYcxjdUbiMeMEJfTUTZE3wW\nfxNiAFdWUlow1SjAqk0Cc3rOcW3LJXGrPBYeWlCFYxYRDWiZHlD3YazDK3ejBi5j\nAr6qTCYq5mt8148A6qU81/yRxiQ8IBcSM1mHf1Qm25NrIOzDUcSYfn0sugnra8ez\nV93gfOFS9QtEDY6ACz00H+CUUbAzJ0bDAqtZXyQ3PQIDAQABo4G4MIG1MAwGA1Ud\nEwQFMAMBAf8wDAYDVR0PBAUDAwf/gDAPBgNVHSUECDAGBgRVHSUAMFIGA1UdHwRL\nMEkwR6BFoEOGQWh0dHA6Ly9jcmwud2VicGtpLm5ldD9zbj0xNDExNjYxQUM4NEEy\nNjA0Q0RDMzlCMkIzNDE1MjE4OTczMjc4NzVFMDIGCCsGAQUFBwEBBCYwJDAiBggr\nBgEFBQcwAYYWaHR0cDovL29jc3Aud2VicGtpLm5ldDANBgkqhkiG9w0BAQsFAAOC\nAQEAASVURt1QTcpPmuDcXUG4qjv96+vClu7K/E2Iyfsy3leHmaswzqcNZzPCqMhS\nloKaN0+0tnQk4d1MMrzHxkivNZFaMYQzaXd10YCw3eJMPk++uf+Fcdd0y6k3O7oS\nrUx2x9Y32jJw9yK/bFsPIRV0hIZMwuJN7sryv5J/UKWBpmdjRhdUYsTolQsR22hb\nCpGuI+001bmjS4zk4Qpn4rTW45CrRpyaEgc6pqjxwSdyxAYWLMkPqsDuTseJpFjN\nG1tkC/xyMjWPgq4BNXp+KT4ULbqKbYNdj14XaaXjKOuYkUyDqX8IHoJyFTxguzX6\nwBwvuokf8zGES/+M2tU4Z31zqA==\n-----END CERTIFICATE-----\n",
        "private_key": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIFLTBXBgkqhkiG9w0BBQ0wSjApBgkqhkiG9w0BBQwwHAQI9vInCTJHw5YCAicQ\nMAwGCCqGSIb3DQIJBQAwHQYJYIZIAWUDBAEqBBAD8irl9HqeQ8PWs7Wttj9nBIIE\n0BtJvRDK9zXWeqHG/2aVnA4U2dq2Y9Mphjg2a6tMtQmSv2DlhRfCxZ+IPkckpXWv\neMKZelDiO2dlQFDgVTremTgZTBSrJXSQ5BJ//7dj8nNrO0nXDLzwbPZf2lY34djr\nBx2zrlip6izs23CJVWKLTsBTk8ERgUly3CRlcI93OwkWgqWn6qGu1Qq7764UorX7\nd82Kv66GqJ/b3ISNt7IoAWxACpzh+wOREIln1O5/uj04wccMbWD8kB4JRII3jp8l\ndjQMOnZxFWWCUbtRQZg5Z+cCWJXLj31zJ7T3ySPFtXw1R/VITKvdN9dUbLMudZ6L\nomE7ju5Ea6jU3haXNYFimidosuOLJ2zkC5AUivLBiOe7pYAsF0wpKl5NfHcmN81A\nJtO+J6zSyCruyL9h2w/wtlk4wzyGBq6pHiYRsmcNT53pWxhR5lM6goft9NY8rbVM\nAHuuKAk1KOosbv7O4jrGU77YjwfI6HL8V8cAbI+BW3tFfuuk61v7lBotgDXrth7m\nQWcQpZ/kXITkJ86pSt2fp2yFsS1DKABQhkoy157V+IEwVifUaZBTfwV6tf5t0ogC\nKx0995NoILBfyx26aS7VWnU4H0wlI1s5nQ/Oyk5D9mnnlJq+3Xfm9B4ALz5bDngv\nZbv0YUDzIFRRKu6IkwLAMjo5VOqSraozyfvsR0ymPKWB+8TBFaJybNp+6f4FkVa6\nZ612IlmeP1/FYBJolDj5C4TgLmEM9wEhpO86mCHfb4/TyHs/aysxWmj44HT1AfkU\nphKO+BaAnO1dpXMbtAB/lAxhsx7YYz2skLKW1MoIDoMI0zGW6dGvqnwxvDkduLb1\n0oDF1yiBO01K5jqHiXfb48CIpcCROXpK/uxMDegdjZtr81QkyrwvyYe67aTt/bXa\nQyUpqay5iJTXcXgYcGnTB1eyr6k2Qg2aWIMI/laVCFHTv+iWfo6IjbVVI/v/bG8I\nQDG/dDmLdfzjfueXHfIPa+Gxjmgl5VAS276X/HElDY37UjiTyoOehle3WbSSfqNC\nqBNaET6LyyGcJDy0AJpD567HiTeEc5fvytc3js8Mxy9IV/MOa8uKYeJ+WDxob/NW\nD9d9bPD3MVFRzN78YlxMI1uR6JupnQ+kTDZbUaUQLl7+tokUH8lfpX+hZxHFPf+a\nWtEfQqYMYHi2EjQ6g1qc+LjlEocr92mywSjBb7FTjdvXIzgUbhRymlyR1g4Du1Bw\npMNJjyONnB9z6ES1AXWImrfRiANBsYICIjZFje6A1q0j+WI6w87BnpJwRrQsEdJZ\nKStIxi2//3Z9oqXxbQ2GCn8L442zFuvhfoudVUfbON4gC8LOWvrtMAFARvSXrskP\n6LBlJ3TvUaQxeH2cH0Sp7eopDBMYeM1wGFNJ9L1lvWZHikyA/bX5VqWLd+QaKcG+\nfURG1xj2aBzjM8N7KxpJSMld+ONTtbzJX3frMeGHkdJH/OQCLVDQdzCJSYsUSVWl\n9v2ttXcHLbv4AhSaJI6UhL3qUuLorgNzV4WChGewcDIN/aaVKOzMsKYrFLWnFpsu\nYOE4QkfbPOwlUyZUQbiDQFoD+hDqhMQbHC9p2Qu/hgHD2JDM3ClRw1KFBKA0l7QD\nj/urDuILtEUR4ocb5gWnObpZCG9rdAcTV4DnMEEN2Chv\n-----END ENCRYPTED PRIVATE KEY-----\n",
        "encrypt_certificate": "",
        "encrypt_private_key": "",
        "tarball_bytes": ""
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见 错误码说明