ListGatewayService - Microservices Engine - Alibaba Cloud Documentation Center

Queries a list of services that are subscribed with a gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListGatewayService	get	Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10
OrderItem	string	No	The item based on which entries are sorted.	GmtCreate
DescSort	boolean	No	Specifies whether to enable sorting.	false
FilterParams	object	No	The parameters that are used to specify filter conditions. The values of the parameters are in the format of {"key1":"value1"}.
Name	string	No	The name of the service.	test
SourceType	string	No	The type of the source.	MSE
Namespace	string	No	The namespace to which the service belongs.	public
GroupName	string	No	The group.	test
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-5017305290e14centbrveca****
ServiceProtocol	string	No	The protocol of the service. HTTP HTTPS HTTP2 GRPC DUBBO	HTTP
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	F46CDBA4-B1EE-5C94-8A48-51C10177****
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message returned if the request failed.	You are not authorized to perform this operation.
Code	integer	The return value.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The returned data.
TotalSize	long	The total number of entries returned.	9
PageNumber	integer	The number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 10.	10
Result	array<object>	The data returned.
Services	object	The data structure.
Id	long	The ID.	1
Name	string	The name of the service.	test
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14centbrveca****
GatewayId	long	The gateway ID.	1
SourceType	string	The source type.	MSE
Namespace	string	The namespace.	public
GroupName	string	The group.	test
SourceId	long	The ID of the service source.	2
ServiceNameInRegistry	string	The name of the service that is registered with the service registry.	test
MetaInfo	string	The metadata or IP addresses of the service.	{}
Ips	array	The list of IP addresses.
Ips	string	The IP address.	127.0.2.1
GmtCreate	string	The creation time.	2022-01-07 18:07:57
GmtModified	string	The modification time.	2022-01-07 18:07:57
Versions	array<object>	The service version.
Versions	object	The version.
Name	string	The version number.	v1
ServiceProtocol	string	The protocol of the service.	HTTP
ServicePort	long	The service port number.	80
HealehStatus	string	The health status. Health Unhealthy Unknown	Unhealthy
HealthStatus	string	The health status. Health Unhealthy Unknown	Unhealthy
HealthCheck	boolean	Indicates whether health checks are performed.	true
HealthCheckInfo	object	The information about health checks.
Check	boolean	Indicates whether checks are performed.	true
Protocol	string	The network protocol.	TCP
Timeout	integer	The timeout period.	2
Interval	integer	The health check interval.	2
HealthyThreshold	integer	The threshold for healthy instances.	2
UnhealthyThreshold	integer	The threshold for unhealthy instances.	2
HttpPath	string	The path to which the HTTP request for the health check is sent.	/health
HttpHost	string	The endpoint of the HTTP request for the health check.	http://172.168.0.1
ExpectedStatuses	array	The expected status of the health check.
expectedStatuses	integer	The expected HTTP status.	200
UnhealthyEndpoints	array	The array of endpoints of unhealthy instances.
unhealthyEndpoints	string	The endpoint of the unhealthy instance.	172.168.0.1
GatewayTrafficPolicy	object	The traffic management policy.
Tls	object	The Transport Layer Security (TLS).
Mode	string	The TLS mode. DISABLE SIMPLE MUTUAL ISTIO_MUTUAL	SIMPLE
CertId	string	The ID of the certificate.	5******-cn-hangzhou
CaCertId	string	The ID of the certification authority (CA) certificate.	5******-cn-hangzhou
CaCertContent	string	The public key of the CA certificate .	content
SubjectAltNames	array	The array of subject aliases.
SubjectAltName	string	The subject alias.	name
Sni	string	The Server Name Indication (SNI) value.	name-sni
LoadBalancerSettings	object	The load balancing settings.
LoadbalancerType	string	The load balancing type. ROUND_ROBIN LEAST_CONN RANDOM CONSISTENT_HASH	RANDOM
ConsistentHashLBConfig	object	The consistent hashing settings.
ParameterName	string	The name of the parameter.	param
HttpCookie	object	The cookie-based load balancing parameters.
Name	string	The name of the cookie.	name
Path	string	The path of the cookie.	/path
Ttl	string	The lifecycle of the cookie.	360
MinimumRingSize	long	The minimum value of the hash ring.	10000
ConsistentHashLBType	string	The type based on which consistent hashing load balancing is performed. HEADER COOKIE SOURCE_IP QUERY_PARAMETER	HEADER
WarmupDuration	integer	The prefetch time of the least connection load balancing.	10
Ports	array	The port array.
ports	integer	The port number.	8080

Examples

Sample success responses

JSONformat

{
  "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": ""
      }
    ]
  }
}

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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-06	The response structure of the API has changed	View Change Details
2023-03-31	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-02-22	The response structure of the API has changed	View Change Details
2022-02-22	The internal configuration of the API is changed, but the call is not affected	View Change Details