订阅管理-华为云

应用与数据集成平台 ROMA CONNECT-删除订阅:响应参数

响应参数状态码： 400 表3 响应Body参数参数参数类型描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。最小长度：0 最大长度：64 error_msg String 错误描述。最小长度：0 最大长度：200 request_id String 消息ID。最小长度：0 最大长度：64 状态码： 404 表4 响应Body参数参数参数类型描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。最小长度：0 最大长度：64 error_msg String 错误描述。最小长度：0 最大长度：200 request_id String 消息ID。最小长度：0 最大长度：64 状态码： 500 表5 响应Body参数参数参数类型描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。最小长度：0 最大长度：64 error_msg String 错误描述。最小长度：0 最大长度：200 request_id String 消息ID。最小长度：0 最大长度：64

应用与数据集成平台 ROMA CONNECT 订阅管理

应用与数据集成平台 ROMA CONNECT-删除订阅:响应示例

响应示例状态码： 400 Bad Request { "error_code" : "string", "error_msg" : "string", "request_id" : "string" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "string", "error_msg" : "string", "request_id" : "string" }

应用与数据集成平台 ROMA CONNECT 订阅管理

设备管理 IOTDM（联通用户专用）-批量查询订阅:参数说明

参数说明参数必选/可选类型位置描述 qbsInDTO 必选 QueryBatchSubInDTO query 见下表QueryBatchSubInDTO的描述。 accessToken 必选 String header 填写鉴权接口获取的accessToken。 QueryBatchSubInDTO 参数必选/可选类型位置描述 appId 可选 String(256) query 设备或者规则等订阅内容主体所属的appId。 notifyType 可选 String(256) query 通知类型，第三方应用可以根据通知类型对消息分别进行处理。 bindDevice（绑定设备） deviceAdded（添加新设备） deviceInfoChanged（设备信息变化） deviceDataChanged（设备数据变化） deviceDatasChanged（设备数据批量变化） deviceCapabilitiesChanged（设备服务能力变化，订阅后推送设备服务能力变化通知） deviceCapabilitiesAdded（设备服务能力增加，订阅后推送设备服务能力增加通知） deviceCapabilitiesDeleted（设备服务能力删除，订阅后推送设备服务能力删除通知） deviceDeleted（删除设备） messageConfirm（消息确认） commandRsp（命令响应） deviceDesiredPropertiesModifyStatusChanged（修改设备影子状态变更） swUpgradeStateChangeNotify（软件升级状态变更通知） swUpgradeResultNotify（软件升级结果通知） fwUpgradeStateChangeNotify（固件升级状态变更通知） fwUpgradeResultNotify（固件升级结果通知） pageNo 可选 Integer query 分页查询参数。值为空时，查询内容不分页值大于等于0的时分页查询值等于0时查询第一页 pageSize 可选 Integer query 分页查询参数，取值大于等于1的整数，缺省值：“10”。

设备管理 IOTDM（联通用户专用）订阅管理

设备管理 IOTDM（联通用户专用）-批量查询订阅:错误码

错误码 Http状态码错误码错误描述说明 400 100224 The resource exceeds 1000, please refinement query conditions. 查到端资源超出1000条，请重新设定查询条件。处理建议：请缩小查询条件范围。 403 100217 The application hasn't been authorized. 应用未被授权。处理建议：若非应用授权场景，请确认请求参数中的appId为空。 403 1010009 app throttle exceed. 应用调用接口过于频繁，超过流控值（默认值是100次/60s）。处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。处理建议：请检查接口请求中所携带的accessToken是否有误。

设备管理 IOTDM（联通用户专用）订阅管理

事件网格 EG-创建事件订阅:响应示例

响应示例状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request" } 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method" } 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found" } 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error" }

事件网格 EG 事件订阅管理

事件网格 EG-创建事件订阅:响应参数

响应参数状态码： 200 表15 响应Header参数参数参数类型描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表16 响应Body参数参数参数类型描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型枚举值： EVENT SCHEDULED status String 状态枚举值： CREATED ENABLED DISABLED FROZEN ERROR channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间表17 SubscriptionUsedInfo 参数参数类型描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述表18 SubscriptionSourceInfo 参数参数类型描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间表19 SubscriptionTargetInfo 参数参数类型描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID 最大长度：64 detail Object 订阅的事件目标参数列表 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间表20 TransForm 参数参数类型描述 type String 转换规则类型枚举值： ORIGINAL CONSTANT VARIABLE value String 常量类型规则时，字段为常量内容定义；变量类型规则时，为变量定义，内容必须为JsonObject字符串。变量最多支持100个，且不支持嵌套结构定义；变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符；变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。最大长度：1024 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。最大长度：2048 表21 DeadLetterQueue 参数参数类型描述 type String 队列类型枚举值： KAFKA instance_id String 实例id 最小长度：1 最大长度：128 connection_id String 目标连接id 最小长度：1 最大长度：128 topic String 主题最小长度：1 最大长度：128 状态码： 400 表22 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表23 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表24 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表25 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表26 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

事件网格 EG 事件订阅管理

事件网格 EG-创建事件订阅:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：16384 表3 请求Body参数参数是否必选参数类型描述 name 是 String 订阅名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须字母或数字开头最小长度：1 最大长度：128 description 否 String 订阅描述最大长度：255 channel_id 是 String 所属事件通道ID sources 是 Array of SubscriptionSource objects 订阅的事件源列表，当前仅支持订阅一个事件源数组长度：1 - 1 targets 是 Array of SubscriptionTarget objects 事件目标列表，至少订阅一个事件目标表4 SubscriptionSource 参数是否必选参数类型描述 id 否 String 订阅源ID，需保证全局唯一。指定ID的订阅源存在时则进行更新，否则进行创建；未指定时由系统自动生成。由小写字母、数字、中划线组成，必须字母或数字开头。最小长度：32 最大长度：64 name 是 String 订阅的事件源名称最大长度：128 provider_type 是 String 订阅的事件源的提供方类型枚举值： CUSTOM OFFICIAL PARTNER detail 否 Object 订阅的事件源参数列表, 该字段序列化后总长度不超过1024字节 filter 是 Object 订阅事件源的匹配过滤规则, 该字段序列化后总长度不超过2048字节表5 SubscriptionTarget 参数是否必选参数类型描述 id 否 String 订阅目标ID，需保证全局唯一，由小写字母、数字、中划线组成，必须字母或数字开头。更新订阅场景时，指定ID的订阅目标存在时则进行更新，否则进行创建；创建订阅目标场景时，指定ID作为待创建的订阅目标对象ID，未指定时由系统自动生成。更新订阅目标时，此字段忽略；最小长度：32 最大长度：64 name 是 String 订阅的事件目标名称最大长度：128 provider_type 是 String 订阅的事件目标的提供方类型枚举值： CUSTOM OFFICIAL connection_id 否 String 订阅的事件目标使用的目标链接ID 最大长度：64 detail 否 Detail object 订阅的事件目标参数列表，该字段序列化后总长度不超过1024字节，函数、函数流、webhook订阅目标必填，其中函数、函数流委托名称必填 kafka_detail 否 KafkaTargetDetail object 订阅的事件kafka目标参数列表，该字段序列化后总长度不超过1024字节，kafka订阅目标必填 smn_detail 否 SmnTargetDetail object 订阅的事件smn目标参数列表，该字段序列化后总长度不超过1024字节，smn订阅目标必填 transform 是 TransForm object 订阅的事件目标转换规则 dead_letter_queue 否 DeadLetterQueue object 订阅的死信参数列表表6 Detail 参数是否必选参数类型描述 url 否 String 自定义目标url agency_name 否 String 委托名称 invocation_http_parameters 否 InvocationHttpParameters object invoke_type 否 String 函数调用方式,异步/同步枚举值： SYNC，ASYNC 表7 InvocationHttpParameters 参数是否必选参数类型描述 header_parameters 否 Array of HeaderParameter objects 对象列表数组长度：0 - 5 表8 HeaderParameter 参数是否必选参数类型描述 is_value_secret 否 Boolean 是否加密 key 否 String header的key值最小长度：1 最大长度：256 value 否 String header的value值最小长度：1 最大长度：1024 表9 KafkaTargetDetail 参数是否必选参数类型描述 topic 是 String 主题 keyTransform 否 keyTransform object 键值规则表10 keyTransform 参数是否必选参数类型描述 type 否 String 键值规则类型枚举值： NONE VARIABLE CONSTANT value 否 String 键值规则，键值规则为VARIABLE，CONSTANT时必填 template 否 String 键值规则模板，键值规则为VARIABLE时必填表11 SmnTargetDetail 参数是否必选参数类型描述 urn 是 String 主题urn agency_name 是 String 委托名称 subject_transform 否 subject_transform object 标题规则表12 subject_transform 参数是否必选参数类型描述 type 是 String 标题规则类型枚举值： VARIABLE CONSTANT value 是 String 标题规则 template 否 String 标题规则模板，键值规则为VARIABLE时必填表13 TransForm 参数是否必选参数类型描述 type 是 String 转换规则类型枚举值： ORIGINAL CONSTANT VARIABLE value 否 String 常量类型规则时，字段为常量内容定义；变量类型规则时，为变量定义，内容必须为JsonObject字符串。变量最多支持100个，且不支持嵌套结构定义；变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符；变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。最大长度：1024 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。最大长度：2048 表14 DeadLetterQueue 参数是否必选参数类型描述 type 是 String 队列类型枚举值： KAFKA instance_id 是 String 实例id 最小长度：1 最大长度：128 connection_id 是 String 目标连接id 最小长度：1 最大长度：128 topic 是 String 主题最小长度：1 最大长度：128

事件网格 EG 事件订阅管理

事件网格 EG-更新事件订阅目标:响应示例

响应示例状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

事件网格 EG 事件订阅管理

设备管理 IoTDM（联通用户专用）-批量删除订阅:请求示例

请求示例 DELETE https://{host}:{port}/iocm/app/sub/v1.2.0/subscriptions?appId={appId}¬ifyType={notifyType}&callbackUrl={callbackUrl}&channel={channel}Content-Type: application/jsonapp_key: ******Authorization: Bearer *****

设备管理 IoTDM（联通用户专用）订阅管理-V3

设备管理 IoTDM（联通用户专用）-批量删除订阅:错误码

错误码 Http状态码错误码错误描述说明 403 100217 The application hasn't been authorized. 应用未被授权。处理建议：若非应用授权场景，请确认请求参数中的appId为空。 403 1010009 app throttle exceed. 应用调用接口过于频繁，超过流控值（默认值是100次/60s）。处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。处理建议：请检查接口请求中所携带的accessToken是否有误。 404 100225 The resource is not found 找不到资源。处理建议：请检查订阅类型是否有误。

设备管理 IoTDM（联通用户专用）订阅管理-V3

设备管理 IoTDM（联通用户专用）-批量删除订阅:请求参数

请求参数参数必选/可选类型位置描述 app_key 必选 String header 访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。 Authorization 必选 String header 访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 appId 可选 String(256) query 订阅所属的应用ID，当删除授权应用下的订阅时才需要填写。 notifyType 可选 String(256) query 通知类型，应用可以根据通知类型对消息分别进行处理。 deviceAdded（添加新设备，订阅后推送注册设备通知） bindDevice（绑定设备，订阅后推送绑定设备通知） deviceInfoChanged（设备信息变化，订阅后推送设备信息变化通知） deviceDataChanged（设备数据变化，订阅后推送设备数据变化通知） deviceDatasChanged（设备数据批量变化，订阅后推送批量设备数据变化通知） deviceCapabilitiesChanged（设备服务能力变化，订阅后推送设备服务能力变化通知） deviceCapabilitiesAdded（设备服务能力增加，订阅后推送设备服务能力增加通知） deviceCapabilitiesDeleted（设备服务能力删除，订阅后推送设备服务能力删除通知） deviceDeleted（删除设备，订阅后推送删除设备通知） messageConfirm（消息确认，订阅后推送设备消息确认通知） commandRsp（命令响应，订阅后推送设备命令响应通知） ruleEvent（规则事件，订阅后推送规则事件通知） deviceDesiredPropertiesModifyStatusChanged（设备影子状态变更，订阅后推送设备影子状态变更通知） swUpgradeStateChangeNotify（软件升级状态变更通知） swUpgradeResultNotify（软件升级结果通知） fwUpgradeStateChangeNotify（固件升级状态变更通知） fwUpgradeResultNotify（固件升级结果通知） callbackUrl 可选 String(256) query 订阅回调的URL地址。 channel 可选 String(32) query 传输通道。当channel为空时，删除“传输通道”为“HTTP”的订阅。当channel为“MQ TTS ”时，删除“传输通道”为“MQTTS”的订阅。当channel为“HTTP”时，删除“传输通道”为“HTTP”的订阅。当channel取其他值时，不会删除订阅。

设备管理 IoTDM（联通用户专用）订阅管理-V3

设备管理 IoTDM（联通用户专用）-查询订阅:请求参数

请求参数名称必选/可选类型位置说明 X-Auth-Token 必选 String Header 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 可选 String Header 实例ID。物理多租下各实例的唯一标识，一般华为云租户无需携带该参数，仅在物理多租场景下从管理面访问API时需要携带该参数。 project_id 必选 String Path 项目ID。获取方法请参见获取项目ID。 subscription_id 必选 String Path 订阅ID，用于唯一标识一个订阅，在创建订阅时由物联网平台分配获得。

设备管理 IoTDM（联通用户专用）订阅管理-V5

设备管理 IoTDM（联通用户专用）-查询订阅:响应参数

响应参数名称类型说明 subscription_id String 订阅ID，用于唯一标识一个订阅，在创建订阅时由物联网平台分配获得。 subject Subject Object 订阅的主题信息，即订阅的资源变化事件。 callbackurl String 订阅的回调地址，用于接收对应资源事件的通知消息。 channel String 物联网平台推送通知消息时使用的协议通道。使用“http”填充，表示该订阅推送协议通道为http(s)协议。表1 Subject 名称类型说明 resource String 订阅的资源名称。 device：设备。 device.data：设备数据。 device.message.status：设备消息状态。 device.message：设备消息。 device.status：设备状态。 batchtask.status：批量任务状态。 event String 订阅的资源事件，取值范围：activate、update、up。 event需要与resource关联使用，具体的“resource：event”映射关系如下： device：activate（设备激活） device.data：update（设备数据变化） device.message.status：update（设备消息状态） device.message：report（设备消息上报） device.status：update （设备状态变化） batchtask.status：update （批量任务状态变化）

设备管理 IoTDM（联通用户专用）订阅管理-V5

设备管理 IoTDM（联通用户专用）-查询订阅:响应示例

响应示例 Status Code: 200 OK Content-Type: application/json{ "subscription_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "subject" : { "resource" : "device", "event" : "activate" }, "callbackurl" : "https://host:port/deviceActivate", "channel" : "http"}

设备管理 IoTDM（联通用户专用）订阅管理-V5

设备管理 IoTDM（联通用户专用）-查询订阅:错误码

错误码 HTTP状态码错误码错误码英文描述错误码中文描述处理建议 403 IOTDA.000021 Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service. 没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务（IOTDA）请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。 IOTDA.001000 The application does not exist. 该应用不存在请确定是否已在平台注册应用并检查应用ID是否正确。 IOTDA.001002 Operation not allowed. The application has not been authorized. 该应用没有权限访问请检查该应用是否已被授权。 IOTDA.001005 Operation not allowed. The parameter 'app_id' is not carried, and the authorized user has more than one applications. Include the parameter 'app_id', or contact Huawei technical support engineers to merge application data. 该用户下有多个应用的情况下未携带appId访问接口请携带对应的appId或联系华为工程师合并应用数据。 IOTDA.001006 Operation not allowed. Application not found by authorized user or the authorized user has no application. 用户下没有应用或应用与用户不匹配请排查用户下是否有应用或是否有指定的应用。 IOTDA.001007 Operation not allowed. The application does not belong to the authorized user. 应用与用户信息不匹配请排查该用户下是否有指定的应用。 404 IOTDA.009003 The subscription subject can not be found. 查询不到该订阅记录请确认请求中的参数是否正确。 500 IOTDA.000001 Internal server error. 服务器内部错误请联系华为工程师分析解决。 IOTDA.000020 Decrypt IAM token failed. IAM Token解析失败请联系华为工程师分析解决。

设备管理 IoTDM（联通用户专用）订阅管理-V5

云服务器内容精选

订阅管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线