Updated on 2023-04-19 GMT+08:00

Creating a Private NAT Gateway

Function

This API is used to create a private NAT gateway.

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

URI

POST /v3/{project_id}/private-nat/gateways

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It is a response to the API used to obtain a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value.

Minimum: 1

Maximum: 10240

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

gateway

Yes

CreatePrivateNatOption object

Specifies the request body for creating the private NAT gateway.

Table 4 CreatePrivateNatOption

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the private NAT gateway name. Only digits, letters, underscores (_), and hyphens (-) are allowed.

Minimum: 1

Maximum: 64

description

No

String

Provides supplementary information about the private NAT gateway.

Minimum: 0

Maximum: 255

spec

No

String

Specifies the private NAT gateway type. The value can be: Small Medium Large Extra-large

Default: Small

Enumeration values:

  • Small

  • Medium

  • Large

  • Extra-large

downlink_vpcs

Yes

Array of DownlinkVpcOption objects

Specifies the VPC where the private NAT gateway resides.

tags

No

Array of Tag objects

Specifies the tag list.

enterprise_project_id

No

String

Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created. For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

Default: 0

Minimum: 1

Maximum: 36

Table 5 DownlinkVpcOption

Parameter

Mandatory

Type

Description

virsubnet_id

Yes

String

Specifies the ID of the subnet where the private NAT gateway resides.

Minimum: 36

Maximum: 36

Table 6 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

Minimum: 1

Maximum: 128

value

Yes

String

Specifies the tag value.

Minimum: 0

Maximum: 255

Response Parameters

Status code: 201

Table 7 Response body parameters

Parameter

Type

Description

gateway

PrivateNat object

Specifies the response body for the private NAT gateway.

request_id

String

Specifies the request ID.

Minimum: 1

Maximum: 36

Table 8 PrivateNat

Parameter

Type

Description

id

String

Specifies the private NAT gateway ID.

Minimum: 36

Maximum: 36

project_id

String

Specifies the project ID.

Minimum: 32

Maximum: 32

name

String

Specifies the private NAT gateway name.

Minimum: 1

Maximum: 64

description

String

Provides supplementary information about the private NAT gateway.

Minimum: 0

Maximum: 255

spec

String

Specifies the private NAT gateway type. The value can be: Small Medium Large Extra-large

Default: Small

Enumeration values:

  • Small

  • Medium

  • Large

  • Extra-large

status

String

Specifies the private NAT gateway status. The value can be: ACTIVE: The private NAT gateway is running properly. FROZEN: The private NAT gateway is frozen.

Enumeration values:

  • ACTIVE

  • FROZEN

created_at

String

Specifies when the private NAT gateway was created. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format.

updated_at

String

Specifies when the private NAT gateway was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format.

downlink_vpcs

Array of DownlinkVpc objects

Specifies the VPC where the private NAT gateway resides.

tags

Array of Tag objects

Specifies the list of tags.

enterprise_project_id

String

Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created.

Minimum: 1

Maximum: 36

Table 9 DownlinkVpc

Parameter

Type

Description

vpc_id

String

Specifies the ID of the VPC where the private NAT gateway resides.

Minimum: 36

Maximum: 36

virsubnet_id

String

Specifies the ID of the subnet where the private NAT gateway resides.

Minimum: 36

Maximum: 36

Table 10 Tag

Parameter

Type

Description

key

String

Specifies the tag key.

Minimum: 1

Maximum: 128

value

String

Specifies the tag value.

Minimum: 0

Maximum: 255

Example Requests

This API is used to create a private NAT gateway.

POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways

{
  "gateway" : {
    "name" : "private-nat-gateway-name",
    "description" : "private-nat-gateway-description",
    "spec" : "Small",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "downlink_vpcs" : [ {
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ],
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }
}

Example Responses

Status code: 201

Private NAT gateway created.

{
  "request_id" : "9882046a9b96f1405472e36d797e33dc",
  "gateway" : {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "private-nat-gateway-name",
    "description" : "private-nat-gateway-description",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T08:47:13",
    "updated_at" : "2019-04-22T08:47:13",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  }
}

Status Codes

Status Code

Description

201

Private NAT gateway created.

Error Codes

See Error Codes.