Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
组织和团队
/
组织

更新一个组织

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例

更改一个项目的名称。

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

PATCH /orgs/{ORG-ID}

请求路径参数

名称
类型
说明
ORG-ID
字符串
组织的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称
类型
必要性
说明
默认
pretty
布尔
Optional
false
envelope
布尔
Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称
说明
status
HTTP 响应代码
content
预期响应正文
false

请求正文参数

名称
类型
必要性
说明
名称
字符串
必需
组织的新名称。

响应

名称
类型
说明
id
组织的唯一标识符。
isDeleted
布尔
指示组织是否已删除的标志。
links
文档数组
指向子资源和/或相关资源的一个或多个链接。 URL 之间的关系在 Web 链接规范 中进行了解释 。
name
字符串
组织的新名称。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}?pretty=true" \
     --data '
     {
       "name" :  "Organization Name 1"
     }'

响应示例

1{
2  "id": "{ORG-ID}",
3  "isDeleted": false,
4  "links": [{
5      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
6      "rel": "self"
7    },
8    {
9      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups",
10      "rel": "http://mms.mongodb.com/groups"
11    },
12    {
13      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams",
14      "rel": "http://mms.mongodb.com/teams"
15    },
16    {
17      "href": "https://cloud-dev.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/users",
18      "rel": "http://mms.mongodb.com/users"
19    }
20  ],
21  "name": "Organization Name 1"
22}

后退

更新角色

来年

删除