すべてのプロダクト
Search
ドキュメントセンター

Alibaba Cloud Linux:ListInstanceHealth

最終更新日:Sep 11, 2026

指定された時間範囲内のクラスターのノードまたは Pod のヘルスステータスリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sysom:ListInstanceHealth

list

*すべてのリソース。

*

なし なし

リクエスト構文

GET /api/v1/openapi/cluster_health/range/instance_health_list HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

cluster

string

任意

クラスターの ID。

2dc6f3be-bf24-4070-8d3a-c03c26850532

instance

string

任意

インスタンスの ID。

i-wz9d00ut2ska3mlyhn6j

start

number

必須

開始時刻。

1725797727754

end

number

必須

終了時刻。

1725801327754

current

integer

任意

現在のページ番号。

1

pageSize

integer

任意

ページサイズ。デフォルト値: 5。有効な値: 1 から 100。

10

レスポンスフィールド

フィールド

型

説明

例

object

応答のスキーマ。

code

string

状態コード。

  • code == Success の場合、権限付与は成功です。

  • その他の状態コードは、権限付与が失敗したことを示します。詳細なエラー情報については、message フィールドを確認してください。

SysomOpenAPI.ServerError

data

array<object>

返されるデータ。

object

応答データ。

images

array

Pod 内のコンテナイメージ名のリスト。

string

コンテナイメージ名。

alinux3:latest

instance

string

インスタンスの ID。

i-wz9d00ut2ska3mlyhn6j

namespace

string

Pod の名前空間。

default

pod

string

Pod 名。

test-pod

region_id

string

リージョンの ID。

cn-shanghai

score

number

ヘルススコア。

100

status

string

インスタンスの実行ステータス。有効な値:

  • Running: 実行中。

  • Offline: オフライン。

説明

オフラインステータスのインスタンスは、ノードと SysOM サーバー間のハートビートが失われていることを示します。これは、対応する ECS インスタンスが実行中ではないことを意味するものではありません。

Running

message

string

エラーメッセージ。

  • code == Success の場合、このフィールドは空です。

  • それ以外の場合、このフィールドにはリクエストのエラー情報が含まれます。

Query no data

request_id

string

リクエストの ID。

35F91AAB-5FDF-5A22-B211-C7C6B00817D0

total

integer

クエリ結果の総数。

42

例

成功レスポンス

JSONJSON

{
  "code": "SysomOpenAPI.ServerError",
  "data": [
    {
      "images": [
        "alinux3:latest"
      ],
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "namespace": "default",
      "pod": "test-pod",
      "region_id": "cn-shanghai",
      "score": 100,
      "status": "Running"
    }
  ],
  "message": "Query no data",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
  "total": 42
}

エラーコード

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

変更履歴

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