查询监控空间的使用情况信息
接口描述
POST
/monitor/ts/data/v1/subscriptions/:subscription_name/resourceGroups/:resource_group_name/zones/:zone/telemetryStations/:telemetry_station_name/usage
查询监控空间的使用情况信息
请求头(Request Header)
请求参数(Request Parameters)
名称 | 类型 | 必须 | 位置 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|---|
subscription_name | string | 是 | path | - | - | 订阅 |
resource_group_name | string | 是 | path | - | - | 资源组 |
zone | string | 是 | path | - | - | 可用区 |
telemetry_station_name | string | 是 | path | - | - | 监控空间 |
请求体(Request Body)
名称 | 类型 | 描述 |
---|---|---|
filter | Filter | 用于进一步筛选日志的筛选字符串 |
start | string | 日志检索的起始时间 |
end | string | 日志检索的结束时间 |
granularity | enum | 用量粒度 USAGE_GRANULARITY_UNSPECIFIED, USAGE_GRANULARITY_HOUR, USAGE_GRANULARITY_DAY, USAGE_GRANULARITY_MONTH, USAGE_GRANULARITY_YEAR |
其中Filter
如下:
名称 | 类型 | 描述 |
---|---|---|
key | string | 自定义查询的键 |
value | string | 自定义查询的值,可以是中文或自定义值 |
请求示例(Request Example)
curl -XPOST 'https://monitor.sensecoreapi.dev/monitor/ts/data/v1/subscriptions/8d2c81fc-717c-434e-898a-a5722c11d0cc/resourceGroups/default/zones/sh-regional/telemetryStations/ts-user-c0c6c1a8-409f-4e69-8fc9-769d1eebb467/usage' \
-H 'Content-Type: application/json' \
-d '
{
"filter":
[
{
"resource_type": "storage.afs.v2.volume",
"resource_id": "2b4b3f38-ebeb-11ee-ae5e-0a9a76b0ff14",
"usage_name": "capacity"
}
]
}
'
响应(Response)
名称 | 类型 | 描述 |
---|---|---|
results | []Result | 用量结果 |
其中Result
如下
名称 | 类型 | 描述 |
---|---|---|
resource_type | string | 资源类型 |
resource_id | string | 资源 ID |
start | string | 用量开始时间 |
end | string | 用量结束时间 |
usage_name | string | 用量名称 |
usage_unit | string | 用量单位 |
usage_quantity | string | 用量粒度 |
granularity | string | 资源唯一名称 |
响应示例(Response Example)
{
"results": [
{
"resource_id": "2b4b3f38-ebeb-11ee-ae5e-0a9a76b0ff14",
"resource_type": "storage.afs.v2.volume",
"usage_name": "capacity",
"usage_unit": "KiB",
"usage_quantity": 0,
"granularity": "USAGE_GRANULARITY_UNSPECIFIED",
"start": "2024-04-12T05:28:00Z",
"end": "2024-04-12T05:28:00Z"
}
]
}