ListGateway - Microservices Engine - Alibaba Cloud Documentation Center

Queries a list of 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:ListGateway

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries returned per page.	10
OrderItem	string	No	The order information.	{}
DescSort	boolean	No	Specifies whether to enable the sorting feature. This feature is not available.	false
FilterParams	object	No	The parameters related to the node.
GatewayType	string	No	The type of the gateway.	Ingress
Name	string	No	The name of the gateway.	rutain-test
Vpc	string	No	The virtual private cloud (VPC).	vpc-bp13hhyjntbab7w****
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-5017305290e14centbrveca****
InstanceId	string	No	The instance ID.	mse_ingresspre-cn-****
MseTag	string	No	The resource tag.	[{"key":"tagkey","value":"tagvalue"}]
ResourceGroupId	string	No	The resource group ID.	rg-7y2uye*****
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese. en: English.	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	34300B3-52EC-5049-8C96-914098CF****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The message that is returned for the request.	You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
Code	integer	The return value.	200
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The queried meta information.
TotalSize	integer	The total number of entries.	9
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Result	array	The response data.
	object	The information about the gateway.
Id	integer	The gateway ID.	153
Name	string	The gateway name.	tesa-test
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14cebb8ce5cb6a4****
GatewayType	string	The gateway type.	Ingress
Region	string	The region of the gateway.	cn-hangzhou
PrimaryUser	string	The information about the Alibaba Cloud account.	18278117654342
Status	integer	The gateway state. Valid values: 0: The gateway is being created. 1: The gateway failed to be created. 2: The gateway is running. 3: The gateway is changing. 4: The gateway is scaling in. 6: The gateway is scaling out. 8: The gateway is being deleted. 9: The gateway is suspended and to be released. 10: The gateway is restarting. 11: The gateway is being rebuilt. 12: The gateway is being upgraded. 13: The gateway failed to be upgraded.	2
AhasOn	boolean	Indicates whether AHAS is enabled.	false
ArmsOn	boolean	Indicates whether ARMS is enabled.	false
Spec	string	The specifications.	MSE_GTW_1_2_200_c
Replica	integer	The backup.	2
GmtCreate	string	The time when the gateway was created.	2021-09-13 19:24:23
GmtModified	string	The time when the gateway was modified.	2021-09-13 19:24:23
StatusDesc	string	The status description.	Restarting
Slb	array	The SLB collection.
	object	The SLB collection information.
SlbIp	string	The IP address of the SLB instance.	153.12.XX.XX
SlbPort	string	The SLB port.	80
SlbSpec	string	The SLB specifications.	slb.s2.small
Type	string	The network type. Valid values: PUB_NET: Internet PRIVATE_NET: VPC	PUB_NET
GatewaySlbStatus	string	The gateway SLB status.	Ready
StatusDesc	string	The status description.	Creating
GatewaySlbMode	string	The gateway SLB mode.	UserHost
SlbId	string	The ID of the SLB instance.	lb-bp1ut8asdfgucjk****
InternetSlb	array	The Internet SLB.
	object	The data structure.
SlbIp	string	The IP address of the SLB instance.	153.12.XX.XX
SlbPort	string	The SLB port.	slb.s2.small
SlbSpec	string	The SLB specifications.	slb.s2.small
Type	string	The type.	PUB_NET
InternetNetworkFlow	string	The traffic of the gateway.	20
GatewaySlbStatus	string	The gateway SLB status.	Ready
StatusDesc	string	The status description.	Creating
GatewaySlbMode	string	The gateway SLB mode.	UserHost
SlbId	string	The ID of the SLB instance.	lb-bp1ut8asdfgucjk****
Upgrade	boolean	The upgrade.	false
MustUpgrade	boolean	The forced upgrade.	false
SupportWasm	boolean	Indicates whether WASM is supported.	true
CurrentVersion	string	The current version of the gateway.	0.1.0-mse-gw
AppVersion	string	The application version.	1.0.1.0
LatestVersion	string	The latest version.	0.1.0-mse-gw
Vswitch2	string	The vSwitch 2.	vsw-bpbrveck45nf****
InstanceId	string	The instance ID.	mse_ingresspost-cn-0jbvrcex****
ChargeType	string	The billing method.	POSTPAY
EndDate	string	The time when the subscription gateway expires.	4792060800000
Tag	string	The tag.	test
InitConfig	object	The configurations.
EnableWaf	boolean	Indicates whether WAF is enabled.	true
SupportWaf	boolean	Indicates whether WAF is supported.	true
GatewayVersion	string	The gateway version.	1.2.9
RollBack	boolean	Indicates whether rollbacks are allowed.	false
MseTag	string	The resource tag.	{"tagKey":"tagValue"}
ResourceGroupId	string	The resource group ID.	rg-97hg87vi****
TotalReplica	integer	The total number of replicas, including the number of replicas that are automatically scaled out.	4
Elastic	boolean	Indicates whether auto scale-out is enabled.	true
ElasticReplica	integer	The number of replicas that are automatically scaled out.	2
ElasticType	string	The type of auto scale-out. Valid value: CronHPA: scale-out by time	CronHPA
ElasticPolicy	object	The auto scale-out policy.
Elastic	boolean	Indicates whether auto scale-out is enabled.	true
MaxReplica	integer	The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.	10
ElasticType	string	The type of auto scale-out. Valid value: CronHPA: scale-out by time	CronHPA
TimePolicyList	array	The time policy list for auto scale-out.
	object
DesiredReplica	integer	The expected number of replicas for auto scale-out.	4
StartTime	string	The start time of auto scale-out.	07:00
EndTime	string	The end time of auto scale-out.	09:00
LoadWarningThreshold	boolean	The type of the threshold for load-based scaling. The value true indicates that the warning threshold is used. The value false indicates that the security threshold is used.
EnableScaleTimePolicyList	array	The time period during which scale-in is allowed.
	object
StartTime	string
EndTime	string
ElasticInstanceId	string	The gateway elastic instance ID, which is returned when auto scale-out is used.	mse_ingresselastic_public_cn-uqm3d0*****
VpcId	string	The gateway VPC ID.	vpc-uf6heojei217tv14*****
MseVersion	string
MaintenancePeriod	object
TimeZone	string
StartTime	string
EndTime	string
GatewayEntry	array	The ingress address of the gateway that uses the Professional Edition of common instances.
	object
NetType	string	The ingress network type. Valid values: PRIVATE_NET: VPC PUB_NET: Internet	PUB_NET
EntryDomain	string	The ingress domain name.	gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com
IpList	array	The ingress IP addresses.
	string	The ingress IP address.	1.2.3.4
HttpPorts	array	The HTTP listener ports.
	integer	The HTTP listener port.	80
HttpsPorts	array	The HTTPS listener ports.
	integer	The HTTPS listener port.	443
VersionLifecycle	string

Examples

Success response

JSON format

{
  "RequestId": "34300B3-52EC-5049-8C96-914098CF****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 153,
        "Name": "tesa-test",
        "GatewayUniqueId": "gw-5017305290e14cebb8ce5cb6a4****",
        "GatewayType": "Ingress",
        "Region": "cn-hangzhou",
        "PrimaryUser": "18278117654342",
        "Status": 2,
        "AhasOn": false,
        "ArmsOn": false,
        "Spec": "MSE_GTW_1_2_200_c",
        "Replica": 2,
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2021-09-13 19:24:23",
        "StatusDesc": "Restarting\n",
        "Slb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "80",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "Creating\n",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "InternetSlb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "slb.s2.small",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "InternetNetworkFlow": "20",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "Creating\n",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "Upgrade": false,
        "MustUpgrade": false,
        "SupportWasm": true,
        "CurrentVersion": "0.1.0-mse-gw",
        "AppVersion": "1.0.1.0",
        "LatestVersion": "0.1.0-mse-gw",
        "Vswitch2": "vsw-bpbrveck45nf****",
        "InstanceId": "mse_ingresspost-cn-0jbvrcex****",
        "ChargeType": "POSTPAY",
        "EndDate": "4792060800000",
        "Tag": "test",
        "InitConfig": {
          "EnableWaf": true,
          "SupportWaf": true
        },
        "GatewayVersion": "1.2.9",
        "RollBack": false,
        "MseTag": "{\"tagKey\":\"tagValue\"}",
        "ResourceGroupId": "rg-97hg87vi****",
        "TotalReplica": 4,
        "Elastic": true,
        "ElasticReplica": 2,
        "ElasticType": "CronHPA",
        "ElasticPolicy": {
          "Elastic": true,
          "MaxReplica": 10,
          "ElasticType": "CronHPA",
          "TimePolicyList": [
            {
              "DesiredReplica": 4,
              "StartTime": "07:00",
              "EndTime": "09:00"
            }
          ],
          "LoadWarningThreshold": true,
          "EnableScaleTimePolicyList": [
            {
              "StartTime": "",
              "EndTime": ""
            }
          ]
        },
        "ElasticInstanceId": "mse_ingresselastic_public_cn-uqm3d0*****",
        "VpcId": "vpc-uf6heojei217tv14*****",
        "MseVersion": "",
        "MaintenancePeriod": {
          "TimeZone": "",
          "StartTime": "",
          "EndTime": ""
        },
        "GatewayEntry": [
          {
            "NetType": "PUB_NET",
            "EntryDomain": "gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com",
            "IpList": [
              "1.2.3.4"
            ],
            "HttpPorts": [
              80
            ],
            "HttpsPorts": [
              443
            ]
          }
        ],
        "VersionLifecycle": ""
      }
    ]
  }
}

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.