ListInstances - Simple Application Server - Alibaba Cloud ドキュメントセンター

指定されたリージョンの 1 つ以上のシンプルアプリケーションサーバーインスタンスの詳細を照会します。

操作説明

指定されたリージョンの 1 つ以上のシンプルアプリケーションサーバーインスタンスの詳細（サーバー名、パブリック IP アドレス、非公開 IP アドレス、作成時間、有効期限など）を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:ListInstances

get

Instance

acs:swas-open:{#regionId}:{#accountId}:instance/*

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	シンプルアプリケーションサーバーのリージョン ID。	cn-hangzhou
InstanceIds	string	任意	シンプルアプリケーションサーバーのインスタンス ID。値は、最大 100 個のインスタンス ID で構成される JSON 配列にできます。複数の ID はコンマ (,) で区切ります。説明 `InstanceIds` と `PublicIpAddresses` の両方を指定する場合、インスタンス ID とパブリック IP アドレスは同じシンプルアプリケーションサーバーに属している必要があります。そうでない場合、空の結果が返されます。	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]
ChargeType	string	任意	インスタンスの課金方法。有効な値: PrePaid。サブスクリプションのみサポートされています。デフォルト値: PrePaid。	PrePaid
PublicIpAddresses	string	任意	シンプルアプリケーションサーバーのパブリック IP アドレス。値は、最大 100 個のパブリック IP アドレスで構成される JSON 配列にできます。複数のアドレスはコンマ (,) で区切ります。説明 `InstanceIds` と `PublicIpAddresses` の両方を指定する場合、インスタンス ID とパブリック IP アドレスは同じシンプルアプリケーションサーバーに属している必要があります。そうでない場合、空の結果が返されます。	["42.1..", "42.2.."]
PageNumber	integer	任意	シンプルアプリケーションサーバーリストのページ番号。デフォルト値: 1	1
PageSize	integer	任意	ページング用の 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 10	10
Status	string	任意	インスタンスステータス。有効な値: Pending: 準備中。 Starting: 起動中。 Running: 実行中。 Stopping: 停止中。 Stopped: 停止済み。 Resetting: リセット中。 Upgrading: アップグレード中。 Disabled: 利用不可。	Running
Tag	array<object>	任意	インスタンスのタグ。
	object	任意	タグ。
Key	string	任意	インスタンスのタグキー。タグキーの長さは 1～64 文字である必要があります。N の有効な値: 1～20。	TestKey
Value	string	任意	インスタンスのタグ値。タグ値の長さは 1～64 文字である必要があります。N の有効な値: 1～20。	TestValue
ResourceGroupId	string	任意	シンプルアプリケーションサーバーのリソースグループ ID。	rg-aek2bti7cf7****
InstanceName	string	任意	シンプルアプリケーションサーバーインスタンスの名前。あいまい一致のためにワイルドカード文字 (*) がサポートされています。	test
PlanType	string	任意	プランタイプ。有効な値: NORMAL: 汎用。 CAPACITY: ストレージ最適化。 PREVIOUS: 旧世代。 MULTI_IP: 複数パブリック IP アドレス。 INTERNATIONAL: 国際版。説明詳細については、「インスタンスファミリー」を参照してください。	NORMAL

レスポンスフィールド

フィールド	型	説明	例
	object	インスタンス情報。
Instances	array<object>	シンプルアプリケーションサーバー情報の配列。
	array<object>	シンプルアプリケーションサーバー情報の配列。
Status	string	インスタンスステータス。有効な値: Pending: 準備中。 Starting: 起動中。 Running: 実行中。 Stopping: 停止中。 Stopped: 停止済み。 Resetting: リセット中。 Upgrading: アップグレード中。 Disabled: 利用不可。	Running
CreationTime	string	作成時間。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットに従います。時間は協定世界時 (UTC)+0 で表示されます。	2021-03-08T05:31:06Z
InnerIpAddress	string	非公開 IP アドレス。	172.26.XX.XX
ChargeType	string	課金方法。	PrePaid
InstanceId	string	インスタンス ID。	2ad1ae67295445f598017499dc****
PlanId	string	プラン ID。	swas.s2.c2m2s50b4t08
PublicIpAddress	string	パブリック IP アドレス。	42.1.XX.XX
RegionId	string	リージョン ID。	cn-hangzhou
ExpiredTime	string	有効期限。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ フォーマットに従います。時間は協定世界時 (UTC)+0 で表示されます。	2021-05-08T16:00:00Z
InstanceName	string	サーバー名。	test-InstanceName
BusinessStatus	string	サーバーステータス。有効な値: Normal: 法線。 Expired: 期限切れ。 Overdue: 支払い遅延。	Normal
DdosStatus	string	DDoS 攻撃ステータス。有効な値: Normal: 法線。 BlackHole: ブラックホールフィルタリングステータス。 Defense: トラフィックスクラブステータス。	Normal
ImageId	string	イメージ ID。	fe9c66133a9d4688872869726b52****
DisableReason	string	リソースが無効になっている理由。有効な値: FINANCIAL: 支払い遅延によるロック済み。 SECURITY: セキュリティ上の理由によるロック済み。 EXPIRED: インスタンスの有効期限切れ。	EXPIRED
Combination	boolean	インスタンスがコンビネーションプランを使用しているかどうかを示します。	false
CombinationInstanceId	string	コンビネーションプランのインスタンス ID。	com-f6c9a22****45b5b8de68ad608af1ba
Uuid	string	インスタンスの UUID。	41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec	object	リソース仕様。
DiskCategory	string	ディスクタイプです。有効な値： ESSD：パフォーマンスレベル (PL) 0 のエンハンスト SSD (ESSD)。 SSD：標準 SSD。 CLOUD_EFFICIENCY：Ultra ディスク。	ESSD
Cpu	integer	vCPU 数です。	2
Bandwidth	integer	帯域幅です。単位：Mbit/s。	200
DiskSize	integer	ディスクサイズです。単位：GiB。	60
Memory	number	メモリサイズです。単位：GiB。	2
Flow	number	データ転送クォータです。値が 0 の場合、インスタンスは帯域幅ベースです。 0 以外の値の場合、インスタンスはデータ転送プランベースです。	818
Image	object	イメージ情報。
OsType	string	OS タイプです。	windows
ImageName	string	イメージ名です。	test-custom-1686536882356
ImageVersion	string	イメージバージョンです。	V3.5
ImageType	string	イメージタイプです。有効な値： system：OS イメージ。 app：アプリケーションイメージ。 custom：カスタムイメージ。	system
ImageIconUrl	string	イメージアイコンの URL です。	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	イメージプロバイダーです。	https://selfs****e.console.aliyun.com/ticket/createIndex
Tags	array<object>	インスタンスのタグ。
	object	タグ。
Key	string	タグのキーです。	TestKey
Value	string	タグの値です。	TestValue
Disks	array<object>	シンプルアプリケーションサーバーのディスク情報配列。
	array<object>	ディスク情報。
CreationTime	string	インスタンスの作成時刻です。時刻は ISO 8601 標準（yyyy-MM-ddTHH:mm:ssZ 形式）に従い、UTC 表示となります。	2023-02-24T02:20:10Z
Status	string	ディスクのステータスです。有効な値： ReIniting：ディスクの初期化中です。 Creating：ディスクの作成中です。 In_use：ディスクは使用中です。 Available：ディスクはマウント可能状態です。 Attaching：ディスクのアタッチ中です。 Detaching：ディスクのデタッチ中です。	In_use
Device	string	サーバー内でのディスクのデバイス名です。	/dev/xvda
Size	integer	ディスクサイズです。単位：GiB。	50
DiskName	string	ディスク名です。	SystemDisk
DiskChargeType	string	ディスクの課金方法です。	PrePaid
DiskType	string	ディスクタイプです。有効な値： system：システムディスク。 data：データディスク。	system
Category	string	ディスクタイプです。有効な値： ESSD：パフォーマンスレベル (PL) 0 のエンハンスト SSD (ESSD)。 SSD：標準 SSD。 CLOUD_EFFICIENCY：Ultra ディスク。	ESSD
DiskId	string	ディスク ID です。	d-bp14wq0149cpp2x****
RegionId	string	リージョン ID です。	cn-hangzhou
Remark	string	ディスクの備考です。	remark
DiskTags	array<object>	ディスクのタグです。
	object	タグ情報です。
Key	string	タグキーです。	TestKey
Value	string	タグ値です。	TestValue
ResourceGroupId	string	ディスクが属するリソースグループの ID です。	rg-aek2bti7cf7****
ResourceGroupId	string	インスタンスのリソースグループ ID。	rg-aekz7jmhg5s****
NetworkAttributes	array<object>	ネットワーク情報。
	object	ネットワーク情報。
PublicIpAddress	string	パブリック IP アドレスです。	116.62.XX.XX
PrivateIpAddress	string	プライベート IP アドレスです。	72.25.XX.XX
PeakBandwidth	integer	パブリックネットワークのピーク帯域幅です。単位：Mbit/s。	200
PublicIpDdosStatus	string	パブリック IP アドレスの DDoS 対策ステータスです。	normal
PlanType	string	プランタイプ。有効な値: NORMAL: 汎用。 CAPACITY: ストレージ最適化。 PREVIOUS: 旧世代。 MULTI_IP: 複数パブリック IP アドレス。 INTERNATIONAL: 国際版。説明詳細については、「インスタンスファミリー」を参照してください。	NORMAL
CommodityCode	string
TotalCount	integer	返されたインスタンスの総数。	1
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4F****
PageSize	integer	ページング用の 1 ページあたりのエントリ数。	10
PageNumber	integer	シンプルアプリケーションサーバーリストのページ番号。	1

例

成功レスポンス

JSONJSON

{
  "Instances": [
    {
      "Status": "Running",
      "CreationTime": "2021-03-08T05:31:06Z",
      "InnerIpAddress": "172.26.XX.XX",
      "ChargeType": "PrePaid",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "PlanId": "swas.s2.c2m2s50b4t08",
      "PublicIpAddress": "42.1.XX.XX",
      "RegionId": "cn-hangzhou",
      "ExpiredTime": "2021-05-08T16:00:00Z",
      "InstanceName": "test-InstanceName",
      "BusinessStatus": "Normal",
      "DdosStatus": "Normal",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "DisableReason": "EXPIRED",
      "Combination": false,
      "CombinationInstanceId": "com-f6c9a22****45b5b8de68ad608af1ba",
      "Uuid": "41f30524-5df7-49c9-9c6e-32****489001",
      "ResourceSpec": {
        "DiskCategory": "ESSD",
        "Cpu": 2,
        "Bandwidth": 200,
        "DiskSize": 60,
        "Memory": 2,
        "Flow": 818
      },
      "Image": {
        "OsType": "windows",
        "ImageName": "test-custom-1686536882356",
        "ImageVersion": "V3.5",
        "ImageType": "system",
        "ImageIconUrl": "https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg",
        "ImageContact": "https://selfs****e.console.aliyun.com/ticket/createIndex"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Disks": [
        {
          "CreationTime": "2023-02-24T02:20:10Z",
          "Status": "In_use",
          "Device": "/dev/xvda",
          "Size": 50,
          "DiskName": "SystemDisk",
          "DiskChargeType": "PrePaid",
          "DiskType": "system",
          "Category": "ESSD",
          "DiskId": "d-bp14wq0149cpp2x****",
          "RegionId": "cn-hangzhou",
          "Remark": "remark",
          "DiskTags": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ],
          "ResourceGroupId": "rg-aek2bti7cf7****"
        }
      ],
      "ResourceGroupId": "rg-aekz7jmhg5s****",
      "NetworkAttributes": [
        {
          "PublicIpAddress": "116.62.XX.XX",
          "PrivateIpAddress": "72.25.XX.XX",
          "PeakBandwidth": 200,
          "PublicIpDdosStatus": "normal"
        }
      ],
      "PlanType": "NORMAL",
      "CommodityCode": ""
    }
  ],
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "PageSize": 10,
  "PageNumber": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidChargeType.ValueNotSupported	The specified parameter ChargeType is invalid.
400	InvalidPublicIpAddresses.ValueNotSupported	The specified parameter PublicIpAddresses is invalid.
400	InvalidPublicIpAddresses	The specified parameter PublicIpAddresses value is not valid.
500	InternalError	An error occurred while processing your request.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

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

変更履歴

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