Modifies the name and description of a high-availability virtual IP address (HAVIP).
Usage notes
You cannot repeatedly call the ModifyHaVipAttribute operation to modify the name and description of an HAVIP within the specified period of time.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyHaVipAttribute | The operation that you want to perform. Set the value to ModifyHaVipAttribute. |
ClientToken | String | No | 02fb3da4-130e-11e9-8e44-0016e0**** | 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. |
RegionId | String | Yes | cn-shanghai | The ID of the region to which the HAVIP belongs. You can call the DescribeRegions operation to query the most recent region list. |
HaVipId | String | Yes | havip-2zeo05qre24nhrqp**** | The ID of the HAVIP. |
Description | String | No | This is my HaVip. | The description of the HAVIP. The description must be 1 to 256 characters in length and cannot start with |
Name | String | No | test | The name of the HAVIP. The name must be 1 to 128 characters in length, and cannot start with |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | C44F62BE-9CE7-4277-B117-69243F3988BF | The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ModifyHaVipAttribute
&ClientToken=02fb3da4-130e-11e9-8e44-0016e0****
&RegionId=cn-shanghai
&HaVipId=havip-2zeo05qre24nhrqp****
&Description=This is my HaVip.
&Name=test
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyHaVipAttributeResponse>
<RequestId>C44F62BE-9CE7-4277-B117-69243F3988BF</RequestId>
</ModifyHaVipAttributeResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C44F62BE-9CE7-4277-B117-69243F3988BF"
}
Error codes
HttpCode | Error code | Error message | Examples |
---|---|---|---|
400 | InvalidDescription.Malformed | The specified Description is wrongly formed. | The error message returned because the Description parameter is set to an invalid value. |
400 | Forbidden.HaVip | No 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 apply for the permissions. |
404 | InvalidHaVipId.NotFound | The specified HaVip does not exist in the specified region. | The error message returned because the specified HAVIP does not exist in the specified region. Check the region ID. |
For a list of error codes, see Service error codes.