订阅管理

您可以使用以下 API 端点管理您的订阅。

先决条件

• 提交您的用户凭据，客户端ID和客户端机密以进行OAuth2身份验证。有关如何验证对Equinix API的请求的详细信息，请参阅API身份验证。

获取您的订阅

要返回所有流媒体订阅的列表，请向端点发送GET请求/smartview/v2/streaming/subscriptions。

cURL 请求示例：

curl -X 
GET 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'authorization: Bearer <token>'

示例回答：

[
    {
        "id": "606349eca6171829c70d8777",
        "status": "PENDING",
        "messageType": {
            "asset": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ],
                    "assetClassification": [
                        "MECHANICAL"
                    ],
                    "assetId": [
                        "string"
                    ]
                }
            ],
            "environmental": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ],
                    "level": [
                        "ZONE"
                    ]
                }
            ],
            "power": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ]
                }
            ],
            "meteredPower": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ]
                }
            ],
            "systemAlert": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ]
                }
            ],
            "customAlert": [
                {
                    "accountNumber": "135888",
                    "ibx": [
                        "DE2"
                    ],
                    "user": "abc"
                }
            ]
        },
        "channel": {
            "channelType": "AWS_IOT_CORE",
            "awsIotCoreChannelConfiguration": {
                "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
            }
        },
        "orgId": "123",
        "createdBy": "abc",
        "createdDateTime": "2019-08-24T14:15:22Z",
        "updatedBy": "abc",
        "updatedDateTime": "2019-08-24T14:15:22Z"
    }
]

获取订阅详情

要获取指定订阅的详细信息，请向终结点发送GET请求/smartview/v2/streaming/subscriptions/{id}。

cURL 请求示例：

curl -X 
GET 'https://api.equinix.com/smartview/v2/streaming/subscriptions/606349eca6171829c70d8777'
-H 'authorization: Bearer <token>'

示例回答：

{
    "id": "606349eca6171829c70d8777",
    "status": "ACTIVE",
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "AWS_IOT_CORE",
        "awsIotCoreChannelConfiguration": {
            "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
        }
    },
    "orgId": "123",
    "createdBy": "abc",
    "createdDateTime": "2019-08-24T14:15:22Z",
    "updatedBy": "abc",
    "updatedDateTime": "2019-08-24T14:15:22Z"
}

更新订阅

要修改订阅，请向端点发送PUT请求/smartview/v2/streaming/subscriptions/{id}。新的请求正文将替换当前的订阅配置。

cURL 请求示例：

curl -X 
PUT 'https://api.equinix.com/smartview/v2/streaming/subscriptions/{id}'
-H 'authorization: Bearer <token>'
-d '{
    "messageType": {
        "asset": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "assetClassification": [
                    "MECHANICAL"
                ],
                "assetId": [
                    "string"
                ]
            }
        ],
        "environmental": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "level": [
                    "ZONE"
                ]
            }
        ],
        "power": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "meteredPower": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "systemAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ]
            }
        ],
        "customAlert": [
            {
                "accountNumber": "135888",
                "ibx": [
                    "DE2"
                ],
                "user": "abc"
            }
        ]
    },
    "channel": {
        "channelType": "AWS_IOT_CORE",
        "awsIotCoreChannelConfiguration": {
            "url": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com"
        }
    }
}' 

删除一个订阅

要删除订阅，请向端点发送DELETE请求/smartview/v2/streaming/subscriptions/{id}。一旦收到删除请求，事件将不再可用于订阅。

cURL 请求示例：

curl -X 
DELETE 'https://api.equinix.com/smartview/v2/streaming/subscriptions/606349eca6171829c70d8777'
-H 'authorization: Bearer <token>'