DescribeStorageVolume API で ENS ストレージボリュームをクエリ - ENS

ボリュームを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeStorageVolume

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	string	任意	ノードの ID です。	cn-shenzhen-3
VolumeId	string	任意	ボリュームの ID です。	sv-***
GatewayId	string	任意	ゲートウェイの ID です。	sgw-****
StorageId	string	任意	記憶媒体の ID です。	d-***
IsEnable	integer	任意	ボリュームの有効化設定を指定します。有効な値は以下のとおりです。 1（デフォルト）：ボリュームを有効化します。 0：ボリュームを無効化します。	1
PageNumber	integer	任意	ページ番号です。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりの表示件数です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマです。
StorageVolumes	array<object>	返された結果の一覧です。
	object	ボリュームに関する情報です。
StorageVolumeId	string	ボリュームの ID です。	sv-***
StorageVolumeName	string	ボリュームの名前です。	testVolumeName
StorageGatewayId	string	ストレージゲートウェイの ID です。	sgw-***
StorageId	string	記憶媒体の ID です。	d-***
CreationTime	string	ボリュームが作成された時刻です。時刻は協定世界時 (UTC) で表示されます。	2024-03-14T09:35:32Z
IsEnable	integer	ボリュームが有効かどうかを示します。有効な値は以下のとおりです。 1（デフォルト）：ボリュームは有効です。 0：ボリュームは無効です。	1
IsAuth	integer	認証が有効かどうかを示します。有効な値は以下のとおりです。 1：認証は有効です。 0（デフォルト）：認証は無効です。	0
Description	string	ボリュームの説明です。	testDescription
TargetName	string	ボリュームの送信先です。	iqn...:
Status	string	ボリュームのステータスです。有効な値は以下のとおりです。 creating available deleting deleted	available
AuthProtocol	string	認証プロトコルです。値は CHAP に設定されます。	CHAP
EnsRegionId	string	ノードの ID です。	cn-shenzhen-3
RequestId	string	リクエストの ID です。	AAE90880-4970-4D81-A534-A6C0F3631F74
PageNumber	string	ページ番号です。デフォルト値は 1 です。	1
PageSize	string	1 ページあたりの表示件数です。	10
TotalCount	string	返された合計件数です。	15

例

成功レスポンス

JSONJSON

{
  "StorageVolumes": [
    {
      "StorageVolumeId": "sv-***",
      "StorageVolumeName": "testVolumeName",
      "StorageGatewayId": "sgw-***",
      "StorageId": "d-***",
      "CreationTime": "2024-03-14T09:35:32Z",
      "IsEnable": 1,
      "IsAuth": 0,
      "Description": "testDescription",
      "TargetName": "iqn.*.*.*:*",
      "Status": "available",
      "AuthProtocol": "CHAP",
      "EnsRegionId": "cn-shenzhen-3"
    }
  ],
  "RequestId": "AAE90880-4970-4D81-A534-A6C0F3631F74",
  "PageNumber": "1",
  "PageSize": "10",
  "TotalCount": "15"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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