cfw · 2019-09-04

DescribeNatFwInstancesInfo

POST

Get all NAT instances and instance card information 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/DescribeNatFwInstancesInfo 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: DescribeNatFwInstancesInfo' \
  -H 'X-TC-Version: 2019-09-04' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
Filter	NatFwFilter[]	—	Gets filtering fields of instance list
Offset	integer	—	Page number
Limit	integer	—	Page length

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
NatinsLst	NatInstanceInfo[]	Instance card info array
Total	integer	Number of NAT firewalls
RequestId	string	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Success

{
  "Response": {
    "NatinsLst": …,
    "Total": …,
    "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.

SecretIdSecretKey

Request bodyvalid JSONPOST cfw.api3.convergecloud.com · DescribeNatFwInstancesInfo

{}

Read-only. Creates nothing.

Recorded example response

{
  "NatinsLst": [],
  "RequestId": "40fdcaf8-df91-db86-0a66-c3f111545c38",
  "Total": 0
}