You need to enable JavaScript to run this app.
导航
创建根CA
最近更新时间:2023.10.31 14:35:40首次发布时间:2023.08.11 19:16:08

API 说明

API 名称:CreateRootInstance
API 域名:open.volcengineapi.com
API 描述:调用本接口创建一个私有根CA(以下简称“根CA”)。

  • 根CA是企业内部信任链的起点。您可以根据组织架构来定义根CA。
  • 您调用本接口创建的是一个根CA实例。根CA实例创建后默认启用并开始计费。
  • 根CA实例包含一个自签名的根CA证书。根CA证书对应的私钥由证书中心保管。您可以使用根CA签发子CA证书。

请求方法

POST

使用限制

节流限制:暂无。

公共请求头参数

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

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

请求参数

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

请求正文

参数名称
数据类型
是否必选
参数说明
示例
contact
Object
设置根CA证书的联系人信息。
csr_common
Object
设置根CA证书的申请信息。
hash_alg
String
设置根CA证书的签名算法。该参数有以下取值:
  • SHA256
  • SHA384
  • SHA512
SHA256
key_alg
String
设置根CA证书的密钥算法。该参数有以下取值:
  • RSA
  • ECDSA
  • SM2
RSA
key_param
String
设置根CA证书的密钥强度。根据 key_alg 的值,该参数有不同的取值。
  • key_alg 为 RSA 时,该参数的取值有:2048、3072、4096。
  • key_alg 为 ECDSA 时,该参数的取值有:P256、P384、P521。
  • key_alg 为 SM2 时,该参数无需设置。
2048
quantity
Integer
设置根CA证书的有效时长。根据 duration_type 的值,该参数有不同的取值范围。
  • duration_type为 year 时,该参数的取值范围为:1~30。
  • duration_type 为 month 时,该参数的取值范围为:1~360。
  • duration_type 为 day 时,该参数的取值范围为:2~10950。
30
duration_type
String
设置有效时长(quantity)的单位。该参数有以下取值:
  • day
  • month
  • year
day
tag
String
为根CA证书设置标签。允许使用任意字符。
Test

响应正文

参数名称
数据类型
参数说明
示例
instance_id
String
根CA实例的ID。
该ID是证书中心为根CA实例分配的,用于唯一标识根CA。
pca_root_aXPEF****
certificate
String
根CA证书的内容。
-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----

示例

请求示例

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

{
    "contact": {
        "email": "zhangsan@example.com",
        "name": "张三",
        "phone_number": "131****1111"
    },
    "csr_common": {
        "subject": {
            "common_name": "Volcengine CA",
            "country": [
                "CN"
            ],
            "locality": [
                "海淀"
            ],
            "organization": [
                "Volcengine"
            ],
            "organizational_unit": [
                "Certificate Center"
            ],
            "postal_code": [
                "100080"
            ],
            "province": [
                "北京"
            ]
        }
    },
    "hash_alg": "SHA256",
    "key_alg": "RSA",
    "key_param": "2048",
    "quantity": 30,
    "duration_type": "day",
    "tag": "doc-test-RootCA"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230314151646747AE0BE8437E90EA396",
        "Action": "CreateRootInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance_id": "pca_root_aXPEF****",
        "certificate": "-----BEGIN CERTIFICATE-----\n********ApegAwIBAgIUMx1M0BTkgTq4MC5H3Z60Nt4ue94wDQYJKoZIhvcNAQEN\nBQAweTELMAkGA1UEBhMCQ04xDzANBgNVBAgMBuWMl+S6rDEPMA0GA1UEBwwG5rW3\n5reAMRMwEQYDVQQKDApWb2xjZW5naW5lMRswGQYDVQQLDBJDZXJ0aWZpY2F0ZSBD\nZW50ZXIxFjAUBgNVBAMMDVZvbGNlbmdpbmUgQ0EwHhcNMjMwMzE0MDcxNjQ2WhcN\nMjMwNDEzMTU1OTU5WjB5MQswCQYDVQQGEwJDTjEPMA0GA1UECAwG5YyX5LqsMQ8w\nDQYDVQQHDAbmtbfmt4AxEzARBgNVBAoMClZvbGNlbmdpbmUxGzAZBgNVBAsMEkNl\ncnRpZmljYXRlIENlbnRlcjEWMBQGA1UEAwwNVm9sY2VuZ2luZSBDQTCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBANSStoBdQ/YwsLoPJntT2xvVna8QVSlP\nUpaz7YPP2mZw2U32eTAdk3CDXXn5wnLNj0Hw+8i8CgiTyBg7WpzMHf4rruYgSvZ6\nsFa8JXyOuJC/11x7uWqEICUwBQIs2SMpSgfN7n4T2Za5U6FWA5OE0+7zfaEK0h5A\nELHUIUWXffgaY1VhTO/973IdXekpMYPyHhhgQBnenrSvL+Ek2SDi5vufkeKZRis+\nlC4jcKArVoVnBKCvmUNR/I4xRnY8KbY3jz1topuLw5feCfYkXh+dJilrH6vG1FJL\nBbATN9E8KtuxGI8e5nX8kVHS5toptVbgajpLg+sBKb2vygx4CphzJdECAwEAAaMv\nMC0wDAYDVR0TBAUwAwEB/zAMBgNVHQ8EBQMDB/+AMA8GA1UdJQQIMAYGBFUdJQAw\nDQYJKoZIhvcNAQENBQADggEBABcddS1v0PpRcW0vSKuEiomOrdz54VxmsgXIXweE\nhHLh0scTGtqIhA3Z3fVJujE/GwWIANl6VErHE1W0TmycM19UQ766ErIz2f8RCKMh\nvSsjXjoKkujk1xoR+N5w3gxFB+Epa38vGRXU2aTBDFql0yHdCzccKRME9n36x5hV\nUONnsMFIlguQDyyn+pVg8dmEIDIrNRACKZtlsVEMZ6Xeg0Yj1sHvMZM2b0jO1m35\netpnoDIuzDWriI+ZEA4aoL73FVukoZrOfc7XucJRGkv3zKu4aERAKdkwvPKZlKw2\nc+QpjLJ6r5xjeMDPlTAKWvmxn19hmX0MMsKlWgDk********\n-----END CERTIFICATE-----\n"
    }
}

错误码

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