すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Linux:ListInstanceStatus

    ドキュメントセンター

    Alibaba Cloud Linux:ListInstanceStatus

    最終更新日:Sep 11, 2026

    インスタンスステータスを取得します。

    操作説明

    SysOM によって管理されるマシンのリストを取得します。

    今すぐお試しください

    この 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:ListInstanceStatus

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/am/instance/list_instance_status HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    current

    integer

    任意

    現在のページ番号 (1 から始まる)。ページネーションが使用される場合、このフィールドが存在します。

    1
    pageSize

    integer

    任意

    ページサイズ。デフォルト値: 10。

    10
    instance

    string

    任意

    インスタンスの ID。

    i-wz9b9vucz1iubsz355rh
    status

    string

    任意

    インスタンスリストをフィルターするために使用されるインスタンスステータス。このパラメーターを指定すると、指定されたステータスのインスタンスのみが返されます。

    列挙値:

    • Running :

      Running。

    • Offline :

      Offline。

    Running
    region

    string

    任意

    リージョン ID。

    cn-shenzhen

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエスト ID。エンドツーエンドの診断に使用できます。

    5BC79EF5-798B-5499-9683-4E14EBBBF712
    code

    string

    状態コード。

    • コード == Success は、権限付与が成功したことを示します。

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

    Success
    data

    array<object>

    返されるデータ。

    object

    返されるデータ。

    instance

    string

    インスタンスの ID。

    i-wz9d00ut2ska3mlyhn6j
    region

    string

    リージョン ID。

    cn-hangzhou
    status

    string

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

    • Running: インスタンスは実行中です。

    • Offline: インスタンスはオフラインです。

    説明

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

    Running
    message

    string

    エラーメッセージ。

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

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

    SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
    total

    integer

    エントリの総数。

    218

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "5BC79EF5-798B-5499-9683-4E14EBBBF712",
  "code": "Success",
  "data": [
    {
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "region": "cn-hangzhou",
      "status": "Running"
    }
  ],
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "total": 218
}

    エラーコード

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

    変更履歴

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