查詢環境中的大盤資訊。
調試
您可以在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
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。