文档首页/视频接入服务 VIS/API参考/obs桶策略管理/获取桶信息列表
更新时间：2022-07-29 GMT+08:00
查看PDF
分享

获取桶信息列表

功能介绍

此接口用于用户获取桶信息列表，桶信息中包含两个字段，分别是桶名称和桶授权信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/buckets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询的开始位置，取值范围为0～100000，默认值为0。如果offset超过数据总条数，则结果返回空列表。

limit

否

Integer

返回结果的最大条目数，取值范围为1～100，默认值为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

普通租户的token。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

桶列表总数

buckets

PolicyResponseList object

桶列表信息

表5 PolicyResponseList

参数

参数类型

描述

bucket

String

桶名称

authorized

Boolean

桶授权信息，表示桶是否已经进行了授权

请求示例

GET /v1/0572be6bdf80d4ad2f0******/buckets

响应示例

状态码： 200

正常

{
  "count" : 30,
  "buckets" : [ {
    "bucket" : "bucketName1",
    "authorized" : true
  }, {
    "bucket" : "bucketName2",
    "authorized" : false
  } ]
}

状态码： 400

请求错误。具体返回错误码请参考错误码说明

{
  "error_msg" : "Invalid request parameter, limit should be in range [1, 100].",
  "error_code" : "VIS.0005"
}

状态码

状态码

描述

200

正常

400

请求错误。具体返回错误码请参考错误码说明

父主题：obs桶策略管理

相关文档