vpc — Virtual Private Cloud
vpc · 2017-03-12
DescribeCcnRoutes
POST
Query routes that have been added to a CCN.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeCcnRoutes 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://vpc.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: vpc.api3.convergecloud.com' \
-H 'X-TC-Action: DescribeCcnRoutes' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"CcnId":"<CcnId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| CcnId | string | Yes | The CCN instance ID, such as `ccn-gree226l`. |
| RouteIds | string[] | No | The unique ID of the CCN routing policy, such as `ccnr-f49l6u0z`. |
| Filters | Filter[] | No | Filter condition. `RouteIds` and `Filters` cannot be specified at the same time. |
| Offset | integer | No | Offset |
| Limit | integer | No | The returned quantity |
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 | The number of objects meeting the condition. |
| RouteSet | CcnRoute[] | The CCN routing policy object. |
| 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": …,
"RouteSet": …,
"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/vpc.
Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeCcnRoutes
Read-only. Creates nothing.