跳至主内容

getMonthlyUsage

该方法展示指定公司在目标月份的月度使用量。仅返回默认产品类型(终端安全)端点的使用量。如需其他产品类型的使用量,请参考 getMonthlyUsagePerProductType 方法。

参数

参数

类型

可选

描述

companyId

字符串

公司ID。默认值为生成API密钥的用户关联的公司ID。

targetMonth

字符串

返回使用情况的月份。格式应为: 月/年 。默认值为当前月份。

usageCoverageType

整数

仅返回特定时间区间内创建的公司的月度使用情况。使用 companyRegistrationStartDatecompanyRegistrationEndDate 参数指定要查询的时间段。可能取值: 3 .

注意

此参数仅在请求中包含 companyRegistrationStartDatecompanyRegistrationEndDate 时可用。

companyRegistrationStartDate

字符串

仅返回在此日期之后创建的公司的月度使用情况。

注意

请求中使用的时间按UTC计算。

companyRegistrationEndDate

字符串

仅返回在此日期之前创建的公司的月度使用量。

注意

请求中使用的时间视为UTC时间。

返回值

此方法返回一个对象,包含指定月份内每项已获取服务的许可证席位使用数量,若查询公司无月度许可证则返回0:

  • 端点月度使用量 - 使用本地引擎扫描的所有端点的月度使用量。

  • 按需月度使用量 - 使用本地引擎扫描的端点月度使用量,这些端点属于采用 按需 防护模型的公司。

  • MSP安全版月度使用量 - 使用本地引擎扫描的端点月度使用量,这些端点属于采用 安全版 防护模型的公司。

  • MSP安全增强版月度使用量 - 使用本地引擎扫描的端点月度使用量,这些端点属于采用 安全增强版 防护模型的公司。

  • MSP安全高级版月度使用量 - 使用本地引擎扫描的端点月度使用量,这些端点属于采用 安全高级版 防护模型的公司。

  • 邮件安全月度使用量 - 邮件安全邮箱的月度使用量。

  • 移动安全月度使用量 - 移动安全设备的月度使用量。

  • Exchange月度使用量 - Exchange邮箱的月度使用量。

  • encryptionMonthlyUsage - 加密模块的月度使用量。

  • atsMonthlyUsage - 沙盒分析器和HyperDetect模块的月度使用量。

  • edrMonthlyUsage - EDR模块的月度使用量。

  • edrStorage90DaysUsage - 使用90天事件保留期的EDR终端数量。

  • edrStorage180DaysUsage - 使用180天事件保留期的EDR终端数量。

  • edrStorage1YearUsage - 使用1年事件保留期的EDR终端数量。

  • phasrMonthlyUsage - 使用PHASR的终端总数。

  • easmMonthlyUsage - 使用EASM的终端总数。

  • complianceMonthlyUsage - 使用合规管理附加模块的终端总数。

  • mdrFoundationsMonthlyUsage - MDR Foundations服务的月度使用量。

  • patchManagementMonthlyUsage - 补丁管理模块的月度使用量。

  • containerProtectionMonthlyUsage - 容器保护模块的月度使用量。

  • integrityMonitoringUsage - 使用完整性监控的终端总数。

  • integrityMonitoring90DaysUsage - 使用90天事件保留期的完整性监控终端数量。

  • integrityMonitoring180DaysUsage - 使用具有180天事件保留期的完整性监控的终端数量。

  • integrityMonitoring1YearUsage - 使用具有1年事件保留期的完整性监控的终端数量。

  • xdrIdentitySensorsMonthlyUsage ,传感器管理中Azure AD和Active Directory集成的月度使用量。

  • xdrProductivitySensorsMonthlyUsage ,传感器管理中Office 365集成的月度使用量。

  • xdrNetworkSensorsMonthlyUsage ,传感器管理中网络传感器集成的月度使用量。

  • xdrCloudSensorsMonthlyUsage ,传感器管理中AWS集成的月度使用量。

  • sveVsMonthlyUsage - 使用安全服务器扫描的虚拟服务器的月度使用量。

  • sveVdiMonthlyUsage - 使用安全服务器扫描的虚拟桌面的月度服务使用量(以小时计)。

  • minimumUsage - 包含许可证类型及公司通过法律协议承诺每月使用的最低槽位数的对象:

    • endpointMonthlyUsage ,客户同意从主许可证中使用的最低终端数量。

示例

请求 :

{
       "params": {
           "targetMonth": "11/2023","companyId": "55115935b1a43dcc4a7b23c6""usageCoverageType": 3,
           "companyRegistrationStartDate": "2023-09-01T10:03:34",
           "companyRegistrationEndDate": "2023-10-01T12:06:33"
       },       "jsonrpc": "2.0",
       "method": "getMonthlyUsage", 
       "id": "5087eab8-b74f-4a3e-85b3-4271e85890d4"
  }

响应 :

公司采用 按需 保护模式。

{
  "result": {
    "endpointMonthlyUsage":4,
    "encryptionMonthlyUsage": 0,
    "emailSecurityMonthlyUsage": 0,
    "mobileSecurityMonthlyUsage": 0,
    "exchangeMonthlyUsage": 0,
    "atsMonthlyUsage": 0,
    "edrMonthlyUsage": 0,
    "edrStorage90DaysUsage": 0,
    "edrStorage180DaysUsage": 0,
    "edrStorage1YearUsage": 0,
    "mdrFoundationsMonthlyUsage": 0,
    "patchManagementMonthlyUsage": 0,
    "integrityMonitoringUsage": 0,
    "integrityMonitoring90DaysUsage": 0,
    "integrityMonitoring180DaysUsage": 0,
    "integrityMonitoring1YearUsage": 0,
    "sveVsMonthlyUsage": 0,
    "sveVdiMonthlyUsage": 0,
    "containerProtectionMonthlyUsage": 0,
    "xdrIdentitySensorsMonthlyUsage": 0,
    "xdrProductivitySensorsMonthlyUsage": 0,
    "xdrNetworkSensorsMonthlyUsage": 0,
    "xdrCloudSensorsMonthlyUsage": 0,
    "phasrMonthlyUsage": 0,
    "easmMonthlyUsage": 0,
    "complianceMonthlyUsage": 2,
    "aLaCarteMonthlyUsage": 1,
    "mspSecureMonthlyUsage":1,
    "mspSecurePlusMonthlyUsage": 0,
    "mspSecureExtraMonthlyUsage":2},
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

公司采用 安全 防护模式。

{
  "result": {
    "endpointMonthlyUsage":4,
    "encryptionMonthlyUsage": 0,
    "emailSecurityMonthlyUsage": 0,
    "mobileSecurityMonthlyUsage": 0,
    "exchangeMonthlyUsage": 0,
    "atsMonthlyUsage": 0,
    "edrMonthlyUsage": 0,
    "edrStorage90DaysUsage": 0,
    "edrStorage180DaysUsage": 0,
    "edrStorage1YearUsage": 0,
    "mdrFoundationsMonthlyUsage": 0,
    "patchManagementMonthlyUsage": 0,
    "integrityMonitoringUsage": 0,
    "integrityMonitoring90DaysUsage": 0,
    "integrityMonitoring180DaysUsage": 0,
    "integrityMonitoring1YearUsage": 0,
    "xdrIdentitySensorsMonthlyUsage": 0,
    "xdrProductivitySensorsMonthlyUsage": 0,
    "xdrNetworkSensorsMonthlyUsage": 0,
    "xdrCloudSensorsMonthlyUsage": 0,
    "phasrMonthlyUsage": 2,
    "easmMonthlyUsage": 1,
    "complianceMonthlyUsage": 2,
    "aLaCarteMonthlyUsage": 1,
    "mspSecureMonthlyUsage":1,
    "mspSecurePlusMonthlyUsage": 0,
    "mspSecureExtraMonthlyUsage":2},
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}