Retrieve Quota Information - GetUFileQuotaInfo

Overview

Retrieve Quota Information

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetUFileQuotaInfo`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	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
QuotaType.N	string	Quota type, the value can be storage-volume, download-traffic or request-count	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
DataSet	array[UFileQuotaDataSetItem]	Quota Information Dataset	No

Data Model

UFileQuotaDataSetItem

Field Name	Type	Description Information	Required
Region	string	Available Region	No
Owe	int	Whether there is arrears: 1 means there is arrears; 0 means no arrears.	No
Storage	UFileQuotaLeft	Remaining Storage Capacity	No
DownloadFlow	UFileQuotaLeft	Remaining Download Traffic	No
RequestCnt	UFileQuotaLeft	Remaining Request Times	No

UFileQuotaLeft

Field Name	Type	Description Information	Required
Left	float	Remaining Quota	No

Example

Request Example


https://api.sigcalcloud.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
}