Crate apisix_admin_client

Apisix Client Library

Provides a REST models for service consumers of Apisix.

Maintained by Trust1Team for Apisix

Modules

• admin_route_requests
• admin_route_responses
• admin_service_requests
• admin_service_responses
• admin_upstream_requests
• admin_upstream_responses
• client
• client_admin_impl
• client_ctrl_impl
• common
• config
• consumer_group_requests
• consumer_group_responses
• consumer_requests
• consumer_responses
• ctrl_responses
• error
• plugins

Structs

• UpstreamBuilder
• UpstreamRequest

Enums

• UpstreamSchema
• UpstreamType
• UpstreamTypeChashAuxiliary

Functions

• admin_check
  Check if the Admin API is up and running
• admin_create_consumer_group_with_id
  Creates or updates a new Consumer group with the specified id
• admin_create_consumer_with_name
  Create new Consumer
• admin_create_route_with_id
  Creates or updates a Route with the specified id
• admin_create_service_with_id
  Creates or updates a Service with the specified id
• admin_create_upstream_with_id
  Creates or updates a Route with the specified id
• admin_delete_consumer
  Removes the Consumer with the specified username
• admin_delete_consumer_group
  Removes the Consumer group with the specified id
• admin_delete_route
  Removes the Route with the specified id
• admin_delete_service
  Removes the Service with the specified id
• admin_delete_upstream
  Creates an Upstream and assigns a random id The default behaviour is that Apisix generated an ID for you, but that causes problems as Apisix allows the use of integers or strings for id’s. We force a random generated string, fallback is the default Apisix behaviour Removes the Upstream with the specified id
• admin_get_consumer
  Fetches specified Consumer by username
• admin_get_consumer_group
  Fetches specified Consumer group by id
• admin_get_consumer_groups
  Fetches a list of all configured Consumer Groups
• admin_get_consumers
  Fetches a list of all Consumers
• admin_get_route
  Fetches specified Route by id
• admin_get_routes
  Fetches a list of all configured Routes
• admin_get_service
  Fetches specified Service by id
• admin_get_services
  Fetches a list of available Services
• admin_get_upstream
  Fetches specified Upstream by id
• admin_get_upstreams
  Fetch a list of all configured Upstreams
• ctrl_garbage_collect
  Triggers a full garbage collection in the HTTP subsystem. Note: When stream proxy is enabled, APISIX runs another Lua VM for the stream subsystem. Full garbage collection is not triggered in this VM.
• ctrl_health_check
  Returns a health check of the APISIX instance
• ctrl_schema
  Returns the JSON schema used by the APISIX instance (untyped JSON)
• get_config_default
  Get configuration based on the Apisix development environment variables Function is used during development, and in combination with a Smart ID demo client application
• get_config_from_env
  Get configuration based on the environment variables (default config override) Function will panic when the environment variables are not set The following variables must be set: