You need to enable JavaScript to run this app.
导航
获取子CA列表
最近更新时间:2024.04.19 16:26:35首次发布时间:2023.08.11 19:16:08

API 说明

API 名称:ListSubInstances
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 的名称。该参数的取值是 ListSubInstances
ListSubInstances
Version
String
API 的版本。该参数的取值是 2023-05-01
2023-05-01
common_name
String
指定一个公用名(对应证书中的CN字段)对子CA证书进行筛选。
Certificate Center CA
instance_id
String
指定一个实例ID对子CA证书进行筛选。
pca_sub_MlRaK****
instance_status
Integer
指定一个实例状态对子CA证书进行筛选。该参数有以下取值:
  • 0:未知
  • 1:正常运行
  • 2:已停用
  • 4:已吊销
  • 8:已冻结(实例欠费)
  • 16:已过期
1
issued_id
String
指定上一级CA实例(根CA实例)的ID对子CA证书进行筛选。
pca_root_aXPEF****
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=ListSubInstances&Version=2023-05-01&page_size=1&page=1&<其他公共请求参数>

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202303141903459594F07C8006A209F865",
        "Action": "ListSubInstances",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": {
        "count": 1,
        "result": [
            {
                "common_name": "Certificate Center CA",
                "instance_id": "pca_sub_MlRaK****",
                "issued_id": "pca_root_aXPEF****",
                "issued_common_name": "Volcengine CA",
                "instance_status": 1,
                "not_before": 1678791084,
                "not_after": 1680537599,
                "signature_algorithm": "SHA512-RSA",
                "create_at": 0,
                "tag": "doc-test-SubCA",
                "sourceType": 0,
                "contact": {
                    "name": "张三",
                    "email": "zhangsan@example.com",
                    "phone_number": "131****1111"
                },
                "subject": {
                    "country": [
                        "CN"
                    ],
                    "organization": [
                        "证书中心"
                    ],
                    "organizational_unit": [
                        "研发部"
                    ],
                    "locality": [
                        "海淀"
                    ],
                    "province": [
                        "北京"
                    ],
                    "common_name": "Certificate Center CA"
                },
                "encryption_algorithm": "RSA 2048",
                "duration": "20天"
            }
        ]
    }
}

错误码

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