cwp · 2018-02-28

DescribeBaselineRule

POST

Query the information on corresponding check items based on baseline ID.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeBaselineRule 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://cwp.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cwp/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cwp.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeBaselineRule' \
  -H 'X-TC-Version: 2018-02-28' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"BaselineId":"<BaselineId>","Limit":20,"Offset":0}'

Request parameters

Field	Type	Required	Description
BaselineId	integer	Yes	Baseline ID
Limit	integer	Yes	Pagination limit, with the maximum value being 100.
Offset	integer	Yes	Pagination parameter
Level	string[]	No	Severity level
Status	integer	No	Status
Quuid	string	No	Host QUUID
Uuid	string	No	Host UUID

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
TotalCount	integer	Total number of pagination query records
BaselineRuleList	BaselineRuleInfo[]	Baseline check item list
ShowRuleRemark	boolean	Whether to display the description column. True: yes; false: no.Note: This field may return null, indicating that no valid values can be obtained.
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": {
    "TotalCount": …,
    "BaselineRuleList": …,
    "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/cwp.

SecretIdSecretKey

Request bodyvalid JSONPOST cwp.api3.convergecloud.com · DescribeBaselineRule

{
  "BaselineId": "<BaselineId>",
  "Limit": 20,
  "Offset": 0
}

Read-only. Creates nothing.