You need to enable JavaScript to run this app.
导航

ModifyDirectConnectVirtualInterfaceAttributes

最近更新时间2023.09.05 08:30:38

首次发布时间2022.03.25 07:38:20

调用ModifyDirectConnectVirtualInterfaceAttributes修改指定虚拟接口的名称、描述及配置等相关信息。

调用说明

  • 当前NQA检测功能为邀测状态,如需试用您可提交工单或联系客户经理申请试用。未开通NQA检测功能,请避免传入EnableNqaNqaDetectIntervalNqaDetectMultiplier

  • 您可调用ModifyDirectConnectVirtualInterfaceAttributes为虚拟接口添加本端互联IP、对端互联IP的IPv6类型的IP地址,但需遵循以下限制:

    • 仅支持添加新的IPv6地址,不支持修改已有IPv6地址或删除已有IPv6地址。

    • 仅支持同时添加本端、对端互联IP的IPv6地址,不支持单独添加本端或对端互联IP的IPv6地址。

  • 不支持同时开启NQA检测功能和BFD检测功能。

请求参数

名称类型是否必选示例值描述
ActionStringModifyDirectConnectVirtualInterfaceAttributes要执行的操作,取值为ModifyDirectConnectVirtualInterfaceAttributes。
VersionString2020-04-01API版本信息。
VirtualInterfaceIdStringdcv-7qthudw0ll6jmc****待修改信息的虚拟接口的ID。您可调用DescribeDirectConnectVirtualInterfaces查询虚拟接口的ID。

VirtualInterfaceName

String

test

虚拟接口的名称。

  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短横线(-)。
  • 长度限制为1 ~ 128个字符。
  • 不更改该参数时,保持原有配置,表示不修改虚拟接口实例的名称。

Description

String

This is a sample description

虚拟接口的描述信息。

  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。
  • 长度限制为0 ~ 255个字符。
  • 不更改该参数时,保持原有配置,表示不修改虚拟接口实例的描述。

EnableBfd

BfdDetectInterval

Boolean

Integer

false

1000

是否开启BFD检测。您可调用DescribeDirectConnectVirtualInterfaces查询RouteType类型。

  • true:开启
  • false(默认):不开启
    BFD检测时间间隔。单位:ms,取值范围:200~1000,默认1000。未开启BFD检测功能,请避免传入此参数。
BfdDetectMultiplierInteger3BFD检测次数。取值范围:3~10,默认3。未开启BFD检测功能,请避免传入此参数。

Bandwidth

Integer

100

虚拟接口的带宽,单位:Mbps。

  • 不可超过所关联物理专线的带宽。
  • 若关联的是共享专线,则限速带宽为共享专线的带宽。
  • 不填表示不限速。

EnableNqa

Boolean

true

是否开启NQA检测功能。您可调用DescribeDirectConnectVirtualInterfaces查询RouteType类型。

  • true:开启
  • false(默认):不开启

说明

RouteTypeStatic类型时,支持开启NQA检测功能。

NqaDetectIntervalInteger3000NQA检测发送连续探测报文的时间间隔。单位:ms,取值:1000~5000,默认2000。未开启NQA检测功能,请避免传入此参数。

NqaDetectMultiplier

Integer

8

NQA检测的时间次数,若NQA检测连续失败次数达到设定的检测次数,则判定此线路故障。取值:3~8 ,默认5。未开启NQA检测功能,请避免传入此参数。

说明

开启NQA功能后,若线路流量几乎可达带宽上限,建议把检测次数设为8

LocalIpv6IpStringfe80:XX::1/120虚拟接口本端网关互联IP的IPv6地址。
PeerIpv6IpStringfe80:XX::2/120虚拟接口对端网关互联IP的IPv6地址。

返回数据

名称类型
示例值
描述
RequestIdString202111161611080102121461940900****请求ID。

请求示例

GET /?Action=ModifyDirectConnectVirtualInterfaceAttributes&Version=2020-04-01&VirtualInterfaceId=dcv-7qthudw0ll6jmc****&VirtualInterfaceName=test&Description=test HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202111161611080102121461940900****",
        "Action": "ModifyDirectConnectVirtualInterfaceAttributes",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
    		"RequestId": "202111161611080102121461940900****"
    }
}

错误码

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

HttpCode
错误码
错误信息
描述
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidDirectConnectGateway.InvalidStatusThe specified direct connect gateway is not in the correct status for the request.指定的专线网关所处的状态无法响应该请求。
400InvalidDirectConnectVirtualInterface.BandwidthMismatchThe specified bandwidth of virtual interface is inconsistent with the bandwidth of the shared connection.指定的虚拟接口带宽与共享专线的带宽不一致。
400InvalidDirectConnectVirtualInterface.BandwidthMalformedThe specified bandwidth is malformed.指定的带宽不合法。
400InvalidDirectConnectVirtualInterface.BandwidthExceededThe specified bandwidth of virtual interface exceeds the bandwidth of physical connection.指定的虚拟接口带宽超过了物理专线带宽。
400InvalidDirectConnectVirtualInterface.EnableBfdMismatchThe specified virtual interface route type does not support enable bfd.指定的虚拟接口路由类型不支持启用BFD检测。
400InvalidDirectConnectVirtualInterface.BfdDetectIntervalMalformedThe specified bfd detect interval is malformed. It can only be set when bfd is enabled, and the value should be between 200 and 1000.指定的BFD检测间隔数值不合法。只有在启用BFD时才可设置该值,且该值应在200和1000之间。
400InvalidDirectConnectVirtualInterface.BfdDetectMultiplierMalformedThe specified bfd detect multiplier is malformed. It can only be set when bfd is enabled, and the value should be between 3 and 10.指定的BFD检测次数数值不合法。只有在启用BFD时才可设置该值,且该值应在3和10之间。
400InvalidDirectConnectVirtualInterface.EnableNqaMismatchThe specified virtual interface route type does not support enable nqa.指定的虚拟接口路由类型不支持启用NQA检测。
400InvalidDirectConnectVirtualInterface.NqaDetectIntervalMalformedThe specified nqa detect interval is malformed. It can only be set when nqa is enabled, and the value should be between 1000 and 5000.指定的NQA检测间隔数值不合法。只有在启用NQA时才可设置该值,且该值应在1000和5000之间。
400InvalidDirectConnectVirtualInterface.NqaDetectMultiplierMalformedThe specified nqa detect multiplier is malformed. It can only be set when nqa is enabled, and the value should be between 3 and 8.指定的NQA检测次数数值不合法。只有在启用NQA时才可设置该值,且该值应在3和8之间。
400InvalidDirectConnectConnection.InvalidBusinessStatusThe specified direct connect connection is not in the correct status for the request. The specified direct connect connection is in freeze.指定的物理专线所处的状态无法响应该请求。当前物理专线被冻结。
400InvalidDirectConnectGateway.InvalidBusinessStatusThe specified direct connect gateway is not in the correct status for the request. The specified direct connect gateway is in freeze.指定的专线网关所处的状态无法响应该请求。当前专线网关被冻结。
400InvalidDirectConnectConnection.InvalidStatusThe specified direct connect connection is not in the correct status for the request.指定的物理专线所处的状态无法响应该请求。
400InvalidDirectConnectVirtualInterface.Ipv6IpChangeIt is unsupported changing local IPv6 IP or peer IPv6 IP.不支持修改虚拟接口的本端IPv6地址或对端IPv6地址。
400InvalidDirectConnectVirtualInterface.GatewayIpv6NotEnableThe specified direct connect gateway does not enable IPv6.指定的专线网关未启用IPv6。
400InvalidDirectConnectVirtualInterface.Ipv6IpMissingThe specified virtual interface local IPv6 IP or peer IPv6 IP is missing, they must either both be configured or not configured at all.指定的虚拟接口必须同时指定本端IPv6地址和对端IPv6地址。
400InvalidDirectConnectVirtualInterface.LocalIpv6IpMalformedThe specified virtual interface local IPv6 address is malformed.指定的虚拟接口本端IPv6地址不合法。
400InvalidDirectConnectVirtualInterface.PeerIpv6IpMalformedThe specified virtual interface peer IPv6 address is malformed.指定的虚拟接口对端IPv6地址不合法。
400InvalidDirectConnectVirtualInterface.PeerIpv6IPMismatchThe specified virtual interface Peer IPv6 IP and Local IPv6 IP are not in the same subnet.指定的虚拟接口对端IPv6地址与本端IPv6地址不在同一个子网。
400InvalidDirectConnectVirtualInterface.NqaBfdBothEnabledThe specified virtual interface does not support enabling bfd and nqa at the same time.指定的虚拟接口不支持同时启动BFD和NQA检测。
403Forbidden.IPv6You are not authorized to operate IPv6 functions.无权限操作IPv6功能。
403ForbiddenYou are not authorized to perform nqa operations on the specified virtual interface.无权限对指定的虚拟接口进行NQA操作。
404InvalidDirectConnectVirtualInterface.NotFoundThe specified direct connect virtual interface does not exist.指定的虚拟接口不存在。
409InvalidDirectConnectVirtualInterface.PeerIpv6IpConflictThe specified virtual interface peer IPv6 IP conflicts with its local IPv6 IP.指定的虚拟接口对端IPv6地址与本端IPv6地址重复。
409InvalidDirectConnectVirtualInterface.LocalIpv6IpConflictThe subnet of the specified virtual interface local IPv6 IP overlaps with another virtual interface.指定的虚拟接口本端IPv6地址所在子网与另一个虚拟接口所在子网重叠。