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

Operation description

Description

The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project name in the Host.
Create an AccessKey pair. For more information, see AccessKey pair.

An AccessKey pair for an Alibaba Cloud account has the permissions to call all API operations. This is a high-risk practice. We recommend that you create and use a RAM user to call API operations or perform routine O&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see Create and authorize a RAM user.

Identify the name and region of the project that contains the logs you want to query. For more information, see Manage projects.

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 line from which the query starts. The default value is 0.	0
size	integer	No	The number of entries to return on each page for a paged query. The maximum value is 500. The default value is 500.	10
tags	array<object>	No	The tag information.
	object	No	A 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 dashboard.
dashboards	array	A list of dashboard names. This corresponds to dashboardName.
	string	A list of dashboard names. This corresponds to dashboardName.	dashboard-1609294922657-434834
dashboardItems	array<object>	The dashboards.
	object	A dashboard.
dashboardName	string	The dashboard ID. The ID must be unique within a project. Fuzzy queries are supported. For example, if you enter da, all dashboards whose names start with da are returned.	dashboard-1609294922657-434834
displayName	string	The display name of the dashboard.	data-ingest
description	string	The description.	tablet_ai

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.