调用DescribeContactList接口查询报警联系人列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:DescribeContactList | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageSize | integer | 否 | 每页显示的记录条数。 默认值：100。 | 10 |
| PageNumber | integer | 否 | 当前页码。 默认值：1。 | 1 |
| ContactName | string | 否 | 报警联系人姓名。 | Alice |
| ChanelType | string | 否 | 报警类型。取值：
| |
| ChanelValue | string | 否 | 报警类型的值。 说明
仅当 ChanelType设置为Mail时，需要设置该参数。
| Alice@example.com |
返回参数
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "The Request is not authorization.",
"RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
"Total": 15,
"Success": true,
"Contacts": {
"Contact": [
{
"UpdateTime": 1552356159000,
"Name": "Alice",
"CreateTime": 1552356159000,
"Lang": "zh-cn",
"Desc": "ECS联系人",
"ContactGroups": {
"ContactGroup": [
{
"ContactGroup": [
"ECS_Group",
"Jim"
]
}
]
},
"Channels": {
"Mail": "Alice@example.com",
"AliIM": "Alice",
"DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
"SMS": "1333333****"
},
"ChannelsState": {
"Mail": "PENDING",
"AliIM": "OK",
"DingWebHook": "OK",
"SMS": "OK"
}
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidParameter | %s |
| 403 | InvalidAuthorization | %s |
| 404 | ResourceNotFound | %s |
| 500 | InternalError | The request processing has failed due to some unknown error. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史