文档中心

创建子CA

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

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

API 说明

API 名称：CreateSubInstance
API 域名：open.volcengineapi.com
API 描述：调用本接口创建一个私有子CA（以下简称“子CA”）。子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 的名称。该参数的取值是 `CreateSubInstance`。	`CreateSubInstance`
Version	String	是	API 的版本。该参数的取值是 `2023-05-01`。	`2023-05-01`

请求正文

参数名称	数据类型	是否必选	参数说明	示例
contact	Object	是	设置子CA证书的联系人信息。
csr_common	Object	是	设置子CA证书的申请信息。
issuer_id	String	是	上一级CA实例（根CA实例）的ID。您可以调用 ListRootInstances 接口获取所有根CA实例的ID。	`pca_root_aXPEF****`
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~29。 duration_type 为 month 时，该参数的取值范围为：1~359。 duration_type 为 day 时，该参数的取值范围为：1~10949。子CA的有效时长必须小于上一级CA实例（根CA实例）的有效时长。	`20`
duration_type	String	是	设置有效时长（quantity）的单位。该参数有以下取值： day month year	`day`
tag	String	否	为子CA证书设置标签。允许使用任意字符。	`doc-test-SubCA`

响应正文

参数名称	数据类型	参数说明	示例
instance_id	String	子CA实例的ID。该ID是证书中心为子CA实例分配的，用于唯一标识子CA。	`pca_sub_MlRaK****`
certificate	String	子CA证书的内容。	`-----BEGIN CERTIFICATE----- MIID……XWlZ -----END CERTIFICATE-----`
root_certificate	String	上一级CA证书（根CA证书）的内容。	`-----BEGIN CERTIFICATE----- MIID……+o= -----END CERTIFICATE-----`

示例

请求示例

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

{
    "contact": {
        "email": "zhangsan@example.com",
        "name": "张三",
        "phone_number": "131****1111"
    },
    "csr_common": {
        "subject": {
            "common_name": "Certificate Center CA",
            "country": [
                "CN"
            ],
            "locality": [
                "海淀"
            ],
            "organization": [
                "证书中心"
            ],
            "organizational_unit": [
                "研发部"
            ],
            "postal_code": [
                "100080"
            ],
            "province": [
                "北京"
            ]
        }
    },
    "issuer_id": "pca_root_aXPEF****",
    "hash_alg": "SHA256",
    "key_alg": "RSA",
    "key_param": "2048",
    "quantity": 20,
    "duration_type": "day",
    "tag": "doc-test-SubCA"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230314185124D597B88D0A849506BE8C",
        "Action": "CreateSubInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance_id": "pca_sub_MlRaK****",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDszCCApugAwIBAgIUVOJ82RHcResPAmsbmlq+D54LdHQwDQYJKoZIhvcNAQEN\nBQAweTELMAkGA1UEBhMCQ04xDzANBgNVBAgMBuWMl+S6rDEPMA0GA1UEBwwG5rW3\n5reAMRMwEQYDVQQKDApWb2xjZW5naW5lMRswGQYDVQQLDBJDZXJ0aWZpY2F0ZSBD\nZW50ZXIxFjAUBgNVBAMMDVZvbGNlbmdpbmUgQ0EwHhcNMjMwMzE0MTA1MTI0WhcN\nMjMwNDAzMTU1OTU5WjB6MQswCQYDVQQGEwJDTjEPMA0GA1UECAwG5YyX5LqsMQ8w\nDQYDVQQHDAbmtbfmt4AxFTATBgNVBAoMDOivgeS5puS4reW/gzESMBAGA1UECwwJ\n56CU5Y+R6YOoMR4wHAYDVQQDDBVDZXJ0aWZpY2F0ZSBDZW50ZXIgQ0EwggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3r7v2Itw0miqsRM5aImNNsMzUu9g5\nQ4UcBkUnL3ADhGyjJX8m/lJNoJiCtZ7mHubzQgtJ1P/7RrmAbhaU+7jK+3GDdGYa\nWTvTw87H0d6/Epl9SoZ45xq+xs8riBn5HESJmt//lBZ/O9EPUW/+jX9RxuMcDG6x\nfbRqebDMXl/6ulCQVGHHk9HZQ1YgrWTQ3jeEPSkGf/ztNjT1fuXciRbvSZC0LFwc\nvg8Bqf6osWyZ0jvhTUg5qPpmz8aIQbhwwRyyUZd2Tz6ApiBID5Qo5o0lGIyirqW3\nuDKalOi5pMw/YVAXje4qlHsBHDAw0guybzNzMA1YHasDaPmTP2NWdqCFAgMBAAGj\nMjAwMA8GA1UdEwQIMAYBAf8CAf8wDAYDVR0PBAUDAwf/gDAPBgNVHSUECDAGBgRV\nHSUAMA0GCSqGSIb3DQEBDQUAA4IBAQAJbFNSIjGhXxpibk1/kI4RmSfOCwBjoxjL\n3vKyWsCE63XgKXiyfZ5lPxI2+NgZ7EA/hRwF6JHOWfoW3nCeN/PjsF5yOhVmMYRo\ncSq6eMoJgh/vn6HYOIpeVC4ibUxU9tvpTiwQZdcJtn2NCKGSbMBj+p8tAt8vA8N5\n1jNkRbJQRUPrfaH8BtCz+wmC92JhVSoIzDIDfx5H3FIjbV8u0kNpsrIBQ1bM1oy/\nj2AXT2IvalPZ1LMh9LKsLNI9M1f7RfOahdq7/LfJ4J9qkg/VvIGAmaBUPfEIO+OR\nsTIg5k0iNM3+v4lvq29EBgGOQ/DlmWGn+irCHotvIZjH2o8cXWlZ\n-----END CERTIFICATE-----\n",
        "root_certificate": "-----BEGIN CERTIFICATE-----\nMIIDrzCCApegAwIBAgIUMx1M0BTkgTq4MC5H3Z60Nt4ue94wDQYJKoZIhvcNAQEN\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+QpjLJ6r5xjeMDPlTAKWvmxn19hmX0MMsKlWgDkKdlYl+o=\n-----END CERTIFICATE-----\n"
    }
}

错误码

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