获取已绑定对象列表

最近更新时间:2020-01-09 14:40:01

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

获取已绑定对象列表

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:monitor.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBindingPolicyObjectList。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
GroupId Integer 策略组id

3. 输出参数

参数名称 类型 描述
List Array of DescribeBindingPolicyObjectListInstance 绑定的对象实例列表
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 绑定的对象实例总数
NoShieldedSum Integer 未屏蔽的对象实例数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取已绑定对象列表

输入示例

https://monitor.tencentcloudapi.com/?Action=DescribeBindingPolicyObjectList
&Module=monitor
&GroupId=11111
&<公共请求参数>

输出示例

{
  "Response": {
    "List": [
      {
        "Dimensions": "{\"unInstanceId\":\"ins-19701111\"}",
        "IsShielded": 0,
        "Region": "gz",
        "UniqueId": "9d091111111111111111111111111111"
      },
      {
        "Dimensions": "{\"unInstanceId\":\"ins-19031111\"}",
        "IsShielded": 0,
        "Region": "gz",
        "UniqueId": "ba8a1111111111111111111111111111"
      },
      {
        "Dimensions": "{\"unInstanceId\":\"ins-19b01111\"}",
        "IsShielded": 0,
        "Region": "gz",
        "UniqueId": "1a301111111111111111111111111111"
      }
    ],
    "NoShieldedSum": 3,
    "RequestId": "11111111-1111-1111-1111-111111111111",
    "Total": 3
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

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 操作不支持。