Статья создана

🚧 [Experimental] List bucket objects

Returns object paths from the cloud environment storage bucket, optionally filtered by prefix.

Request

POST

https://api.datalens.tech/rpc/listBucketObjects

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

application/json

{
  "cloudEnvironmentId": "example",
  "prefix": "example",
  "pageSize": 0,
  "pageToken": "example"
}

Name	Description
cloudEnvironmentId	Type: string ID of the cloud environment that owns the storage bucket. Min length: `1` Max length: `50` Example: `example`
pageSize	Type: integer Maximum number of objects to return. The default is 1000. Min value: `0` Max value: `1000`
pageToken	Type: string Token for the next page of objects. Example: `example`
prefix	Type: string Prefix used to filter object paths. Must not exceed 1024 UTF-8 bytes or contain control characters. Lists all objects when omitted. Example: `example`

Response

application/json

{
  "keys": [
    "example"
  ],
  "nextPageToken": "example"
}

Name

Description

keys

Type: string[]

Paths of objects matching the request.

Example

[
  "example"
]

nextPageToken

Type: string

Token for the next page of objects.

Example: example