すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:ListDashboards

    ドキュメントセンター

    Application Real-Time Monitoring Service:ListDashboards

    最終更新日:Apr 11, 2026

    Container Service for Kubernetes (ACK) クラスターの Grafana ダッシュボードをクエリします。

    操作説明

    なし。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    arms:ListDashboards

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-hangzhou
    ClusterId

    string

    任意

    ACK クラスターの ID。

    cc7a37ee31aea4ed1a059eff8034b****
    ClusterType

    string

    任意

    有効な値：ACK、ASK、cloud-product-prometheus、Node。クラスタータイプを指定することで、仮想クラスターのダッシュボードをクエリできます。InfluxDB の場合は、このパラメーターを cloud-product-prometheus に設定します。

    Node
    Language

    string

    任意

    返される Grafana ダッシュボードの言語。有効な値：en、zh。デフォルト値：en。

    en
    Title

    string

    任意

    ダッシュボードのタイトル。ダッシュボードのタイトルは変更可能です。DashboardName パラメーターを指定することを推奨します。

    ApiServer
    Product

    string

    任意

    クラウドサービスコード。このパラメーターは、ClusterType パラメーターを cloud-product-prometheus に設定した場合に必須です。利用可能なクラウドサービスは次のとおりです：Serverless App Engine、Microservices Engine、Message Queue for Apache RocketMQ、Lindorm、Message Queue for Apache Kafka、ApsaraDB for ClickHouse、Data Lake Analytics、Message Queue for RabbitMQ、ApsaraDB for MongoDB、Time Series Database (TSDB) for InfluxDB、MSE Cloud-native Gateway、Grafana Service、SchedulerX、Global Transaction Service、Enterprise Distributed Application Service、Machine Learning Platform for AI - Elastic Algorithm Service (EAS)、Application High Availability Service、Performance Testing。

    xxxx
    RecreateSwitch

    boolean

    任意

    仮想クラスターを作成するかクエリするかを指定します。このパラメーターは下位互換性を提供します。

    false
    DashboardName

    string

    任意

    ダッシュボードの一意の名前。名前を指定してダッシュボードをクエリできます。ダッシュボードのタイトルは変更できますが、ダッシュボード名は変更できません。複数の名前を指定し、コンマ (,) で区切ることができます。例：k8s-event,k8s-overview。ダッシュボードには複数のバージョンが存在する場合があります。バージョンを指定したい場合は、名前の後にバージョン情報を追加できます。例：k8s-event:v1,k8s-overview:latest。

    k8s-node-overview

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    2A0CEDF1-06FE-44AC-8E21-21A5BE65****
    DashboardVos

    array<object>

    Grafana ダッシュボードに関する情報。

    array<object>

    Grafana ダッシュボードに関する情報。

    Type

    string

    Grafana ダッシュボードのタイプ。有効な値：

    • dash-db：ダッシュボード

    • dash-folder：ダッシュボードを含むことができるフォルダー

    dash-db
    Time

    string

    Grafana ダッシュボードが作成された時刻。値はタイムスタンプです。単位：秒。

    1590136924
    NeedUpdate

    boolean

    Grafana ダッシュボードにアップグレード可能な新しいバージョンがあるかどうかを示します。

    false
    Kind

    string

    Grafana ダッシュボードのカテゴリ。有効な値：BASIC、THIRD、LIMIT、CUSTOM。

    BASIC
    Language

    string

    Grafana ダッシュボードの言語。

    en
    Url

    string

    Grafana ダッシュボードの完全な URL。

    http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s
    HttpsUrl

    string

    Grafana ダッシュボードの URL。

    http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s
    DashboardType

    string

    Grafana ダッシュボードのタイプ。このパラメーターは Exporter パラメーターと同じ効果を持ちますが、より明確な意味合いを提供します。

    Node
    Exporter

    string

    エクスポーターのアクセスソースのタイプ。有効な値：

    • Prometheus

    • Node

    • GPU

    • Redis

    • MySQL

    • Kafka

    • NGINX V2

    • Nginx

    • ZooKeeper

    • MongoDB

    • RabbitMQ

    • PostgreSQL

    • Kubernetes

    • Client Library

    • Elasticsearch

    • RocketMQ

    Nginx
    Version

    string

    Grafana ダッシュボードのバージョン。バージョンと名前の組み合わせでダッシュボードが一意に識別されます。

    v2
    IsArmsExporter

    boolean

    エクスポーターが Application Real-Time Monitoring Service (ARMS) によって提供されているかどうかを示します。

    • true：エクスポーターは ARMS によって提供されます。

    • false：エクスポーターは ARMS によって提供されていません。

    false
    HttpUrl

    string

    Grafana ダッシュボードの URL。

    http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s
    Title

    string

    Grafana ダッシュボードのタイトル。

    ApiServer
    Name

    string

    Grafana ダッシュボードの名前。このパラメーターは、変更できない点で Title パラメーターとは異なります。

    k8s-node-overview
    Id

    string

    Grafana ダッシュボードの ID。この値は、Grafana ダッシュボードをインストールしたときにのみ一意になります。

    1100**
    Uid

    string

    Grafana ダッシュボードの一意の識別子。

    1131971649496228-*****-59
    Tags

    array

    Grafana ダッシュボードのタグ。

    string

    Grafana ダッシュボードのタグ。

    ["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]
    I18nChild

    object

    Grafana ダッシュボードに関する情報。

    Type

    string

    Grafana ダッシュボードのタイプ。有効な値：

    • dash-db：ダッシュボード

    • dash-folder：ダッシュボードを含むことができるフォルダー

    dash-db
    Time

    string

    Grafana ダッシュボードが作成された時刻。値はタイムスタンプです。

    1590136924
    NeedUpdate

    boolean

    Grafana ダッシュボードにアップグレード可能な新しいバージョンがあるかどうかを示します。

    false
    Kind

    string

    Grafana ダッシュボードのカテゴリ。有効な値：BASIC、THIRD、LIMIT、CUSTOM。

    BASIC
    Language

    string

    Grafana ダッシュボードの言語。

    zh
    Url

    string

    Grafana ダッシュボードの完全な URL。

    http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s
    HttpsUrl

    string

    Grafana ダッシュボードの URL。

    http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s
    DashboardType

    string

    Grafana ダッシュボードのタイプ。このパラメーターは Exporter パラメーターと同じ効果を持ちますが、より明確な意味合いを提供します。

    Node
    Exporter

    string

    エクスポーターのアクセスソースのタイプ。有効な値：

    • Prometheus

    • Node

    • GPU

    • Redis

    • MySQL

    • Kafka

    • NGINX V2

    • Nginx

    • ZooKeeper

    • MongoDB

    • RabbitMQ

    • PostgreSQL

    • Kubernetes

    • Client Library

    • Elasticsearch

    • RocketMQ

    Nginx
    Version

    string

    Grafana ダッシュボードのバージョン。バージョンと名前の組み合わせでダッシュボードが一意に識別されます。

    v2
    IsArmsExporter

    boolean

    エクスポーターが ARMS によって提供されているかどうかを示します。

    • true：エクスポーターは ARMS によって提供されます。

    • false：エクスポーターは ARMS によって提供されていません。

    false
    HttpUrl

    string

    Grafana ダッシュボードの URL。

    http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s
    Title

    string

    Grafana ダッシュボードのタイトル。

    ApiServer
    Name

    string

    Grafana ダッシュボードの名前。このパラメーターは、変更できない点で Title パラメーターとは異なります。

    k8s-node-overview
    Id

    string

    Grafana ダッシュボードの ID。この値は、Grafana ダッシュボードをインストールしたときにのみ一意になります。

    1100**
    Uid

    string

    Grafana ダッシュボードの一意の識別子。

    1131971649496228-*****-59
    Tags

    array

    Grafana ダッシュボードのタグ。

    string

    Grafana ダッシュボードのタグ。

    ["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]
    PrometheusServiceOpened

    string

    Prometheus サービスを有効にするかどうか。

    true
    EnvironmentId

    string

    環境インスタンスの ID。

    env-ebd54733482581fc8c4237******
    GrafanaServiceOpened

    string

    Managed Service for Grafana が有効化されているかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "DashboardVos": [
    {
      "Type": "dash-db",
      "Time": "1590136924",
      "NeedUpdate": false,
      "Kind": "BASIC",
      "Language": "en",
      "Url": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "HttpsUrl": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "DashboardType": "Node",
      "Exporter": "Nginx",
      "Version": "v2",
      "IsArmsExporter": false,
      "HttpUrl": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
      "Title": "ApiServer",
      "Name": "k8s-node-overview",
      "Id": "1100**",
      "Uid": "1131971649496228-*****-59",
      "Tags": [
        "[\"arms-k8s\",\"ccc8ce1fe0c9543629e39ee657e34****\"]"
      ],
      "I18nChild": {
        "Type": "dash-db",
        "Time": "1590136924",
        "NeedUpdate": false,
        "Kind": "BASIC",
        "Language": "zh",
        "Url": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "HttpsUrl": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "DashboardType": "Node",
        "Exporter": "Nginx",
        "Version": "v2",
        "IsArmsExporter": false,
        "HttpUrl": "http://gnew.console.alibabacloud.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s",
        "Title": "ApiServer",
        "Name": "k8s-node-overview",
        "Id": "1100**",
        "Uid": "1131971649496228-*****-59",
        "Tags": [
          "[\"arms-k8s\",\"ccc8ce1fe0c9543629e39ee657e34****\"]"
        ]
      }
    }
  ],
  "PrometheusServiceOpened": "true",
  "EnvironmentId": "env-ebd54733482581fc8c4237******",
  "GrafanaServiceOpened": "true"
}

    エラーコード

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

    変更履歴

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