Help Center/ KooPhone/ API Reference/ APIs/ Instance Usage/ Instance Preparation Progress
Updated on 2025-11-24 GMT+08:00
View PDF
Share

Instance Preparation Progress

Function

Instance preparation progress.

The prerequisite for invoking this API is that the prepare API is called.

This API is called cyclically until the cloud phone status is normal.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    koophone:cloudphoneResource:getInstancePrepareProgress

    Read

    cloudphoneResource *

    -

    -

    -

URI

POST /v1/instances/prepare-progress

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

IAM token information of the tenant.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

User ID. The value can contain a maximum of 32 characters.

instance_id

Yes

String

Instance ID. The value can contain a maximum of 32 characters.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

data object

Response to the instance preparation progress.

error_code

String

Error code.

error_msg

String

Error description.
Table 4 data

Parameter

Type

Description

status

Integer

Instance preparation status. 0: normal 1: queuing 2: restoring and offline -1: processing failure 3: backing up

waitingCount

Integer

Wait time.

Status code: 400

Table 5 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.4001: The instance does not exist.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Status code: 500

Table 6 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.4001: The instance does not exist.

KOOPHONE.API.9999: Internal service error.

error_msg

String

Error message.

Example Requests

/v1/instances/prepare-progress

{
  "user_id" : "1008600000104285462",
  "instance_id" : "iRJEVP9"
}

Example Responses

Status code: 200

Normal response.

{
  "data" : {
    "status" : 0,
    "waitingCount" : 0
  },
  "error_code" : "0",
  "error_msg" : "OK"
}

Status Codes

Status Code

Description

200

Normal response.

400

Request error.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Instance Usage