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

文档中心

立即注册

导航

查询视图空间信息

最近更新时间：2022.11.01 17:47:37首次发布时间：2022.11.01 17:47:37

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

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetStructuredViewSpace
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	视图空间 ID	可通过调用 ListStructuredViewSpaces 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
ID	String	视图空间 ID
SpaceName	String	视图空间名称
ViewNumber	Int	接入数量
StoragePeriod	Int	存储周期（0 表示永久存储）
StorageType	String	存储方式：普通存储
Region	String	接入区域：华东北京
Description	String	视图空间描述
SpaceCode	String	视图空间编码
SpaceIP	String	视图空间 IP 地址
SpacePort	Int	视图空间端口号
CreateTimestamp	Int	创建时间，Unix 时间戳，单位：秒
UpdateTimestamp	Int	更新时间，Unix 时间戳，单位：秒
Status	String	视图空间状态：可用已停用

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022101915190701017424420903EE8671",
        "Action": "GetStructuredViewSpace",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "vs_1ck3kvr4hpxxxxxx",
        "SpaceName": "sec1'/**/and/**/DBMS_PIPE.RECEIVE_MESSAGE('u',2)='u",
        "ViewNumber": 82,
        "StoragePeriod": 0,
        "StorageType": "普通存储",
        "Region": "华东",
        "Description": "sec",
        "SpaceCode": "52568280885030xxxxxx",
        "SpaceIP": "10.xxx.xxx.xxx",
        "SpacePort": 8080,
        "CreateTimestamp": 1664457536,
        "UpdateTimestamp": 1664457536,
        "Status": "可用"
    }
}