文档首页/实时音视频 SparkRTC/API参考/OBS桶管理/查询OBS桶列表 - ListObsBuckets
更新时间：2025-11-04 GMT+08:00
查看PDF
分享

查询OBS桶列表 - ListObsBuckets

功能介绍

查询OBS桶列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v2/rtc-ops/buckets

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表2 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。

表3 响应Body参数

参数

参数类型

描述

count

Integer

桶的总数

buckets

Array of ObsBucket objects

桶信息

表4 ObsBucket

参数

参数类型

描述

bucket

String

OBS的bucket名称

location

String

OBS的bucket所在region

creation_date

String

创建时间，格式如：2020/07/16 15:11:55 GMT+08:00

is_authorized

Boolean

鉴权

状态码：400

表5 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表9 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号，以便任务跟踪。

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

获取OBS桶列表成功

{
  "count" : 1,
  "buckets" : [ {
    "bucket" : "rtctest"
  }, {
    "location" : "cn-north-4"
  }, {
    "creation_date" : "20230808112928"
  }, {
    "is_authorized" : true
  } ]
}

状态码：400

获取OBS桶列表失败

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

状态码：401

获取OBS桶列表失败，携带的X-Auth-Token错误

{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}

状态码：500

查询失败，服务器端错误

{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}

状态码

状态码

描述

200

获取OBS桶列表成功

400

获取OBS桶列表失败

401

获取OBS桶列表失败，携带的X-Auth-Token错误

500

查询失败，服务器端错误

错误码

请参见错误码。

父主题：OBS桶管理

相关文档