huawei-cloud-api-definitions-ROMA 0.1.20240626

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"AddSubsetsToGatewayRequestBody":{"example":{"resources":[10001,10002]},"properties":{"resources":{"description":"待添加子设备ID列表,且设备需是普通设备,自动向下取整","items":{"type":"integer"},"maxItems":9999,"minItems":1,"type":"array"}},"required":["resources"]},"AddSubsetsToGatewayResponseBody":{"properties":{"app_id":{"description":"应用ID","maxLength":36,"minLength":0,"type":"string"},"client_id":{"description":"设备客户端ID,平台生成的设备唯一标识","maxLength":32,"minLength":0,"type":"string"},"created_datetime":{"description":"创建时间,timestamp(ms),使用UTC时区","format":"int64","maximum":99999999999999999,"minimum":1,"type":"integer"},"created_user":{"$ref":"#/definitions/CreatedUser"},"description":{"description":"备注","maxLength":200,"minLength":0,"type":"string"},"device_id":{"description":"设备ID(兼容20.0)","format":"int32","maximum":99999999999999999,"minimum":1,"type":"integer"},"device_name":{"description":"设备名称,支持中文、中文标点符号()。;,:“”、?《》及英文大小写、数字及英文符号()_,#.?'-@%&!, 长度2-64","maxLength":64,"minLength":2,"type":"string"},"id":{"description":"设备ID","format":"int32","maximum":99999999999999999,"minimum":1,"type":"integer"},"instance_id":{"description":"实例id","maxLength":64,"minLength":2,"type":"string"},"last_updated_datetime":{"description":"最后修改时间,timestamp(ms),使用UTC时区","format":"int64","maximum":99999999999999999,"minimum":1,"type":"integer"},"last_updated_user":{"$ref":"#/definitions/LastUpdatedUser"},"node_id":{"description":"设备物理编号,通常使用MAC或者IMEI号,支持英文大小写,数字,下划线和中划线,长度2-64","maxLength":64,"minLength":2,"type":"string"},"online_status":{"description":"是否在线 0-未连接 1-在线 2-离线","enum":[0,1,2],"format":"int32","maximum":10,"minimum":0,"type":"integer"},"parent_device_id":{"description":"父设备ID","format":"int32","maximum":99999999999999999,"minimum":1,"type":"integer"},"product":{"$ref":"#/definitions/ProductReferer"},"status":{"description":"设备状态 0-启用 1-禁用","enum":[0,1],"format":"int32","maximum":10,"minimum":0,"type":"integer"}}},"CreatedUser":{"description":"创建时的用户","example":{"user_id":"6546435432432","user_name":"user1"},"properties":{"user_id":{"description":"用户ID","maxLength":64,"minLength":0,"type":"string"},"user_name":{"description":"用户名","maxLength":64,"minLength":0,"type":"string"}}},"Error":{"properties":{"error_code":{"description":"系统错误码,针对4xx和5xx类HTTP错误码的详细错误码","maxLength":64,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述","maxLength":200,"minLength":0,"type":"string"},"request_id":{"description":"消息ID","maxLength":64,"minLength":0,"type":"string"}}},"LastUpdatedUser":{"description":"最后更新时的用户","example":{"user_id":"6546435432432","user_name":"user1"},"properties":{"user_id":{"description":"用户ID","maxLength":64,"minLength":0,"type":"string"},"user_name":{"description":"用户名","maxLength":64,"minLength":0,"type":"string"}}},"ProductReferer":{"description":"产品","example":{"manufacturer_id":"huawei","model":"mate30pro","prodct_type":0,"product_id":10001,"product_name":"string","protocol_type":0},"properties":{"manufacturer_id":{"description":"厂商ID,未填写产品ID时厂商ID和型号必填","maxLength":64,"minLength":0,"type":"string"},"model":{"description":"型号,未填写产品ID时厂商ID和型号必填","maxLength":64,"minLength":0,"type":"string"},"product_id":{"description":"产品ID,未填写厂商ID+型号时产品ID必填","maximum":999999999999999999,"minimum":1,"type":"integer"},"product_name":{"description":"产品名称","maxLength":64,"minLength":0,"type":"string"},"product_type":{"description":"产品类型:0-普通产品 1-网关产品","enum":[0,1],"format":"int32","maximum":10,"minimum":0,"type":"integer"},"protocol_type":{"description":"产品的协议类型:0-mqtt,1-coap,2-modbus,3-http, 4-opcua","enum":[0,1,2,3,4],"format":"int32","maximum":10,"minimum":0,"type":"integer"}}}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"f6136a9051f64211a30794c1e930fcfe","info_version":"v2","method":"post","name":"AddSubsetsToGateway","parameters":{"device_id":{"description":"设备ID","in":"path","maximum":1e23,"minimum":0,"name":"device_id","required":true,"type":"integer"},"instance_id":{"description":"实例ID","in":"path","maxLength":36,"minLength":0,"name":"instance_id","required":true,"type":"string"},"project_id":{"description":"项目ID,获取方式请参见《ROMA Connect API参考》的“附录 > 获取项目ID”章节。","in":"path","maxLength":32,"minLength":0,"name":"project_id","required":true,"type":"string"}},"paths":{"/v2/{project_id}/link/instances/{instance_id}/devices/{device_id}/subsets":{"post":{"description":"添加子设备到网关","operationId":"AddSubsetsToGateway","parameters":[{"$ref":"#/parameters/project_id"},{"$ref":"#/parameters/instance_id"},{"$ref":"#/parameters/device_id"},{"description":"待添加子设备列表,且设备需是普通设备","in":"body","name":"AddSubsetsToGatewayRequestBody","required":true,"schema":{"$ref":"#/definitions/AddSubsetsToGatewayRequestBody"}}],"produces":["application/json"],"responses":{"201":{"description":"Created","schema":{"items":{"$ref":"#/definitions/AddSubsetsToGatewayResponseBody"},"type":"array"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/Error"}}},"summary":"添加子设备到网关","tags":["设备管理"],"x-apigateway-request-type":"public","x-is-registered":"Y","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"添加子设备到网关","tags":"设备管理","uri":null,"version":"2.0"}