文档

DescribeGWSImages - 查询可视化镜像信息

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
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****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
406AliyunErrorAn Alibaba Cloud product 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请求失败,服务暂时不可用

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

  • 本页导读 (1)
文档反馈