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

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

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

请求参数

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

返回数据

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

示例

请求示例

http(s)://[Endpoint]/?Action=CreateGatewayBlockVolume
&GatewayId=gw-000dt67z4ijngqvh1***
&Name=name
&OssBucketName=bucketName
&OssEndpoint=oss-cn-shanghai-internal.aliyuncs.com
&VolumeProtocol=iSCSI
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateGatewayBlockVolumeResponse>
    <TaskId>t-000c6hshwukkbtxrb***</TaskId>
    <Message>successful</Message>
    <RequestId>9083F167-95B1-4B40-B2CD-70DE068EC3**</RequestId>
    <Code>200</Code>
    <Success>true</Success>
</CreateGatewayBlockVolumeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode	错误码	错误信息	描述
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.	网关块卷参数于当前网关版本不支持，请检查。

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