Hướng dẫn mongodb update api - api cập nhật mongodb

Tài liệu về nhà → Hướng dẫn sử dụng MongoDBMongoDB Manual


Sử dụng menu chọn ngôn ngữ của bạn ở phía trên bên phải để đặt ngôn ngữ của các ví dụ sau.Select your language drop-down menu in the upper-right to set the language of the following examples.


Ghi chú

Bắt đầu từ MongoDB 4.2, MongoDB có thể chấp nhận một đường ống tổng hợp để chỉ định các sửa đổi để thực hiện thay vì tài liệu cập nhật. Xem trang tham chiếu phương thức để biết chi tiết.

Tất cả các hoạt động viết trong MongoDB đều là nguyên tử ở cấp độ của một tài liệu. Để biết thêm thông tin về MongoDB và tính nguyên tử, hãy xem tính nguyên tử và giao dịch.

Sau khi được đặt, bạn không thể cập nhật giá trị của trường _id và bạn cũng không thể thay thế một tài liệu hiện có bằng một tài liệu thay thế có giá trị trường _id khác nhau.

Đối với các hoạt động ghi, MongoDB bảo tồn thứ tự của các trường tài liệu ngoại trừ các trường hợp sau:

  • Trường _id luôn là trường đầu tiên trong tài liệu.

  • Các bản cập nhật bao gồm renaming tên trường có thể dẫn đến việc sắp xếp lại các trường trong tài liệu.

Với các mối quan tâm ghi, bạn có thể chỉ định mức độ xác nhận được yêu cầu từ MongoDB cho các hoạt động viết. Để biết chi tiết, xem Viết mối quan tâm.

Đối với các điểm cuối trả về một kết quả, cơ quan phản hồi bao gồm:MongoDB Manual

trạng thái

Mã phản hồi HTTP

Cơ thể phản ứng mong đợi

  • Đối với các điểm cuối trả về danh sách các kết quả, đối tượng

    {
      "desc" : "Updated |api| key description for test purposes",
      "id" : "5c47ba5127d9d61b9fd8a27b",
      "links" : [ {
        "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
        "rel" : "self"
      } ],
      "privateKey" : "********-****-****-db2c132ca78d",
      "publicKey" : "kzurbulc",
      "roles" : [ {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_MEMBER"
      }, {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_READ_ONLY"
      } ]
    }
    
    2 là một phong bì. Trình quản lý đám mây thêm trường
    {
      "desc" : "Updated |api| key description for test purposes",
      "id" : "5c47ba5127d9d61b9fd8a27b",
      "links" : [ {
        "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
        "rel" : "self"
      } ],
      "privateKey" : "********-****-****-db2c132ca78d",
      "publicKey" : "kzurbulc",
      "roles" : [ {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_MEMBER"
      }, {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_READ_ONLY"
      } ]
    }
    
    3 vào thân phản hồi.

  • Không có

Yêu cầu tham số cơ thể

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4

Không bắt buộc

  • db.collection.find()

Mô tả khóa. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 được cung cấp, nó phải dài từ 1 đến 250 ký tự.

Hướng dẫn mongodb update api - api cập nhật mongodb

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6

  • Mảng chuỗi

  • Danh sách các vai trò mà khóa API nên có. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số

    {
      "desc" : "Updated |api| key description for test purposes",
      "id" : "5c47ba5127d9d61b9fd8a27b",
      "links" : [ {
        "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
        "rel" : "self"
      } ],
      "privateKey" : "********-****-****-db2c132ca78d",
      "publicKey" : "kzurbulc",
      "roles" : [ {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_MEMBER"
      }, {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_READ_ONLY"
      } ]
    }
    
    4 hoặc tham số
    {
      "desc" : "Updated |api| key description for test purposes",
      "id" : "5c47ba5127d9d61b9fd8a27b",
      "links" : [ {
        "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
        "rel" : "self"
      } ],
      "privateKey" : "********-****-****-db2c132ca78d",
      "publicKey" : "kzurbulc",
      "roles" : [ {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_MEMBER"
      }, {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_READ_ONLY"
      } ]
    }
    
    6. Nếu
    {
      "desc" : "Updated |api| key description for test purposes",
      "id" : "5c47ba5127d9d61b9fd8a27b",
      "links" : [ {
        "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
        "rel" : "self"
      } ],
      "privateKey" : "********-****-****-db2c132ca78d",
      "publicKey" : "kzurbulc",
      "roles" : [ {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_MEMBER"
      }, {
        "orgId" : "5980cfc70b6d97029d82e3f6",
        "roleName" : "ORG_READ_ONLY"
      } ]
    }
    
    6 được cung cấp, phải có ít nhất một vai trò được liệt kê và tất cả các vai trò phải có giá trị cho một tổ chức.

  • Vai trò tổ chức bao gồm:

  • Giá trị vai trò trong API

Vai diễn

  • _id2

  • curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
      --data '{
        "desc" : "Updated |api| key description for test purposes",
        "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
      }'
    
    1New trong phiên bản 3.2

  • curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
      --data '{
        "desc" : "Updated |api| key description for test purposes",
        "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
      }'
    
    2New trong phiên bản 3.2

Trong MongoDB, các hoạt động cập nhật nhắm mục tiêu một bộ sưu tập duy nhất. Tất cả các hoạt động viết trong MongoDB đều là nguyên tử ở cấp độ của một tài liệu.

Bạn có thể chỉ định các tiêu chí hoặc bộ lọc, xác định các tài liệu để cập nhật. Các bộ lọc này sử dụng cùng một cú pháp như các hoạt động đọc.

Để biết ví dụ, xem tài liệu cập nhật.

Xóa hoạt động Xóa các tài liệu khỏi một bộ sưu tập. MongoDB cung cấp các phương pháp sau để xóa tài liệu của bộ sưu tập:

  • curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
      --data '{
        "desc" : "Updated |api| key description for test purposes",
        "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
      }'
    
    3New trong phiên bản 3.2

  • curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
      --header "Accept: application/json" \
      --header "Content-Type: application/json" \
      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
      --data '{
        "desc" : "Updated |api| key description for test purposes",
        "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
      }'
    
    4New trong phiên bản 3.2

Trong MongoDB, xóa các hoạt động nhắm vào một bộ sưu tập duy nhất. Tất cả các hoạt động viết trong MongoDB đều là nguyên tử ở cấp độ của một tài liệu.

Bạn có thể chỉ định các tiêu chí hoặc bộ lọc, xác định các tài liệu để xóa. Các bộ lọc này sử dụng cùng một cú pháp như các hoạt động đọc.

Để biết ví dụ, xem xóa tài liệu.

MongoDB cung cấp khả năng thực hiện các hoạt động viết với số lượng lớn. Để biết chi tiết, xem hoạt động viết hàng loạt.

Mã định danh duy nhất cho khóa API

Mô tả khóa API

  • _id4 >
  • Đã điều chỉnh lại khóa riêng cho khóa API >
  • _id5 >
  • Khóa công khai cho khóa API >
  • Mảng đối tượng

Vai trò mà khóa API có

_id7

PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}

_id8 đại diện cho tổ chức hoặc dự án mà vai trò này được áp dụng. Các giá trị có thể là: _id9 hoặc _id0.

TênLoại hìnhSự mô tả
_id1sợi dâyTên của vai trò. Tài nguyên _id2 trả về tất cả các vai trò mà người dùng có trong Atlas MongoDB hoặc Trình quản lý đám mây. Các giá trị có thể là:organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.
Vai trò tổ chứcsợi dâyVai trò dự án/orgs/{ORG-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.

Ghi chú

Các nhóm và dự án là thuật ngữ đồng nghĩa.

TênLoại hìnhSự mô tảYêu cầu ví dụ En
Người dùng thực hiện yêu cầu có thể được định dạng là db.collection.insertOne()3 hoặc db.collection.insertOne()4.Phản hồi ví dụ EnCơ thể phản ứngdẫn đường
Bạn đã được chuyển hướng từ một phiên bản khác của tài liệu. Nhấp vào đây để trở lại.Phản hồi ví dụ EnCơ thể phản ứngdẫn đường
Bạn đã được chuyển hướng từ một phiên bản khác của tài liệu. Nhấp vào đây để trở lại.API>Tài nguyên API Quản lý đám mây> Tài nguyên API>Khóa API lập trình>
Tổ chức Khóa API lập trình>API>

Tài nguyên API Quản lý đám mây> Tài nguyên API>

Khóa API lập trình>

Tổ chức Khóa API lập trình>

Cập nhật khóa APIURL cơ sở:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
  --data '{
    "desc" : "Updated |api| key description for test purposes",
    "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
  }'
5
Tổ chức Khóa API lập trình>Cập nhật khóa API

URL cơ sở:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
  --data '{
    "desc" : "Updated |api| key description for test purposes",
    "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
  }'
5

Không có

Yêu cầu tham số cơ thể

TênLoại hìnhRequired/OptionalSự mô tả
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4
sợi dâyKhông bắt buộcMô tả khóa. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 được cung cấp, nó phải dài từ 1 đến 250 ký tự.
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6
Mảng chuỗiKhông bắt buộc

Mô tả khóa. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 được cung cấp, nó phải dài từ 1 đến 250 ký tự.

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6

Mảng chuỗiDanh sách các vai trò mà khóa API nên có. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6 được cung cấp, phải có ít nhất một vai trò được liệt kê và tất cả các vai trò phải có giá trị cho một tổ chức.
Vai trò tổ chức bao gồm:Giá trị vai trò trong API
Vai diễn_id2
_id3_id4
_id5_id6
_id7_id8

_id9

TênLoại hìnhSự mô tả
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4
sợi dâyKhông bắt buộc
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4
sợi dâyKhông bắt buộc
Mô tả khóa. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 được cung cấp, nó phải dài từ 1 đến 250 ký tự.
sợi dâyKhông bắt buộc
Mô tả khóa. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 được cung cấp, nó phải dài từ 1 đến 250 ký tự.
sợi dâyKhông bắt buộc
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6
Mảng chuỗiDanh sách các vai trò mà khóa API nên có. Tham số này là tùy chọn; Tuy nhiên, yêu cầu phải chứa tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
4 hoặc tham số
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6. Nếu
{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}
6 được cung cấp, phải có ít nhất một vai trò được liệt kê và tất cả các vai trò phải có giá trị cho một tổ chức.
Vai trò tổ chức bao gồm:sợi dâyKhông bắt buộc
_id1sợi dây

Tên của vai trò.Tài nguyên _id2 trả về tất cả các vai trò mà người dùng có trong Atlas MongoDB hoặc Trình quản lý đám mây.Các giá trị có thể là:

  • Vai trò tổ chức

    Giá trị vai trò trong APIVai diễn
    _id2_id3
    _id4_id5
    _id6_id7
    _id8_id9
    _id0_id1
  • Vai trò dự án

    Ghi chú

    Các nhóm và dự án là thuật ngữ đồng nghĩa.

    • renaming3
    • renaming4
    • renaming5
    • renaming6
    • renaming7
    • renaming8
    • renaming9
    • db.collection.insertOne()0
    • renaming3
    • db.collection.insertOne()2

Yêu cầu ví dụ En

Ghi chú

Các nhóm và dự án là thuật ngữ đồng nghĩa.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
  --data '{
    "desc" : "Updated |api| key description for test purposes",
    "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
  }'

Yêu cầu ví dụ En

Người dùng thực hiện yêu cầu có thể được định dạng là db.collection.insertOne()3 hoặc db.collection.insertOne()4.

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}