vpc · 2017-03-12

DescribeNatGatewayDestinationIpPortTranslationNatRules

POST

Query the array of objects of a NAT gateway's port forwarding rules.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeNatGatewayDestinationIpPortTranslationNatRules 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: DescribeNatGatewayDestinationIpPortTranslationNatRules' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
NatGatewayIds	string[]	—	NAT gateway ID.
Filters	Filter[]	—	Filters:
Offset	integer	—	Offset. Default value: 0.
Limit	integer	—	Number of returned results. Default value: 20. Maximum value: 100.

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
NatGatewayDestinationIpPortTranslationNatRuleSet	NatGatewayDestinationIpPortTranslationNatRule[]	The object array of port forwarding rules for the NAT gateway.
TotalCount	integer	The number of eligible object arrays of NAT port forwarding rules.
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": {
    "NatGatewayDestinationIpPortTranslationNatRuleSet": …,
    "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/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeNatGatewayDestinationIpPortTranslationNatRules

{}

Read-only. Creates nothing.

Recorded example response

{
  "TotalCount": 0,
  "NatGatewayDestinationIpPortTranslationNatRuleSet": []
}