ListGatewaySlb - Microservices Engine - Alibaba Cloud Documentation Center

Queries gateway entry SLB instances.

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 support 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:ListGatewaySlb

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-1cef5440bf2d484db419fb264d4f****
AcceptLanguage	string	No	The language type of the returned information: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	Data structure.
RequestId	string	The request ID.	EAB345F4-3AC3-560C-B653-65717703****
HttpStatusCode	integer	HTTP status code.	200
Message	string	The returned message.	The request is successfully processed.
Code	integer	The return code.	200
Success	boolean	The request result. Valid values: `true`: The request is successful. `false`: The request failed.	true
Data	array	The returned data.
	object	Data structure.
Id	string	ID	ID
SlbId	string	SLB ID	lb-bp1kmnli3hdpreptw2ah3
SlbIp	string	SLB IP	121.199.XX.XX
SlbPort	string	SLB port.	80,443
Type	string	Network type PUB_NET: Internet PRIVATE_NET: Private network	PUB_NET
GatewayId	string	Gateway ID.	1
GmtCreate	string	Creation time.	2022-01-14 14:39:16
GatewaySlbMode	string	Source.	UserSelect
GatewaySlbStatus	string	Association status.	Ready
StatusDesc	string	Status description.	Associating
VServerGroupId	string	HTTP vServer group ID.	353
HttpPort	integer	HTTP port (vServer group).	80
HttpsPort	integer	HTTPS port (vServer group).	443
ServiceWeight	integer	Service weight.	80
EditEnable	boolean	Whether it is editable.	false
HttpsVServerGroupId	string	HTTPS vServer group ID.	353
VsMetaInfo	string	vServer group metadata.
VServiceList	array	SLB listener information.
	object
Port	string	Port.
Protocol	string	Protocol Type. HTTPS HTTP
VServerGroupId	string	vServer group ID.
VServerGroupName	string	vServer group name.
SlbType	string

Examples

Success response

JSON format

{
  "RequestId": "EAB345F4-3AC3-560C-B653-65717703****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": "ID",
      "SlbId": "lb-bp1kmnli3hdpreptw2ah3",
      "SlbIp": "121.199.XX.XX",
      "SlbPort": "80,443",
      "Type": "PUB_NET",
      "GatewayId": "1",
      "GmtCreate": "2022-01-14 14:39:16",
      "GatewaySlbMode": "UserSelect",
      "GatewaySlbStatus": "Ready",
      "StatusDesc": "Associating\n",
      "VServerGroupId": "353",
      "HttpPort": 80,
      "HttpsPort": 443,
      "ServiceWeight": 80,
      "EditEnable": false,
      "HttpsVServerGroupId": "353",
      "VsMetaInfo": "",
      "VServiceList": [
        {
          "Port": "",
          "Protocol": "",
          "VServerGroupId": "",
          "VServerGroupName": ""
        }
      ],
      "SlbType": ""
    }
  ]
}

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.