Updated on 2026-02-12 GMT+08:00

Querying Space Information

Function

Query individual space information.

URI

GET /koodrive/ose/v1/space/{ownerId}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ownerId

Yes

String

Definition:

Space owner.

Constraints:

N/A

Range:

KooDrive user ID.

Default Value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Definition:

Space type.

Constraints:

N/A

Range:

  • 1: individual

Default Value:

N/A

containerId

No

String

Definition:

Space ID.

Constraints:

If the space type is individual (type=1) and there are multiple individual spaces, the container ID needs be specified.

Range:

Default Value:

N/A

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

code

Integer

Response code.

msg

String

Response message.

data

SpaceInfo object

Space information.

Table 5 SpaceInfo

Parameter

Type

Description

type

String

Owner type. 1: individual space

status

String

Status.

ownerId

String

Space owner. For an individual space, the user ID is returned.

containerId

String

Space ID.

bizRootFileId

String

ID of the service root directory, which stores unencrypted common files.

bizSboxFileId

String

ID of the service safe directory, which stores encrypted files.

capacity

String

Space size, in GB. The total space size is the sum of the value of this parameter and the value of capacityKb.

spaceUsed

String

Used space, in KB.

tenantId

String

Tenant ID.

creator

String

Creator.

createTime

String

Creation time.

modifier

String

Modifier ID.

updateTime

String

Update time.

rootFileId

String

ID of the space root directory.

capacityKb

String

Expansion package space size, in KB. The total space size is the sum of the value of this parameter and the value of capacity.

Example Requests

Query the space information of user 369528171409614001.

GET /koodrive/ose/v1/space/369528171409614001?type=1

Authorization:Bearer+10f88**********4791e9ff

Example Responses

Status code: 200

Space information.

{
  "data" : {
    "tenantId" : "40086000004871666",
    "creator" : "369528171409614001",
    "createTime" : "2023-11-07T20:36:35.000Z",
    "modifier" : "369528171409614001",
    "updateTime" : "2023-12-26T11:40:07.000Z",
    "ownerId" : "369528171409614001",
    "type" : 1,
    "status" : 0,
    "capacity" : 800,
    "spaceUsed" : 91966408,
    "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "rootFileId" : "HFFdIb642fU51JWKAUlP6mwUVc8oDNKbO",
    "bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"
  },
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

Space information.