1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口(ProgramFpgaImage)用于在线烧录由客户提供的FPGA镜像文件到指定实例的指定FPGA卡上。
- 只支持对单个实例发起在线烧录FPGA镜像的操作。
- 支持对单个实例的多块FPGA卡同时烧录FPGA镜像，DBDFs参数为空时，默认对指定实例的所有FPGA卡进行烧录。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ProgramFpgaImage。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例的ID信息。 |
| FPGAUrl | 是 | String | FPGA镜像文件的COS URL地址。 |
| DBDFs.N | 否 | Array of String | 实例上FPGA卡的DBDF号，不填默认烧录FPGA镜像到实例所拥有的所有FPGA卡。 |
| DryRun | 否 | Boolean | 试运行，不会执行实际的烧录动作，默认为False。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 在线烧录FPGA镜像
本示例将由客户提供的FPGA镜像文件烧录到实例上的两块FPGA卡
输入示例
GET https://cvm.tencentcloudapi.com/?Action=ProgramFpgaImage
&InstanceId=ins-r8hr2upy
&FPGAUrl=fpga-test-123456.cos.ap-guangzhou.myqcloud.com/test.xclbin
&DBDFs.0=0000:00:08.0
&DBDFs.1=0000:00:09.0
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270dfafb54a7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidInstanceId.Malformed | 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。 |
| InvalidInstanceId.NotFound | 没有找到相应实例。 |
| InvalidParameterValue.IncorrectFormat | 传参格式不对。 |
| InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求，请提供规范的实例ID，类似ins-xxxxxxxx，字母x代表小写字符或数字。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| OperationDenied.InstanceOperationInProgress | 实例正在执行其他操作，请稍后再试。 |
| UnsupportedOperation.NotFpgaInstance | 当前实例不是FPGA机型。 |