Help Center/KooDrive/API Reference（Carrier）/API/Space Management/Querying Space Usage Overview
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Querying Space Usage Overview

Function

Query space usage overview, total number, total space capacity, and used total space.

URI

GET /koodrive/ose/v1/space/usage/overview

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

The value must comply with the internationalization specifications.

Default Value:

en-US

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication.

Constraints:

The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z.

Range:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Default Value:

N/A

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

code

Integer

Return code.

msg

String

Description.

data

SpaceQuotaUsage object

Query result.

Table 3 SpaceQuotaUsage

Parameter

Type

Description

totalAllocation

Long

Total allocated quota, in KB.

totalCapacity

Long

Total quota, in KB.

totalUsed

Long

Used quota, in KB.

quota

String

Quota, in GB.

Example Requests

Query space usage overview, total number, total space capacity, and used total space.

/koodrive/ose/v1/space/usage/overview

Authorization:Bearer+c69b0f40334782d560bb154032cf22ef43d671843c4ffbad

Example Responses

Status code: 200

Space usage analysis.

{
  "data" : {
    "totalAllocation" : 43,
    "totalCapacity" : 1051187,
    "totalUsed" : 33085606
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Space usage analysis.

Parent topic:Space Management