Get Elastic IP Billing Method - GetEIPPayMode
Overview
Get Elastic IP Billing Mode
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetEIPPayMode . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
ProjectId | string | Project 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.N | string | Elastic IP's Resource Id | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
EIPPayMode | array[EIPPayModeSet] | Billing mode of EIP, see EIPPayModeSet | No |
Data Model
EIPPayModeSet
Field Name | Type | Description Information | Required |
---|---|---|---|
EIPId | string | Resource ID of EIP | No |
EIPPayMode | string | Billing 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
}