Help Center/ Meeting/ Server API Reference/ Enterprise Resource Management/ Querying Resource Information as an SP Administrator
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Resource Information as an SP Administrator

Description

This API is used by an SP administrator to query all resources of the SP, including used resources.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/usg/dcs/sp/resource

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

queryGroup

No

Boolean

Query

Whether to return media ingestion group IDs during resource information query. By default, media ingestion group IDs are not returned.

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Request-Id

No

String

Header

Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

Accept-Language

No

String

Header

Language. Values: zh-CN for Chinese (default) and en-US for English.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

confCallCount

ResDetailDTO object

Number of concurrent participants.

corpCount

ResDetailDTO object

Total number of enterprises.

enablePstn

Boolean

Whether PSTN is enabled during enterprise creation.

enableSMS

Boolean

Whether to send meeting notifications by SMS message.

groupList

Array of QueryCorpGroupDTO objects

List of groups bound to the SP administrator.

hwVisionCount

ResDetailDTO object

Number of smart TV access accounts.

ideaHubCount

ResDetailDTO object

Number of IdeaHub access accounts.

liveCount

ResDetailDTO object

Number of live broadcast ports.

recordCapability

ResDetailDTO object

Recording storage space, in GB.

roomCount

ResDetailDTO object

Number of whiteboard (SmartRooms) access accounts.

te1080pHardCount

ResDetailDTO object

Number of 1080p hard terminal access accounts.

te720pHardCount

ResDetailDTO object

Number of 720p hard terminal access accounts.

teSoftCount

ResDetailDTO object

Number of user accounts.

thirdPartyHardCount

ResDetailDTO object

Number of third-party hard terminal access accounts.
Table 5 QueryCorpGroupDTO data structure

Parameter

Type

Description

groupId

String

Media ingestion group ID.

groupName

String

Group name.

groupType

Integer

Group type.

regionId

String

Region ID. This parameter is mandatory only in the service list grouping scenario.

remarks

String

Group remarks.

status

Integer

Group status.

  • 0: normal.
  • 1: disabled. After service list grouping is disabled, new enterprises will not be automatically allocated to this group.

Example Request

GET /v1/usg/dcs/sp/resource?queryGroup=true
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

HTTP/1.1 200 
Date: Tue, 17 Dec 2019 09:32:47 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 439e8b710378987ffc5eb844b5e5c297

{
    "confCallCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 6
    },
    "corpCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 1,
        "trialCount": 0,
        "usedCount": 0
    },
    "enablePstn": true,
    "enableSMS": true,
    "hwVisionCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 2,
        "trialCount": 0,
        "usedCount": 0
    },
    "ideaHubCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 0,
        "trialCount": 0,
        "usedCount": 0
    },
    "liveCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 6
    },
    "recordCapability": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 5
    },
    "roomCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 4
    },
    "te1080pHardCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 1
    },
    "te720pHardCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 2
    },
    "teSoftCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 3
    },
    "thirdPartyHardCount": {
        "expiredCount": 0,
        "expiringCount": 0,
        "sumCount": 20,
        "trialCount": 0,
        "usedCount": 7
    },
    "groupList": [
        {
            "groupId": "297e87ec7713734b01771458c2d80000",
            "groupName": "Test Group",
            "groupType": 3,
            "regionId": "393e8fec7413734b01s71458c2d80s01",
            "remarks": "Test",
            "status": 0
        }
    ]
}

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/resource