查询存储桶列表

获取归档服务器上可用的存储桶列表。

请求 URL

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

请求参数

参数 是否必填 类型 说明
auth_info_id 是 Integer 归档服务器的 ID。
注： 可通过 查询归档服务器列表 接口查询该 ID。
bucket_info_type 是 Integer 要获取的存储类型。

取值范围:

  • 1：兼容 S3 的对象存储。
  • 2：Google Cloud Storage。
  • 3：Microsoft SharePoint。
bucket_name 否 String 存储桶的名称。
path_prefix 否 String 存储桶内的路径前缀。
site_id 否 String SharePoint 站点的 ID。
drive_id 否 String SharePoint 文档库的 ID。
path_id 否 String SharePoint 文件夹的 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
bucket_names Array<Bucket_Info> 存储桶列表。
file_paths Array<Bucket_Path_Info> 存储桶内的路径列表。
Bucket_Info
参数 类型 说明
id String
  • 对于兼容 S3 的对象存储或 Google Cloud Storage，表示存储桶的 ID。
  • 对于 Microsoft SharePoint，表示站点或文档库的 ID。
name String
  • 对于兼容 S3 的对象存储或 Google Cloud Storage，表示存储桶的名称。
  • 对于 Microsoft SharePoint，表示站点或文档库的名称。
Bucket_Path_Info
参数 类型 说明
id String 存储桶内路径的 ID。
path String 存储桶的路径。

示例

请求示例

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

Host: yeastardocs.example.yeastarcloud.com

响应示例

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
}