為VPC NAT網關實例創建NAT IP地址。
接口說明
CreateNatIp 接口屬于異步接口，即系統會先返回一個 NAT IP 地址，但該 NAT IP 地址并未創建完成，系統后臺的創建任務仍在進行。您可以調用 ListNatIps 查詢 NAT IP 地址創建的狀態：
-
當 NAT IP 地址處于 Creating 狀態時，表示 NAT IP 地址正在創建中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
-
當 NAT IP 地址處于 Available 狀態時，表示 NAT IP 地址創建完成。
CreateNatIp 接口在同一個 NAT 網關內不支持并發創建 NAT IP 地址。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要創建 NAT IP 地址所屬 NAT 網關實例的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | eu-central-1 |
| NatGatewayId | string | 是 | NAT IP 地址所屬的 VPC NAT 網關實例 ID。 | ngw-gw8v16wgvtq26vh59**** |
| NatIpName | string | 是 | 創建的 NAT IP 地址的名稱。 長度為 2~128 個字符，必須以字母或中文開頭，可包含數字、半角句號（.）、下劃線（_）和短劃線（-）。但不能以 | newnatip |
| NatIpDescription | string | 是 | 創建的 NAT IP 地址的描述信息。 長度為 2~256 個字符，必須以字母或中文開頭，但不能以 | test |
| DryRun | boolean | 否 | 是否只預檢此次請求，取值：
| false |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| NatIpCidr | string | 是 | 創建 NAT IP 地址的地址段。 | 192.168.0.0/24 |
| NatIp | string | 否 | 創建的 NAT IP 地址。 如果您不指定該 IP 地址，系統會在您的 NAT IP 地址段中隨機分配一個 IP 地址。 | 192.168.0.34 |
返回參數
示例
正常返回示例
JSON格式
{
"NatIp": "192.168.0.34",
"RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B",
"NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Mismatch.NatIpAndNatIpCidr | The %s and %s are mismatched. | %s和%s不匹配。 |
| 400 | ResourceNotFound.NatGateway | The specified resource of %s is not found. | - |
| 400 | ResourceNotFound.NatIpCidr | The specified resource of %s is not found. | 找不到指定的%s資源。 |
| 400 | IncorrectStatus.NatGateway | %The status of %s [%s] is incorrect. | nat網關狀態不正確 |
| 400 | QuotaExceeded.NatIp | The quota of %s is exceeded, usage %s/%s. | - |
| 400 | ResourceAlreadyExist.NatIp | The specified resource of %s is already exist. | - |
| 400 | ResourceNotEnough.SwitchAvailableIps | The available private Ip number is not enough in your subnet. | 子網中可用的私網IP不足。 |
| 400 | ResourceNotEnough.NatIp | The specified resource of NatIp is not enough. | Insufficient IP addresses in the specified CIDR block. |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-23 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-03 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-06-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |