Get Subscription List¶

获取当前 OU 订阅任务列表。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
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`：订阅类型为“设备事件上报订阅”。
enabled	Boolean	订阅任务是否已启动，`true` 表示已启动，`false` 表示已暂停。

示例¶

请求示例¶

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

返回示例¶

{
    "retCode": 0,
    "data": [
        {
            "id": 1410,
            "subId": "yourSubId01",
            "app": "appAccessKey",
            "desc": {
              "default": "Time Series Data - Online",
              "zh-CN": "时序数据-实时通道",
              "en-US": "Time Series Data - Online"
            },
            "orgId": "yourOrgId",
            "type": "DATA",
            "enabled": true
        },
        {
            "id": 1808,
            "subId": "yourSubId02",
            "app": "appAccessKey",
            "desc": {
              "default": "Time Series Data - Offline",
              "zh-CN": "时序数据-离线通道",
              "en-US": "Time Series Data - Offline"
            },
            "orgId": "yourOrgId",
            "type": "OFFLINE",
            "enabled": false
        }
    ],
    "msg": null,
    "subMsg": null
}