ListGateway API Reference - Microservices Engine - Alibaba Cloud - Microservices Engine

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 per page.	10
OrderItem	string	No	The sorting criteria.	{}
DescSort	boolean	No	Specifies whether to sort the results in descending order. This parameter is not currently in use.	false
FilterParams	object	No	The filter parameters.
GatewayType	string	No	The gateway type.	Ingress
Name	string	No	The gateway name.	rutain-test
Vpc	string	No	The VPC ID.	vpc-bp13hhyjntbab7w****
GatewayUniqueId	string	No	The unique gateway ID.	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

Element	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 response message.	You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
Code	integer	The response code.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The response data.
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<object>	The list of gateways.
	array<object>	The details of a gateway.
Id	integer	The gateway ID.	153
Name	string	The gateway name.	tesa-test
GatewayUniqueId	string	The unique gateway ID.	gw-5017305290e14cebb8ce5cb6a4****
GatewayType	string	The gateway type.	Ingress
Region	string	The region.	cn-hangzhou
PrimaryUser	string	The ID of the Alibaba Cloud account.	18278117654342
Status	integer	The status of the gateway. Valid values: 0: Creating 1: Creation Failed 2: Running 3: Changing 4: Scaling In 6: Scaling Out 8: Deleting 9: Suspended 10: Restarting 11: Rebuilding 12: Upgrading 13: Upgrade Failed	2
AhasOn	boolean	Indicates whether Application High Availability Service (AHAS) is enabled.	false
ArmsOn	boolean	Indicates whether Application Real-Time Monitoring Service (ARMS) is enabled.	false
Spec	string	The specification.	MSE_GTW_1_2_200_c
Replica	integer	The number of replicas.	2
GmtCreate	string	The creation time.	2021-09-13 19:24:23
GmtModified	string	The modification time.	2021-09-13 19:24:23
StatusDesc	string	The status description.	重启中
Slb	array<object>	The associated SLB instances.
	object	The details of an SLB instance.
SlbIp	string	The IP address of the SLB instance.	153.12.XX.XX
SlbPort	string	The port of the SLB instance.	80
SlbSpec	string	The specification of the SLB instance.	slb.s2.small
Type	string	The network type. Valid values: `PUB_NET`: Internet PRIVATE_NET: VPC	PUB_NET
GatewaySlbStatus	string	The status of the associated SLB instance.	Ready
StatusDesc	string	The status description.	创建中
GatewaySlbMode	string	The mode of the associated SLB instance.	UserHost
SlbId	string	The ID of the SLB instance.	lb-bp1ut8asdfgucjk****
InternetSlb	array<object>	The Internet-facing SLB instances.
	object	The details of the Internet-facing SLB instance.
SlbIp	string	The IP address of the SLB instance.	153.12.XX.XX
SlbPort	string	The port of the SLB instance.	slb.s2.small
SlbSpec	string	The specification of the SLB instance.	slb.s2.small
Type	string	The network type.	PUB_NET
InternetNetworkFlow	string	The public network traffic.	20
GatewaySlbStatus	string	The status of the associated SLB instance.	Ready
StatusDesc	string	The status description.	创建中
GatewaySlbMode	string	The mode of the associated SLB instance.	UserHost
SlbId	string	The ID of the SLB instance.	lb-bp1ut8asdfgucjk****
Upgrade	boolean	Indicates whether the gateway can be upgraded.	false
MustUpgrade	boolean	Indicates whether the gateway must be forcibly upgraded.	false
SupportWasm	boolean	Indicates whether WebAssembly (Wasm) is supported.	true
CurrentVersion	string	The current version.	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 ID of the secondary vSwitch.	vsw-bpbrveck45nf****
InstanceId	string	The instance ID.	mse_ingresspost-cn-0jbvrcex****
ChargeType	string	The billing method.	POSTPAY
EndDate	string	The expiration time.	4792060800000
Tag	string	The tag of the gateway.	test
InitConfig	object	The initialization configurations.
EnableWaf	boolean	Indicates whether Web Application Firewall (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 supported.	false
MseTag	string	The resource tags.	{"tagKey":"tagValue"}
ResourceGroupId	string	The resource group ID.	rg-97hg87vi****
TotalReplica	integer	The total number of replicas, including any auto-scaled replicas.	4
Elastic	boolean	Indicates whether auto scaling is enabled.	true
ElasticReplica	integer	The number of auto-scaled replicas.	2
ElasticType	string	The type of auto scaling. Valid value: CronHPA: Time-based scaling	CronHPA
ElasticPolicy	object	The auto scaling policy.
Elastic	boolean	Indicates whether auto scaling is enabled.	true
MaxReplica	integer	The maximum number of replicas for auto scaling.	10
ElasticType	string	The type of auto scaling. Valid value: CronHPA: Scheduled scaling	CronHPA
TimePolicyList	array<object>	The list of scheduled auto scaling policies.
	object
DesiredReplica	integer	The desired number of replicas for auto scaling.	4
StartTime	string	The start time for auto scaling.	07:00
EndTime	string	The end time for auto scaling.	09:00
LoadWarningThreshold	boolean	Specifies the threshold type for load-based auto scaling: `true` for the warning threshold and `false` for the safety threshold.
EnableScaleTimePolicyList	array<object>	The time periods during which scale-in is allowed.
	object
StartTime	string	The start time of the period.
EndTime	string	The end time of the period.
ElasticInstanceId	string	The ID of the elastic instance for the gateway. This parameter is returned if auto scaling is enabled.	mse_ingresselastic_public_cn-uqm3d0*****
VpcId	string	The ID of the VPC in which the gateway resides.	vpc-uf6heojei217tv14*****
MseVersion	string	The cluster version.
MaintenancePeriod	object	The maintenance window.
TimeZone	string	The time zone.
StartTime	string	The start time of the maintenance window.
EndTime	string	The end time of the maintenance window.
GatewayEntry	array<object>	The ingress configurations for the gateway. This parameter is applicable to Professional Edition instances.
	object
NetType	string	The network type of the ingress. 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	An ingress IP address.	1.2.3.4
HttpPorts	array	The HTTP listener ports.
	integer	An HTTP listener port.	80
HttpsPorts	array	The HTTPS listener ports.
	integer	An HTTPS listener port.	443
VersionLifecycle	string	The version lifecycle.

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": "重启中",
        "Slb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "80",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "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": "创建中",
            "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": false,
          "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.