ListGatewayService - Microservices Engine - Alibaba Cloud Documentation Center

Queries the list of services that a gateway has subscribed to.

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:ListGatewayService

get

*Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Page number.	1
PageSize	integer	No	Page size.	10
OrderItem	string	No	Sorting property.	GmtCreate
DescSort	boolean	No	Sort.	false
FilterParams	object	No	Filter condition, in the format of {"key1":"value1"}.
Name	string	No	Service name.	test
SourceType	string	No	Source type.	MSE
Namespace	string	No	Namespace.	public
GroupName	string	No	Group.	test
GatewayUniqueId	string	Yes	Gateway unique identifier ID.	gw-5017305290e14centbrveca****
ServiceProtocol	string	No	Service Agreement. HTTP HTTPS HTTP2 GRPC DUBBO	HTTP
AcceptLanguage	string	No	Language type of the returned information: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	Data structure.
RequestId	string	Request ID.	F46CDBA4-B1EE-5C94-8A48-51C10177****
HttpStatusCode	integer	HTTP status code.	200
Message	string	Error message.	You are not authorized to perform this operation.
Code	integer	Return value.	200
Success	boolean	Request result, with the following values: `true`: The request is successful. `false`: The request failed.	true
Data	object	Return data.
TotalSize	integer	Total number of entries.	9
PageNumber	integer	Page number.	1
PageSize	integer	Maximum number of records per page, default value is 10.	10
Result	array	Return collection.
	object	Data structure.
Id	integer	ID.	1
Name	string	Service name.	test
GatewayUniqueId	string	Gateway unique ID.	gw-5017305290e14centbrveca****
GatewayId	integer	Gateway ID.	1
SourceType	string	Source type.	MSE
Namespace	string	Namespace.	public
GroupName	string	Group.	test
SourceId	integer	Source ID.	2
ServiceNameInRegistry	string	Original service name in the Accreditation Centre.	test
MetaInfo	string	Meta information or IP list.	{}
Ips	array	IP list.
	string	IP.	127.0.2.1
GmtCreate	string	Record creation time.	2022-01-07 18:07:57
GmtModified	string	Record modification time.	2022-01-07 18:07:57
Versions	array	Service version.
	object	Version.
Name	string	Version name.	v1
ServiceProtocol	string	Service Agreement.	HTTP
ServicePort	integer	Service port.	80
HealehStatus	string	Health status. Health Unhealthy Unknown	Unhealthy
HealthStatus	string	Health status. Health Unhealthy Unknown	Unhealthy
HealthCheck	boolean	Whether to perform health check.	true
HealthCheckInfo	object	Health check information.
Check	boolean	Whether to check.	true
Protocol	string	Network protocol.	TCP
Timeout	integer	Timeout.	2
Interval	integer	Health check interval.	2
HealthyThreshold	integer	Healthy Threshold.	2
UnhealthyThreshold	integer	Unhealthy threshold.	2
HttpPath	string	URI of the request for health check HTTP.	/health
HttpHost	string	Health check HTTP request address.	http://172.168.0.1
ExpectedStatuses	array	Expected status values for health check.
	integer	Expected HttpStatus.	200
UnhealthyEndpoints	array	Unhealthy endpoint array
	string	Unhealthy endpoint	172.168.0.1
GatewayTrafficPolicy	object	Traffic management policy.
Tls	object	TLS.
Mode	string	TLS mode. DISABLE SIMPLE MUTUAL ISTIO_MUTUAL	SIMPLE
CertId	string	Certificate ID.	5******-cn-hangzhou
CaCertId	string	CA certificate ID.	5******-cn-hangzhou
CaCertContent	string	CA certificate public key.	content
SubjectAltNames	array	Subject alias array.
	string	Subject alias.	name
Sni	string	Service name identifier.	name-sni
LoadBalancerSettings	object	Load balancing settings.
LoadbalancerType	string	Load balancing policy ROUND_ROBIN LEAST_CONN RANDOM CONSISTENT_HASH	RANDOM
ConsistentHashLBConfig	object	Consistent hash configuration.
ParameterName	string	Parameter name.	param
HttpCookie	object	Cookie-based parameters.
Name	string	Cookie name.	name
Path	string	Cookie path.	/path
Ttl	string	Cookie lifecycle.	360
MinimumRingSize	integer	Hash ring minimum value.	10000
ConsistentHashLBType	string	Consistent hash method. HEADER COOKIE SOURCE_IP QUERY_PARAMETER	HEADER
WarmupDuration	integer	Ramp-up period for minimum requests.	10
Ports	array	Port array.
	integer	Port.	8080
ServiceFQDN	string
DnsServerList	array	DNS server list (for DNS domain name service only)
	string	DNS server address (IP+port)	1.1.1.1:80

Examples

Success response

JSON format

{
  "RequestId": "F46CDBA4-B1EE-5C94-8A48-51C10177****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GatewayId": 1,
        "SourceType": "MSE",
        "Namespace": "public",
        "GroupName": "test",
        "SourceId": 2,
        "ServiceNameInRegistry": "test",
        "MetaInfo": "{}",
        "Ips": [
          "127.0.2.1"
        ],
        "GmtCreate": "2022-01-07 18:07:57",
        "GmtModified": "2022-01-07 18:07:57",
        "Versions": [
          {
            "Name": "v1"
          }
        ],
        "ServiceProtocol": "HTTP",
        "ServicePort": 80,
        "HealehStatus": "Unhealthy",
        "HealthStatus": "Unhealthy",
        "HealthCheck": true,
        "HealthCheckInfo": {
          "Check": true,
          "Protocol": "TCP",
          "Timeout": 2,
          "Interval": 2,
          "HealthyThreshold": 2,
          "UnhealthyThreshold": 2,
          "HttpPath": "/health",
          "HttpHost": "http://172.168.0.1",
          "ExpectedStatuses": [
            200
          ]
        },
        "UnhealthyEndpoints": [
          "172.168.0.1"
        ],
        "GatewayTrafficPolicy": {
          "Tls": {
            "Mode": "SIMPLE",
            "CertId": "5******-cn-hangzhou",
            "CaCertId": "5******-cn-hangzhou",
            "CaCertContent": "content",
            "SubjectAltNames": [
              "name"
            ],
            "Sni": "name-sni"
          },
          "LoadBalancerSettings": {
            "LoadbalancerType": "RANDOM",
            "ConsistentHashLBConfig": {
              "ParameterName": "param",
              "HttpCookie": {
                "Name": "name",
                "Path": "/path",
                "Ttl": "360"
              },
              "MinimumRingSize": 10000,
              "ConsistentHashLBType": "HEADER"
            },
            "WarmupDuration": 10
          }
        },
        "Ports": [
          8080
        ],
        "ServiceFQDN": "",
        "DnsServerList": [
          "1.1.1.1:80"
        ]
      }
    ]
  }
}

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.