这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

Webhooks

可以使用这些 API 调用获取有关 Webhook 的信息,以及创建或删除 Webhook。

1 - GET webhooks

返回此群集的活动 Webhook 的列表。

资源 URL

https://<NODE>:5444/webhooks

认证

请求头中需要包含 VerticaAPIKey

API 密钥必须具有受限 级别或更高级别的安全性。

参数

无。

示例请求

响应:

{
    "body": [
        {
            "host": "192.168.232.1",
            "id": "79c1c8a18be02804b3d2f48ea6462909",
            "port": 80,
            "timestamp": "2014-07-20 22:54:09.829642",
            "url": "/gettest.htm"
        },
        {
            "host": "192.168.232.1",
            "id": "9c32cb0f3d2f9a7cb10835f1732fd4a7",
            "port": 80,
            "timestamp": "2014-07-20 22:54:09.829707",
            "url": "/getwebhook.php"
        }
    ],
    "href": "/webhooks",
    "links": [
        "/subscribe",
        "/:subscriber_id"
    ],
    "mime-type": "application/vertica.webhooks.json-v2"
}

2 - POST webhooks/subscribe

为 Webhook 创建订阅。

资源 URL

https://<NODE>:5444/webhooks/subscribe

认证

请求头中需要包含 VerticaAPIKey

API 密钥必须具有受限 级别或更高级别的安全性。

参数

示例请求

响应:

响应不采用 JSON 编码。仅有的文本响应是 Webhook 订阅的 ID。此外,HTTP 200/OK 标头指示操作成功。

79c1c8a18be02804b3d2f48ea6462909

3 - DELETE webhooks/:subscriber_id

删除 :subscriber_id 所标识的 Webhook。:subscriber_idGET webhooks 命令返回的 id 字段的值。

资源 URL

https://<NODE>:5444/webhooks/:subscriber_id

认证

请求头中需要包含 VerticaAPIKey

API 密钥必须具有受限 级别或更高级别的安全性。

参数

无。

示例请求

响应:

成功的删除没有 HTTP 主体响应。成功的删除将返回 HTTP 200/OK 标头。