monitor · 2018-07-24

DescribeStatisticData

POST

Query monitoring data by dimension conditions.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeStatisticData 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: DescribeStatisticData' \
  -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
Module	string	Yes	Module, whose value is fixed at `monitor`
Namespace	string	Yes	Namespace. Valid values: `QCE`, `TKE2`.
MetricNames	string[]	Yes	Metric name list
Conditions	MidQueryCondition[]	No	Dimension condition. The `=` and `in` operators are supported
Period	integer	No	Statistical period in seconds. Default value: 300. Optional values: 60, 300, 3,600, and 86,400.
StartTime	string	No	Start time, which is the current time by default, such as 2020-12-08T19:51:23+08:00
EndTime	string	No	End time, which is the current time by default, such as 2020-12-08T19:51:23+08:00
GroupBys	string[]	No	`groupBy` by the specified dimension

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
Period	integer	Statistical period
StartTime	string	Start time
EndTime	string	End time
Data	MetricData[]	Monitoring data
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "Period": …,
    "StartTime": …,
    "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 · DescribeStatisticData

{
  "Namespace": "<Namespace>"
}

Read-only. Creates nothing.