NAT IPアドレスの名前と説明を変更します。

使用上の注意

ModifyNatIpAttributeを繰り返し呼び出して、指定された期間内にNAT IPアドレスの名前と説明を変更することはできません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
RegionId String 必須 eu-central-1

変更するNAT IPアドレスが属するNATゲートウェイのリージョンID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

NatIpId String 必須 vpcnatip-gw8e1n11f44wpg ****

変更するNAT IPアドレスのID。

NatIpName String 必須 newname

変更するNAT IPアドレスの名前。

名前は2 ~ 128文字で、英数字、ピリオド (.) 、アンダースコア (_) 、ハイフン (-) を使用できます。 先頭は文字である必要があります。 先頭文字列を http://または https:// にすることはできません。

NatIpDescription String 必須 test

変更するNAT IPアドレスの説明。

説明の長さは 2～256 文字である必要があります。 名前は英字で始まる必要があります。先頭文字列は http:// または https:// にすることはできません。

DryRun Boolean いいえ false

このリクエストのみを事前チェックするかどうかを指定します。 有効な値：

  • true: 事前チェックリクエストを送信しますが、NAT IPアドレスの名前や説明は変更しません。 システムは、AccessKeyペア、Resource Access Management (RAM) ユーザー権限、および必要なパラメーターをチェックします。 リクエストが事前チェックに失敗した場合、エラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false (デフォルト): リクエストを送信します。 リクエストが事前チェックに合格すると、2xx HTTPステータスコードが返され、NAT IPアドレスの名前と説明が変更されます。
ClientToken String 任意 5A2CFF0E-5718-45B5-9D4D-70B3FF3898

リクエストのべき等性を保証するために使用されるクライアントトークン。

クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 クライアントトークンにはASCII文字のみを含めることができます。

説明 このパラメーターを設定しない場合、ClientTokenはRequestIdの値に設定されます。 各APIリクエストのRequestIdの値は異なる場合があります。
操作 String 必須 ModifyNatIpAttribute

実行する操作です。 値をModifyNatIpAttributeに設定します。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 6CC9456C-2E29-452A-9180-B6926E51B5CA

リクエストの ID です。

例

リクエストの例

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatIpId=vpcnatip-gw8e1n11f44wpg ****
&NatIpName=newname
&NatIpDescription=テスト
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&アクション=ModifyNatIpAttribute
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyNatIpAttributeResponse>
    <RequestId>6CC9456C-2E29-452A-9180-B6926E51B5CA</RequestId>
</ModifyNatIpAttributeResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6CC9456C-2E29-452A-9180-B6926E51B5CA"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
404 InvalidRegionId.NotFound 指定された RegionId はレコードに存在しません。 指定されたリージョンIDが存在しない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。