ListGatewayZone - Microservices Engine - Alibaba Cloud Documentation Center

Queries the available zones for gateways.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListGatewayZone

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: `zh`: Chinese. `en`: English. Default: `zh`.	zh

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	integer	The status code. If the `Success` parameter is `true`, the value of this parameter is `200`.	200
Message	string	The response message.	OK
RequestId	string	The request ID.	EE5C32A1-BC0E-4B79-817C-103E4EDF****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
ErrorCode	string	The error code.	NO_PERMISSION
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The placeholder in the dynamic error message.	code
DynamicMessage	string	The dynamic error message that is used to replace the `%s` placeholder in the ErrMessage parameter.	The specified parameter is invalid.
Data	array<object>	A list of zones.
	object	The data structure of a zone.
ZoneId	string	The zone ID.	cn-hangzhou-i
LocalName	string	The local name of the zone.	I
SupportQat	boolean

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Success": true,
  "ErrorCode": "NO_PERMISSION",
  "HttpStatusCode": 200,
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": [
    {
      "ZoneId": "cn-hangzhou-i",
      "LocalName": "I",
      "SupportQat": true
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.