How to call queryClientViews using RPA-Robotic Process Automation(RPA)-阿里云帮助中心

Endpoint: console-rpa.aliyun.com/rpa/openapi/client/queryClientViews

Method: GET

Response format: JSON

Description: Queries information about clients.

Request parameters

Name	Type	Required	Example	Description
clientName	String	No	IZQH0JDWJ	The client name.
currentPage	String	No	1	The page number to display.
pageSize	String	No	10	The number of records to display on each page.

Response parameters

Name	Type	Example	Description
uuid	String	00166330ACCA52894465E1BE08930B0D	The unique identifier of the client.
groupId	String	b8e097d8-605c-47cf-a5a3-db5d13f8b4ca	The unique identifier of the enterprise.
clientType	String	robot	Client type
name	String	exampleName	The client name.
ip	String	10.30.88.168	The IP address of the client.
macAddress	String	00:16:3E:04:36:AD	The MAC address of the client.
status	String	authorized	Client authentication status
dispatchMode	String	unmanned	Scheduling mode
downloadMode	String	newer	The download mode.
remark	String	null	Remarks. The default value is null.
connectTime	Date	null	The time when the client connected.
disconnectTime	Date	null	The time when the client disconnected.
userId	String	067468ec-bbc2-4d64-9486-bd06c5371fb	The unique identifier of the user who is currently logged on.
userName	String	test_account	The username of the user who is currently logged on.
appId	String	fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d	The unique identifier of the application that last ran or is currently running on the client.
appName	String	TestAPP1	The name of the application that last ran or is currently running on the client.
taskId	String	null	The unique identifier of the scheduled task that is currently associated with the client.
connectStatus	String	unconnect	Client connection status
companyName	String	null	The enterprise name.
guacamoleEntity	String	null	A field related to the Remote Desktop Protocol (RDP).

Examples

Example request:

https://console-rpa.aliyun.com/rpa/openapi/client/queryClientViews?<Common request parameters>
&clientName=ITDA-D-22633726
&currentPage=1
&pageSize=1

Example response:

{
    "requestId":"5d4405be-7e07-4d1e-8037-7ec40a17af33",
    "success":true,
    "code":0,
    "msg":"The call is successful",
    "msgCode":"result.success",
    "data":[
        {
            "uuid":"00166330ACCA52894465E1BE08930B0D",
            "groupId":"b8e097d8-605c-47cf-a5a3-db5d13f8b4ca",
            "clientType":"robot",
            "name":"exampleName",
            "ip":"10.30.88.168",
            "macAddress":"00:16:3E:04:36:AD",
            "status":"authorized",
            "dispatchMode":"unmanned",
            "downloadMode":"newer",
            "remark":null,
            "connectTime":null,
            "disconnectTime":null,
            "userId":"067468ec-bbc2-4d64-9486-bd06c5371fb",
            "userName":"test_account",
            "appId":"fb6a99a1-d8bd-46ee-8bed-2ed9cb5a0c0d",
            "appName":"TestAPP1",
            "taskId":null,
            "connectStatus":"unconnect",
            "companyName":"null",
            "guacamoleEntity":"null"
        }
    ],
    "pager":{
        "currentPage":1,
        "totalPage":8,
        "pageSize":1,
        "total":8,
        "limit":1,
        "offset":0
    }
}