接口功能介绍

根据规格名称、镜像可见类型等，查询可以使用的镜像资源
准备：
1. 在调用前需了解如何构造请求，可参见：如何调用 API - 构造请求
2. OpenAPI 请求需进行加密调用，可参见：如何调用 API - 认证鉴权
注意：
1. 推荐使用查询物理机镜像接口来查询物理机镜像
2. 在调用前，请您认真阅读此文档，包括但不限于参数描述中的“注意”部分

接口约束

接口请求成功需至少满足：
1. 您具有调用此接口的权限
2. 传入的有取值范围的参数的值在取值范围内
3. 传入的 azName 参数所指定的可用区对您而言是存在的
4. 传入的 flavorName 参数所指定的规格对您而言是存在的
5. 传入的 projectID 参数所指定的企业项目对您而言是存在的
6. 传入的 regionID 参数所指定的资源池对您而言是存在的

URI

GET /v4/image/list

路径参数
无

Query参数

请求参数

请求头header参数
无

请求体body参数
无

响应参数

表 returnObj

表 image

枚举参数

参数名 imageVisibilityCode

参数名 imageIntegrityCheckStatus

参数名 imageStatus

参数名 imageVisibility

请求示例

请求url

示例 1：若您在华东 1 欲查询第 1 页（每页最多 10 份镜像）公共镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?regionID=bb9fdb42056f11eda1610242ac110002

示例 2：若您在华东 1 欲查询第 1 页（每页最多 10 份镜像）适用于云主机规格 s7.small.1 的公共镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?flavorName=s7.small.1&regionID=bb9fdb42056f11eda1610242ac110002

示例 3：若您在华东 1 欲查询第 2 页（每页最多 20 份镜像）公共镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?pageNo=2&pageSize=20&regionID=bb9fdb42056f11eda1610242ac110002

示例 4：若您在华东 1 欲查询第 1 页（每页最多 10 份镜像）属于默认企业项目的私有镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?imageVisibilityCode=0&projectID=0&regionID=bb9fdb42056f11eda1610242ac110002

示例 5：若您在华东 1 欲在设定查询内容为 CTyunOS 的情况下查询第 1 页（每页最多 10 份镜像）私有镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?imageVisibilityCode=0&queryContent=CTyunOS&regionID=bb9fdb42056f11eda1610242ac110002

示例 6：若您在华东 1 欲查询第 1 页（每页最多 10 份镜像）已拒绝的共享镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?imageStatus=rejected&imageVisibilityCode=2&regionID=bb9fdb42056f11eda1610242ac110002

示例 7：若您在华东 1 欲查询适用于开发场景的轻量型云主机应用镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?imageScene=dev&imageSubcategory=thin_app&imageVisibilityCode=5&regionID=bb9fdb42056f11eda1610242ac110002

示例 8：若您在华东 1 欲查询适用于云骁智算 GPU 云主机节点且适用于云主机规格 pi7.4xlarge.4 的公共镜像，则可参考如下形式查询可以使用的镜像资源。
GET .../v4/image/list?cwaiType=node&flavorName=pi7.4xlarge.4&regionID=bb9fdb42056f11eda1610242ac110002

请求头header

无

请求体body

无

响应示例

{
  "returnObj": {
    "images": [
      {
        "appVersion": null,
        "architecture": "x86_64",
        "azName": null,
        "bootMode": "bios",
        "chargeableImage": false,
        "containerFormat": "bare",
        "createdTime": 1698145871,
        "createdTimeStr": "2023-10-24T11:11:11Z",
        "cwaiType": null,
        "description": "Test CTyunOS",
        "destinationAccountID": null,
        "destinationUser": null,
        "diskFormat": "raw",
        "diskID": "8888a888-b888-8888-a888-baee8d8ce88c",
        "diskSize": 40,
        "enableImageIntegrityCheck": false,
        "fullECSDiskSize": null,
        "gpuImageCategory": null,
        "hasAcceptedSharedImages": false,
        "imageClass": "ECS",
        "imageDisplayName": null,
        "imageID": "8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa",
        "imageIntegrityCheckStatus": null,
        "imageName": "CTyunOS-test",
        "imageScene": null,
        "imageShareCount": 0,
        "imageSize": 42949672960,
        "imageSource": "cloud_server",
        "imageStatus": "active",
        "imageSubcategory": null,
        "imageType": null,
        "imageVisibility": "private",
        "maximumRAM": 0,
        "minimumRAM": 0,
        "osDistro": "CTyunOS",
        "osType": "linux",
        "osVersion": "23.01",
        "projectID": "0",
        "sourceAccountID": null,
        "sourceServerID": "88f888ea-88ff-88ec-a8bc-888888888fe8",
        "sourceUser": null,
        "supportOneClickSFSMount": false,
        "supportXSSD": false,
        "taskID": null,
        "updatedTime": 1698145871,
        "updatedTimeStr": "2023-10-24T11:11:11Z"
      }
    ],
    "currentPage": 1,
    "currentCount": 1,
    "totalPage": 1,
    "totalCount": 1
  },
  "errorCode": "",
  "message": "SUCCESS",
  "description": "成功",
  "statusCode": 800
}

状态码

请参考 状态码

错误码

请参考 错误码