文档首页 > > API参考> API> 大屏管理接口> 查询大屏列表

查询大屏列表

分享
更新时间: 2019/09/25 GMT+08:00

功能介绍

获取大屏列表。

URI

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

    参数

    是否必选

    参数类型

    描述

    project_id

    String

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

请求消息

参数说明:无

响应消息

参数说明:如表2所示。

表2 响应参数

参数

参数类型

描述

screens

Array of screen objects

大屏列表。

maxScreenNuM

Integer

可创建大屏的最大个数。

currentNum

Integer

已创建的大屏个数。

表3 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

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

示例

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

  • 成功响应示例
    {
        "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
            },
            {
                "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
            }
    
        ],
        "maxScreenNuM": 20,
        "currentNum": 2
    }
  • 失败响应示例
    {
        "errors": [
            {
                "error_code": "1004",
                "error_msg": "The operation with the resource entity occur some error."
            }
        ]
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区