Help Center/ Meeting/ Server API Reference/ Enterprise Management/ APIs/ Querying Enterprise Resource Orders by Page
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF

Querying Enterprise Resource Orders by Page

Description

This API is used by the enterprise administrator to query enterprise resource orders based on the search criteria.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/usg/dcs/corp/resource-list

Transport Protocol

HTTPS

Request Parameters

Table 2 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.

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 be queried.

Default value: 10.

searchKey

No

String

Query

Search criteria. Fuzzy search by resourceId is supported.

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.

  • 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.
    NOTE:

    When webinar resources are queried, set type to VMR.

vmrMode

No

Integer

Query

Cloud meeting room mode. This parameter is valid only when type is set to VMR.

  • 0: personal meeting ID.
  • 1: cloud meeting room.
  • 2: webinar.

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.

orderId

No

String

Query

Order ID.

status

No

Integer

Query

Order status.

  • 0: normal.
  • 1: expired.
  • 2: disabled.

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/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10
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

{
    "offset": 0,
    "limit": 10,
    "count": 1,
    "data": [
        {
            "id": "1747cfe902c34631999975417bf6bc1a",
            "type": "VMR",
            "typeId": 2001000,
            "typeDesc": "Webinar_1000 Attendees",
            "vmrMode": 2,
            "count": 10,
            "expireDate": 1640966400000,
            "orderId": "95152407f7f147149e7f3e8e5e4a84bc",
            "status": 0,
            "editable": 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' /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10
Parent topic: APIs