Help Center/ KooDrive/ API Reference/ API/ Space Management/ Querying Space Information

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

View PDF

Querying Space Information

Function

Query the space information of an individual, department, or group.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
owner_id	Yes	String	Owner ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Space type. 0: department. 1: individual. 2: group.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	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}.
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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response message.
data	SpaceInfo object	Space information.

**Table 5** SpaceInfo
Parameter	Type	Description
type	String	Owner type. 0: department space; 1: individual space; 2: group space.
status	String	Status.
ownerId	String	Space owner. For a department space, the department ID is returned. For an individual space, the user ID is returned. For a group space, the group 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.
spaceUsed	String	Size of the used space.
administrators	String	For a department space, administrator names are returned. Multiple administrators are separated by commas (,). 2. For a group space, the owner name is returned.
tenantId	String	Tenant ID.
creator	String	Creator.
createTime	String	Creation time.
modifier	String	ID of the user who updated the information.
updateTime	String	Update time.
userNum	String	Number of users.
rootFileId	String	ID of the space root directory.

Example Requests

Queries 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" : "OK"
}