更新时间:2024-09-06 GMT+08:00
分享

批量添加删除资源标签

功能介绍

为指定实例批量添加或删除标签。一个资源上最多有10个标签。

此接口为幂等接口:创建时如果请求体中存在重复key则报错。

创建时,不允许重复key,如果数据库存在就覆盖。

删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取项目ID请参考 获取项目ID

resource_type

String

资源类型,目前有:

smn_topic,主题

smn_sms,短信

smn_application,移动推送

resource_id

String

资源ID。

获取resource_id的方法:

当resource_type为“smn_topic”时,

手动添加请求消息头“X-SMN-RESOURCEID-TYPE=name”,资源ID即为topic名称。

不添加请求消息头,通过“查询资源实例”,获取资源ID。

当resource_type为“smn_sms”时,resource_id为签名ID。您可在控制台获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of ResourceTag objects

标签列表,结构体说明请参见表1。删除时tags结构体不能缺失,key不能为空或空字符串,且不针对字符集范围进行校验。

action

String

操作标识:仅限于create(创建)、delete(删除)。

表4 ResourceTag

参数

是否必选

参数类型

描述

key

String

键,表示要匹配的字段。

当前key的参数值只能取“resource_name”,此时value的参数值为云服务器名称。

  • key不能重复,value为匹配的值。

  • 此字段为固定字典值。

  • 不允许为空字符串。

value

String

值。

当前key的参数值只能取“resource_name”,此时value的参数值为云服务器名称。

  • 每个值最大长度255个unicode字符。

  • 不可以为空。

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

  • 批量添加资源标签

    POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/tags/action
    
    {
      "action" : "create",
      "tags" : [ {
        "key" : "key1",
        "value" : "value1"
      }, {
        "key" : "key",
        "value" : "value3"
      } ]
    }
  • 批量删除资源标签

    POST https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/{resource_id}/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
    63
    64
    65
    66
    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.smn.v2.region.SmnRegion;
    import com.huaweicloud.sdk.smn.v2.*;
    import com.huaweicloud.sdk.smn.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchCreateOrDeleteResourceTagsSolution {
    
        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");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            SmnClient client = SmnClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchCreateOrDeleteResourceTagsRequest request = new BatchCreateOrDeleteResourceTagsRequest();
            request.withResourceType("{resource_type}");
            request.withResourceId("{resource_id}");
            BatchCreateOrDeleteResourceTagsRequestBody body = new BatchCreateOrDeleteResourceTagsRequestBody();
            List<ResourceTag> listbodyTags = new ArrayList<>();
            listbodyTags.add(
                new ResourceTag()
                    .withKey("key1")
                    .withValue("value1")
            );
            listbodyTags.add(
                new ResourceTag()
                    .withKey("key")
                    .withValue("value3")
            );
            body.withAction("create");
            body.withTags(listbodyTags);
            request.withBody(body);
            try {
                BatchCreateOrDeleteResourceTagsResponse response = client.batchCreateOrDeleteResourceTags(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
    62
    63
    64
    65
    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.smn.v2.region.SmnRegion;
    import com.huaweicloud.sdk.smn.v2.*;
    import com.huaweicloud.sdk.smn.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class BatchCreateOrDeleteResourceTagsSolution {
    
        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");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            SmnClient client = SmnClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                    .build();
            BatchCreateOrDeleteResourceTagsRequest request = new BatchCreateOrDeleteResourceTagsRequest();
            request.withResourceType("{resource_type}");
            request.withResourceId("{resource_id}");
            BatchCreateOrDeleteResourceTagsRequestBody body = new BatchCreateOrDeleteResourceTagsRequestBody();
            List<ResourceTag> listbodyTags = new ArrayList<>();
            listbodyTags.add(
                new ResourceTag()
                    .withKey("key1")
            );
            listbodyTags.add(
                new ResourceTag()
                    .withKey("key2")
                    .withValue("value3")
            );
            body.withAction("delete");
            body.withTags(listbodyTags);
            request.withBody(body);
            try {
                BatchCreateOrDeleteResourceTagsResponse response = client.batchCreateOrDeleteResourceTags(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
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdksmn.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"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = SmnClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(SmnRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchCreateOrDeleteResourceTagsRequest()
            request.resource_type = "{resource_type}"
            request.resource_id = "{resource_id}"
            listTagsbody = [
                ResourceTag(
                    key="key1",
                    value="value1"
                ),
                ResourceTag(
                    key="key",
                    value="value3"
                )
            ]
            request.body = BatchCreateOrDeleteResourceTagsRequestBody(
                action="create",
                tags=listTagsbody
            )
            response = client.batch_create_or_delete_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
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdksmn.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"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = SmnClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(SmnRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = BatchCreateOrDeleteResourceTagsRequest()
            request.resource_type = "{resource_type}"
            request.resource_id = "{resource_id}"
            listTagsbody = [
                ResourceTag(
                    key="key1"
                ),
                ResourceTag(
                    key="key2",
                    value="value3"
                )
            ]
            request.body = BatchCreateOrDeleteResourceTagsRequestBody(
                action="delete",
                tags=listTagsbody
            )
            response = client.batch_create_or_delete_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"
        smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/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")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := smn.NewSmnClient(
            smn.SmnClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchCreateOrDeleteResourceTagsRequest{}
    	request.ResourceType = "{resource_type}"
    	request.ResourceId = "{resource_id}"
    	var listTagsbody = []model.ResourceTag{
            {
                Key: "key1",
                Value: "value1",
            },
            {
                Key: "key",
                Value: "value3",
            },
        }
    	request.Body = &model.BatchCreateOrDeleteResourceTagsRequestBody{
    		Action: "create",
    		Tags: listTagsbody,
    	}
    	response, err := client.BatchCreateOrDeleteResourceTags(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
    52
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/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")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := smn.NewSmnClient(
            smn.SmnClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.BatchCreateOrDeleteResourceTagsRequest{}
    	request.ResourceType = "{resource_type}"
    	request.ResourceId = "{resource_id}"
    	var listTagsbody = []model.ResourceTag{
            {
                Key: "key1",
            },
            {
                Key: "key2",
                Value: "value3",
            },
        }
    	request.Body = &model.BatchCreateOrDeleteResourceTagsRequestBody{
    		Action: "delete",
    		Tags: listTagsbody,
    	}
    	response, err := client.BatchCreateOrDeleteResourceTags(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

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

状态码

状态码

描述

204

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档