返回一个流程的所有 Atlas Search 指标类型

获取 /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics

返回可用于指定项目中一个流程的所有 Atlas Search 指标类型。您必须具有“项目只读”或更高角色才能查看 Atlas Search 指标类型。

路径参数

  • processId 字符串 必需

    为 MongoDB 进程提供服务的主机名和 IANA 端口的组合。主机必须是运行 MongoDB 进程(mongod 或 mongos)的主机的主机名、完全限定域名 (FQDN) 或 Internet 协议地址(IPv4 或 IPv6)。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。

    格式应符合以下模式:^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$

  • groupId 字符串 必需

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

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

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

查询参数

  • envelope 布尔

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

    默认值为false

响应

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

    正常

    隐藏响应属性 显示响应属性 对象
    • groupId 字符串 必需

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

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

    • hardwareMetrics 大量[对象]

      列表,其中包含当MongoDB Atlas收到此请求时专用于Atlas Search 的所有托管计算、内存和存储利用率。

      当MongoDB Atlas收到此请求时,测量一个Atlas Search状态。

      隐藏 hardwareMetrics 属性 显示hardwareMetrics 属性 对象
      • metricName 字符串 必需

        人类可读标签,用于标识此Atlas Search硬件、状态或索引度量。

        值为 INDEX_SIZE_ON_DISKNUMBER_OF_DELETESNUMBER_OF_ERROR_QUERIESNUMBER_OF_GETMORE_COMMANDSNUMBER_OF_INDEX_FIELDSNUMBER_OF_INSERTSNUMBER_OF_SUCCESS_QUERIESNUMBER_OF_UPDATESREPLICATION_LAGTOTAL_NUMBER_OF_QUERIESFTS_DISK_USAGEFTS_PROCESS_CPU_KERNELFTS_PROCESS_CPU_USERFTS_PROCESS_NORMALIZED_CPU_KERNELFTS_PROCESS_NORMALIZED_CPU_USERFTS_PROCESS_RESIDENT_MEMORYFTS_PROCESS_SHARED_MEMORYFTS_PROCESS_VIRTUAL_MEMORYJVM_CURRENT_MEMORYJVM_MAX_MEMORYPAGE_FAULTS

      • 单位 字符串 必需

        适用于此Atlas Search指标的计量单位。

        值为 BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURKILOBYTESMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSMILLISECONDS_LOGSCALEPERCENTSCALARSCALAR_PER_SECOND、或 SECONDS

    • indexMetrics 大量[对象]

      包含在MongoDB Atlas收到此请求时Atlas Search索引执行的所有性能和利用率测量值的列表。

      当MongoDB Atlas收到此请求时,测量一个Atlas Search状态。

      隐藏 indexMetrics 属性 显示 indexMetrics 属性 对象
      • metricName 字符串 必需

        人类可读标签,用于标识此Atlas Search硬件、状态或索引度量。

        值为 INDEX_SIZE_ON_DISKNUMBER_OF_DELETESNUMBER_OF_ERROR_QUERIESNUMBER_OF_GETMORE_COMMANDSNUMBER_OF_INDEX_FIELDSNUMBER_OF_INSERTSNUMBER_OF_SUCCESS_QUERIESNUMBER_OF_UPDATESREPLICATION_LAGTOTAL_NUMBER_OF_QUERIESFTS_DISK_USAGEFTS_PROCESS_CPU_KERNELFTS_PROCESS_CPU_USERFTS_PROCESS_NORMALIZED_CPU_KERNELFTS_PROCESS_NORMALIZED_CPU_USERFTS_PROCESS_RESIDENT_MEMORYFTS_PROCESS_SHARED_MEMORYFTS_PROCESS_VIRTUAL_MEMORYJVM_CURRENT_MEMORYJVM_MAX_MEMORYPAGE_FAULTS

      • 单位 字符串 必需

        适用于此Atlas Search指标的计量单位。

        值为 BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURKILOBYTESMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSMILLISECONDS_LOGSCALEPERCENTSCALARSCALAR_PER_SECOND、或 SECONDS

    • processId 字符串 必需

      标识进程的主机名和端口。

      格式应符合以下模式:^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$

    • statusMetrics 大量[对象]

      包含MongoDB Atlas收到此请求时所有可用Atlas Search状态指标的列表。

      当MongoDB Atlas收到此请求时,测量一个Atlas Search状态。

      隐藏 statusMetrics 属性 显示 statusMetrics 属性 对象
      • metricName 字符串 必需

        人类可读标签,用于标识此Atlas Search硬件、状态或索引度量。

        值为 INDEX_SIZE_ON_DISKNUMBER_OF_DELETESNUMBER_OF_ERROR_QUERIESNUMBER_OF_GETMORE_COMMANDSNUMBER_OF_INDEX_FIELDSNUMBER_OF_INSERTSNUMBER_OF_SUCCESS_QUERIESNUMBER_OF_UPDATESREPLICATION_LAGTOTAL_NUMBER_OF_QUERIESFTS_DISK_USAGEFTS_PROCESS_CPU_KERNELFTS_PROCESS_CPU_USERFTS_PROCESS_NORMALIZED_CPU_KERNELFTS_PROCESS_NORMALIZED_CPU_USERFTS_PROCESS_RESIDENT_MEMORYFTS_PROCESS_SHARED_MEMORYFTS_PROCESS_VIRTUAL_MEMORYJVM_CURRENT_MEMORYJVM_MAX_MEMORYPAGE_FAULTS

      • 单位 字符串 必需

        适用于此Atlas Search指标的计量单位。

        值为 BYTESBYTES_PER_SECONDGIGABYTESGIGABYTES_PER_HOURKILOBYTESMEGABYTESMEGABYTES_PER_SECONDMILLISECONDSMILLISECONDS_LOGSCALEPERCENTSCALARSCALAR_PER_SECOND、或 SECONDS

  • 400 application/json

    错误请求。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

  • 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 状态代码。

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

  • 429 application/json

    请求过多。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

  • 500 application/json

    内部服务器错误。

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

      错误请求详情。

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

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

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

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

        • 字段 字符串 必需

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

    • 详细信息 字符串

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

    • 错误 integer(int32) 必需

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

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

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

    • 参数 大量[对象]

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

    • 原因 字符串

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

GET /API/Atlas/v2/groups/{groupId}/hosts/{processId}/fts/ 指标
atlas api monitoringAndLogs listGroupHostFtsMetrics --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.ListGroupHostFtsMetricsApiParams{}
	sdkResp, httpResp, err := client.MonitoringandLogsApi.
		ListGroupHostFtsMetricsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true"
响应示例 (200)
{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hardwareMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ],
  "indexMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "processId": "mongodb.example.com:27017",
  "statusMetrics": [
    {
      "metricName": "INDEX_SIZE_ON_DISK",
      "units": "BYTES"
    }
  ]
}
响应示例 (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
响应示例 (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"
}
响应示例 (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
响应示例 (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"
}