Querying Activation Codes by Page as an Enterprise Administrator
Description
This API is used by an enterprise administrator to query activation codes by page. Fuzzy query by activation code or terminal name is supported.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/dcs/corp/vision/activecode |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
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. Fuzzy search by activation code or terminal name is supported. |
devType |
No |
String |
Query |
Terminal type.
|
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 |
---|---|---|
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 QueryVisionActiveCodeResultDTO objects |
Activation code information. |
Parameter |
Type |
Description |
---|---|---|
activeCode |
String |
Activation code. |
deptCode |
String |
Department code. |
deptName |
String |
Department name. |
devName |
String |
Terminal name. |
devType |
String |
Terminal type. |
expireDate |
Long |
Expiration timestamp. |
id |
String |
Unique ID of the activation code. |
Example Request
GET /v1/usg/dcs/corp/vision/activecode Connection: keep-alive X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD 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: 639e8b710378987ffc5eb844b5e5c291 { "count": 1, "data": [ { "activeCode": "324****97", "deptCode": "1", "deptName": "Test Department", "devName": "test_device", "devType": "idea-hub", "expireDate": 1611250137942, "id": "6d35397d67504dd1b7e1766a25f1be12" } ], "limit": 10, "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: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vision/activecode
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