MongoDB/listGroupHostFtsMetrics

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

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

Read list Group Host Fts Metrics.

Contract-preserving GET endpoint for list Group Host Fts Metrics in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.

All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.

Request

operationId
listGroupHostFtsMetrics
Server
https://cloud.mongodb.com
Authentication
ServiceAccounts, DigestAuth

Request parameters

processId

pathstringrequired

process Id value in the Atlas Administration API contract.

my.host.name.com:27017

groupId

pathstringrequired

group Id value in the Atlas Administration API contract.

32b6e34b3d91647abb20e7b8

envelope

queryboolean

envelope value in the Atlas Administration API contract.

Responses

200

CloudSearchMetricsapplication/vnd.atlas.2023-01-01+json

Successful supplier response.

Properties: groupIdhardwareMetricsindexMetricslinksprocessIdstatusMetrics

400

ApiErrorapplication/json

Supplier response with HTTP status 400.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

401

ApiErrorapplication/json

Supplier response with HTTP status 401.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

403

ApiErrorapplication/json

Supplier response with HTTP status 403.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

404

ApiErrorapplication/json

Supplier response with HTTP status 404.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

429

ApiErrorapplication/json

Supplier response with HTTP status 429.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

500

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "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"
  }
}