文档

DescribeMonitorGroupInstances - 查询指定应用分组内包含的资源列表

更新时间:

调用DescribeMonitorGroupInstances接口查询指定应用分组内包含的资源列表。

调试

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

授权信息

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

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

请求参数

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

每页显示记录条数。默认值:10。

10
PageNumberinteger

页码。默认值:1。

1
GroupIdlong

应用分组 ID。

12345
Categorystring

产品名称或产品规格缩写,取值范围:

  • ecs(包括阿里云和非阿里云主机)
  • rds(云数据库 RDS 版)
  • ads(分析型数据库)
  • slb(负载均衡)
  • vpc(弹性 IP)
  • apigateway(API 网关)
  • cdn(域名加速)
  • cs(容器服务 Swarm 版)
  • dcdn(全站加速)
  • ddos(DDoS 防护)
  • eip(弹性公网 IP)
  • elasticsearch
  • emr(E-MapReduce)
  • ess(弹性伸缩)
  • hbase(云数据库 HBase 版)
  • iot_edge(IoT 边缘计算)
  • k8s_pod(k8s pod)
  • kvstore_sharding(Redis 集群版)
  • kvstore_splitrw(Redis 读写分离版)
  • kvstore_standard(Redis 标准版)
  • memcache(云数据库 Memcache)
  • mns(消息服务)
  • mongodb(MongoDB 副本实例)
  • mongodb_cluster(MongoDB 集群版本)
  • mongodb_sharding(MongoDB 分片集群)
  • mq_topic(消息服务 TOPIC)
  • ocs(旧版云数据库 Memcache)
  • opensearch(开放搜索)
  • oss(对象存储 OSS)
  • polardb(云数据库 PolarDB)
  • petadata(HybridDB for MySQL)
  • scdn(安全加速)
  • sharebandwidthpackages(共享带宽包)
  • sls(日志服务)
  • vpn(VPN 网关)

N 的取值范围为 1~200。

ecs
Keywordstring

按照实例名称模糊查询。

s1
InstanceIdsstring

按照实例 ID 搜索。

i-x1234568

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

97F2A410-9412-499C-9AD1-76EF7EC02DF2
Successboolean

请求是否成功。

true
Codeinteger

状态码。

说明 状态码为 200 表示成功。
200
Messagestring

错误信息。

success
PageNumberinteger

页码。

1
PageSizeinteger

每页记录条数。

10
Totalinteger

总记录条数。

12
Resourcesobject []

应用分组资源的描述信息。

Categorystring

产品名称缩写。

ecs
InstanceIdstring

实例 ID,实例的唯一标识。

i-2ze3w55tr2r****
InstanceNamestring

实例名称。

hostIP
Idlong

资源 ID。

12345
RegionIdstring

实例对应的地域。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "97F2A410-9412-499C-9AD1-76EF7EC02DF2",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 10,
  "Total": 12,
  "Resources": {
    "Resource": [
      {
        "Category": "ecs",
        "InstanceId": "i-2ze3w55tr2r****",
        "InstanceName": "hostIP",
        "Id": 12345,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

JSON格式

{
  "RequestId": "97F2A410-9412-499C-9AD1-76EF7EC02DF2",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 10,
  "Total": 12,
  "Resources": {
    "Resource": [
      {
        "Category": "ecs",
        "InstanceId": "i-2ze3w55tr2r****",
        "InstanceName": "hostIP",
        "Id": 12345,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403AccessForbiddenThe X.509 certificate or cms access key ID provided does not exist in our records.-
404ResourceNotFoundThe specified resource is not found.未找到指定资源。
406%s%s-
429Throttli∂ngExceptionThe request was denied due to request throttling.-
500InternalErrorThe request processing has failed due to some unknown error.-

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

  • 本页导读 (1)
文档反馈