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

查询视图空间列表

最近更新时间2022.11.01 17:47:37

首次发布时间2022.11.01 17:47:37

查询已创建的视图空间的信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明

Action

Query

String

公共参数,OpenAPI 接口名称

ListStructuredViewSpaces

Version

Query

String

公共参数,OpenAPI 接口版本

2021-01-01

SpaceNameQueryString筛选条件,视图空间名称支持模糊搜索

Order

Query

Integer

查询结果排序方式

可选枚举值:

  • 1(正序)

  • -1(倒序,默认)

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
ViewSpaceListArray of objects查询到的视图空间列表,参考以下 List<ViewSpaceList> 数据结构说明

List<ViewSpaceList> 数据结构说明

字段
类型
说明
IDString视图空间 ID
SpaceNameString视图空间名称
ViewNumberInt接入数量
StoragePeriodInt存储周期(0 表示永久存储)

StorageType

String

存储方式:

  • 普通存储

Region

String

接入区域:

  • 华东

  • 北京

DescriptionString视图空间描述
SpaceCodeString视图空间编码
SpaceIPString视图空间 IP 地址
SpacePortInt视图空间端口号
CreateTimestampInt创建时间,Unix 时间戳,单位:秒
UpdateTimestampInt更新时间,Unix 时间戳,单位:秒

Status

String

视图空间状态:

  • 可用

  • 已停用

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022101910562801017425412602C18D4C",
        "Action": "ListStructuredViewSpaces",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "ViewSpaceList": [
            {
                "ID": "vs_4mygbj0idzxxxxxx",
                "SpaceName": "sec1'and(select+1)>0waitfor/**/delay'0:0:2",
                "ViewNumber": 0,
                "StoragePeriod": 0,
                "StorageType": "普通存储",
                "Region": "华东",
                "Description": "sec",
                "SpaceCode": "52568280885030xxxxxx",
                "SpaceIP": "10.xxx.xxx.xxx",
                "SpacePort": 8080,
                "CreateTimestamp": 1664457535,
                "UpdateTimestamp": 1664457535,
                "Status": "可用"
            },
            {
                "ID": "vs_ctnt9n0s07xxxxxx",
                "SpaceName": "sec1'and(select+1)>0waitfor/**/delay'0:0:0",
                "ViewNumber": 0,
                "StoragePeriod": 0,
                "StorageType": "普通存储",
                "Region": "华东",
                "Description": "sec",
                "SpaceCode": "52568280885030xxxxxx",
                "SpaceIP": "10.xxx.xxx.xxx",
                "SpacePort": 8080,
                "CreateTimestamp": 1664457535,
                "UpdateTimestamp": 1664457535,
                "Status": "可用"
            }
        ]
    }
}