接口功能介绍
校验一个镜像文件地址。
接口约束
无
URI
GET /v4/image/validate-file-source
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
imageFileSource | 是 | String | 镜像文件地址,格式应为 {internetEndpoint}/{bucket}/{key}。可使用访问控制 endpoint 查询接口来查询外网访问 endpoint,可使用查询所有桶接口来查询您拥有的桶的列表,可使用查看对象列表接口来查询存储桶内所有对象。 | https://xxx.zos.ctyun.cn/bucket-xxx/image-xxx | |
regionID | 是 | String | 资源池 ID。可使用资源池列表查询接口来查询您可见的资源池的列表。 | 88f8888888dd88ec888888888d888d8b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码,取值范围(值:描述): 800:成功 900:失败 |
800 | |
error | String | 错误码(product.module.code 三段式码)。 | ||
errorCode | String | 同“error”参数。 | ||
message | String | 响应状态描述(一般为英文)。 | ||
description | String | 响应状态描述(一般为中文)。 | ||
returnObj | Object | 返回参数。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
archive | Boolean | 是否处于归档冻结状态。 | false | |
bucket | Boolean | 对象存储的桶是否存在。 | true | |
encryption | Boolean | 是否加密。 | false | |
object | Boolean | 文件是否存在。 | true |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"imageFileSource": "https://xxx.zos.ctyun.cn/bucket-xxx/image-xxx",
"regionID": "88f8888888dd88ec888888888d888d8b"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"archive": false,
"bucket": true,
"encryption": false,
"object": true
}
}
状态码
请参考 状态码
错误码
请参考 错误码