删除告警联系人组。
请求说明
- 请求方式:POST
- 请求地址:https://open.volcengineapi.com/?Action=DeleteContactGroups&Version=2021-03-03
请求参数
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | DeleteContactGroups | 公共参数,本接口值:DeleteContactGroups。 |
Version | String | 是 | 2021-03-03 | 公共参数,本接口值:2021-03-03。 |
Ids | Array of String | 是 | ["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"] | 联系人组 ID。 |
请求示例
POST /?Action=DeleteContactGroups&Version=2021-03-03
Content-Type:application/json
{
"Ids": ["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"]
}
返回参数
参数名称 | 类型 | 示例值 | 描述 |
---|
SuccessfulItems | Array of String | ["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"] | 成功删除的联系人组 ID。 |
UnsuccessfulItems | Array of UnsuccessfulItem | - | 未成功删除的联系人组信息。 |
UnsuccessfulItem
参数名称 | 类型 | 示例值 | 描述 |
---|
Id | String | 9011e74d-42ea-45d5-ba20-a972888f29b5 | 未成功删除的联系人组 ID。 |
Error | Object UnsuccessfulItemError | - | 未成功操作的原因。 |
UnsuccessfulItemError
参数名称 | 类型 | 示例值 | 描述 |
---|
Code | String | NotFound.Ids | 错误码。 |
Message | String | The specified ContactGroup {{id}} is not found. | 错误信息。 |
Data | Map[String]String | - | 错误元数据。 |
返回示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"ResponseMetadata": {
"RequestId": "202211302208xxxx",
"Action": "DeleteContactGroups",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"SuccessfulItems": ["f9626b5a-0c9e-420e-b6e5-4c66b84f080d"],
"UnsuccessfulItems": [
{
"Id": "9011e74d-42ea-45d5-ba20-a972888f29b5",
"Error": {
"Code": " NotFound.Ids",
"Message": "The specified ContactGroup {{id}} is not found.",
"Data":
}
}
]
}
}
错误码
本接口错误码如下表所示,公共错误码请参见 公共错误码。
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 ContactGroup {{Id}} is not found. | 未找到指定联系人组。 |