You need to enable JavaScript to run this app.
导航
查询根CA详情
最近更新时间:2024.04.19 16:26:35首次发布时间:2023.08.11 19:16:08

API 说明

API 名称:GetRootInstance
API 域名:open.volcengineapi.com
API 描述:调用本接口查询指定私有根CA(以下简称“根CA”)实例的详情。

请求方法

GET

使用限制

节流限制:暂无。

公共请求头参数

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

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

请求参数

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

请求正文

参数名称
数据类型
是否必选
参数说明
示例
instance_id
String
要查询的根CA实例的ID。
您可以调用 ListRootInstances 接口获取所有根CA实例的ID。
pca_root_aXPEF****

响应正文

参数名称
数据类型
参数说明
示例
Result
Object
根CA实例的详情。

示例

请求示例

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

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202303141728335A3BCB56DFF6D11E40E7",
        "Action": "GetRootInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance_id": "pca_root_aXPEF****",
        "root_ca_id": "",
        "encryption_algorithm": "RSA 2048",
        "signature_algorithm": "SHA512-RSA",
        "serial_number": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",
        "tag": "doc-test-RootCA",
        "sourceType": 0,
        "contact": {
            "name": "张三",
            "email": "zhangsan@example.com",
            "phone_number": "131****1111"
        },
        "subject": {
            "country": [
                "CN"
            ],
            "organization": [
                "Volcengine"
            ],
            "organizational_unit": [
                "Certificate Center"
            ],
            "locality": [
                "海淀"
            ],
            "province": [
                "北京"
            ],
            "common_name": "Volcengine CA"
        },
        "common_name": "Volcengine CA",
        "certificate": {
            "csr": "",
            "encrypt_key": "",
            "encrypt_chain": null,
            "key": "",
            "chain": [
                "-----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"
            ]
        },
        "create_at": 1678778206,
        "not_after": 1681401599,
        "not_before": 1678778206,
        "instance_status": 1,
        "duration": "30天"
    }
}

错误码

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