按类型获取一个项目的代理

在此页面上

Resource

请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

2024 年 8 月 30 日以后，Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。

用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。: 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth2.0 身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。

获取指定类型的所有代理（即监控、备份或自动化）为一个项目。

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

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

Resource

GET /groups/{PROJECT-ID}/agents/{TYPE}

请求路径参数

名称	类型	说明
PROJECT-ID	字符串	拥有代理 API 密钥的项目的唯一标识符。
类型	字符串	要检索的代理类型。 TYPE可以是以下值之一： `MONITORING` `BACKUP` `AUTOMATION`

请求查询参数

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

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印的标志格式。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点，`content` 对象是一个信封。Cloud Manager 将 `status` 字段添加到响应正文。	`false`
backupJobsEnabledOnly	布尔	Optional	指示是否从响应中排除未启用备份数据库的守护进程的标志。将其设置为`false`以包含将`backupJobsEnabled`标志设置为`false`的守护进程配置。	`true`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

名称	类型	说明
`typeName`	字符串	代理的类型： `MONITORING` 、 `BACKUP`或`AUTOMATION` 。
`hostname`	字符串	主节点主机名。主机通常可能有别名，因此主节点是 Cloud Manager 决定的最佳可用名称。
`confCount`	数字	配置调用次数。
`lastConf`	timestamp	上次配置调用的日期和时间。
`stateName`	字符串	代理的当前状态。 `stateName`可以返回以下值： `ACTIVE`：代理处于活动状态并正在运行 `STANDBY`：代理处于待命状态 `NO_PROCESSES`：代理未管理、监控或备份任何进程。
`pingCount`	数字	仅适用于监控代理。监控代理已发送到`hostname` URL 的网络探测（ping）次数。
`isManaged`	布尔	仅适用于监控和备份代理。指定 Cloud Manager 是否托管代理。
`lastPing`	timestamp	仅适用于监控代理。最近一次 ping 的时间。
`tag`	字符串	仅适用于备份代理。代理的标签（如果有）。

请求示例

获取一个项目的所有监控代理。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING"

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{
  "links" : [],
  "results": [
    {
      "confCount": 59,
      "hostname": "example",
      "isManaged": true,
      "lastConf": "2015-06-18T14:21:42Z",
      "lastPing": "2015-06-18T14:21:42Z",
      "pingCount": 6,
      "stateName": "ACTIVE",
      "typeName": "MONITORING"
    }
  ],
  "totalCount": 1
}

后退

获取链接

来年

创建API密钥