查询环境中的大盘信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
| Data |
object |
操作结果。 |
|
| Dashboards |
array<object> |
大盘列表。 |
|
|
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 |
integer |
返回结果的总项目数量。 |
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
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。