全部产品
Search
文档中心

云企业网:UpdateTransitRouter - 修改转发路由器实例信息

更新时间:Mar 01, 2024

调用UpdateTransitRouter接口修改转发路由器实例的名称和描述信息。

接口说明

UpdateTransitRouter 接口属于异步接口,即系统会先返回一个 RequestId,但转发路由器实例的修改并未完成,系统后台的修改任务仍在进行。您可以调用 ListTransitRouters 接口查询转发路由器实例的状态。

  • 当转发路由器实例处于 Modifying 状态时,表示转发路由器实例正在修改中,在该状态下,您只能对转发路由器实例执行查询操作,不能执行其他操作。
  • 当转发路由器实例处于 Active 状态时,表示转发路由器实例修改完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:UpdateTransitRouterWrite
  • TransitRouter
    acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-001****
DryRunboolean

是否对此次修改请求执行预检,包括权限、实例状态校验等。取值:

  • false(默认):发送正常请求,通过检查后直接修改转发路由器实例的信息。
  • true:发送检查请求,只进行校验,不会修改转发路由器实例的信息。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回对应请求 ID。
false
RegionIdstring

转发路由器实例所属地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
TransitRouterIdstring

转发路由器实例 ID。

tr-uf654ttymmljlvh2x****
TransitRouterNamestring

转发路由器实例的新名称。

名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。

testname
TransitRouterDescriptionstring

转发路由器实例新的描述信息。

描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。

testdesc

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400OperationUnsupported.RegionIdThe specified region ID is not supported.操作不支持此地域
400IncorrectStatus.TransitRouterInstanceThe status of TransitRouter is incorrect.转发路由器状态不正确。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史