Get Subscription Details¶

根据订阅任务 ID 获取任务详情。

请求格式¶

GET https://{apigw-address}/subscription-service/v1/subscription/{subId}

请求参数（URI）¶

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

响应参数¶

名称	数据类型	描述
id	String	订阅任务的系统 ID。
subId	String	订阅任务 ID。
app	String	应用的 access key。
desc	StringI18n	订阅任务的国际化描述。
orgId	String	所在 OU ID。
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"]`。仅支持“设备事件上报订阅”类型。
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 结构体¶

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

示例¶

请求示例¶

url: https://{apigw-address}/subscription-service/v1/subscription/yourSubId?orgId=yourOrgId
method: GET

返回示例¶

{
    "msg": null,
    "data": {
        "id": 61,
        "subId": "yourSubId",
        "app": "yourAppAccessKey",
        "desc": {
            "default": "Time Series Data - Online",
            "zh-CN": "时序数据-实时通道",
            "en-US": "Time Series Data - Online"
        },
        "orgId": "yourOrgId",
        "type": "DATA",
        "content": {
            "customers": [
                "CustomerOrgId"
            ],
            "models": [
                {
                    "modelId": "Demo1",
                    "useAllPoints": true,
                    "points": [
                        "lemo_point1_5min",
                        "merg_point_5min"
                    ],
                    "public": null
                }
            ],
            "useAllModels": false,
            "assetIds": [
                "assetId01",
                "assetId02"
            ],
            "structureRootId": "structureRootId",
            "tags": {
                "deviceTagKey": "deviceTagValue"
            },
            "treeTags": {

            },
            "eventTypes": [

            ],
            "sourceEventType": {

            }
        },
        "enabled": false
    },
    "subMsg": null,
    "requestId": null,
    "retCode": 0
}