全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Oct 14, 2024

    查询存储卷。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    ens:DescribeStorageVolumelist
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    EnsRegionIdstring否

    节点 ID。

    		cn-shenzhen-3
    VolumeIdstring否

    卷 ID。

    		sv-***
    GatewayIdstring否

    网关 ID。

    		sgw-****
    StorageIdstring否

    存储介质 ID。

    		d-***
    IsEnableinteger否

    是否启用。取值：

    • 1：启用。（默认）
    • 0：不启用。
    		1
    PageNumberinteger否

    列表的页码，默认值为 1。

    		1
    PageSizeinteger否

    分页查询时每页的行数。

    		10

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    StorageVolumesarray<object>

    查询结果列表。

    StorageVolumesobject

    存储卷信息。

    StorageVolumeIdstring

    存储卷 ID。

    		sv-***
    StorageVolumeNamestring

    存储卷名称。

    		testVolumeName
    StorageGatewayIdstring

    存储网关 ID。

    		sgw-***
    StorageIdstring

    存储介质 ID。

    		d-***
    CreationTimestring

    创建时间，UTC 时间。

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

    是否启用。取值：

    • 1：启用。（默认）
    • 0：不启用。
    		1
    IsAuthinteger

    是否启用鉴权。取值：

    • 1：启用。
    • 0：不启用。（默认）
    		0
    Descriptionstring

    描述信息。

    		testDescription
    TargetNamestring

    存储卷目标。

    		iqn.*.*.*:*
    Statusstring

    存储卷状态。取值：

    • creating：创建中。
    • available：可用。
    • deleting：删除中。
    • deleted：已删除
    		available
    AuthProtocolstring

    鉴权协议。取值：CHAP。当前仅支持 CHAP 协议。

    		CHAP
    EnsRegionIdstring

    节点 ID。

    		cn-shenzhen-3
    RequestIdstring

    请求 ID。

    		AAE90880-4970-4D81-A534-A6C0F3631F74
    PageNumberstring

    列表的页码，默认值为 1。

    		1
    PageSizestring

    分页查询时设置的每页行数。

    		10
    TotalCountstring

    列表条目数。

    		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错误码错误信息描述
    400NoPermissionPermission denied.没有足够的权限，请联系云账号管理员授予您相应权限。
    400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史