DescribeDedicatedBlockStorageClusterDisks での専用ブロックストレージクラスター内クラウドディスククエリ - ECS - Alibaba Cloud - Elastic Compute Service

専用ブロックストレージクラスターで作成された 1 つ以上のクラウドディスクの情報を照会します。

操作説明

返されたデータを表示するには、次の 2 つの方法がサポートされています。
- 方法 1: NextToken を使用してクエリトークンを設定します。その値を DescribeDisks の前回の呼び出しで返された NextToken 値に設定し、MaxResults を使用してページあたりの最大エントリ数を設定します。
- 方法 2: PageSize を使用してページあたりのエントリ数を設定し、PageNumber を使用してページ番号を設定します。
前述の方法のうち 1 つのみを使用できます。多数のエントリが返される場合は、方法 1 を使用することを推奨します。NextToken を設定した場合、PageSize および PageNumber リクエストパラメーターは効果を持たず、返されたデータの TotalCount は無効になります。
マルチアタッチ機能が有効なクラウドディスクは、複数のインスタンスにアタッチできます。応答内の Attachment リストに基づいて、クラウドディスクのすべての添付ファイル情報を確認できます。

クラウドアシスタント CLI を使用して API オペレーションを呼び出す際は、異なるデータタイプのリクエストパラメーターを必須のフォーマットで指定してください。詳細については、「CLI のパラメーターフォーマット」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ebs:DescribeDedicatedBlockStorageClusterDisks

get

*DedicatedBlockStorageCluster

acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	専用ブロックストレージクラスターのリージョン ID。最新のリージョンリストをクエリするには、 DescribeRegions を呼び出せます。	cn-heyuan
MaxResults	integer	任意	ページングクエリのページあたりの最大エントリ数。最大値: 500。デフォルト値: 10。	10
NextToken	string	任意	ページネーショントークン。このパラメーターを前回の呼び出しで返された NextToken 値に設定します。最初のリクエストでは、このパラメーターを設定する必要はありません。	AAAAAdDWBF2
DbscId	string	必須	専用ブロックストレージクラスター ID。	dbsc-cn-od43bf****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	11B55F58-D3A4-4A9B-9596-342420D0****
NextToken	string	この呼び出しで返されたページネーショントークン。	AAAAAdDWBF2
Disks	object	クラウドディスク情報のコレクション。
Disk	array<object>	クラウドディスク情報のコレクション。
	array<object>	クラウドディスク情報のコレクション。
DiskId	string	クラウドディスクの ID。	d-bp67acfmxazb4p****
DiskName	string	クラウドディスクの名前。	testDiskName
Status	string	クラウドディスクの状態。詳細については、「ディスクの状態」をご参照ください。有効な値： In_use Available Attaching Detaching Creating ReIniting	In_use
Type	string	ディスクのタイプ。有効な値： system：システムディスク data：データディスク	system
PerformanceLevel	string	ESSD (Enhanced SSD) のパフォーマンスレベル。有効な値： PL0： 1 つの ESSD で最大 10,000 のランダム読み書き IOPS を配信できます。 PL1： 1 つの ESSD で最大 50,000 のランダム読み書き IOPS を配信できます。 PL2： 1 つの ESSD で最大 100,000 のランダム読み書き IOPS を配信できます。 PL3： 1 つの ESSD で最大 1,000,000 のランダム読み書き IOPS を配信できます。	PL0
BdfId	string	このパラメーターは現在招待プレビュー中であり、一般ユーザーは利用できません。	null
EnableAutoSnapshot	boolean	クラウドディスクに対して自動スナップショットポリシー機能が有効になっているかどうかを示します。	false
StorageSetId	string	ストレージセットの ID。	ss-i-bp1j4i2jdf3owlhe****
StorageSetPartitionNumber	integer	ストレージセット内のパーティションの最大数。	11
DeleteAutoSnapshot	boolean	ディスクがリリースされたときに、クラウドディスクの自動スナップショットが削除されるかどうかを示します。有効な値： true：ディスクがリリースされると、クラウドディスクの自動スナップショットは削除されます。 false：ディスクがリリースされても、クラウドディスクの自動スナップショットは保持されます。 CreateSnapshot 操作を呼び出すか、Elastic Compute Service (ECS) コンソールを使用して作成されたスナップショットは保持され、このパラメーターの影響を受けません。	false
StorageClusterId	string	クラウドディスクが属する専用ブロックストレージクラスターの ID。ご利用のクラウドディスクがパブリックブロックストレージクラスターに属している場合、空の値が返されます。	dbsc-j5e1sf2vaf5he8m2****
Encrypted	boolean	クラウドディスクが暗号化されているかどうかを示します。	false
MountInstanceNum	integer	共有ブロックストレージデバイスがアタッチされているインスタンスの数。	1
Description	string	クラウドディスクの説明。	testDescription
Device	string	関連付けられたインスタンス上のクラウドディスクのデバイス名。例： /dev/xvdb。次の点にご注意ください：このパラメーターは、`Status` の値が `In_use` の場合にのみ値を返します。このパラメーターは、マルチアタッチ機能が有効になっているクラウドディスクの場合は空になります。 `Attachment` 値に基づいて、クラウドディスクのアタッチメント情報を照会できます。説明このパラメーターは将来廃止される予定です。将来の互換性を確保するために、他のパラメーターを使用することを推奨します。	/dev/xvdb
Portable	boolean	クラウドディスクがリムーバブルであるかどうかを示します。	false
ImageId	string	インスタンスの作成に使用されたイメージの ID。このパラメーターは、クラウドディスクがイメージから作成された場合を除き、空になります。このパラメーターの値は、クラウドディスクのライフサイクルを通じて変更されません。	m-bp13aqm171qynt3u***
KMSKeyId	string	クラウドディスクで使用される Key Management Service (KMS) キーの ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	関連付けられたインスタンスがリリースされたときに、クラウドディスクがリリースされるかどうかを示します。有効な値： true：関連付けられたインスタンスがリリースされると、クラウドディスクもリリースされます。 false：関連付けられたインスタンスがリリースされても、クラウドディスクは保持されます。	true
DetachedTime	string	クラウドディスクが最後にデタッチされた時刻。	2021-06-07T21:01:22Z
SourceSnapshotId	string	クラウドディスクの作成に使用されたスナップショットの ID。このパラメーターは、クラウドディスクがスナップショットから作成された場合を除き、空になります。このパラメーターの値は、クラウドディスクのライフサイクルを通じて変更されません。	s-bp67acfmxazb4p****
InstanceId	string	クラウドディスクがアタッチされているインスタンスの ID。次の点にご注意ください：このパラメーターは、`Status` の値が `In_use` の場合にのみ値を返します。このパラメーターは、マルチアタッチ機能が有効になっているクラウドディスクの場合は空になります。 `Attachment` 値に基づいて、クラウドディスクのアタッチメント情報を照会できます。	i-bp67acfmxazb4q****
Size	integer	ディスクのサイズ。単位： GiB。	60
RegionId	string	クラウドディスクのリージョン ID。	cn-heyuan
ZoneId	string	クラウドディスクのゾーン ID。	cn-heyuan-i
AttachedTime	string	クラウドディスクが最後にアタッチされた時刻。時刻は、yyyy-MM-ddThh:mmZ 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。	2021-06-07T06:08:56Z
Category	string	ディスクのカテゴリ。 cloud_essd の値は、ディスクが ESSD であることを示します。	cloud_essd
MultiAttach	string	クラウドディスクでマルチアタッチ機能が有効になっているかどうかを示します。	Disabled
Tags	array<object>	クラウドディスクのタグ。
	object
TagValue	string	クラウドディスクのタグ値。	TestValue
TagKey	string	クラウドディスクのタグキー。	TestKey
DiskChargeType	string	クラウドディスクの課金方法。有効な値： PrePaid：サブスクリプション PostPaid：従量課金	PrePaid
IOPS	integer	IOPS の最大数。	4000
Throughput	integer	BPS の最大数。	100
ProvisionedIops	integer	ESSD AutoPL ディスクのプロビジョニングされた読み取り/書き込み IOPS。説明このパラメーターは、DiskCategory パラメーターが cloud_auto に設定されている場合にのみ使用可能です。詳細については、「ESSD AutoPL ディスク」および「ESSD AutoPL ディスクのパフォーマンス構成の変更」をご参照ください。	40000
BurstingEnabled	boolean	ESSD AutoPL ディスクでバースト IOPS/BPS が有効になっているかどうか。このパラメーターは、DiskCategory パラメーターが cloud_auto に設定されている場合にのみ使用可能です。詳細については、「ESSD AutoPL ディスク」をご参照ください。	false

例

成功レスポンス

JSONJSON

{
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****",
  "NextToken": "AAAAAdDWBF2",
  "Disks": {
    "Disk": [
      {
        "DiskId": "d-bp67acfmxazb4p****",
        "DiskName": "testDiskName",
        "Status": "In_use",
        "Type": "system",
        "PerformanceLevel": "PL0",
        "BdfId": "null",
        "EnableAutoSnapshot": false,
        "StorageSetId": "ss-i-bp1j4i2jdf3owlhe****",
        "StorageSetPartitionNumber": 11,
        "DeleteAutoSnapshot": false,
        "StorageClusterId": "dbsc-j5e1sf2vaf5he8m2****",
        "Encrypted": false,
        "MountInstanceNum": 1,
        "Description": "testDescription",
        "Device": "/dev/xvdb",
        "Portable": false,
        "ImageId": "m-bp13aqm171qynt3u***",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": true,
        "DetachedTime": "2021-06-07T21:01:22Z",
        "SourceSnapshotId": "s-bp67acfmxazb4p****",
        "InstanceId": "i-bp67acfmxazb4q****",
        "Size": 60,
        "RegionId": "cn-heyuan",
        "ZoneId": "cn-heyuan-i",
        "AttachedTime": "2021-06-07T06:08:56Z",
        "Category": "cloud_essd",
        "MultiAttach": "Disabled",
        "Tags": [
          {
            "TagValue": "TestValue",
            "TagKey": "TestKey"
          }
        ],
        "DiskChargeType": "PrePaid",
        "IOPS": 4000,
        "Throughput": 100,
        "ProvisionedIops": 40000,
        "BurstingEnabled": false
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

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

変更履歴

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