DescribeStorageVolume - 查询存储卷 - 边缘节点服务ENS

查询存储卷。

调试

您可以在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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。