产品管理-华为云

设备接入 IOTDA-查询产品:响应示例

响应示例状态码： 200 Successful response { "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "app_name" : "testAPP01", "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer", "device_type" : "Thermometer", "protocol_type" : "MQTT", "data_format" : "json", "manufacturer_name" : "ABC", "industry" : "smartCity", "description" : "this is a thermometer produced by Huawei", "service_capabilities" : [ { "service_id" : "temperature", "service_type" : "temperature", "properties" : [ { "property_name" : "temperature", "required" : true, "data_type" : "decimal", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "centigrade", "method" : "RW", "description" : "force", "default_value" : { "color" : "red", "size" : 1 } } ], "commands" : [ { "command_name" : "reboot", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "responses" : [ { "response_name" : "ACK", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ] } ] } ], "events" : [ { "event_type" : "reboot", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : "1", "max" : "100", "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ] } ], "description" : "temperature", "option" : "Mandatory" } ], "create_time" : "20190303T081011Z" }

设备接入 IOTDA 产品管理

设备接入 IOTDA-查询产品:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 app_id String 资源空间ID。 app_name String 资源空间名称。 product_id String 产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。 name String 产品名称。 device_type String 设备类型。 protocol_type String 设备使用的协议类型。取值范围：MQTT，CoAP，HTTP，HTTPS，Modbus，ONVIF， OPC-UA，OPC-DA，Other。 data_format String 设备上报数据的格式，取值范围：json，binary。 manufacturer_name String 厂商名称。 industry String 设备所属行业。 description String 产品的描述信息。 service_capabilities Array of ServiceCapability objects 设备的服务能力列表。 create_time String 在物联网平台创建产品的时间，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。表5 ServiceCapability 参数参数类型描述 service_id String 参数说明：设备的服务ID。注：产品内不允许重复。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。 service_type String 参数说明：设备的服务类型。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-$等字符的组合。 properties Array of ServiceProperty objects 参数说明：设备服务支持的属性列表。取值范围：数组长度大小不超过500。 commands Array of ServiceCommand objects 参数说明：设备服务支持的命令列表。取值范围：数组长度大小不超过500。 events Array of ServiceEvent objects 参数说明：设备服务支持的事件列表。目前暂未支持自定义事件，创建/修改产品时无需定义该字段。取值范围：数组长度大小不超过500。 description String 参数说明：设备服务的描述信息。取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 option String 参数说明：指定设备服务是否必选。目前本字段为非功能性字段，仅起到标识作用。取值范围： Master：主服务 Mandatory：必选服务 Optional：可选服务默认值为Optional。缺省值：Optional 表6 ServiceProperty 参数参数类型描述 property_name String 参数说明：设备属性名称。注：设备服务内不允许重复。属性名称作为设备影子JSON文档中的key不支持特殊字符：点(.)、dollar符号($)、空char(十六进制的ASCII码为00)，如果包含了以上特殊字符则无法正常刷新影子文档。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 data_type String 参数说明：设备属性的数据类型。取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 required Boolean 参数说明：设备属性是否必选。默认为false。缺省值：false enum_list Array of strings 参数说明：设备属性的枚举值列表。 min String 参数说明：设备属性的最小值。取值范围：长度1-16。最小长度：1 最大长度：16 max String 参数说明：设备属性的最大值。取值范围：长度1-16。最小长度：1 最大长度：16 max_length Integer 参数说明：设备属性的最大长度。 step Double 参数说明：设备属性的步长。 unit String 参数说明：设备属性的单位。取值范围：长度不超过16。最大长度：16 method String 参数说明：设备属性的访问模式。取值范围：RWE，RW，RE，WE，E，W，R。 R：属性值可读 W：属性值可写 E：属性值可订阅，即属性值变化时上报事件 description String 参数说明：设备属性的描述。取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。 default_value Object 参数说明：设备属性的默认值。如果设置了默认值，使用该产品创建设备时，会将该属性的默认值写入到该设备的设备影子预期数据中，待设备上线时将该属性默认值下发给设备。表7 ServiceCommand 参数参数类型描述 command_name String 参数说明：设备命令名称。注：设备服务内不允许重复。取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras Array of ServiceCommandPara objects 参数说明：设备命令的参数列表。 responses Array of ServiceCommandResponse objects 参数说明：设备命令的响应列表。表8 ServiceCommandResponse 参数参数类型描述 response_name String 参数说明：设备命令响应名称。取值范围：长度不超过128，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras Array of ServiceCommandPara objects 参数说明：设备命令响应的参数列表。表9 ServiceEvent 参数参数类型描述 event_type String 参数说明：设备事件类型。注：设备服务内不允许重复。取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 paras Array of ServiceCommandPara objects 参数说明：设备事件的参数列表。表10 ServiceCommandPara 参数参数类型描述 para_name String 参数说明：参数的名称。取值范围：长度不超过32，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 data_type String 参数说明：参数的数据类型。取值范围：int，long，decimal，string，DateTime，jsonObject，enum，boolean，string list。 required Boolean 参数说明：参数是否必选。默认为false。缺省值：false enum_list Array of strings 参数说明：参数的枚举值列表。 min String 参数说明：参数的最小值。取值范围：长度1-16。最小长度：1 最大长度：16 max String 参数说明：参数的最大值。取值范围：长度1-16。最小长度：1 最大长度：16 max_length Integer 参数说明：参数的最大长度。 step Double 参数说明：参数的步长。 unit String 参数说明：参数的单位。取值范围：长度不超过16。最大长度：16 description String 参数说明：参数的描述。取值范围：长度不超过128，只允许中文、字母、数字、空白字符、以及_?'#().,;&%@!- ，、：；。￥$！【】’‘“”（）？…~/等字符的组合。

设备接入 IOTDA 产品管理

设备接入 IOTDA-查询产品:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情。

设备接入 IOTDA 产品管理

设备接入 IOTDA-查询产品:URI

URI GET /v5/iot/{project_id}/products/{product_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 参数说明：项目ID。获取方法请参见获取项目ID 。 product_id 是 String 参数说明：产品ID，用于唯一标识一个产品，在物联网平台创建产品后由平台分配获得。取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。表2 Query参数参数是否必选参数类型描述 app_id 否 String 参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，建议携带该参数，指定要查询的产品属于哪个资源空间；若不携带，则优先取默认资源空间下产品，如默认资源空间下无对应产品，则按照产品创建时间取最早创建产品。如果用户存在多资源空间，同时又不想携带该参数，可以联系华为技术支持对用户数据做资源空间合并。取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。

设备接入 IOTDA 产品管理

态势感知 SA-检查心跳健康:响应参数

响应参数状态码： 400 表4 响应Body参数参数参数类型描述 error_msg String 无效数据的描述信息。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128 状态码： 401 表5 响应Body参数参数参数类型描述 error_msg String token认证错误。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128 状态码： 403 表6 响应Body参数参数参数类型描述 error_msg String 权限错误。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128 状态码： 500 表7 响应Body参数参数参数类型描述 error_msg String 系统内部错误。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128

态势感知 SA 产品管理

态势感知 SA-检查心跳健康:请求示例

请求示例 POST https://{endpoint}/v1/{project_id}/products/health-check { domain_id: "dfaf9864b95c448797b5dc0f0xxxxxxx", project_id: "2b31ed520xxxxxxebedb6e57xxxxxxxx", region: "xx-xx-1", company_name: "xxx", product_name: "xxx" }

态势感知 SA 产品管理

态势感知 SA-检查心跳健康:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：2097152 X-Language 否 String 语言最小长度：2 最大长度：6 表3 请求Body参数参数是否必选参数类型描述 domain_id 是 String 数据源产品所属账号的ID。最小长度：32 最大长度：36 project_id 是 String 数据源产品所属项目的ID。最小长度：32 最大长度：36 region 是 String 数据源产品所在区域。最小长度：1 最大长度：512 company_name 是 String 数据源产品所属公司的名称。最小长度：1 最大长度：512 product_name 是 String 数据源产品的名称。最小长度：1 最大长度：512

态势感知 SA 产品管理

安全云脑 SECMASTER-检查心跳健康:响应参数

响应参数状态码： 400 表4 响应Body参数参数参数类型描述 error_msg String 无效数据的描述信息。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128 状态码： 401 表5 响应Body参数参数参数类型描述 error_msg String token认证错误。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128 状态码： 403 表6 响应Body参数参数参数类型描述 error_msg String 权限错误。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128 状态码： 500 表7 响应Body参数参数参数类型描述 error_msg String 系统内部错误。最小长度：1 最大长度：128 error_code String 错误码。最小长度：1 最大长度：128

安全云脑 SECMASTER 产品管理

安全云脑 SECMASTER-检查心跳健康:请求示例

请求示例 POST https://{endpoint}/v1/{project_id}/products/health-check { domain_id: "dfaf9864b95c448797b5dc0f0xxxxxxx", project_id: "2b31ed520xxxxxxebedb6e57xxxxxxxx", region: "xx-xx-1", company_name: "xxx", product_name: "xxx" }

安全云脑 SECMASTER 产品管理

安全云脑 SECMASTER-检查心跳健康:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：2097152 X-Language 否 String 语言最小长度：2 最大长度：6 表3 请求Body参数参数是否必选参数类型描述 domain_id 是 String 数据源产品所属账号的ID。最小长度：32 最大长度：36 project_id 是 String 数据源产品所属项目的ID。最小长度：32 最大长度：36 region 是 String 数据源产品所在区域。最小长度：1 最大长度：512 company_name 是 String 数据源产品所属公司的名称。最小长度：1 最大长度：512 product_name 是 String 数据源产品的名称。最小长度：1 最大长度：512

安全云脑 SECMASTER 产品管理

应用与数据集成平台 ROMA CONNECT-查询产品详情:响应示例

响应示例状态码： 200 OK { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 120671, "product_serial" : "Dd1bRt122894", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "name" : "pro-opcua", "manufacturer_id" : "pro-opcua", "manufacturer_name" : "pro-opcua", "model" : "pro-opcua", "product_type" : 0, "description" : "opcua product", "protocol_type" : 4, "device_type" : "default", "version" : "version", "created_datetime" : 1607481372416, "last_updated_datetime" : 1607481372416, "app_name" : "app-link", "data_format" : 0, "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "authentication" : { "user_name" : "4MjxbCl4q461", "password" : "********" } } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.searchProductDetails]. Parameter is [product_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.", "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

应用与数据集成平台 ROMA CONNECT 产品管理

应用与数据集成平台 ROMA CONNECT-查询产品主题:响应示例

响应示例状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "product_id" : 122888, "topic_id" : "17", "permission" : 1, "topic_name" : "/3.0/${deviceId}/t1", "version" : "3.0", "description" : "description" } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product-topic.queryProductTopic]. Parameter is [productId]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.", "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

应用与数据集成平台 ROMA CONNECT 产品管理

应用与数据集成平台 ROMA CONNECT-查询产品主题:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 total Integer 总数最小值：0 最大值：9999999999999999 size Integer 本次返回数量最小值：1 最大值：999 items Array of ProductTopic objects 产品主题列表数组长度：0 - 9999 表5 ProductTopic 参数参数类型描述 product_id Integer 归属产品ID 最小值：1 最大值：99999999999999999 topic_id String 产品主题ID 最小长度：1 最大长度：99999999999999999 permission Integer 主题权限 0-发布 1-订阅最小值：0 最大值：10 topic_name String 主题名称最小长度：0 最大长度：64 version String 版本号最小长度：0 最大长度：10 description String 描述最小长度：0 最大长度：200 状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码最小长度：0 最大长度：64 error_msg String 错误描述最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 404 表7 响应Body参数参数参数类型描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码最小长度：0 最大长度：64 error_msg String 错误描述最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 500 表8 响应Body参数参数参数类型描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码最小长度：0 最大长度：64 error_msg String 错误描述最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64

应用与数据集成平台 ROMA CONNECT 产品管理

设备发放 IoTDP-查询产品:响应示例

响应示例状态码： 200 Successful response { "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer", "device_type" : "Thermometer", "model" : "123", "protocol_type" : "LWM2M", "data_format" : "binary", "industry" : "smartCity", "description" : "this is a thermometer produced by Huawei", "service_capabilities" : [ { "service_id" : "temperature", "service_type" : "temperature", "properties" : [ { "property_name" : "temperature", "required" : true, "data_type" : "decimal", "enum_list" : null, "min" : 1, "max" : 100, "max_length" : 100, "step" : 0.1, "unit" : "centigrade", "method" : "R", "description" : "force" } ], "commands" : [ { "command_name" : "reboot", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : 1, "max" : 100, "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "responses" : [ { "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : 1, "max" : 100, "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "response_name" : "ACK" } ] } ], "description" : "temperature", "option" : "Mandatory" } ], "create_time" : "20190303T081011Z"}

设备发放 IoTDP 产品管理

设备发放 IoTDP-查询产品:URI

URI GET /v5/iotps/{project_id}/products/{product_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID。最小长度：1 最大长度：32 product_id 是 String 产品ID，用于唯一标识一个产品，在物联网平台的SP Portal上导入产品模型后由平台分配获得。表2 Query参数参数是否必选参数类型描述 region_id 是 String 区域ID，用于区分不同的区域。 access_point_id 是 String 接入点id，用于区分不同的区域。

设备发放 IoTDP 产品管理

云服务器内容精选

产品管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线