全部產品
Search
文件中心

Cloud Enterprise Network:UpdateTransitRouter - 修改轉寄路由器執行個體資訊

更新時間:Aug 07, 2025

調用UpdateTransitRouter介面修改轉寄路由器執行個體的名稱和描述資訊。

介面說明

UpdateTransitRouter 介面屬於非同步介面,即系統會先返回一個 RequestId,但轉寄路由器執行個體的修改並未完成,系統背景修改任務仍在進行。您可以調用 ListTransitRouters 介面查詢轉寄路由器執行個體的狀態。

  • 當轉寄路由器執行個體處於 Modifying 狀態時,表示轉寄路由器執行個體正在修改中,在該狀態下,您只能對轉寄路由器執行個體執行查詢操作,不能執行其他動作。

  • 當轉寄路由器執行個體處於 Active 狀態時,表示轉寄路由器執行個體修改完成。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:UpdateTransitRouter

update

*TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

請求參數

名稱

類型

必填

描述

樣本值

ClientToken

string

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

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

說明

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

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

DryRun

boolean

是否對此次修改請求執行預檢,包括許可權、執行個體狀態校正等。取值:

  • false(預設):發送正常請求,通過檢查後直接修改轉寄路由器執行個體的資訊。

  • true:發送檢查請求,只進行校正,不會修改轉寄路由器執行個體的資訊。檢查項包括是否填寫了必需參數、請求格式等。如果檢查不通過,則返回對應錯誤。如果檢查通過,則返回對應請求 ID。

false

RegionId

string

轉寄路由器執行個體所屬地區 ID。

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

cn-shanghai

TransitRouterId

string

轉寄路由器執行個體 ID。

tr-uf654ttymmljlvh2x****

TransitRouterName

string

轉寄路由器執行個體的新名稱。

名稱可以為空白或長度為 1~128 個字元,不能以 http://或 https://開頭。

testname

TransitRouterDescription

string

轉寄路由器執行個體新的描述資訊。

描述可以為空白或長度為 1~256 個字元,不能以 http://或 https://開頭。

testdesc

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

E9963DD7-998B-4F92-892D-8293CB49EE81

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E9963DD7-998B-4F92-892D-8293CB49EE81"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 OperationUnsupported.RegionId The specified region ID is not supported. 操作不支援此地區
400 IncorrectStatus.TransitRouterInstance The status of TransitRouter is incorrect. 轉寄路由器狀態不正確。
400 InvalidParameter Invalid parameter. 參數不合法。
400 Unauthorized The AccessKeyId is unauthorized. 帳號無許可權操作。

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

變更歷史

更多資訊,參考變更詳情