Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Application Groups/ Moving an Application to a Specified Group
Updated on 2024-08-30 GMT+08:00

Moving an Application to a Specified Group

Function

This API is used to move applications to a specified group (batch operations are supported).

Calling Method

For details, see Calling APIs.

URI

PUT /v1/projects/{project_id}/applications/groups/move

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

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

Parameter

Mandatory

Type

Description

group_id

Yes

String

Group ID

application_ids

Yes

Array of strings

Application ID list

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Array of MoveAppToGroupResult objects

Result of moving an application to a specified group. Only the list of applications that fail to be moved is returned.

status

String

Request success or failure status

Table 5 MoveAppToGroupResult

Parameter

Type

Description

code

String

Failed or not

application_id

String

Application ID

application_name

String

Application name

error_code

String

Error code

error_msg

String

Error message

Example Requests

https://{endpoint}/v1/projects/0a38ce9ba3c740c199a0f872b6163661/applications/groups/move

{
  "application_ids" : [ "a958794f9f4f4a24a96950c9cb279a4d", "a958794f9f4f4a24a96950c9cb279a4f" ],
  "group_id" : "ec3ccc617cf3405b8a6236f26223112b"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ ],
  "status" : "success"
}

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
55
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 MoveAppToGroupSolution {

    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();
        MoveAppToGroupRequest request = new MoveAppToGroupRequest();
        request.withProjectId("{project_id}");
        MoveAppToGroupRequestBody body = new MoveAppToGroupRequestBody();
        List<String> listbodyApplicationIds = new ArrayList<>();
        listbodyApplicationIds.add("a958794f9f4f4a24a96950c9cb279a4d");
        listbodyApplicationIds.add("a958794f9f4f4a24a96950c9cb279a4f");
        body.withApplicationIds(listbodyApplicationIds);
        body.withGroupId("ec3ccc617cf3405b8a6236f26223112b");
        request.withBody(body);
        try {
            MoveAppToGroupResponse response = client.moveAppToGroup(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
39
# 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 = MoveAppToGroupRequest()
        request.project_id = "{project_id}"
        listApplicationIdsbody = [
            "a958794f9f4f4a24a96950c9cb279a4d",
            "a958794f9f4f4a24a96950c9cb279a4f"
        ]
        request.body = MoveAppToGroupRequestBody(
            application_ids=listApplicationIdsbody,
            group_id="ec3ccc617cf3405b8a6236f26223112b"
        )
        response = client.move_app_to_group(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
44
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.MoveAppToGroupRequest{}
	request.ProjectId = "{project_id}"
	var listApplicationIdsbody = []string{
        "a958794f9f4f4a24a96950c9cb279a4d",
	    "a958794f9f4f4a24a96950c9cb279a4f",
    }
	request.Body = &model.MoveAppToGroupRequestBody{
		ApplicationIds: listApplicationIdsbody,
		GroupId: "ec3ccc617cf3405b8a6236f26223112b",
	}
	response, err := client.MoveAppToGroup(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.