调用UpdateGatewayBlockVolume在块网关下更新块卷配置_云存储网关(CSG)-阿里云帮助中心

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

您已经创建部署完成块网关，并已经完成一个块卷的配置。
该更新接口会更新块卷对应的所有暴露参数，如果您不想更新某个参数，请调用时务必传入该参数原值，否则该块卷参数会被设置成默认值。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	UpdateGatewayBlockVolume	系统规定参数。取值：UpdateGatewayBlockVolume。
GatewayId	String	是	gw-000eg44nmxbsfwbvq***	网关ID。
IndexId	String	是	NFSalex***	索引ID。可以通过DescribeGatewayBlockVolumes接口获取。
Size	Long	否	100	块卷的容量大小，单位为GB。取值范围为1~262144，默认值为100。说明启用恢复情况下，该参数无效。
ChapEnabled	Boolean	否	false	块卷是否启用iSCSI访问的CHAP认证，目前支持CHAP入站验证。取值范围如下： false（默认）：否 true：是
ChapInUser	String	否	user	块卷启用iSCSI访问CHAP认证时，入站验证的用户名。长度限制1~32个字符，包含英文字母和数字。说明未开启Chap认证时该参数无效。
ChapInPassword	String	否	ChapInPassword	块卷启用iSCSI访问CHAP认证时，入站验证的密码。长度限制12~16个字符，可以包含英文字母，数字，或者符号"!"、"@"、"#"、"$"、"%"、"^"、"&"、"*"。说明未开启Chap认证时该参数无效。

返回数据

名称	类型	示例值	描述
TaskId	String	t-000avsri6tlyddgfe***	任务ID。
Message	String	successful	请求结果描述。
RequestId	String	EBAF769F-2E88-4D81-AF1E-A34FAACF9***	请求ID。
Code	String	200	状态码。状态码为200表示请求成功。
Success	Boolean	true	请求结果描述。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateGatewayBlockVolume
&GatewayId=gw-000eg44nmxbsfwbvq***
&IndexId=NFSalex***
&<公共请求参数>

正常返回示例

XML格式

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

<UpdateGatewayBlockVolumeResponse>
    <TaskId>t-000avsri6tlyddgfe***</TaskId>
    <Message>successful</Message>
    <RequestId>EBAF769F-2E88-4D81-AF1E-A34FAACF9***</RequestId>
    <Code>200</Code>
    <Success>true</Success>
</UpdateGatewayBlockVolumeResponse>

JSON格式

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

{
  "TaskId" : "t-000avsri6tlyddgfe***",
  "Message" : "successful",
  "RequestId" : "EBAF769F-2E88-4D81-AF1E-A34FAACF9***",
  "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.	网关块卷参数于当前网关版本不支持，请检查。

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