UpdateGatewayBlockVolume - 更新块卷

在块网关下更新块卷配置。

接口说明

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

  • 您已经创建部署完成块网关,并已经完成一个块卷的配置。

  • 该更新接口会更新块卷对应的所有暴露参数,如果您不想更新某个参数,请调用时务必传入该参数原值,否则该块卷参数会被设置成默认值。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
GatewayIdstring

网关 ID。

gw-000eg44nmxbsfwbvq***
IndexIdstring

索引 ID。可以通过 DescribeGatewayBlockVolumes 接口获取。

NFSalex***
Sizelong

块卷的容量大小,单位为 GB。取值范围为 1~262144,默认值为 100。

说明 启用恢复情况下,该参数无效。
100
ChapEnabledboolean

块卷是否启用 iSCSI 访问的 CHAP 认证,目前支持 CHAP 入站验证。取值范围如下:

  • false(默认):否

  • true:是

false
ChapInUserstring

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

说明 未开启 Chap 认证时该参数无效。
user
ChapInPasswordstring

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

说明 未开启 Chap 认证时该参数无效。
ChapInPassword

返回参数

名称类型描述示例值
object
TaskIdstring

任务 ID。

t-000avsri6tlyddgfe***
Messagestring

请求结果描述。

successful
RequestIdstring

请求 ID。

EBAF769F-2E88-4D81-AF1E-A34FAACF9***
Codestring

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

200
Successboolean

请求结果描述。

true

示例

正常返回示例

JSON格式

{
  "TaskId": "t-000avsri6tlyddgfe***",
  "Message": "successful",
  "RequestId": "EBAF769F-2E88-4D81-AF1E-A34FAACF9***",
  "Code": "200",
  "Success": true
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史