全部產品
Search
文件中心

Virtual Private Cloud:UpdateVpcGatewayEndpointAttribute - 修改網關終端節點的配置資訊

更新時間:Apr 27, 2026

調用UpdateVpcGatewayEndpointAttribute介面修改網關終端節點的配置資訊。

介面說明

  • UpdateVpcGatewayEndpointAttribute 介面屬於非同步介面,即系統會先返回一個 RequestId,但該網關終端節點的配置資訊並未修改完成,系統背景修改任務仍在進行。您可以調用 GetVpcGatewayEndpointAttribute 查詢網關終端節點的狀態。

    • 當網關終端節點處於 Updating 狀態時,表示正在修改中。

    • 當網關終端節點處於 Created 狀態時,表示修改完成。

  • UpdateVpcGatewayEndpointAttribute 介面不支援並發修改同一個網關終端節點。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

EndpointId

string

需要修改資訊的網關終端節點的執行個體 ID。

vpce-bp1w1dmdqjpwul0v3****

EndpointName

string

網關終端節點需要被修改的名稱。

名稱的長度在 1~128 個字元之間。

update

EndpointDescription

string

網關終端節點需要被修改的描述資訊。

描述資訊的長度在 1~255 個字元之間。

updateendpoint

PolicyDocument

string

雲端服務的存取原則。

關於存取原則的文法和結構,請參見權限原則文法和結構

{ "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }

ClientToken

string

用戶端 Token,用於保證請求的等冪性。

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。

0c593ea1-3bea-11e9-b96b-88e9fe637760

DryRun

boolean

是否只預檢此次請求,取值:

  • true:發送檢查請求,不會修改網關終端節點的資訊。檢查項包括 AccessKey 是否有效、RAM 使用者的授權情況和是否填寫了必需參數。如果檢查不通過,則返回對應錯誤。如果檢查通過,會返回錯誤碼DryRunOperation

  • false(預設值):發送正常請求,通過檢查後返回 2xx HTTP 狀態代碼並修改網關終端節點的資訊。

false

RegionId

string

需要修改資訊的網關終端節點所在的地區 ID。

您可以通過調用 DescribeRegions 介面擷取地區 ID。

cn-hangzhou

返回參數

名稱

類型

描述

樣本值

object

返回資訊。

RequestId

string

請求 ID。

E9654534-5A38-5545-813F-0403D49042FB

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E9654534-5A38-5545-813F-0403D49042FB"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 OperationFailed.ConcurrentOperation The operation is failed because of concurrent operation.
400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
400 ResourceNotFound.GatewayEndpoint The specified resource gateway endpoint is not found. 指定的GatewayEndpoint不存在
400 IllegalParam.PolicyDocument The param of PolicyDocument is illegal.
400 IllegalParam.GatewayEndpointName The param of GatewayEndpointName is illegal.
400 IllegalParam.GatewayEndpointDescription The param of GatewayEndpointDescription is illegal.
400 SystemBusy System is busy, please try again later.
400 Forbbiden User not authorized to operate on the specified resource.
400 InvalidRegionId.NotFound The regionId provided does not exist in our records. 指定的RegionId不存在。請檢查該參數是否正確。
400 OperationDenied.PolicyDocument The gatewayEndpoint does not support policy.
400 IncorrectStatus.GatewayEndpoint The status of GatewayEndpoint [%s] is incorrect.
400 InvalidPolicy.WrongFormat Invalid input policy format. 輸入策略資訊格式錯誤。

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

變更歷史

更多資訊,參考變更詳情