GetDashboard - API Gateway - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Obtains data from dashboards.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
apig:GetDashboard	get	All Resources ``	none	none

Request syntax

GET /v1/gateways/{gatewayId}/dashboards HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The instance ID.	gw-co370icmjeu****
pluginClassId	string	No	The plug-in ID.	pls-dn82a9djd8z****
apiId	string	No	API ID	api-c9uuekzmia8q2****
source	string	No	The dashboard source. Valid values: SLS: Simple Log Service	SLS
name	string	No	The dashboard name. LOG: access logs PLUGIN: plug-in logs	PLUGIN
filter	object	No	The filter configurations.
routeName	string	No	The route name.	test-route
acceptLanguage	string	No	The language. Valid values: zh (Chinese) and en (English).	zh

Response parameters

Parameter	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
code	integer	The HTTP status code.	200
success	boolean	Indicates whether the request was successful.	true
errorCode	string	The error code.	Ok
message	string	The error message.	success
data	object	The data returned.
name	string	The dashboard name.	PLUGIN
title	string	The dashboard title.	APIG Plugin
url	string	The dashboard URL.	https://sls.console.alibabacloud.com/lognext/project/xxxxx
gatewayId	string	The instance ID.	gw-co370icmjeu****

Examples

Sample success responses

JSONformat

{
  "requestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "code": 200,
  "success": true,
  "errorCode": "Ok",
  "message": "success",
  "data": {
    "name": "PLUGIN",
    "title": "APIG Plugin",
    "url": "https://sls.console.alibabacloud.com/lognext/project/xxxxx",
    "gatewayId": "gw-co370icmjeu****"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-07-24	The request parameters of the API has changed	View Change Details
2025-03-31	The request parameters of the API has changed	View Change Details
2024-12-24	The request parameters of the API has changed	View Change Details