monitor — Cloud Monitor
monitor · 2018-07-24
DescribeAllNamespaces
POST
Query all namespaces.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeAllNamespaces 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: DescribeAllNamespaces' \
-H 'X-TC-Version: 2018-07-24' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Module":"<Module>","SceneType":"<SceneType>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| SceneType | string | Yes | Filter by use case. Currently, the only valid value is `ST_ALARM` (alarm type). |
| Module | string | Yes | Value fixed at "monitor" |
| MonitorTypes | string[] | No | Filter by monitor type. Valid values: MT_QCE (Converge Cloud service monitoring). If this parameter is left empty, all will be queried by default |
| Ids | string[] | No | Filter by namespace ID. If this parameter is left empty, all will be queried |
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 |
|---|---|---|
| QceNamespaces | CommonNamespace | Alarm policy type of Converge Cloud service (disused) |
| CustomNamespaces | CommonNamespace | Other alarm policy type (disused) |
| QceNamespacesNew | CommonNamespace[] | Alarm policy type of Converge Cloud service |
| CustomNamespacesNew | CommonNamespace[] | Other alarm policy type (not supported currently) |
| CommonNamespaces | CommonNamespaceNew[] | General alarm policy type, including TAPM, RUM, and CAT. |
| RequestId | string | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Success
{
"Response": {
"QceNamespaces": …,
"CustomNamespaces": …,
"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.
Request bodyvalid JSONPOST monitor.api3.convergecloud.com · DescribeAllNamespaces
Read-only. Creates nothing.