ListCommunityImages - 查询社区镜像

查询社区镜像。

调试

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

授权信息

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

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

请求参数

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

基础镜像操作系统标签。

CentOS_7.2_64
InstanceTypestring

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

ecs.n1.tiny
ClusterIdstring

指定集群 ID。如果该集群支持多操作系统,则查询集群所在地域下的所有镜像列表。

如果不指定集群 ID,则默认查询所有集群支持的镜像列表。

ehpc-hz-FYUr32****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
Imagesarray<object>

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

ImageInfoobject
Statusstring

镜像状态。可能值:

  • UnAvailable:不可用

  • Available:可用

  • Creating:创建中

  • CreateFailed:创建失败

Available
PostInstallScriptstring

安装镜像后执行的脚本。

example.sh
Descriptionstring

镜像描述。

ExampleDescription
Sizeinteger

镜像大小。单位:GiB。

40
ImageOwnerAliasstring

镜像类型。可能值:

  • self:自定义镜像

  • others:共享镜像

self
ImageNamestring

镜像名称。

linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0
SkuCodestring

商品规格码。可能值:

  • ECS:按量付费

  • package:预付费

ECS
PricingCyclestring

镜像计费单位,可能值:

  • Hour:按小时付费

  • Month:按月付费

  • Year:按年付费

Month
ImageIdstring

镜像 ID。

m-bp181x855551ww5yq****
ProductCodestring

云市场的商品标识。

cmjj028279
Uidstring

镜像所有者。

127****
BaseOsTagobject

对应的基础镜像操作系统标签。

Platformstring

操作系统发行版。可能值:

  • CentOS

  • Ubuntu

  • SUSE

  • OpenSUSE

  • Debian

  • CoreOS

  • Aliyun

  • Windows Server 2003

  • Windows Server 2008

  • Windows Server 2012

  • Others Linux

  • Customized Linux

CentOS
OsTagstring

操作系统镜像标签。

CentOS_7.2_64
Versionstring

操作系统版本。

7.2
Architecturestring

操作系统架构。可能值:

  • i386

  • x86_64

x86_64
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-6C044FE73368",
  "Images": {
    "ImageInfo": [
      {
        "Status": "Available",
        "PostInstallScript": "example.sh",
        "Description": "ExampleDescription",
        "Size": 40,
        "ImageOwnerAlias": "self",
        "ImageName": "linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0",
        "SkuCode": "ECS",
        "PricingCycle": "Month",
        "ImageId": "m-bp181x855551ww5yq****",
        "ProductCode": "cmjj028279",
        "Uid": "127****",
        "BaseOsTag": {
          "Platform": "CentOS",
          "OsTag": "CentOS_7.2_64",
          "Version": 7.2,
          "Architecture": "x86_64"
        },
        "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调用出错. %s
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请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
2022-07-15新增 OpenAPI查看变更详情