查询边界列表

limit

否

Integer

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

取值范围：默认值为10，取值范围为1-50的整数。

marker

否

String

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

取值范围：长度固定24，只允许大小写字母、数组的组合。

offset

否

Integer

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

取值范围：默认为0，取值范围为0-500的整数。

parent_boundary_id

否

String

参数说明：父级边界ID。如填写该参数为$root，则默认返回首层边界列表。

取值范围：长度不超过36，只允许字母、数字、以及$_-等字符的组合。

boundary_name

否

String

边界名称

boundary_type

否

String

边界类型。空间-ZONE; 系统-SYSTEM

system_type

否

String

系统类型。冷站-COLD_SITE; 空压站-COMPRESSOR_SITE

system_id

否

String

系统ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。

X-Auth-Token

是

String

参数说明：用户Token。通过调用 生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

X-Instance-Id

是

String

参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。

取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。

X-Root-Zone-Id

否

String

参数说明：项目ID。

取值范围：长度不超过24，只允许字母、数字的组合。

X-Request-Id

String

This field is the request ID number for task tracking.

Format is request_uuid-timestamp-hostname.

boundaries

Array of QueryBoundaryBaseRsp objects

边界列表

page

Page object

查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。

boundary_id

String

边界ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。

boundary_name

String

边界名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。

boundary_description

String

边界描述。长度不超过256，只允许中文、字母、数字、以及_-等字符的组合。

boundary_type

String

边界类型。空间-ZONE; 系统-SYSTEM

zone_id

String

区域ID

zone_name

String

参数说明：空间名称。

取值范围：长度1-256。

system_type

String

系统类型。冷站-SITE; 空压站-COMPRESSOR

system_id

String

系统ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。

system_name

String

系统名称。长度不超过64，只允许中文、字母、数字、以及_-等字符的组合。

parent_boundary_id

String

父级边界ID。长度不超过36，只允许字母、数字、以及_-等字符的组合。

child_boundary_count

Integer

参数说明：直接下级边界数量。

取值范围：大小为0-100。

create_time

String

创建时间，格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。

update_time

String

更新时间，格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。

count

Long

参数说明：本次分页查询结果中，获取的记录总数。

marker

String

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

取值范围：长度0-64。

X-Request-Id

String

This field is the request ID number for task tracking.

Format is request_uuid-timestamp-hostname.

error_code

String

参数说明：错误码。

取值范围：长度8-36。

error_msg

String

参数说明：错误描述。

取值范围：长度2-512。

200

查询边界列表响应体

400

Error response