Help Center/ KooDrive/ API Reference（Carrier）/ API/ Album Management/ Viewing an Album
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Viewing an Album

Function

View an album (album list).

URI

GET /koodrive/ose/v1/album/list

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

albumKind

Yes

Integer

Definition:

Album type.

Constraints:

N/A

Range:

1: personal album 2: shared album

Default Value:

N/A

albumType

Yes

Integer

Definition:

Album type.

Constraints:

N/A

Range:

1: collection album 2: manual album

Default Value:

N/A

groupId

No

String

Definition:

Group ID of a family.

Constraints:

Group ID returned after a family is created.

Range:

N/A

Default Value:

N/A

pageSize

No

Integer

Definition:

Page size.

Constraints:

N/A

Range:

[1-100]

Default Value:

10

pageNum

No

Integer

Definition:

Number of pages.

Constraints:

N/A

Range:

An integer greater than 0.

Default Value:

1

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.

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

language

No

String

Definition:

Language code.

Constraints:

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

Range:

N/A

Default Value

If this parameter is not transferred, English (United States) is used by default.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

albumList

Array of AlbumItem objects

Album list.

total

Integer

Total number.
Table 4 AlbumItem

Parameter

Type

Description

id

String

Album ID.

name

String

Album name, which is returned when a manual album is created.

coverImg

String

Album cover, which is returned when a manual album is created.

albumType

Integer

Album type. 1: collection album 2: manual album

albumKind

Integer

Album type. 1: personal album 2: shared album

scopeDir

Array of strings

Collection scope. This parameter is used when type is set to 1. The value can be folederId1,folederId2,folederId3.

scopeKind

String

Collection type. 1: image 2: video Example: 1, 2

scopeParentFolderId

String

Parent directory ID of the collection scope.

createTime

String

Creation time.

updateTime

String

Update time.

albumOwnerId

String

Album owner ID.

Example Requests

Query an album list

/koodrive/ose/v1/album/list?albumKind=1&albumType=2&pageSize=100&pageNum=1

albumKind=1&albumType=2&pageSize=100&pageNum=1

Example Responses

Status code: 200

Album list response.

{
    "albumList": [
        {
            "id": "1795607640592646273",
            "name": "88888",
            "coverImg": "https://obs-xxxx.myhuaweicloud.com/96e9758b7db047fcbc327266c85f1bd7086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27ms_kt%253Durl%26at%253Dori%26key%253DaHR0cHM6Ly9xY2xvdWQuZHBmaWxlLmNvbS9wYy9XUnZfSk9iOTYzVm1vbjJkQTlQY0lLV25GWVlnTWxIY2RGb2tYSGVESWNSNjV6Y0dDd0szVU1WbV8tMlI4S0xUWTBxNzNzQjJEeVFjZ21LVXhaRlF0dy5qcGc%253D%26sign%253Dyx_CIR6buct8Z.jpg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251027T090540Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=bd99ab2471fb6d0737834d5bc95950693c3710692db8591a10cc112416031d15",
            "albumType": 2,
            "albumKind": 1,
            "createTime": "2025-10-13T03:11:51.147Z",
            "updateTime": "2025-10-13T03:11:51.147Z",
            "albumOwnerId": "1765263620687613825"
        },
        {
            "id": "1784744274928137601",
            "name": "3333332",
            "coverImg": "https://obs-xxxx.myhuaweicloud.com/2dece6a7dbab49168a97f552e7e1395f086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27853ce32e95d7b7f07a1702b85b3f85a5_20250922_143618.jpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251027T090540Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=375a759de79bc0ac53c8880b9c7c88fb40c2d6494e711f161498a03ea70d3016",
            "albumType": 2,
            "albumKind": 1,
            "createTime": "2025-09-28T03:28:17.049Z",
            "updateTime": "2025-09-29T09:15:08.862Z",
            "albumOwnerId": "1765263620687613825"
        },
    ],
    "total": 2,
    "code": 0,
    "msg": "Success."
}

Status Codes

Status Code

Description

200

Album list response.
Parent topic: Album Management