MongoDBMongoDB Atlas 管理 API v2
GET/api/atlas/v2/groups/byName/{groupName}
读取get Group By Name。
MongoDB Atlas Administration API 中用于 get Group By Name 的保留合约 GET Endpoint。资源相关值由调用方在运行时提供。
覆盖固定 Apache-2.0 OpenAPI revision 中全部 540 个 MongoDB Atlas 管理 Endpoint。Hub 提供文档与独立 SDK/CLI,但不代理账户、组织、项目、网络、备份或运行数据;调用方通过本地凭证直连。
请求
- operationId
getGroupByName- 服务器
https://cloud.mongodb.com- 认证
- ServiceAccounts, DigestAuth
请求参数
envelope
queryboolean
Atlas Administration API 合约中的 envelope 值。
pretty
queryboolean
Atlas Administration API 合约中的 pretty 值。
groupName
pathstring必填
Atlas Administration API 合约中的 group Name 值。
响应
200
Groupapplication/vnd.atlas.2023-01-01+json
供应商成功响应。
字段: clusterCountcreatedidlinksnameorgIdregionUsageRestrictionstagswithDefaultAlertsSettings
400
ApiErrorapplication/json
供应商返回 HTTP 状态 400。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
401
ApiErrorapplication/json
供应商返回 HTTP 状态 401。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
供应商返回 HTTP 状态 403。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
供应商返回 HTTP 状态 404。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
409
ApiErrorapplication/json
供应商返回 HTTP 状态 409。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
429
ApiErrorapplication/json
供应商返回 HTTP 状态 429。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
供应商返回 HTTP 状态 500。
字段: badRequestDetaildetailerrorerrorCodeparametersreason
{
"clusterCount": 0,
"id": "32b6e34b3d91647abb20e7b8",
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
},
"orgId": "32b6e34b3d91647abb20e7b8",
"regionUsageRestrictions": "COMMERCIAL_FEDRAMP_REGIONS_ONLY",
"tags": {}
}