云监控服务 CES云监控服务 CES

更新时间:2021/10/08 GMT+08:00
分享

查询资源分组下的资源

功能介绍

根据资源分组ID查询资源分组下的资源。

URI

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    项目ID。

    获取方式请参见获取项目ID

    group_id

    资源分组ID。

    status

    资源健康状态,值可为health、unhealth、no_alarm_rule,health表示健康。

    namespace

    资源命名空间,例如弹性云服务器的资源命名空间为:SYS.ECS,各服务命名空间可查看支持监控的服务列表

    dname

    资源维度,例如弹性云服务器维度为:instance_id,各资源的维度可查看支持监控的服务列表

    start

    分页起始值,类型为integer,默认值为0。

    limit

    单次查询的条数限制,取值范围(0,100],默认值为100,用于限制结果数据条数。

  • 样例:查询资源分组下的资源。
    GET https://{云监控的endpoint}/V1.0/{project_id}/resource-groups/{group_id}

请求消息

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    group_name

    String

    资源分组的名称,如:Resource-Group-ECS-01。

    group_id

    String

    资源分组的ID,如:rg1603786526428bWbVmk4rP。

    resources

    Arrays of objects

    一组或者多组资源信息。

    status

    String

    资源分组的当前状态,值可为health、unhealth、no_alarm_rule。health表示健康,unhealth表示不健康,no_alarm_rule表示未设置告警规则。

    create_time

    Long

    资源分组的创建时间,UNIX时间戳,单位毫秒。如:1603819753000。

    meta_data

    MetaData object

    查询结果元数据信息,包括分页信息等。

    enterprise_project_id

    String

    创建资源分组时关联的企业项目。默认值为0,表示企业项目为default。

    表3 resources字段数据结构说明

    名称

    参数类型

    说明

    namespace

    String

    资源命名空间,如弹性云服务器的资源命名空间为:SYS.ECS,各服务命名空间可查看支持监控的服务列表

    dimensions

    Arrays of objects

    一个或者多个资源维度。

    status

    String

    资源分组的当前状态,值可为health、unhealth、no_alarm_rule。health表示健康,unhealth表示不健康,no_alarm_rule表示未设置告警规则。

    表4 dimensions字段数据结构说明

    名称

    参数类型

    说明

    name

    string

    资源维度,例如弹性云服务器维度为:instance_id,各资源的维度可查看支持监控的服务列表

    value

    string

    资源维度值,为资源的实例ID。如:4270ff17-aba3-4138-89fa-820594c39755。

    表5 meta_data字段数据结构说明

    名称

    参数类型

    说明

    count

    Integer

    当前返回结果条数。

    total

    Integer

    结果总条数。

    marker

    String

    下一个开始的标记,用于分页。

    • 返回样例
      {
       "group_name": "ResourceGroup-Test-01",
       "resources": [
         {
           "namespace": "SYS.ECS",
           "dimensions": [
             {
               "name": "instance_id",
               "value": "6cffb0bd-fd37-400f-ae6f-8f4be021ff7e"
             }
           ],
           "status": "health",
           "event_type": 0
         },
         {
           "namespace": "SYS.ECS",
           "dimensions": [
             {
               "name": "instance_id",
               "value": "e37d6238-9dd3-4720-abcc-eb9f8fb08ca0"
             }
           ],
           "status": "health",
           "event_type": 0
         }
       ],
       "create_time": 1604476378000,
       "group_id": "rg16044763786104XvXvl00a",
       "status": "health",
       "meta_data": {
         "count": 0,
         "marker": "",
         "total": 2
       },
       "enterprise_project_id": "0"
      }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    未提供认证信息,或认证信息错误。

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

    请求超出了服务器的等待时间。

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成,服务异常。

    503 Service Unavailable

    系统暂时不可用,请求受限。

错误码

请参考返回错误码说明

分享:

    相关文档

    相关产品