UpdateIpv4GatewayAttribute - 修改IPv4網關的名稱或描述資訊 - Virtual Private Cloud

介面說明

UpdateIpv4GatewayAttribute 介面不支援並發修改同一個 IPv4 網關的名稱或描述資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:UpdateIpv4GatewayAttribute

update

*Ipv4Gateway

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

無

請求參數

名稱	類型	必填	描述	樣本值
Ipv4GatewayId	string	是	要修改名稱或描述資訊的 IPv4 網關的執行個體 ID。	ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayName	string	否	要修改的 IPv4 網關執行個體的名稱，即修改後的名稱。	newname
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會修改 IPv4 網關的名稱或描述資訊。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接修改 IPv4 網關的名稱或描述資訊。	false
Ipv4GatewayDescription	string	否	要修改的 IPv4 網關執行個體的描述資訊，即修改後的描述資訊。	new
RegionId	string	是	要修改名稱或描述資訊的 IPv4 網關執行個體所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	ap-southeast-6
RegionId	string	是	要修改名稱或描述資訊的 IPv4 網關執行個體所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	ap-southeast-6

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	請求 ID。	671CEB03-C98D-5916-950C-C55B0BD06621

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ResourceNotFound.Ipv4Gateway	The specified resource ipv4Gateway is not found.	未找到指定的Ipv4網關，無法刪除
400	IncorrectStatus.Ipv4Gateway	The status of %s [%s] is incorrect.	指定的Ipv4Gateway處於非穩態，請稍後重試

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

變更歷史

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