- Service Overview
-
User Guide
- Preparatory Work
- Introducing the DLV Console
- How-Tos
- Managing Workspaces
- Creating Data Connections
- Creating Screens
- Developing Screens
- Managing Screens
- Managing Layers
-
Data Connection Management
-
Creating Data Connections
- Data Connection Overview
- Using Static Data Sources
- Creating API Data Connections
- Creating CSV File Data Connections
- Creating Object Storage Service Data Connections
- Creating Data Warehouse Service Data Connections
- Creating Data Lake Insight Data Connections
- Creating MRS Hive Data Connections
- Creating MRS SparkSQL Data Connections
- Creating ClickHouse Data Connections
- Creating RDS for MySQL Data Connections
- Creating RDS for PostgreSQL Data Connections
- Creating RDS for SQL Server Data Connections
- Creating RDS for GaussDB Data Connections
- Creating GeminiDB Influx API Data Connections
- Creating Cloud Search Service Data Connections
- Creating DDM Data Connections
- Creating Oracle Data Connections
- Creating MySQL Data Connections
- Creating PostgreSQL Data Connections
- Creating SQL Server Data Connections
- Creating Elasticsearch Data Connections
- Editing Data Connections
- Searching for Data Connections
- Deleting Data Connections
-
Creating Data Connections
- Managing Components
- Component Guide
- Screen Combination
- Integrating DLV into Third-Party Systems
- Change History
- Developer Guide
- API Reference
-
FAQs
- What Is DLV Used For?
- Regions and AZs
- Can I Quickly Create a DLV Screen Using a Template?
- Can DLV Connect to Data Sources Through APIs?
- What Types of Data Connections Are Supported in DLV?
- How Do I Configure a CSV Data Source?
- How Do I Use the Interaction Function?
- What Can I Do If a Component Cannot Be Completely or Normally Displayed?
- How Do I Query Data Formats Supported by Different Components?
- What Can I Do When the WebGL Component Breaks Down?
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Preparatory Work
- Introducing the DLV Console
- How-Tos
- Managing Workspaces
- Creating Data Connections
- Creating Screens
- Developing Screens
- Managing Screens
- Managing Layers
-
Data Connection Management
-
Creating Data Connections
- Data Connection Overview
- Using Static Data Sources
- Creating API Data Connections
- Creating API Gateway Data Connections
- Creating CSV File Data Connections
- Creating Object Storage Service Data Connections
- Creating Data Warehouse Service Data Connections
- Creating Data Lake Insight Data Connections
- Creating MRS Hive Data Connections
- Creating MRS SparkSQL Data Connections
- Creating ClickHouse Data Connections
- Creating RDS for MySQL Data Connections
- Creating RDS for PostgreSQL Data Connections
- Creating RDS for SQL Server Data Connections
- Creating RDS for GaussDB Data Connections
- Creating GeminiDB Influx API Data Connections
- Creating Cloud Search Service Data Connections
- Creating a DAYU Data Connection
- Creating DDM Data Connections
- Creating Oracle Data Connections
- Creating MySQL Data Connections
- Creating PostgreSQL Data Connections
- Creating SQL Server Data Connections
- Creating Elasticsearch Data Connections
- Editing Data Connections
- Searching for Data Connections
- Deleting Data Connections
- Managing VPC Connections
-
Creating Data Connections
- Managing Components
- Component Guide
- Screen Combination
- Integrating DLV into Third-Party Systems
-
FAQs
- What Is DLV?
- What Is DLV Used For?
- Regions and AZs
- How Many Screens Can I Create in DLV?
- Can I Quickly Create a DLV Screen Using a Template?
- Can DLV Connect to Data Sources Through APIs?
- What Types of Data Connections Are Supported in DLV?
- How Do I Configure a CSV Data Source?
- How Do I Use the Interaction Function?
- What Can I Do If a Component Cannot Be Completely or Normally Displayed?
- How Do I Query Data Formats Supported by Different Components?
- What Can I Do When the WebGL Component Breaks Down?
- API Reference (ME-Abu Dhabi Region)
- Developer Guide (ME-Abu Dhabi Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Obtaining a Screen List
Function
Obtain a screen list.
URI
- URI format
GET /v1/{project_id}/screens
- Parameter description
Table 1 URI parameter description Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workspaceId |
Yes |
String |
Workspace ID, which consists of 32 characters. For details about how to obtain the workspace ID, see Obtaining a Workspace ID. |
Response
Table 3 describes the response parameters.
Parameter |
Type |
Description |
---|---|---|
screens |
Array of screen objects |
Screen list. |
maxScreenNuM |
Integer |
The maximum number of the screens that can be created. |
currentNum |
Integer |
Number of screens created in the current project. |
domainScreenNum |
Integer |
Number of screens created for all projects in the current region. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the screen. |
name |
String |
Name of the screen. |
alias |
String |
Alias of the screen. |
description |
String |
Description of the screen. |
status |
Integer |
Status of the screen: 0-created, 1-deleted, 2-shared |
projectId |
String |
ID of the project. |
createUser |
String |
Creator of the screen. |
createDate |
Integer |
Timestamp for creating the screen. |
updateUser |
String |
User who updates the screen. |
updateDate |
Integer |
Timestamp for updating the screen. |
templateId |
String |
ID of the template used for creating the screen. |
snapshotId |
String |
ID of the screen snapshot. |
share |
String |
UUID for sharing the screen. |
thumbnail |
String |
URL for accessing the screen thumbnail. |
width |
Integer |
Screen width in units of pixels. |
height |
Integer |
Screen height in units of pixels. |
password |
String |
Password for accessing the screen |
token |
String |
Token for accessing the screen. |
Examples
- Request example
GET https://{dlv_endpoint}/v1/{project_id}/screens Request header { "workspaceId": "86ce107974ce4f93b618acb232863027" }
- Example of a successful response
{ "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 }
- Example of a failed response
{ "errors": [ { "error_code": "1004", "error_msg": "The operation with the resource entity occur some error." } ] }
Status Codes
For details about status codes, see Status Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot