CreateGatewayBlockVolume_云存储网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用该接口时,需要注意如下事项:

  • 您已经创建部署完成块网关,如果采用缓存模式,需要该网关拥有未被使用的缓存盘;采用写透模式,可无需缓存盘。

  • 您拥有对象存储(OSS)的 Bucket。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hcs-sgw:CreateGatewayBlockVolume
Create
全部资源
*

请求参数

字段名称字段详情
GatewayIdstring

网关 ID。

示例值:gw-000dt67z4ijngqvh1***参考取值来源:
    ModifyGateway
    CreateGateway
    DescribeGateways
Namestring

块卷名称。长度限制 1~32 个字符,可以包含小写字母,数字,同时必须以小写字母开头。

示例值:name
Recoveryboolean

块卷是否启用恢复。如果启用恢复并且 OSS Bucket 之前被作为块卷的云存储,那么网关会尝试使用其中的元数据集进行块卷恢复。展开详情

示例值:false
VolumeProtocolstring

块卷协议。唯一取值:iSCSI。

示例值:iSCSI
Sizeinteger<int64>

块卷的容量大小。单位:GB。取值范围:展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:100
ChunkSizeinteger<int32>

块卷存储分配单元。块卷的最小分配单位,为达到最佳的存储效率,建议与应用的存储分配单元一致。单位:Byte。取值范围:展开详情

示例值:32768
CacheModestring

块卷缓存模式,默认值:Cache。取值范围:展开详情

示例值:Cache
ChapEnabledboolean

块卷是否启用 iSCSI 访问的 CHAP 认证,目前支持 CHAP 入站验证。展开详情

示例值:false
ChapInUserstring

块卷启用 iSCSI 访问 CHAP 认证时,入站验证的用户名。长度限制 1~32 个字符,包含英文字母、数字。展开详情

示例值:chapInUser
ChapInPasswordstring

块卷启用 iSCSI 访问 CHAP 认证时,入站验证的密码。长度限制 12-16 个字符,可以包含英文、字母、数字或者符号“!”,“@”,“#”,“$”,“%”,“^”,“&”,“*”。展开详情

示例值:chapInPassword
OssBucketNamestring

块卷对应的对象存储(OSS)Bucket 名称。展开详情

示例值:bucketName
OssEndpointstring

块卷对应的对象存储(OSS)Bucket 所在地域节点。展开详情

示例值:oss-cn-shanghai-internal.aliyuncs.com
OssBucketSslboolean

块卷是否启用 SSL 访问 OSS Bucket。展开详情

示例值:true
LocalFilePathstring

块卷使用的缓存盘内部设备名。可以通过 DescribeGatewayCaches 接口得到。展开详情

示例值:/dev/vdb参考取值来源:
    CreateGatewayFileShare
OssBucketRegionIdstring

块卷对应的对象存储(OSS)Bucket 所在地域。

示例值:cn-hangzhou

返回参数

字段名称字段详情
TaskIdstring

任务 ID。

示例值:t-000c6hshwukkbtxrb***
Messagestring

请求结果描述。

示例值:successful
RequestIdstring

请求 ID。

示例值:9083F167-95B1-4B40-B2CD-70DE068EC3**
Codestring

状态码。状态码为 200 表示请求成功。

示例值:200
Successboolean

请求是否成功。

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断

变更历史

变更时间变更内容概要操作
2024-12-18
新增请求参数OssBucketRegionId

相关示例