API for Querying Client Status

Prerequisite

Please make sure you obtain x-ak & x-sk issued by Aethir.

Query Client Online Status

Description

This interface is used to query whether the client is online.

URL

https://app.aethir.com/console-api/v2/client/onLineState

Method

POST

Rate Limit

Each x-ak can make a request every 5 seconds.

Request Headers

Header
Type
Mandatory

x-ak

string

Yes

x-op-token

string

Yes

Request Body

The request body is an array of clientId, supporting a maximum of 100 IDs.

[
  "clientId1",
  "clientId2",
  ...
]

Response

Possible responses and their corresponding meanings are:

  • HttpStatus 200: Query successful; the query result is parsed in the HttpResponseBody.

  • HttpStatus 400: The x-op-token format is incorrect or rate limit exceeded.

  • HttpStatus 401: The client needs to regenerate the x-op-token and retry the query.

Response Body

[
  {
    "clientId": "clientId1",
    "onLineState": 1
  }
]
Field
Type
Description

clientId

string

Client ID

onLineState

int

1: Online, 0: Offline

Last updated