Obtain EIP Exclusive Traffic Package Information - GetEIPExclusiveUTPInfo
Overview
Obtain EIP Exclusive Traffic Package Information
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetEIPExclusiveUTPInfo . | 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 |
Zone | string | Availability Zone. See Availability Zone List | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
EIPId | string | EIP 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 |
EIPExclusiveInfo | EIPExclusiveInfo | EIP Exclusive Traffic Package Information | Yes |
Data Model
EIPExclusiveInfo
Field Name | Type | Description Information | Required |
---|---|---|---|
EIPId | string | EIP Resource Id | No |
AccountId | int | No | |
TotalSize | int | Exclusive Traffic Package Total Specification (Unit MB) | No |
AvailableSize | int | Remaining available specifications for the exclusive traffic package (unit MB) | No |
LastResetTime | int | Last Reset Time for Exclusive Traffic Package | No |
NextResetTime | int | Dedicated Traffic Package Next Reset Time | No |
ResetPolicy | string | Dedicated Traffic Package Reset Strategy Enumeration: Day, Month, Year | No |
CreateTime | int | Resource Creation Time | No |
Example
Request Example
https://api.surfercloud.com/?Action=GetEIPExclusiveUTPInfo
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=UXGsZpNJ
&EIPId=NWZFJlKy
Response Example
{
"Action": "GetEIPExclusiveUTPInfoResponse",
"ExclusiveInfo": {},
"RetCode": 0
}