Converge Studios
cfw — Cloud Firewall
cfw · 2019-09-04

DescribeNatFwInstance

POST

Get all NAT instances of a tenant.

Wire call

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

Request parameters

This action takes no parameters.

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.

FieldTypeDescription
NatinsLstNatFwInstance[]Instance array
RequestIdstringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.
Success
{
  "Response": {
    "NatinsLst": …,
    "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/cfw.
Request bodyvalid JSONPOST cfw.api3.convergecloud.com · DescribeNatFwInstance
Read-only. Creates nothing.
Recorded example response
{
  "NatinsLst": [],
  "RequestId": "762795de-4143-0fcf-1ff1-4561f3fb5980"
}