You need to enable JavaScript to run this app.
导航
CreateContactGroup
最近更新时间:2024.09.24 18:56:29首次发布时间:2021.11.10 18:21:34

创建一个告警联系组。

使用限制

单个账号最多可创建100个联系组。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=CreateContactGroup&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

请求参数

Query

参数类型是否必选示例值描述
ActionStringCreateContactGroup接口名称。当前 API 的名称为 CreateContactGroup
VersionString2018-01-01接口版本。当前 API 的版本为 2018-01-01

Body

参数类型是否必选示例值描述

Name

String

主联系组

联系组的名称。

  • 不能以数字、中划线开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度限制在1 ~ 128字符之间。

Description

String

该联系组为主要联系组,默认请绑定此联系组。

联系组的描述。

  • 若不填,默认为空字符串。
  • 长度限制在1 ~ 255字符之间。
  • 允许包含中文、英文、下划线等特殊字符。

ContactsIdList

Array of String

["145247681036000****",
"145247681036001****"]

创建联系组时需添加联系人,取值应为联系人ID。

  • 联系人ID可以通过ListContacts接口获取。
  • ID不能超过100条,即单个联系组内成员最大上限为100。

返回参数

参数类型示例值描述
DataArray of String["1599*****9648"]联系组ID。

请求示例

POST https://open.volcengineapi.com?Action=CreateContactGroup&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "Name": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "",
        "Action": "CreateContactGroup",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": [
            "1599*****9648"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码