检索 App Services 指标

获取 /groups/{groupId}/apps/{appId}/metrics
tokenAuth

检索各种指标，包括：计算时间、数据传输、同步分钟数、请求成功、请求失败。有关可用指标的完整列表，请参阅 App Services 指标参考。

路径参数

查询参数

  • 开始 字符串 必需

    查询期开始的 ISO-8601 日期和时间（例如“2022-10-27T14:01:01Z”）。

  • end 字符串 必需

    查询期结束的 ISO-8601 日期和时间（例如“2022-10-27T14:01:01Z”）。

  • 粒度 字符串 必需

    将查询周期的粒度指定为 ISO-8601 持续时间值。示例包括“P31D”（31 天）、“PT1H”（1 小时）和“PT5M”（5 分钟）。

  • 衡量标准 字符串

    过滤依据的指标名称。有关可用指标及其单位的详细信息，请参阅 App Services 指标参考。

    值为 ACTIVE_OPEN_SYNC_SESSIONS、AUTH_EGRESS_BYTES、AUTH_FAILED_REQUESTS、AUTH_RESPONSE_MS、AUTH_SUCCESSFUL_LOGIN、AUTH_SUCCESSFUL_REQUESTS、AUTH_TOTAL_USERS、ENDPOINTS_COMPUTE_MS、ENDPOINTS_EGRESS_BYTES、ENDPOINTS_FAILED_REQUEST、ENDPOINTS_RESPONSE_MS、ENDPOINTS_SUCCESSFUL_REQUESTS、 GRAPHQL_RESPONSE_MS、GRAPHQL_COMPUTE_MS、GRAPHQL_EGRESS_BYTES、GRAPHQL_FAILED_REQUESTS、GRAPHQL_SUCCESSFUL_REQUESTS、LF_RESPONSE_MS、OVERALL_COMPUTE_MS、OVERALL_EGRESS_BYTES、OVERALL_FAILED_REQUESTS、OVERALL_SUCCESSFUL_REQUESTS、OVERALL_SYNC_MINUTES、SDK_COMPUTE_MS、SDK_EGRESS_BYTES, SDK_FAILED_REQUESTS, SDK_FNS_RESPONSE_MS, SDK_MQL_COMPUTE_MS, SDK_MQL_EGRESS_BYTES, SDK_MQL_FAILED_REQUESTS, SDK_MQL_RESPONSE_MS, SDK_MQL_SUCCESSFUL_REQUESTS, SDK_SUCCESSFUL_REQUESTS, SYNC_CLIENT_BOOTSTRAP_MS, SYNC_CLIENT_UPLOADS_INVALID, SYNC_CURRENT_OPLOG_LAG_MS_SUM, SYNC_EGRESS_BYTES, SYNC_FAILED_REQUESTS、SYNC_HISTORY_WRITE_MS、SYNC_MINUTES、SYNC_NUM_INTEGRATION_ATTEMPTS、SYNC_NUM_UNSYNCABLE_DOC、SYNC_OT_MS、SYNC_SESSIONS_ENDED、SYNC_SESSIONS_STARTED、SYNC_SUCCESSFUL_REQUESTS、SYNC_UPLOAD_PROPS_MS、TRIGGERS_COMPUTE_MS、TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM、TRIGGERS_EGRESS_BYTES、TRIGGERS_FAILED_REQUESTS、TRIGGERS_RESPONSE_MS 或 TRIGGERS_SUCCESSFUL_REQUESTS。

响应

  • 200 application/json

    已成功检索。

    隐藏响应属性 显示响应属性 对象
    • 测量 大量[对象] 必需

      指标列表。

      隐藏测量属性 显示测量属性 对象
      • data_points 大量[对象]

        给定指标的一设立数据点。

        隐藏 data_points 属性 显示 data_points 属性 对象
        • timestamp 字符串

          测量的 ISO-8601 日期和时间。

        • 值 数字

          以指标的 unit属性指定的单位表示的测量值。

      • 名称 字符串

        指标的名称。有关可用指标及其单位的完整列表，请参阅App Services指标参考。

      • 单位 字符串

        每个数据点的 value属性的单位。

    • app_id 字符串 必需

      请求中发送的应用ID 。

    • app_name 字符串 必需

      应用的人类可读名称。

    • GROUP_ID 字符串 必需

      请求中发送的群组 ID（group ID） 。

    • 开始 字符串 必需

      最早请求的测量的日期和时间（ISO-8601 格式）。

    • end 字符串 必需

      最近请求的测量的日期和时间（ISO-8601 格式）。

    • 粒度 字符串 必需

      请求的指标粒度（采用 ISO-8601 持续时间格式）。
GET /groups/{groupId}/apps/{appId}/ 指标 
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/metrics?start=string&end=string&granularity=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
响应示例 (200) 
{
  "measurements": [
    {
      "data_points": [
        {
          "timestamp": "string",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "string"
    }
  ],
  "app_id": "string",
  "app_name": "string",
  "group_id": "string",
  "start": "2022-10-27T14:01:01Z",
  "end": "2022-12-27T14:01:01Z",
  "granularity": "string"
}