All Products
Search
Document Center

ENS:CreateNatGateway

Last Updated:Dec 25, 2024

Creates a network address translation (NAT) gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:CreateNatGatewaycreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The name of the NAT gateway. The name must be 1 to 128 characters in length. The name cannot start with http:// or https://.

name
EnsRegionIdstringYes

The ID of the Edge Node Service (ENS) node.

cn-suzhou-telecom
NetworkIdstringYes

The ID of the network.

n-5qj7ykuxmjn7k96l090sp****
VSwitchIdstringYes

The ID of the vSwitch.

vsw-5savh5ngxh8sbj14bu7n****
InstanceTypestringNo

The instance type of the NAT gateway. Set the value to enat.default.

enat.default

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NatGatewayIdstring

The ID of the NAT gateway.

nat-5t7nh1cfm6kxiszlttr38****

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****"
}

Error codes

HTTP status codeError codeError messageDescription
400ens.interface.error An error occurred while call the API. -
400Invalid%sThe specified parameter %s is invalid.-
400Missing%sYou must specify the parameter %s.-
400InvalidParameter.RegionNotSupportedThe specified EnsRegion does not support this operation.-
400InvalidParameter.VSwitchNotFoundThe specified VSwitch is not found. -
400InvalidParameter.VSwitchNotBelongToNetwork The specified VSwitch is not bound to the Network-
400InvalidParameter.NetworkNotFoundThe specified Network is not found. -
400InvalidParameter.NetworkNotSupportedThe specified Network does not support this operation. -
400QuotaExceed.NatGatewayThe maximum number of natGateway is reached. -
400SaleControl.VerificationFailedYou did not pass the salecontrol verification.Please contact the product.Failed to pass the sales constraint verification when you create the resource.
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-12The Error code has changed. The request parameters of the API has changedView Change Details