Help Center/ Workspace/ API Reference/ Workspace APIs/ Binds a terminal to a desktop./ Deletes a terminal-desktop binding configuration.
Updated on 2024-01-10 GMT+08:00

Deletes a terminal-desktop binding configuration.

Function

Deletes a terminal-desktop binding configuration.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/terminals/binding-desktops/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

MIME type of the request body.

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id_list

No

Array of strings

Binding policy IDs.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result_list

Array of DeleteTerminalsBindingDesktopsResult objects

IDs of policies to be deleted.

Table 5 DeleteTerminalsBindingDesktopsResult

Parameter

Type

Description

id

String

ID of the policy to be deleted.

delete_result_code

String

Result code of the deletion operation.

delete_result_msg

String

Result of the deletion operation.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

Example Requests

post /v2/fb2e5ec048384c8f9469d22db0037908/terminals/binding-desktops/batch-delete

{
  "id_list" : [ "abcdfxxxxxfghjxxxxxxjkl" ]
}

Example Responses

Status code: 200

Normal.

{
  "result_list" : [ {
    "id" : "abcdfxxxxxfghjxxxxxxjkl",
    "delete_result_code" : "WKS.00000000",
    "delete_result_msg" : "success"
  } ]
}

Status Codes

Status Code

Description

200

Normal.

400

The request cannot be understood by the server due to malformed syntax.

404

No resource found.

500

An internal service error occurred. For details about the error code, see the error code description.

Error Codes

See Error Codes.