Docs
api
Object-based Storage(US3)
GetUFileQuotaInfo

Retrieve Quota Information - GetUFileQuotaInfo

Overview

Retrieve Quota Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUFileQuotaInfo.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
QuotaType.NstringQuota type, the value can be storage-volume, download-traffic or request-countYes

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
DataSetarray[UFileQuotaDataSetItem]Quota Information DatasetNo

Data Model

UFileQuotaDataSetItem

Field NameTypeDescription InformationRequired
RegionstringAvailable RegionNo
OweintWhether there is arrears: 1 means there is arrears; 0 means no arrears.No
StorageUFileQuotaLeftRemaining Storage CapacityNo
DownloadFlowUFileQuotaLeftRemaining Download TrafficNo
RequestCntUFileQuotaLeftRemaining Request TimesNo

UFileQuotaLeft

Field NameTypeDescription InformationRequired
LeftfloatRemaining QuotaNo

Example

Request Example

https://api.ucloud-global.com/?Action=GetUFileQuotaInfo
&Region=cn-bj2
&QuotaType.0=storage-volume
&QuotaType.1=download-traffic
&QuotaType.2=request-count
&ProjectId=org-xxx

Response Example

{
  "Action": "GetUFileQuotaInfoResponse",
  "DataSet": [
    {
      "DownloadFlow": {
        "Left": -5.1803
      },
      "Owe": 1,
      "Region": "cn-bj",
      "RequestCnt": {
        "Left": 202
      },
      "Storage": {
        "Left": -13507.2
      }
    }
  ],
  "RetCode": 0
}