查看空间列表--慢直播-火山引擎

文档中心

立即注册

导航

查看空间列表

最近更新时间：2022.02.08 14:17:26首次发布时间：2021.11.25 17:12:51

查询已创建的空间列表信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListSpaces
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
Order	Query	Integer	否	查询结果排序方式	可选枚举值： 1（正序） -1（倒序，默认）

字段

位置

类型

必填

说明

值

Action

Query

String

是

公共参数，OpenAPI 接口名称

ListSpaces

Version

Query

String

是

公共参数，OpenAPI 接口版本

2021-01-01

Order

Query

Integer

否

查询结果排序方式

可选枚举值：

1（正序）
-1（倒序，默认）

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。
Result 字段包含以下参数：

字段	类型	说明
Spaces	Array of objects	查询到的空间列表，参考 `List<Spaces>` 数据结构说明

List<Spaces> 数据结构说明

Space 数据结构说明，参见查看空间信息接口的返回结果说明。

示例

请求示例

GET https://open.volcengineapi.com?Action=ListSpaces
&Version=2021-01-01
&Order=1
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022020720245001020209205006034FC6",
        "Action": "ListSpaces",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 10,
        "Spaces": [
            {
                "SpaceName": "HyzGB01",
                "Description": "New space",
                "SpaceID": "517ff7ec-7700-4862-b1e7-7967a492df79",
                "Region": "cn-qingdao-a",
                "AccessType": "gb28181",
                "Status": "enabled",
                "GB": {
                    "PullOnDemand": true
                },
                "HLSLowLatency": false,
                "CreatedAt": "2021-11-11T11:28:30+08:00",
                "UpdatedAt": "2021-12-04T15:52:13+08:00",
                "Domains": {
                    "prcldt8wxxxxxxx.pull.xxxxxxx.com": {
                        "Domain": "prcldt8wxxxxxxx.pull.xxxxxxx.com",
                        "Type": "fcdn-pull",
                        "Status": "enabled",
                        "CNAME": "prcldtxxxxxxxxxx.pull.xxxxxxx.com.c.xxxxxxxx.com",
                        "Default": true,
                        "Https": {
                            "Enable": false,
                            "CertificateID": ""
                        },
                        "CreatedAt": "2021-11-11T11:28:28+08:00",
                        "UpdatedAt": "",
                        "TimeFlag": false,
                        "MainKey": "",
                        "SpareKey": "",
                        "ValidDuration": 0
                    }
                },
                "SipServer": {
                    "SipId": "3402000000xxxxxxxxxx",
                    "SipDomain": "xx.xx.xxxx.xx",
                    "SipIp": "xx.xx.xxxx.xx",
                    "SipPort": {
                        "tcp": 0000,
                        "udp": 0000
                    }
                },
                "CallbackURL": "",
                "Template": {
                    "Screenshot": {
                        "TemplateID": "af991af9-fb07-4773-9ed1-c58e5b90a810",
                        "TemplateName": "",
                        "BindTime": "2022-02-07T17:13:04+08:00"
                    },
                    "Record": {
                        "TemplateID": "535aa5e6-3388-42e9-bd7d-a1ee6616040c",
                        "TemplateName": "",
                        "BindTime": "2022-02-07T17:13:23+08:00"
                    },
                    "AI": {
                        "TemplateID": "1c443146-8d6a-44d5-baf8-5efafc0e7275",
                        "TemplateName": "",
                        "BindTime": "2022-02-07T17:19:39+08:00"
                    }
                }
            }
            ...
            ...
        ]
    }
}