DescribeImages
1. 接口描述
本接口(DescribeImages)用于查看镜像列表。
2. 请求参数
以下请求参数列表仅列出了接口中需要的请求参数
参数名称
必选
类型
描述
imageName
否
String
镜像名称。
category
否
String
镜像所属分类。
可能值:
CentOS
Windows
Ubuntu
Debian
imageType
否
String
镜像类型。
PUBLIC_IMAGE-公共镜像。
CUSTOM_IMAGE-自定义镜像。
osType
否
String
操作系统类型。
可能值:
windows
linux
imageStatus
否
String
镜像状态。
CREATING-创建中
AVAILABLE-可用
UNAVAILABLE-不可用
pageNum
否
Integer
返回的分页数。
默认为1。
pageSize
否
Integer
返回的分页大小。
默认为20,最大为1000。
3. 响应结果
参数名称
类型
描述
requestId
String
唯一请求 ID。
每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount
Integer
符合条件的数据总数。
4. 代码示例
获取所有可用镜像。
不带任何参数查询所有可用镜像。
POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeImages
<Common Request Params>
Request:
{
"zoneId": "FRA-A",
"osType": "linux",
"pageSize": 3
}
Response:
{
"requestId": "T6818FFFC-B917-4E46-8BEC-D8BBD8FA2AA5",
"response": {
"requestId": "T6818FFFC-B917-4E46-8BEC-D8BBD8FA2AA5",
"dataSet": [
{
"imageVersion": "18.04",
"imageId": "img-EVhEsCuXhCN0urZ7Vt77oOr6K",
"imageName": "Ubuntu Server 18.04 LTS x86 64-bit",
"imageDescription": null,
"osType": "linux",
"imageSize": "30",
"imageStatus": "AVAILABLE",
"category": "Ubuntu",
"imageType": "PUBLIC_IMAGE"
},
{
"imageVersion": "11.5",
"imageId": "img-MJHkbWzEl9anNobblDtpRTDPB",
"imageName": "Debian 11.5 Amd x86 64-bit",
"imageDescription": null,
"osType": "linux",
"imageSize": "30",
"imageStatus": "AVAILABLE",
"category": "Debian",
"imageType": "PUBLIC_IMAGE"
},
{
"imageVersion": "7.4",
"imageId": "img-3ELi56cECstEUqmcQzqIGdiuB",
"imageName": "CentOS 7.4.1708 x86 64-bit",
"imageDescription": null,
"osType": "linux",
"imageSize": "30",
"imageStatus": "AVAILABLE",
"category": "CentOS",
"imageType": "PUBLIC_IMAGE"
}
],
"totalCount": 7
}
}
5. 开发者工具
Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。
6. 错误码
下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码
HTTP状态码
错误码
说明
404
INVALID_ZONE_NOT_FOUND
没有找到指定的区域。
最后更新于