查询模型绑定实体列表
功能介绍
应用服务器可调用此接口查询模型绑定实体列表。
URI
GET /v1/iotfm/ai/model-bindings
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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的整数。 |
|
model_name |
否 |
String |
参数说明: 模型名称。 取值范围: 枚举类型，枚举值如下: |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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，只允许字母、数字的组合。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
model_bindings |
Array of ModelNameBindingItem objects |
参数说明：绑定实体列表，数组类型。 取值范围: 数组长度不超过1000。 |
|
page |
Page object |
查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
model_name |
String |
参数说明: 模型名称。 取值范围: 枚举类型，枚举值如下: |
|
device_id |
String |
参数说明：设备ID。设备级模型绑定/解绑时填写。 取值范围: 长度不超过128，只允许字母、数字，中划线(-)及下划线(_)的组合。 |
|
system_id |
String |
参数说明：系统ID。系统级模型绑定/解绑时填写。 取值范围: 长度不超过128，只允许字母、数字，中划线(-)及下划线(_)的组合。 |
|
system_device_id |
Object |
参数说明：系统内设备ID列表。系统级模型绑定时填写。 取值范围: 键值对格式 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
参数说明：本次分页查询结果中，获取的记录总数。 |
|
marker |
String |
参数说明：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 取值范围：长度0-64。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数说明：错误码。 取值范围：长度8-36。 |
|
error_msg |
String |
参数说明：错误描述。 取值范围：长度2-512。 |
请求示例
查询模型绑定实体列表
GET https://{endpoint}/v1/iotfm/ai/model-bindings
响应示例
状态码：200
OK
{
"model_bindings" : [ {
"model_name" : "device-cooling-pump",
"device_id" : "ucb241upuwl01"
}, {
"model_name" : "device-cooling-pump",
"device_id" : "00423330-0523-01"
} ],
"page" : {
"count" : 2,
"marker" : "1885305fcea05bcd4a634d25"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
