TestWebhook--托管 Prometheus-火山引擎

文档中心

立即注册

导航

TestWebhook

最近更新时间：2024.09.03 15:42:19首次发布时间：2024.08.16 17:03:02

测试 Webhook 的连通性。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=TestWebhook&Version=2021-03-03

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	TestWebhook	接口名称。当前 API 的名称为 `TestWebhook`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Address	String	是	https://bytedance.com/v2/hook/f19ce***	Webhook 地址。
Token	String	否	zs0T****	Webhook Token，不能单独配置。当配置 Webhook 地址，且启用了签名校验功能时，需同步配置。

请求示例

POST https://open.volcengineapi.com/?Action=TestWebhook&Version=2021-03-03
Content-Type: application/json
{
    "Address": "https://bytedance.com/v2/hook/f19ce***",
    "Token": "zs0T****"
}

返回参数

参数	类型	示例值	描述
StatusCode	Integer	200	HTTP 状态码。
Body	String	successfully	HTTP response body。
ErrorMessage	String	timeout	HTTP 请求返回的错误信息。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "TestWebhook",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "StatusCode": 200,
        "Body": "successfully",
        "ErrorMessage": "timeout"
    }
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。
403	ProductUnsubscribed	You are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。