Call the ListDashboard API to query dashboards - Simple Log Service - Alibaba Cloud - Simple Log Service

Operation description

The Host in the request syntax consists of the Project name and the Simple Log Service endpoint. You must specify the Project in the Host.
An AccessKey pair has been created and obtained. For more information, see AccessKey pair.

An Alibaba Cloud account AccessKey pair has access permissions on all API operations, which poses high security risks. We strongly recommend that you create and use a Resource Access Management (RAM) user for API access or routine O&M. The RAM user must have permissions to operate Simple Log Service EPS resources. For more information, see Create a RAM user and authorization.

You have determined the name and region of the Project to which the logs you want to query belong. For information about how to query this information, see Manage a Project.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

log:ListDashboard

list

*Project

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*

log:TLSVersion

None

Request syntax

GET /dashboards HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The Project name.	ali-test-project
offset	integer	No	The row from which the query starts. Default value: 0.	0
size	integer	No	The number of rows per page in a paged query. Maximum value: 500. Default value: 500.	10
tags	array<object>	No	The tag information.
	object	No	The tag.
key	string	No	The tag key.	key1
value	string	No	The tag value.	value1
dashboardName	string	No	The dashboard name.	dashboard-1609294922657-434834
displayName	string	No	The display name.	test

Response elements

Element	Type	Description	Example
	object	The dashboards.
dashboardItems	array<object>	The dashboards.
	object	The dashboards.
dashboardName	string	The dashboard ID. The dashboard ID is unique within a Project and cannot be duplicated. Fuzzy match is supported. For example, if you enter da, all dashboards whose names start with da are returned.	dashboard-1609294922657-434834
description	string	The description.	tablet_ai
displayName	string	The display name of the dashboard.	data-ingest
dashboards	array	The list of dashboard names, corresponding to dashboardName.
	string	The list of dashboard names, corresponding to dashboardName.	dashboard-1609294922657-434834

Examples

Success response

JSON format

{
  "dashboardItems": [
    {
      "dashboardName": "dashboard-1609294922657-434834",
      "description": "tablet_ai",
      "displayName": "data-ingest"
    }
  ],
  "dashboards": [
    "dashboard-1609294922657-434834"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.