Query Bucket List

Retrieve the list of storage buckets available on an archive server.

Request URL

GET {base_url}/{api_path}/archive_task/bucketnamelist?access_token={access_token}

Request parameters

Parameter Required Type Description
auth_info_id Yes Integer The ID of the archive server.
Note: You can obtain the ID using the Query Archive Server List interface.
bucket_info_type Yes Integer The type of storage to retrieve.

Valid value:

  • 1: S3-compatible object storage.
  • 2: Google Cloud Storage.
  • 3: Microsoft SharePoint.
bucket_name No String The name of the storage bucket.
path_prefix No String The path prefix within the bucket.
site_id No String The ID of the SharePoint site.
drive_id No String The ID of the SharePoint document library.
path_id No String The ID of the SharePoint folder.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
bucket_names Array<Bucket_Info> The list of storage buckets.
file_paths Array<Bucket_Path_Info> The list of paths within the bucket.
Bucket_Info
Parameter Type Description
id String
  • For S3-compatible object storage or Google Cloud Storage, this indicates the ID of the storage bucket.
  • For Microsoft SharePoint, this indicates the ID of the SharePoint or document library.
name String
  • For S3-compatible object storage or Google Cloud Storage, this indicates the name of the storage bucket.
  • For Microsoft SharePoint, this indicates the name of the SharePoint or document library.
Bucket_Path_Info
Parameter Type Description
id String The ID of the path within the bucket.
path String The path within the bucket.

Example

Request example

GET /openapi/v1.0/archive_task/bucketnamelist?access_token=EQ94dIauiuY6rjSxcIkoqqHTkPZDzqqR&auth_info_id=14&bucket_info_type=2 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "submsg": "",
    "bucket_names": [
        {
            "name": "756424455218-asia-east1-blueprint-config"
        },
        {
            "name": "756424455218-us-central1-blueprint-config"
        },
        {
            "name": "yeastar-pse-system"
        }
    ],
    "file_paths": null
}