調(diào)用UpdateTransitRouter接口修改轉(zhuǎn)發(fā)路由器實(shí)例的名稱和描述信息。
接口說明
UpdateTransitRouter 接口屬于異步接口,即系統(tǒng)會先返回一個 RequestId,但轉(zhuǎn)發(fā)路由器實(shí)例的修改并未完成,系統(tǒng)后臺的修改任務(wù)仍在進(jìn)行。您可以調(diào)用 ListTransitRouters 接口查詢轉(zhuǎn)發(fā)路由器實(shí)例的狀態(tài)。
- 當(dāng)轉(zhuǎn)發(fā)路由器實(shí)例處于 Modifying 狀態(tài)時,表示轉(zhuǎn)發(fā)路由器實(shí)例正在修改中,在該狀態(tài)下,您只能對轉(zhuǎn)發(fā)路由器實(shí)例執(zhí)行查詢操作,不能執(zhí)行其他操作。
- 當(dāng)轉(zhuǎn)發(fā)路由器實(shí)例處于 Active 狀態(tài)時,表示轉(zhuǎn)發(fā)路由器實(shí)例修改完成。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cen:UpdateTransitRouter | update |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數(shù)值,確保不同請求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統(tǒng)自動使用 API 請求的 RequestId 作為 ClientToken 標(biāo)識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44-001**** |
DryRun | boolean | 否 | 是否對此次修改請求執(zhí)行預(yù)檢,包括權(quán)限、實(shí)例狀態(tài)校驗(yàn)等。取值:
| false |
RegionId | string | 是 | 轉(zhuǎn)發(fā)路由器實(shí)例所屬地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
TransitRouterId | string | 是 | 轉(zhuǎn)發(fā)路由器實(shí)例 ID。 | tr-uf654ttymmljlvh2x**** |
TransitRouterName | string | 否 | 轉(zhuǎn)發(fā)路由器實(shí)例的新名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | testname |
TransitRouterDescription | string | 否 | 轉(zhuǎn)發(fā)路由器實(shí)例新的描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | testdesc |
返回參數(shù)
示例
正常返回示例
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. | 轉(zhuǎn)發(fā)路由器狀態(tài)不正確。 |
400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權(quán)限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|