文档首页/ 数据可视化 DLV/ API参考/ API/ 大屏管理接口/ 查询大屏列表
更新时间：2021-03-18 GMT+08:00
查看PDF
分享

查询大屏列表

功能介绍

获取大屏列表。

URI

  • URI格式 
    GET /v1/{project_id}/screens
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目编号，获取方法请参见获取项目ID。

请求消息

参数说明：如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

workspaceId

是

String

工作空间ID，长度为32个字符，获取方法请参见获取workspaceId。

响应消息

参数说明：如表3所示。

表3 响应参数

参数

参数类型

描述

screens

Array of screen objects

大屏列表。

maxScreenNuM

Integer

可创建大屏的最大个数。

currentNum

Integer

当前project下已创建的大屏个数。

domainScreenNum

Integer

当前region所有project已创建的大屏个数。
表4 screen

参数

参数类型

描述

id

String

大屏ID

name

String

大屏名称

alias

String

大屏别名

description

String

大屏的描述信息

status

Integer

大屏状态：0-created，1- deleted，2-shared

projectId

String

项目编号，即project_id

createUser

String

大屏的创建者

createDate

Integer

大屏的创建时间戳

updateUser

String

大屏的更新者

updateDate

Integer

大屏的更新时间戳

templateId

String

创建大屏时使用的模板ID

snapshotId

String

大屏快照的ID

share

String

大屏分享的UUID标识

thumbnail

String

大屏缩略图的访问地址

width

Integer

大屏的屏幕宽度，单位为像素

height

Integer

大屏的屏幕高度，单位为像素

password

String

大屏访问设置的密码

token

String

大屏访问设置的token

示例

  • 请求示例 
    GET https://{dlv_endpoint}/v1/{project_id}/screens
{请求消息头}

{
    "workspaceId": "86ce107974ce4f93b618acb232863027"
}

  • 成功响应示例 
    {
    "screens": [
        {
            "id": "ff80808167813a360167819d5b640045",
            "name": "screen_01",
            "alias": "test_screen_01",
            "description": null,
            "status": 2,
            "projectId": "abcdefghijk0123456",
            "createUser": "a1b2c2d3e4f5g6h5j6k6",
            "createDate": 1544067832676,
            "updateUser": null,
            "updateDate": 0,
            "templateId": "32546212564",
            "snapshotId": null,
            "share": "f7c9a336e6c74ca5883a60af882d92de",
            "thumbnail": null,
            "width": 1920,
            "height": 1080,
            "password": null,
            "token": null
        },
        {
            "id": "ff808081674bb2e401675002b5950120",
            "name": "Test_done",
            "alias": "",
            "description": null,
            "status": 2,
            "projectId": "abcdefghijk0123456",
            "createUser": "a1b2c2d3e4f5g6h5j6k6",
            "createDate": 1543235614101,
            "updateUser": "a1b2c2d3e4f5g6h5j6k6",
            "updateDate": 1543238083522,
            "templateId": "32546212564",
            "snapshotId": null,
            "share": "e3f93ab1474f43ff8e45ddaa90157d30",
            "thumbnail": null,
            "width": 1920,
            "height": 1080,
            "password": null,
            "token": null
        }

    ],
    "maxScreenNuM": 20,
    "currentNum": 2,
    "domainScreenNum": 2
}
  • 失败响应示例 
    {
    "errors": [
        {
            "error_code": "1004",
            "error_msg": "The operation with the resource entity occur some error."
        }
    ]
}

状态码

状态码请参见状态码。

父主题： 大屏管理接口

相关文档