Help Center/ KooDrive/ API Reference/ API/ Space Management/ Obtaining the Space Allocation Status
Updated on 2025-03-14 GMT+08:00

Obtaining the Space Allocation Status

Function

Obtain the allocated and total space size of a tenant.

URI

GET /koodrive/ose/v1/space/allocation/get

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

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.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

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

String

Error code.

msg

String

Error message.

data

Array of GetSpaceAllocatedData objects

Space allocation status.

Table 3 GetSpaceAllocatedData

Parameter

Type

Description

type

Integer

Space type.

allocateCapacity

Long

Allocated size, in GB.

totalCapacity

Long

Total size, in GB.

Example Requests

Obtaining the Allocated and Total Space Size of a Tenant

/koodrive/ose/v1/space/allocation/get

Authorization: HMAC-SHA256 AppId=a378331eca141163119eb602adb67b7802cc79cd33ba44c7d2fe61d1586c96a1,SignedHeaders=host;x-date;x-user-id,Signature=bd355f202be40f95bf9510fd7bd48ad711a7d144c01df07d515ee0fbf3a47416
X-User-Id: 1505084218764547200
Host: 10.32.45.165
X-Date: 20240909T033325Z

Example Responses

Status code: 200

Obtains the space allocation status.

{
  "data" : {
    "type" : "0",
    "allocateCapacity" : "1000",
    "totalCapacity" : "2000"
  },
  "code" : 0,
  "msg" : "Operation successful."
}

Status Codes

Status Code

Description

200

Obtains the space allocation status.