查询主机配置数据 - ShowEventData
功能介绍
查询指定时间范围指定事件类型的主机配置数据,可以通过参数指定需要查询的数据维度。注意:该接口提供给HANA场景下SAP Monitor查询主机配置数据,其他场景下查不到主机配置数据。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ces:eventData:get
Read
-
-
ces:sapEventData:list
-
URI
GET /V1.0/{project_id}/event-data
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 长度为[1,64]个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
namespace |
是 |
String |
参数解释 服务命名空间,样例:弹性云服务器的命名空间为SYS.ECS。 各服务命名空间请参阅支持监控的服务列表。 约束限制 不涉及 取值范围 格式为service.item,service和item以点号拼接组成。 service和item必须以字母(大写或小写)开头,后面可以跟零个或多个字母(大写或小写)、数字、下划线(_),长度为[3,32]个字符 默认取值 不涉及 |
|
dim.0 |
是 |
String |
参数解释 指标的第一层维度,目前最多支持4个维度,维度格式为dim.{i}=key,value。样例:instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 各服务资源的维度名称,请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。 约束限制 不涉及 取值范围 dim.0=key,value,由key、value以逗号拼接组成。 key必须以字母(大写或小写)开头,后面可以跟零个或多个字母(大写或小写)、数字、下划线()、连字符(-),长度为[1,32]个字符 value由多个字母(大写或小写)、数字、下划线()、连字符(-)、点(.)、斜杠(/)、井号(#)、英文左括号(()、英文右括号())组合而成,首个字符可以包含星号(*),但不能以连字符(-)开头,长度为[1,256]个字符 默认取值 不涉及 |
|
dim.1 |
否 |
String |
参数解释 指标的第二层维度,目前最多支持4个维度,维度格式为dim.{i}=key,value。样例:instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 各服务资源的维度名称,请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档。 约束限制 不涉及 取值范围 dim.1=key,value,由key、value以逗号拼接组成。 key必须以字母(大写或小写)开头,后面可以跟零个或多个字母(大写或小写)、数字、下划线()、连字符(-),长度为[1,32]个字符 value由多个字母(大写或小写)、数字、下划线()、连字符(-)、点(.)、斜杠(/)、井号(#)、英文左括号(()、英文右括号())组合而成,首个字符可以包含星号(*),但不能以连字符(-)开头,长度为[1,256]个字符 默认取值 不涉及 |
|
dim.2 |
否 |
String |
参数解释 指标的第三层维度,目前最多支持4个维度,维度格式为dim.{i}=key,value。样例:instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 各服务资源的维度名称,请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档 约束限制 不涉及 取值范围 dim.2=key,value,由key、value以逗号拼接组成。 key必须以字母(大写或小写)开头,后面可以跟零个或多个字母(大写或小写)、数字、下划线()、连字符(-),长度为[1,32]个字符 value由多个字母(大写或小写)、数字、下划线()、连字符(-)、点(.)、斜杠(/)、井号(#)、英文左括号(()、英文右括号())组合而成,首个字符可以包含星号(*),但不能以连字符(-)开头,长度为[1,256]个字符 默认取值 不涉及 |
|
dim.3 |
否 |
String |
参数解释 指标的第四层维度,目前最多支持4个维度,维度格式为dim.{i}=key,value。样例:instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 各服务资源的维度名称,请参阅具体云服务的文档。您可以直接从支持监控的服务列表页面导航至相应文档 约束限制 不涉及 取值范围 dim.3=key,value,由key、value以逗号拼接组成。 key必须以字母(大写或小写)开头,后面可以跟零个或多个字母(大写或小写)、数字、下划线()、连字符(-),长度为[1,32]个字符 value由多个字母(大写或小写)、数字、下划线()、连字符(-)、点(.)、斜杠(/)、井号(#)、英文左括号(()、英文右括号())组合而成,首个字符可以包含星号(*),但不能以连字符(-)开头,长度为[1,256]个字符 默认取值 不涉及 |
|
type |
是 |
String |
参数解释 事件类型 约束限制 不涉及 取值范围 必须以字母(大写或小写)开头,后面可以跟零个或多个字母(大写或小写)、数字、下划线(_)、连字符(-),长度为[1,64]个字符 默认取值 不涉及 |
|
from |
是 |
Long |
参数解释 查询数据起始时间,UNIX时间戳,单位毫秒 约束限制 不涉及 取值范围 毫秒级时间戳,范围为[0,9999999999999] 默认取值 不涉及 |
|
to |
是 |
Long |
参数解释 查询数据截止时间,UNIX时间戳,单位毫秒 约束限制 from必须小于to 取值范围 毫秒级时间戳,范围为[0,9999999999999] 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 长度为[1,64]个字符。 默认取值: 默认使用 application/json; charset=UTF-8,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 |
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 长度为[1,16384]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
datapoints |
Array of EventDataInfo objects |
参数解释: 配置信息列表 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释: 事件类型 取值范围: 不涉及 |
|
timestamp |
Long |
参数解释: 上报时间,UNIX时间戳,单位毫秒 取值范围: 不涉及 |
|
value |
String |
参数解释: 主机配置信息 取值范围: 不涉及 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
请求错误。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
未提供认证信息,或认证信息错误。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
请求页面被禁止访问。 |
状态码:408
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
请求超出了服务器的等待时间。 |
状态码:429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
请求过多。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
请求未完成,服务异常。 |
状态码:503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
系统暂时不可用,请求受限。 |
请求示例
/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
响应示例
状态码:200
OK
{
"datapoints" : [ {
"type" : "instance_host_info",
"timestamp" : 1450231200000,
"value" : "20"
}, {
"type" : "instance_host_info",
"timestamp" : 1450231800000,
"value" : "30"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
408 |
Request Timeout |
|
429 |
Too Many Requests |
|
500 |
Internal Server Error |
|
503 |
Service Unavailable |
错误码
请参见错误码。