すべてのプロダクト
Search
ドキュメントセンター

Virtual Private Cloud:UpdateIpv4GatewayAttribute

最終更新日:Apr 27, 2026

IPv4 ゲートウェイの説明または名前を変更します。

操作説明

指定された期間内に、UpdateIpv4GatewayAttribute 操作を繰り返し呼び出して IPv4 ゲートウェイの名前または説明を変更することはできません。

今すぐお試しください

この 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:UpdateIpv4GatewayAttribute

update

*Ipv4Gateway

acs:vpc:{#regionId}:{#accountId}:ipv4gateway/{#ipv4gatewayId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Ipv4GatewayId

string

必須

名前または説明を変更する IPv4 ゲートウェイの ID です。

ipv4gw-5tsnc6s4ogsedtp3k****

Ipv4GatewayName

string

任意

IPv4 ゲートウェイの新しい名前です。

newname

ClientToken

string

任意

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

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

説明

このパラメーターを指定しない場合、システムは自動的に リクエスト IDクライアントトークン として使用します。リクエスト ID は各リクエストごとに異なる可能性があります。

123e4567-e89b-12d3-a456-426655440000

DryRun

boolean

任意

実際のリクエストを実行せずにドライランのみを実行するかどうかを指定します。有効値:

  • true:ドライランのみを実行します。システムは、パラメーター値の不足、リクエスト構文の誤り、サービス制限など、潜在的な問題についてリクエストをチェックします。ドライランに失敗した場合は、エラーメッセージが返されます。ドライランに成功した場合は、エラーコード DryRunOperation が返されます。

  • false (デフォルト):ドライランを実行し、実際のリクエストも実行します。ドライランに成功した場合は、HTTP ステータスコード 2xx が返され、操作が実行されます。

false

Ipv4GatewayDescription

string

任意

IPv4 ゲートウェイの新しい説明です。

new

RegionId

string

必須

名前または説明を変更する IPv4 ゲートウェイのリージョン ID です。

最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出してください。

ap-southeast-6

RegionId

string

必須

名前または説明を変更する IPv4 ゲートウェイのリージョン ID です。

最新のリージョンリストを照会するには、DescribeRegions 操作を呼び出してください。

ap-southeast-6

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID です。

671CEB03-C98D-5916-950C-C55B0BD06621

成功レスポンス

JSONJSON

{
  "RequestId": "671CEB03-C98D-5916-950C-C55B0BD06621"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 ResourceNotFound.Ipv4Gateway The specified resource ipv4Gateway is not found.
400 IncorrectStatus.Ipv4Gateway The status of %s [%s] is incorrect.

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

変更履歴

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