ListGatewayZone - Microservices Engine - Alibaba Cloud Documentation Center

Obtains a list of zones where a gateway is available.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListGatewayZone	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.	zh

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Code	integer	The response code. The status code 200 indicates that the request was successful.	200
Message	string	The message returned.	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 status code.	NO_PERMISSION
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	The dynamic part in the error message. This parameter is used to replace %s in ErrMessage.	The specified parameter is invalid.
Data	array<object>	The queried zones.
data	object
ZoneId	string	The zone ID.	cn-hangzhou-i
LocalName	string	The local name of the zone.	I

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.