Docs
api
Basic Network(UNet)
UpdateEIPAttribute

Update Elastic IP Properties - UpdateEIPAttribute

Overview

Update Elastic IP name, business group, remarks, and other attribute fields

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is UpdateEIPAttribute.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
EIPIdstringEIP Resource IDYes
NamestringName (Error will be reported if both Name Tag Remark are empty)No
TagstringBusinessNo
RemarkstringNoteNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No

Example

Request Example

https://api.ucloud-global.com/?Action=UpdateEIPAttribute
&Region=cn-bj2
&EIPId=eip-XXXXX
&Name=test
&Tag=test
&Remark=test

Response Example

{
  "Action": "UpdateEIPAttributeResponse",
  "Request_uuid": "a50bf300-1ff3-4192-b46f-XXXXXX",
  "RetCode": 0
}