设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

获取设备CA证书列表

接口说明

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

调试

您可以在API Explorer中调试该接口。

URI

请求方法

GET

URI

/v5/iot/{project_id}/certificates

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

X-Auth-Token

必选

String

Header

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

可选

String

Header

参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

project_id

必选

String

Path

参数说明:项目ID。获取方法请参见 获取项目ID

app_id

可选

String

Query

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

取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。

limit

可选

Integer

Query

参数说明:分页查询时每页显示的记录数。

取值范围:1-50的整数,默认值为10。

marker

可选

String

Query

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

取值范围:长度为24的十六进制字符串,默认值为ffffffffffffffffffffffff。

offset

可选

Integer

Query

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

取值范围:0-500的整数,默认为0。

响应参数

名称

类型

说明

certificates

List<CertificatesRspDTO>

证书列表。

page

Page Object

查询结果的分页信息。

表1 CertificatesRspDTO

名称

类型

说明

certificate_id

String

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

cn_name

String

CA证书CN名称。

owner

String

CA证书所有者。

status

Boolean

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

verify_code

String

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。

表2 Page

名称

类型

说明

count

Long

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

marker

String

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

请求示例

GET https://{Endpoint}/v5/iot/{project_id}/certificates?app_id={app_id}&limit={limit}&marker={marker}&offset={offset}
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********

响应示例

Status Code: 200 OK

Content-Type: application/json

{
  "certificates" : [ {
    "certificate_id" : "string",
    "cn_name" : "string",
    "owner" : "string",
    "status" : true,
    "verify_code" : "string",
    "create_date" : "20191212T121212Z",
    "effective_date" : "20191212T121212Z",
    "expiry_date" : "20221212T121212Z"
  } ],
  "page" : {
    "count" : 100,
    "marker" : "5c8f3d2d3df1f10d803adbda"
  }
}

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

403

IOTDA.000021

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务(IOTDA)

请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。

IOTDA.000022

Operation not allowed. The user does not have the permission

该用户没有权限

请排查该用户是否有权限访问。

IOTDA.001006

Operation not allowed. Application not found by authorized user or the authorized user has no application.

用户下没有应用或应用与用户不匹配

请排查用户下是否有应用或是否有指定的应用。

IOTDA.001007

Operation not allowed. The application does not belong to the authorized user.

应用与用户信息不匹配

请排查该用户下是否有指定的应用。

500

IOTDA.000020

Decrypt IAM token failed.

IAM Token解析失败

请联系华为工程师分析解决。

分享:

    相关文档

    相关产品