Get Subscription List¶

Get the current OU subscription job list.

Request Format¶

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

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	The OU ID where the subscription job belongs to. How to get orgId >>

Response Parameters¶

Name	Data Type	Description
id	String	The system ID of the subscription job.
subId	String	The subscription job ID.
app	String	The access key of the application.
desc	StringI18n	International description of subscription job.
orgId	String	The OU ID where the subscription job belongs to.
type	Enum	The subscription Type: `DATA`: The subscription type is “Time Series Data Subscription”, and the message channel is “Real-Time”. `OFFLINE`: The subscription type is “Time Series Data Subscription”, and the message channel is “Offline”. `EVENT`: The subscription type is “Alert Data Subscription”, and the message channel is “Basic Alert Service”. `ALERT`: The subscription type is “Alert Data Subscription”, and the message channel is “Advanced Alert Service”. `CASE`: The subscription type is “Device Management Event Subscription”. `REPORT`: The subscription type is “Device Event Report Subscription”.
enabled	Boolean	Whether the subscription job has been started, `true` means it has been started, `false` means it has been suspended.

Samples¶

Request Sample¶

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

Response Sample¶

{
    "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
}