返回所有项目中的所有授权集群

获取 /api/atlas/v2/clusters

服务账户 DigestAuth

返回您有权访问的所有项目中所有集群的详细信息。集群包含一组维护相同数据集的主机。该响应不包括多云集群。要使用此资源，请求的服务帐户或 API 密钥可以具有任何集群级别角色。

查询参数

envelope 布尔

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

默认值为false 。
includeCount 布尔

标志，用于指示响应是否返回响应中的列项总数 (totalCount)。

默认值为true 。
itemsPerPage 整型

响应每页返回的列项数。

最小值为 1，最大值为 500。默认值为 100。
pageNum 整型

显示响应返回的当前总对象集的页面编号。

最小值为 1。默认值为 1。
pretty 布尔

指示响应正文是否应采用 prettyprint 格式的标记。

默认值为false 。

Prettyprint

响应

200 application/vnd.atlas.2023-01-01+json

正常
隐藏响应属性显示响应属性对象
- 链接大量[对象]
  
  点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。
  
  Web 链接规范 (RFC 5988)
  
  隐藏链接属性显示链接属性对象
  
  href 字符串
  
  统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
  
  rel 字符串
  
  统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
- 结果大量[对象]
  
  MongoDB Cloud 在完成此请求时提供的返回文档列表。
  
  隐藏结果属性显示结果属性对象
  
  集群大量[对象]
  
  描述API密钥有权查看的每个项目中集群的设置。
  
  描述API密钥有权查看的每个项目中集群的设置。
  
  隐藏集群属性显示集群属性对象
  
  alertCount integer(int32)
  
  指示在集群上打开的警报数量的整数。
  
  authEnabled 布尔
  
  指示访问权限此集群中的节点是否需要进行身份验证的标志。
  
  可用性字符串
  
  表示当MongoDB Cloud 收到此请求时可以访问集群的多少个节点的术语。当所有节点均可访问时，此参数返回 available；仅当可访问集群中的部分节点时，此参数会返回 warning；当无法访问集群时，此参数会返回 unavailable；当集群已停用时，此参数会返回 dead。
  
  取值为 available、dead、unavailable 或 warning。
  
  backupEnabled 布尔
  
  指示集群是否可以执行备份的标志。如果设置为 true，则集群可以执行备份。对于 NVMe 集群，必须将此值设置为 true。备份对专用集群使用云备份，对租户集群使用共享集群备份。如果设置为 false ，则集群不使用 MongoDB Cloud 备份。
  
  clusterId 字符串
  
  唯一的 24-十六进制字符串，用于标识集群。每个 clusterId 在所有MongoDB Cloud 部署中仅使用一次。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
  
  dataSizeBytes integer(int64)
  
  集群中每个节点上存储的数据总大小。资源以字节为单位表示该值。
  
  名称字符串
  
  用于标识集群的人类可读标签。
  
  格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。
  
  nodeCount integer(int32)
  
  表示组成集群的节点数量的整数。
  
  sslEnabled 布尔
  
  指示访问权限此集群中的节点是否需要 TLS身份验证的标志。
  
  类型字符串
  
  指示集群类型的人类可读标签。
  
  值为 REPLICA_SET 或 SHARDED_CLUSTER。
  
  versions array[string]
  
  包含集群中每个节点运行的MongoDB版本的列表。
  
  groupId 字符串
  
  唯一的 24 位十六进制字符串，用于标识项目。
  
  groupName 字符串
  
  用于标识项目的人类可读标签。
  
  格式应符合以下模式：^[\p{L}\p{N}\-_.(),:&@+']{1,64}$。
  
  orgId 字符串
  
  唯一的 24-十六进制字符串，用于标识包含该项目的组织。
  
  orgName 字符串
  
  人类可读标签，用于标识包含该项目的组织。
  
  格式应符合以下模式：^[\p{L}\p{N}\-_.(),:&@+']{1,64}$。
  
  planType 字符串
  
  指示计划类型的人类可读标签。
  
  标记 array[string]
  
  对指定项目进行分类的人类可读标签列表。 MongoDB Cloud 返回一个空大量。
- 总计数 integer(int32)
  
  可用文档总数。如果 includeCount设立为 false，MongoDB Cloud 会忽略此值。总数为估计值，可能不准确。
  
  最小值为 0。
401 application/json

未经授权。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
403 application/json

Forbidden.
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
500 application/json

内部服务器错误。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

GET /api/atlas/v2/clusters

atlas api clusters listClusterDetails --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListClusterDetailsApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		ListClusterDetailsWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true"

响应示例 (200)

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "clusters": [
        {
          "alertCount": 42,
          "authEnabled": true,
          "availability": "available",
          "backupEnabled": true,
          "clusterId": "string",
          "dataSizeBytes": 42,
          "name": "string",
          "nodeCount": 42,
          "sslEnabled": true,
          "type": "REPLICA_SET",
          "versions": [
            "string"
          ]
        }
      ],
      "groupId": "string",
      "groupName": "string",
      "orgId": "string",
      "orgName": "string",
      "planType": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "totalCount": 42
}

响应示例 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

响应示例 (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

响应示例 (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}