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

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 ModifyHaVipAttribute

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

HaVipId String Yes havip-2zeo05qre24nhrqp****

The ID of the HAVIP.

RegionId String Yes cn-shanghai

The region ID of the HAVIP. You can call the DescribeRegions operation to query region IDs.

ClientToken String No 02fb3da4-130e-11e9-8e44-0016e0****

The client token that is used to guarantee the idempotence of the request. You can use the client to generate a value that is unique among different requests.ClientToken supports only ASCII characters.

It can contain up to 64 ASCII characters.

Description String No This is my HaVip.

The description of the HAVIP.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http://orhttps://.

Name String No test

The description of the HAVIP.

The name must be 2 to 128 characters and can contain digits, underscores (_), and hyphens (-). The name must start with a letter.

Response parameters

Parameter Type Example Description
RequestId String C44F62BE-9CE7-4277-B117-69243F3988BF

The request ID.

Examples

Sample requests

https://vpc.aliyuncs.com/?Action=ModifyHaVipAttribute 
&HaVipId=havip-2zeo05qre24nhrqp****
&RegionId=cn-shanghai 
&Common request parameters

Sample success responses

XML format

<ModifyHaVipAttributeResponse> 
  <RequestId>C44F62BE-9CE7-4277-B117-69243F3988BF</RequestId> 
</ModifyHaVipAttributeResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
404 InvalidHaVipId.NotFound The specified HaVip does not exist in the specified region. The error message returned because the HAVIP does not exist in the specified region. Check whether the specified region is correct.
400 IncorrectStatus HaVip can be deleted only when it's status is Available or InUse. The error message returned because the HAVIP failed to be deleted because the HAVIP is unavailable.
400 InvalidDescription.Malformed The specified Description is wrongly formed. The error message returned because the specified description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

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