Thêm Custom Domain
Custom Domain cho phép client gọi API qua domain riêng của bạn, ví dụ api.yourcompany.com, thay cho domain mặc định. API Gateway phục vụ Custom Domain qua HTTPS bằng Certificate bạn chọn.
- Bạn cần sở hữu domain và có quyền sửa DNS record của domain.
- Tổ chức cần có Certificate với Domains (SAN) bao gồm domain cần thêm, ví dụ
*.yourcompany.combao gồmapi.yourcompany.com. Nếu chưa có, hãy import Certificate trước, hoặc import ngay tại Bước 2.
Nhấn vào ảnh để phóng to.
Thêm Custom Domain
Để thêm Custom Domain, bạn thực hiện các bước sau:
- Chọn API Gateway → Gateway ở menu bên trái, nhấn vào tên API Gateway, chọn tab Gateway Endpoint, rồi nhấn Add Domain.
- Nhập các thông tin sau tại form Create Custom Domain:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Domain name | Y | Tên domain đầy đủ, ví dụ api.yourcompany.com. Không gồm https://, không gồm path và không dùng wildcard. Không trùng với Custom Domain khác trong tổ chức. |
| Description | N | Mô tả mục đích của domain. |
| Certificate | Y | Certificate bao gồm domain. Mỗi Certificate trong danh sách hiển thị Domains (SAN) và ngày hết hạn. Để import Certificate mới, nhấn + Import certificate ở cuối danh sách. |
Khi Certificate hợp lệ và bao gồm domain, form hiển thị This certificate covers <domain>. Ô màu xanh bên dưới hiển thị IP Load Balancer của API Gateway kèm biểu tượng sao chép.
- Nhấn Add domain. Nút chỉ dùng được khi domain và Certificate hợp lệ.
Thông báo Create Custom Domain successfully hiển thị. Custom Domain mới nằm ở đầu tab Gateway Endpoint với trạng thái Cert valid. Domain cũng hiển thị ở cột Gateway URL của danh sách API Gateway và ở cột SNIs, Used by của Certificate.
- Tạo DNS record tại nhà cung cấp DNS, trỏ domain tới IP Load Balancer hiển thị trong form. IP này cũng có tại Service Configuration → Load Balancer Configuration → Load Balancer IP của API Gateway.
Hệ thống không kiểm tra DNS. Domain chỉ phục vụ traffic sau khi DNS record trỏ tới IP Load Balancer và thay đổi DNS đã cập nhật xong.
Bạn cũng có thể thêm Custom Domain ngay khi tạo API Gateway, tại bước Endpoint. Xem Tạo API Gateway.
Lỗi thường gặp
| Lỗi | Nguyên nhân | Cách xử lý |
|---|---|---|
| Domain name must be a valid domain, e.g. api.example.com. | Domain có https://, có path, có ký tự không hợp lệ hoặc chỉ có một cấp | Nhập tên domain đầy đủ, ví dụ api.yourcompany.com. |
| Wildcard domains are not supported. Enter a fully qualified domain name, e.g. api.example.com. | Domain chứa * | Nhập một domain cụ thể. Wildcard chỉ dùng trong Domains (SAN) của Certificate. |
| A custom domain must be unique within the organization | Domain đã là Custom Domain của một API Gateway khác trong tổ chức | Dùng domain khác, hoặc xóa domain khỏi API Gateway kia trước. |
| <domain> is not in the domains (SAN) of this certificate, so clients would get a certificate name mismatch. Select a certificate that covers this domain. | Certificate không bao gồm domain | Chọn Certificate có Domains (SAN) chứa domain hoặc wildcard tương ứng. |
| This certificate is expired. Select another certificate or renew it first. / This certificate is not yet valid … | Certificate đã hết hạn hoặc chưa tới ngày hiệu lực | Chọn Certificate khác, hoặc gia hạn Certificate này. |
Kiểm tra Custom Domain
- Gửi request tới một Route qua Custom Domain bằng Postman hoặc curl:
https://<Custom Domain>/<path của Route>. Response phải giống như khi gọi qua domain mặc định.
Lỗi thường gặp
| Lỗi | Nguyên nhân | Cách xử lý |
|---|---|---|
| Request tới domain bị lỗi dù trạng thái là Cert valid | Chưa tạo DNS record, DNS record trỏ sai IP hoặc thay đổi DNS chưa có hiệu lực | Đối chiếu DNS record với IP Load Balancer và chờ DNS cập nhật. |