Update Subscription Job¶

更新订阅任务。

请求格式¶

PUT https://{apigw-address}/subscription-service/v1/subscription

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	订阅任务所在 OU ID。如何获取 orgId 信息 >>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
subId	必需	String	订阅任务 ID。
app	必需	String	订阅任务关联应用的 access key，不可更改。
desc	可选	StringI18n	订阅任务的描述，支持国际化。国际化字段表示方法 >>
type	必需	Enum	订阅类型，不可更改： `DATA`：订阅类型为“时序数据订阅”，订阅通道为“实时通道”。 `OFFLINE`：订阅类型为“时序数据订阅”，订阅通道为“离线通道”。 `EVENT`：订阅类型为“告警数据订阅”，订阅通道为“基础告警”。 `ALERT`：订阅类型为“告警数据订阅”，订阅通道为“高级告警”。 `CASE`：订阅类型为“设备管理系统事件订阅”。 `REPORT`：订阅类型为“设备事件上报订阅”。
content	必需	Content 结构体	订阅任务详情，Content 结构体 >>

Content 结构体¶

名称	必需/可选	数据类型	描述
customers	必需	List<String>	需要订阅该任务的 OU ID。
models	可选	List<DeviceModel>	订阅任务的模型条件。DeviceModel 结构体 >>
useAllModels	可选	Boolean	是否订阅当前 OU 所有可用模型，`true` 表示是，`false` 表示否。
assetIds	可选	List<String>	如需指定组织结构过滤条件，可提供组织结构上需要订阅的场站 ID。仅支持“时序数据订阅”类型。
structureRootId	可选	String	指定组织结构 ID。仅支持“时序数据订阅”类型。
tags	可选	Map<String, String>	指定设备标签过滤条件，结构为 `{"key":"value"}`。仅支持以下类型：订阅类型为“告警数据订阅”，且订阅通道为“基础告警”。订阅类型为“时序数据订阅”。
treeTags	可选	Map<String, String>	指定资产树标签过滤条件，结构如 `{"key":"value"}`。仅支持“告警数据订阅”类型，且订阅通道为“基础告警”。
eventTypes	可选	List<String>	指定设备事件类型过滤条件，结构如 `["INFO","WARN","ERROR"]`。仅支持“设备事件上报订阅”类型。
sourceEventType	可选	Map	指定订阅任务的设备事件类型过滤条件，结构如 `{"MODEL": ["CREATE","DELETE","UPDATE"]}`。仅支持“设备管理系统事件订阅”类型。事件类型及其对应的事件如下： `MODEL`：表示资产模型，事件包括： CREATE DELETE UPDATE `DEVICE_ASSET`：表示设备资产，事件包括： CREATE ACTIVATE ENABLE DISABLE DELETE REPLACE_DEVICE_KEY LOGIN LOGOUT CHANGE_INFO ADD_SUBDEVICES REMOVE_SUBDEVICES REMOVE_ALL_SUBDEVICES ADD_MIRROR_SOURCE REMOVE_MIRROR_SOURCE NOTIFY_COMMAND_STATE `LOGIC_ASSET`：表示逻辑资产，事件包括： CREATE DELETE CHANGE_INFO `FOTA_FILE`：表示 OTA 固件文件，事件包括： CREATED DELETED VERIFIED `FOTA_JOB`：表示 OTA 任务，事件包括： CREATED STARTED STOPPED UPDATED STATISTICS_UPDATED
enabled	可选	Boolean	是否启动订阅任务，`true` 表示启动，`false` 表示暂停。

DeviceModel 结构体¶

名称	必需/可选	数据类型	描述
points	必需	List<String>	订阅的测点 ID，结构如 `["point1","point2"]`。
modelId	必需	String	订阅的模型 ID。
useAllPoints	可选	Boolean	是否订阅模型下的所有测点，`true` 表示是，`false` 表示否。
public	必需	Boolean	模型是否为公有模型，`true` 表示是，`false` 表示否。

示例¶

请求示例¶

url: https://{apigw-address}/subscription-service/v1/subscription/?orgId=yourOrgId
method: PUT
requestBody:
{
  "id": 63,
  "subId": "yourSubId",
  "app": "yourAppAccessKey",
  "desc": {
       "default": "REPORT",
            "zh-CN": "设备事件上报",
            "en-US": "REPORT"
        },
        "orgId": "yourOrgId",
        "type": "REPORT",
        "content": {
            "customers": [
                "CustomerOrgId1"
            ],
            "models": [
                {
                    "modelId": "EnOS_Substation_Device",
                    "useAllPoints": false,
                    "points": [

                    ],
                    "public": null
                }
            ],
            "useAllModels": false,
            "assetIds": [

            ],
            "structureRootId": "",
            "tags": {

            },
            "treeTags": {

            },
            "eventTypes": [
                "WARN",
                "ERROR"
            ],
            "sourceEventType": {

            }
        },
        "enabled": false
}

返回示例¶

{
    "retCode": 0,
    "data": null,
    "msg": null,
    "subMsg": null
}