ListDashboardsByName - Application Real-Time Monitoring Service

Uses Loki data sources and other data sources to create a dashboard in Prometheus Service.

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
arms:ListDashboardsByName	none	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
ClusterId	string	No	The ID of the cluster. If the ClusterType parameter is not set to `cloud-product-prometheus` or `cms-enterprise-prometheus`, you must specify the ClusterId parameter.	cc7a37ee31aea4ed1a059eff8034b****
DataSourceType	string	No	The type of the data source. Valid values: loki prometheus	loki
ClusterType	string	No	The cluster type. Valid values: vpc-prometheus cloud-product-prometheus cms-enterprise-prometheus ExternalKubernetes Ask Kubernetes ManagedKubernetes remote-write-prometheus GlobalViewV2	cloud-product-prometheus
ProductCode	string	No	The abbreviation of the Alibaba Cloud service name.	edas
GroupName	string	No	The name of the dashboard group.	EDAS
DashBoardName	string	No	The name of the dashboard.	edas-ingress-url
DashBoardVersion	string	No	The version of the dashboard.	latest
OnlyQuery	boolean	No	Specifies whether to display the Grafana dashboard only in the Application Real-Time Monitoring Service (ARMS) console.	true

Response parameters

Parameter	Type	Description	Example
	object	The content of the response.
Data	string	The returned struct.	[{"name":"Edas Ingress Url Analysis","type":"edas-ingress-url-analysis","url":"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou"}]
RequestId	string	The ID of the request, You can use the ID to locate logs and troubleshoot issues.	2983BEF7-4A0D-47A2-94A2-8E9C5E63****
Code	integer	Status Code. Description 200 indicates success.	200
Message	string	Returns a hint message for the result.	success

Examples

Sample success responses

JSONformat

{
  "Data": "[{\"name\":\"Edas Ingress Url Analysis\",\"type\":\"edas-ingress-url-analysis\",\"url\":\"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou\"}]",
  "RequestId": "2983BEF7-4A0D-47A2-94A2-8E9C5E63****",
  "Code": 200,
  "Message": "success"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-03-20	The response structure of the API has changed	View Change Details