全部产品
Search
文档中心

云企业网:UpdateTransitRouterPeerAttachmentAttribute - 修改企业版转发路由器下跨地域连接的配置

更新时间:Mar 01, 2024

调用UpdateTransitRouterPeerAttachmentAttribute接口修改企业版转发路由器下跨地域连接的配置。

接口说明

UpdateTransitRouterPeerAttachmentAttribute 接口属于异步接口,即系统会先返回一个 RequestId,但该跨地域连接并未修改完成,系统后台的修改任务仍在进行。您可以调用 ListTransitRouterPeerAttachments 接口查询跨地域连接的状态。

  • 当跨地域连接处于 Modifying 状态时,表示跨地域连接正在修改中,在该状态下,您只能对跨地域连接执行查询操作,不能执行其他操作。
  • 当跨地域连接处于 Attached 状态时,表示跨地域连接修改完成。

调试

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

授权信息

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

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

请求参数

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

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

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

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

跨地域连接 ID。

tr-attach-ft94dcrbc3e5taun3x
TransitRouterAttachmentNamestring

跨地域连接的新名称。

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

testname
TransitRouterAttachmentDescriptionstring

跨地域连接新的描述信息。

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

testdesc
AutoPublishRouteEnabledboolean

是否允许企业版转发路由器自动发布跨地域连接的路由到对端地域。

  • false(默认值):否。
  • true:是。
false
DryRunboolean

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

  • false(默认值):发送正常请求,通过检查后直接修改跨地域连接的配置。
  • true:发送检查请求,只进行校验,不会修改跨地域连接的配置。检查项包括是否填写了必需参数、请求格式等。如果检查不通过,则返回对应错误。如果检查通过,则返回对应请求 ID。
false
Bandwidthinteger

跨地域连接的带宽值。单位:Mbps。

  • BandwidthType 取值为 BandwidthPackage 时,该参数表示跨地域连接可使用的带宽值。
  • BandwidthType 取值为 DataTransfer 时,该参数表示跨地域连接的限速带宽值。
2
CenBandwidthPackageIdstring

跨地域连接要绑定的带宽包 ID。

说明 BandwidthType 取值为 DataTransfer 时,无需配置该项。
cenbwp-3xrxupouolw5ou****
BandwidthTypestring

带宽的分配方式。取值:

  • BandwidthPackage:从带宽包中分配带宽。
  • DataTransfer:不为跨地域连接分配带宽,按使用流量计费。
BandwidthPackage
DefaultLinkTypestring

默认链路类型。

可选值为 Platinum(铂金),Gold(金),默认为 Gold(金)。

且仅在带宽分配方式是按流量计费时,才可以配置为 Platinum(铂金)。

Gold

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

A01FEDD7-7D69-4EB3-996D-CF79F6F885CA

示例

正常返回示例

JSON格式

{
  "RequestId": "A01FEDD7-7D69-4EB3-996D-CF79F6F885CA"
}

错误码

HTTP status code错误码错误信息描述
400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.网络连接实例ID不存在。
400OperationUnsupported.BandwidthTypeThe specified BandwidthType does not support the operation.当前BandwidthType不支持该操作。
400MissingParam.BandwidthThe parameter Bandwidth is mandatory.带宽值参数是必需的。
400IncorrectStatus.AttachmentThe resource is not in a valid state for the attachment operation.网络连接实例正在处理状态,请稍后再操作。
400IllegalParam.BandwidthTypeBandwidthType is illegal.带宽包类型不合法。
400IllegalParam.BandwidthBandwidth is illegal.带宽包ID不合法。
400ParameterIllegal.BandwidthPackageDefaultLinkTypeOnlySupportGoldCen bandwidthPackage only support Gold.带宽分配方式为带宽包时,默认链路类型仅支持金(Gold)
400ParameterIllegal.CdtDefaultLinkTypeOnlySupportPlatinumOrGoldDataTransfer only support Platinum and Gold.带宽分配方式为按流量计费时,默认链路类型仅支持铂金(Platinum)和金(Gold)。
400ParameterIllegal.CdtDefaultLinkTypeOnlySupportGoldCDT only support Gold when both transitrouters for cross regional connections are not all enterprise version.当跨地域连接的两端转发路由器不全是企业版且带宽分配方式为按流量计费时,默认链路类型仅支持金(Gold)。
400OperationNotAllowed.DefaultLinkTypeOnlySupportGoldOperation is not allowed because this user can only set default link type to Gold.本用户只能设置默认链路类型为金。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-12-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:DefaultLinkType
2023-11-03OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-10-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:DefaultLinkType
2023-10-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
入参OpenAPI 入参发生变更
    新增入参:DefaultLinkType