1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取基础策略告警组列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePolicyGroupList。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Module | 是 | String | 固定值,为"monitor" 示例值:monitor |
Limit | 是 | Integer | 分页参数,每页返回的数量,取值1~100 示例值:2 |
Offset | 是 | Integer | 分页参数,页偏移量,从0开始计数 示例值:0 |
Like | 否 | String | 按策略名搜索 示例值:test |
InstanceGroupId | 否 | Integer | 实例分组id 示例值:12345 |
UpdateTimeOrder | 否 | String | 按更新时间排序, asc 或者 desc 示例值:asc |
ProjectIds.N | 否 | Array of Integer | 项目id列表 示例值:[1] |
ViewNames.N | 否 | Array of String | 告警策略类型列表 示例值:[cvm_device] |
FilterUnuseReceiver | 否 | Integer | 是否过滤无接收人策略组, 1表示过滤, 0表示不过滤 示例值:0 |
Receivers.N | 否 | Array of String | 过滤条件, 接收组列表 示例值:[123] |
ReceiverUserList.N | 否 | Array of String | 过滤条件, 接收人列表 示例值:[12345] |
Dimensions | 否 | String | 维度组合字段(json字符串), 例如[[{"name":"unInstanceId","value":"ins-6e4b2aaa"}]] 示例值:{} |
ConditionTempGroupId | 否 | String | 模板策略组id, 多个id用逗号分隔 示例值:123,345 |
ReceiverType | 否 | String | 过滤条件, 接收人或者接收组, user表示接收人, group表示接收组 示例值:user |
IsOpen | 否 | Boolean | 过滤条件,告警策略是否已启动或停止 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
GroupList | Array of DescribePolicyGroupListGroup | 策略组列表 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 策略组总数 示例值:142 |
Warning | String | 备注信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:This method is deprecated! Use DescribeAlarmPolicies instead! |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取头两个基础策略告警组列表
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePolicyGroupList
<公共请求参数>
{
"Limit": 2,
"Module": "monitor",
"Offset": 0
}
输出示例
{
"Response": {
"GroupList": [
{
"GroupId": 0,
"GroupName": "abc",
"IsOpen": true,
"ViewName": "abc",
"LastEditUin": "abc",
"UpdateTime": 0,
"InsertTime": 0,
"UseSum": 0,
"NoShieldedSum": 0,
"IsDefault": 0,
"CanSetDefault": true,
"ParentGroupId": 0,
"Remark": "abc",
"ProjectId": 0,
"Conditions": [
{
"MetricShowName": "abc",
"Period": 0,
"MetricId": 0,
"RuleId": 0,
"Unit": "abc",
"AlarmNotifyType": 0,
"AlarmNotifyPeriod": 0,
"CalcType": 0,
"CalcValue": "abc",
"ContinueTime": 0,
"MetricName": "abc"
}
],
"EventConditions": [
{
"EventId": 0,
"RuleId": 0,
"EventShowName": "abc",
"AlarmNotifyPeriod": 0,
"AlarmNotifyType": 0
}
],
"ReceiverInfos": [
{
"ReceiverGroupList": [
0
],
"ReceiverUserList": [
0
],
"StartTime": 0,
"EndTime": 0,
"ReceiverType": "abc",
"NotifyWay": [
"abc"
],
"UidList": [
0
],
"RoundNumber": 0,
"RoundInterval": 0,
"PersonInterval": 0,
"NeedSendNotice": 0,
"SendFor": [
"abc"
],
"RecoverNotify": [
"abc"
],
"ReceiveLanguage": "abc"
}
],
"ConditionsTemp": {
"GroupId": 0,
"GroupName": "abc",
"ViewName": "abc",
"Remark": "abc",
"LastEditUin": "abc",
"UpdateTime": 0,
"InsertTime": 0,
"IsUnionRule": 0
},
"InstanceGroup": {
"InstanceGroupId": 0,
"ViewName": "abc",
"LastEditUin": "abc",
"GroupName": "abc",
"InstanceSum": 0,
"UpdateTime": 0,
"InsertTime": 0
},
"IsUnionRule": 0
}
],
"Total": 0,
"Warning": "abc",
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.AlertFilterRuleDeleteFailed | 删除过滤条件失败。 |
FailedOperation.AlertPolicyCreateFailed | 创建告警策略失败。 |
FailedOperation.AlertPolicyDeleteFailed | 告警策略删除失败。 |
FailedOperation.AlertPolicyDescribeFailed | 告警策略查询失败。 |
FailedOperation.AlertPolicyModifyFailed | 告警策略修改失败。 |
FailedOperation.AlertTriggerRuleDeleteFailed | 删除触发条件失败。 |
FailedOperation.DbQueryFailed | 数据库查询失败。 |
FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
FailedOperation.DbTransactionBeginFailed | 数据库事务开始失败。 |
FailedOperation.DbTransactionCommitFailed | 数据库事务提交失败。 |
FailedOperation.DimQueryRequestFailed | 请求维度查询服务失败。 |
FailedOperation.DoHTTPTransferFailed | 后端服务超时 |
FailedOperation.DruidQueryFailed | 查询分析数据失败。 |
FailedOperation.DuplicateName | 名字重复。 |
FailedOperation.ServiceNotEnabled | 服务未启用,开通服务后方可使用。 |
InternalError | 内部错误。 |
InternalError.ExeTimeout | 执行超时。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameterParam | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.MetricQuotaExceeded | 指标数量达到配额限制,禁止含有未注册指标的请求。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |