All Products
Search
Document Center

Drive and Photo Service:SearchDrive

Last Updated:Aug 04, 2025

Queries drives.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/drive/search HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request parameters.

drive_namestringNo

The drive name.

limitintegerNo

The maximum number of asynchronous tasks to return. Valid values: 1 to 100. Default value: 100.

100
markerstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of marker.
By default, this parameter is left empty.

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
ownerstringNo

The owner of the drive.

c9b7a5aa04d14ae3867fdc886fa01da4
owner_typestringNo

The type of the owner. Valid values:

user group

user

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

itemsarray

The information about the drives.

Drive

The information about a drive.

next_markerstring

A pagination token. It can be used in the next request to retrieve a new page of results. If next_marker is empty, no next page exists.

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

Examples

Sample success responses

JSONformat

{
  "items": [
    {
      "domain_id": "bj1",
      "drive_id": 1,
      "drive_name": "drv1",
      "description": "vipdrive",
      "owner": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "owner_type": "user",
      "drive_type": "normal",
      "status": "enabled",
      "used_size": 20480,
      "total_size": 204800,
      "created_at": "2019-08-20T06:51:27.292Z",
      "creator": "c9b7a5aa04d14ae3867fdc886fa01da4"
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}

Error codes

For a list of error codes, visit the Service error codes.