查询所有资源分组

功能介绍

查询所创建的所有资源分组。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /V1.0/{project_id}/resource-groups

• 参数说明

  表1 参数说明

  名称	类型	是否必选	说明
  project_id	String	是	项目ID。 获取方式请参见获取项目ID。
  group_name	String	否	资源分组的名称，如：Resource-Group-ECS-01。
  group_id	String	否	资源分组的ID，如：rg1603786526428bWbVmk4rP。
  status	String	否	资源分组的当前状态，值可为health、unhealth、no_alarm_rule。health表示健康，unhealth表示不健康，no_alarm_rule表示未设置告警规则。
  start	Integer	否	分页起始值，类型为integer，默认值为0。
  limit	Integer	否	单次查询的条数限制。取值范围(0,100]，默认值为100，用于限制结果数据条数。

• 样例：查询所有资源分组。

  GET https://{云监控的endpoint}/V1.0/{project_id}/resource-groups

请求消息

无

响应消息

• 响应参数

  表2 响应参数

  名称	参数类型	是否必选	说明
  resource_groups	Array of objects	否	一个或者多个资源分组信息。 详细参数说明请参见表3。
  meta_data	MetaData object	否	查询结果元数据统计个数。 详细参数说明请参见表5。

  表3 resource_groups字段数据结构说明

  名称	参数类型	是否必选	说明
  group_name	String	否	资源分组的名称，如：ResourceGroup-Test01。
  group_id	String	否	资源分组的ID，如：rg1603786526428bWbVmk4rP。
  create_time	Long	否	资源分组的创建时间，UNIX时间戳，单位毫秒。如：1603819753000。
  relation_ids	Array of strings	否	企业项目ID列表。
  type	String	否	资源分组添加资源方式，EPS：同步企业项目，TAG：标签动态匹配，空值：手动添加。 最小长度：0 最大长度：32
  resources	Array of Resource objects	否	一组或者多个资源信息，默认为空。 数组长度：0 - 20
  instance_statistics	InstanceStatistics object	否	资源分组中的资源信息统计。 详细参数说明请参见表4。
  status	String	否	资源分组的当前状态。值可为health、unhealth、no_alarm_rule。health表示健康，unhealth表示不健康，no_alarm_rule表示未设置告警规则。
  enterprise_project_id	String	否	创建资源分组时关联的企业项目。默认值为0，表示企业项目为default。

  表4 instance_statistics字段数据结构说明

  名称	参数类型	是否必选	说明
  unhealth	Integer	否	该资源分组中当前处在告警状态的资源个数。
  total	Integer	否	该资源分组中资源的总个数。
  type_statistics	Integer	否	该资源分组中选择的资源类型个数。如资源分组添加了弹性云服务、弹性公网IP和带宽则值为2。

  表5 meta_data字段数据结构说明

  名称	参数类型	是否必选	说明
  total	Integer	否	结果总条数。

  • 返回样例

    {
      "resource_groups": [
       {
         "group_name": "ResourceGroup-Test01",
         "create_time": 1606374365000,
         "group_id": "rg16063743652226ew93e64p",
         "relation_ids": ["0"],
         "instance_statistics": {
           "unhealth": 2,
           "total": 10,
           "type_statistics": 1
         },
         "status": "unhealth",
         "enterprise_project_id": "0",
         "type": "TAG",
         "resources": []
       },
       {
         "group_name": "RS",
         "create_time": 1606327955000,
         "group_id": "rg1606327955657LRj1lrE4y",
         "relation_ids": ["0"],
         "instance_statistics": {
           "unhealth": 0,
           "total": 2,
           "type_statistics": 1
         },
         "status": "no_alarm_rule",
         "enterprise_project_id": "0",
         "type": "TAG",
         "resources": []
       },
       {
         "group_name": "RS",
         "create_time": 1606327947000,
         "group_id": "rg1606327947514v9OWqAD3N",
         "relation_ids": ["0"],
         "instance_statistics": {
           "unhealth": 0,
           "total": 2,
           "type_statistics": 1
         },
         "status": "no_alarm_rule",
         "enterprise_project_id": "0",
         "type": "TAG",
         "resources": []
       },
       {
         "group_name": "RS",
         "create_time": 1606327946000,
         "group_id": "rg1606327946625PYogr059N",
         "relation_ids": ["0"],
         "instance_statistics": {
           "unhealth": 0,
           "total": 2,
           "type_statistics": 1
         },
         "status": "no_alarm_rule",
         "enterprise_project_id": "0",
         "type": "TAG",
         "resources": []
       },
       {
         "group_name": "ResourceGroupCorrect_2",
         "create_time": 1606325669000,
         "group_id": "rg1606325669900Rk4eKkLMZ",
         "relation_ids": ["0"],
         "instance_statistics": {
           "unhealth": 0,
           "total": 1,
           "type_statistics": 1
         },
         "status": "no_alarm_rule",
         "enterprise_project_id": "0",
         "type": "TAG",
         "resources": []
       }
     ],
     "meta_data": {
       "total": 5
     }
    }

返回值

• 正常

  200

• 异常

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	未提供认证信息，或认证信息错误。
  403 Forbidden	请求页面被禁止访问。
  408 Request Timeout	请求超出了服务器的等待时间。
  429 Too Many Requests	当前请求过多。
  500 Internal Server Error	请求未完成，服务异常。
  503 Service Unavailable	系统暂时不可用，请求受限。

错误码

请参考返回错误码说明。