应用与数据集成平台 ROMA CONNECT-添加子设备到网关:响应参数

时间:2023-11-29 17:31:44

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of AddSubsetsToGatewayResponseBody objects

Created

表5 AddSubsetsToGatewayResponseBody

参数

参数类型

描述

id

Integer

设备ID

最小值:1

最大值:99999999999999999

device_id

Integer

设备ID(兼容20.0)

最小值:1

最大值:99999999999999999

parent_device_id

Integer

父设备ID

最小值:1

最大值:99999999999999999

product

ProductReferer object

产品

device_name

String

设备名称,支持中文、中文标点符号()。;,:“”、?《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64

最小长度:2

最大长度:64

instance_id

String

实例id

最小长度:2

最大长度:64

client_id

String

设备客户端ID,平台生成的设备唯一标识

最小长度:0

最大长度:32

node_id

String

设备物理编号,通常使用MAC或者IMEI号,支持英文大小写,数字,下划线和中划线,长度2-64

最小长度:2

最大长度:64

status

Integer

设备状态 0-启用 1-禁用

最小值:0

最大值:10

online_status

Integer

是否在线 0-未连接 1-在线 2-离线

最小值:0

最大值:10

description

String

备注

最小长度:0

最大长度:200

created_user

CreatedUser object

创建时的用户

last_updated_user

LastUpdatedUser object

最后更新时的用户

created_datetime

Long

创建时间,timestamp(ms),使用UTC时区

最小值:1

最大值:99999999999999999

last_updated_datetime

Long

最后修改时间,timestamp(ms),使用UTC时区

最小值:1

最大值:99999999999999999

app_id

String

应用ID

最小长度:0

最大长度:36

表6 ProductReferer

参数

参数类型

描述

product_id

Integer

产品ID,未填写厂商ID+型号时产品ID必填

最小值:1

最大值:99999999999999999

product_name

String

产品名称

最小长度:0

最大长度:64

manufacturer_id

String

厂商ID,未填写产品ID时厂商ID和型号必填

最小长度:0

最大长度:64

model

String

型号,未填写产品ID时厂商ID和型号必填

最小长度:0

最大长度:64

protocol_type

Integer

产品的协议类型:0-mqtt,1-CoAP,2-modbus,4-opcua,5-扩展协议

最小值:0

最大值:5

product_type

Integer

产品类型:0-普通产品 1-网关产品

最小值:0

最大值:10

extend_protocol_name

String

扩展协议名称

最小长度:0

最大长度:64

表7 CreatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度:0

最大长度:64

user_name

String

用户名

最小长度:0

最大长度:64

表8 LastUpdatedUser

参数

参数类型

描述

user_id

String

用户ID(保留字段,未使用)

最小长度:0

最大长度:64

user_name

String

用户名

最小长度:0

最大长度:64

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

support.huaweicloud.com/api-roma/AddSubsetsToGateway.html