Querying Metrics

Function

This API is used to query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: resType_resId), start position, and maximum number of returned records in pagination queries.

URI

POST /v2/{project_id}/ams/metrics?type={type}&limit={limit}&start={start}

Table 1 describes the parameters.

Request

Request parameters

Table 2 describes the request parameters.

Request headers

Table 4 describes the request headers.

Example request

(Query by namespace+appName+clusterName)

/v2/{projectId}/ams/metrics
{
    "metricItems": [
        {
            "namespace": "PAAS.CONTAINER",
            "dimensions":[
                {
                    "name":"appName",
                    "value":"demo"
                },
                {
                    "name":"clusterName",
                    "value":"test"
                }
            ]
        }
    ]
}

Response

Response parameters

Table 5 describes the response parameters.

Example response

{ 
    "errorCode": "AOM.0200", 
    "errorMessage": "success", 
    "metrics": [{ 
        "namespace": "abc", 
        "metricName": "cpuUsage", 
        "unit":"Percent", 
        "dimensions": [{ 
                    "name": "instance_id", 
                    "value": "demo1" 
        }]     
    }] 
}

Status Code

• Success response

  Table 6 describes the status code.

  Table 6 Status code

  Status Code	Message	Description
  200	OK	The request has succeeded.

• Error response

  Table 7 describes the status codes. For more information, see Status Codes.

  Table 7 Status codes

  Status Code	Message	Description
  400	Bad Request	The request is invalid. The client should not repeat the request without modifications.
  401	Unauthorized	The authorization information provided by the client is incorrect or invalid.
  403	Forbidden	The request is rejected. The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.
  500	Internal Server Error	The server is able to receive the request but unable to understand the request.
  503	Service Unavailable	The requested service is invalid. The client should not repeat the request without modifications.

Error Code