You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/空间管理/获取空间详细信息
获取空间详细信息
最近更新时间：2024.06.20 11:26:49首次发布时间：2022.06.21 14:21:36
我的收藏

此接口用于设置 SpaceName 空间名称参数，获取空间详细信息，包含所属区域、具体空间描述以及空间创建时间等信息。

注意事项

前提条件：已完成CreateSpace。

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetSpaceDetail&Version=2022-01-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
是
GetSpaceDetail
接口名称。当前 API 的名称为 GetSpaceDetail。
Version
String
是
2022-01-01
接口版本。当前 API 的版本为 2022-01-01。
SpaceName
String
是
doc-test
点播空间名称。您可调用 ListSpace 接口获取当前账号下所有空间的名称。

返回参数

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

参数
类型
示例值
描述
SpaceName
String
doc-test
点播空间名称。
Region
String
cn-north-1
账号 ID 所属区域。
ProjectName
String
default
IAM 项目名称。
BucketName
String
tos-vod-cn-v-16fd9e8343bb****
绑定的存储桶名称。
BucketStatus
String
configure_success

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

  • configure_success: 配置成功。

  • configuring: 配置中。

  • configure_error: 配置失败。

Description
String
test
点播空间描述。
UserName
String
byte_****
空间创建者的用户名称。
CreatedAt
String
2023-01-03 18:09:31
空间创建时间，UTC 时间，精确到秒。
Type
String
space
类型。当前取值仅为 space。

请求示例

https://vod.volcengineapi.com?Action=GetSpaceDetail&Version=2022-01-01&SpaceName=doc-test

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230208112414D409533E40AD7B******",
    "Action": "GetSpaceDetail",
    "Version": "2022-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceName": "doc-test",
    "Region": "cn-north-1",
    "BucketName": "tos-vod-cn-v-16fd9e8343******",
    "BucketStatus": "configure_success",
    "Description": "test",
    "UserName": "byte_****",
    "CreatedAt": "2023-01-03 18:09:31",
    "Type": "space"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码错误码错误信息说明
400InvalidParameter.InvalidSpaceName-无效的 SpaceName。

服务端 SDK

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