CheckBlockVolumeName - 云存储网关

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

接口返回此卷名称是否已存在。
恢复模式：当云资源对应的OSS Bucket已经被用作卷的云存储时，系统会尝试使用其中的元数据（例如卷的容量等），进行卷恢复。
接口返回的isRequireRecovery可能值：
- true：卷名称存在，您可以选择设置此卷为恢复模式。
- false：卷名称不存在，您可以直接使用云资源对应的OSS Bucket创建新的卷。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CheckBlockVolumeName	系统规定参数。取值：CheckBlockVolumeName。
BucketEndpoint	String	是	oss-cn-hangzhou-internal.aliyuncs.com	Bucket Endpoint。
BucketName	String	是	random***	Bucket 名称。
VolumeName	String	是	alex***	块卷名称。卷名称长度限制1~32个字符，可以包含小写字母，数字，同时必须以小写字母开头。

返回数据

名称	类型	示例值	描述
IsRequireRecovery	Boolean	false	块卷是否可以设置为恢复模式，可能值： true：存在此卷名称，您可以选择设置此卷为恢复模式。 false：卷名称不存在，您可以直接使用云资源对应的OSS Bucket创建新的卷。
Message	String	successful	请求结果描述。
RequestId	String	735B642E-6564-4A87-99A0-3609F67C787E	请求ID。
Code	String	200	状态码。状态码为200表示请求成功。
Success	Boolean	true	请求是否成功。
IsAlreadyExist	Boolean	false	是否已经存在。

示例

请求示例

http(s)://[Endpoint]/?Action=CheckBlockVolumeName
&BucketEndpoint=oss-cn-hangzhou-internal.aliyuncs.com
&BucketName=random***
&VolumeName=alex***
&<公共请求参数>

正常返回示例

XML格式

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

<CheckBlockVolumeNameResponse>
    <IsRequireRecovery>false</IsRequireRecovery>
    <Message>successful</Message>
    <RequestId>735B642E-6564-4A87-99A0-3609F67C787E</RequestId>
    <Code>200</Code>
    <Success>true</Success>
    <IsAlreadyExist>false</IsAlreadyExist>
</CheckBlockVolumeNameResponse>

JSON格式

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

{
  "IsRequireRecovery" : false,
  "Message" : "successful",
  "RequestId" : "735B642E-6564-4A87-99A0-3609F67C787E",
  "Code" : "200",
  "Success" : true,
  "IsAlreadyExist" : false
}

错误码

HttpCode	错误码	错误信息	描述
400	EmptyBucketName	You must enter a valid name for the bucket.	Bucket名称不能为空。
400	EmptyVolumeName	You must enter a valid name for the volume.	卷名称不能为空。
400	EmptyBucketEndpoint	You must specify a valid endpoint for the bucket.	Bucket Endpoint不能为空。
400	InvalidBucketEndpoint	The specified endpoint for the bucket is invalid. The Endpoint must start with oss- and end with .aliyuncs.com.	无效的Bucket Endpoint，Endpoint必须以“oss-”开头，以“.aliyuncs.com”结束。
400	InvalidVolumeName	The specified volume name is invalid. The name must be a maximum of 32 characters in length and contain lower-case letters and digits.The name must start with a lower-case letter.	无效的卷名称，卷名称长度不能超过32个字符，可以包含小写字母、数字，同时必须以小写字母开头。

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