ModifyTransitRouterAttributes--中转路由器-火山引擎

文档中心

立即注册

导航

ModifyTransitRouterAttributes

最近更新时间：2024.07.09 08:42:30首次发布时间：2023.03.07 09:56:38

调用ModifyTransitRouterAttributes接口，修改指定中转路由器实例的名称或描述信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ModifyTransitRouterAttributes	要执行的操作，取值为ModifyTransitRouterAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TransitRouterId	String	是	tr-7qthudw0ll6jmc****	中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。
TransitRouterName	String	否	transitrouter-01	中转路由器实例的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。长度限制为1 ~ 128个字符。不更改该参数取值时，保持原有配置不变。
Description	String	否	This transit router is used for test.	中转路由器实例的描述信息。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不更改该参数取值时，保持原有配置不变。

返回数据

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=ModifyTransitRouterAttributes&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "ModifyTransitRouterAttributes",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {}
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidTransitRouter.InvalidStatus	The specified Transit Router is not in the correct status for the request.	指定的中转路由器所处状态无法响应该请求。
403	Forbidden.NoPermissionToOperate	You are not authorized to operate the specified resource.	无权限操作指定的资源。
404	InvalidTransitRouter.NotFound	The specified Transit Router does not exist.	指定的中转路由器不存在。