Querying Enterprise Resources and Service Permissions as an Enterprise Administrator
Description
This API is used by an enterprise administrator to query details of enterprise resources and service permissions, including used resource details.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/corp/resource |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
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
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
Parameter |
Type |
Description |
---|---|---|
confCallCount |
ResDetailDTO object |
Number of concurrent participants. |
confLength |
Integer |
Meeting duration. |
enableAiMinutes |
Boolean |
Whether automatic generation of meeting minutes is enabled. |
enableHybridCloud |
Boolean |
Whether the hybrid cloud mode is enabled. |
enablePstn |
Boolean |
Whether PSTN is enabled when the enterprise was created. |
enableSMS |
Boolean |
Whether to send meeting notifications by SMS message. |
enableCloudDisk |
Boolean |
Whether Clouddrive is enabled. |
enableUc |
Boolean |
Whether the UC function is enabled. |
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. |
singleConfCallCount |
Integer |
Number of concurrent participants in a single meeting. |
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 soft client accounts. |
thirdPartyHardCount |
ResDetailDTO object |
Number of third-party hard terminal access accounts. |
vmr |
Array of QueryVmrPkgResResultDTO objects |
Number of cloud meeting room packages. |
Parameter |
Type |
Description |
---|---|---|
expiredCount |
Integer |
Number of expired resources. |
expiringCount |
Integer |
Number of resources that are about to expire in 30 days. |
sumCount |
Integer |
Total number of resources. |
trialCount |
Integer |
Number of rewarded resources. |
usedCount |
Integer |
Number of used resources, expect for recording storage space, number of concurrent participants, and number of live broadcast ports. |
Parameter |
Type |
Description |
---|---|---|
vmrName |
String |
Name of a cloud meeting room package. |
vmrPkgCount |
Integer |
Number of cloud meeting room packages of this specification. |
vmrPkgId |
String |
ID of the cloud meeting room package. |
vmrPkgParties |
Integer |
Number of concurrent participants in the cloud meeting room package. |
vmrPkgUsedCount |
Integer |
Number of allocated cloud meeting room packages of this specification. |
Example Request
GET /v1/usg/dcs/corp/resource Connection: keep-alive X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC 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: 539e8b710378987ffc5eb844b5e5c290 { "te1080pHardCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 2, "usedCount": 1 }, "te720pHardCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 5, "usedCount": 0 }, "teSoftCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 30, "usedCount": 21 }, "roomCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 0, "usedCount": 0 }, "recordCapability": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 8, "usedCount": 0 }, "confCallCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 6, "usedCount": 0 }, "liveCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 1, "usedCount": 0 }, "thirdPartyHardCount": { "expiredCount": 0, "expiringCount": 0, "trialCount": 0, "sumCount": 0, "usedCount": 0 }, "vmr": [ { "vmrPkgId": "ff808081680d5b8601682b3436070030", "vmrName": "Dedicated operations cloud meeting room_25", "vmrPkgParties": 25, "vmrPkgCount": 1, "vmrPkgUsedCount": 1 } ], "enablePstn": false, "enableSMS": true }
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: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/resource
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot