Query Group Master Account Resource Overview

Interface Description

Use the group master account credentials to query the current group's live streaming resources, video-on-demand (VOD) storage, and VOD traffic. The interface only returns resource statistics fields and does not return appSecret, VOD keys, or read/write tokens.

Interface URL

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

Request Method

GET

Request Parameters

appId The associated group account is determined by gateway authentication. The interface does not accept the groupId parameter and cannot query other group accounts.

Request Example

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

Statistical Methodology

Resource items are returned based on resourceCode. Resource values are snapshots at the current point in time:

The original unit for storage and traffic settlement is bytes. The interface converts uniformly to GB. MINUTE, CONCURRENT are integer units, GB can include decimals.

For minute-based live streaming resources, mainAccountAvailableAmount uses the same real-time available amount query methodology as minutes in the group backend's GroupAccountServiceApi.getGroupAccountInfo; totalAmount is the cumulative minute resource top-up, usedAmount = max(0, totalAmount - mainAccountAvailableAmount).

allocationDataUpdatedAt is the update time for the sub-account quota summary. This summary is asynchronous, and data latency is determined by the difference between this field and dataUpdatedAt; total and used resource amounts use the same settlement methodology as the group backend overview at the same point in time.

Response Fields

Data Fields

Resources Fields

When resourceCode is BALANCE, totalAmount is the sum of cumulative top-up amount and cumulative donation amount, mainAccountAvailableAmount is the available balance, groupPoolAssignableAmount is the current amount allocatable to sub-accounts. Financial accounting includes independent transactions such as refunds, freezes, and credits; usedAmount does not provide cumulative derived values and is fixed at null.

Resource Status

When resources are unlimited, the resource item is still returned and state is UNLIMITED, numeric fields are null; 0 is not used to indicate unlimited.

Java Call Example

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);

Response Example

{
  "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
      }
    ]
  }
}

Error Codes

For common authentication, signature, and timestamp errors, please refer to Global Error Description. When downstream resource services are unavailable, the interface returns a standard failure response and does not return resource snapshots.