查询已创建的空间列表信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListSpaces | 要执行的操作，取值：ListSpaces。 |
Version | String | 是 | 2021-01-01 | API的版本，取值：2021-01-01。 |
TagFilters.N.Key | Array of String | 否 | 1 | 查询过滤key数组条件 |
TagFilters.N.Values.N | Array of String | 否 | 1 | 过滤value条件数组 |
ProjectName | String | 否 | default | 项目名称 |
PageSize | String | 否 | 20 | 页面大小 |
PageNumber | String | 否 | 0 | 当前页面 |
Order | String | 否 | 1 | 查询结果排序方式，可选枚举值：
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Spaces | Array of Object | 查询到的空间列表，参考 |
GET https://open.volcengineapi.com?Action=ListSpaces&Version=2021-01-01&PageSize=20&PageNumber=0&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" } } } ... ... ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | MissingParameter | |
400 | InvalidParameter | |
400 | OperationDenied | |
400 | InvalidParameter.AccountService | |
500 | InternalError.AccountService |