Querying Enterprise Resources by Page as an SP Administrator

Description

This API is used by an SP to query enterprise resources that match specific conditions.

Debugging

You can debug this API in API Explorer.

Prototype

**Table 1** Prototype
Request Method	GET
Request Address	/v1/usg/dcs/sp/corp/{corp_id}/resource
Transport Protocol	HTTPS

Request Parameters

**Table 2** Parameters
Parameter	Mandatory	Type	Location	Description
corp_id	Yes	String	Path	Enterprise ID.
offset	No	Integer	Query	Query offset. If the value exceeds the maximum number of records available, records on the last page are returned. Default value: 0.
limit	No	Integer	Query	Number of records to query. Default value: 10.
searchKey	No	String	Query	Search criteria.
startExpireDate	No	Integer	Query	If this parameter is specified, resources whose expiration time is later than the specified date are queried.
endExpireDate	No	Integer	Query	If this parameter is specified, resources whose expiration time is earlier than the specified date are queried.
type	No	String	Query	Resource type.
typeId	No	String	Query	Resource type ID. For example, if you want to query five-participant cloud meeting rooms, set this parameter to the ID of the five-participant cloud meeting room package.
status	No	Integer	Query	Resource status. 0: normal. 1: expired (returned only during query). 2: disabled.
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
count	Integer	Total number of records.
limit	Integer	Number of records displayed per page. Default value: 10.
offset	Integer	Number of the query start page. The value starts from 0.
data	Array of QueryResourceResultDTO objects	Enterprise user details.

**Table 5** QueryResourceResultDTO data structure
Parameter	Type	Description
count	Integer	Resource quantity.
editable	Boolean	Whether a resource can be edited or deleted. If the value is false, buttons for modifying or deleting resources must be hidden on the GUI.
expireDate	Long	UTC time when the resource expires.
id	String	Uniquely identifies a resource. If the request carries this parameter, the parameter value is used. Otherwise, the backend automatically generates a UUID.
status	Integer	Resource status. 0: normal. 1: expired. 2: disabled.
type	String	Resource type. VMR: cloud meeting room. CONF_CALL: concurrent participant. HARD_1080P: 1080p hard terminal access account. HARD_720P: 720p hard terminal access account. SOFT: user account. ROOM: whiteboard account. LIVE: live broadcast port. RECORD: recording storage space. HARD_THIRD_PARTY: third-party hard terminal access account. HUAWEI_VISION: smart TV account. IDEA_HUB - ideahub
typeDesc	String	Description of the resource type. For example, if the resource type is cloud meeting room, the value of this parameter is the name of the cloud meeting room package.
typeId	String	Resource type ID. For example, if the resource type is cloud meeting room, the value of this parameter is the ID of the cloud meeting room package.
vmrMode	Integer	Cloud meeting room mode. 0: personal meeting ID. 1: cloud meeting room. 2: webinar.
orderId	String	Order ID corresponding to the resource.

Example Request

GET /v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0
Connection: keep-alive
X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF
Content-Type: application/json
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 63facce44898efa03629afd189da7f0f

{
  "count": 1,
  "data": [
    {
      "count": 10,
      "editable": true,
      "expireDate": 2549030400000,
      "id": "b974dfbe2daf456880afd10c80d12c9f",
      "status": 0,
      "type": "VMR",
      "typeDesc": null,
      "typeId": "ff808081699b56cb0169c411a0980152"
    }
  ],
  "limit": 5,
  "offset": 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/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0

Parent topic: Enterprise Resource Management

Previous topic: Modifying Enterprise Resources as an SP Administrator

Next topic: Querying Enterprise Resource Operation Records by Page as an SP Administrator