文档首页/ 企业路由器 ER/ API参考/ API/ 标签/ 批量添加删除资源标签
更新时间:2024-04-03 GMT+08:00
分享

批量添加删除资源标签

功能介绍

  • 为指定实例批量添加或删除标签

  • 标签管理服务需要使用该接口批量管理实例的标签。

  • 一个资源上最多有20个标签。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/{resource_type}/{resource_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

resource_id

String

资源ID

resource_type

String

标签资源类型:

  • instance: 企业路由器实例

  • route-table: 路由表

  • vpc-attachment: VPC连接

  • vgw-attachment: 虚拟网关连接

  • peering-attachment: 对等连接(Peering)连接

  • vpn-attachment: VPN网关连接

  • ecn-attachment: 企业连接网连接

  • cfw-attachment: 云防火墙连接

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

String

功能说明:操作标识。 取值范围: create(创建) delete(删除)

tags

Array of Tag objects

标签列表。

表3 Tag

参数

是否必选

参数类型

描述

key

String

标签键,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • _sys_开头属于系统标签,租户不能输入。

  • 标签key不能为空(长度不能为0)。

  • 长度在1-128之间。

最小长度:1

最大长度:128

value

String

标签值,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • 资源标签值可以为空(empty or null)。

  • 长度在0-255之间。

最小长度:0

最大长度:255

响应参数

请求示例

  • 批量添加资源标签。

    POST https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action
    
    {
      "action" : "create",
      "tags" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key2",
        "value" : "value2"
      } ]
    }
  • 批量删除资源标签。

    POST https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action
    
    {
      "action" : "delete",
      "tags" : [ {
        "key" : "key1"
      }, {
        "key" : "key2",
        "value" : "value3"
      } ]
    }

响应示例

SDK代码示例

SDK代码示例如下。

  • 批量添加资源标签。

     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.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.er.v3.region.ErRegion;
    import com.huaweicloud.sdk.er.v3.*;
    import com.huaweicloud.sdk.er.v3.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchCreateResourceTagsSolution {
    
        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);
    
            ErClient client = ErClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchCreateResourceTagsRequest request = new BatchCreateResourceTagsRequest();
            BatchOperateResourceTagsRequestBody body = new BatchOperateResourceTagsRequestBody();
            List<Tag> listbodyTags = new ArrayList<>();
            listbodyTags.add(
                new Tag()
                    .withKey("key1")
                    .withValue("value1")
            );
            listbodyTags.add(
                new Tag()
                    .withKey("key2")
                    .withValue("value2")
            );
            body.withTags(listbodyTags);
            body.withAction(BatchOperateResourceTagsRequestBody.ActionEnum.fromValue("create"));
            request.withBody(body);
            try {
                BatchCreateResourceTagsResponse response = client.batchCreateResourceTags(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());
            }
        }
    }
    
  • 批量删除资源标签。

     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
    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.er.v3.region.ErRegion;
    import com.huaweicloud.sdk.er.v3.*;
    import com.huaweicloud.sdk.er.v3.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchCreateResourceTagsSolution {
    
        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);
    
            ErClient client = ErClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchCreateResourceTagsRequest request = new BatchCreateResourceTagsRequest();
            BatchOperateResourceTagsRequestBody body = new BatchOperateResourceTagsRequestBody();
            List<Tag> listbodyTags = new ArrayList<>();
            listbodyTags.add(
                new Tag()
                    .withKey("key1")
            );
            listbodyTags.add(
                new Tag()
                    .withKey("key2")
                    .withValue("value3")
            );
            body.withTags(listbodyTags);
            body.withAction(BatchOperateResourceTagsRequestBody.ActionEnum.fromValue("delete"));
            request.withBody(body);
            try {
                BatchCreateResourceTagsResponse response = client.batchCreateResourceTags(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());
            }
        }
    }
    
  • 批量添加资源标签。

     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 BasicCredentials
    from huaweicloudsdker.v3.region.er_region import ErRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdker.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 = BasicCredentials(ak, sk) \
    
        client = ErClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(ErRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchCreateResourceTagsRequest()
            listTagsbody = [
                Tag(
                    key="key1",
                    value="value1"
                ),
                Tag(
                    key="key2",
                    value="value2"
                )
            ]
            request.body = BatchOperateResourceTagsRequestBody(
                tags=listTagsbody,
                action="create"
            )
            response = client.batch_create_resource_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)
    
  • 批量删除资源标签。

     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
    # coding: utf-8
    
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdker.v3.region.er_region import ErRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdker.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 = BasicCredentials(ak, sk) \
    
        client = ErClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(ErRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchCreateResourceTagsRequest()
            listTagsbody = [
                Tag(
                    key="key1"
                ),
                Tag(
                    key="key2",
                    value="value3"
                )
            ]
            request.body = BatchOperateResourceTagsRequestBody(
                tags=listTagsbody,
                action="delete"
            )
            response = client.batch_create_resource_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)
    
  • 批量添加资源标签。

     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 main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/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 := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            Build()
    
        client := er.NewErClient(
            er.ErClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchCreateResourceTagsRequest{}
    	keyTags:= "key1"
    	valueTags:= "value1"
    	keyTags1:= "key2"
    	valueTags1:= "value2"
    	var listTagsbody = []model.Tag{
            {
                Key: &keyTags,
                Value: &valueTags,
            },
            {
                Key: &keyTags1,
                Value: &valueTags1,
            },
        }
    	request.Body = &model.BatchOperateResourceTagsRequestBody{
    		Tags: &listTagsbody,
    		Action: model.GetBatchOperateResourceTagsRequestBodyActionEnum().CREATE,
    	}
    	response, err := client.BatchCreateResourceTags(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 批量删除资源标签。

     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
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/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 := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            Build()
    
        client := er.NewErClient(
            er.ErClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchCreateResourceTagsRequest{}
    	keyTags:= "key1"
    	keyTags1:= "key2"
    	valueTags:= "value3"
    	var listTagsbody = []model.Tag{
            {
                Key: &keyTags,
            },
            {
                Key: &keyTags1,
                Value: &valueTags,
            },
        }
    	request.Body = &model.BatchOperateResourceTagsRequestBody{
    		Tags: &listTagsbody,
    		Action: model.GetBatchOperateResourceTagsRequestBodyActionEnum().DELETE,
    	}
    	response, err := client.BatchCreateResourceTags(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

No Content

错误码

请参见错误码

相关文档