All Products
Search
Document Center

:DescribeStorageVolume

Last Updated:Dec 25, 2024

Queries volumes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeStorageVolumelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the node.

cn-shenzhen-3
VolumeIdstringNo

The ID of the volume.

sv-***
GatewayIdstringNo

The ID of the gateway.

sgw-****
StorageIdstringNo

The ID of the storage medium.

d-***
IsEnableintegerNo

Specifies whether to enable the volume. Valid values:

  • 1 (default): enables the volume.
  • 0: disables the volume.
1
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

StorageVolumesarray<object>

The list of returned results.

StorageVolumesobject

The information about the volume.

StorageVolumeIdstring

The ID of the volume.

sv-***
StorageVolumeNamestring

The name of the volume.

testVolumeName
StorageGatewayIdstring

The ID of the storage gateway.

sgw-***
StorageIdstring

The ID of the storage medium.

d-***
CreationTimestring

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

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

Indicates whether the volume is enabled. Valid values:

  • 1 (default): The volume is enabled.
  • 0: The volume is disabled.
1
IsAuthinteger

Indicates whether authentication is enabled. Valid values:

  • 1: Authentication is enabled.
  • 0 (default): Authentication is disabled.
0
Descriptionstring

The description of the volume.

testDescription
TargetNamestring

The destination of the volume.

iqn.*.*.*:*
Statusstring

The status of the volume. Valid values:

  • creating
  • available
  • deleting
  • deleted
available
AuthProtocolstring

The authentication protocol. The value is set to CHAP.

CHAP
EnsRegionIdstring

The ID of the node.

cn-shenzhen-3
RequestIdstring

The ID of the request.

AAE90880-4970-4D81-A534-A6C0F3631F74
PageNumberstring

The page number. Default value: 1.

1
PageSizestring

The number of entries per page.

10
TotalCountstring

The total number of entries returned.

15

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history