All Products
Search

This Product

    ENS:DescribeStorageVolume

    Document Center

    ENS:DescribeStorageVolume

    Last Updated:Mar 27, 2026

    Queries volumes.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ens:DescribeStorageVolume

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EnsRegionId

    string

    No

    The ID of the node.

    cn-shenzhen-3
    VolumeId

    string

    No

    The ID of the volume.

    sv-***
    GatewayId

    string

    No

    The ID of the gateway.

    sgw-****
    StorageId

    string

    No

    The ID of the storage medium.

    d-***
    IsEnable

    integer

    No

    Specifies whether to enable the volume. Valid values:

    • 1 (default): enables the volume.

    • 0: disables the volume.

    1
    PageNumber

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    StorageVolumes

    array<object>

    The list of returned results.

    object

    The information about the volume.

    StorageVolumeId

    string

    The ID of the volume.

    sv-***
    StorageVolumeName

    string

    The name of the volume.

    testVolumeName
    StorageGatewayId

    string

    The ID of the storage gateway.

    sgw-***
    StorageId

    string

    The ID of the storage medium.

    d-***
    CreationTime

    string

    The time when the volume was created. The time is displayed in UTC.

    2024-03-14T09:35:32Z
    IsEnable

    integer

    Indicates whether the volume is enabled. Valid values:

    • 1 (default): The volume is enabled.

    • 0: The volume is disabled.

    1
    IsAuth

    integer

    Indicates whether authentication is enabled. Valid values:

    • 1: Authentication is enabled.

    • 0 (default): Authentication is disabled.

    0
    Description

    string

    The description of the volume.

    testDescription
    TargetName

    string

    The destination of the volume.

    iqn.*.*.*:*
    Status

    string

    The status of the volume. Valid values:

    • creating

    • available

    • deleting

    • deleted

    available
    AuthProtocol

    string

    The authentication protocol. The value is set to CHAP.

    CHAP
    EnsRegionId

    string

    The ID of the node.

    cn-shenzhen-3
    RequestId

    string

    The ID of the request.

    AAE90880-4970-4D81-A534-A6C0F3631F74
    PageNumber

    string

    The page number. Default value: 1.

    1
    PageSize

    string

    The number of entries per page.

    10
    TotalCount

    string

    The total number of entries returned.

    15

    Examples

    Success response

    JSON format

    {
  "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"
}

    Error codes

    HTTP status code

    Error code

    Error message

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.