Retrieve On-Premises Gateway Images with DescribeGatewayImages - Cloud Storage Gateway - Alibaba Cloud - Cloud Storage Gateway

Queries information about on-premises gateway images, including the names and descriptions of the images.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The type of the gateway. Valid values: File: file gateway. Iscsi: block gateway.	File

Response elements

Element	Type	Description	Example
	object
Message	string	The description of the request result.	successful
RequestId	string	The request ID.	30DFF66156-3672-4204-B708-24389F01FC77
Images	object
Image	array<object>	The on-premises gateway image information.
	object	The on-premises gateway image information.
Type	string	The image type.	application/octet-stream
Description	string	The image description. Valid values: sgw.file.ova.description: Use this OVA image to install the Cloud Storage Gateway (CSG) file gateway service on VMware vSphere (version 6.0 and later). sgw.file.vhd.description: Use this VHD image to install the CSG file gateway service on Microsoft Hyper-V. sgw.file.kvm.description: Use this QCOW2 image to install the CSG file gateway service on KVM.	sgw.file.kvm.description
Version	string	The image version.	1.0.40
Size	integer	The image size. Unit: bytes.	1063744588
Url	string	The download URL of the on-premises gateway image. The URL is valid for 1 hour.	http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI**************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv**
Title	string	The i18n key of the on-premises gateway image name. Valid values: sgw.file.ova.title: Cloud storage performance compute-optimized instance file gateway vSphere (v6.0 and later) image. sgw.file.vhd.title: Cloud storage performance compute-optimized instance file gateway Hyper-V image. sgw.file.kvm.title: Cloud storage performance compute-optimized instance file gateway KVM image.	sgw.file.kvm.title
MD5	string	The MD5 checksum of the on-premises gateway image file.	48f43e6a906b28ed30ec40d****
Name	string	The image name.	aliyun/file/1.0.40/image/sgw-file-1.0.39.v***
ModifiedDate	string	The date on which the image was last modified. The date is in the YYYY-MM-DD format.	2019-07-24
Code	string	The status code. A value of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Message": "successful",
  "RequestId": "30DFF66156-3672-4204-B708-24389F01FC77",
  "Images": {
    "Image": [
      {
        "Type": "application/octet-stream",
        "Description": "sgw.file.kvm.description",
        "Version": "1.0.40",
        "Size": 1063744588,
        "Url": "http://sgw-gateway.oss-cn-shanghai.aliyuncs.com/aliyun/file/1.0.40/image/sgw-file-1.0.40.qcow2?Expires=1564045229&OSSAccessKeyId=LTAI****************&Signature=%2BoTNVCGWgxis8GMpvpg5NIRkFv****",
        "Title": "sgw.file.kvm.title",
        "MD5": "48f43e6a906b28ed30ec40d****",
        "Name": "aliyun/file/1.0.40/image/sgw-file-1.0.39.v***",
        "ModifiedDate": "2019-07-24"
      }
    ]
  },
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidGatewayType	The specified type of the gateway is invalid.	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.	Failed to access OSS. We recommend that you submit a ticket in the Alibaba Cloud console.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.