Querying Enterprise Resource Operation Records by Page as an SP Administrator

Description

This API is used by an SP to query enterprise resource operation records that match specific search criteria. Fuzzy search based on resource ID is supported.

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-record
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, operation records of resources whose expiration time is later than the specified date are queried.
endExpireDate	No	Integer	Query	If this parameter is specified, operation records of resources whose expiration time is earlier than the specified date are queried.
startOperateDate	No	Integer	Query	If this parameter is specified, operation records of resources whose operation time is later than the specified date are queried.
endOperateDate	No	Integer	Query	If this parameter is specified, operation records of resources whose operation 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.
operateType	No	Integer	Query	Operation type. 0: addition. 1: deletion. 2: modification. 3: disabling. 4: enabling.
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 resource items by page.

Example Request

GET /v1/usg/dcs/sp/corp/746781680/resource-record?searchKey=&startExpireDate=1573488000000&endExpireDate=1620835199999&startOperateDate=1573488000000&endOperateDate=1589299199999&type=&typeId=&orderId=&operateType=&offset=0&limit=10
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: 556
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 63facce44898efa03629afd189da7f0f

{
    "offset": 0,
    "limit": 10,
    "count": 2,
    "data": [
        {
            "id": "4c6e7a9c644f4a4abe8c901341b48027",
            "type": "CONF_CALL",
            "typeId": "",
            "typeDesc": null,
            "count": 10,
            "expireDate": 1620403200000,
            "orderId": "89e60765e62c47e2b6d37356e7eaac04"
        },
        {
            "id": "4c6e7a9c644f4a4abe8c901341b48027",
            "type": "CONF_CALL",
            "typeId": "",
            "typeDesc": null,
            "count": 10,
            "expireDate": 1620403200000,
            "orderId": "89e60765e62c47e2b6d37356e7eaac04"
        }
    ]
}

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/746781680/resource-record?searchKey=&startExpireDate=1573488000000&endExpireDate=1620835199999&startOperateDate=1573488000000&endOperateDate=1589299199999&type=&typeId=&orderId=&operateType=&offset=0&limit=10

Parent topic: Enterprise Resource Management

Previous topic: Querying Enterprise Resources by Page as an SP Administrator

Next topic: Querying Resource Information as an SP Administrator