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

文档中心

立即注册

导航

ModifyTransitRouterVpnAttachmentAttributes

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

调用ModifyTransitRouterVpnAttachmentAttributes接口，修改指定VPN类型网络实例连接的信息。

调试

API Explorer

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

去调试

请求参数

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

返回参数

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

请求示例

GET /?Action=ModifyTransitRouterVpnAttachmentAttributes&Version=2020-04-01&TransitRouterAttachmentId=tr-attach-13n2l4c****&TransitRouterAttachmentName=vpnattach-02 HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

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

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
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.	指定的中转路由器所处状态无法响应该请求。
400	InvalidTransitRouterAttachment.InvalidStatus	The specified Transit Router Attachment is not in the correct status for the request.	指定的网络实例连接所处状态无法响应该请求。
404	InvalidTransitRouterAttachment.NotFound	The specified Transit Router attachment does not exist.	指定的网络实例连接不存在。