Tạo API Gateway
API Gateway là hạ tầng nền của FPT API Gateway: mọi Route, Service, Upstream, Consumer và Plugin đều thuộc về một API Gateway. Vì vậy tạo API Gateway là việc cần làm đầu tiên, trước khi cấu hình các đối tượng khác.
Tạo API Gateway sẽ cấp phát hạ tầng thật (cụm node, Load Balancer) trong VPC bạn chọn và phát sinh chi phí.
Nhấn vào ảnh để phóng to.
Tạo API Gateway
Màn hình tạo API Gateway là wizard 4 bước: Basic Information → Service Configuration → Endpoint → Review & Create. Bạn chỉ sang được bước sau khi mọi field bắt buộc (dấu * đỏ) của bước hiện tại đã hợp lệ.
Để tạo API Gateway, bạn thực hiện các bước sau:
-
Chọn API Gateway → Gateway ở menu bên trái, nhấn Create Gateway.
-
Nhập các thông tin sau tại bước Basic Information:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Name | Y | Tên API Gateway, hiển thị ở danh sách và ở ô chọn API Gateway của các màn Route, Service, Upstream. Tối đa 255 ký tự, bắt đầu bằng chữ cái, chỉ gồm chữ a-z, số 0-9 và -. Ví dụ: gateway-test-01. |
| Description | N | Mô tả mục đích của API Gateway, ví dụ phục vụ hệ thống nào, môi trường nào. Tối đa 500 ký tự. |
| Deployment Type | Y | Chọn Dedicated Cloud: API Gateway chạy trên hạ tầng VPC của khách hàng, FPT triển khai và vận hành. Serverless và Self-managed là tính năng sắp ra mắt. |
| Access type | Y | Public (mặc định): API Gateway được cấp URL công khai, gọi được từ Internet. Private: chỉ truy cập được trong cùng VPC. |
- Nhấn Next, nhập thông tin phần Launch configuration tại bước Service Configuration:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Cloud Provider | Y | Nhà cung cấp hạ tầng. Điền sẵn FPT Smart Cloud. |
| Tenant | Y | Tenant trên FPT Cloud Console đứng tên tài nguyên. Danh sách lấy theo tài khoản đang đăng nhập. |
| Region | Y | Vùng triển khai, quyết định độ trễ tới người dùng cuối. |
| VPC | Y | VPC chứa cụm API Gateway. Danh sách lấy theo Tenant và Region đã chọn. |
| Subnet | Y | Subnet thuộc VPC trên, nơi đặt các Worker node. |
| Storage Policy | Y | Chính sách lưu trữ (mức IOPS) cho disk của Worker node. |
| Flavor | Y | Tài nguyên của mỗi Worker node, ví dụ 2 vCPU - 4GB RAM, 4 vCPU - 8GB RAM, 8 vCPU - 16GB RAM. Danh sách chỉ gồm các flavor vừa quota của VPC. |
| Worker nodes | Y | Số node của cụm API Gateway, từ 1 đến 10. |
Các field Region → VPC → Subnet tải theo thứ tự: field sau để trống cho tới khi chọn field trước, và đổi một field sẽ xóa giá trị các field sau.
Nếu Tenant / Region chưa có VPC, ô VPC hiển thị No data kèm liên kết FPT Cloud Console Portal và nút Create VPC. Nhấn vào một trong hai để mở FPT Cloud Console ở tab mới, tạo VPC, rồi quay lại chọn tiếp. Ô Subnet có thông báo tương tự khi VPC chưa có Subnet.
Môi trường phát triển hoặc tải thấp: 2 vCPU - 4GB RAM, 1 node. Môi trường production: 4 vCPU - 8GB RAM trở lên và từ 2 node, vì chạy 1 node thì không có dự phòng khi node đó gặp sự cố.
- Nhập thông tin phần Autoscaling configuration để cụm tự tăng / giảm số node theo tải:
- Autoscaling = Enable (mặc định): nhập thêm các thông tin sau.
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Minimum nodes | Y | Số node tối thiểu cụm luôn duy trì, từ 1 đến 10. |
| Maximum nodes | Y | Số node tối đa cụm được mở rộng tới, từ 1 đến 10 và phải lớn hơn hoặc bằng Minimum nodes. |
| CPU scale-out threshold | Y | Ngưỡng % CPU trung bình. Vượt ngưỡng này, hệ thống xem xét thêm node. Mặc định 80. |
| Memory scale-out threshold | Y | Ngưỡng % RAM trung bình. Vượt ngưỡng này, hệ thống xem xét thêm node. Mặc định 80. |
- Autoscaling = Disable: 4 field trên bị ẩn, cụm chạy cố định đúng số Worker nodes đã nhập.
- Chọn Load Balancer Size tại Load balancer configuration:
Basic-1,Basic-2hoặcAdvanced-2. Gói này quyết định số kết nối đồng thời và throughput của Load Balancer đứng trước cụm. Chọn gói lớn hơn khi lưu lượng API dự kiến cao.
- Nhấn Next, chọn endpoint tại bước Endpoint:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Default Endpoint | N | Domain hệ thống cấp cho API Gateway. Mặc định bật. |
| Custom Domain | N | Mặc định tắt: hệ thống cấp domain mặc định, bạn có thể thêm custom domain sau. Bật để nhập ngay Domain name và chọn Certificate phủ domain đó. |
Nếu tắt Default Endpoint, bạn phải bật Custom Domain và nhập domain, certificate hợp lệ, vì custom domain trở thành endpoint duy nhất của API Gateway.
- Nhấn Next để sang bước Review & Create. Kiểm tra lại toàn bộ thông tin, được nhóm theo Basic Information, Launch configuration, Autoscaling configuration, Load balancer configuration và Endpoint. Muốn sửa, nhấn Previous để quay lại bước tương ứng.
Kiểm tra kỹ Tenant, Region, VPC, Subnet trước khi tạo. Các giá trị này không đổi được sau khi cụm đã tạo. Nếu sai, bạn phải xóa API Gateway và tạo lại từ đầu.
- Nhấn Create để hoàn tất.
Thông báo Create API Gateway successfully hiện ra, API Gateway mới hiển thị ở đầu danh sách API Gateway Manager với trạng thái Processing.
Ở bất kỳ bước nào, bạn có thể thoát bằng Cancel hoặc liên kết API Gateway ở đầu màn hình. Dữ liệu đang nhập sẽ không được lưu.
Theo dõi trạng thái sau khi tạo
Quá trình khởi tạo chạy nền (dựng cụm, triển khai ứng dụng API Gateway, cấp domain) và có thể kéo dài đến vài giờ.
| Trạng thái | Ý nghĩa |
|---|---|
| Processing | API Gateway đang được khởi tạo, chưa dùng được. Cột Gateway URL đã có URL nhưng URL chưa phục vụ traffic. |
| Active | Khởi tạo thành công. Gateway URL dùng được, bạn có thể chọn API Gateway ở các màn Route, Service, Upstream, Consumer, Plugin. |
| Error | Khởi tạo thất bại, API Gateway không phục vụ traffic. |
Trạng thái tự làm mới định kỳ. Nhấn Refresh để cập nhật ngay.
Lỗi thường gặp
| Lỗi | Nguyên nhân | Cách xử lý |
|---|---|---|
| Name is required | Bỏ trống Name | Nhập tên API Gateway. |
| Please select a deployment type | Chưa chọn Deployment Type | Chọn Dedicated Cloud. |
| Name has invalid characters | Tên không bắt đầu bằng chữ cái, hoặc có ký tự ngoài a-z, 0-9 và - | Đổi tên theo quy tắc ở Bước 2. |
| Name must be at most 255 characters long | Tên dài quá 255 ký tự | Rút ngắn tên. |
| Description must be at most 500 characters long | Mô tả dài quá 500 ký tự | Rút ngắn mô tả. |
| Worker nodes must be at least 1 / Worker nodes must be at most 10 | Worker nodes ngoài khoảng 1–10 | Nhập số từ 1 đến 10. |
| Minimum nodes must be at least 1 / must be at most 10 (tương tự với Maximum nodes) | Giá trị ngoài khoảng 1–10 | Nhập số từ 1 đến 10. |
| Maximum nodes must be greater than Minimum nodes | Maximum nodes nhỏ hơn Minimum nodes | Tăng Maximum nodes hoặc giảm Minimum nodes. |
| Something went wrong. Please try again later | Timeout hoặc lỗi hệ thống khi nhấn Create. Form giữ nguyên dữ liệu đã nhập | Nhấn Create lại sau giây lát. |
| API Gateway chuyển sang Error | Khởi tạo thất bại phía hạ tầng. Màn hình danh sách không hiển thị lý do | Xóa API Gateway rồi tạo lại. Nếu vẫn Error, liên hệ bộ phận hỗ trợ để kiểm tra quota VPC, Subnet, Storage Policy. |