获取根CA列表--证书中心-火山引擎

文档中心

立即注册

导航

获取根CA列表

最近更新时间：2024.06.24 20:30:01首次发布时间：2023.08.11 19:16:08

调用本接口获取已创建的私有根CA（以下简称“根CA”）实例的列表。

请求说明

接口名称：ListRootInstances
请求方式：GET
请求地址：open.volcengineapi.com

调试

暂不支持。

请求参数

下方表格中的参数包含在请求头（header）中。

参数	类型	是否必选	描述	示例值
Region	string	是	服务地区。该参数的取值是`cn-north-1`。	`cn-north-1`
ServiceName	string	是	服务名称。该参数的取值是`pca`。	`pca`

Query

下方表格中的参数包含在查询字符串（query string）中。

参数	类型	是否必选	描述	示例值
Action	String	是	API 的名称。该参数的取值是 `ListRootInstances`。	`ListRootInstances`
Version	String	是	API 的版本。该参数的取值是 `2023-05-01`。	`2023-05-01`
common_name	String	否	指定一个公用名（CN）（对应证书中的CN字段）对根CA证书进行筛选。	`Volcengine CA`
instance_id	String	否	指定一个实例ID对根CA证书进行筛选。	`pca_root_aXPEF****`
instance_status	Integer	否	指定一个实例状态对根CA证书进行筛选。该参数有以下取值： 0：未知 1：已启用 2：已停用 4：已吊销 8：已冻结（实例欠费） 16：已过期	`1`
sourceType	Integer	否	指定一个来源类型对根CA证书进行筛选。该参数有以下取值： 0：在证书中心创建 1：上传到证书中心	`0`
page_size	Integer	是	查询结果中每页的根CA数量。取值范围：1~20。	`1`
page	Integer	是	请求的页码。	`1`

返回参数

参数	类型	描述	示例值
count	Integer	符合查询条件的根CA证书的数量。	`1`
result	Array[]	根CA证书列表。
	Object

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202303141650050544282AC6DAC413676B",
        "Action": "ListRootInstances",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": {
        "count": 1,
        "result": [
            {
                "common_name": "Volcengine CA",
                "instance_id": "pca_root_aXPEF****",
                "issued_id": "",
                "issued_common_name": "",
                "instance_status": 1,
                "not_before": 1678778206,
                "not_after": 1681401599,
                "signature_algorithm": "SHA512-RSA",
                "create_at": 1678778206,
                "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"
                },
                "encryption_algorithm": "RSA 2048",
                "duration": "30天"
            }
        ]
    }
}

错误码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心