- GetGlobalSSHTraffic
Overview
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetGlobalSSHTraffic . | 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 |
---|---|---|---|
ProjectId | string | Yes | |
UGAId | string | Yes | |
BeginTime | int | Yes | |
EndTime | int | 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 |
UGAId | string | Yes | |
DataSet | array[TrafficDaily] | Yes | |
TrafficDailyRecently | array[TrafficDailyRecently] | No |
Data Model
TrafficDaily
Field Name | Type | Description Information | Required |
---|---|---|---|
Date | int | Date | Yes |
Traffic | int | Traffic (Unit GB) | Yes |
BillingState | string | Yes: Fee Deducted, No: Fee Not Deducted | Yes |
TrafficDailyRecently
Field Name | Type | Description Information | Required |
---|---|---|---|
Day | string | Date | No |
TrafficUnitMB | string | Daily Traffic (in MB) | No |
TrafficUnitGB | string | Daily Traffic (Unit: GB) | No |
Example
Request Example
https://api.surfercloud.com/?Action=GetGlobalSSHTraffic
&ProjectId=org-xxxx
&UGAId=uga-usai7d
&BeginTime=1525017600
&EndTime=1526399999
Response Example
{
"Action": "GetGlobalSSHTrafficResponse",
"DataSet": [
{
"BillingState": "No",
"Date": 1568304000,
"Traffic": 0
},
{
"BillingState": "No",
"Date": 1568390400,
"Traffic": 0
},
{
"BillingState": "No",
"Date": 1568476800,
"Traffic": 0
},
{
"BillingState": "No",
"Date": 1568563200,
"Traffic": 0
},
{
"BillingState": "No",
"Date": 1568649600,
"Traffic": 0
},
{
"BillingState": "No",
"Date": 1568131200,
"Traffic": 0
},
{
"BillingState": "No",
"Date": 1568217600,
"Traffic": 0
}
],
"Message": "",
"RetCode": 0,
"TrafficDailyRecently": [
{
"Day": "uZZsUBmp",
"TrafficUnitGB": "sJNgQpQk",
"TrafficUnitMB": "lRVjQUCU"
}
],
"UGAId": "uga-usai7d"
}