接口功能介绍
校验一个镜像文件地址。
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求。
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权。
注意：在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分。
接口约束
接口请求成功需至少满足：
1. 您具有调用此接口的权限。
2. 传入的 imageFileSource 参数所指定的镜像文件地址的格式满足要求。
3. 传入的 regionID 参数所指定的资源池对您而言是存在的。
URI
GET /v4/image/validate-file-source
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageFileSource | 是 | String | 镜像文件地址，即对象存储上的桶内的对象的 URL。注意： 1. 格式应为 {internetEndpoint}/{bucket}/{key}。可使用访问控制 endpoint 查询接口来查询外网 endpoint，可使用查询所有桶接口来查询您拥有的桶的列表，可使用查看对象列表接口来查询存储桶内所有对象。 2. 桶应是在传入的 regionID 参数所指定的资源池的对象存储上属于您的标准存储桶，且未开启服务端加密。 3. 对象应是 QCOW2、RAW、VHD 或 VMDK 格式的镜像文件，且是可读的标准存储对象。特别地，在非多可用区资源池中，此对象应是公共读的。 |
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 三段式码）。 | Openapi.PatternCheck.NotValid | |
| errorCode | String | 同 error 参数。 | Openapi.PatternCheck.NotValid | |
| message | String | 响应状态描述（一般为英文）。 | SUCCESS | |
| description | String | 响应状态描述（一般为中文）。 | 成功 | |
| returnObj | Object | 成功时返回的数据。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| archivedObject | Boolean | 用于表示所指定的对象是否被归档冻结的标识。 | false | |
| encryptedObject | Boolean | 用于表示所指定的对象是否被加密的标识。 | false | |
| publiclyReadableObject | Boolean | 用于表示在非多可用区资源池中所指定的对象是否可公共读的标识。 | true | |
| reachableBucket | Boolean | 用于表示所指定的桶对您而言是否存在的标识。 | true | |
| reachableObject | Boolean | 用于表示所指定的对象对您而言是否存在的标识。 | true | |
| validEndpoint | Boolean | 用于表示所指定的 endpoint 是否有效且归属当前资源池的标识。 | true | |
| validURL | Boolean | 用于表示所指定的 URL 是否满足基本规范的标识。 | true |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"imageFileSource": "https://xxx.zos.ctyun.cn/bucket-xxx/image-xxx",
"regionID": "88f8888888dd88ec888888888d888d8b"
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"archivedObject": false,
"encryptedObject": false,
"publiclyReadableObject": null,
"reachableBucket": true,
"reachableObject": true,
"validEndpoint": true,
"validURL": true
}
}
状态码
请参考 状态码
错误码
请参考 错误码
