全部产品
Search
文档中心

应用实时监控服务ARMS:CreateOrUpdateContact - 创建或修改联系人

更新时间:Nov 05, 2024

创建或者修改告警联系人。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:CreateContactnone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ContactIdlong

告警联系人 ID。

  • 不填代表创建新的告警联系人。
  • 填写代表修改指定告警联系人信息。
123
ContactNamestring

告警联系人姓名。

JohnDoe
Phonestring

告警联系人手机号码。

说明 PhoneEmail 参数至少填写一项。每个手机号码或邮箱只能用于一个联系人。
1381111****
Emailstring

告警联系人邮箱地址。

说明 PhoneEmail 参数至少填写一项。每个手机号码或邮箱只能用于一个联系人。
someone@example.com
ReissueSendNoticelong

电话通知失败后,通知补发类型。

  • 0:不补发
  • 1:重复拨打一次电话
  • 2:发送短信通知
  • 3(默认):使用全局默认值
3
IsEmailVerifyboolean

邮箱是否已验证

true
DingRobotUrlstring

钉钉 Webhook 地址。

https://oapi.dingtalk.com/robot/send?access_token=69d4e0******
ResourceGroupIdstring

资源组 ID。

rg-acfmxyexli2****
CorpUserIdstring

告警联系人在自己企业组织内的标识,用于三方 IM 的@功能

A123221

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
AlertContactobject

返回 AlertContact 对象。

ContactIdfloat

告警联系人 ID。

123
ContactNamestring

告警联系人姓名。

JohnDoe
Phonestring

告警联系人手机号码。

1381111****
Emailstring

告警联系人邮箱地址。

someone@example.com
IsVerifyboolean

手机号码验证标识。

  • false(默认):未验证。
  • true:已验证。

您可以通过调用 SendTTSVerifyLink 接口验证联系人手机号,仅验证过的手机号可以在通知策略中使用电话的通知方式。

false
ReissueSendNoticelong

电话通知失败补发类型:0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值(当前为不补发)

3
isEmailVerifyboolean

邮箱是否已验证。

true
DingRobotUrlstring

钉钉告警机器人 URL。

https://test1.com

示例

正常返回示例

JSON格式

{
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "AlertContact": {
    "ContactId": 123,
    "ContactName": "JohnDoe",
    "Phone": "1381111****",
    "Email": "someone@example.com",
    "IsVerify": false,
    "ReissueSendNotice": 3,
    "isEmailVerify": true,
    "DingRobotUrl": "https://test1.com"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-09OpenAPI 入参发生变更查看变更详情
2024-05-09API 内部配置变更,不影响调用查看变更详情
2022-06-24OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情