GetDashboard - Simple Log Service - Alibaba Cloud Documentation Center

Queries a dashboard.

Operation description

Usage notes

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
log:GetDashboard	get	Project acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}	log:TLSVersion	none

Request syntax

GET /dashboards/{dashboardName} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
dashboardName	string	Yes	The name of the dashboard.	dashboard-1609294922657-434834

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Length	string	The length of the response body.	0
Connection	string	Indicates whether the connection is persistent. Valid values: close: The connection is non-persistent. A new TCP connection is established for each HTTP request. keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
	dashboard	The data structure of the dashboard.

Examples

Sample success responses

JSONformat

{
  "dashboardName": "dashboard-1609294922657-434834",
  "displayName": "test-alert",
  "description": "",
  "attribute": {
    "key": ""
  },
  "charts": [
    {
      "title": "my-chart",
      "type": "linepro",
      "search": {
        "test": "test",
        "test2": 1
      },
      "display": {
        "test": "test",
        "test2": 1
      },
      "action": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history