You need to enable JavaScript to run this app.
导航
CreateContacts
最近更新时间:2024.06.26 12:08:54首次发布时间:2021.11.10 18:21:35

调用CreateContacts接口创建一个联系人。

使用限制

一个账户最多创建100个联系人。

请求说明

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

调试

请求参数

Query

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

Body

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

Name

String

testuser

联系人名称。

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

Email

String

1000@volc.com

告警邮件地址。
云监控会发送验证邮件至填写的邮件地址,需要在邮件地址中打开验证链接进行验证,此告警邮件才能生效,接收告警邮件。

Phone

String

13450000000

告警电话。
云监控会发送验证短信至填写的手机号,需要在短信中打开验证链接进行验证,此告警短信才能生效,接收告警消息。

返回参数

参数类型示例值描述
DataArray of String["157255269369******"]创建告警联系人的ID。

请求示例

POST https://open.volcengineapi.com?Action=CreateContacts&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "Name":"testuser",
    "Email":"1000@volc.com",
    "Phone":"13450000000"
}

返回示例

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

错误码

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