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

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyVSwitchAttribute

系统规定参数。取值:ModifyVSwitchAttribute

VSwitchId String vsw-25nacdfvue4****

交换机的ID。

VSwitchName String VSwitch-1

交换机要修改的名称。

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

RegionId String cn-hangzhou

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

Description String This is my vswitch.

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

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

Ipv6CidrBlock Integer 10

交换机IPv6网段的最后8比特位,取值:0~255

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

EnableIPv6 Boolean false

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

  • true:开通IPv6功能。
  • false(默认值):未开通IPv6功能。
VpcIpv6CidrBlock String 2408:XXXX:312:3e00::/56

交换机所在VPC的IPv6网段。

该参数仅当VPC开通IPv6功能时支持配置。

返回数据

名称 类型 示例值 描述
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyVSwitchAttribute
&VSwitchId=vsw-25nacdfvue4****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyVSwitchAttributeResponse>
<RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</ModifyVSwitchAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidVSwitchName.Malformed Specified virtual switch name is not valid. 该vSwitch名字格式不正确,请您确认vSwitch名字格式。
400 InvalidVSwitchDiscription.Malformed Specified virtual switch description is not valid. 该vSwitch描述信息格式不正确。
400 InvalidVSwitchDiscription.Malformed Specified virtual switch description is not valid. 交换机描述不合法。
400 Forbidden.VRouterNotFound specified virtual switch is not found during access authentication. 在访问鉴权时未找到指定的虚拟交换机
400 UnsupportedFeature.CloudBoxIpv6 The IPv6 feature is not supported by cloud box. 云盒不支持创建IPv6。
400 OperationFailed.Ipv6InstanceExist Operation failed because vswitch has ipv6 instance. 交换机中存在IPv6实例。
400 IncorrectStatus.VpcRouteEntry The status of the specified routeEntry is invalid. VPC路由条目状态不正确。
400 OperationFailed.IPv6Disabled Operation failed because IPv6 is not enabled for the vSwitch. 指定操作失败,因为IPv6功能未打开。
404 InvalidVSwitchId.NotFound The specified virtual switch does not exists. 该交换机不存在,请您检查输入的交换机是否正确。

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