ec2.nat-gateways.get

A NAT gateway: state, egress address, address in the VPC

GET /ec2/api/nat-gateways/{id}IAM ec2:DescribeNatGatewaysRead

Request syntax

GET /ec2/api/nat-gateways/{id}

Path parameters

  • idRequired

    string

    Constraints: /^nat-[0-9a-f]{6,32}$/

Response

200: `data` is the NAT gateway: id, vpcId, regionId, status, publicAddress (the egress address), privateAddress, routeInstalled, reconcileError, timestamps.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ec2:DescribeNatGateways on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ec2 nat-gateways get id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_nat-gateways_get.