All Products
Search
Document Center

Cloud Storage Gateway:DescribeGatewayTypes

Last Updated:Aug 04, 2025

Queries the available gateway types for a specified location.

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

GatewayLocation

string

Yes

The location of the gateway. Valid values:

  • Cloud: a cloud gateway.

  • On_Premise: an on-premises gateway.

Cloud

Response parameters

Parameter

Type

Description

Example

object

Types

string

The available types of the gateway. The gateway types are separated by commas. Possible values:

  • File: file gateway.

  • Iscsi: iSCSI gateway.

File,Iscsi

Message

string

The description of the request result.

successful

RequestId

string

The request ID.

787ECFD0-5F30-44C0-BB8F-56A964F66D01

Code

string

The status code. A status code of 200 indicates that the request is successful.

200

Success

boolean

Indicates whether the request is successful.

true

Examples

Success response

JSON format

{
  "Types": "File,Iscsi",
  "Message": "successful",
  "RequestId": "787ECFD0-5F30-44C0-BB8F-56A964F66D01",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 BadRequest Invalid request. You must specify valid parameters in the request.  Invalid request. You must specify valid parameters in the request. 
400 InvalidGatewayLocation The specified location of the gateway is invalid. The specified location of the gateway is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.