Skip to content

Usage Transparency Service

Usage Transparency (UTS)提供API来获取关于提供者应用用量信息，并可导入相关用户/资产/租户应用用量，以用于计费，报告及配额检查等。

UTS接受所有以有效格式发送的数据，有效载荷不超过每个请求的用量限制。如果为某些用量单元配置了规则，则根据配置验证相应的用量数据。如果数据验证失败，数据将被拒绝，并且不会被聚合。用户可以查询使用/usagesJobs端点发送的数据状态。用量计费必须要有相关规则。

可使用Usage Transparency 用户界面对该信息进行展示和分析。

访问

要访问此服务，您需要具有 Usage Transparency Service 角色和范围中列出的相应角色。

功能

Usage Transparency Service 公开其 API 以实现以下任务：

  • 用量：向UTS后台发送应用的特定数据。
  • 用量作业追溯：将一个或多个租户、用户和应用的用量添加到 UTS 中进行存储和处理，并且获取已添加用量的查询状态、处理状态和处理错误的信息。

UTS 只接受经过以下验证的数据：

  1. 必须为 appname 和使用单元配置规则。
  2. 令牌中的租户声明必须是开发者租户或运营商租户。
  3. 令牌中的租户声明和客户 ID 中的 tenamtID 应该相同 或 有效负载中的租户必须是运营商的 IoT-Tenant，而有效负载中的应用被提供给该 IoT 租户。

限制

  • 在单个请求中可以添加到UTS的最大用量是200。
  • 用户一次最多可以查询1000个作业。
  • 一次可以执行的操作数量是有限的。

错误代码

以下错误代码可能出现在任何指定操作中。通用错误的前缀是 mdsp.core.generic..

  • 204: noContent
  • 400: invalidParameter
  • 400: invalidRequestBodyProperty
  • 400: missingParameter
  • 400: missingRequestBodyProperty
  • 401: unauthorized
  • 403: forbidden
  • 404: noMatch
  • 413: payloadTooLarge
  • 415: unsupportedMediaType
  • 429: tooManyRequests
  • 500: internalServerError

示例场景

供应商提供了一款应用，客户可以使用它将工业硬件连接到 MindSphere 。他们想对新的硬件设备收取一笔初始上线费，并对每台设备每月收取一定费用。他们在该应用中使用 Usage Transparency 将客户信息发送到其中，当支付了费用后，就可以通过用户接口访问它。

Last update: March 22, 2023