ListEnvironmentDashboards - Application Real-Time Monitoring Service

Queries information about a dashboard of an environment instance.

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:ListEnvironmentDashboards	none	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
EnvironmentId	string	Yes	The ID of the environment instance.	env-xxx
RegionId	string	No	The region ID of the instance.	cn-hangzhou
AddonName	string	No	Name of Addon,One of AddonName and Scene must be filled in.	trace-java
Scene	string	No	The scenario of Addon. Either AddonName or Scene is required.	database

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	Id of the request	A5EC8221-08F2-4C95-9AF1-49FD998C647A
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	message
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Data	object	The result of the operation.
Dashboards	array<object>	The dashboards.
dashboards	object	Dashboard details.
FolderUid	string	The UID of the folder.	1374923841627893
Region	string	The region ID.	cn-hangzhou
Tags	array	The keyword.
tags	string	The tags.	k8s
Title	string	The title of the Grafana dashboard.	kafka-instance
Uid	string	The unique identifier of the dashboard.	1537863211936042
Url	string	The complete URL of the dashboard.	http://xxx
Total	long	The total number of entries returned.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "A5EC8221-08F2-4C95-9AF1-49FD998C647A",
  "Code": 200,
  "Message": "message",
  "Success": true,
  "Data": {
    "Dashboards": [
      {
        "FolderUid": "1374923841627893",
        "Region": "cn-hangzhou",
        "Tags": [
          "k8s"
        ],
        "Title": "kafka-instance",
        "Uid": "1537863211936042",
        "Url": "http://xxx"
      }
    ],
    "Total": 1
  }
}

Error codes

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