On this page

Show all

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

Querying Service Usage

Updated on 2025-03-07 GMT+08:00

View PDF

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
Authorization	No	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permissions. When an API is called, the token is added to the request header to obtain the operation permissions. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
Host	Yes	String	Address, which is used for app authentication.

Response Parameters

Status code: 200

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

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

Example Requests

Query the current service usage.

GET /koodrive/ose/v1/service/quotaUsed

Authorization:Bearer+10f88d***************4791e9f

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"
}

Status Codes

Status Code	Description
200	Response for querying service usage.

Parent topic: Service Subscription

Previous topic: Obtaining the Subscription Status

Next topic: Enterprise Settings

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot