すべてのプロダクト
Search

このプロダクト

    :ListDashboard

    ドキュメントセンター

    :ListDashboard

    最終更新日:Dec 23, 2025

    ダッシュボードを照会します。

    操作説明

    API の説明

    • リクエスト構文において、Host はプロジェクト名と Simple Log Service (SLS) のエンドポイントで構成されます。Host にはプロジェクトを指定する必要があります。

    • AccessKey が作成済みであること。詳細については、「AccessKey」をご参照ください。

    Alibaba Cloud アカウントの AccessKey は、すべての API へのフルアクセスを許可するため、高いセキュリティリスクをもたらします。API アクセスや日常の O&M (運用保守) タスクには、Resource Access Management (RAM) ユーザーを作成して使用することを強く推奨します。RAM ユーザーには、SLS リソースを管理するための権限が必要です。詳細については、「RAM ユーザーの作成と権限付与」をご参照ください。

    • 照会したいログのプロジェクト名とリージョンがわかっていること。詳細については、「プロジェクトの管理」をご参照ください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    log:ListDashboard

    list

    *Project

    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*
    • log:TLSVersion
    		 なし

    リクエスト構文

    GET /dashboards HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    project

    string

    必須

    プロジェクト名。

    ali-test-project
    offset

    integer

    任意

    クエリの開始行。デフォルト値：0。

    0
    size

    integer

    任意

    ページングクエリにおける1ページあたりのエントリ数。最大値：500。デフォルト値：500。

    10
    tags

    array<object>

    任意

    object

    任意

    key

    string

    任意

    value

    string

    任意

    dashboardName

    string

    任意

    displayName

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ダッシュボード。

    dashboards

    array

    dashboardName に対応するダッシュボード名のリスト。

    string

    dashboardName に対応するダッシュボード名のリスト。

    dashboard-1609294922657-434834
    dashboardItems

    array<object>

    ダッシュボード。

    object

    ダッシュボード。

    dashboardName

    string

    ダッシュボード ID。ダッシュボード ID は同一プロジェクト内で一意であり、重複はできません。あいまいクエリがサポートされています。例えば、「da」と入力すると、名前が「da」で始まるすべてのダッシュボードが返されます。

    dashboard-1609294922657-434834
    displayName

    string

    ダッシュボードの表示名。

    data-ingest
    description

    string

    例

    成功レスポンス

    JSONJSON

    {
  "dashboards": [
    "dashboard-1609294922657-434834"
  ],
  "dashboardItems": [
    {
      "dashboardName": "dashboard-1609294922657-434834",
      "displayName": "data-ingest",
      "description": ""
    }
  ]
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。