ListDisks を使用してディスクをクエリ - Simple Application Server (SAS)

指定されたリージョン内のディスク情報をクエリします。

操作説明

パラメーター InstanceId、DiskIds、ResourceGroupId はオプションです。ただし、これらのパラメーターをフィルター条件として指定し、論理 AND 演算子と組み合わせて、クエリ対象のディスクを絞り込むことができます。

今すぐお試しください

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

get

*Disk

acs:swas-open:{#regionId}:{#accountId}:disk/{#DiskId}

*Disk

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	ディスクが属するリージョン ID。	cn-hangzhou
InstanceId	string	任意	シンプルアプリケーションサーバーの ID。	2ad1ae67295445f598017499dc****
DiskIds	string	任意	ディスク ID。最大 100 個のディスク ID を含む JSON 配列形式で指定できます。複数のディスク ID はカンマ (,) で区切ります。	["d-bp14wq0149cpp2x**", "d-bp14wq0149cpp2y**"]
PageSize	integer	任意	1ページあたりのエントリ数。最大値：100。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
DiskType	string	任意	ディスクタイプ。有効値： system：システムディスク data：データディスクデフォルトでは、システムディスクとデータディスクの両方がクエリされます。	system
Tag	array<object>	任意	ディスクに追加されたタグ。
	object	任意	ディスクのタグ。
Key	string	任意	タグキー。タグキーの長さは最大 64 文字です。N の有効値：1～20。	TestKey
Value	string	任意	タグ値。タグ値の長さは最大 64 文字です。N の有効値：1～20。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。	rg-aek2bti7cf7****

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの総数。	1
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	1ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
Disks	array<object>	クエリされたディスク。
	array<object>	ディスクの情報。
CreationTime	string	ディスクが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。	2021-03-08T05:31:06Z
Status	string	ディスクのステータス。有効値： ReIniting：ディスクは初期化中です。 Creating：ディスクは作成中です。 In_use：ディスクは使用中です。 Available：ディスクはアタッチ可能です。 Attaching：ディスクはアタッチ中です。 Detaching：ディスクはデタッチ中です。	In_use
Device	string	ディスクがシンプルアプリケーションサーバーにアタッチされた後のデバイス名。	/dev/xvda
Size	integer	ディスクサイズ。単位：GB。	50
DiskName	string	ディスク名。	SystemDisk
DiskChargeType	string	ディスクの課金方法。	PrePaid
DiskType	string	ディスクタイプ。有効値： system：システムディスク data：データディスク	System
Category	string	ディスクのカテゴリ。有効値： ESSD：パフォーマンスレベル 0 (PL0) の拡張 SSD (ESSD) SSD：標準 SSD CLOUD_EFFICIENCY：Ultra ディスク	ESSD
DiskId	string	ディスク ID。	d-bp14wq0149cpp2x****
InstanceId	string	ディスクがアタッチされているシンプルアプリケーションサーバーの ID。	2ad1ae67295445f598017499dc****
RegionId	string	リージョン ID。	cn-hangzhou
Remark	string	ディスクの備考。	remark
Tags	array<object>	ディスクに追加されたタグ。
	object	ディスクのタグ。
Key	string	タグキー。	TestKey
Value	string	タグ値。	TestValue
InstanceName	string	シンプルアプリケーションサーバーの名前。	myInstance
ResourceGroupId	string	ディスクが属するリソースグループの ID。	rg-aek2bti7cf7****

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Disks": [
    {
      "CreationTime": "2021-03-08T05:31:06Z",
      "Status": "In_use",
      "Device": "/dev/xvda",
      "Size": 50,
      "DiskName": "SystemDisk",
      "DiskChargeType": "PrePaid",
      "DiskType": "System",
      "Category": "ESSD",
      "DiskId": "d-bp14wq0149cpp2x****",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "RegionId": "cn-hangzhou",
      "Remark": "remark",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "myInstance",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	An error occurred while processing your request.

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

変更履歴

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