Tham chiếu API này không được dùng nữa. Nó sẽ bị xóa trong một bản phát hành trong tương lai. Để có tham chiếu API mới nhất, hãy xem Đặc tả API quản trị bản đồ MongoDB. Đặc tả API mới này có thể mất vài giây để tải. MongoDB đánh giá cao sự kiên nhẫn của bạn vì nó cải thiện trải nghiệm này
Ghi chú
Nhóm và dự án là các thuật ngữ đồng nghĩa. Của bạn
{GROUP-ID}
giống với ID dự án của bạn. Đối với các nhóm hiện có, ID nhóm/dự án của bạn vẫn giữ nguyên. Tài nguyên và các điểm cuối tương ứng sử dụng thuật ngữ groups
Tạo một trong những điều sau đây
Một điểm cuối riêng cho
AWS hoặc Azure trong dự án Atlas.Một nhóm điểm cuối riêng cho Google Cloud trong một dự án Atlas. Các nhóm điểm cuối đại diện cho một tập hợp các điểm cuối. Để tìm hiểu thêm, hãy xem Thiết lập Điểm cuối Riêng tư
Nếu nỗ lực thêm một điểm cuối hoặc nhóm điểm cuối không thành công, hãy xóa nó, sau đó thử thêm một điểm cuối mới
API quản trị Atlas xác thực bằng HTTP Digest Authentication. Cung cấp khóa công khai API lập trình và khóa riêng tư tương ứng làm tên người dùng và mật khẩu khi xây dựng HTTP request. To learn how to configure API cho dự án Atlas, hãy xem Bắt đầu với API quản trị Atlas.
điều kiện tiên quyết
Bạn phải hoàn thành các bước sau cho nhà cung cấp đám mây của mình trước khi có thể tạo nhóm điểm cuối hoặc điểm cuối riêng tư
Atlas Kubernetes Operator hỗ trợ các điểm cuối riêng tư để kết nối với các cụm chuyên dụng và phiên bản serverless
Khi bạn sử dụng Atlas Kubernetes Operator để định cấu hình các liên kết riêng tư trong Atlas, Atlas sẽ tạo các liên kết riêng
VPC hoặc dịch vụ Liên kết riêng tư và đặt các cụm chuyên dụng hoặc phiên bản serverless trong một khu vực phía sau bộ cân bằng tải trong Atlas VPC or Atlas VNet. To learn more, see the Private Endpoint Overview.Để quản lý các điểm cuối riêng của bạn với Atlas Kubernetes Operator, bạn có thể chỉ định và cập nhật một trong các tham số sau
Đối với các cụm chuyên dụng, hãy chỉ định tham số
spec.privateEndpoints
cho Tài nguyên tùy chỉnh
01curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
Đối với các phiên bản serverless, hãy chỉ định tham số
1 cho Tài nguyên tùy chỉnh1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
21curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
Mỗi khi bạn thay đổi trường
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
3 trong bất kỳ tài nguyên tùy chỉnh nào được hỗ trợ, Atlas Kubernetes Operator sẽ tạo hoặc cập nhật cấu hình Atlas tương ứngMột số cân nhắc và hạn chế áp dụng cho các điểm cuối riêng tư. Để tìm hiểu thêm, hãy xem Thiết lập Điểm cuối Riêng tư
điều kiện tiên quyết
Để kích hoạt kết nối với Atlas Kubernetes Operator tới Atlas bằng các điểm cuối riêng tư, bạn phải
Thủ tục
Để cho phép máy khách kết nối với các cụm chuyên dụng của Atlas hoặc các phiên bản không có máy chủ bằng cách sử dụng các điểm cuối riêng tư, hãy xem các quy trình sau
Thực hiện theo các bước sau để cho phép khách hàng kết nối với cụm dành riêng cho Atlas bằng cách sử dụng các điểm cuối riêng tư
Để tìm hiểu thêm về cách sử dụng điểm cuối riêng tư với Atlas, hãy xem Thiết lập điểm cuối riêng tư
Để thiết lập điểm cuối riêng cho phiên bản không có máy chủ, hãy xem Thiết lập điểm cuối riêng cho phiên bản không có máy chủ
Tham chiếu API này không được dùng nữa. Nó sẽ bị xóa trong một bản phát hành trong tương lai. Để có tham chiếu API mới nhất, hãy xem Đặc tả API quản trị bản đồ MongoDB. Đặc tả API mới này có thể mất vài giây để tải. MongoDB đánh giá cao sự kiên nhẫn của bạn vì nó cải thiện trải nghiệm này
Ghi chú
Nhóm và dự án là các thuật ngữ đồng nghĩa. Của bạn
{GROUP-ID}
giống với ID dự án của bạn. Đối với các nhóm hiện có, ID nhóm/dự án của bạn vẫn giữ nguyên. Tài nguyên và các điểm cuối tương ứng sử dụng thuật ngữ groups
Xóa một điểm cuối riêng cho một phiên bản Atlas serverless. Các phiên bản serverless hỗ trợ các điểm cuối riêng trên
Tham chiếu API này không được dùng nữa. Nó sẽ bị xóa trong một bản phát hành trong tương lai. Để có tham chiếu API mới nhất, hãy xem Đặc tả API quản trị bản đồ MongoDB. Đặc tả API mới này có thể mất vài giây để tải. MongoDB đánh giá cao sự kiên nhẫn của bạn vì nó cải thiện trải nghiệm này
Ghi chú
Nhóm và dự án là các thuật ngữ đồng nghĩa. Của bạn
{GROUP-ID}
giống với ID dự án của bạn. Đối với các nhóm hiện có, ID nhóm/dự án của bạn vẫn giữ nguyên. Tài nguyên và các điểm cuối tương ứng sử dụng thuật ngữ groups
Trả lại thông tin chi tiết cho một điểm cuối riêng tư cho một phiên bản Atlas serverless. Các phiên bản serverless hỗ trợ các điểm cuối riêng trên
AWS .API quản trị Atlas xác thực bằng HTTP Digest Authentication. Cung cấp khóa công khai API lập trình và khóa riêng tư tương ứng làm tên người dùng và mật khẩu khi xây dựng HTTP request. To learn how to configure API cho dự án Atlas, hãy xem Bắt đầu với API quản trị Atlas.
Vai trò bắt buộc
Bạn phải có ít nhất vai trò
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
8 để dự án gọi thành công tài nguyên nàyYêu cầu
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
9GET /groups/{GROUP-ID}/privateEndpoint/serverless/instance/{INSTANCE-NAME}/endpoint/{ENDPOINT-ID}
Tham số đường dẫn yêu cầu
Tham số đường dẫn
Loại
sự cần thiết
Sự miêu tả
{ID NHÓM}
chuỗi
Cần thiết
Chuỗi chữ số 24 hệ thập lục phân duy nhất xác định dự án của bạn
{INSTANCE-NAME}
chuỗi
Cần thiết
Nhãn mà con người có thể đọc được xác định phiên bản không có máy chủ được liên kết với điểm cuối của đối tượng thuê
{ENDPOINT-ID}
chuỗi
Cần thiết
Chuỗi 24 chữ số thập lục phân duy nhất xác định điểm cuối của đối tượng thuê
Yêu cầu tham số truy vấn
Điểm cuối này có thể sử dụng bất kỳ tham số truy vấn yêu cầu HTTP nào có sẵn cho tất cả các tài nguyên API quản trị Atlas. Tất cả những điều này là tùy chọn.
Tên
Loại
sự cần thiết
Sự miêu tả
Mặc định
khá
boolean
Không bắt buộc
Cờ cho biết nội dung phản hồi có nên ở định dạng in đẹp không.
01curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
phong bì
boolean
Không bắt buộc
Cờ cho biết liệu Atlas có nên bọc phản hồi trong phong bì JSON hay không. Tùy chọn này có thể cần thiết cho một số API khách hàng. Những khách hàng này không thể truy cập tiêu đề phản hồi hoặc mã trạng thái HTTP . Để khắc phục điều này, hãy đặt phong bì=true trong truy vấn. Đối với các điểm cuối trả về một kết quả, nội dung phản hồi bao gồm trạng thái HTTP mã phản hồi phong bì Cơ quan phản hồi dự kiến
01curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
Yêu cầu thông số cơ thể
Điểm cuối này không sử dụng HTTP tham số nội dung yêu cầu.
Các yếu tố phản hồi
Tham số phản hồi
Loại
Sự miêu tả
_Tôi
chuỗi
Chuỗi chữ số 24 hệ thập lục phân duy nhất xác định điểm cuối riêng tư
cloudProviderEndpointId
chuỗi
Chuỗi duy nhất xác định giao diện mạng của điểm cuối riêng tư
bình luận
chuỗi
Tuyên bố có thể đọc được của con người được liên kết với điểm cuối riêng tư
tên dịch vụ điểm cuối
chuỗi
Chuỗi duy nhất xác định dịch vụ điểm cuối PrivateLink. MongoDB Cloud trả về
2 trong khi nó tạo dịch vụ điểm cuối1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
thông báo lỗi
chuỗi
Thông báo lỗi mà con người có thể đọc được cho biết tình trạng lỗi liên quan đến việc thiết lập kết nối điểm cuối riêng tư
trạng thái
chuỗi
Nhãn mà con người có thể đọc được cho biết trạng thái hoạt động hiện tại của điểm cuối riêng tư. Giá trị bao gồm.
0, 1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
1, 1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
2, 1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
3, 1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
4, 1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"
51curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2 --header "Accept: application/json" \3 --request GET "//cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless/instance/4 {INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"