文档中心

获取服务商 Bucket

最近更新时间：2024.05.06 15:18:33

首次发布时间：2024.05.06 15:18:33

本接口支持通过指定云服务商和访问密钥获取迁移源 Bucket 详情。

注意事项

请求频率限制：单用户请求频率限制为 10 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetVendorBuckets&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetVendorBuckets`	接口名称。当前 API 的名称为 `GetVendorBuckets`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
Vendor	String	是	`OSS`	服务商。取值如下所示： `OSS`：阿里云 `COS`：腾讯云 `KODO`：七牛云 `BOS`：百度云 `OBS`：华为云 `Ucloud`：Ucloud file `AWS`：AWS 国际站 `S3`：其他 S3 协议存储 `URL`：以上传 URL 列表的方式迁移
Region	String	否	`cn-beijing`	Bucket 所在地区。仅当`Vendor` 非 `URL/OSS/KODO/AWS` 时为必填。
AK	String	是	`AKTP8shJDSYGbi8*****`	Access Key。是与 Secret Key 同时填写的，为了保证有访问源数据桶的权限。
SK	String	是	`PJDJSAJNNNCbE1E****`	Secret Key。是与 Access Key 同时填写的，为了保证有访问源数据桶的权限。
Endpoint	String	是	`https://s3.amazonaws.com`	S3 协议 Endpoint，需以`http://`或`https://`开头。仅当`Vendor`为`S3`时必填。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Buckets	Array of String	`["my-source-bucket-1", "my-source-bucket-2", "my-source-bucket-3"]`	bucket 列表

请求示例

POST https://imagex.volcengineapi.com/?Action=GetVendorBuckets&Version=2023-05-01
{
   "Vendor": "BOS",
   "AK": "8hdoh**80h",
   "SK": "GO8gjk***=="
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023061615574388A72E74B3D53A0B790E",
        "Action": "GetVendorBuckets",
        "Version": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    	  "Buckets": ["my-source-bucket-1", "my-source-bucket-2", "my-source-bucket-3"]  
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。