Modifies the name and description of a vRouter.

Usage notes

You cannot repeatedly call the ModifyVRouterAttribute operation to modify the name and description of a vRouter within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyVRouterAttribute

The operation that you want to perform. Set the value to ModifyVRouterAttribute.

RegionId String No cn-hangzhou

The ID of the region where the vRouter is deployed.

You can call the DescribeRegions operation to query the most recent region list.

VRouterId String Yes vrt-gw0p7zigake75znix****

The ID of the vRouter.

VRouterName String No VRouter-1

The name of the vRouter.

The name must be 1 to 128 characters in length and cannot start with http:// or https://.

Description String No My VRouter

The description of the vRouter.

The description must be 1 to 256 characters in length and cannot start with http:// or https://.

Response parameters

Parameter Type Example Description
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyVRouterAttribute
&RegionId=cn-hangzhou
&VRouterId=vrt-gw0p7zigake75znix****
&VRouterName=VRouter-1
&Description=My VRouter
&Common request parameters

Sample success responses

XML format 

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

<ModifyVRouterAttributeResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
</ModifyVRouterAttributeResponse>

JSON format 

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

{
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

Error codes

HttpCode Error code Error message Description
400 InvalidVRouterName.Malformed Specified virtual router name is not valid. The error message returned because the name format of the specified vRouter is invalid.
400 InvalidVRouterDiscription.Malformed Specified virtual router description is not valid. The error message returned because the description format of the specified vRouter is invalid.
400 MissingParameter Miss mandatory parameter. The error message returned because some required parameters are not set. Check whether you have set all required parameters before you call this operation.
404 InvalidVRouterId.NotFound Specified virtual router does not exist. The error message returned because the specified vRouter does not exist. Check whether the specified vRouter is valid.

For a list of error codes, visit the API Error Center.