monitor · 2018-07-24

DescribeBaseMetrics

POST

Get the attributes of basic metrics.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeBaseMetrics path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://monitor.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/monitor/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: monitor.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeBaseMetrics' \
  -H 'X-TC-Version: 2018-07-24' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Namespace":"<Namespace>"}'

Request parameters

Field	Type	Required	Description
Namespace	string	Yes	Service namespace. Converge Cloud services have different namespaces. For more information on service namespaces, see the monitoring metric documentation of each service. For example, see CVM Monitoring Metrics for the namespace of CVM
MetricName	string	No	Metric name. Converge Cloud services have different metric names. For more information on metric names, see the monitoring metric documentation of each service. For example, see CVM Monitoring Metrics for the metric names of CVM
Dimensions	string[]	No	Filter by dimension. This parameter is optional.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
MetricSet	MetricSet[]	Listed of queried metric descriptions
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "MetricSet": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/monitor.

SecretIdSecretKey

Request bodyvalid JSONPOST monitor.api3.convergecloud.com · DescribeBaseMetrics

{
  "Namespace": "<Namespace>"
}

Read-only. Creates nothing.

Recorded example response

{
  "MetricSet": []
}