查询关联列表
功能介绍
本接口用于查询租户可见的FPGA镜像与弹性云服务器镜像之间的关联映射关系列表。
 
   目前仅“华北-北京一、华东-上海二、华南-广州”区域支持,其他区域暂未支持。
URI
GET /v1/{project_id}/cloudservers/fpga_image/associations?image_id={image_id}&fpga_image_id={fpga_image_id}&page={page}&size={size}
参数说明请参见表1。
| 
        参数  | 
      
        是否必选  | 
      
        描述  | 
     
|---|---|---|
| 
        project_id  | 
      
        是  | 
      
        项目ID。 获取方法请参见获取项目ID。  | 
     
| 
        image_id  | 
      
        否  | 
      
        ECS镜像ID。  | 
     
| 
        fpga_image_id  | 
      
        否  | 
      
        FPGA镜像ID。  | 
     
| 
        page  | 
      
        否  | 
      
        分页查询的页数。 该参数值需满足如下要求: 
  | 
     
| 
        size  | 
      
        否  | 
      
        分页查询时,每页最多展示的记录数。 
  | 
     
 
   - 只有至少指定fpga_image_id和image_id参数中的一个时,用户才可能查询到关联关系,否则只会返回一个空列表。
 - page和size的参数值均存在时,分页查询功能才会生效。如果只存在一个,系统会显示参数非法的错误。当同时指定image_id和fpga_image_id参数时,page和size参数指定的分页查询功能将不生效。
 
请求消息
无
响应消息
响应参数如表2所示。
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        image_id  | 
      
        String  | 
      
        弹性云服务器镜像ID。  | 
     
| 
        fpgaimages  | 
      
        Array of objects  | 
      
        相关联的FPGA镜像详情列表。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        id  | 
      
        String  | 
      
        FPGA镜像的ID。  | 
     
| 
        name  | 
      
        String  | 
      
        FPGA镜像的名称。  | 
     
| 
        description  | 
      
        String  | 
      
        FPGA镜像的描述信息。  | 
     
| 
        status  | 
      
        String  | 
      
        FPGA镜像的状态。取值如下: 
  | 
     
| 
        size  | 
      
        Integer  | 
      
        FPGA镜像的文件大小,单位为MB。  | 
     
| 
        createdAt  | 
      
        String  | 
      
        FPGA镜像的创建时间。 使用UTC时间。  | 
     
| 
        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/associations
 响应示例
{ 
  "associations": [ 
    { 
      "image_id": "89e38a0a-de83-4f3d-83b9-a2df2c605487", 
      "fpgaimages": [ 
        { 
          "id": "4010a32b5f231f04015f24259efd0429", 
          "name": "relate-test", 
          "description": "relate-test", 
          "status": "active", 
          "size": 40, 
          "createdAt": "2017-10-16 07:46:06", 
          "protected": true, 
          "message": null, 
          "metadata": { 
            "shell_type": "OCL", 
            "shell_version": "1.0" 
          },
          "log_directory": "obs-fpga:vu9p/log"
        }, 
        { 
          "id": "4010a32b5f231f04015f23f0c07c041a", 
          "name": "name123", 
          "description": "desc123", 
          "status": "active", 
          "size": 60, 
          "createdAt": "2017-10-16 06:48:21", 
          "protected": true, 
          "message": null, 
          "metadata": { 
            "shell_type": "OCL", 
            "shell_version": "1.0" 
          },
          "log_directory": "obs-fpga:vu9p/log"
        } 
      ] 
    } 
  ] 
}
 返回值
请参考通用请求返回值。
错误码
请参考错误码。