monitor · 2018-07-24

DescribeConditionsTemplateList

POST

Get the trigger condition template.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /monitor/DescribeConditionsTemplateList 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: DescribeConditionsTemplateList' \
  -H 'X-TC-Version: 2018-07-24' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Module":"<Module>"}'

Request parameters

Field	Type	Required	Description
Module	string	Yes	The value is fixed to `monitor`.
ViewName	string	No	View name, which can be obtained via DescribeAllNamespaces. For the monitoring of Converge Cloud services, the value of this parameter is `QceNamespacesNew.N.Id` of the output parameter of `DescribeAllNamespaces`, for example, `cvm_device`.
GroupName	string	No	Filter by trigger condition template name.
GroupID	string	No	Filter by trigger condition template ID.
Limit	integer	No	Pagination parameter, which specifies the number of returned results per page. Value range: 1-100. Default value: 20.
Offset	integer	No	Pagination offset starting from 0. Default value: 0.
UpdateTimeOrder	string	No	Sorting method by update time. `asc`: Ascending order; `desc`: Descending order.
PolicyCountOrder	string	No	Sorting order based on the number of associated policies. Valid values: `asc` (ascending order), `desc` (descending order).

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
Total	integer	Total number of templates.
TemplateGroupList	TemplateGroup[]	Template list.
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "Total": …,
    "TemplateGroupList": …,
    "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 · DescribeConditionsTemplateList

{
  "Module": "<Module>"
}

Read-only. Creates nothing.

Recorded example response

{
  "TemplateGroupList": [],
  "Total": 0
}