Help Center/ KooDrive/ API Reference/ API/ Service Subscription/ Querying Service Usage

Updated on 2024-07-30 GMT+08:00

View PDF

Querying Service Usage

Function

Query service usage (space and OrgID user quotas).

URI

GET /koodrive/ose/v1/service/quotaUsed

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response message.
data	data object

**Table 3** data
Parameter	Type	Description
spaceQuotaUsed	String	Used space quota.
userCount	String	Number of created OrgID users.
spaceCapacity	String	Total space capacity subscribed by the tenant, in GB.
userMaxCount	String	User quantity subscribed by the tenant.
spaceUsed	String	Used space.
deptSpaceQuota	String	Department space quota.
personalSpaceQuota	String	Individual space quota.
groupSpaceQuota	String	Group space quota.
reservedSpaceQuota	String	Reserved space quota.
deptSpaceUsed	String	Used department space.
deptSpaceQuotaUsed	String	Used department space quota.
personalSpaceUsed	String	Used individual space.
personalSpaceQuotaUsed	String	Used individual space quota.
groupSpaceUsed	String	Used group space.
groupSpaceQuotaUsed	String	Used group space quota.
packageDownloadExpires	String	Expiration time of package download.
productType	String	Product type.

Example Requests

None

Example Responses

Status code: 200

Response for querying service usage.

{
  "data" : {
    "spaceUsed" : 7753298,
    "spaceCapacity" : 10240,
    "deptSpaceQuota" : 6144,
    "personalSpaceQuota" : 2048,
    "groupSpaceQuota" : 2048,
    "reservedSpaceQuota" : 0,
    "spaceQuotaUsed" : 327,
    "deptSpaceUsed" : 1975057,
    "deptSpaceQuotaUsed" : 42,
    "personalSpaceUsed" : 3933426,
    "personalSpaceQuotaUsed" : 35,
    "groupSpaceUsed" : 1844815,
    "groupSpaceQuotaUsed" : 250,
    "userCount" : 20,
    "userMaxCount" : 100,
    "packageDownloadExpires" : 7,
    "productType" : "1"
  },
  "code" : 0,
  "msg" : "success"
}