Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Applications/ Deleting Applications from a Project in Batches
Updated on 2024-11-25 GMT+08:00

Deleting Applications from a Project in Batches

Function

This API is used to delete applications from a project in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/applications/batch-delete

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

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 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

application_ids

Yes

Array of strings

Application ID list

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

Array of AppDeleteResult objects

Result of deleting applications in batches

total_num

Integer

Total number of applications deleted in batches

Table 4 AppDeleteResult

Parameter

Type

Description

application_id

String

Application ID

application_name

String

Application name

status

String

Deletion result: success or error

error_reason

String

Causes of deletion failures

Example Requests

https://{endpoint}/v2/applications/batch-delete

{
  "application_ids" : [ "eac65c10c5c34df1824af96ec93a9eea", "3ba2ad194ff141e39b1d3d0749242858" ],
  "project_id" : "0a38ce9ba3c740c199a0f872b6163661"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ {
    "application_id" : "eac65c10c5c34df1824af96ec93a9eea",
    "application_name" : "Application name 1",
    "error_reason" : "",
    "status" : "success"
  }, {
    "application_id" : "eac65c10c5c34df1824af96ec93a9eeb",
    "application_name" : "Application name 2",
    "error_reason" : "No permissions.",
    "status" : "error"
  } ],
  "total_num" : 2
}

SDK Sample Code

The SDK sample code is as follows.

Java

 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
54
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.codeartsdeploy.v2.region.CodeArtsDeployRegion;
import com.huaweicloud.sdk.codeartsdeploy.v2.*;
import com.huaweicloud.sdk.codeartsdeploy.v2.model.*;

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

public class BatchDeleteAppSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchDeleteAppRequest request = new BatchDeleteAppRequest();
        AppBatchDeleteRequest body = new AppBatchDeleteRequest();
        List<String> listbodyApplicationIds = new ArrayList<>();
        listbodyApplicationIds.add("eac65c10c5c34df1824af96ec93a9eea");
        listbodyApplicationIds.add("3ba2ad194ff141e39b1d3d0749242858");
        body.withApplicationIds(listbodyApplicationIds);
        body.withProjectId("0a38ce9ba3c740c199a0f872b6163661");
        request.withBody(body);
        try {
            BatchDeleteAppResponse response = client.batchDeleteApp(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());
        }
    }
}

Python

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.v2 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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = BatchDeleteAppRequest()
        listApplicationIdsbody = [
            "eac65c10c5c34df1824af96ec93a9eea",
            "3ba2ad194ff141e39b1d3d0749242858"
        ]
        request.body = AppBatchDeleteRequest(
            application_ids=listApplicationIdsbody,
            project_id="0a38ce9ba3c740c199a0f872b6163661"
        )
        response = client.batch_delete_app(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchDeleteAppRequest{}
	var listApplicationIdsbody = []string{
        "eac65c10c5c34df1824af96ec93a9eea",
	    "3ba2ad194ff141e39b1d3d0749242858",
    }
	request.Body = &model.AppBatchDeleteRequest{
		ApplicationIds: listApplicationIdsbody,
		ProjectId: "0a38ce9ba3c740c199a0f872b6163661",
	}
	response, err := client.BatchDeleteApp(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.