调用DescribeGatewayImages接口可以查询线下网关镜像信息。包括线下网关镜像的名称、描述等。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeGatewayImages

系统规定参数。取值:DescribeGatewayImages

Type String File

网关类型。取值范围:

  • File:文件网关。
  • Iscsi:块网关。

返回数据

名称 类型 示例值 描述
Message String successful

请求结果描述。

RequestId String 30DFF66156-3672-4204-B708-24389F01FC77

请求ID。

Images Array of Image

线下网关镜像信息。

Image
Type String application/octet-stream

镜像类型。

Description String sgw.file.kvm.description

镜像描述。可能值:

  • sgw.file.ova.description:用这个ova镜像在VMWare vSphere(支持6.0版本及以上)上安装云存储文件网关服务。
  • sgw.file.vhd.description:用这个vhd镜像在Microsoft HyperV上安装云存储文件网关服务。
  • sgw.file.kvm.description:用这个qcow2镜像在KVM上安装云存储文件网关服务。
Version String 1.0.40

镜像版本。

Size Long 1063744588

镜像大小。单位为Byte。

Url String http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAINaSMVqr8***&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFvE%3D

线下网关的下载地址。有效时间为1小时。

Title String sgw.file.kvm.title

线下网关镜像名字的i18n key。可能值:

  • sgw.file.ova.title:云存储性能型文件网关 vSphere(v6.0及以上)镜像。
  • sgw.file.vhd.title:云存储性能型文件网关HyperV镜像。
  • sgw.file.kvm.title:云存储性能型文件网关KVM镜像。
MD5 String 48f43e6a906b28ed30ec40d8***

线下网关镜像文件的MD5SUM。

Name String aliyun/file/1.0.40/image/sgw-file-1.0.39.v***

镜像名称。

ModifiedDate String 2019-07-24

镜像修改日期。

Code String 200

状态码。状态码为200表示请求成功。

Success Boolean true

请求是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeGatewayImages
&Type=File
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeGatewayImagesResponse>
    <Message>successful</Message>
    <RequestId>6BF67960-7782-4542-98AF-1E4B3B6E514B</RequestId>
    <Images>
        <Image>
            <Type>application/octet-stre**</Type>
            <Description>sgw.file.kvm.description</Description>
            <Version>1.0.40</Version>
            <Size>1063744512</Size>
            <Title>sgw.file.kvm.title</Title>
            <ModifiedDate>2019-07-24</ModifiedDate>
            <Url>http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&amp;OSSAccessKeyId=LTAISMVqr8***&amp;Signature=%2BoTNVCxis8GMpv5NIRkFvE***%3D</Url>
            <Name>aliyun/file/1.0.40/image/sgw-file-1.0.40.qc***</Name>
            <MD5>76069b6a745dd360cd54064b***</MD5>
        </Image>
        <Image>
            <Type>application/x-virtualbox-v***</Type>
            <Description>sgw.file.vhd.description</Description>
            <Version>1.0.39</Version>
            <Size>1819893760</Size>
            <Title>sgw.file.vhd.title</Title>
            <ModifiedDate>2019-07-24</ModifiedDate>
            <Url>http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.39.vhd?Expires=1564045229&amp;OSSAccessKeyId=LTAINaSMVqr8***&amp;Signature=MUfa0layij2ofNWzUAoSxg%3D***</Url>
            <Name>aliyun/file/1.0.40/image/sgw-file-1.0.39.v***</Name>
            <MD5>48f3ce6a906b30ec40d84bf***</MD5>
        </Image>
    </Images>
    <Code>200</Code>
    <Success>true</Success>
</DescribeGatewayImagesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "successful",
  "RequestId" : "6B777960-7782-4542-98AF-1E4B377E514B",
  "Images" : {
    "Image" : [ {
      "Type" : "application/octet-stre**",
      "Description" : "sgw.file.kvm.description",
      "Version" : "1.0.40",
      "Size" : 1063744512,
      "Title" : "sgw.file.kvm.title",
      "ModifiedDate" : "2019-07-24",
      "Url" : "http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAINVqr8ST***&Signature=%2BoTNVCGWgxGMpvpg5NIRkF***%3D",
      "Name" : "aliyun/file/1.0.40/image/sgw-file-1.0.40.qc***",
      "MD5" : "76069b6a745dd360cd54064b***"
    }, {
      "Type" : "application/x-virtualbox-v***",
      "Description" : "sgw.file.vhd.description",
      "Version" : "1.0.39",
      "Size" : 1819893760,
      "Title" : "sgw.file.vhd.title",
      "ModifiedDate" : "2019-07-24",
      "Url" : "http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.39.vhd?Expires=1564045229&OSSAccessKeyId=LTAINaSMVTRZ***&Signature=MUfU5a0layij2ofUIEaAoS***%3D",
      "Name" : "aliyun/file/1.0.40/image/sgw-file-1.0.39.v***",
      "MD5" : "48f3ce6a906b30ec40d84bf***"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidGatewayType The specified type of the gateway is invalid. 无效的网关类型。
500 OSSResourceAccountAccessFail Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console. 访问OSS失败,请登录阿里云控制台提交工单。

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