CreateNatIp - NAT Gateway - Alibaba Cloud ドキュメントセンター

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 アドレスの同時作成をサポートしていません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:CreateNatIp

create

*NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	NAT IP アドレスが属する VPC NAT ゲートウェイインスタンスのリージョン ID。 DescribeRegions を呼び出してリージョン ID をクエリできます。	eu-central-1
NatGatewayId	string	必須	NAT IP アドレスが属する VPC NAT ゲートウェイのインスタンス ID。	ngw-gw8v16wgvtq26vh59****
NatIpName	string	任意	NAT IP アドレスの名前。名前は 2～128 文字で、英字または中国語文字で始まる必要があります。数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。`http://` または `https://` で始めることはできません。	newnatip
NatIpDescription	string	任意	NAT IP アドレスの説明。説明は 2～256 文字で、英字または中国語文字で始まる必要があります。`http://` または `https://` で始めることはできません。	test
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ドライランを実行します。システムは AccessKey ペア、Resource Access Management (RAM) ユーザーの権限付与、および必須パラメーターを確認します。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): 法線リクエストを送信します。リクエストがドライランに成功した場合、2xx HTTP 状態コードが返され、NAT IP アドレスが作成されます。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。ClientToken の値には ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatIpCidr	string	必須	NAT IP アドレスの作成元となる NAT CIDR ブロック。	192.168.0.0/24
NatIp	string	任意	作成する NAT IP アドレス。このパラメーターを指定しない場合、システムは NAT CIDR ブロックから IP アドレスをランダムに割り当てます。	192.168.0.34
RegionId	string	必須	NAT IP アドレスが属する VPC NAT ゲートウェイインスタンスのリージョン ID。 DescribeRegions を呼び出してリージョン ID をクエリできます。	eu-central-1
Ipv4Prefix	string	任意	作成する IP プレフィックス CIDR ブロック。 IP プレフィックス CIDR ブロックは、NAT ゲートウェイが存在する vSwitch の予約済み CIDR ブロック内である必要があり、予約済み CIDR ブロックは使用されていない必要があります。プレフィックスマスクは /28 である必要があります。	192.168.0.0/28
Ipv4PrefixCount	integer	任意	自動的に割り当てる IP プレフィックスの数。 IP プレフィックスは、NAT ゲートウェイが存在する vSwitch の未割り当ての予約済み CIDR ブロックからランダムに割り当てられます。有効な値: 1～10。説明この操作を呼び出す際、Ipv4Prefix と Ipv4PrefixCount を同時に指定することはできません。	1

レスポンスフィールド

フィールド	型	説明	例
	object	作成された NAT IP アドレス。
NatIp	string	作成された NAT IP アドレス。	192.168.0.34
RequestId	string	リクエスト ID。	E9AD97A0-5338-43F8-8A80-5E274CCBA11B
NatIpId	string	作成された NAT IP アドレスのインスタンス ID。	vpcnatip-gw8y7q3cpk3fggs8****
Ipv4Prefix	string	レガシ操作によって返された IPv4 プレフィックス。このパラメーターは非推奨です。	""
NatIps	array<object>	NAT IP アドレスの作成後に返される NAT IP アドレス情報。IPv4 プレフィックスを使用して NAT IP アドレスを作成する場合、すべての NAT IP アドレス情報が返されます。単一の NAT IP アドレスを作成する場合、このパラメーターを使用して NAT IP アドレス情報を取得することを推奨します。
	object	IPv4 プレフィックスを使用して作成された NAT IP アドレスのリスト。
NatIp	string	IPv4 プレフィックスを使用して作成された NAT IP アドレスリスト内の NAT IP アドレス。	192.168.2.128
NatIpId	string	IPv4 プレフィックスを使用して作成された NAT IP アドレスリスト内の NAT IP アドレス ID。	vpcnatip-xxxxxxxx
Ipv4Prefix	string	IPv4 プレフィックスを使用して作成された NAT IP アドレスリスト内の IPv4 プレフィックス。	192.168.1.128/28

例

成功レスポンス

JSONJSON

{
  "NatIp": "192.168.0.34",
  "RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B",
  "NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****",
  "Ipv4Prefix": "\"\"",
  "NatIps": [
    {
      "NatIp": "192.168.2.128",
      "NatIpId": "vpcnatip-xxxxxxxx",
      "Ipv4Prefix": "192.168.1.128/28"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Mismatch.NatIpAndNatIpCidr	The %s and %s are mismatched.
400	ResourceNotFound.NatGateway	The specified resource of %s is not found.
400	ResourceNotFound.NatIpCidr	The specified resource of %s is not found.
400	IncorrectStatus.NatGateway	%The status of %s [%s] is incorrect.
400	QuotaExceeded.NatIp	The quota of %s is exceeded, usage %s/%s.
400	ResourceNotEnough.SwitchAvailableIps	The available private Ip number is not enough in your subnet.
400	ResourceNotEnough.NatIp	The specified resource of NatIp is not enough.
400	ResourceAlreadyExist.NatIp	The specified resource of NatIp has already exist.
400	Mismatch.Ipv4PrefixAndNatIpCidr	The %s and %s are mismatched.
400	Mismatch.Ipv4PrefixAndCidrReservations	The %s and %s are mismatched.
400	ResourceAlreadyAssociated.Ipv4Prefix	%s is already associated.
400	ResourceNotEnough.Ipv4Prefix	The resource of %s is not enough.
400	ResourceNotFound.Ipv4Prefix	The resource of s% is not found.
400	ResourceAlreadyAssociated.NatIp	The resource of %s was already associated.
400	ResourceNotFound.NatIp	The specified resource of %s is not found.
400	IllegalParam.Ipv4Prefix	The param of %s is illegal, must be /28 network segment.
400	ResourceAlreadyExist.Ipv4Prefix	The specified resource of %s is already exist.
400	QuotaExceeded.Ipv4Prefix	The quota of %s is exceeded, usage %s/%s.
400	OperationFailed.InstanceNotSupport	natgateway not support ipv4prefix.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。