SP管理员查询资源信息
描述
SP管理员查询SP的所有资源,包括已使用的资源。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
GET |
---|---|
请求地址 |
/v1/usg/dcs/sp/resource |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
---|---|---|---|---|
queryGroup |
否 |
Boolean |
Query |
是否在查询资源信息时返回媒体接入分组id,默认不查询。 |
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
X-Request-Id |
否 |
String |
Header |
请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 |
Accept-Language |
否 |
String |
Header |
语言参数,默认为中文zh-CN,英文为en-US。 |
状态码
HTTP状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
confCallCount |
ResDetailDTO object |
会议并发方数。 |
corpCount |
ResDetailDTO object |
企业总数。 |
enablePstn |
Boolean |
在创建企业的时候设置的pstn权限开关。 |
enableSMS |
Boolean |
企业是否通过短信形式发送会议通知。 |
groupList |
Array of QueryCorpGroupDTO objects |
SP管理员绑定的分组列表。 |
hwVisionCount |
ResDetailDTO object |
智慧屏TV接入数。 |
ideaHubCount |
ResDetailDTO object |
IdeaHub接入数。 |
liveCount |
ResDetailDTO object |
推流并发方数。 |
recordCapability |
ResDetailDTO object |
录播存储空间 (单位:G)。 |
roomCount |
ResDetailDTO object |
电子白板(SmartRooms)接入数。 |
te1080pHardCount |
ResDetailDTO object |
1080P硬终端接入数。 |
te720pHardCount |
ResDetailDTO object |
720P硬终端接入数。 |
teSoftCount |
ResDetailDTO object |
软终端账号数。 |
thirdPartyHardCount |
ResDetailDTO object |
第三方硬终端接入数。 |
请求消息示例
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)
响应消息示例
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": "测试分组", "groupType": 3, "regionId": "393e8fec7413734b01s71458c2d80s01", "remarks": "测试", "status": 0 } ] }
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/resource