1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取基础策略组详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePolicyGroupInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Module | 是 | String | 固定值,为"monitor" 示例值:monitor |
GroupId | 是 | Integer | 策略组id 示例值:123456 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
GroupName | String | 策略组名称 示例值:策略 |
ProjectId | Integer | 策略组所属的项目id 示例值:0 |
IsDefault | Integer | 是否为默认策略,0表示非默认策略,1表示默认策略 示例值:1 |
ViewName | String | 策略类型 示例值:cvm_device |
Remark | String | 策略说明 |
ShowName | String | 策略类型名称 示例值:云服务器基础监控 |
LastEditUin | String | 最近编辑的用户uin 示例值:123 |
UpdateTime | String | 最近编辑时间 示例值:1718159371 |
Region | Array of String | 该策略支持的地域 示例值:bj |
DimensionGroup | Array of String | 策略类型的维度列表 示例值:uuid |
ConditionsConfig | Array of DescribePolicyGroupInfoCondition | 阈值规则列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
EventConfig | Array of DescribePolicyGroupInfoEventCondition | 产品事件规则列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
ReceiverInfos | Array of DescribePolicyGroupInfoReceiverInfo | 用户接收人列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
Callback | DescribePolicyGroupInfoCallback | 用户回调信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{} |
ConditionsTemp | DescribePolicyGroupInfoConditionTpl | 模板策略组 注意:此字段可能返回 null,表示取不到有效值。 示例值:{} |
CanSetDefault | Boolean | 是否可以设置成默认策略 示例值:false |
IsUnionRule | Integer | 是否且规则 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询策略组信息
输入示例
https://monitor.tencentcloudapi.com/?Action=DescribePolicyGroupInfo
&Module=monitor
&GroupId=11111
&<公共请求参数>
输出示例
{
"Response": {
"Callback": null,
"CanSetDefault": true,
"ConditionsConfig": [
{
"AlarmNotifyPeriod": 86400,
"AlarmNotifyType": 0,
"CalcType": 1,
"CalcValue": "0",
"ContinueTime": 60,
"MetricId": 33,
"MetricShowName": "CPU利用率",
"Period": 60,
"RuleId": 200000,
"Unit": "%"
}
],
"ConditionsTemp": null,
"DimensionGroup": [
"unInstanceId"
],
"EventConfig": [
{
"AlarmNotifyPeriod": 86400,
"AlarmNotifyType": 0,
"EventId": 42,
"EventShowName": "ping不可达",
"RuleId": 200001
}
],
"GroupName": "策略组名称test",
"IsDefault": 0,
"LastEditUin": "1500000000",
"ProjectId": 0,
"IsUnionRule": 0,
"ReceiverInfos": null,
"Region": [
"bj",
"ca",
"cd",
"de",
"gz",
"gzopen",
"hk",
"hzec",
"jnec",
"jp",
"kr",
"nj",
"sg",
"sh",
"shjr",
"tsn",
"usw"
],
"Remark": "",
"RequestId": "11111111-1111-1111-1111-111111111111",
"ShowName": "云服务器-基础监控",
"UpdateTime": "2018-07-09 15:56:55",
"ViewName": "cvm_device"
}
}
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.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 | 操作不支持。 |