查詢儀錶盤。
介面說明
介面說明
請求文法中 Host 由 Project 名稱和Log Service Endpoint 構成,您需要在 Host 中指定 Project。
已建立並擷取 AccessKey。更多資訊,請參見存取金鑰。
阿里雲帳號 AccessKey 擁有所有 API 的存取權限,風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運。RAM 使用者需具備動作記錄服務資源的許可權。具體操作,請參見建立 RAM 使用者及授權。
已明確您查詢日誌所屬的 Project 名稱、所屬地區等。如何查詢,請參見管理 Project。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
log:ListDashboard |
list |
*Project
|
|
無 |
請求文法
GET /dashboards HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| project |
string |
是 |
Project 名稱。 |
ali-test-project |
| offset |
integer |
否 |
查詢開始行。預設值為 0。 |
0 |
| size |
integer |
否 |
分頁查詢時,設定的每頁行數。最大值為 500。預設值為 500。 |
10 |
| tags |
array<object> |
否 |
標籤資訊 |
|
|
object |
否 |
標籤。 |
||
| key |
string |
否 |
標籤鍵。 |
key1 |
| value |
string |
否 |
標籤值。 |
value1 |
| dashboardName |
string |
否 |
儀錶盤名稱。 |
dashboard-1609294922657-434834 |
| displayName |
string |
否 |
顯示名稱 |
test |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
儀錶盤。 |
||
| dashboards |
array |
儀錶盤的名字列表,對應 dashboardName。 |
|
|
string |
儀錶盤的名字列表,對應 dashboardName。 |
dashboard-1609294922657-434834 |
|
| dashboardItems |
array<object> |
儀錶盤。 |
|
|
object |
儀錶盤。 |
||
| dashboardName |
string |
儀錶盤 ID。同一個 Project 下,儀錶盤 ID 唯一,不可重複。支援模糊查詢,例如輸入 da,會查詢出所有以 da 開頭的儀錶盤。 |
dashboard-1609294922657-434834 |
| displayName |
string |
儀錶盤顯示名稱。 |
data-ingest |
| description |
string |
描述 |
tablet_ai |
樣本
正常返回樣本
JSON格式
{
"dashboards": [
"dashboard-1609294922657-434834"
],
"dashboardItems": [
{
"dashboardName": "dashboard-1609294922657-434834",
"displayName": "data-ingest",
"description": "tablet_ai"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。