cdc · 2020-12-14

DescribeSites

POST

Query the site list.

Wire call

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

Request parameters

Field	Type	Required	Description
SiteIds	string[]	—	Filter by site id.
Name	string	—	Name of fuzzy matching site
Offset	integer	—	Offset, 0 by default For further information on Offset, please refer to relevant sections in API [Overview].
Limit	integer	—	Number of returned pieces, 20 by default and can be up to 100. For further information on Limit, please refer to relevant sections in API [Overview].

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
SiteSet	Site[]	List of sites that meet the query conditions
TotalCount	integer	Number of sites that meet the conditions
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": {
    "SiteSet": …,
    "TotalCount": …,
    "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/cdc.

SecretIdSecretKey

Request bodyvalid JSONPOST cdc.api3.convergecloud.com · DescribeSites

{}

Read-only. Creates nothing.

Recorded example response

{
  "SiteSet": [],
  "TotalCount": 0,
  "RequestId": "7ad2e7e8-7989-2054-99be-a28325d92a4e"
}