NATゲートウェイの名前と説明を変更します。

使用上の注意

このAPIを呼び出して、インターネットNATゲートウェイまたは仮想プライベートクラウド (VPC) NATゲートウェイを照会できます。 このトピックのNATゲートウェイという用語は、両方のタイプのNATゲートウェイを指します。

デバッグ

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

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 ModifyNatGatewayAttribute

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

RegionId String 必須 cn-hangzhou

NATゲートウェイのリージョンID。

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

NatGatewayId String 必須 ngw-2ze0dcn4mq31qx2jc ****

NAT ゲートウェイの ID 。

名前 String 任意 nat123

NATゲートウェイの名前。

名前は1 ~ 128文字で、http:// またはhttps:// で始めることはできません。

説明　 String 任意 説明　

NATゲートウェイの説明。

説明の長さは1 ~ 128文字である必要があり、先頭文字をhttp:// またはhttps:// にすることはできません。

IcmpReplyEnabled Boolean いいえ false

インターネット制御メッセージプロトコル (ICMP) 非検索機能を有効にするかどうかを指定します。 有効な値：

  • false: ICMP非検索機能を無効にします。 デフォルト値です。
  • true: ICMP非検索機能を有効にします。
EipBindMode String 任意 NAT

NATゲートウェイがelastic IPアドレス (EIP) に関連付けられているモード。 このパラメーターは空のままにできます。 このパラメーターに値を指定する場合は、値をNATに設定します。これは、NATゲートウェイがNATモードのEIPに関連付けられていることを示します。

説明
  • NATゲートウェイの作成時にEipBindModeパラメーターがMULTI_BINDEDに設定されている場合、このパラメーターの値をMULTI_BINDEDからNATに変更できます。 NATゲートウェイの作成時にEipBindModeパラメーターがNATに設定されている場合、このパラメーターの値をNATからMULTI_BINDEDに変更することはできません。 MULTI_BINDEDの詳細については、「CreateNatGateway」をご参照ください。
  • NATゲートウェイがEIPに関連付けられているモードが変更されている場合、数秒続く一時的な接続が発生する可能性があります。 NATゲートウェイが関連付けられているEIPの数が増えると、一時的な接続はより長く続きます。 モードを変更できるのは、最大5つのEIPに関連付けられているNATゲートウェイのみです。 オフピーク時にモードを変更することを推奨します。
  • モードがNATに変更された後、インターネットNATゲートウェイはIPv4ゲートウェイと互換性があります。 ただし、EIPをNATゲートウェイに関連付けると、EIPはNATゲートウェイのvSwitchで1つのプライベートIPアドレスを占有します。 vSwitchに十分なプライベートIPアドレスがあることを確認します。 それ以外の場合、EIPはNATゲートウェイに関連付けられません。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String AB5F62CF-2B60-4458-A756-42C9DFE108D1

リクエストの ID です。

例

リクエストの例

http(s):// [エンドポイント]/?Action=ModifyNatGatewayAttribute
&RegionId=cn-hangzhou
&NatGatewayId=ngw-2ze0dcn4mq31qx2jc ****
&名前=nat123
&Description=説明
&IcmpReplyEnabled=false
&EipBindMode=NAT
&共通リクエストパラメータ

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

XML 形式 

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

<ModifyNatGatewayAttributeResponse>
    <RequestId>AB5F62CF-2B60-4458-A756-42C9DFE108D1</RequestId>
</ModifyNatGatewayAttributeResponse>

JSON 形式 

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

{
  "RequestId" : "AB5F62CF-2B60-4458-A756-42C9DFE108D1"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 UnsupportedFeature.PrivateLinkMode % sの機能はサポートされていません。 逆アクセス機能がサポートされていない場合に返されるエラーメッセージ。
400 IncorrectStatus.NATGW NATGWステータスは無効です。 NAT gatewayのステータスが異常な場合に返されるエラーメッセージ。
400 ExclusiveParam.% sAnd % s % sと % sのパラメーターは相互に排他的です。 % sパラメーターと % sパラメーターが相互に排他的である場合に返されるエラーメッセージ。
400 IncorrectStatus.NatGateway natgatewayのステータスが正しくありません。 NAT gatewayのステータスが異常な場合に返されるエラーメッセージ。
400 DependencyViolation.PrivateLinkMode 指定された % sのリソースは % sに依存するため、操作を完了できません。 操作が完了していない場合に返されるエラーメッセージ。 % sリソースは % sに依存します。
400 UnsupportedFeature.IcmpReplyEnabled IcmpReplyEnabledの機能はサポートされていません。 IcmpReplyEnabledパラメーターの値を変更できない場合に返されるエラーメッセージ。
400 InvalidParams.NotNull パラメーターはnull、name、description、icmpReplyEnabledであってはなりません。 Name、Description、およびIcmpReplyEnabledパラメーターが設定されていない場合に返されるエラーメッセージ。 少なくとも1つのパラメーターを設定します。
400 InvalidParameter.Name.Malformed 指定されたNameは無効です。 指定された名前の形式が無効な場合に返されるエラーメッセージ。 有効な形式で名前を指定します。
400 InvalidParameter.Description.Malformed 指定されたDescriptionは無効です。 指定された説明が無効な場合に表示されるエラーメッセージ。
400 UnsupportedFeature。IndirectConvertForVpcNat VPC NATゲートウェイは、EIPボンドタイプの変更をサポートしていません。 VPC NATゲートウェイのEipBindModeパラメーターの値を変更できない場合に返されるエラーメッセージ。
400 UnsupportedFeature。NormalNatModifyEipBindMode 通常のNAT gatewayは、EIPボンドタイプの変更をサポートしていません。 標準NATゲートウェイのEipBindModeパラメーターの値を変更できない場合に返されるエラーメッセージ。
400 OperationDenied.EipBondTypeIsAlreadyNAT EIPボンドタイプは既にNATタイプです。 EipBindModeパラメーターがNATに設定されている場合に返されるエラーメッセージ。
400 UnsupportedFeature。IndirectConvertForFwNat セキュリティ保護が有効なNATゲートウェイは、EIPボンドタイプの変更をサポートしていません。 セキュリティ保護機能が有効になっているインターネットNATゲートウェイでEipBindModeパラメーターの値を変更できない場合に返されるエラーメッセージ。
400 QuotaExceeded.EipNumForModifyEipBondType % sのクォータを超えています。binded: % s, quota: % s. NAT gatewayに関連付けられているEIPの数が上限を超えた場合に返されるエラーメッセージ。
400 ResourceNotEnough.SwitchAvailableIps 利用可能なプライベートIp番号はサブネットでは不十分です。 vSwitchのプライベートIPアドレスが不足している場合に返されるエラーメッセージ。
400 UnsupportedFeature.VpcNatSecurityProtectionEnabled VPC NATゲートウェイは、セキュリティ保護を有効にするためにサポートされていません。 VPC NATゲートウェイでセキュリティ保護機能を有効にできない場合に返されるエラーメッセージ。
400 OperationDenied.NatGatewayStatusInvalid NAT gatewayのステータスが無効です。 NATゲートウェイのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
400 OperationDenied.EipStatusInvalid NATゲートウェイのEIPステータスが無効です。 NATゲートウェイに関連付けられているEIPのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
400 OperationDenied.SnatEntryStatusInvalid NATゲートウェイのSNATエントリのステータスが無効です。 NATゲートウェイのSNATエントリのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
400 OperationDenied.DnatEntryStatusInvalid NATゲートウェイのDNATエントリのステータスが無効です。 NATゲートウェイの宛先ネットワークアドレス変換 (DNAT) エントリのステータスが操作をサポートしていない場合に返されるエラーメッセージ。
400 UnsupportedFeature。MutilBindedTypeNatEnableFw NAT with Mutil-Binded Eipバインドタイプは、有効ファイアウォールをサポートしていません。 EIPがMULTI_BINDEDモードで関連付けられているNATゲートウェイに対してファイアウォールを有効にできない場合に返されるエラーメッセージ。
403 Forbidden.ModifyEipBondType EIPボンドタイプの変更で認証に失敗しました。 EipBindModeパラメーターの値を変更できない場合に返されるエラーメッセージ。
404 InvalidRegionId.NotFound 指定された RegionId はレコードに存在しません。 指定されたリージョンIDが存在しない場合に返されるエラーメッセージ。
404 InvalidNatGatewayId.NotFound 指定された NatGatewayId はレコードに存在しません。 指定されたNATゲートウェイIDが存在しない場合に返されるエラーメッセージ。 NatGatewayIdパラメーターの値が有効かどうかを確認します。

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