获取私有证书列表--证书中心-火山引擎

文档中心

立即注册

导航

获取私有证书列表

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

调用本接口获取已签发的私有证书的列表。

请求说明

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

调试

暂不支持。

请求参数

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

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

Query

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

参数	类型	是否必选	描述	示例值
Action	String	是	API的名称。该参数的取值是 `ListLeafInstances`。	`ListLeafInstances`
Version	String	是	API的版本。该参数的取值是 `2023-05-01`。	`2023-05-01`
common_name	String	否	指定一个公用名（对应证书中的CN字段）对私有证书进行筛选。	`www.example.com`
instance_id	String	否	指定一个实例ID对私有证书进行筛选。	`pca_leaf_M6gaihuZRcO****`
instance_status	Integer	否	指定一个实例状态对私有证书进行筛选。该参数有以下取值： 0：未知 1：正常运行 2：已停用 4：已吊销 8：已冻结（实例欠费） 16：已过期	`1`
issued_id	String	否	指定上一级CA实例（子CA实例）的ID对私有证书进行筛选。	`pca_sub_MlRaK****`
page_size	Integer	是	查询结果中每页的私有证书数量。取值范围：1~20。	`1`
page	Integer	是	请求的页码。	`1`

返回参数

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230314201533B5FE7FB98504080F6CE9",
        "Action": "ListLeafInstances",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": {
        "count": 1,
        "result": [
            {
                "common_name": "www.example.com",
                "instance_id": "pca_leaf_M6gaihuZRcO****",
                "issued_id": "pca_sub_MlRaK****",
                "issued_common_name": "Certificate Center CA",
                "instance_status": 1,
                "not_before": 1678823484,
                "not_after": 1679702399,
                "signature_algorithm": "",
                "create_at": 0,
                "tag": "",
                "contact": {
                    "name": "",
                    "email": "",
                    "phone_number": ""
                },
                "subject": {
                    "country": null,
                    "organization": null,
                    "organizational_unit": null,
                    "locality": null,
                    "province": null,
                    "common_name": ""
                },
                "encryption_algorithm": "RSA 2048",
                "duration": "10天"
            }
        ]
    }
}

错误码

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

证书中心