Updated on 2026-04-16 GMT+08:00

Listing My Shares

Function

List files shared by you. One sharing record occupies one line. When multiple files are shared, a folder with the first file name is displayed. When a single file is shared, the file information is displayed.

URI

GET /koodrive/ose/v1/share

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

pageSize

No

Integer

Definition:

Number of results returned on each page. It is possible that partial or empty result pages are returned before the end of the result list has been reached.

Constraints:

N/A

Range:

The minimum value is 1 and the maximum value is 100.

Default Value:

100

pageCursor

No

String

Definition:

Current page cursor, which is obtained from nextCursor of the previous response.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

sortType

No

Integer

Definition:

Sorting type. 4: sharing creation time

Constraints:

N/A

Range:

4

Default Value:

4

sortDirection

No

Integer

Definition:

Sorting direction. 1: ascending 2: descending

Constraints:

N/A

Range:

N/A

Default Value:

2

displayName

No

String

Fuzzy match by display name is supported.

Definition: Query name.

Constraints: None

Range: None

Value: none

imageProcess

No

String

Image operation, which can be used to specify the thumbnail size.

Description: thumbnail size

Constraints: None

Range: See https://support.huaweicloud.com/en-us/usermanual-obs/obs_01_0430.html.

Default Value: image/resize,m_lfit,h_128,w_128

usage

No

String

Definition:

Document and video thumbnail formats.

Constraints:

The maximum length is 100.

Range:

minThumbnail, midThumbnail, largeThumbnail, and superLargeThumbnail

Default Value:

N/A

Request Parameters

Table 2 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

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. The format is yyyyMMdd'T'HHmmss'Z'.

Constraints:

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

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

nextCursor

String

Pagination cursor. If the cursor does not exist, the last record has been returned.

shareLinks

Array of ShareByMeLink objects

Sharing link list.

Table 5 ShareFileInfo

Parameter

Type

Description

id

String

*File ID.

fileName

String

*File name, which contains up to 250 bytes.

fileType

String

File type.

mimeType

String

*Content type.

size

Integer

File size.

parentFolder

Array of strings

List of parent directory IDs. Currently, only the first ID is used.

fileSuffix

String

File name extension, which is the last character string of fullFileExtension.

containers

Array of strings

Space ID.

downloadLinks

Array of downloadLinks objects

Download link.

recycled

Boolean

Whether the file is in the recycle bin.

Example Requests

GET /koodrive/ose/v1/share?pageSize=&pageCursor=0&sortType=2&sortDirection=4&displayName=

Authorization:Bearer+10f88*************5a544791e9ff

Example Responses

Status code: 200

OK

{
  "shareLinks" : [ {
    "shareId" : "1689759841444195840",
    "shortUrl" : "1689759841452584448",
    "linkUrl" : "https://kdconsole-test-gray.hwcloudtest.cn:8080/koodrive/ose/v1/share/public/download/redirect?shortUrl=1689759841452584448&agentName=standard&extractCode=BIqw8T1X",
    "shareTime" : "2025-05-20T02:11:10.211Z",
    "expireTime" : "2025-05-27T02:11:10.210Z",
    "scope" : 1,
    "files" : [ {
      "recycled" : false,
      "id" : "FgzdaJOvUdMXVGqP--cdF7ZRWEeIlVzPF",
      "fileName" : "Download.webp",
      "fileType" : "15",
      "mimeType" : "image/webp",
      "size" : 153326,
      "parentFolder" : [ "DF2FLxs6DRwArootIAABh_RdhS8bOg0cA1684711052660690818" ],
      "fileSuffix" : "webp",
      "containers" : [ "IAABh_RdhS8bOg0cA1684711052660690818" ],
      "downloadLinks" : [ {
        "usage" : "content",
        "downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/c06f30e6b4e64334b355eb7b8d10f101086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E4%25B8%258B%25E8%25BD%25BD.webp&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=b28f386aff3385232224501ee808cef9772e8c403bdc5f38ac1ee4165f615350"
      }, {
        "usage" : "thumbnail",
        "downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/c06f30e6b4e64334b355eb7b8d10f101086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E4%25B8%258B%25E8%25BD%25BD.webp&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=bcd6f6ae2479cdc39d33ccde3968cc5c36725992a6bc9fdf069cee7eaa03e811"
      } ]
    }, {
      "recycled" : false,
      "id" : "Fk63FCWhcDAga2puvYKRG1oTMjs-m30sI",
      "fileName" : "Figure-1-1-1-75-750x422.png",
      "fileType" : "15",
      "mimeType" : "image/png",
      "size" : 141587,
      "parentFolder" : [ "DF2FLxs6DRwArootIAABh_RdhS8bOg0cA1684711052660690818" ],
      "fileSuffix" : "png",
      "containers" : [ "IAABh_RdhS8bOg0cA1684711052660690818" ],
      "downloadLinks" : [ {
        "usage" : "content",
        "downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/d3f26272207047d1a12eafa4fcd99ed8086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%259C%2596%25E7%2589%2587-1-1-1-75-750x422.png&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=c5ffcfd17ad3a0f19a7651ae33c883e3e01e5839087eb445bde42c3517e74d13"
      }, {
        "usage" : "thumbnail",
        "downloadLink" : "https://obs-koodrive-test-2.obs.cn-north-4.myhuaweicloud.com/d3f26272207047d1a12eafa4fcd99ed8086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27%25E5%259C%2596%25E7%2589%2587-1-1-1-75-750x422.png&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250520T021113Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=CKJ3TYZ9M7QPX4SXS5YC%2F20250520%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=0515fbd7808e509a3fe1018ee49127cdf0d45ec03bfc0de93e37cddfd3638aa2"
      } ]
    } ],
    "displayName" : "Download.webp",
    "status" : 0,
    "comment" : "",
    "containerName" : "Individual space.",
    "ownerType" : "1",
    "containerId" : "IAABh_RdhS8bOg0cA1684711052660690818",
    "viewCnt" : 0,
    "downloadCnt" : 0,
    "saveCnt" : 0,
    "updateTime" : "2025-05-20T02:11:10.211Z"
  } ],
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

OK