全部产品
Search

搜索本产品

    专有网络 VPC：ModifyVSwitchAttribute - 修改指定交换机的名称和描述信息

    文档中心

    专有网络 VPC：ModifyVSwitchAttribute - 修改指定交换机的名称和描述信息

    更新时间：Nov 27, 2024

    调用ModifyVSwitchAttribute接口修改指定交换机的名称和描述信息。

    接口说明

    • ModifyVSwitchAttribute 接口属于异步接口，即系统会返回一个请求 ID，但该交换机的名称和描述信息尚未修改成功，系统后台的修改任务仍在进行。您可以调用 DescribeVSwitchAttributes 查询交换机的修改状态：
      • 当交换机的状态处于 Pending 状态时，表示交换机的名称和描述信息正在修改中。
      • 当交换机状态处于 Available 状态时，表示交换机可用。
    • ModifyVSwitchAttribute 接口不支持并发修改同一个交换机的名称和描述信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    VSwitchIdstring是

    交换机的 ID。

    		vsw-25nacdfvue4****
    VSwitchNamestring否

    交换机要修改的名称。

    名称长度为 1～128 个字符，不能以http://或https://开头。

    		VSwitch-1
    RegionIdstring否

    交换机所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

    		cn-hangzhou
    Descriptionstring否

    交换机要修改的描述信息。

    描述长度为 1～256 个字符，不能以http://或https://开头。

    		This is my vswitch.
    Ipv6CidrBlockinteger否

    交换机 IPv6 网段的最后 8 比特位，取值：0~255。

    该参数仅当交换机所属的 VPC 开通 IPv6 功能支持配置。

    		10
    EnableIPv6boolean否

    交换机是否开通 IPv6 功能。取值：

    • true：开通 IPv6 功能。
    • false（默认值）：未开通 IPv6 功能。
    		false
    VpcIpv6CidrBlockstring否

    交换机所在 VPC 的 IPv6 网段。 该参数仅当 VPC 开通 IPv6 功能时支持配置。

    		2408:XXXX:312:3e00::/56

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		0ED8D006-F706-4D23-88ED-E11ED28DCAC0

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidVSwitchName.MalformedSpecified virtual switch name is not valid.该vSwitch名字格式不正确，请您确认vSwitch名字格式。
    400InvalidVSwitchDiscription.MalformedSpecified virtual switch description is not valid.该vSwitch描述信息格式不正确。
    400InvalidVSwitchDiscription.MalformedSpecified virtual switch description is not valid.交换机描述不合法。
    400Forbidden.VRouterNotFoundspecified virtual switch is not found during access authentication.在访问鉴权时未找到指定的虚拟交换机
    400UnsupportedFeature.CloudBoxIpv6The IPv6 feature is not supported by cloud box.云盒不支持创建IPv6。
    400OperationFailed.Ipv6InstanceExistOperation failed because vswitch has ipv6 instance.交换机中存在IPv6实例。
    400IncorrectStatus.VpcRouteEntryThe status of the specified routeEntry is invalid.VPC路由条目状态不正确。
    400OperationFailed.IPv6DisabledOperation failed because IPv6 is not enabled for the vSwitch.指定操作失败，因为IPv6功能未打开。
    400ParamExclusive.DisableIpv6AndIpv6CidrBlockDisableIpv6 and Ipv6Cidr are mutually exclusive.操作冲突，不允许同时修改Ipv6Cidr和DisableIpv6功能。
    400IncorrectStatus.cbnStatusCurrent CBN status does not support this operation.CBN当前状态不正确
    400DependencyViolation.IPv6CidrReservationThe specified resource of [%s] depends on [%s], so the operation cannot be completed.操作的资源[%s]依赖了IPv6预留网段，请先删除依赖资源后再操作。
    400IllegalParam.VpcIpv6CidrBlockThe parameter of VpcIPv6CidrBlock is illegal.参数VpcIPv6CidrBlock非法。
    400OperationFailed.Ipv6AlreadyEnabledOperation failed because the IPv6 is enabled already.操作失败，已开启IPv6。
    400OperationFailed.Ipv6CidrBlockExistedOperation failed because the specified IPv6 CIDR block is used already.操作失败，该IPv6地址段已被使用。
    400IllegalParam.Ipv6CidrBlockThe parameter of Ipv6CidrBlock is illegal.参数Ipv6CidrBlock非法。
    400InvalidDescription.MalformedThe specified Description is wrongly formed.入参Description无效
    400OperationFailed.VpcIpv6DisabledOperation failed because the VPC has not enabled IPv6.当前操作不支持因为VPC尚未开启IPv6。
    400IncorrectStatus.VSwitchThe specified vSwitch status is invalid.虚拟交换机状态异常。
    404InvalidVSwitchId.NotFoundThe specified virtual switch does not exists.该交换机不存在，请您检查输入的交换机是否正确。
    500SystemBusyThe system is busy. Please try again later.当前系统繁忙，请稍后重试。

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

    变更历史

    变更时间变更内容概要操作
    2024-11-07OpenAPI 错误码发生变更查看变更详情
    2024-10-08OpenAPI 错误码发生变更查看变更详情
    2023-08-24OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
    2023-06-30OpenAPI 错误码发生变更查看变更详情