Configures Network Address Translation (NAT) rules for an instance. This operation is an asynchronous API operation. For more information about the configurations, see the API documentation of GetDeviceInternetPort.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ens:AddDeviceInternetPort | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance. You can specify the ID of the server or container. | i-5saiou41t6ude2ia56ri902ke |
| InternalIp | string | Yes | The internal IP address of the instance. | 10.0.0.50 |
| RegionId | string | Yes | The ID of the Edge Node Service (ENS) node. | cn-wuxi-5 |
| InternalPort | string | No | The internal port number. Specify this parameter in the following format: first port/last port. Separate multiple port number groups with commas (,). Example: 1026/2001,2005/2005. This parameter is required if you set NatType to DNAT. If you set NatType to SNAT, the value of this parameter is invalid. | 12022/12022 |
| NatType | string | Yes | The type of the NAT gateway. The value of this parameter is of the enumerated data type. Valid values:
| DNAT |
| ISP | string | No | The Internet service provider (ISP). If you leave this parameter empty, the system automatically allows a random ISP. Valid values:
| telecom |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "0F9185F6-B6FA-514C-9E05-FFD5F0D7D156",
"RuleIds": [
"['snat-5sbkmpicuke62r396o5csw1z2']"
]
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | NoPermission | Permission denied. |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|