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

インスタンス。

acs:swas-open:{#regionId}:{#accountId}: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 配列とすることができます。複数の IP アドレスはコンマ (,) で区切ります。説明 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 標準の協定世界時 (UTC) で表示され、yyyy-MM-ddTHH:mm:ssZ フォーマットです。	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 標準の協定世界時 (UTC) で表示され、yyyy-MM-ddTHH:mm:ssZ フォーマットです。	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 の 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	オペレーティングシステムタイプ。	windows
ImageName	string	イメージ名。	test-custom-1686536882356
ImageVersion	string	イメージバージョン。	V3.5
ImageType	string	イメージタイプ。有効な値: system: システムイメージ。 app: アプリケーションイメージ。 custom: カスタムイメージ。	system
ImageIconUrl	string	イメージアイコンの URL。	https://img.alicdn.com/imgextra/i3/O**1vdh9651ReKqWNMI2I_!!6000000002136**-24-24.svg
ImageContact	string	イメージプロバイダー。	https://selfs****e.console.alibabacloud.com/ticket/createIndex
Tags	array<object>	インスタンスのタグ。
	object	タグ。
Key	string	インスタンスのタグキー。	TestKey
Value	string	インスタンスのタグ値。	TestValue
Disks	array<object>	シンプルアプリケーションサーバーのクラウドディスク情報の配列。
	array<object>	クラウドディスク情報。
CreationTime	string	インスタンスの作成日時。時間は ISO 8601 標準の協定世界時 (UTC) で表示され、yyyy-MM-ddTHH:mm:ssZ フォーマットです。	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 の 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.alibabacloud.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.

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

変更履歴

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