Querying Metrics
Function
Queries metrics.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/statistics/metrics
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_time |
Yes |
String |
Start time (UTC). |
end_time |
Yes |
String |
End time (UTC). |
dim |
No |
String |
Metric dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single-dimension: dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d. Multi-dimension: dim.0=key,value&dim.1=key,value. |
metric_names |
Yes |
Array of strings |
Metric name list. For details about the supported metric names, seeWorkspace O&M Monitoring Metrics. |
period |
No |
String |
Data period. The value can be DAY (daily) or HOUR (hourly). |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of Metric objects |
Response body for querying metrics. |
Parameter |
Type |
Description |
---|---|---|
metric_name |
String |
Metric name. |
metric_value |
Double |
Metric value. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
Succeeded.
[ { "metric_name" : "desktop_state", "metric_value" : 10 } ]
Status Codes
Status Code |
Description |
---|---|
200 |
Succeeded. |
400 |
Invalid request from the client. |
401 |
Authentication failed. |
500 |
Internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot