DescribeGatewayTypes - - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DescribeGatewayTypes

The operation that you want to perform. Set the value to DescribeGatewayTypes.

GatewayLocation

String

Yes

Cloud

The location of the gateway. Valid values:

Cloud: The gateway is deployed in Alibaba Cloud.
On_Premise: The gateway is deployed on your data center.

Response parameters

Parameter	Type	Example	Description
Code	String	200	The HTTP status code. If the request is successful, 200 is returned.
Message	String	successful	The description of the status code.
RequestId	String	787ECFD0-5F30-44C0-BB8F-56A964F66D01	The ID of the request.
Success	Boolean	true	Indicates whether the request is successful.
Types	String	File,Iscsi	The list of gateway types. The gateway types are separated with commas (,). Valid values: File: file gateway Iscsi: block gateway

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeGatewayTypes
&GatewayLocation=Cloud
&<Common request parameters>

Sample success responses

XML format

<DescribeGatewayTypesResponse>
      <code>200</code>
      <message>successful</message>
      <requestId>787ECFD0-5F30-44C0-BB8F-56A964F66D01</requestId>
      <success>true</success>
      <types>File,Iscsi</types>
</DescribeGatewayTypesResponse>

JSON format

{
    "code":"200",
    "message":"successful",
    "requestId":"787ECFD0-5F30-44C0-BB8F-56A964F66D01",
    "success":true,
    "types":"File,Iscsi"
}

Error codes

HttpCode	Error code	Error message	Description
400	BadRequest	Invalid request. You must specify valid parameters in the request.	The error message returned because the request is invalid. Check the request parameters and try again.
400	InvalidGatewayLocation	The specified location of the gateway is invalid.	The error message returned because the location of the gateway is invalid.

For a list of error codes, visit the API Error Center.