更新时间：2022-09-29 GMT+08:00
注册FPGA镜像
功能介绍
本接口用于注册FPGA镜像。
FPGA镜像是指用户开发的FPGA逻辑文件，通常也称为AEI（Accelerated Engine Image）。在注册FPGA镜像时，该逻辑文件需要存放在用户的OBS（Object Storage Service）桶中。
目前仅“华北-北京一、华东-上海二、华南-广州”区域支持，其他区域暂未支持。
请求消息
请求参数如表2所示。
参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
location | String | 是 | FPGA逻辑文件在OBS桶中的路径，格式为“桶名:文件名”，例如“obs-fpga:fpga.bin”。 桶名的命名规则满足OBS的约束：
文件名的命名规则如下：
|
name | String | 是 | FPGA镜像的名称。 取值范围：
|
metadata | Object | 是 | FPGA镜像的元数据信息，要求是合法的JSON（JavaScript Object Notation）对象类型。 metadata在进行JSON序列化后的字符个数不能超过1024。 |
description | String | 否 | FPGA镜像的描述信息，由中文汉字、中文句号、中文逗号、英文大小写字母、数字、中划线、下划线、英文句号、英文逗号、空格组成，长度0到255个字符。 |
响应消息
响应参数如表4所示。
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | FPGA镜像的ID。 |
status | String | 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"
}
} 返回值
请参考通用请求返回值。
错误码
请参考错误码。
父主题：FPGA逻辑文件管理
