Chuyển tới nội dung chính

Terms

TerminologyDefinition
ProjectA logical workspace grouping APIs, gateways, and users. All configurations and deployments are managed per project.
API GatewayA component that handles client API requests, enforces policies, and routes requests to backend services.
Gateway URLThe external endpoint assigned to an API Gateway, allowing access to deployed APIs.
Ingress ClassA Kubernetes configuration used to specify which ingress controller (e.g., NGINX, Kong) to use.
Gateway PolicyA rule or logic applied to API requests or responses, such as authentication, logging, or transformation.
Inbound PolicyA policy executed before the request is forwarded to the backend.
Outbound PolicyA policy executed after the backend responds but before the client receives the response.
Kong GatewayThe open-source API gateway engine used by the APIM system for managing API traffic.
KubernetesAn open-source platform for container orchestration, used by APIM to deploy and scale gateways.
PodA basic deployable unit in Kubernetes that contains one or more containers. APIM Gateways run as pods.
AffinityA Kubernetes configuration that controls pod co-location on specific nodes.
TolerationA Kubernetes setting that allows pods to run on nodes with specific taints.
Topology SpreadA configuration that ensures gateway pods are evenly distributed across nodes or zones.
APIA defined interface that allows communication between software services. In APIM, APIs are exposed to external clients.
API ProductA published package of one or more APIs grouped for developer consumption.
API SubscriptionA request made by a developer to gain access to a specific API product.
Developer PortalA web interface where developers can browse, request access to, and test available APIs.
Dev UserAn external developer who uses the Developer Portal to access and consume APIs.
DeveloperA user role representing someone who consumes APIs through the Developer Portal.
APIM ConsoleThe administrative interface for managing projects, APIs, policies, gateways, and users.
Request DashboardA monitoring dashboard showing API request counts, status codes, and performance over time.
Report DashboardA historical reporting tool for viewing API usage statistics across projects or APIs.
Realtime DashboardA dashboard that displays live API traffic metrics and error rates.
API TestA testing tool that allows users to execute API requests directly via Swagger UI.
SwaggerA framework (OpenAPI Specification) used to define and interact with RESTful APIs.
OpenAPIThe official name of the Swagger specification used for API documentation and testing.
JWTJSON Web Token - a compact token format used for securely transmitting claims between parties.
Rate LimitingA policy that restricts the number of API requests allowed within a specific time window.
RedisAn in-memory data store used by the gateway for temporary data such as rate limits or token caches.
Fluent BitA log processor used to collect and forward gateway logs to external observability tools.
AnnotationA key-value pair used to configure metadata for Gateway or Ingress resources.
Ingress AnnotationSpecific annotations used in Kubernetes to fine-tune ingress behavior, such as timeout or path rewrite.
Request TransformerA policy that modifies the structure or content of incoming API requests.
Response TransformerA policy that modifies the structure or content of outgoing API responses.
Request TerminationA policy that stops request processing and returns a fixed error response based on defined rules.
IP RestrictionA policy that allows or denies access to APIs based on the client’s IP address.
Timeout PolicyA policy that defines how long the system waits for a request or response before timing out.
Request Size LimitingA policy that restricts the maximum size of API request payloads.
Stdout LogA policy that logs request and response information to standard output for debugging or audit.
DeploymentThe action of applying API configurations and policies to a Gateway instance.
EnvironmentA logical stage such as development, staging, or production, each with its own settings and endpoints.
Subscription RequestA formal request from a developer to subscribe to an API product.
Manual ApprovalA workflow where an admin manually reviews and approves access or subscriptions.
User RoleA set of permissions assigned to a user (e.g., Admin, API Manager, Viewer) in a project.
Policy TemplateA reusable configuration preset for a gateway policy, used to simplify repeated setups.