Help Center/ CloudDevice/ API Reference/ APIs/ Instance Usage/ Releasing a Session by an Instance
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Releasing a Session by an Instance

Function

After the streaming is stopped, the session still exists for a period of time. This API can be used to release the session.

URI

POST /v1/instances/session/release

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

IAM token information of the tenant.

x-request-id

Yes

String

Unique ID of a request.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

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

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.

Status code: 500

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.9999: Internal service error.

error_msg

String

Error message.

Example Requests

/v1/instances/session/release

{
  "instance_id" : "iRJEVP96 - iRJEVP96"
}

Example Responses

Status code: 200

Normal response.

{
  "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