Updated on 2024-03-21 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

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

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 characters

Response

None

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

None

SDK Sample Code

The sample code is as follows:

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.sms.v3.region.SmsRegion;
import com.huaweicloud.sdk.sms.v3.*;
import com.huaweicloud.sdk.sms.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class DeleteTemplatesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        SmsClient client = SmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmsRegion.valueOf("<YOUR REGION>"))
                .build();
        DeleteTemplatesRequest request = new DeleteTemplatesRequest();
        DeletetemplatesReq body = new DeletetemplatesReq();
        List<String> listbodyIds = new ArrayList<>();
        listbodyIds.add("3db302e8-95de-478c-a892-8a083f2dxxxx");
        listbodyIds.add("708847ae-f013-4b1a-8ea8-6cfa1e94xxxx");
        body.withIds(listbodyIds);
        request.withBody(body);
        try {
            DeleteTemplatesResponse response = client.deleteTemplates(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdksms.v3.region.sms_region import SmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksms.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = SmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DeleteTemplatesRequest()
        listIdsbody = [
            "3db302e8-95de-478c-a892-8a083f2dxxxx",
            "708847ae-f013-4b1a-8ea8-6cfa1e94xxxx"
        ]
        request.body = DeletetemplatesReq(
            ids=listIdsbody
        )
        response = client.delete_templates(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := sms.NewSmsClient(
        sms.SmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DeleteTemplatesRequest{}
	var listIdsbody = []string{
        "3db302e8-95de-478c-a892-8a083f2dxxxx",
	    "708847ae-f013-4b1a-8ea8-6cfa1e94xxxx",
    }
	request.Body = &model.DeletetemplatesReq{
		Ids: &listIdsbody,
	}
	response, err := client.DeleteTemplates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.