Help Center/ KooPhone/ API Reference/ APIs/ Instance Management/ Assigning Instances
Updated on 2025-11-24 GMT+08:00
View PDF
Share

Assigning Instances

Function

Before calling this API, ensure that the tenant has purchased an instance. This API is used to assign a cloud phone to a user specified by the tenant. The user ID needs to be specified.

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:instanceAssign

    Write

    cloudphoneResource *

    -

    -

    -

URI

POST /v1/instances/assign

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

user_instances

Yes

Array of user_instances objects

User instance binding relationship list. The list can contain a maximum of 100 columns.
Table 3 user_instances

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 4 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 5 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: 500

Table 6 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.

Example Requests

/instances/assign

{
  "user_instances" : [ {
    "instance_id" : "a44uhlf7",
    "user_id" : "1123422"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Normal response.

400

Request error.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Instance Management