Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Name Policy/ Deleting Desktop Name Policies in Batches
Updated on 2025-07-14 GMT+08:00

Deleting Desktop Name Policies in Batches

Function

This interface is used to delete desktop name policies in batches.

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}/desktop-name-policies/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

X-Auth-Token

No

String

User token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

policy_ids

No

Array of strings

Policy ID array. A maximum of 50 policy IDs are supported.

Response Parameters

Status code: 204

The system responds properly when desktop name policies are deleted in batches.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

{
  "policy_ids" : [ "xxxx3bc6-1512-4386-81fb-20604fe6xxxx" ]
}

Example Responses

None

Status Codes

Status Code

Description

204

The system responds properly when desktop name policies are deleted in batches.

400

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

401

Authentication failed.

403

No operation permission.

500

Internal server error.

Error Codes

See Error Codes.