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

ENS:DescribeARMServerInstances

最終更新日:Sep 08, 2026

ARM サーバーおよび AIC インスタンスの情報を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeARMServerInstances

list

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ServerIds

array

任意

サーバーインスタンス ID のリスト。

string

任意

サーバーインスタンス ID のリスト。

cas-インスタンス****

EnsRegionIds

array

任意

ENS エッジゾーン ID のリスト。

string

任意

ENS エッジゾーン ID のリスト。

cn-chengdu-telecom-4

PageNumber

integer

任意

クエリリストのページ番号。最小値: 1。

デフォルト値: 1。

1

PageSize

integer

任意

ページングクエリの 1 ページあたりのエントリ数。最大値: 100。

デフォルト値: 10。

10

MinDate

string

任意

クエリの開始時刻。フォーマット: "2006-01-02"。デフォルトでは、時間制限は適用されません。

2006-01-02

MaxDate

string

任意

クエリの終了時刻。フォーマット: "2006-01-02"。デフォルトでは、時間制限は適用されません。

2006-01-03

States

array

任意

操作状態のリスト。

string

任意

サーバーの操作状態。有効な値:

  • success: 成功。

  • failed: 失敗した。

  • creating: 作成中。

  • releasing: リリース中。

  • rebooting: 再起動中。

  • upgrading: アップグレード中。

success

AICSpecs

array

任意

コンテナスペックのリスト。

string

任意

コンテナのスペック。

aic.cf53r.c2.np

ServerSpecs

array

任意

サーバースペックのリスト。

string

任意

サーバーのスペック。

cas.cf53r

Name

string

任意

サーバー名。

サーバー名

Namespace

string

任意

名前空間。

デフォルト

Tags

array<object>

任意

タグのリスト。

object

任意

Key

string

任意

タグキー。

key-1

Value

string

任意

タグ値。

値-1

OrderByParams

string

任意

クエリ結果のソート方法。結果は、ServerIdSort (サーバー ID)、ServerNameSort (サーバー名)、ExpireTimeSort (有効期限)、CreationTimeSort (作成時間)、EnsRegionIdSort (エッジゾーン ID) のいずれか 1 つ以上のフィールドでソートできます。

有効な値: asc (昇順)、desc (降順)。

{"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"}

DescribeAICInstances

boolean

任意

クエリ結果にコンテナ情報を含めるかどうかを指定します。有効な値:

  • true: 含める。

  • false: 含めない。

true

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエスト ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF

Servers

array<object>

ARM サーバーおよび AIC インスタンス情報の配列。

array<object>

CreationTime

string

インスタンスが作成された時間。

2022-05-07 11:59:09

ExpiredTime

string

インスタンスの有効期限切れの時間。

2027-05-07 11:59:09

AICInstances

array<object>

AIC インスタンス情報の配列。

array<object>

Frequency

integer

AIC インスタンスの更新頻度。単位: Hz。

120

ImageId

string

AIC イメージの ID。

m-****

InstanceId

string

AIC インスタンスの ID。

aic-インスタンス****

NetworkAttributes

object

ネットワーク属性。

IpAddress

string

AIC インスタンスの IP アドレス。

192.168.XX.XX

NetworkId

string

AIC インスタンスのネットワークの ID。

n-*****

VSwitchId

string

AIC インスタンスの vSwitch の ID。

vsw-****

SdgDeployInfo

object

インスタンスにデプロイされている共有データグループ (SDG) 情報。

SDGId

string

SDG の ID。

sdg-xxxxx

Status

string

SDG の Deployment ステータス。有効な値:

  • sdg_deploying: Deployment 中。

  • failed: 失敗した。

  • success: Deployment 成功。

success

Resolution

string

AIC インスタンスの解像度。

1920*1080

Spec

string

AIC インスタンスのスペック。

aic.cf53r.c2.np

State

string

AIC インスタンスの操作状態。有効な値:

  • success: 成功。

  • failed: 失敗した。

  • creating: 作成中。

  • releasing: リリース中。

  • rebooting: 再起動中。

  • reseting: リセット中。

success

Status

string

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

  • running: 実行中。

  • pending: 保留中。

  • terminating: 終了中。

実行中

Name

string

コンテナ名。

AIC-Name

LatestAction

string

直近の操作。

ServerCreate

EnsRegionId

string

ENS エッジゾーンの ID。

cn-hanghzou-27

ServerId

string

サーバーの ID。

cas-******

SpecName

string

サーバーのスペック。

cas.cf53r

State

string

サーバーの操作状態。有効な値:

  • success: 成功。

  • failed: 失敗した。

  • creating: 作成中。

  • releasing: リリース中。

  • rebooting: 再起動中。

  • upgrading: アップグレード中。

success

Status

string

サーバーの実行ステータス。有効な値:

  • running: 実行中。

  • stopping: 停止中。

  • down: ダウン。

  • starting: 起動中。

実行中

Namespace

string

カードが属するクラスターの名前空間。

デフォルト

Name

string

サーバー名。

サーバー名

PayType

string

課金方法。

prepay

LatestAction

string

直近の操作。

ServerCreate

Tags

array<object>

タグのコレクション。

object

タグ。

Key

string

タグキー。

key-1

Value

string

タグ値。

値-1

PageNumber

integer

インスタンスリストのページ番号。

1

PageSize

integer

リクエストで指定された 1 ページあたりのエントリ数。

10

TotalCount

integer

返されるインスタンスの総数。

2

例

成功レスポンス

JSONJSON

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "Servers": [
    {
      "CreationTime": "2022-05-07 11:59:09",
      "ExpiredTime": "2027-05-07 11:59:09",
      "AICInstances": [
        {
          "Frequency": 120,
          "ImageId": "m-****",
          "InstanceId": "aic-instance****",
          "NetworkAttributes": {
            "IpAddress": "192.168.XX.XX",
            "NetworkId": "n-*****",
            "VSwitchId": "vsw-****"
          },
          "SdgDeployInfo": {
            "SDGId": "sdg-xxxxx",
            "Status": "success"
          },
          "Resolution": "1920*1080",
          "Spec": "aic.cf53r.c2.np",
          "State": "success",
          "Status": "running",
          "Name": "AIC-Name",
          "LatestAction": "ServerCreate"
        }
      ],
      "EnsRegionId": "cn-hanghzou-27",
      "ServerId": "cas-******",
      "SpecName": "cas.cf53r",
      "State": "success",
      "Status": "running",
      "Namespace": "default",
      "Name": "Server-Name",
      "PayType": "prepay",
      "LatestAction": "ServerCreate",
      "Tags": [
        {
          "Key": "key-1",
          "Value": "value-1"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Parameter.Invalid This service has not been activated.
400 Interface.Call.Error The interface call error
400 Interface.Call.Failed %s.
400 NoPermission Permission denied.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

変更履歴

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