文档首页 > > API参考> API(推荐)> FPGA逻辑文件管理> 注册FPGA镜像

注册FPGA镜像

分享
更新时间: 2019/11/21 GMT+08:00

功能介绍

本接口用于注册FPGA镜像。

FPGA镜像是指用户开发的FPGA逻辑文件,通常也称为AEI(Accelerated Engine Image)。在注册FPGA镜像时,该逻辑文件需要存放在用户的OBS(Object Storage Service)桶中。

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

URI

POST /v1/{project_id}/cloudservers/fpga_image

参数说明请参见表1

表1 参数说明

参数

是否必选

描述

project_id

项目ID。

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

请求消息

请求参数如表2所示。

表2 请求参数

参数

参数类型

是否必选

描述

fpga_image

Dict

FPGA镜像信息详情。

表3 fpga_image字段结构说明

参数

参数类型

是否必选

描述

location

String

FPGA逻辑文件在OBS桶中的路径,格式为“桶名:文件名”,例如“obs-fpga:fpga.bin”。

桶名的命名规则满足OBS的约束:

  • 由英文小写字母、数字以及特殊字符“.”“-”组成。
  • 只能以数字或字母开头和结尾。
  • 长度3~63个字符。
  • 不能是ip地址。
  • 不能包含“..”“.-”“-.”字符串。

文件名的命名规则如下:

  • 由英文大、小写字母,数字,中划线,下划线,斜杠,英文句号组成。
  • 必须以“.bin”或“xclbin”结尾。
  • 长度4~64个字符。

name

String

FPGA镜像的名称。

取值范围:

  • 只能由英文字母、数字、下划线、中划线组成。
  • 长度1~64个字符。

metadata

Dict

FPGA镜像的元数据信息,要求是合法的JSON(JavaScript Object Notation)对象类型。

metadata在进行JSON序列化后的字符个数不能超过1024。

description

String

FPGA镜像的描述信息,由中文汉字、中文句号、中文逗号、英文大小写字母、数字、中划线、下划线、英文句号、英文逗号、空格组成,长度0到255个字符。

响应消息

响应参数如表4所示。

表4 响应参数

参数

参数类型

描述

fpga_image

dict

FPGA镜像信息详情。

表5 fpga_image字段结构说明

参数

参数类型

描述

id

String

FPGA镜像的ID。

status

String

FPGA镜像状态。取值如下:

  • saving:表示FPGA镜像正在上传文件到后端存储。
  • deleting:表示FPGA镜像正在删除中。
  • error:表示FPGA镜像创建失败。
  • active:表示FPGA镜像可以正常使用。

请求示例

POST https://{endpoint}/v1/{project_id}/cloudservers/fpga_image
{ 
  "fpga_image": { 
    "location": "obs-fpga:fpga.bin", 
    "name": "fpga-image-test", 
    "description": "fpga description", 
    "metadata": { 
      "shell_type": "OCL", 
      "shell_version": "1.0" 
    } 
  } 
}

响应示例

{
  "fpga_image": {
    "status": "saving",
    "id": "4010a32c5c62bad9015c62dc2290002b"
  }
}

返回值

请参考通用请求返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区