更新时间:2023-08-15 GMT+08:00

查询主机配置数据

功能介绍

查询指定时间范围指定事件类型的主机配置数据,可以通过参数指定需要查询的数据维度。

该接口提供给HANA场景下SAP Monitor查询主机配置数据,其他场景下查不到主机配置数据。

调试

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

URI

GET /V1.0/{project_id}/event-data

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    项目ID。

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

  • 以下列表为查询检索参数

    名称

    是否必选

    参数类型

    说明

    namespace

    String

    查询服务的命名空间,各服务命名空间请参考支持监控的服务列表

    格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,service.item总长度最短为3,最大为32。

    type

    String

    事件类型,只允许字母、下划线、中划线,字母开头,长度不超过64,如instance_host_info。

    from

    String

    查询数据起始时间,UNIX时间戳,单位毫秒。

    to

    String

    查询数据截止时间UNIX时间戳,单位毫秒。from必须小于to。

    dim

    String

    监控维度,例如弹性云服务器的维度为instance_id。各服务监控指标对应的维度请参考支持监控的服务列表中对应服务的监控指标说明。

    指标的维度,目前最大支持3个维度,维度编号从0开始;维度格式为dim.{i}=key,value。key的最大长度32,value的最大长度为256。

    例如dim.0=instance_id,i-12345

  • 样例:查询弹性云服务器ID为33328f02-3814-422e-b688-bfdba93d4051,事件类型为instance_host_info的主机配置信息。
    GET https://{云监控的endpoint}/V1.0/{project_id}/event-data?namespace=SYS.ECS&dim.0=instance_id,33328f02-3814-422e-b688-bfdba93d4051&type=instance_host_info&from=1450234543422&to=1450320943422

请求消息

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    datapoints

    Array of objects

    配置信息列表。如果不存在对应的配置信息,则datapoints为空数组[]。

    详细参数请参见表3

    表3 datapoints字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    事件类型,例如instance_host_info。

    timestamp

    Long

    事件上报时间,UNIX时间戳,单位毫秒。

    value

    String

    主机配置信息。

  • 响应样例
    {
        "datapoints": [
            {
                "type": "instance_host_info",
                "timestamp": 1450231200000,
                "value": "xxx"
            },
            {
                "type": "instance_host_info",
                "timestamp": 1450231800000,
                "value": "xxx"
            }
        ]
    }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

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

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

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

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成,服务异常。

    503 Service Unavailable

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

错误码

请参考返回错误码说明