更新时间:2024-12-16 GMT+08:00

查看租户资源用量信息

功能介绍

查询租户一次性和包周期(包年/包月)资源用量信息。

各种资源的计费方式请参考计费说明

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/tenants/resources-usage

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

resource

String

资源类型。可填多个,用","分隔。详见资源类型

business

String

业务类型。可填多个,用","分隔。

  • VOICE_CLONE:声音制作
  • SYNTHETICS_SOUND:声音合成
  • ASSET_MANAGER:资产管理
  • MODELING_2D:形象制作
  • LIVE_2D:分身数字人视频直播
  • VIDEO_2D:分身数字人视频制作
  • CHAT_2D:分身数字人智能交互
  • BUSINESS_CARD_2D:分身数字人名片
  • PICTURE_2D:照片数字人视频
  • MODELING_3D:3D照片建模
  • VDS_3D:3D视觉驱动
  • TTSA_3D:3D语音驱动
  • FLEXUS_2D:FLEXUS版本资源

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表5 响应Body参数

参数

参数类型

描述

resources

Array of ResourceUsageInfo objects

资源用量列表

表6 ResourceUsageInfo

参数

参数类型

描述

resource_type

String

资源类型。详见资源类型

business_type

String

业务类型。

  • VOICE_CLONE:声音制作
  • SYNTHETICS_SOUND:声音合成
  • ASSET_MANAGER:资产管理
  • MODELING_2D:形象制作
  • LIVE_2D:分身数字人视频直播
  • VIDEO_2D:分身数字人视频制作
  • CHAT_2D:分身数字人智能交互
  • BUSINESS_CARD_2D:分身数字人名片
  • PICTURE_2D:照片数字人视频
  • MODELING_3D:3D照片建模
  • VDS_3D:3D视觉驱动
  • TTSA_3D:3D语音驱动
  • FLEXUS_2D:FLEXUS版本资源

sub_resource_type

String

子资源类型。

is_sub_resource

Boolean

是否子资源。子资源描述的是子资源的数量和单位

默认取值:

false

charging_mode

String

计费类型。

  • PERIODIC: 包周期
  • ONE_TIME:一次性
  • ON_DEMAND:按需

resource_source

String

资源来源。

  • PURCHASED: 购买
  • SP_ALLOCATED:SP分配
  • ADMIN_ALLOCATED:系统管理员分配

amount

Number

总量

取值范围:

0-1000000

usage

Number

使用量

取值范围:

0-1000000

unit

String

单位。

  • NUM:个数(形象/声音)
  • MIN:分钟(视频制作)
  • HOUR:小时 (直播)
  • CHANNEL:路(直播/交互)
  • GB:GB(资产管理)
  • MILLION_WORDS:百万字
  • TEN_THOUSAND_WORDS:万字
  • TIME:次

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/f488337c31c8e4622f1590735b134c65/tenants/resources-usage

响应示例

状态码: 200

查看租户信息

{
  "resources" : [ {
    "resource_type" : "video",
    "charging_mode" : "ONE_TIME",
    "amount" : 6000,
    "usage" : 100.5,
    "unit" : "MIN"
  } ]
}

状态码: 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码

状态码

描述

200

查看租户信息

400

请求传参异常,包含错误码及对应描述。

错误码

请参见错误码