首页 弹性高性能计算E-HPC 开发参考 API参考 API目录 可视化实例 DescribeGWSImages - 查询可视化镜像信息

DescribeGWSImages - 查询可视化镜像信息

更新时间: 2023-09-05 10:47:16

调用DescribeGWSImages查询可视化镜像信息。

调试

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

调试

授权信息

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

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

请求参数

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

当前页码。

起始值:1

默认值:1

1
PageSizeinteger

每页显示的条数。取值范围:1~50

默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

本页条数。

10
RequestIdstring

请求ID。

2777461A-E45E-42F8-8E67-0EBF132E93E0
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目总数。

2
Imagesobject []

可视化镜像信息列表。

Statusstring

镜像状态。可能值:

  • Creating:创建中
  • CreateFailed:创建失败
  • Available:可用
  • UnAvailable:不可用
Available
ImageTypestring

可视化镜像类型。可能值:

  • system:系统镜像
  • custom:自定义镜像
system
Progressstring

镜像进程完成的进度。

100%
Sizeinteger

镜像大小。单位:GB

40
CreateTimestring

镜像创建时间。

2019-05-15T06:05:40.000Z
Namestring

可视化镜像名称。

Windows Server 2019
ImageIdstring

可视化镜像ID。

m-bp1by33e4h650m70lb****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "2777461A-E45E-42F8-8E67-0EBF132E93E0",
  "PageNumber": 1,
  "TotalCount": 2,
  "Images": {
    "ImageInfo": [
      {
        "Status": "Available",
        "ImageType": "system",
        "Progress": "100%",
        "Size": 40,
        "CreateTime": "2019-05-15T06:05:40.000Z",
        "Name": "Windows Server 2019",
        "ImageId": "m-bp1by33e4h650m70lb****"
      }
    ]
  }
}

JSON格式

{
  "PageSize": 10,
  "RequestId": "2777461A-E45E-42F8-8E67-0EBF132E93E0",
  "PageNumber": 1,
  "TotalCount": 2,
  "Images": {
    "ImageInfo": [
      {
        "Status": "Available",
        "ImageType": "system",
        "Progress": "100%",
        "Size": 40,
        "CreateTime": "2019-05-15T06:05:40.000Z",
        "Name": "Windows Server 2019",
        "ImageId": "m-bp1by33e4h650m70lb****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsInvalid param: %s-
406AliyunError其他云产品接口请求失败
407NotAuthorized此请求未获得RAM授权
500UnknownError未知错误,请检查相关参数是否合理,检查后稍后重试。
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

阿里云首页 弹性高性能计算E-HPC 相关技术圈