文档首页/ 设备发放 IoTDP/ API参考/ API/ 设备CA证书管理/ 获取设备CA证书列表
更新时间：2024-07-01 GMT+08:00
查看PDF
分享

获取设备CA证书列表

功能介绍

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

URI

GET /v5/iotps/{project_id}/certificates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

最小长度：1

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

cert_name

否

String

证书名称。

最小长度：0

最大长度：256

marker

否

String

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

缺省值：999999999999999999999999

最小长度：24

最大长度：24

limit

否

Integer

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

最小值：1

最大值：50

缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

certificates

Array of CertificatesRspDTO objects

证书列表。

数组长度：0 - 1000

page

Page object

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

参数

参数类型

描述

certificate_id

String

CA证书ID。

最小长度：0

最大长度：256

cn_name

String

CA证书CN名称。

最小长度：0

最大长度：128

owner

String

Ca证书所有者。

最小长度：0

最大长度：128

status

Boolean

CA证书验证状态。

verify_code

String

CA证书验证码。

最小长度：0

最大长度：256

create_date

String

创建证书日期。

最小长度：0

最大长度：128

effective_date

String

CA证书生效日期

最小长度：0

最大长度：128

expiry_date

String

CA证书失效日期。

最小长度：0

最大长度：128

cert_name

String

CA证书名称。

最小长度：0

最大长度：256

cert_issue

String

CA证书颁发者。

最小长度：0

最大长度：128

update_date

String

CA证书更新日期。

最小长度：0

最大长度：128

expired

Integer

CA证书过期时间：

  • 0：可用；

  • 1：即将过期；

  • 2：已经过期。

最小值：0

最大值：2

cert_hash

String

CA证书指纹。

最小长度：0

最大长度：128
表6 Page

参数

参数类型

描述

count

Long

满足查询条件的记录总数，最大返回1000条记录。

最小值：0

最大值：1000

marker

String

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

最小长度：0

最大长度：64

请求示例

获取设备CA证书列表

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

响应示例

状态码： 200

OK

{
  "certificates" : [ {
    "certificate_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "cert_name" : "huawei",
    "cn_name" : "huawei",
    "owner" : "huawei",
    "status" : true,
    "verify_code" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "create_date" : "20190301T1910Z",
    "effective_date" : "20190301T1910Z",
    "expiry_date" : "20190301T1910Z"
  } ],
  "page" : {
    "count" : 1,
    "marker" : "d4922d8a-6c8e-4396-852c-164aefa6638f"
  }
}

状态码

状态码

描述

200

OK

403

Forbidden

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 设备CA证书管理

相关文档