{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00169901","maxLength":16,"minLength":1,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request message is invalid.","maxLength":255,"minLength":1,"type":"string"}}},"ListServerMetricDataResp":{"description":"监控信息集合,GPU服务器可能会有多个显卡的情况。","properties":{"server_metrics":{"description":"监控数据。","items":{"$ref":"#/definitions/ServerMetricData"},"type":"array"}}},"ServerDataPoints":{"description":"指标数据结构。","properties":{"average":{"description":"聚合周期内指标数据的平均值。","example":10.740412979351031,"format":"double","readOnly":true,"type":"number"},"max":{"description":"聚合周期内指标数据的最大值。","example":10.740412979351031,"format":"double","readOnly":true,"type":"number"},"min":{"description":"聚合周期内指标数据的最小值。","example":10.740412979351031,"format":"double","readOnly":true,"type":"number"},"sum":{"description":"聚合周期内指标数据的求和值。","example":10.740412979351031,"format":"double","readOnly":true,"type":"number"},"timestamp":{"description":"指标采集时间,UNIX时间戳,单位毫秒。","example":1655986862000,"format":"int64","readOnly":true,"type":"integer"},"unit":{"description":"指标单位。","example":"%","readOnly":true,"type":"string"},"variance":{"description":"聚合周期内指标数据的方差。","example":10.740412979351031,"format":"double","readOnly":true,"type":"number"}}},"ServerMetricData":{"description":"监控信息。","properties":{"datapoints":{"description":"指标数据列表。","items":{"$ref":"#/definitions/ServerDataPoints"},"readOnly":true,"type":"array"},"dimension_value":{"description":"维度值,仅查询GPU监控信息时有值。","example":"2e84018fc8b4484b94e89aae212fe615","readOnly":true,"type":"string"},"metric_name":{"description":"监控指标名称。","example":"cpu_util","readOnly":true,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"12b2bb072b01424fa15437296ff5b519","info_version":"v1","method":"get","name":"ListServerMetricData","parameters":{},"paths":{"/v1/{project_id}/app-servers/server-metric-data/{server_id}":{"get":{"description":"查询指定时间范围指定指标的指定粒度的监控数据,可以通过参数指定需要查询的数据维度。","operationId":"ListServerMetricData","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"服务器唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"server_id","required":true,"type":"string"},{"description":"服务的命名空间:例如 \"SYS.ECS/AGT.ECS\",当namespace为AGT.ECS,则查询GPU监控指标: - SYS.ECS:弹性云服务器的基础监控指标。 - AGT.ECS:弹性云服务器操作系统监控的监控指标(GPU指标)。","in":"query","maxLength":32,"minLength":3,"name":"namespace","pattern":"^(SYS.ECS|AGT.ECS)?$","required":true,"type":"string"},{"description":"监控查询指标名称: - SYS.ECS命名空间的指标名称,请参考帮助文档:“[弹性云服务器支持的基础监控指标](https://support.huaweicloud.com/usermanual-ecs/ecs_03_1002.html)”。 - AGT.ECS命名空间的指标名称,请参考帮助文档:“[操作系统监控指标:GPU](https://support.huaweicloud.com/usermanual-ecs/ecs_03_1003.html#section11)”。","in":"query","maxLength":255,"minLength":1,"name":"metric_name","required":true,"type":"string"},{"description":"查询数据起始时间,UNIX时间戳,单位毫秒。","in":"query","maxLength":32,"minLength":1,"name":"from","required":true,"type":"string","x-example":1691671739879},{"description":"查询数据截止时间UNIX时间戳,单位毫秒。from必须小于to。","in":"query","maxLength":32,"minLength":1,"name":"to","required":true,"type":"string","x-example":1691671739879},{"description":"监控数据粒度。 取值范围: - 1: 实时数据。 - 300: 5分钟粒度。 - 1200: 20分钟粒度。 - 3600: 1小时粒度。 - 14400: 4小时粒度。 - 86400: 1天粒度。","format":"int32","in":"query","name":"period","required":true,"type":"integer","x-example":300},{"description":"数据聚合方式,支持的聚合方式如下: - average:聚合周期内指标数据的平均值。 - max:聚合周期内指标数据的最大值。 - min:聚合周期内指标数据的最小值。 - sum:聚合周期内指标数据的求和值。 - variance:聚合周期内指标数据的方差。","in":"query","name":"filter","pattern":"^(average|max|min|sum|variance)?$","required":true,"type":"string","x-example":"average"}],"responses":{"200":{"description":"操作成功。","examples":{"application/json":{"server_metrics":[{"datapoints":[{"average":0.23,"timestamp":1442341200000,"unit":"%"}],"dimension_value":"2e84018fc8b4484b94e89aae212fe615","metric_name":"gpu_usage_encoder"},{"datapoints":[{"average":0.23,"timestamp":1442341200000,"unit":"%"}],"dimension_value":"7784018fc8b4484b94e89aae212fe455","metric_name":"gpu_usage_encoder"}]}},"schema":{"$ref":"#/definitions/ListServerMetricDataResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/ErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/ErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ErrorResp"}}},"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"查询指定时间范围指定指标的指定粒度的监控数据","tags":["Server"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"get","name":"wks-apsmanager-lb","path":"/v1/{project_id}/app-servers/server-metric-data/{server_id}","scheme":"https","timeout":30000},"parameters":[{"description":"请求头。","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"},{"description":"租户id。","in":"path","name":"project_id","origin":"request","value":"project_id"},{"description":"服务器id。","in":"path","name":"server_id","origin":"request","value":"server_id"},{"description":"服务的命名空间。","in":"query","name":"namespace","origin":"request","value":"namespace"},{"description":"指标名称。","in":"query","name":"metric_name","origin":"request","value":"metric_name"},{"description":"查询数据起始时间,UNIX时间戳,单位毫秒。","in":"query","name":"from","origin":"request","value":"from"},{"description":"查询数据截止时间UNIX时间戳,单位毫秒。from必须小于to。","in":"query","name":"to","origin":"request","value":"to"},{"description":"监控数据粒度。","in":"query","name":"period","origin":"request","value":"period"},{"description":"数据聚合方式。","in":"query","name":"filter","origin":"request","value":"filter"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/app-servers/server-metric-data/8115c9d8464ead3a38309130?namespace=AGT.ECS&metric_name=cpu_util&from=1691671739879&to=1691671739872&period=1&filter=average","x-support-sdk":"Y"}}},"product_short":"WorkspaceApp","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"查询指定时间范围指定指标的指定粒度的监控数据","tags":"服务器管理","uri":null,"version":"2.0"}