全部產品
Search
文件中心

ENS:DescribeStorageVolume - 查詢儲存卷

更新時間:Mar 20, 2026

查詢儲存卷。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeStorageVolume

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

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

分頁查詢時每頁的行數。

10

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

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 協議。

CHAP

EnsRegionId

string

節點 ID。

cn-shenzhen-3

RequestId

string

請求 ID。

AAE90880-4970-4D81-A534-A6C0F3631F74

PageNumber

string

列表的頁碼,預設值為 1

1

PageSize

string

分頁查詢時設定的每頁行數。

10

TotalCount

string

列表條目數。

15

樣本

正常返回樣本

JSON格式

{
  "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 status code

錯誤碼

錯誤資訊

描述

400 NoPermission Permission denied.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情