ListCustomImages - 查询自定义和共享的镜像列表

查询E-HPC产品支持的自定义和共享的镜像列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListCustomImagesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ImageOwnerAliasstring

镜像来源。取值范围:

  • self:自定义镜像
  • others:共享镜像
self
BaseOsTagstring

基础镜像标签,仅管控节点使用。

CentOS_7.2_64
InstanceTypestring

指定实例规格。如果不指定实例规格,则默认查询所有实例规格支持的镜像列表。

ecs.n1.tiny
ClusterIdstring

集群 ID。

  • 如果指定集群 ID,则查询集群所在地域下的所有镜像列表。
  • 如果不指定集群 ID,则默认查询所有集群支持的镜像列表。
ehpc-hz-FYUr32****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE7****
Imagesobject []

E-HPC 支持的自定义镜像和共享镜像的列表。

Statusstring
说明 该参数未开放使用。
Available
PostInstallScriptstring
说明 该参数未开放使用。
example.sh
Descriptionstring

镜像描述。

ExampleDescription
Sizeinteger

镜像大小。单位:GiB

40
ImageOwnerAliasstring

镜像类型。可能值:

  • self:自定义镜像
  • others:共享镜像
self
ImageNamestring

镜像名称。

CHESS5V5.0.27
SkuCodestring
说明 该参数未开放使用。
ECS
PricingCyclestring
说明 该参数未开放使用。
Month
ImageIdstring

镜像 ID。

m-bp181x855551ww5yq****
ProductCodestring
说明 该参数未开放使用。
cmjj028279
Uidstring
说明 该参数未开放使用。
127****
BaseOsTagobject

基础镜像标签。

Platformstring

操作系统平台。可能值:

  • CentOS
  • windows
CentOS
OsTagstring

镜像标签。

CentOS_7.2_64
Versionstring

操作系统版本。

7.2
Architecturestring

操作系统架构。可能值:

  • i386
  • x86_64
i386
OsTagobject

E-HPC 支持的操作系统镜像。

Platformstring

操作系统平台。

CentOS
OsTagstring

镜像标签。

CentOS_7.2_64
Versionstring

操作系统版本。

7.2
Architecturestring

操作系统架构。可能值:

  • i386
  • x86_64
x86_64
BaseOsTagstring

基础镜像标签。

CentOS_7.2_64

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "Images": {
    "ImageInfo": [
      {
        "Status": "Available",
        "PostInstallScript": "example.sh",
        "Description": "ExampleDescription",
        "Size": 40,
        "ImageOwnerAlias": "self",
        "ImageName": "CHESS5V5.0.27",
        "SkuCode": "ECS",
        "PricingCycle": "Month",
        "ImageId": "m-bp181x855551ww5yq****",
        "ProductCode": "cmjj028279",
        "Uid": "127****",
        "BaseOsTag": {
          "Platform": "CentOS",
          "OsTag": "CentOS_7.2_64",
          "Version": "7.2",
          "Architecture": "i386"
        },
        "OsTag": {
          "Platform": "CentOS",
          "OsTag": "CentOS_7.2_64",
          "Version": "7.2",
          "Architecture": "x86_64",
          "BaseOsTag": "CentOS_7.2_64"
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404ImageNotFoundThe specified image does not exist.指定的镜像不存在,请您检查该参数是否正确。
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406DbErrorA database service error occurred.数据库请求失败
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

访问错误中心查看更多错误码。