Help Center/ KooPhone/ API Reference/ APIs/ Instance Management/ Batch Status Query
Updated on 2024-07-22 GMT+08:00
View PDF
Share

Batch Status Query

Function

This API is used to query status of instances in batches. Before calling this API, ensure that the tenant has purchased a KooPhone cloud phone instance. The current instance status is returned. 0: Unknown. 1: Stopped. 2: Running. 3: Offline. 4: Starting. 5: Shut down.

URI

POST /v1/instances/batch-query-status

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-request-id

Yes

String

Unique ID of a request.

X-Auth-Token

Yes

String

Tenant-level token.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance_ids

Yes

Array of strings

Instance ID list.

Maximum: 32

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Response code. The error code specification is KooPhone.API.1001, and the number increases in ascending order.

error_msg

String

Response description.

data

StatusResultWrapper object

Status query result.
Table 4 StatusResultWrapper

Parameter

Type

Description

status_results

Array of StatusResult objects

Status query result.
Table 5 StatusResult

Parameter

Type

Description

instance_id

String

Instance ID.

Maximum: 32

status

Integer

Cloud phone status. 0: Unknown. 1: Stopped. 2: Running. 3: Offline. 4: Starting. 5: Shut down.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Response code. The error code specification is KOOPHONE.API.0001, and the number increases in ascending order. If error_code is 0, the operation is successful.

error_msg

String

Response description.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Response code. The error code specification is KOOPHONE.API.0001, and the number increases in ascending order. If error_code is 0, the operation is successful.

error_msg

String

Response description.

Example Requests

/v1/instances/batch-query-status

{
  "instance_ids" : [ "a44uhlf7", "efjy72gs" ]
}

Example Responses

Status code: 200

OK

{
  "status_results" : [ {
    "instance_id" : "a44uhlf7",
    "status" : 0
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Instance Management