ListEnvironmentDashboards - 查询环境中的大盘信息_应用实时监控服务(ARMS)-阿里云帮助中心

查询环境中的大盘信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListEnvironmentDashboards	Write	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	无	无

请求参数

名称	类型	必填	描述	示例值
EnvironmentId	string	是	环境 ID。	env-xxx
RegionId	string	否	地域 ID。	cn-hangzhou
AddonName	string	否	Addon 的名称，AddonName 和 Scene 必填一个。	trace-java
Scene	string	否	Addon 的场景，AddonName 和 Scene 必填一个。	database

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	Id of the request	A5EC8221-08F2-4C95-9AF1-49FD998C647A
Code	integer	状态码。200 表示成功。	200
Message	string	返回结果的提示信息。	message
Success	boolean	查询是否成功： true：成功。 false：失败。	true
Data	object	操作结果。
Dashboards	object []	大盘列表。
FolderUid	string	文件夹 UID。	1374923841627893
Region	string	地域。	cn-hongkong
Tags	array	关键字。
	string	标签。	k8s
Title	string	Grafana 大盘标题。	kafka-instance
Uid	string	安装多个 Grafana 大盘时的大盘唯一标识符，是展示在页面上的唯一业务 ID。	1537863211936042
Url	string	Grafana 大盘的完整 URL。	http://xxx
Total	long	返回结果的总项目数量。	1

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。