CreateContactGroup--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateContactGroup

最近更新时间：2024.09.03 15:42:17首次发布时间：2023.06.30 15:23:34

创建告警联系人组。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateContactGroup	接口名称。当前 API 的名称为 `CreateContactGroup`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Name	String	是	user-group-demo	联系人组名称: 支持大小写字母、中文、数字、中划线或下划线。不能以数字、中划线、下划线或其他特殊字符开头。长度小于 128 个字符。账户内唯一。
ContactIds	Array of String	否	["e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"]	联系人组中的联系人 ID 列表。

请求示例

POST https://open.volcengineapi.com/?Action=CreateContactGroup&Version=2021-03-03
Content-Type: application/json
{
    "Name": "user-group-demo",
    "ContactIds": [
        "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    ]
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	联系人组 ID。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateContactGroup",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    }
}

错误码

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

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 服务。
409	Conflict.Name	The specified name conflicts with existing {{resource}}.	指定的名称与已有资源重复。