在块网关下更新块卷配置。
接口说明
使用该接口时，需要注意如下事项：
-
您已经创建部署完成块网关，并已经完成一个块卷的配置。
-
该更新接口会更新块卷对应的所有暴露参数，如果您不想更新某个参数，请调用时务必传入该参数原值，否则该块卷参数会被设置成默认值。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hcs-sgw:UpdateGatewayBlockVolume | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GatewayId | string | 是 | 网关 ID。 | gw-000eg44nmxbsfwbvq*** |
| IndexId | string | 是 | 索引 ID。可以通过 DescribeGatewayBlockVolumes 接口获取。 | NFSalex*** |
| Size | long | 否 | 块卷的容量大小，单位为 GB。取值范围为 1~262144，默认值为 100。 说明
启用恢复情况下，该参数无效。
| 100 |
| ChapEnabled | boolean | 否 | 块卷是否启用 iSCSI 访问的 CHAP 认证，目前支持 CHAP 入站验证。取值范围如下：
| false |
| ChapInUser | string | 否 | 块卷启用 iSCSI 访问 CHAP 认证时，入站验证的用户名。长度限制 1~32 个字符，包含英文字母和数字。 说明
未开启 Chap 认证时该参数无效。
| user |
| ChapInPassword | string | 否 | 块卷启用 iSCSI 访问 CHAP 认证时，入站验证的密码。长度限制 12~16 个字符，可以包含英文字母，数字，或者符号"!"、"@"、"#"、"$"、"%"、"^"、"&"、"*"。 说明
未开启 Chap 认证时该参数无效。
| ChapInPassword |
返回参数
示例
正常返回示例
JSON格式
{
"TaskId": "t-000avsri6tlyddgfe***",
"Message": "successful",
"RequestId": "EBAF769F-2E88-4D81-AF1E-A34FAACF9***",
"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. | 网关块卷参数于当前网关版本不支持，请检查。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史