You need to enable JavaScript to run this app.
导航

获取空间列表

最近更新时间2024.01.08 20:39:16

首次发布时间2022.06.21 14:21:36

此接口用于获取当前账号下所有空间的信息。

请求说明

请求地址:https://vod.volcengineapi.com?Action=ListSpace&Version=2021-01-01

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringListSpace接口名称。当前 API 的名称为 ListSpace
VersionString2021-01-01接口版本。当前 API 的版本为 2021-01-01
OffsetDouble2查询游标。
LimitDouble1查询数量。

返回参数

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

参数类型示例值描述
SpaceNameStringdoc-test点播空间名称。
RegionStringcn-north-1账号 ID 所属区域。
ProjectNameStringdefaultIAM 项目名称。
BucketNameStringtos-vod-cn-v-16fd9e8343bb****绑定的存储桶名称。

BucketStatus

String

configure_success

绑定的存储桶状态。取值如下:

  • configure_success: 配置成功。
  • configuring: 配置中。
  • configure_error: 配置失败。
DescriptionStringtest点播空间描述。
UserNameStringbyte_****空间创建者的用户名称。
CreatedAtString2023-01-03 18:09:31空间创建时间,UTC 时间,精确到秒。
TypeStringspace类型。当前取值仅为 space

请求示例

https://vod.volcengineapi.com?Action=ListSpace&Version=2021-01-01&Offset=YourOffset&Limit=YourLimit

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202301031826118C1479B6C99D48CC****",
    "Action": "ListSpace",
    "Version": "2021-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": [
    {
      "SpaceName": "doc-test",
      "Region": "cn-north-1",
      "ProjectName": "default",
      "BucketName": "tos-vod-cn-v-16fd9e8343bb****",
      "BucketStatus": "configure_success",
      "Description": "test",
      "UserName": "byte_****",
      "CreatedAt": "2023-01-03 18:09:31",
      "Type": "space"
    }
  ]
}

错误码

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

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: