Updated on 2024-03-29 GMT+08:00

Batch Creating or Deleting Tags

Function

This API is used to create or delete tags in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

resource_id

Yes

String

Resource ID.

Minimum: 0

Maximum: 36

resource_type

Yes

String

Resource type.

  • cloud-connection: cloud connection

  • bandwidth-package: bandwidth package

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 102400

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

No

String

Operation to be performed. - create: To add a tag. - delete: To delete a tag.

tags

No

Array of Tag objects

Adding or deleting resource tags in batches

Array Length: 0 - 20

Table 4 Tag

Parameter

Mandatory

Type

Description

key

No

String

Tag key.

Minimum: 1

Maximum: 128

value

No

String

Tag value.

Minimum: 0

Maximum: 255

Response Parameters

None

Example Requests

  • Creating resource tags in batches (If the keys are the same, the values are updated. If there are no keys, the values are added.)

    POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/action
    
    {
      "action" : "create",
      "tags" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key2",
        "value" : "value3"
      } ]
    }
  • Deleting resource tags in batches by tag key

    POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/{resource_id}/tags/action
    
    {
      "action" : "delete",
      "tags" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key2",
        "value" : "value3"
      } ]
    }

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

  • Creating resource tags in batches (If the keys are the same, the values are updated. If there are no keys, the values are added.)

     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
    56
    57
    58
    59
    60
    61
    62
    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.cc.v2.region.CcRegion;
    import com.huaweicloud.sdk.cc.v2.*;
    import com.huaweicloud.sdk.cc.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchCreateDeleteTagsSolution {
    
        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);
    
            CcClient client = CcClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchCreateDeleteTagsRequest request = new BatchCreateDeleteTagsRequest();
            ResourceTags body = new ResourceTags();
            List<Tag> listbodyTags = new ArrayList<>();
            listbodyTags.add(
                new Tag()
                    .withKey("key1")
                    .withValue("value1")
            );
            listbodyTags.add(
                new Tag()
                    .withKey("key2")
                    .withValue("value3")
            );
            body.withTags(listbodyTags);
            body.withAction(ResourceTags.ActionEnum.fromValue("create"));
            request.withBody(body);
            try {
                BatchCreateDeleteTagsResponse response = client.batchCreateDeleteTags(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());
            }
        }
    }
    
  • Deleting resource tags in batches by tag key

     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
    56
    57
    58
    59
    60
    61
    62
    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.cc.v2.region.CcRegion;
    import com.huaweicloud.sdk.cc.v2.*;
    import com.huaweicloud.sdk.cc.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchCreateDeleteTagsSolution {
    
        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);
    
            CcClient client = CcClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchCreateDeleteTagsRequest request = new BatchCreateDeleteTagsRequest();
            ResourceTags body = new ResourceTags();
            List<Tag> listbodyTags = new ArrayList<>();
            listbodyTags.add(
                new Tag()
                    .withKey("key1")
                    .withValue("value1")
            );
            listbodyTags.add(
                new Tag()
                    .withKey("key2")
                    .withValue("value3")
            );
            body.withTags(listbodyTags);
            body.withAction(ResourceTags.ActionEnum.fromValue("delete"));
            request.withBody(body);
            try {
                BatchCreateDeleteTagsResponse response = client.batchCreateDeleteTags(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());
            }
        }
    }
    
  • Creating resource tags in batches (If the keys are the same, the values are updated. If there are no keys, the values are added.)

     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
    # coding: utf-8
    
    from huaweicloudsdkcore.auth.credentials import GlobalCredentials
    from huaweicloudsdkcc.v2.region.cc_region import CcRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkcc.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 = __import__('os').getenv("CLOUD_SDK_AK")
        sk = __import__('os').getenv("CLOUD_SDK_SK")
    
        credentials = GlobalCredentials(ak, sk) \
    
        client = CcClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(CcRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchCreateDeleteTagsRequest()
            listTagsbody = [
                Tag(
                    key="key1",
                    value="value1"
                ),
                Tag(
                    key="key2",
                    value="value3"
                )
            ]
            request.body = ResourceTags(
                tags=listTagsbody,
                action="create"
            )
            response = client.batch_create_delete_tags(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Deleting resource tags in batches by tag key

     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
    # coding: utf-8
    
    from huaweicloudsdkcore.auth.credentials import GlobalCredentials
    from huaweicloudsdkcc.v2.region.cc_region import CcRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkcc.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 = __import__('os').getenv("CLOUD_SDK_AK")
        sk = __import__('os').getenv("CLOUD_SDK_SK")
    
        credentials = GlobalCredentials(ak, sk) \
    
        client = CcClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(CcRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchCreateDeleteTagsRequest()
            listTagsbody = [
                Tag(
                    key="key1",
                    value="value1"
                ),
                Tag(
                    key="key2",
                    value="value3"
                )
            ]
            request.body = ResourceTags(
                tags=listTagsbody,
                action="delete"
            )
            response = client.batch_create_delete_tags(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Creating resource tags in batches (If the keys are the same, the values are updated. If there are no keys, the values are added.)

     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 main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
        cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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 := global.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            Build()
    
        client := cc.NewCcClient(
            cc.CcClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchCreateDeleteTagsRequest{}
    	keyTags:= "key1"
    	valueTags:= "value1"
    	keyTags1:= "key2"
    	valueTags1:= "value3"
    	var listTagsbody = []model.Tag{
            {
                Key: &keyTags,
                Value: &valueTags,
            },
            {
                Key: &keyTags1,
                Value: &valueTags1,
            },
        }
    	actionResourceTags:= model.GetResourceTagsActionEnum().CREATE
    	request.Body = &model.ResourceTags{
    		Tags: &listTagsbody,
    		Action: &actionResourceTags,
    	}
    	response, err := client.BatchCreateDeleteTags(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Deleting resource tags in batches by tag key

     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 main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
        cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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 := global.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            Build()
    
        client := cc.NewCcClient(
            cc.CcClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchCreateDeleteTagsRequest{}
    	keyTags:= "key1"
    	valueTags:= "value1"
    	keyTags1:= "key2"
    	valueTags1:= "value3"
    	var listTagsbody = []model.Tag{
            {
                Key: &keyTags,
                Value: &valueTags,
            },
            {
                Key: &keyTags1,
                Value: &valueTags1,
            },
        }
    	actionResourceTags:= model.GetResourceTagsActionEnum().DELETE
    	request.Body = &model.ResourceTags{
    		Tags: &listTagsbody,
    		Action: &actionResourceTags,
    	}
    	response, err := client.BatchCreateDeleteTags(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

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

204

Tags are created or deleted.

Error Codes

See Error Codes.