返回所有云提供商访问角色

获取 /api/atlas/v2/groups/{groupId}/cloudProviderAccess

返回有权访问指定项目的所有云提供商访问角色。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目所有者”角色。

路径参数

  • groupId 字符串 必需

    用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。

    注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

    格式应符合以下模式:^([a-f0-9]{24})$

查询参数

  • envelope 布尔

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

    默认值为false

  • pretty 布尔

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

    默认值为false

    Prettyprint

响应

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

    正常

    隐藏响应属性 显示响应属性 对象
    • awsIamRoles 大量[对象]

      包含在MongoDB Cloud 中注册和授权的Amazon Web Services (AWS) IAM 角色的列表。

      描述与Amazon Web Services (AWS) 身份和访问管理 (IAM)角色相关的功能的详细信息。

      隐藏 awsIamRoles 属性 显示 awsIamRoles 属性 对象

      描述与Amazon Web Services (AWS) 身份和访问管理 (IAM)角色相关的功能的详细信息。

      • 提供商名称 字符串 必需 鉴别器

        用于标识角色的云提供商的人类可读标签。

        值为 CloudProviderAccessRole

      • _id 字符串

        用于标识角色的唯一的 24 位十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • atlasAzureAppId string(uuid)

        Atlas的Azure Active Directory 应用程序ID 。

      • createdDate string(date-time)

        有人为指定云服务提供商创建此角色的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • featureUsages 大量[对象]

        包含与此Amazon Web Services (AWS) 身份和访问管理 (IAM)角色关联的应用程序程序功能的列表。

        以下之一:
      • lastUpdatedDate string(date-time)

        上次更新此Azure服务主体的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • 服务主体 ID string(uuid)

        标识Azure服务主体的 UUID 字符串。

      • 租户 ID string(uuid)

        UUID 字符串,用于标识Azure Active Directory 租户ID。

      • gcpServiceAccountForAtlas 字符串

        Atlas创建的 Google 服务帐号的电子邮件解决。

        格式应符合以下模式:^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$

      • roleId 字符串

        用于标识角色的唯一的 24 位十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • 状态 字符串

        服务帐户的预配状态。

        取值为 IN_PROGRESSCOMPLETEFAILEDNOT_INITIATED

      • atlasAWSAccountArn 字符串

        Amazon资源名称,用于标识MongoDB Cloud 在假定身份和访问管理 (IAM)角色时使用的Amazon Web Services (AWS) 用户帐户。

        最小长度为 20,最大长度为 2048

      • atlasAssumedRoleExternalId string(uuid)

        MongoDB Cloud 在您的Amazon Web Services (AWS) 账户中担任 IAM角色时使用的唯一外部ID 。

      • authorizedDate string(date-time)

        有人为指定云服务提供商授权此角色的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • iamAssumedRoleArn 字符串

        Amazon 资源名称 (ARN),用于标识 MongoDB Cloud 在访问您的 AWS 账户中的资源时所使用的 Amazon Web Services (AWS) 身份和访问管理 (IAM) 角色。

        最小长度为 20,最大长度为 2048

    • azureServicePrincipals 大量[对象]

      包含在MongoDB Cloud 中注册的Azure服务主体的列表。

      描述与Azure服务主体关联的功能的详细信息。

      隐藏 azureServicePrincipals 属性 显示 azureServicePrincipals 属性 对象

      描述与Azure服务主体关联的功能的详细信息。

      • 提供商名称 字符串 必需 鉴别器

        用于标识角色的云提供商的人类可读标签。

      • atlasAWSAccountArn 字符串

        Amazon资源名称,用于标识MongoDB Cloud 在假定身份和访问管理 (IAM)角色时使用的Amazon Web Services (AWS) 用户帐户。

        最小长度为 20,最大长度为 2048

      • atlasAssumedRoleExternalId string(uuid)

        MongoDB Cloud 在您的Amazon Web Services (AWS) 账户中担任 IAM角色时使用的唯一外部ID 。

      • authorizedDate string(date-time)

        有人为指定云服务提供商授权此角色的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • createdDate string(date-time)

        创建此Azure服务主体的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • featureUsages 大量[对象]

        包含与此Azure服务主体关联的应用程序功能的列表。

        以下之一:
      • iamAssumedRoleArn 字符串

        Amazon 资源名称 (ARN),用于标识 MongoDB Cloud 在访问您的 AWS 账户中的资源时所使用的 Amazon Web Services (AWS) 身份和访问管理 (IAM) 角色。

        最小长度为 20,最大长度为 2048

      • roleId 字符串

        用于标识角色的唯一的 24 位十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • gcpServiceAccountForAtlas 字符串

        Atlas创建的 Google 服务帐号的电子邮件解决。

        格式应符合以下模式:^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$

      • 状态 字符串

        服务帐户的预配状态。

        取值为 IN_PROGRESSCOMPLETEFAILEDNOT_INITIATED

      • _id 字符串

        用于标识角色的唯一的 24 位十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • atlasAzureAppId string(uuid)

        Atlas的Azure Active Directory 应用程序ID 。

      • lastUpdatedDate string(date-time)

        上次更新此Azure服务主体的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • 服务主体 ID string(uuid)

        标识Azure服务主体的 UUID 字符串。

      • 租户 ID string(uuid)

        UUID 字符串,用于标识Azure Active Directory 租户ID。

    • gcpServiceAccounts 大量[对象]

      包含在MongoDB Cloud 中注册和授权的 Google 服务帐户的列表。

      描述与GCP服务帐号关联的功能的详细信息。

      隐藏 gcpServiceAccounts 属性 显示 gcpServiceAccounts 属性 对象

      描述与GCP服务帐号关联的功能的详细信息。

      • 提供商名称 字符串 必需 鉴别器

        用于标识角色的云提供商的人类可读标签。

      • atlasAWSAccountArn 字符串

        Amazon资源名称,用于标识MongoDB Cloud 在假定身份和访问管理 (IAM)角色时使用的Amazon Web Services (AWS) 用户帐户。

        最小长度为 20,最大长度为 2048

      • atlasAssumedRoleExternalId string(uuid)

        MongoDB Cloud 在您的Amazon Web Services (AWS) 账户中担任 IAM角色时使用的唯一外部ID 。

      • authorizedDate string(date-time)

        有人为指定云服务提供商授权此角色的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • createdDate string(date-time)

        创建此 Google 服务帐号的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • featureUsages 大量[对象]

        包含与此 Google 服务帐号关联的应用程序功能的列表。

        以下之一:
      • iamAssumedRoleArn 字符串

        Amazon 资源名称 (ARN),用于标识 MongoDB Cloud 在访问您的 AWS 账户中的资源时所使用的 Amazon Web Services (AWS) 身份和访问管理 (IAM) 角色。

        最小长度为 20,最大长度为 2048

      • roleId 字符串

        用于标识角色的唯一的 24 位十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • _id 字符串

        用于标识角色的唯一的 24 位十六进制数字字符串。

        格式应符合以下模式:^([a-f0-9]{24})$

      • atlasAzureAppId string(uuid)

        Atlas的Azure Active Directory 应用程序ID 。

      • lastUpdatedDate string(date-time)

        上次更新此Azure服务主体的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

      • 服务主体 ID string(uuid)

        标识Azure服务主体的 UUID 字符串。

      • 租户 ID string(uuid)

        UUID 字符串,用于标识Azure Active Directory 租户ID。

      • gcpServiceAccountForAtlas 字符串

        Atlas创建的 Google 服务帐号的电子邮件解决。

        格式应符合以下模式:^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$

      • 状态 字符串

        服务帐户的预配状态。

        取值为 IN_PROGRESSCOMPLETEFAILEDNOT_INITIATED

  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

GET /API/Atlas/v2/groups/{groupId}/cloudProviderAccess
atlas api cloudProviderAccess listGroupCloudProviderAccess --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/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.ListGroupCloudProviderAccessApiParams{}
	sdkResp, httpResp, err := client.CloudProviderAccessApi.
		ListGroupCloudProviderAccessWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true"
响应示例 (200)
{
  "awsIamRoles": [
    {
      "providerName": "CloudProviderAccessRole",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "createdDate": "2025-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {}
        }
      ],
      "lastUpdatedDate": "2025-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "status": "IN_PROGRESS",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2025-05-04T09:42:00Z",
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
    }
  ],
  "azureServicePrincipals": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2025-05-04T09:42:00Z",
      "createdDate": "2025-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "lastUpdatedDate": "2025-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string"
    }
  ],
  "gcpServiceAccounts": [
    {
      "providerName": "string",
      "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
      "atlasAssumedRoleExternalId": "string",
      "authorizedDate": "2025-05-04T09:42:00Z",
      "createdDate": "2025-05-04T09:42:00Z",
      "featureUsages": [
        {
          "featureType": "ATLAS_DATA_LAKE",
          "featureId": {
            "groupId": "32b6e34b3d91647abb20e7b8",
            "name": "string"
          }
        }
      ],
      "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "_id": "32b6e34b3d91647abb20e7b8",
      "atlasAzureAppId": "string",
      "lastUpdatedDate": "2025-05-04T09:42:00Z",
      "servicePrincipalId": "string",
      "tenantId": "string",
      "gcpServiceAccountForAtlas": "string",
      "status": "IN_PROGRESS"
    }
  ]
}
响应示例 (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"
}
响应示例 (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
响应示例 (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"
}