GetSpace - 查询空间信息--慢直播-火山引擎

文档中心

立即注册

导航

GetSpace - 查询空间信息

最近更新时间：2025.06.06 17:05:39首次发布时间：2021.11.25 17:12:51

查询指定空间的详细信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetSpace&Version=2021-01-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetSpace	要执行的操作，取值：GetSpace。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
SpaceID	String	是	2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx	需要查询的空间 ID，可通过调用 ListSpaces 接口获取。

返回参数

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

参数	类型	示例值	描述
SpaceName	String	spacename	空间名称
Description	String	space description	空间描述
SpaceID	String	spacexxxxuuid	空间 ID
Region	String	cn-north-1	服务区域： cn-qingdao-a（华北）
AccessType	String	rtmp	接入类型： rtmp gb28181
Status	String	enabled	空间状态： enabled：可用 disabled：已停用
GB	Object		当接入类型为 gb28181 时，返回数据；参考以下 GB 数据结构说明
HLSLowLatency	Boolean	false	是否已开启 HLS 低延迟： true：开启 false：关闭
CreatedAt	String	2023-10-01 10:10:09	空间创建时间
UpdatedAt	String	2023-10-01 10:10:09	空间更新时间
Domains	Object		空间域名，参考以下 SpaceDomain 数据结构说明
CallbackURL	String	http://callback_host/callback	回调地址
Template	Object		空间绑定的模板，参考以下 Template 数据结构说明
SipServer	Object		SIP 服务器信息，参考以下 SIP Server数据结构说明

请求示例

GET /?Action=GetSpace&Version=2021-01-01&SpaceID=2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20241219T071331Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/aiotvideo/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241219151335011041229096E5CEB8",
    "Action": "GetSpace",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "SpaceName": "GRcnn1g1FZL",
    "Description": "9omf9I",
    "SpaceID": "9ZoG8",
    "Region": "Q4BSI",
    "AccessType": "tw2v15",
    "Status": "hySki",
    "GB": {
      "PullOnDemand": true
    },
    "HLSLowLatency": true,
    "CreatedAt": "lgLBd",
    "UpdatedAt": "qxTIv",
    "Domains": {},
    "CallbackURL": "35CpT",
    "Template": {
      "Screenshot": {
        "TemplateID": "af991af9-fb07-4773-9ed1-c58e5b90a810",
        "TemplateName": "hyzsnap01",
        "BindTime": "2022-02-07T17:13:04+08:00"
      },
      "Record": {
        "TemplateID": "535aa5e6-3388-42e9-bd7d-a1ee6616040c",
        "TemplateName": "hyzrecord01",
        "BindTime": "2022-02-07T17:13:23+08:00"
      },
      "AI": {
        "TemplateID": "1c443146-8d6a-44d5-baf8-5efafc0e7275",
        "TemplateName": "car0121",
        "BindTime": "2022-02-07T17:12:39+08:00"
      }
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	MissingParameter	The required parameter %s is missing.
400	InvalidParameter	The specified parameter %s is invalid.
400	OperationDenied	Operation is denied because the specified resource is in use.
400	NotFound.SpaceDataService	The request is failed due to request data not found.