Updated on 2025-02-13 GMT+08:00

Batch Deleting Templates

Function

This API is used to delete templates with specified IDs in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v3/vm/templates/delete

Request

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

X-Auth-Token

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

Minimum length: 1 character

Maximum length: 16,384 characters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

ids

No

Array of strings

The IDs of the templates to be deleted.

Minimum length: 0 characters

Maximum length: 255 characters

Array length: 0 to 65,535

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

String

Templates with specified IDs were deleted in batches.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 255 characters

encoded_authorization_message

String

Encrypted authorization information.

Minimum length: 0 characters

Maximum length: 65,535 characters

error_param

Array of strings

Invalid parameter.

Minimum length: 0 characters

Maximum length: 65,535 characters

Array length: 1 to 20

details

Array of details objects

The error message.

Array length: 1 to 20

Table 5 details field description

Parameter

Type

Description

error_code

String

The SMS error code.

Minimum length: 0 characters

Maximum length: 65,535 characters

error_msg

String

The SMS error message.

Minimum length: 0 characters

Maximum length: 65,535 characters

Example Request

This example deletes templates with IDs of 3db302e8-95de-478c-a892-8a083f2dxxxx and 708847ae-f013-4b1a-8ea8-6cfa1e94xxxx in a batch.

POST https://{endpoint}/v3/vm/templates/delete

{
  "ids" : [ "3db302e8-95de-478c-a892-8a083f2dxxxx", "708847ae-f013-4b1a-8ea8-6cfa1e94xxxx" ]
}

Example Response

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}

Status Codes

Status Code

Description

200

Templates with specified IDs were deleted in batches.

403

Authentication failed.

Error Codes

For details, see Error Codes.