更新时间:2021-08-17 GMT+08:00
分享

查询注册组列表

功能介绍

应用服务器可调用此接口查询物联网平台中的注册组信息列表。

URI

GET /v5/iotps/{project_id}/registration-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id。

最小长度:1

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

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

最小值:1

最大值:50

缺省值:10

marker

String

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

缺省值:999999999999999999999999

最小长度:24

最大长度:24

registration_group_name

String

注册组名称。

最小长度:0

最大长度:256

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

registration_groups

Array of RegistrationGroupInfoDTO objects

注册组信息。

page

Page object

查询结果的分页信息。

表5 RegistrationGroupInfoDTO

参数

参数类型

描述

certificate_id

String

CA证书id

最小长度:0

最大长度:256

cert_type

String

证书类型

strategy_type

String

策略类型。目前支持静态策略(base),证书策略(certificates)和自定义策略(functions)。

缺省值:functions

function_name

String

自定义函数名称。

最小长度:1

最大长度:256

func_urn

String

函数的URN(Uniform Resource Name),唯一标识函数。

最小长度:1

最大长度:360

registration_group_id

String

注册组id,用于唯一标识一个注册组

registration_group_name

String

注册组名称。

最小长度:1

最大长度:256

init_config

String

注册组的初始化配置。必须为json字符串

最小长度:1

最大长度:65535

表6 Page

参数

参数类型

描述

count

Long

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

最小值:0

最大值:1000

marker

String

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

最小长度:0

最大长度:64

请求示例

响应示例

状态码: 200

Successful response

{
  "registration_groups" : [ {
    "certificate_id" : "d82c4917-51b2-460d-b148-56801fc4d87f",
    "strategy_type" : "functions",
    "function_name" : "a",
    "func_urn" : "urn:fss:cn-north-7:88cce89f943646cfbda057aed55c4841:function:default:a",
    "registration_group_id" : "id4922d8a-6c8e-4396-852c-164aefa6638",
    "registration_group_name" : "ab"
  }, {
    "certificate_id" : "d82c4917-51b2-460d-b148-56801fc4d88f",
    "strategy_type" : "functions",
    "function_name" : "b",
    "func_urn" : "urn:fss:cn-north-7:88cce89f943646cfbda057aed55c4841:function:default:b",
    "registration_group_id" : "id4922d8a-6c8e-4396-852c-164aefa6637",
    "registration_group_name" : "abc"
  } ],
  "page" : {
    "count" : 100,
    "marker" : "5c8f3d2d3df1f10d803adbda"
  }
}

状态码

状态码

描述

200

Successful response

错误码

请参见错误码

分享:

    相关文档

    相关产品

close