最近更新时间:2023.10.31 14:35:40
首次发布时间:2023.08.11 19:16:08
API 名称:ListLeafInstances
API 域名:open.volcengineapi.com
API 描述:调用本接口获取已签发的私有证书的列表。
GET
节流限制:暂无。
在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下三个请求头(header)参数的取值说明如下:
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
Region | String | 是 | 服务地区。该参数的取值是 cn-north-1 。 | cn-north-1 |
ServiceName | String | 是 | 服务名称。该参数的取值是 pca 。 | pca |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
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 | 否 | 指定一个实例状态对私有证书进行筛选。该参数有以下取值:
| 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 请求失败。关于更多错误码的信息,参见 错误码说明。