删除告警联系人。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=DeleteContacts&Version=2021-03-03
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | DeleteContacts | 接口名称。当前 API 的名称为 DeleteContacts。 |
| Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03。 |
| Ids | Array of String | 是 | ["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"] | 联系人 ID。 |
请求示例
POST https://open.volcengineapi.com/?Action=DeleteContacts&Version=2021-03-03
Content-Type: application/json
{
"Ids": [
"e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
]
}
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| SuccessfulItems | Array of String | ["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"] | 成功删除的联系人 ID。 |
| UnsuccessfulItems | Array of UnsuccessfulItem | - | 未成功删除的联系人信息。 |
UnsuccessfulItem
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Id | String | e28ae750-bbb8-4ff4-abf4-1e0e0f88808c | 未成功操作的对象 ID。 |
| Error | Object of UnsuccessfulItemError | - | 未成功操作的原因。 |
UnsuccessfulItemError
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Code | String | NotFound.Ids | 错误码。 |
| Message | String | The specified Contact abc is not found. | 错误信息。 |
| Data | JSON Map | - | 错误元数据。 |
返回示例
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DeleteContacts",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-north-1"
},
"Result": {
"SuccessfulItems": [
"e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
],
"UnsuccessfulItems": [
{
"Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
"Error": {
"Code": "NotFound.Ids",
"Message": "The specified Contact abc is not found."
}
}
]
}
}
错误码
本接口错误码如下表所示，公共错误码请参见 公共错误码。
| HTTP 状态码 | 错误码 | 错误信息 | 说明 |
|---|
| 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 服务。 |
| 404 | NotFound.Id | The specified Contact/ContactGroup {{Id}} is not found. | 未找到指定联系人/联系人组。 |