Help Center/ CloudDevice/ API Reference/ APIs/ Instance Management/ Resetting Instances in Batches
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Resetting Instances in Batches

Function

Reset instances in batches.

The prerequisite for calling this API is that the tenant has purchased an instance.

After this API is called, the current instance is initialized.

URI

POST /v1/instances/batch-reset

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 list. A single instance can contain a maximum of 32 characters, and the list can contain a maximum of 100 columns.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.0000: The tenant does not exist.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KPAPI.2209: No device can be assigned.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error description.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

0: successful.

KOOPHONE.API.1000: The request parameter is incorrect.

KOOPHONE.API.1001: Insufficient instance permissions.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Example Requests

/v1/instances/batch-reset 

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

Example Responses

Status code: 200

Normal response.

{
  "error_code" : "0",
  "error_msg" : "ok"
}

Status Codes

Status Code

Description

200

Normal response.

400

Bad Request

Error Codes

See Error Codes.

Parent topic: Instance Management