调用DescribeGatewayBlockVolumes接口查询块卷详情-云存储网关-阿里云

查询块网关卷详情，例如：操作状态、传输数据、地址、容量、端口、CHAP、OSS Bucket SSL、LUN ID、卷状态。

接口说明

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGatewayBlockVolumes

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000dt67z4ijngqvh***
IndexId	string	否	索引 ID。如果该字段为空，则枚举该网关上的所有块网关卷的配置信息。	alex-or2020010816***
Refresh	boolean	否	是否强制刷新缓存。取值范围入下： true（默认）：是。 false：否。	true

返回参数

名称	类型	描述	示例值
	object
BlockVolumes	object
BlockVolume	array<object>	块网关卷信息。
	object
Status	integer	操作状态。可能值： 0：成功 1：创建卷失败 2：删除卷失败 3：启用目标失败 4：禁用目标失败 5：数据库错误 6：启用缓存失败 7：禁用缓存失败 8：系统错误	0
ChunkSize	integer	存储分配单元，单位为 Byte。存储分配单元包括 8 k、16 k、32 k、64 k、128 k，默认为 32 K。	32768
TotalUpload	integer	总上传数据量，单位为 Byte。	123214564
DiskType	string	缓存盘类型。	cloud_efficiency
DiskId	string	缓存盘 ID。	d-bp1a8athxvwbja18***
Port	integer	端口。	0
IndexId	string	索引 ID。	alex-or2020010816***
TotalDownload	integer	总下载数据量。单位为 Byte。	56342324
ChapEnabled	boolean	是否启用 CHAP。	true
Enabled	boolean	块卷是否启用。	true
Address	string	服务 IP 地址。	172.16.0.22
Name	string	块卷名称。	alex
Target	string	卷目标。	iqn**************
OssEndpoint	string	块卷对应的对象存储（OSS） Bucket 所在地域节点。说明区分内网及外网 Endpoint。建议如果 OSS Bucket 和网关处于相同 Region 则使用内网 Endpoint：oss-cn-hangzhou-internal.aliyuncs.com。	oss-cn-hangzhou-internal.aliyuncs.com
OssBucketName	string	OSS Bucket 名称。	random***
CacheMode	string	缓存模式。可能值： Cache：缓存模式。 WriteThrough：写透模式。	Cache
State	string	缓存状态。可能值： clean：同步完成 dirty：同步未完成	clean
Protocol	string	协议。	iSCSI
LunId	integer	LUN ID。	0
OssBucketSsl	boolean	是否使用 OSS BUCKET SSL。	true
VolumeState	integer	卷状态。可能值： 0：失败 1：完成 2：创建中 3：删除中 4：启用中 5：禁用中 6：运行中	1
LocalPath	string	缓存盘本地路径。	/dev/vdb
ChapInUser	string	入站 CHAP 用户。	alex***
Size	integer	容量。单位为 Byte。	107374182400
OssBucketRegionId	string	块卷对应的对象存储（OSS）Bucket 所在地域。	cn-hangzhou
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	787D4AD4-5536-4C36-9FB0-D74C0554D344
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "BlockVolumes": {
    "BlockVolume": [
      {
        "Status": 0,
        "ChunkSize": 32768,
        "TotalUpload": 123214564,
        "DiskType": "cloud_efficiency",
        "DiskId": "d-bp1a8athxvwbja18***",
        "Port": 0,
        "IndexId": "alex-or2020010816***",
        "TotalDownload": 56342324,
        "ChapEnabled": true,
        "Enabled": true,
        "Address": "172.16.0.22",
        "Name": "alex",
        "Target": "iqn**************",
        "OssEndpoint": "oss-cn-hangzhou-internal.aliyuncs.com",
        "OssBucketName": "random***",
        "CacheMode": "Cache",
        "State": "clean",
        "Protocol": "iSCSI",
        "LunId": 0,
        "OssBucketSsl": true,
        "VolumeState": 1,
        "LocalPath": "/dev/vdb",
        "ChapInUser": "alex***",
        "Size": 107374182400,
        "OssBucketRegionId": "cn-hangzhou"
      }
    ]
  },
  "Message": "successful",
  "RequestId": "787D4AD4-5536-4C36-9FB0-D74C0554D344",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	EmptyGatewayId	You must enter a valid ID for the gateway.	网关ID不能为空。
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	网关不存在，请确认输入参数是否正确。
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	网关正在升级中，请稍后再试。
400	GatewayInOperation	The gateway is processing requests . Try again later.	网关正在进行操作中，请稍后再试。

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

变更历史

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