ModifyCustomerGatewayAttribute - VPN Gateway

介面說明

呼叫 ModifyCustomerGatewayAttribute 介面時，如果參數 AuthKey 不為空時，該介面為非同步介面，即系統先返回使用者閘道的資訊，但該使用者閘道的配置尚未修改成功，系統後台的修改任務仍在進行。您可以呼叫 DescribeVpnGateway 查詢使用者閘道的配置的修改狀態：
- 當 VPN 閘道執行個體處於 updating 狀態時，表示使用者閘道的配置正在修改中。
- 當 VPN 閘道執行個體處於 active 狀態時，表示使用者閘道的配置修改成功。
呼叫 ModifyCustomerGatewayAttribute 介面時，如果參數 AuthKey 為空時，該介面為同步介面。
ModifyCustomerGatewayAttribute 介面不支援並發修改同一個使用者閘道的配置。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:ModifyCustomerGatewayAttribute

update

*CustomerGateway

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	使用者閘道所屬的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-shanghai
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	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****

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。