华为云用户手册

响应消息 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 云服务器所在网络名称 List(Dict) 云服务器所在网络，内嵌云服务器网络详细信息，格式参见表4。 表4 云服务器网络参数结构说明 属性 类型 CRUD 默认值 约束 备注 version Integer R 不涉及 4 or 6 IP地址版本，IPv4或者IPv6 addr String R 不涉及 IP地址格式 IP地址

响应消息 响应参数如表2所示。 表2 响应参数 参数 是否必选 参数类型 描述 addresses 是 Object 云服务器网络信息，参考表3。 表3 addresses参数结构说明 参数 是否必选 参数类型 描述 云服务器所在网络名称 是 Array of objects 云服务器所在网络，内嵌云服务器网络详细信息，格式参见表4。 表4 云服务器网络参数结构说明 属性 类型 CRUD 默认值 约束 备注 version Integer R 不涉及 4 or 6 IP地址版本，IPv4或者IPv6 addr String R 不涉及 IP地址格式 IP地址

响应示例 { "networks": [ { "id": "04468f37-500a-4a80-88da-af823e7a1d6c", "cidr_v6": null, "gateway": null, "label": "network_demo1", "broadcast": null, "netmask": null, "cidr": null, "dns2": null, "gateway_v6": null, "netmask_v6": null, "dns1": null }, { "id": "1fcff959-21d0-4ba8-976a-974cb564c977", "cidr_v6": null, "gateway": null, "label": "network_demo2", "broadcast": null, "netmask": null, "cidr": null, "dns2": null, "gateway_v6": null, "netmask_v6": null, "dns1": null } ]}

响应消息 表2 参数说明 参数 是否必选 参数类型 描述 networks 是 Array of objects 云服务器所在网络，内嵌云服务器网络详细信息。详情请参见表3所示。 表3 响应参数 参数 是否必选 参数类型 描述 id 是 String 网络的ID，UUID格式。 label 是 String 网络的名字 broadcast 是 String 固定为null cidr 是 String 固定为null cidr_v6 是 String 固定为null dns1 是 String 固定为null dns2 是 String 固定为null gateway 是 String 固定为null gateway_v6 是 String 固定为null netmask 是 String 固定为null netmask_v6 是 String 固定为null bridge 否 String 固定为null，UUID格式。

响应示例 { "server": { "tenant_id": "7910a6e50b80402ba028c8d96c1b31fe", "image": "", "accessIPv4": "", "addresses": { "03be5c1e-e05d-4905-a105-c3bd9b730bdc": [ { "addr": "192.168.0.72", "version": 4 } ] }, "metadata": {}, "accessIPv6": "", "created": "2018-05-17T03:15:48Z", "hostId": "7dc82f6b1d406200fc63e395cf4829cbffcb49de0e9c75c5773f201f", "flavor": { "links": [ { "rel": "bookmark", "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/flavors/c3.1U1G" } ], "id": "c3.1U1G" }, "OS-DCF:diskConfig": "MANUAL", "user_id": "d698a78532ca430f8daec1858f2b500e", "name": "new-server-test", "progress": 0, "links": [ { "rel": "self", "href": "https://None/v2/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" }, { "rel": "bookmark", "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" } ], "id": "1a19ef4f-be0a-4526-bf2f-14b4464d536a", "updated": "2018-05-21T00:36:27Z", "status": "ACTIVE" }}

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 server 是 Object 云服务器数据结构，详情请参见表3 表3 server字段数据结构说明 参数 是否必选 参数类型 描述 name 否 String 修改后的云服务器名称，字符长度范围为1-255。 description 否 String 对弹性云服务器的任意描述，最大255字节。 微版本2.19及以上版本支持。

响应示例 { "auto_launch_group": { "name": "test", "type": "maintain", "status": "ACTIVE", "task_state": "FULFILLED", "target_capacity": 10, "stable_capacity": 5, "current_capacity": 10, "current_stable_capacity": 5, "excess_fulfilled_capacity_behavior": "terminate", "instances_behavior_with_expiration": "terminate", "valid_since": "2022-11-04T15:58:13Z", "valid_until": "2022-11-06T15:58:13Z", "region_specs": [ { "region_id": "region1", "expect_target_capacity": 10, "expect_stable_capacity": 5, "launch_template_config": { "launch_template": { "launch_template_id": "c516c350-7091-4490-9338-47ddb90360f2", "version": "1.0" }, "overrides": [ { "availability_zone_id": "az1", "flavor_id": "s3.large.2", "spot_price": 2.0, "priority": 4, "weighted_capacity": 6 }, { "availability_zone_id": "az2", "flavor_id": "s3.large.2", "spot_price": 2.0, "priority": 4, "weighted_capacity": 12 } ] } } ], "allocation_strategy": "lowest_price", "spot_price": 0.5, "created_at": "2022-11-03T15:58:13Z" }}

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 auto_launch_group Object 智能购买组详细信息，详情请参见表3。 表3 auto_launch_group参数信息 参数 参数类型 描述 name String 智能购买组名称。 type String 请求类型。 request：一次性。仅在启动时交付实例集群，调度失败后不再重试。 maintain：持续供应。在启动时尝试交付实例集群，并监控容量，未达到目标容量则尝试继续创建E CS 实例。 status string 智能购买组的运行状态。 SUBMITTED：已提交 ACTIVE：运行中 DELETING：删除中 DELETED：已删除 task_state string 智能购买组的任务状态。 HAN DLI NG：购买中 FULFILLED：智能购买组已满配 ERROR：智能购买组异常 target_capacity Integer 智能购买组目标容量。 实例数量或者CPU个数目标容量大于等于stable_capacity。竞价实例的容量为满配容量减去stable_capacity。 stable_capacity Integer 按需实例目标容量。 目标容量指实例数量或CPU个数，必须小于等于target_capacity，智能购买组中可以没有按需实例。 current_capacity Integer 当前已经购买成功的总算力。 current_stable_capacity Integer 当前已经购买成功的按需算力。 excess_fulfilled_capacity_behavior String 超过目标容量或目标容量减少时的实例中断行为。 terminate：释放 noTermination：不释放 instances_behavior_with_expiration String 请求到期时正在运行实例的中断行为。 terminate：释放 noTermination：不释放 valid_since String 请求开始时间，格式为yyyy-MM-ddTHH:mm:ssZ。 valid_until String 请求结束时间，格式为yyyy-MM-ddTHH:mm:ssZ。 region_specs Object 智能购买组在各个区域的配置，详情请参见表4。 allocation_strategy String 实例分配策略。 lowest_price：价格最低策略，智能购买组购买的所有实例的价格总和最低。 prioritized：优先级策略，按照规格设定的优先级创建实例。 capacity_optimized：容量最优化策略，智能购买组购买的实例按照大规格优先进行购买。 spot_price Double 用户愿意为竞价实例每小时支付的最高价格。如果overrides中没有提供价格，可以使用该价格。 created_at String 智能购买组创建时间。 表4 region_specs参数信息 参数 参数类型 描述 region_id String 区域ID。 expect_target_capacity Integer 区域内期望的总算力容量。 expect_stable_capacity Integer 区域内期望的稳定算力容量。 launch_template_config Object 启动模板配置，详情请参见表5。 表5 launch_template_config参数信息 参数 参数类型 描述 launch_template Object 实例的启动模板，详情请参见表6。 overrides Array of objects 实例的详细信息，详情请参见表7。 表6 launch_template参数信息 参数 参数类型 描述 launch_template_id String 实例的启动模板ID，唯一标识一个启动模板。 version String 启动模板版本号。 表7 override参数信息 参数 参数类型 描述 availability_zone_id String 可用区ID flavor_id String 实例规格ID spot_price Double 用户愿意为竞价实例每小时支付的最高价格。 priority Integer 优先级。数值越小，优先级越高，优先购买。 weighted_capacity Double 实例规格的权重。

请求示例 POST https://{endpoint}/v1/{project_id}/servers/{server_id}/tags/action { "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ]}

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 标签列表 action 是 String 操作标识（仅支持小写）：delete（删除） 表3 resource_tag 字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个Unicode字符，不能为空。 同一资源的key值不能重复。 value 否 String 值列表。 每个值最大长度255个Unicode字符，可以为空字符串。

响应示例 { "instanceAction": { "instance_uuid": "e723eb40-f56e-40f9-8c8c-caa517fe06ba", "user_id": "752be40780484291a9cc7ae50fff3e6d", "start_time": "2014-12-11T02:17:49.000000", "request_id": "req-5a429946-c9cc-45cc-b5bd-68864209e5cc", "action": "create", "message": null, "project_id": "89655fe61c4c4a08b9f3e7f9095441b8", "events": [ { "finish_time": "2014-12-11T02:17:58.000000", "start_time": "2014-12-11T02:17:50.000000", "traceback": null, "event": "compute_build_and_run_instance", "result": "Success" } ] }}

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 instanceAction Object 云服务器操作行为，详情请参见表3。 表3 instanceAction字段数据结构说明 参数 是否必选 参数类型 描述 action 是 String 行为动作 instance_uuid 是 String 弹性云服务器ID，UUID格式 message 是 String 行为完成状态信息 project_id 是 String 项目ID request_id 是 String 请求ID start_time 是 String 行为开始时间 user_id 是 String 用户ID events 是 Array of objects 事件信息，详情参见表4 表4 events字段数据结构说明 参数 是否必选 参数类型 描述 event 是 String 行为动作名称 result 是 String 执行结果 traceback 是 String 异常信息 start_time 是 String 事件开始时间 finish_time 是 String 事件结束时间

通用请求返回值 正常 返回值 说明 200 请求成功。 201 请求处理成功。 202 任务提交成功，当前系统繁忙，下发的任务会延迟处理。 204 任务提交成功。 异常 返回值 说明 300 multiple choices 被请求的资源存在多个可供选择的响应。 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 429 Too Many Requests 超出流控值限制。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 公共参数

响应示例 { "floating_ip":{ "id": "05f71f43-f3c9-47ef-ac8d-9f02aef66418", "pool": "external", "ip": "10.154.51.235", "fixed_ip": "192.168.1.2", "instance_id": "8b380f68-5057-4aa2-a33a-170b37218fa8" }}

响应消息 响应参数如表2所示。 表2 响应参数 参数 是否必选 参数类型 描述 floating_ip 是 Object floating_ip对象，参见表3。 表3 floating_ip对象表 参数 是否必选 参数类型 描述 fixed_ip 是 String 私有IP地址。 id 是 String 浮动IP的ID，UUID格式。 instance_id 是 String 被绑定主机的ID，UUID格式。 ip 是 String 浮动IP的IP地址。 pool 是 String 网络资源池名称，用于分配浮动IP地址。

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 keypair Object SSH密钥信息，详情请参见表3。 表3 keypair字段数据结构说明 参数 参数类型 描述 public_key String 密钥对应publicKey信息。 name String 密钥名称。 fingerprint String 密钥对应指纹信息。 created_at String 密钥创建时间。 deleted Boolean 密钥删除标记。 true，表示密钥已被删除。 false，表示密钥未被删除。 deleted_at String 密钥删除时间。 id Integer 密钥ID。 updated_at String 密钥更新时间。 user_id String 密钥所属用户信息。 type String 密钥类型，默认“ssh” 微版本2.2及以上版本支持。

响应示例 { "keypair": { "created_at": "2014-05-07T12:06:13.681238", "deleted": false, "deleted_at": null, "fingerprint": "9d:00:f4:d7:26:6e:52:**:**:**:**:**:**:**:**:**", "id": 1, "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtw*************************************************************************************************************************************************************************************************************************** Generated-by-Nova\n", "updated_at": null, "user_id": "fake" }}

响应示例 { "security_groups": [ { "rules": [ { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "default" }, "ip_protocol": null, "to_port": null, "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "ip_range": {}, "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee" }, { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "default" }, "ip_protocol": null, "to_port": null, "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "ip_range": {}, "id": "f9371051-d7e1-4be4-8748-77b1e0913730" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "default", "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "name": "default" }, { "rules": [ { "from_port": 200, "group": {}, "ip_protocol": "tcp", "to_port": 400, "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "ip_range": { "cidr": "0.0.0.0/0" }, "id": "3330120d-bbd1-4a73-bda9-0196a84d5670" }, { "from_port": 201, "group": {}, "ip_protocol": "tcp", "to_port": 400, "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "ip_range": { "cidr": "0.0.0.0/0" }, "id": "b550c9a6-970a-462d-984e-265e88020818" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "desc-sg", "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "name": "test-sg" } ]}

响应示例 { "security_groups": [ { "rules": [ { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "default" }, "ip_protocol": null, "to_port": null, "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "ip_range": {}, "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee" }, { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "default" }, "ip_protocol": null, "to_port": null, "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "ip_range": {}, "id": "f9371051-d7e1-4be4-8748-77b1e0913730" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "default", "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "name": "default" }, { "rules": [ { "from_port": 200, "group": {}, "ip_protocol": "tcp", "to_port": 400, "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "ip_range": { "cidr": "0.0.0.0/0" }, "id": "3330120d-bbd1-4a73-bda9-0196a84d5670" }, { "from_port": 201, "group": {}, "ip_protocol": "tcp", "to_port": 400, "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "ip_range": { "cidr": "0.0.0.0/0" }, "id": "b550c9a6-970a-462d-984e-265e88020818" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "desc-sg", "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "name": "test-sg" } ]}

响应消息 响应参数如表2所示。 表2 响应参数 参数 是否必选 参数类型 描述 security_groups 是 Array of objects security_group列表，参见表3。 表3 security_group对象 参数 是否必选 参数类型 描述 description 是 String 安全组描述信息，长度0-255 id 是 String 安全组ID，UUID格式 name 是 String 安全组名字，长度0-255 rules 是 Array of objects 安全组规则列表，参见表4 tenant_id 是 String 租户ID或项目ID 表4 security_group_rule对象 参数 是否必选 参数类型 描述 parent_group_id 是 String 相关联的安全组ID，UUID格式。 ip_protocol 是 String 协议类型或直接指定IP协议号，取值可为icmp，tcp，udp或IP协议号。 from_port 是 Integer 起始端口，范围1-65535，且不大于to_port。 ip_protocol设置为icmp时，from_port表示type，范围是0-255。 to_port 是 Integer 终止端口，范围1-65535，且不小于from_port。 ip_protocol设置为icmp时，to_port表示code，范围是0-255，且如果from_port为-1，to_port为-1表示任意ICMP报文。 ip_range 是 Object 对端ip网段，cidr格式，参见表5。 ip_range或者group参数的值，必须有一个为空。 group 是 Object 对端安全组的名称和对端安全组所属租户的租户ID，参见表6。 ip_range或者group参数的值，必须有一个为空。 id 是 String 安全组规则ID，UUID格式。 表5 ip_range对象 参数 是否必选 参数类型 描述 cidr 否 String 对端IP网段，cidr格式。 表6 group对象 参数 是否必选 参数类型 描述 tenant_id 否 String 对端安全组所属租户的租户ID name 否 String 对端安全组的名称

功能介绍 用弹性云服务器创建一个镜像，后续可以使用该镜像创建弹性云服务器。 对于弹性云服务器创建的镜像，会以快照的形式放在存储节点。 该接口为社区原生接口，不适用云服务平台上创建镜像。 如需创建系统盘镜像或数据盘镜像，请使用IMS接口：POST /v2/cloudimages/action，使用指导请参见《 镜像服务 API参考》的“制作镜像”章节。 如需创建整机镜像，请使用IMS接口：POST /v1/cloudimages/wholeimages/action，使用指导请参见《镜像服务API参考》的“制作整机镜像”章节。

接口约束 error状态的弹性云服务器无法用于创建镜像。 对于弹性云服务器创建的镜像，后续使用该镜像创建弹性云服务器时，只能创建在与原弹性云服务器相同的AZ内。 使用弹性云服务器创建的镜像被删除后，关联的快照不会自动删除（原生实现），需要用户自行删除。 使用弹性云服务器创建的镜像不支持用来创建数据盘。 使用本节提供的接口（URI：POST /v2/{project_id}/servers/{server_id}/action 或 POST /v2.1/{project_id}/servers/{server_id}/action）创建的镜像，不支持导出至OBS桶。如需支持导出OBS桶功能，请使用IMS接口：POST /v2/cloudimages/action，使用指导请参见《镜像服务API参考》的“制作镜像”章节。

请求示例 使用指定弹性云服务器创建一个私有镜像，名称为“new-image-name”。 POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action{ "createImage" : { "name" : "new-image-name", "metadata": { "ImageType": "Gold", "ImageVersion": "2.0" } }}

响应示例 { "version":{ "min_version":"2.1", "media-types":[ { "type":"application/vnd.openstack.compute+json;version=2.1", "base":"application/json" } ], "links":[ { "rel":"self", "href":"https://{endpoint}/v2.1/" }, { "rel":"describedby", "href":"http://docs.openstack.org/", "type":"text/html" } ], "id":"v2.1", "updated":"2013-07-23T11:33:21Z", "version":"2.60", "status":"CURRENT" }}

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 versions Object 指定版本信息，详情请参见表3。 表3 versions字段数据结构说明 参数 参数类型 描述 id string 所讨论的版本的通用名称。仅是信息性的，它没有真正的语义。 links Object 链接到资源的问题。有关更多信息，请参见OpenStack Documentation。 详情请参见表4。 media-types Object 媒体类型。详情请参见表5。 min_version string 如果API的这个版本支持微版本，则支持最小的微版本。 如果不支持微版本，这将是空字符串。 status string API版本的状态： CURRENT这是使用的API的首选版本； SUPPORTED：这是一个较老的，但仍然支持的API版本； DEPRECATED：一个被废弃的API版本，该版本将被删除 updated string 一个有特定值的字符串。API版本为2.0时，值为2011-01-21T11:33:21Z ，API版本是2.1时，值为2013-07-23T11:33:21Z。 version string 如果API的这个版本支持微版本，则支持最大的微版本。 如果不支持微版本，这将是空字符串。 表4 links字段数据结构说明 参数 参数类型 描述 href string 相应资源的链接。 rel string self：自助链接包含版本链接的资源。立即链接后使用这些链接。 bookmark：书签链接提供了一个永久资源的永久链接，该链接适合于长期存储。 alternate：备用链接可以包含资源的替换表示形式。例如，OpenStack计算映像可能在OpenStack映像服务中有一个替代表示。 表5 media-types字段数据结构说明 参数 参数类型 描述 base string 基础类型。 type string 媒体类型。

功能介绍 返回指定版本的信息。 为了支持功能不断扩展，Nova API支持版本号区分。Nova中有两种形式的版本号： "主版本号": 具有独立的url。 "微版本号": 通过Http请求头X-OpenStack-Nova-API-Version来使用，从 2.27 版本开始支持新的微版本头：OpenStack-API-Version。 如果使用OpenStack-API-Version的请求头，version对应的value取值格式为 compute 微版本号。 例如：key为OpenStack-API-Version的时候value需要填compute 2.27。

响应示例 { "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" } ] }

响应消息 响应参数如表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”。

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 请求参数 参数 参数类型 是否必选 描述 fpga_image Object 是 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 Object 是 FPGA镜像的元数据信息，要求是合法的JSON（JavaScript Object Notation）对象类型。 metadata在进行JSON序列化后的字符个数不能超过1024。 description String 否 FPGA镜像的描述信息，由中文汉字、中文句号、中文逗号、英文大小写字母、数字、中划线、下划线、英文句号、英文逗号、空格组成，长度0到255个字符。