すべてのプロダクト
Search

このプロダクト

    VPN Gateway:ModifyCustomerGatewayAttribute

    ドキュメントセンター

    VPN Gateway:ModifyCustomerGatewayAttribute

    最終更新日:Jun 19, 2026

    ModifyCustomerGatewayAttribute 操作を呼び出して、カスタマーゲートウェイの構成を変更します。

    操作説明

    • ModifyCustomerGatewayAttribute 操作を呼び出す際、AuthKey パラメーターが空でない場合、この操作は非同期です。システムはまずカスタマーゲートウェイ情報を返しますが、変更タスクがまだバックグラウンドで実行中のため、構成はまだ変更されていません。 DescribeVpnGateway を呼び出して、カスタマーゲートウェイ構成の変更ステータスをクエリできます:

      • VPN ゲートウェイインスタンスが updating 状態の場合、カスタマーゲートウェイ構成は変更中です。

      • VPN ゲートウェイインスタンスが アクティブな 状態の場合、カスタマーゲートウェイ構成は変更済みです。

    • ModifyCustomerGatewayAttribute 操作を呼び出す際、AuthKey パラメーターが空の場合、この操作は同期です。

    • ModifyCustomerGatewayAttribute 操作は、同じカスタマーゲートウェイの構成に対する同時変更をサポートしていません。

    今すぐお試しください

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

    update

    *CustomerGateway

    acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    カスタマーゲートウェイのリージョン ID。

    DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。

    cn-shanghai
    ClientToken

    string

    任意

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

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

    説明

    このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API の呼び出しごとに異なる場合があります。

    02fb3da4-130e-11e9-8e44****
    CustomerGatewayId

    string

    必須

    カスタマーゲートウェイのインスタンス ID。

    cgw-bp1pvpl9r9adju6l5****
    Name

    string

    任意

    カスタマーゲートウェイの名前。

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

    nametest
    Description

    string

    任意

    カスタマーゲートウェイの説明。

    説明は 1～100 文字で、http:// または https:// で始めることはできません。

    desctest
    AuthKey

    string

    任意

    オンプレミスデータセンターのゲートウェイデバイスのボーダーゲートウェイプロトコル (BGP) ルーティングプロトコルの認証キー。

    キーは 1～64 文字で、ASCII 文字のみを含めることができます。スペース、中国語文字、または半角疑問符 (?) を含めることはできません。

    AuthKey****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエスト ID。

    8AA5CE21-2E6A-4530-BDF5-F055849476E6
    IpAddress

    string

    オンプレミスデータセンターのゲートウェイデバイスのパブリック IP アドレス。

    139.32.XX.XX
    Description

    string

    カスタマーゲートウェイの説明。

    desctest
    CustomerGatewayId

    string

    カスタマーゲートウェイのインスタンス ID。

    cgw-bp1pvpl9r9adju6l5****
    CreateTime

    integer

    カスタマーゲートウェイが作成されたタイムスタンプ。

    1492747187000
    Name

    string

    カスタマーゲートウェイの名前。

    nametest
    ResourceGroupId

    string

    カスタマーゲートウェイが属するリソースグループの ID。

    ListResourceGroups 操作を呼び出して、リソースグループ情報をクエリできます。

    rg-acfmzs372yg****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "8AA5CE21-2E6A-4530-BDF5-F055849476E6",
  "IpAddress": "139.32.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
  "CreateTime": 1492747187000,
  "Name": "nametest",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidName The name is not valid
    400 InvalidDescription The description is not valid
    400 OperationDenied.MissingAsn The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.
    400 InvalidAuthkey.Malformed The specified BGP authentication key (%s) is malformed.
    400 OperationDenied.VpnFinancialLocked The associated VPN gateway is financially locked. You cannot update the attributes of the customer gateway.
    400 OperationDenied.VpnConfiguring The associated VPN gateway is being configured. You cannot update the attributes of the customer gateway.
    403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user.
    403 Forbidden User not authorized to operate on the specified resource.
    404 InvalidCustomerGatewayInstanceId.NotFound The specified customer gateway instance id does not exist.

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

    変更履歴

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