更新时间:2026-09-03 GMT+08:00

查询证书列表

功能介绍

该接口用于查询证书列表。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/certs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID和名称。

约束限制:

不涉及

取值范围:

账户的项目ID。

默认取值:

不涉及

cluster_id

是

String

参数解释:

指定查询的集群ID。获取方法请参见获取集群ID。

约束限制:

不涉及

取值范围:

集群ID。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

参数解释:

查询起始值。

约束限制:

不涉及

取值范围:

大于或等于1

默认取值:

1

limit

否

String

参数解释:

查询个数。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

10

certsType

否

String

参数解释:

证书类型。不指定查询证书类型则为查找自定义证书列表。

约束限制:

不涉及

取值范围:

defaultCerts:默认证书类型。

默认取值:

defaultCerts

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

certsRecords

CertsRecordsDatastore object

参数解释:

证书记录。

取值范围:

不涉及

totalSize

Integer

参数解释:

证书记录数量。

取值范围:

不涉及

表4 CertsRecordsDatastore

参数

参数类型

描述

id

String

参数解释:

证书记录ID。

取值范围:

不涉及

status

String

参数解释:

证书状态。

取值范围:

  • checking:正在检查中。

  • available:可用。

  • unavailable:不可用。

  • starting:正开始。

  • working:工作中。

  • stopping:正在停止。

  • stopped:已经停止。

  • restoring:正在回滚。

fileLocation

String

参数解释:

证书记录文件位置。

取值范围:

不涉及

fileName

Boolean

参数解释:

证书记录文件名称。

取值范围:

不涉及

updateAt

Boolean

'参数解释:

证书记录更新时间。

取值范围:

不涉及

请求示例

查询证书列表。

GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/certs

响应示例

状态码:200

请求成功。

{
  "certsRecords" : [ {
    "id" : "2630b1ab-47f8-445c-a4e0-5de74683d767",
    "status" : "available",
    "fileLocation" : "/rds/datastore/logstash/v7.10.0/package/logstash-7.10.0/extend/custom_certs/",
    "fileName" : "xxxx.cer",
    "updateAt" : "2023-06-14T06:54:36"
  } ]
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。