queryClientViewById

Updated at:

Request URL: console-rpa.aliyun.com/rpa/openapi/client/queryClientViewById

Request method: GET

Response format: JSON

Description: Retrieves client information.

Request parameters

Name

Type

Required

Example

Description

clientId

String

Yes

5E77DA4EB87BCFB62A8B9527626A47F4

The unique identifier of the client.

Response parameters

For more information about common response parameters, see Response structure. The following table describes the parameters in the data field.

Name

Type

Example

Description

uuid

String

afbf2b7e-374d-4a47-ad89-a9c65270f0e2

The unique identifier of the client.

groupId

String

b8e097d8-605c-47cf-a5a3-db5d13f8b4ca

The unique identifier of the enterprise.

clientType

String

robot

The client type.

name

String

guojing

The client name.

ip

String

47.10.XX.XXX

The IP address of the client.

macAddress

String

08:1F:71:16:AA:FC

Host address

status

String

authorized

Client authentication status

dispatchMode

String

unmanned

Scheduling mode

remark

String

null

The remarks.

connectTime

Date

1589092522000

The connection time.

disconnectTime

Date

1589095648000

The disconnection time.

userId

String

eb3ca5e0-4440-45e7-9d6f-2d27d65ef517

The unique identifier of the user.

userName

String

guojing

The account name.

appId

String

null

The unique identifier of the application.

appName

String

appName

The application name.

taskId

String

taskId

The unique identifier of the task.

connectStatus

String

unconnect

Client connection status

Example

Request example:

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

Response example:

{
    "requestId":"b6a678f6-3d33-4a98-bcaa-b2f57043ae8d",
    "success":true,
    "code":0,
    "msg":"The call is successful",
    "msgCode":"result.success",
    "data":{
        "uuid":"afbf2b7e-374d-4a47-ad89-a9c65270f0e2",
        "groupId":"b8e097d8-605c-47cf-a5a3-db5d13f8b4ca",
        "clientType":"robot",
        "name":"guojing",
        "ip":"47.10.XX.XXX",
        "macAddress":"08:1F:71:16:AA:FC",
        "status":"authorized",
        "dispatchMode":"unmanned",
        "remark":null,
        "connectTime":1589092522000,
        "disconnectTime":1589095648000,
        "userId":"eb3ca5e0-4440-45e7-9d6f-2d27d65ef517",
        "userName":"guojing",
        "appId":null,
        "appName":null,
        "taskId":null,
        "connectStatus":"unconnect"
    },
    "pager":null
}