Gateway SLB Instance Queries with ListGatewaySlb API - Microservices Engine - Alibaba Cloud - Microservices Engine

This operation 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 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: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 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.	EAB345F4-3AC3-560C-B653-65717703****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	Succ
Code	integer	The return code.	200
Success	boolean	Indicates whether the request succeeded. Valid values: `true`: The request succeeded. `false`: The request failed.	true
Data	array<object>	The response data.
	array<object>	The data structure.
Id	string	The unique ID of the record.	ID
SlbId	string	The ID of the SLB instance.	lb-bp1kmnli3hdpreptw2ah3
SlbIp	string	The IP address of the SLB instance.	121.199.XX.XX
SlbPort	string	The ports of the SLB instance.	80,443
Type	string	The network type. Valid values: `PUB_NET`: public network `PRIVATE_NET`: private network	PUB_NET
GatewayId	string	The ID of the gateway.	1
GmtCreate	string	The creation time of the record.	2022-01-14 14:39:16
GatewaySlbMode	string	The source of the SLB association.	UserSelect
GatewaySlbStatus	string	The association status of the SLB instance.	Ready
StatusDesc	string	A detailed description of the status.	Associating
VServerGroupId	string	The ID of the HTTP vServer group.	353
HttpPort	integer	The HTTP port of the vServer group.	80
HttpsPort	integer	The HTTPS port of the vServer group.	443
ServiceWeight	integer	The service weight.	80
EditEnable	boolean	Indicates whether the entry can be edited.	false
HttpsVServerGroupId	string	The ID of the HTTPS vServer group.	353
VsMetaInfo	string	The metadata of the vServer groups.	[{"protocol":"HTTP","vServerGroupName":"k8s/80/**","port":80,"vServerGroupId":"rsp-bp"},{"protocol":"HTTPS","vServerGroupName":"k8s/443/","port":443,"vServerGroupId":"rsp-bp***"}]
VServiceList	array<object>	Details of the SLB listeners.
	object
Port	string	The listener port.	443
Protocol	string	The protocol type. Valid values: HTTPS HTTP	HTTPS
VServerGroupId	string	The ID of the vServer group.	rsp-bp183l2x70***
VServerGroupName	string	The name of the vServer group.	k8s/310/*/istio-system/clusterid
SlbType	string	The type of the SLB instance.

Examples

Success response

JSON format

{
  "RequestId": "EAB345F4-3AC3-560C-B653-65717703****",
  "HttpStatusCode": 200,
  "Message": "Succ",
  "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",
      "VServerGroupId": "353",
      "HttpPort": 80,
      "HttpsPort": 443,
      "ServiceWeight": 80,
      "EditEnable": false,
      "HttpsVServerGroupId": "353",
      "VsMetaInfo": "[{\"protocol\":\"HTTP\",\"vServerGroupName\":\"k8s/80/****\",\"port\":80,\"vServerGroupId\":\"rsp-bp***\"},{\"protocol\":\"HTTPS\",\"vServerGroupName\":\"k8s/443/***\",\"port\":443,\"vServerGroupId\":\"rsp-bp*****\"}]",
      "VServiceList": [
        {
          "Port": "443",
          "Protocol": "HTTPS",
          "VServerGroupId": "rsp-bp183l2x70***",
          "VServerGroupName": "k8s/31**0/***/istio-system/clusterid"
        }
      ],
      "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.