并行文件服务维度及监控项查询
接口功能介绍
获取资源池下服务、维度、监控项信息。
接口约束
资源池ID不能为空。
URI
GET /v4/monitor/query-items
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 否 | String | 云监控服务，并行文件为hpfs | hpfs | |
| itemType | 否 | String | 本参数表示监控项类型。不传返回全部类型。取值 series：指标类型 | series |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Array of Objects | 统计信息列表 | dataObj |
表 dataObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| service | String | 服务 | hpfs | |
| description | String | 描述 | 并行文件 | |
| dimensions | Array of Objects | 维度列表 | dimensionObj | |
| serviceCount | Integer | 服务下监控项数量 | 7 |
表 dimensionObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dimension | String | 维度 | pushgateway_hpfs | |
| description | String | 描述 | hpfs监控 | |
| monitorItems | Array of Objects | 监控资源列表 | monitorItem | |
| dimensionCount | Integer | 维度下监控项数量 | 7 |
表 monitorItem
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控项的key | fs_capacity_total | |
| metricName | String | 监控项名称 | 文件系统开通总容量 | |
| description | String | 监控指标描述 | 单个文件系统开通总容量 | |
| unit | String | 指标单位 | MB | |
| unitRelations | Array of Objects | 单位转换字典 | unitRelation | |
| dimensions | Array of Strings | 设备标签列表 | ['uuid'] | |
| isAlarm | Integer | 本参数表示是否支持告警。取值范围：0：不支持。1：支持。根据以上范围取值。 | 1 | |
| period | Integer | 上报周期 | 60 | |
| statistics | Array of Strings | 本参数表示趋势计算类型。并行文件取值范围:raw：原始值。avg：平均值、min：最小值、max：最大值 | ['avg','max','min'] | |
| itemType | Integer | 本参数表示监控项类型。取值范围：0：实例指标。1：分组指标。根据以上范围取值。 | 0 |
表 unitRelation
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| unit | String | 单位 | % | |
| weight | Double | 权重 | 1 |
请求示例
请求url
/v4/monitor/query-items?regionID=bb9fdb42056f11eda1610242ac110002&service=hpfs
请求头header
无
请求体body
无
响应示例
{
"httpstatus": 200,
"httpresult": {
"statusCode": 800,
"returnObj": {
"data": [
{
"service": "hpfs",
"description": "并行文件",
"dimensions": [
{
"dimension": "pushgateway_hpfs",
"description": "hpfs监控",
"monitorItems": [
{
"name": "fs_capacity_total",
"description": "单个文件系统开通总容量",
"unit": "MB",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"min",
"avg",
"max"
],
"metricName": "文件系统开通总容量",
"unitRelations": [
{
"weight": 1,
"unit": "bit"
},
{
"weight": 8,
"unit": "Byte"
},
{
"weight": 8192,
"unit": "KB"
},
{
"weight": 8388608,
"unit": "MB"
},
{
"weight": 8589934592,
"unit": "GB"
},
{
"weight": 8796093022208,
"unit": "TB"
}
],
"itemType": 0
},
{
"name": "fs_capacity_usage",
"description": "文件系统容量使用率",
"unit": "%",
"isAlarm": 1,
"period": 3600,
"dimensions": [
"uuid"
],
"statistics": [
""
],
"metricName": "文件系统容量使用率",
"unitRelations": [
{
"weight": 1,
"unit": "%"
}
],
"itemType": 0
},
{
"name": "fs_capacity_used",
"description": "单个文件系统已使用容量",
"unit": "MB",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"min",
"avg",
"max"
],
"metricName": "文件系统已使用容量",
"unitRelations": [
{
"weight": 1,
"unit": "bit"
},
{
"weight": 8,
"unit": "Byte"
},
{
"weight": 8192,
"unit": "KB"
},
{
"weight": 8388608,
"unit": "MB"
},
{
"weight": 8589934592,
"unit": "GB"
},
{
"weight": 8796093022208,
"unit": "TB"
}
],
"itemType": 0
},
{
"name": "fs_read_bw",
"description": "单个文件系统读带宽",
"unit": "Byte/s",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"min",
"avg",
"max"
],
"metricName": "文件系统读带宽",
"unitRelations": [
{
"weight": 1,
"unit": "Byte/s"
},
{
"weight": 1024,
"unit": "KB/s"
},
{
"weight": 1048576,
"unit": "MB/s"
},
{
"weight": 1073741824,
"unit": "GB/s"
}
],
"itemType": 0
},
{
"name": "fs_read_iops",
"description": "单个文件系统读iops",
"unit": "count/s",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"min",
"avg",
"max"
],
"metricName": "文件系统读iops",
"unitRelations": [
{
"weight": 1,
"unit": "count/s"
},
{
"weight": 1000,
"unit": "K/s"
},
{
"weight": 1000000,
"unit": "M/s"
}
],
"itemType": 0
},
{
"name": "fs_write_bw",
"description": "单个文件系统写带宽",
"unit": "Byte/s",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"max",
"min",
"avg"
],
"metricName": "文件系统写带宽",
"unitRelations": [
{
"weight": 1,
"unit": "Byte/s"
},
{
"weight": 1024,
"unit": "KB/s"
},
{
"weight": 1048576,
"unit": "MB/s"
},
{
"weight": 1073741824,
"unit": "GB/s"
}
],
"itemType": 0
},
{
"name": "fs_write_iops",
"description": "单个文件系统写iops",
"unit": "count/s",
"isAlarm": 1,
"period": 60,
"dimensions": [
"uuid"
],
"statistics": [
"avg",
"max",
"min"
],
"metricName": "文件系统写iops",
"unitRelations": [
{
"weight": 1,
"unit": "count/s"
},
{
"weight": 1000,
"unit": "K/s"
},
{
"weight": 1000000,
"unit": "M/s"
}
],
"itemType": 0
}
],
"dimensionCount": 7
}
],
"serviceCount": 7
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
}
并行文件实时监控数据查询
接口功能介绍
查询指定设备的实时监控数据。
接口约束
参见请求参数说明。
URI
POST /v4.2/monitor/query-latest-metric-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 云监控服务，并行文件为hpfs | hpfs | |
| dimension | 是 | String | 云监控维度，并行文件为pushgateway_hpfs | pushgateway_hpfs | |
| itemNameList | 是 | Array of Strings | 待查监控项名称，单次请求长度限制为10，并行文件对应监控项参见监控指标 | ['fs_capacity_usage','fs_capacity_used'] | |
| dimensions | 是 | Array of Objects | 查询设备标签列表，用于定位目标设备，多标签查询取交集，单次请求设备数量限制为10 | dimension |
表 dimension
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 设备标签键 | uuid | |
| value | 是 | Array of Strings | 设备标签键所对应的值，最大数量限制为10 在并行文件系统详情页挂载地址最后的16位即uuid，或并行文件信息查询API返回值中的cephID |
['wjuw92lvy7hbmofq'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemList | Array of Objects | 监控项数据 | itemList |
表 itemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemName | String | 监控项名称，并行文件对应监控项参见监控指标 | fs_capacity_usage | |
| itemDesc | String | 监控项中文介绍 | 文件系统容量使用率 | |
| itemUnit | String | 监控项单位 | % | |
| value | Float | 监控项值，具体请参考对应监控项文档 | 0.2169 | |
| timestamp | Integer | 监控数据采样Unix时间戳 | 1667816712 | |
| dimensions | Array of Objects | 监控项标签 | dimension |
表 dimension
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控项标签键 | uuid | |
| value | String | 监控项标签键对应的值 在并行文件系统详情页挂载地址最后的16位即uuid，或并行文件信息查询API返回值中的cephID |
wjuw92lvy7hbmofq |
请求示例
请求url
/v4.2/monitor/query-latest-metric-data
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"service": "hpfs",
"dimension": "pushgateway_hpfs",
"itemNameList": [
"fs_capacity_total"
],
"dimensions": [
{
"name": "uuid",
"value": [
"wjuw92lvy7hbmofq"
]
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"itemList": [
{
"itemName": "fs_capacity_total",
"itemDesc": "文件系统开通总容量",
"itemUnit": "MB",
"unitRelations": [
{
"unit": "bit",
"weight": 1
},
{
"unit": "Byte",
"weight": 8
},
{
"unit": "KB",
"weight": 8192
},
{
"unit": "MB",
"weight": 8388608
},
{
"unit": "GB",
"weight": 8589934592
},
{
"unit": "TB",
"weight": 8796093022208
}
],
"value": 524288,
"timestamp": 1731553221,
"dimensions": [
{
"name": "uuid",
"value": "wjuw92lvy7hbmofq"
}
]
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
并行文件历史监控数据查询
接口功能介绍
查询指定时间段内的设备时序指标监控数据。
接口约束
参见请求参数说明。
URI
POST /v4.2/monitor/query-history-metric-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 云监控服务，并行文件为hpfs | hpfs | |
| dimension | 是 | String | 云监控维度，并行文件为pushgateway_hpfs | pushgateway_hpfs | |
| itemNameList | 是 | Array of Strings | 待查监控项名称，单次请求长度限制为10，并行文件对应监控项参见监控指标 | ['fs_capacity_usage','fs_capacity_used'] | |
| startTime | 是 | Integer | 查询起始Unix时间戳，秒级 | 1667815639 | |
| endTime | 是 | Integer | 查询结束Unix时间戳，秒级 | 1667817639 | |
| dimensions | 是 | Array of Objects | 查询设备标签列表，用于定位目标设备，多标签查询取交集，单次请求设备数量限制为10 | dimension | |
| fun | 是 | String | 本参数表示聚合类型，默认值为avg。并行文件取值范围:raw：原始值。avg：平均值、min：最小值、max：最大值 | raw | |
| period | 否 | Integer | 聚合周期，单位：秒，默认300，需不小于60，推荐使用60的整倍数 | 300 |
表 dimension
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 设备标签键 | uuid | |
| value | 是 | Array of Strings | 设备标签键所对应的值，最大数量限制为10， 在并行文件系统详情页挂载地址最后的16位即uuid，或并行文件信息查询API返回值中的cephID |
['wjuw92lvy7hbmofq'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemList | Array of Objects | 监控项列表 | item |
表 item
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemName | String | 监控项名称 | fs_capacity_total | |
| itemDesc | String | 监控项中文介绍 | 单个文件系统开通总容量 | |
| itemUnit | String | 监控项单位 | MB | |
| itemData | Array of Objects | 监控项内容 | itemData | |
| dimensions | Array of Objects | 监控项标签 | dimension |
表 itemData
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| value | Float | 监控项值，具体请参考对应监控项文档 | 524288 | |
| timestamp | Integer | 监控数据Unix时间戳 | 1667815639 |
表 dimension
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控项标签键 | uuid | |
| value | String | 监控项标签键对应的值 | 9dc48979-4e19-45e2-b523-5d3c70d516b3 |
请求示例
请求url
/v4.2/monitor/query-history-metric-data
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"service": "hpfs",
"dimension": "pushgateway_hpfs",
"itemNameList": [
"fs_capacity_total"
],
"startTime":1731549518,
"endTime":1731549578,
"fun":"avg",
"dimensions": [
{
"name": "uuid",
"value": [
"wjuw92lvy7hbmofq"
]
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"itemList": [
{
"itemName": "fs_capacity_total",
"itemDesc": "文件系统开通总容量",
"itemUnit": "MB",
"unitRelations": [
{
"unit": "bit",
"weight": 1
},
{
"unit": "Byte",
"weight": 8
},
{
"unit": "KB",
"weight": 8192
},
{
"unit": "MB",
"weight": 8388608
},
{
"unit": "GB",
"weight": 8589934592
},
{
"unit": "TB",
"weight": 8796093022208
}
],
"itemData": [
{
"value": 524288,
"timestamp": 1731549518
},
{
"value": 524288,
"timestamp": 1731549578
}
],
"dimensions": [
{
"name": "uuid",
"value": "wjuw92lvy7hbmofq"
}
]
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
创建并行文件监控数据导出任务
接口功能介绍
调用此接口可创建数据导出任务。
接口约束
资源池ID、任务的名称、设备类型、监控项、聚合类型、起始时间、结束时间不为空。
URI
POST /v4/monitor/task-center/create-task
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| task | 是 | Object | 任务的具体参数 | taskObj |
表 taskObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 任务名称，必须4-20个字符，支持中英文、数字、下划线 | 数据导出任务A | |
| description | 否 | String | 任务描述，最多50个字符 | 导出7月数据 | |
| service | 是 | String | 云监控服务，并行文件为hpfs | ecs | |
| dimension | 是 | String | 云监控维度，并行文件为pushgateway_hpfs | ecs | |
| dimensions | 是 | Array of Objects | 查询设备标签列表，用于定位目标设备，多标签查询取交集 | dimensionObj | |
| itemNameList | 是 | Array of Strings | 待查监控项名称，单次请求长度限制为10，并行文件对应监控项参见监控指标 | ['cpu_util','mem_util'] | |
| aggregateType | 是 | Array of Strings | 本参数表示数据聚合类型。并行文件取值范围:raw：原始值。avg：平均值、min：最小值、max：最大值 | ['avg'] | |
| startTime | 是 | Integer | 数据起始时间，秒级 | 1692812541 | |
| endTime | 是 | Integer | 数据截止时间，秒级 | 1692842541 | |
| period | 否 | Integer | 聚合周期（除raw外其他聚合类型必传），单位：秒 | 3600 | |
| reportTemplate | 否 | Integer | 本参数表示报表模板。默认值为0。取值范围：0：默认报表模板。1：基础报表模板。根据以上范围取值。 | 0 |
表 dimensionObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 设备标签键 | uuid | |
| value | 是 | Array of Strings | 设备标签键所对应的值， 在并行文件系统详情页挂载地址最后的16位即uuid，或并行文件信息查询API返回值中的cephID |
['wjuw92lvy7hbmofq'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskID | String | 数据导出任务ID | TASKtacd8b6b4610b97d202306301808 |
请求示例
请求url
/v4/monitor/task-center/create-task
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"task": {
"name": "并行文件导出任务1",
"description": "用于导出并行文件历史监控数据",
"service": "hpfs",
"dimension": "pushgateway_hpfs",
"dimensions": [
{
"name": "uuid",
"value": [
"wjuw92lvy7hbmofq"
]
}
],
"itemNameList": [
"fs_capacity_total"
],
"aggregateType": [
"avg"
],
"startTime": 1731463118,
"endTime": 1731549578,
"period": 3600,
"reportTemplate": 0
}
}
响应示例
{
"statusCode":800,
"returnObj":{
"taskID": "TASKfaea11f9d85a21cb202411141130"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.DeviceType.Unknown | 未知设备类型 |
| Openapi.RegionInfo.Empty | 找不到资源池 |
| Openapi.Parameter.Error | 请求参数错误，可能是未传入必填项、参数类型错误、参数范围错误 |
| Monitor.DataQuery.AccessFailed | 访问内部系统失败 |
| Monitor.DataQuery.ResponseError | 访问内部系统返回错误 |
| 其他 | 请参考错误码 |
