Tùy chỉnh miền của bạn

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X.
thông tin

Khi tạo cổng thông tin cho nhà phát triển, theo mặc định, bạn sẽ được cung cấp một tên miền mẫu Apigee để truy cập vào cổng thông tin đang hoạt động của mình theo định dạng sau:

https://orgname-portalname.apigee.io

Trong đó orgname là tên tổ chức còn portalname được định nghĩa bằng cách sử dụng tên cổng được chuyển đổi sang toàn bộ chữ thường, đồng thời xoá các dấu cách và dấu gạch ngang.

Trước khi khởi chạy cổng thông tin cho nhà phát triển, bạn nên cung cấp tên miền tuỳ chỉnh của riêng mình. Ví dụ: một lựa chọn thay thế phổ biến là:

https://developers.example.com

Để biết các cân nhắc về việc sử dụng miền tuỳ chỉnh với nhà cung cấp danh tính SAML, hãy xem bài viết Sử dụng miền tuỳ chỉnh với nhà cung cấp SAML.

Các phần sau đây mô tả cách tuỳ chỉnh miền của bạn.

Tuỳ chỉnh tên miền (Apigee Edge)

Với cổng thông tin tích hợp Apigee Edge, để tuỳ chỉnh tên miền, hãy làm theo các bước sau:

  1. Đăng ký tên miền của bạn.
  2. Định cấu hình TLS.
  3. Thêm tên miền tuỳ chỉnh vào cổng thông tin của bạn.
  4. Định cấu hình DNS.

Sau khi thêm miền tuỳ chỉnh, bạn có thể chỉnh sửa hoặc tắt miền đó. Để được trợ giúp khắc phục sự cố, hãy xem bài viết Khắc phục sự cố về miền tuỳ chỉnh.

Bước 1: Đăng ký tên miền

Nếu cần đăng ký miền mới, bạn có thể tìm thấy nhiều trang web đăng ký miền phổ biến, chẳng hạn như Google Domains. Việc chọn trang web đăng ký miền nào là tuỳ thuộc vào bạn.

Khi quyết định tên miền, bạn cần chú ý rằng các URL thân thiện với người dùng, mà con người có thể đọc được là yếu tố then chốt để cải thiện khả năng tối ưu hoá cho công cụ tìm kiếm, như mô tả trong bài viết Triển khai quy trình tối ưu hoá cho công cụ tìm kiếm (SEO).

Bước 2: Định cấu hình TLS

Để hỗ trợ HTTPS, bạn cần định cấu hình TLS bằng cách tạo kho khoá và bí danh chứa các chứng chỉ kỹ thuật số cần thiết trong môi trường cổng, như mô tả trong quy trình sau.

Để định cấu hình TLS:

  1. Mua chứng chỉ TLS từ một tổ chức phát hành chứng chỉ có uy tín, chẳng hạn như Google Trust Services. Bạn sẽ quyết định tổ chức phát hành chứng chỉ nào được quyết định.
  2. Đăng nhập vào https://apigee.com/edge.
  3. Chọn tổ chức của bạn trong trình đơn hồ sơ người dùng.
  4. Chọn Quản trị > Môi trường > Kho khoá TLS để hiển thị trang kho khoá TLS.
  5. Chọn cổng thông tin từ trình đơn thả xuống môi trường.

  6. Tạo kho khoá và bí danh như mô tả trong bài viết Tạo kho khoá và kho tin cậy bằng giao diện người dùng Edge.

Bước 3: Thêm tên miền tuỳ chỉnh vào cổng thông tin của bạn

Khi bạn thêm tên miền tuỳ chỉnh vào cổng thông tin của mình, hệ thống sẽ tạo các tài nguyên sau đây cho bạn (sử dụng chính chức năng dùng để áp dụng tên miền tuỳ chỉnh cho một điểm cuối như api.example.com):

  • Máy chủ ảo, nghe trên cổng 443, bằng tên miền tuỳ chỉnh mà bạn chỉ định.

  • Một Proxy API sử dụng URL miền tuỳ chỉnh với điểm cuối đích được đặt thành miền cổng mặc định. Tên của proxy API khớp với tên miền tuỳ chỉnh với các dấu chấm được thay thế bằng dấu gạch dưới. Proxy API được triển khai cho môi trường cổng thông tin.

Cách thêm tên miền tuỳ chỉnh vào cổng thông tin của bạn:

  1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
  2. Chọn Cài đặt trong trình đơn thả xuống ở thanh điều hướng ở trên cùng hoặc trên trang đích.
  3. Nhấp vào thẻ Domains (Miền).
  4. Trong Miền tuỳ chỉnh, hãy hoàn tất các trường sau.
    Trường Nội dung mô tả
    Kho khoá Chọn một kho khoá trong danh sách thả xuống.

    Lưu ý: Danh sách được điền bằng cách sử dụng kho khoá bạn đã tạo trong môi trường cổng thông tin ở bước 2.

    Sau khi bạn chọn một kho khoá, trường Alias (Bí danh) sẽ xuất hiện.

    Email đại diện Chọn bí danh hợp lệ từ danh sách thả xuống.

    Lưu ý: Danh sách này được điền bằng các bí danh bạn đã tạo cho kho khoá đã chọn. Danh sách này không bao gồm những kho khoá có chuỗi chứng chỉ không hợp lệ, miền Apigee hoặc kho lưu trữ tin cậy.

    Để xác định thời điểm một chứng chỉ trong danh sách sẽ hết hạn:

    • Xem các biểu tượng:
      • chứng chỉ hợp lệ Chứng chỉ sẽ hết hạn sau hơn 30 ngày nữa hoặc miền tuỳ chỉnh mà bạn chọn có thể đã được sử dụng.
      • chứng chỉ hết hạn sau 30 ngày Chứng chỉ sẽ hết hạn trong vòng 30 ngày.
      • chứng chỉ đã hết hạn Chứng chỉ đã hết hạn.
    • Đặt con trỏ lên bí danh để hiển thị số ngày còn lại mà chứng chỉ sẽ có hiệu lực.

    Sau khi bạn chọn một bí danh, trường Miền sẽ hiển thị.

    Lâu đài Chọn một miền trong danh sách thả xuống. Nếu bạn đã chọn một bí danh dạng ký tự đại diện, hãy nhập miền con.

    Lưu ý: Danh sách miền được điền bằng cách sử dụng các tên thông dụng và tên thay thế cho chứng chỉ cấp cao nhất trong chuỗi do bí danh đã chọn xác định.

    Sau khi bạn hoàn thành tất cả các trường, biểu tượng trạng thái Miền tuỳ chỉnh sẽ được cập nhật như sau:
    Trạng thái Nội dung mô tả
    Trạng thái hợp lệ Kho khoá, bí danh và miền tuỳ chỉnh là hợp lệ.
    Chứng chỉ sẽ hết hạn sau 30 ngày Chứng chỉ sẽ hết hạn trong vòng 30 ngày.
    Trạng thái không hợp lệ Kho khoá, bí danh và miền tuỳ chỉnh không hợp lệ.
    Ngoài ra, cấu hình DNS đã được xác thực và biểu tượng Định cấu hình trạng thái DNS sẽ được cập nhật như sau:
    Trạng thái Nội dung mô tả
    Trạng thái hợp lệ Cấu hình DNS là hợp lệ.
    Trạng thái không hợp lệ Cấu hình DNS không hợp lệ. Bạn phải định cấu hình DNS, như mô tả trong bài viết Định cấu hình DNS.
  5. Nhấp vào Bật (hoặc Lưu nếu bạn đang chỉnh sửa).
    Bạn có thể bật miền tuỳ chỉnh ngay cả khi miền tuỳ chỉnh hoặc cấu hình DNS không hợp lệ.

Bước 4: Định cấu hình DNS

Tiếp theo, bạn cần thêm bản ghi tên chính tắc (CNAME) vào DNS của miền để trỏ đến {org_name}-portal.apigee.net.

Để xác nhận giá trị CNAME:

  1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
  2. Chọn Cài đặt trong trình đơn thả xuống ở thanh điều hướng ở trên cùng hoặc trên trang đích.
  3. Nhấp vào thẻ Domains (Miền).
  4. Xem giá trị CNAME của tổ chức trong mục Định cấu hình DNS, như trong hình sau: Định cấu hình DNS

Phần sau đây cung cấp ví dụ về bản ghi CNAME mà bạn sẽ định cấu hình cho miền tuỳ chỉnh hiển thị ở trên (tức là cho miền tuỳ chỉnh developers.example.com trong tổ chức myorg):

developers.example.com. CNAME myorg-portal.apigee.net.

Khắc phục sự cố về miền tuỳ chỉnh

Các phần sau đây cung cấp đề xuất giúp bạn khắc phục sự cố về miền tuỳ chỉnh.

Khắc phục sự cố: Xác minh thiết lập DNS của miền bằng dig

Sau khi DNS miền của bạn được cập nhật để bao gồm bản ghi CNAME, sẽ mất một khoảng thời gian để các thay đổi này có hiệu lực với các máy chủ DNS khác trên toàn thế giới. Bạn có thể truy vấn máy chủ DNS của miền để xác minh rằng bản ghi CNAME đã được thiết lập đúng cách, ngay cả trước khi bản ghi được truyền hoàn toàn đến các máy chủ DNS khác bằng cách sử dụng dig.

Ví dụ: lệnh dig sau đây truy vấn máy chủ DNS của miền. Trong đầu ra của lệnh, ANSWER SECTION chứa mục nhập bản ghi CNAME.

$ dig @your.domain.dns developer.mycompany.com
; <<>> DiG 9.8.3-P1 <<>> @your.domain.dns developer.mycompany.com
; (1 server found)
;; global options:  cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 41356
;; flags: qr rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: 0
;; WARNING: recursion requested but not available

;; QUESTION SECTION:
;developer.mycompany.com.       IN  A

;; ANSWER SECTION:
developer.mycompany.com.    29  IN  CNAME   myorg-portal.apigee.net.

;; Query time: 141 msec
;; SERVER: 192.168.1.254#53(192.168.1.254)
;; WHEN: Mon Mar 20 16:41:59 2017
;; MSG SIZE  rcvd: 136

Khắc phục sự cố: Không thể xác định proxy cho máy chủ lưu trữ

Khi bạn thêm tên miền tuỳ chỉnh vào cổng thông tin của mình, theo mặc định, một proxy API sẽ được tạo. Proxy API sẽ sử dụng URL miền tuỳ chỉnh với điểm cuối đích được đặt thành miền cổng thông tin mặc định. Nếu sửa đổi hoặc xoá proxy API được liên kết với một miền tuỳ chỉnh, thì bạn sẽ vô hiệu hoá cấu hình của miền tuỳ chỉnh đó và nhận được thông báo lỗi Unable to identify proxy for host khi tìm cách truy cập vào URL của miền tuỳ chỉnh đó. Ví dụ:


{"fault":{"faultstring":"Unable to identify proxy for host: developers.mycompany.com:443 and url: \/","detail":{"errorcode":"messaging.adaptors.http.flow.ApplicationNotFound"}}}

Cách khôi phục cấu hình miền tuỳ chỉnh trong trường hợp proxy API đã bị sửa đổi hoặc bị xoá:

  1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
  2. Chọn Cài đặt trong trình đơn thả xuống ở thanh điều hướng ở trên cùng hoặc trên trang đích.
  3. Nhấp vào thẻ Domains (Miền).
  4. Nhấp vào Lưu để khôi phục proxy API.

Cập nhật chứng chỉ

Để biết thông tin chung về cách cập nhật chứng chỉ TLS, hãy xem Cập nhật chứng chỉ TLS.

  1. Hãy làm theo các bước trong Bước 2: Định cấu hình TLS.
  2. Làm theo các bước trong Bước 3: Thêm tên miền tuỳ chỉnh vào cổng thông tin của bạn