保利威文档中心

帮助中心

查询集团主账号资源概览

更新时间:2026-07-22 15:39:36

接口描述

使用集团主账号凭证查询当前集团的直播资源、点播空间和点播流量。接口只返回资源统计字段,不返回 appSecret、点播密钥或读写 Token。

接口 URL

https://api.polyv.net/live/v4/group/account/resource/overview/get

请求方式

GET

请求参数

参数名 必选 类型 说明
appId true String 集团主账号 appId
timestamp true Long 当前 13 位毫秒时间戳,3 分钟内有效
sign true String 使用集团主账号 appSecret 生成的 32 位大写 MD5 签名,详见签名生成规则

appId 关联的集团账号由网关鉴权确定,接口不接受 groupId 参数,不能查询其他集团账号。

请求示例

https://api.polyv.net/live/v4/group/account/resource/overview/get?appId=g8dtv537aq&timestamp=1753171200000&sign=6C95C3A3E93D46A78A86DCDB8930D70A

统计口径

资源项按 resourceCode 返回。资源数值均为当前时点快照:

字段 口径
totalAmount 生效套餐的资源总量;多套餐叠加后求和
usedAmount 集团主账号已实际消耗的资源量;累计并发和并行并发不提供实时已用并发,返回 null
mainAccountAvailableAmount 集团主账号当前剩余可用量。共享资源为 totalAmount - usedAmount;并发为当前套餐并发额度
allocatedAmount 已分配给分账号、占用集团公共资源池的额度,计算为 max(0, mainAccountAvailableAmount - groupPoolAssignableAmount)
groupPoolAssignableAmount 集团公共资源池当前剩余可分配量,已扣除分账号已分配额度

空间和流量的清算原始单位为字节,接口统一转换为 GB。MINUTECONCURRENT 为整数单位,GB 可带小数。

分钟制直播资源的 mainAccountAvailableAmount 与集团后台 GroupAccountServiceApi.getGroupAccountInfominutes 使用同一实时可用量查询口径;totalAmount 为分钟资源充值累计,usedAmount = max(0, totalAmount - mainAccountAvailableAmount)

allocationDataUpdatedAt 是分账号额度汇总的更新时间。该汇总为异步数据,数据延迟以该字段与 dataUpdatedAt 的差值为准;资源总量和已用量与同一时点集团后台概览使用相同清算口径。

响应字段

参数名 类型 说明
code Integer HTTP 风格状态码,成功为 200
status String successerror
success Boolean 是否成功
requestId String 请求唯一标识,用于排查
data Object 资源概览

Data 字段

参数名 类型 说明
groupId String 当前集团账号标识
dataUpdatedAt Long 主资源数据读取时间,13 位毫秒时间戳
resources Array 资源项列表

Resources 字段

参数名 类型 说明
product String 产品:LIVEVODACCOUNT
resourceCode String 资源:LIVE_DURATIONLIVE_CONCURRENTVOD_SPACEVOD_TRAFFICBALANCE
billingPlan String 计费类型:DURATIONTOTAL_CONCURRENTPARALLEL_CONCURRENTSPACETRAFFICAMOUNT
unit String 单位:MINUTECONCURRENTGBCNY
allocationMode String 资源归属:SHARED_POOL 为集团公共资源池,PER_ACCOUNT_CAP 为每个分账号的并发上限
state String 资源状态,见资源状态
packageStartAt Long 套餐生效时间,13 位毫秒时间戳
packageEndAt Long 套餐到期时间,13 位毫秒时间戳;与集团账号概览一致,统一为到期日 23:59:59
totalAmount Decimal 资源总量
usedAmount Decimal 已实际使用量;无法提供实时用量时为 null
allocatedAmount Decimal 已分配给分账号的额度,仅 SHARED_POOL 返回
mainAccountAvailableAmount Decimal 集团主账号自身当前剩余可用量
groupPoolAssignableAmount Decimal 集团公共资源池剩余可分配量,仅 SHARED_POOL 返回
perAccountMaxAmount Decimal 单个分账号可设置的最大额度,仅 PER_ACCOUNT_CAP 返回
availableDepositAmount Decimal 可用充值金额,仅 BALANCE 返回,单位为元
availableDonateAmount Decimal 可用赠送金额(含测试金额),仅 BALANCE 返回,单位为元
frozenAmount Decimal 冻结金额,仅 BALANCE 返回,单位为元
availableCreditAmount Decimal 可用授信额度,仅 BALANCE 返回,单位为元
totalCreditAmount Decimal 授信额度总额,仅 BALANCE 返回,单位为元
pendingPaymentAmount Decimal 待支付金额,仅 BALANCE 返回,单位为元
allocationDataUpdatedAt Long 分账号已分配额度汇总时间,13 位毫秒时间戳

resourceCodeBALANCE 时,totalAmount 为累计充值金额与累计赠送金额之和,mainAccountAvailableAmount 为可用余额,groupPoolAssignableAmount 为当前可分配给分账号的金额。金额账务存在退款、冻结、授信等独立流水,usedAmount 不提供累计推导值,固定为 null

资源状态

state 说明 数值字段
ACTIVE 套餐有效,资源可查询 按资源类型返回
NO_PACKAGE 未配置对应套餐 均为 null
EXPIRED 对应套餐已到期 均为 null
DATA_PENDING 主资源已读取,但分账号额度汇总尚未生成 总量、已用量、主账号剩余可用量返回;已分配和剩余可分配为 null
UNLIMITED 套餐资源不限量 均为 null
UNSUPPORTED 当前集团直播计费类型不属于分钟制、累计并发或并行并发 均为 null

资源不限量时,资源项仍返回且 stateUNLIMITED,数值字段为 null;不会使用 0 表示不限量。

Java 调用示例

String appId = "yourGroupAppId";
String appSecret = "yourGroupAppSecret";
String timestamp = String.valueOf(System.currentTimeMillis());
String url = "https://api.polyv.net/live/v4/group/account/resource/overview/get";

Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

String response = HttpUtil.get(url, requestMap);

响应示例

{
  "code": 200,
  "status": "success",
  "success": true,
  "data": {
    "groupId": "group-123",
    "dataUpdatedAt": 1753171200123,
    "resources": [
      {
        "product": "ACCOUNT",
        "resourceCode": "BALANCE",
        "billingPlan": "AMOUNT",
        "unit": "CNY",
        "allocationMode": "SHARED_POOL",
        "state": "ACTIVE",
        "totalAmount": 1000.00,
        "usedAmount": null,
        "allocatedAmount": 300.00,
        "mainAccountAvailableAmount": 800.00,
        "groupPoolAssignableAmount": 500.00,
        "availableDepositAmount": 700.00,
        "availableDonateAmount": 100.00,
        "frozenAmount": 20.00,
        "availableCreditAmount": 0.00,
        "totalCreditAmount": 0.00,
        "pendingPaymentAmount": 0.00,
        "allocationDataUpdatedAt": 1753171199000
      },
      {
        "product": "LIVE",
        "resourceCode": "LIVE_DURATION",
        "billingPlan": "DURATION",
        "unit": "MINUTE",
        "allocationMode": "SHARED_POOL",
        "state": "ACTIVE",
        "packageStartAt": 1751328000000,
        "packageEndAt": 1754006400000,
        "totalAmount": 10000,
        "usedAmount": 2000,
        "allocatedAmount": 3000,
        "mainAccountAvailableAmount": 8000,
        "groupPoolAssignableAmount": 5000,
        "allocationDataUpdatedAt": 1753171199000
      },
      {
        "product": "VOD",
        "resourceCode": "VOD_SPACE",
        "billingPlan": "SPACE",
        "unit": "GB",
        "allocationMode": "SHARED_POOL",
        "state": "ACTIVE",
        "totalAmount": 1000.00,
        "usedAmount": 120.50,
        "allocatedAmount": 300.00,
        "mainAccountAvailableAmount": 879.50,
        "groupPoolAssignableAmount": 579.50,
        "allocationDataUpdatedAt": 1753171199000
      }
    ]
  }
}

错误码

公共鉴权、签名和时间戳错误请参阅全局错误说明。下游资源服务不可用时接口返回标准失败响应,不返回资源快照。

联系客服,在线咨询