Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
资源
/
助手

获取项目代理资源链接

在此页面上

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

获取项目的监控、备份和自动化代理资源链接。

注意

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

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

Resource

GET /groups/{PROJECT-ID}/agents

请求路径参数

名称
类型
说明
PROJECT-ID
字符串
拥有代理 API 密钥的项目的唯一标识符。

请求查询参数

名称
类型
必要性
说明
默认
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 请求正文参数。

响应

关系
说明
self
Me
http://mms.mongodb.com/group
代理所属的项目
http://mms.mongodb.com/monitoringAgents
所有监控代理的链接。
http://mms.mongodb.com/backupAgents
所有备份代理的链接。
http://mms.mongodb.com/automationAgents
所有自动化代理的链接。

例子

请求

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"

响应

响应标头

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":[
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents",
      "rel":"self"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}",
      "rel":"http://mms.mongodb.com/group"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/MONITORING",
      "rel":"http://mms.mongodb.com/monitoringAgents"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/BACKUP",
      "rel":"http://mms.mongodb.com/backupAgents"
    },
    {
      "href":"https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agents/AUTOMATION",
      "rel":"http://mms.mongodb.com/automationAgents"
    }
  ]
}

后退

助手

来年

按类型获取