All Products
Document Center

Virtual Private Cloud:ModifyHaVipAttribute

Last Updated:Dec 02, 2023

Modifies the name and description of a high-availability virtual IP address (HAVIP).

Operation Description

You cannot repeatedly call the ModifyHaVipAttribute operation to modify the name and description of an HAVIP within the specified period of time.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


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
  • HaVip

Request parameters


The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among all requests. ClientToken can contain only ASCII characters.

Note If you do not specify this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.

The ID of the region to which the HAVIP belongs.

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


The ID of the HAVIP.


The description of the HAVIP.

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

This is my HaVip.

The name of the HAVIP.

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


Response parameters


The ID of the request.



Sample success responses


  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF"

Error codes

HTTP status codeError codeError messageDescription
400IncorrectStatusHaVip can be deleted only when it's status is Available or InUse.-
400InvalidDescription.MalformedThe specified Description is wrongly formed.The error message returned because the Description parameter is set to an invalid value.
400Abs.Vpc.InvalidName.MalformedThe specified Name is not valid.-
400Forbidden.HaVipNo permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.The error message returned because you do not have the permissions to manage the HAVIP. Go to the Quota Center page to acquire the permissions.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404InvalidHaVipId.NotFoundThe specified HaVip does not exist in the specified region.The specified HAVIP does not exist in the specified region. Check whether the specified region is correct.

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