List all stream routes in a service on a gateway group

GET /apisix/admin/stream_routes

List all stream routes in a service on a gateway group

List stream routes in a service through an APISIX Admin API compatible endpoint under /apisix/admin/. Use this for visibility into current L4 routing rules. Required IAM Permission: Action gateway:GetPublishedService, Resource arn:api7:gateway:gatewaygroup/%s/service/%s

Parameters

• service_id (query, string, required): The unique identifier of the service.
• page (query, integer, optional): Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
• page_size (query, integer, optional): Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
• direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.
• order_by (query, string, optional): Index to order resources by.
• search (query, string, optional): Condition to search resources by.
• gateway_group_id (query, string, required): Gateway group ID. Optional when using the gateway group admin key to authenticate.
• with_publish_info (query, boolean, optional): If true, include publish information in the response, such as apisix_route_id, route_version_id, and service_version_id. The additional information is only useful for the Dashboard and not for API users.

Responses

• 200: Successfully retrieved the paginated list of stream routes.
• allOf variant 1
• list (array, optional): An array of resources.
• total (integer, optional): Total number of objects.
• allOf variant 2
• list (array, optional): The array of routes.
• allOf variant 1
• allOf variant 1
• list[].name (string, optional): The object name.
• list[].labels (object, optional): Key-value pairs of labels.
• list[].desc (string, optional): The object description.
• list[].remote_addr (string, optional): Client address filter. If the client request does not originate from remote_addr, the request will not be forwarded to the stream server.
• anyOf variant 1: IPv4
• anyOf variant 2: IPv4/CIDR
• anyOf variant 3: IPv6
• anyOf variant 4: IPv6/CIDR
• list[].server_addr (string, optional): Stream server address.
• anyOf variant 1: IPAddress
• anyOf variant 1: IPv4
• anyOf variant 2: IPv4/CIDR
• anyOf variant 3: IPv6
• anyOf variant 4: IPv6/CIDR
• anyOf variant 2: Domain
• list[].server_port (integer, optional): Stream server port.
• allOf variant 2
• list[].plugins (object, optional): Key-value pairs of plugins and their configurations on the object.
• allOf variant 2
• list[].id (string, optional): The object ID.
• list[].service_id (string, optional): The service ID.
• list[].gateway_group_id (string, optional): The gateway group ID.
• list[].gateway_group_name (string, optional): The object name.
• list[].created_at (integer, optional): The object created timestamp.
• list[].updated_at (integer, optional): The object updated timestamp.
• 400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
• value (object, optional): The specific resource.
• error_msg (string, optional): The error message.

cURL

curl -X GET '$API_BASE_URL/apisix/admin/stream_routes'