CreateGatewayBlockVolume - 创建块卷_云存储网关(CSG)-阿里云帮助中心

在块网关下创建一个块卷（iSCSI）。

接口说明

使用该接口时，需要注意如下事项：

您已经创建部署完成块网关，如果采用缓存模式，需要该网关拥有未被使用的缓存盘；采用写透模式，可无需缓存盘。
您拥有对象存储(OSS)的 Bucket。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:CreateGatewayBlockVolume

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	gw-000dt67z4ijngqvh1***
Name	string	是	块卷名称。长度限制 1~32 个字符，可以包含小写字母，数字，同时必须以小写字母开头。	name
Recovery	boolean	否	块卷是否启用恢复。如果启用恢复并且 OSS Bucket 之前被作为块卷的云存储，那么网关会尝试使用其中的元数据集进行块卷恢复。默认值：false，即会使用 OSS Bucket 创建新的块卷。	false
VolumeProtocol	string	是	块卷协议。唯一取值：iSCSI。	iSCSI
Size	integer	否	块卷的容量大小。单位：GB。取值范围： 1~262144。默认值：100。说明启用恢复情况下，该参数无效。	100
ChunkSize	integer	否	块卷存储分配单元。块卷的最小分配单位，为达到最佳的存储效率，建议与应用的存储分配单元一致。单位：Byte。取值范围： 8192。 16384。 32768。 65536。 131072。默认值：32768。说明启用恢复情况下，该参数无效。	32768
CacheMode	string	否	块卷缓存模式，默认值：Cache。取值范围： Cache：缓存模式。 WriteThrough：写透模式。说明必须指定该参数。缓存模式下，读写会优先访问网关本地缓存；写透模式下读写会直接访问云上 OSS Bucket，通常情况下缓存模式读写性能更好。	Cache
ChapEnabled	boolean	否	块卷是否启用 iSCSI 访问的 CHAP 认证，目前支持 CHAP 入站验证。默认值：false。	false
ChapInUser	string	否	块卷启用 iSCSI 访问 CHAP 认证时，入站验证的用户名。长度限制 1~32 个字符，包含英文字母、数字。说明未开启 Chap 认证时该参数无效。	chapInUser
ChapInPassword	string	否	块卷启用 iSCSI 访问 CHAP 认证时，入站验证的密码。长度限制 12-16 个字符，可以包含英文、字母、数字或者符号“!”，“@”，“#”，“$”，“%”，“^”，“&”，“*”。说明未开启 Chap 认证时该参数无效。	chapInPassword
OssBucketName	string	是	块卷对应的对象存储（OSS）Bucket 名称。说明块卷不支持“回源特性”OSS Bucket。	bucketName
OssEndpoint	string	是	块卷对应的对象存储（OSS）Bucket 所在地域节点。说明区分内网及外网 Endpoint，建议如果 OSS Bucket 和网关处于相同 Region 则使用内网 Endpoint：oss-cn-shanghai-internal.aliyuncs.com。	oss-cn-shanghai-internal.aliyuncs.com
OssBucketSsl	boolean	否	块卷是否启用 SSL 访问 OSS Bucket。默认值：true。	true
LocalFilePath	string	否	块卷使用的缓存盘内部设备名。可以通过 DescribeGatewayCaches 接口得到。说明当 CacheMode 为缓存模式时，LocalFilePath 必须指定。当 CacheMode 为写透模式时，该参数值无效。	/dev/vdb
OssBucketRegionId	string	否	块卷对应的对象存储（OSS）Bucket 所在地域。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
TaskId	string	任务 ID。	t-000c6hshwukkbtxrb***
Message	string	请求结果描述。	successful
RequestId	string	请求 ID。	9083F167-95B1-4B40-B2CD-70DE068EC3**
Code	string	状态码。状态码为 200 表示请求成功。	200
Success	boolean	请求是否成功。	true

示例

正常返回示例

JSON格式

{
  "TaskId": "t-000c6hshwukkbtxrb***",
  "Message": "successful",
  "RequestId": "9083F167-95B1-4B40-B2CD-70DE068EC3**",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter.BlockVolume.%s	The specified field %s for block volume is invalid. Please check it again.	网关块卷参数非法，请检查。
400	VersionNotSupported.BlockVolume.%s	The specified field %s for block volume is not supported by current gateway version. Please check it again.	网关块卷参数于当前网关版本不支持，请检查。

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

变更历史

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