文档

UpdateTransitRouterVpnAttachmentAttribute - 修改VPN连接的配置

更新时间:

调用UpdateTransitRouterVpnAttachmentAttribute接口修改企业版转发路由器下VPN连接的名称、描述信息、是否允许自动发布路由。

调试

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

授权信息

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

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

请求参数

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-42665544****
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会修改 VPN 连接的配置。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接修改 VPN 连接的配置。
false
TransitRouterAttachmentIdstring

VPN 连接 ID。

tr-attach-a6p8voaodog5c0****
TransitRouterAttachmentNamestring

VPN 连接的新名称。

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

nametest
TransitRouterAttachmentDescriptionstring

VPN 连接新的描述信息。

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

desctest
AutoPublishRouteEnabledboolean

是否允许转发路由器实例自动向 IPsec 连接发布路由条目。取值:

  • true:允许。
  • false:不允许。
true

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

1AB038F2-96E5-560B-9F6E-734311D466FA

示例

正常返回示例

JSON格式

{
  "RequestId": "1AB038F2-96E5-560B-9F6E-734311D466FA"
}

错误码

HTTP status code错误码错误信息描述
400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.网络连接实例ID不存在。
400IncorrectStatus.TransitRouterAttachmentIdThe resource is not in a valid state for the attachment operation.当前该Attachment不处于稳态,不支持该操作。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

  • 本页导读 (1)
文档反馈