docs
api
Basic Network(UNet)
GetEIPPayMode

Get Elastic IP Billing Method - GetEIPPayMode

Overview

Get Elastic IP Billing Mode

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetEIPPayMode.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, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
EIPId.NstringElastic IP's Resource IdYes

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
EIPPayModearray[EIPPayModeSet]Billing mode of EIP, see EIPPayModeSetNo

Data Model

EIPPayModeSet

Field NameTypeDescription InformationRequired
EIPIdstringResource ID of EIPNo
EIPPayModestringBilling mode of EIP. Enumerated values are: Bandwidth, bandwidth billing; Traffic, traffic billing; "ShareBandwidth", shared bandwidth mode.No

Example

Request Example

https://api.surfercloud.com/?Action=GetEIPPayMode
&Region=cn-bj2
&EIPId=eip-eij2r4

Response Example

{
  "Action": "GetEIPPayModeResponse",
  "EIPPayMode": [
    {
      "EIPId": "eip-eij2r4",
      "EIPPayMode": "Traffic"
    }
  ],
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved