All Products
Search
Document Center

Virtual Private Cloud:ModifyVRouterAttribute

Last Updated:Mar 04, 2024

Modifies the name and description of a vRouter.

Operation description

You cannot repeatedly call the ModifyVRouterAttribute operation within a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:ModifyVRouterAttributeWrite
  • VRouter
    acs:vpc:{#regionId}:{#accountId}:vrouter/{#VRouterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the vRouter.

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

cn-hangzhou
VRouterIdstringYes

The vRouter ID.

vrt-gw0p7zigake75znix****
VRouterNamestringNo

The name of the vRouter.

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

VRouter-1
DescriptionstringNo

The description of the vRouter.

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

My VRouter

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidVRouterName.MalformedSpecified virtual router name is not valid.The name format of the specified vRouter is invalid.
400InvalidVRouterDescription.MalformedSpecified virtual router description is not valid.The router description is invalid.
400MissingParameterMiss mandatory parameter.Some required parameters are not specified. Specify all required parameters and try again.
400InvalidDescription.MalformedInvalid description.-
400Forbidden.VRouterNotFoundSpecified virtual router is not found during access authentication.-
404InvalidVRouterId.NotFoundSpecified virtual router does not exist.The specified vRouter does not exist. Check whether the specified vRouter is valid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-09API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
2023-04-26The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404