文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ CA证书管理/ 获取CA证书列表 - ListCertificates
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

获取CA证书列表 - ListCertificates

功能介绍

应用服务器可调用此接口在物联网平台获取CA证书列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    iotda:certificates:queryList

    List

    app *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

GET /v5/iot/{project_id}/certificates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

app_id

否

String

资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的证书列表，不携带该参数则会查询该用户下所有证书列表。

limit

否

Integer

分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。

marker

否

String

上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。

offset

否

Integer

表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

certificates

Array of CertificatesRspDTO objects

证书列表。

page

Page object

查询结果的分页信息。
表5 CertificatesRspDTO

参数

参数类型

描述

certificate_id

String

CA证书ID，在上传CA证书时由平台分配的唯一标识。

cn_name

String

CA证书CN名称。

owner

String

CA证书所有者。

status

Boolean

CA证书验证状态。true代表证书已通过验证，可进行设备证书认证接入。false代表证书未通过验证。

verify_code

String

CA证书验证码。

provision_enable

Boolean

是否开启自注册能力，当为true时该功能必须配合预调配功能使用，true：是，false：否。

template_id

String

绑定的预调配模板ID。

ocsp_enable

Boolean

是否开启该CA证书下的设备证书OCSP校验，当为true且设备证书信息中包含OCSP url时则平台会校验证书的状态，当证书状态为revoked时平台会拒绝设备连接，true：开启，false：关闭。

ocsp_server_ca_id

String

ocsp服务器端CA证书id，仅当ocsp服务器开启SSL时配置，平台使用该CA证书认证ocsp服务器。

ocsp_ssl_enable

Boolean

ocsp服务器是否开启SSL加密，开启后必须配置OCSP服务器CA证书。

create_date

String

创建证书日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

effective_date

String

CA证书生效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

expiry_date

String

CA证书失效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
表6 Page

参数

参数类型

描述

count

Long

满足查询条件的记录总数。

marker

String

本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。

请求示例

获取CA证书列表。

GET https://{endpoint}/v5/iot/{project_id}/certificates

响应示例

状态码：200

OK

{
  "certificates" : [ {
    "certificate_id" : "string",
    "cn_name" : "string",
    "owner" : "string",
    "status" : true,
    "verify_code" : "string",
    "create_date" : "20191212T121212Z",
    "effective_date" : "20191212T121212Z",
    "expiry_date" : "20221212T121212Z",
    "provision_enable" : true,
    "template_id" : "61c970ce2d63eb6ee655dbf0",
    "ocsp_enable" : "false,",
    "ocsp_server_ca_id" : "60fa667369d4840337930aec",
    "ocsp_ssl_enable" : true
  } ],
  "page" : {
    "count" : 100,
    "marker" : "5c8f3d2d3df1f10d803adbda"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： CA证书管理