Listing Album Files

Function

List album files.

URI

GET /koodrive/ose/v1/album/{albumId}/list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
albumId	Yes	String	Definition: Album ID. Constraints: Use the ID returned after an album is created. Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
pageSize	No	String	Definition: Number of pages. Constraints: N/A Range: [1,100] Default Value: 100
pageCursor	No	String	Definition: Start cursor. If this parameter is null, the query starts from the first page. Constraints: N/A Range: N/A Default Value: N/A
sortType	No	String	Definition: Sorting type. Constraints: N/A Range: 1: shooting time 2: creation time 3: update time Default Value: In a manual album, the creation time is sorted in descending order by default. In a collection album, the shooting time is sorted in descending order by default.
sortDirection	No	String	Definition: Sorting order. Constraints: N/A Range: 1: ascending 2: descending Default Value: 2

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-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
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-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: N/A Default Value If this parameter is not transferred, English (United States) is used by default.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
contentList	Array of AlbumContent objects	Contents.
nextPageCursor	String	Next query cursor.
total	Integer	Total number.

**Table 5** AlbumContent
Parameter	Type	Description
id	String	File ID.
takeTime	String	Shooting time, which is returned when an album is included.
ownerId	String	File owner.
fileName	String	File name.
mimeType	String	A standard for describing the content type, such as describing the property and format of a document, file, or byte stream.
fileType	String	File category.
fileSuffix	String	Suffix or extension.
parentFolder	Array of strings	Parent directory.
containers	Array of strings	Container ID.
createdTime	String	Creation time.
editedTime	String	Update time.
recycled	Boolean	Recycled or not.
contentUrl	String	Content URL.
thumbnailUrl	String	Thumbnail URL.
favorite	Boolean	Favorited or not.
addTime	String	Time when a photo is added to a manual album.
size	Long	File size.
creatingUser	String	Creator ID, which may be different from the creator of the family album.
adderUserId	String	ID of the person who adds an image, which is returned during manual album creation.

Example Requests

Request for querying an album content list.

/koodrive/ose/v1/album/1795607640592646273/list

pageSize=100&pageCursor=0&sortType=1&sortDirection=2

Example Responses

Status code: 200

Response to the request for querying an album content list.

{
    "contentList": [
        {
            "id": "FsZe6OnbZbVM0XcvEK_FDXqnow9P02vxT",
            "ownerId": "1765263620687613825",
            "fileName": "ims_kt=url&at=ori&key=aHR0cDovL2NpLnhpYW9ob25nc2h1LmNvbS9iODQwNjEzYS1mMzZiLTBlOWUtYzYzYi0xZWEwNmMyYmU2NWU_aW1hZ2VWaWV3Mi8yL3cvMTA4MC9mb3JtYXQvanBn&sign=yx_1vrJ0n2LhWeGrxWPaXNLuQvRJ-U=&tv=0_0.jpg",
            "mimeType": "image/jpeg",
            "fileType": "15",
            "fileSuffix": "jpg",
            "parentFolder": [
                "DGH956YIDkQArootIAACulBh_eemCA5EA1765263622625382272"
            ],
            "containers": [
                "IAACulBh_eemCA5EA1765263622625382272"
            ],
            "createdTime": "2025-09-16T01:31:20.654Z",
            "editedTime": "2025-09-16T01:31:22.219Z",
            "recycled": false,
            "contentUrl": "https://obs-xxx.myhuaweicloud.com/a0134878508b4ab2b1c96820dca2f31c086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27ims_kt%253Durl%26at%253Dori%26key%253DaHR0cDovL2NpLnhpYW9ob25nc2h1LmNvbS9iODQwNjEzYS1mMzZiLTBlOWUtYzYzYi0xZWEwNmMyYmU2NWU_aW1hZ2VWaWV3Mi8yL3cvMTA4MC9mb3JtYXQvanBn%26sign%253Dyx_1vrJ0n2LhWeGrxWPaXNLuQvRJ-U%253D%26tv%253D0_0.jpg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251027T091151Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=ea332f33588b46fe8a379ec04bbb9f9b02ddbbe0fbb794f5c3913b4e02f8bd09",
            "thumbnailUrl": "https://obs-xxx.myhuaweicloud.com/a0134878508b4ab2b1c96820dca2f31c086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27ims_kt%253Durl%26at%253Dori%26key%253DaHR0cDovL2NpLnhpYW9ob25nc2h1LmNvbS9iODQwNjEzYS1mMzZiLTBlOWUtYzYzYi0xZWEwNmMyYmU2NWU_aW1hZ2VWaWV3Mi8yL3cvMTA4MC9mb3JtYXQvanBn%26sign%253Dyx_1vrJ0n2LhWeGrxWPaXNLuQvRJ-U%253D%26tv%253D0_0.jpg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251027T091151Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=7b2a6a3eb60ab7ba5811c74b24fb450b806ac1541a3a5f0d09307d44ea505822",
            "favorite": false,
            "addTime": "2025-10-13T03:12:07.862Z",
            "size": 64492,
            "creatingUser": "1765263620687613825",
            "adderUserId": "1765263620687613825"
        },
        {
            "id": "Fg7cEpaAoh1ZmUxfCPlFEMpvIfUwiKxZW",
            "ownerId": "1765263620687613825",
            "fileName": "ms_kt=url&at=ori&key=aHR0cHM6Ly9xY2xvdWQuZHBmaWxlLmNvbS9wYy9XUnZfSk9iOTYzVm1vbjJkQTlQY0lLV25GWVlnTWxIY2RGb2tYSGVESWNSNjV6Y0dDd0szVU1WbV8tMlI4S0xUWTBxNzNzQjJEeVFjZ21LVXhaRlF0dy5qcGc=&sign=yx_CIR6buct8Z.jpg",
            "mimeType": "image/jpeg",
            "fileType": "15",
            "fileSuffix": "jpg",
            "parentFolder": [
                "DGH956YIDkQArootIAACulBh_eemCA5EA1765263622625382272"
            ],
            "containers": [
                "IAACulBh_eemCA5EA1765263622625382272"
            ],
            "createdTime": "2025-09-16T01:31:22.088Z",
            "editedTime": "2025-09-16T01:31:23.179Z",
            "recycled": false,
            "contentUrl": "https://obs-xxx.myhuaweicloud.com/96e9758b7db047fcbc327266c85f1bd7086?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=20251027T091151Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=9aae3b0102968f632be825e812a3a3d1131909bd0815dabf11eff4793a2d7d79",
            "thumbnailUrl": "https://obs-xxx.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=20251027T091151Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=HPUA8WFGVY35JSJDL1GV%2F20251027%2Fnorth-4%2Fs3%2Faws4_request&X-Amz-Signature=a1d6573d29dc63dbefa2709f24278b7557362732e529039265f2d81e70f4c94f",
            "favorite": false,
            "addTime": "2025-10-13T03:12:07.862Z",
            "size": 89088,
            "creatingUser": "1765263620687613825",
            "adderUserId": "1765263620687613825"
        },
    ],
    "total": 3,
    "code": 0,
    "msg": "Success."
}

Status Codes

Status Code	Description
200	Response to the request for querying an album content list.

Parent topic: Album Management

Previous topic: Viewing an Album

Next topic: Adding Album Content

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot