文档首页/ 弹性云服务器 ECS/ API参考/ 历史API/ FPGA逻辑文件管理/ 查询FPGA镜像详情列表
更新时间：2022-09-29 GMT+08:00
查看PDF
分享

查询FPGA镜像详情列表

功能介绍

本接口用于查询租户拥有的FPGA镜像详情列表。

目前仅“华北-北京一、华东-上海二、华南-广州”区域支持，其他区域暂未支持。

URI

GET /v1/{project_id}/cloudservers/fpga_image/detail?fpga_image_id={fpga_image_id}&page={page}&size={size}

参数说明请参见表1。

表1 参数说明

参数

是否必选

描述

project_id

是

项目ID。

获取方法请参见获取项目ID。

fpga_image_id

否

FPGA镜像的ID。

page

否

分页查询的页数。

该参数值需满足如下要求：

  • 十进制整数
  • 取值范围[1, 65535)
  • 不能包含“+”

size

否

分页查询时，每页最多展示的记录数。

  • 十进制整数。
  • 取值范围[1, 100]。
  • 不能包含“+”
  • page和size的参数值均存在时，分页查询功能才会生效。如果只存在一个，系统会显示参数非法的错误。
  • 当指定fpga_image_id参数时，page和size参数指定的分页查询功能将不生效。

请求消息

无

响应消息

响应参数如表2所示。

表2 响应参数

参数

参数类型

描述

count

Integer

查询的FPGA镜像数量。

fpgaimages

Array of objects

查询的FPGA镜像详情列表。
表3 fpgaimages字段结构说明

参数

参数类型

描述

id

String

FPGA镜像的ID。

name

String

FPGA镜像的名称。

description

String

FPGA镜像的描述信息。

status

String

FPGA镜像状态。取值如下：

  • initialing：表示创建FPGA镜像任务初始化中。
  • scheduling：表示FPGA镜像等待调度创建。
  • creating：表示FPGA镜像正在创建中。
  • saving：表示FPGA镜像正在上传文件到后端存储。
  • deleting：表示FPGA镜像正在删除中。
  • error：表示FPGA镜像创建失败。
  • active：表示FPGA镜像可以正常使用。

size

Integer

FPGA镜像的文件大小，单位为MB。

createdAt

String

FPGA镜像的创建时间。

使用UTC（Coordinated Universal Time）时间。

protected

Boolean

该FPGA镜像是否受保护。

受保护是指，该FPGA镜像与创建弹性云服务器使用的镜像关联，此时，不可以执行删除FPGA镜像的操作。

message

String

FPGA镜像的附加信息。

metadata

Object

FPGA镜像的元数据信息。

log_directory

String

FPGA镜像的构建日志文件在OBS中的目录路径，格式为“桶名:目录路径”，例如“obs-fpga:vu9p/log”。

请求示例

GET https://{endpoint}/v1/{project_id}/cloudservers/fpga_image/detail

响应示例

{ 
  "count": 2, 
  "fpgaimages": [ 
    { 
      "id": "4010a32c5c7d7711015c81ac714c009d", 
      "name": "FPGA001", 
      "description": "fpga test", 
      "status": "active", 
      "size": 40, 
      "createdAt": "2017-06-07 08:29:41", 
      "protected": false, 
      "message": null, 
      "metadata": { 
        "shell_type": "OCL", 
        "shell_version": "1.0" 
      },
      "log_directory": "obs-fpga:vu9p/log"
    }, 
    { 
      "id": "4010a32c5c7d7711015c813e69bd002c", 
      "name": "FPGA002", 
      "description": "fpga test", 
      "status": "active", 
      "size": 43, 
      "createdAt": "2017-06-07 16:29:30", 
      "protected": true, 
      "messgae": null, 
      "metadata": { 
        "shell_type": "OCL", 
        "shell_version": "1.0" 
      },
      "log_directory": "obs-fpga:vu9p/log"
    } 
  ] 
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： FPGA逻辑文件管理

相关文档