You need to enable JavaScript to run this app.
导航
证书中心
  • 文档首页
    • /
  • 证书中心

上传CA证书

最近更新时间：2023.10.31 14:35:40

首次发布时间：2023.08.11 19:16:08

我的收藏

API 说明

API 名称：UploadRootInstance
API 域名：open.volcengineapi.com
API 描述：调用本接口上传一本私有根CA或私有子CA（以下简称“根CA”、”子CA“）证书。

请求方法

POST

使用限制

  • 一个火山引擎主账号在同一时间仅允许上传一本CA证书。
  • 一个火山引擎主账号最多允许上传100本CA证书。
  • 调用本接口时，仅允许上传一本根CA证书、子CA证书，不允许上传证书链。
  • 节流限制：暂无。

公共请求头参数

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

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

请求参数

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

请求正文

参数名称
数据类型
是否必选
参数说明
示例
certificate
String
是
根CA证书或子CA证书的内容。证书内容必须是PEM编码的。
-----BEGIN CERTIFICATE-----……-----END CERTIFICATE-----
key
String
否
根CA证书或子CA证书的私钥。私钥内容必须是PEM编码的。
-----BEGIN PRIVATE KEY-----……-----END PRIVATE KEY-----
tag
String
否
为该CA证书设置一个备注。
testupload-root

响应正文

参数名称
数据类型
参数说明
示例
instance_id
String
CA实例的ID。
该ID是证书中心为CA实例分配的，用于唯一标识该CA实例。
pca_root_EyKa****
instance_type
String
CA实例的类型。该参数有以下取值：
  • root_instance：根CA实例
  • sub_instance：子CA实例
root_instance

示例

请求示例

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

{
    "certificate": "-----BEGIN CERTIFICATE-----
********AuegAwIBAgIUFBFmGshKJgTNw5srNBUhiXMnh14wDQYJKoZIhvcNAQEL
BQAwXDEZMBcGA1UEAwwQUlNBIERFRkFVTFQgUk9PVDELMAkGA1UECgwCUUMxCzAJ
BgNVBAsMAlFDMQswCQYDVQQGEwJDTjELMAkGA1UECAwCUUMxCzAJBgNVBAcMAlFD
MB4XDTIzMDUxMTAzMDgxNloXDTI0MDUxMTE1NTk1OVowXDEZMBcGA1UEAwwQUlNB
IERFRkFVTFQgUk9PVDELMAkGA1UECgwCUUMxCzAJBgNVBAsMAlFDMQswCQYDVQQG
EwJDTjELMAkGA1UECAwCUUMxCzAJBgNVBAcMAlFDMIIBIjANBgkqhkiG9w0BAQEF
AAOCAQ8AMIIBCgKCAQEAweF6Bg8c2IyXe3e5xtgreFTZ1UkZ5DQRh1S7qzibGZiN
0Ey/ivYxdtvJnYmaQJvK9S2Q7jZi8Wh/FUmolrOIDPEPr4/51YbZe8vkAfg/rYDo
Jw878/P678NzjZUeemIojPk3xUG7h208y+sLs9a/lKYcxjdUbiMeMEJfTUTZE3wW
fxNiAFdWUlow1SjAqk0Cc3rOcW3LJXGrPBYeWlCFYxYRDWiZHlD3YazDK3ejBi5j
Ar6qTCYq5mt8148A6qU81/yRxiQ8IBcSM1mHf1Qm25NrIOzDUcSYfn0sugnra8ez
V93gfOFS9QtEDY6ACz00H+CUUbAzJ0bDAqtZXyQ3PQIDAQABo4G4MIG1MAwGA1Ud
EwQFMAMBAf8wDAYDVR0PBAUDAwf/gDAPBgNVHSUECDAGBgRVHSUAMFIGA1UdHwRL
MEkwR6BFoEOGQWh0dHA6Ly9jcmwud2VicGtpLm5ldD9zbj0xNDExNjYxQUM4NEEy
NjA0Q0RDMzlCMkIzNDE1MjE4OTczMjc4NzVFMDIGCCsGAQUFBwEBBCYwJDAiBggr
BgEFBQcwAYYWaHR0cDovL29jc3Aud2VicGtpLm5ldDANBgkqhkiG9w0BAQsFAAOC
AQEAASVURt1QTcpPmuDcXUG4qjv96+vClu7K/E2Iyfsy3leHmaswzqcNZzPCqMhS
loKaN0+0tnQk4d1MMrzHxkivNZFaMYQzaXd10YCw3eJMPk++uf+Fcdd0y6k3O7oS
rUx2x9Y32jJw9yK/bFsPIRV0hIZMwuJN7sryv5J/UKWBpmdjRhdUYsTolQsR22hb
CpGuI+001bmjS4zk4Qpn4rTW45CrRpyaEgc6pqjxwSdyxAYWLMkPqsDuTseJpFjN
G1tkC/xyMjWPgq4BNXp+KT4ULbqKbYNdj14XaaXjKOuYkUyDqX8IHoJyFTxguzX6
wBwvuokf8zGES/+M2tU4********
-----END CERTIFICATE-----",
    "tag": "testupload-root
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308101102451187C1C71BAF6397EA5F",
        "Action": "UploadRootInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-beijing"
    },
    "Result": {
        "instance_id": "pca_root_EyKa****",
        "instance_type": "root_instance"
    }
}

错误码

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