UpdateContactsWithContactGroups--云监控-火山引擎

文档中心

立即注册

导航

UpdateContactsWithContactGroups

最近更新时间：2024.09.24 18:56:29首次发布时间：2021.11.10 18:21:35

将某一联系人添加到指定的一个或多个联系组。

使用限制

一个联系人最多可以添加到10个告警联系组。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateContactsWithContactGroups&Version=2018-01-01

ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateContactsWithContactGroups`	接口名称。当前 API 的名称为 `UpdateContactsWithContactGroups`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

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

Id String 是 145262463627244**** 联系人ID。

参数	类型	是否必选	示例值	描述
Id	String	是	`145262463627244****`	联系人ID。
ContactGroupIds	Array of String	否	`["145080093687100**","145080093687100**"]`	联系组ID。取值会替换联系人已关联的联系组。 ID不能超过10条，即单个联系人最多可以添加到10个联系组中。

ContactGroupIds

Array of String

否

["145080093687100****","145080093687100****"]

联系组ID。

取值会替换联系人已关联的联系组。
ID不能超过10条，即单个联系人最多可以添加到10个联系组中。

返回参数

参数	类型	示例值	描述
Data	Array of String	`["145262463627244****"]`	联系人ID。

请求示例

POST https://open.volcengineapi.com?Action=UpdateContactsWithContactGroups&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "Id":"145258255725730****",
    "ContactGroupIds":[
        "14524768103600****",
        "145080104031932****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022092215001701017423503808******",
        "Action": "UpdateContactsWithContactGroups",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": [
            "145262463627244****"
        ]
    }
}

错误码

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

云监控