DescribeLensMonitorDisks API 呼び出しによるディスク情報の取得 - ECS - Alibaba Cloud - Elastic Compute Service

作成した 1 つ以上のブロックストレージクラウドディスクを照会します。

今すぐお試しください

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

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。DescribeRegions を呼び出して、EBS レンズでサポートされているリージョンのリストをクエリできます。	cn-hangzhou
DiskIds	array	任意	クラウドディスク ID のリスト。	['d-1', 'd-2']
	string	任意	クラウドディスク ID。	d-cd40hxfu0v*****
DiskCategory	string	任意	クラウドディスクタイプ。有効な値: cloud: 基本クラウドディスク。 cloud_efficiency: ウルトラクラウドディスク。 cloud_ssd: 標準 SSD。 cloud_essd: ESSD (エンタープライズ SSD)。 cloud_auto: ESSD AutoPL クラウドディスク。 cloud_essd_entry: ESSD Entry ディスク。	cloud_auto
LensTags	array	任意	クラウドディスクイベントタグのリスト。過去 24 時間以内にこれらのイベントタイプが発生したクラウドディスクをフィルター処理するために使用されます。有効な値: NoSnapshot: データ保護 BurstIOTriggered: バースト I/O CostOptimizationNeeded: コスト最適化 DiskSpecNotMatchedWithInstance: インスタンスとクラウドディスクの仕様が一致しない DiskIONo4kAligned: 非 4K アライン読み取り/書き込み DiskIOHang: クラウドディスクで I/O 一部サービス停止が発生 InstanceIOPSExceedInstanceMaxLimit: インスタンス IOPS が上限に達した InstanceBPSExceedInstanceMaxLimit: インスタンス BPS が上限に達した DiskIOPSExceedInstanceMaxLimit: クラウドディスク IOPS がインスタンスの上限に達した DiskBPSExceedInstanceMaxLimit: クラウドディスク BPS がインスタンスの上限に達した DiskIOPSExceedDiskMaxLimit: クラウドディスク IOPS がディスクの上限に達した DiskBPSExceedDiskMaxLimit: クラウドディスク BPS がディスクの上限に達した
	string	任意	クラウドディスクイベントタグ。	NoSnapshot
NextToken	string	任意	ページネーショントークン。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	任意	ページングクエリの 1 ページあたりのエントリの最大数。最大値: 100。デフォルト値: デフォルト値は 10 です。指定された値が 100 より大きい場合、デフォルト値の 100 が使用されます。	10
DiskIdPattern	string	任意	クラウドディスク ID のあいまい一致フィルターに使用される正規表現式パターン。	d-cd40hxfu0v*
		任意	ECS インスタンス ID。	i-2zedroc0yv8z19ubnyos

レスポンスフィールド

フィールド	型	説明	例
	object	DescribeLensMonitorDisksResponse。
DiskInfos	array<object>	クラウドディスク情報のリスト。
	array<object>	クラウドディスク情報。
Bps	integer	1 秒あたりの読み取り/書き込み (I/O) 操作のデータスループットの最大値。単位: MB/s。	300
BurstingEnabled	boolean	バースト (パフォーマンスバースト) が有効かどうかを示します。有効な値: true: 有効。 false: 無効。このパラメーターは、DiskCategory が cloud_auto にセットされている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」を参照してください。	true
DiskCategory	string	クラウドディスクタイプ。有効な値: cloud: 基本クラウドディスク。 cloud_efficiency: ウルトラクラウドディスク。 cloud_ssd: 標準 SSD。 cloud_essd: ESSD (エンタープライズ SSD)。 cloud_auto: ESSD AutoPL クラウドディスク。 cloud_essd_entry: ESSD Entry ディスク。	cloud_essd
DiskId	string	クラウドディスク ID。	d-cd401****
DiskName	string	クラウドディスク名。	disk-28c6b****
DiskStatus	string	クラウドディスクのステータス。有効な値: Available: 使用中。 Deleted: 削除済み。	Available
DiskType	string	クラウドディスクタイプ。有効な値: system: システムクラウドディスク。 data: データクラウドディスク。	system
Iops	integer	1 秒あたりの読み取り/書き込み (I/O) 操作の最大値。単位: 操作/秒。	4000
LensTags	array	クラウドディスクのイベントタグのコレクション。イベントタグには、過去 24 時間以内にクラウドディスクで発生したイベントが表示されます。実際のイベントと比較して最大 1 時間の遅延があります。
	string	クラウドディスクのイベントタグ。	["NoSnapshot", "DiskIOHang"]
PerformanceLevel	string	ESSD クラウドディスクのパフォーマンスレベル (PL)。有効な値: PL0: 標準 SSD あたりのランダム読み取り/書き込み IOPS の最大値は 10,000。 PL1: 標準 SSD あたりのランダム読み取り/書き込み IOPS の最大値は 50,000。 PL2: 標準 SSD あたりのランダム読み取り/書き込み IOPS の最大値は 100,000。 PL3: 標準 SSD あたりのランダム読み取り/書き込み IOPS の最大値は 1,000,000。	PL0
ProvisionedIops	integer	ESSD AutoPL クラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。有効な値: 0 ～ min{50,000, 1,000 × Capacity - ベースラインパフォーマンス}。ベースラインパフォーマンス = min{1,800 + 50 × Capacity, 50,000}。このパラメーターは、DiskCategory が cloud_auto にセットされている場合にのみサポートされます。詳細については、「ESSD AutoPL クラウドディスク」を参照してください。	4000
RegionId	string	リージョン ID。	cn-hangzhou
SharingEnabled	string	クラウドディスクが共有クラウドディスクかどうかを示します。	true
Size	integer	クラウドディスクサイズ。単位: GiB。	64
Tags	array<object>	クラウドディスクのタグのコレクション。
	object	クラウドディスクのタグ。
TagKey	string	タグキー。	tag1
TagValue	string	タグ値。	user
ZoneId	string	クラウドディスクのゾーン ID。	cn-hangzhou-j
NextToken	string	ページネーショントークン。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	リクエスト ID。API 呼び出しの成否にかかわらずリクエスト ID が返されます。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	返されるエントリの総数。	6

例

成功レスポンス

JSONJSON

{
  "DiskInfos": [
    {
      "Bps": 300,
      "BurstingEnabled": true,
      "DiskCategory": "cloud_essd",
      "DiskId": "d-cd401****",
      "DiskName": "disk-28c6b****",
      "DiskStatus": "Available",
      "DiskType": "system",
      "Iops": 4000,
      "LensTags": [
        "[\"NoSnapshot\", \"DiskIOHang\"]"
      ],
      "PerformanceLevel": "PL0",
      "ProvisionedIops": 4000,
      "RegionId": "cn-hangzhou",
      "SharingEnabled": "true",
      "Size": 64,
      "Tags": [
        {
          "TagKey": "tag1",
          "TagValue": "user"
        }
      ],
      "ZoneId": "cn-hangzhou-j"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 6
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The parameter %s is invalid.	パラメーターエラーが発生しました。
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.	パラメーターの競合が発生しました。
400	InvalidParameter.Format	Specified parameter format is not valid.	日文说明
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	必須パラメーターが欠落しています。
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.	現在のユーザーには、この操作を実行する権限がありません。アカウントの権限を確認するか、プライマリアカウントの管理者に連絡してください。
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.	アカウントの残高が不足しています。
403	LastTokenProcessing	The last token request is processing.	同じ ClientToken を持つリクエストが処理中です。後でもう一度お試しください。
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	現在のユーザーには、サービスリンクロールを作成する権限がありません。
403	OperationDenied	The operation is not allowed.	現在の操作は許可されていません。
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	指定されたリソースが存在しません。
504	RequestTimeout	The request is timeout, please try again later.	リクエストがタイムアウトしました。時間をおいてもう一度お試しください。
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

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

変更履歴

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