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

批量添加标签

功能介绍

用于给云服务的多个资源添加标签,每个资源最多可添加10个标签,每次最多支持批量操作50个资源。

调用方法

请参见如何调用API

URI

POST /v1.0/resource-tags/batch-create

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。说明:由于TMS是全局服务,因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。

表2 请求Body参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,resource_type为region级别服务时为必选项。

resources

Array of ResourceTagBody objects

资源列表

tags

Array of CreateTagRequest objects

标签列表

表3 ResourceTagBody

参数

是否必选

参数类型

描述

resource_id

String

资源ID

resource_type

String

资源类型

表4 CreateTagRequest

参数

是否必选

参数类型

描述

key

String

键。 最大长度36个字符。 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

value

String

值。每个值最大长度43个字符,可以为空字符串。 字符集:A-Z,a-z , 0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

failed_resources

Array of TagCreateResponseItem objects

添加标签失败的资源信息

表6 TagCreateResponseItem

参数

参数类型

描述

resource_id

String

资源ID

resource_type

String

资源类型

error_code

String

错误码

error_msg

String

错误描述

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表8 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表10 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表12 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 404

表13 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表14 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 405

表15 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表16 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 406

表17 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表18 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 409

表19 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表20 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 410

表21 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表22 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 412

表23 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表24 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 429

表25 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表26 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 500

表27 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表28 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 501

表29 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表30 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 503

表31 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表32 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

请求示例

给资源批量添加标签。

POST https://{Endpoint}/v1.0/resource-tags/batch-create

{
  "project_id" : "xxxdcffffffff",
  "resources" : [ {
    "resource_id" : "a28531fa-a8d5-468e-8417-86a80962ee5e",
    "resource_type" : "disk"
  }, {
    "resource_id" : "a28531fa-a8d5-468e-8417-86a8096ddddd",
    "resource_type" : "vpc"
  } ],
  "tags" : [ {
    "key" : "ENV",
    "value" : "dev"
  }, {
    "key" : "DEPT",
    "value" : "pdd"
  } ]
}

响应示例

状态码: 200

Success

{
  "failed_resources" : [ {
    "resource_id" : "e1eb7c40cbea4c8389cde527594a306d",
    "resource_type" : "disk",
    "error_code" : "TMS.0002",
    "error_msg" : "Bad request"
  } ]
}

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
67
68
69
70
71
72
73
74
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.tms.v1.region.TmsRegion;
import com.huaweicloud.sdk.tms.v1.*;
import com.huaweicloud.sdk.tms.v1.model.*;

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

public class CreateResourceTagSolution {

    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);

        TmsClient client = TmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(TmsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateResourceTagRequest request = new CreateResourceTagRequest();
        ReqCreateTag body = new ReqCreateTag();
        List<CreateTagRequest> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new CreateTagRequest()
                .withKey("ENV")
                .withValue("dev")
        );
        listbodyTags.add(
            new CreateTagRequest()
                .withKey("DEPT")
                .withValue("pdd")
        );
        List<ResourceTagBody> listbodyResources = new ArrayList<>();
        listbodyResources.add(
            new ResourceTagBody()
                .withResourceId("a28531fa-a8d5-468e-8417-86a80962ee5e")
                .withResourceType("disk")
        );
        listbodyResources.add(
            new ResourceTagBody()
                .withResourceId("a28531fa-a8d5-468e-8417-86a8096ddddd")
                .withResourceType("vpc")
        );
        body.withTags(listbodyTags);
        body.withResources(listbodyResources);
        body.withProjectId("xxxdcffffffff");
        request.withBody(body);
        try {
            CreateResourceTagResponse response = client.createResourceTag(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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdktms.v1.region.tms_region import TmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdktms.v1 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 = TmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(TmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateResourceTagRequest()
        listTagsbody = [
            CreateTagRequest(
                key="ENV",
                value="dev"
            ),
            CreateTagRequest(
                key="DEPT",
                value="pdd"
            )
        ]
        listResourcesbody = [
            ResourceTagBody(
                resource_id="a28531fa-a8d5-468e-8417-86a80962ee5e",
                resource_type="disk"
            ),
            ResourceTagBody(
                resource_id="a28531fa-a8d5-468e-8417-86a8096ddddd",
                resource_type="vpc"
            )
        ]
        request.body = ReqCreateTag(
            tags=listTagsbody,
            resources=listResourcesbody,
            project_id="xxxdcffffffff"
        )
        response = client.create_resource_tag(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
54
55
56
57
58
59
60
61
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    tms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/tms/v1/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 := tms.NewTmsClient(
        tms.TmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateResourceTagRequest{}
	var listTagsbody = []model.CreateTagRequest{
        {
            Key: "ENV",
            Value: "dev",
        },
        {
            Key: "DEPT",
            Value: "pdd",
        },
    }
	var listResourcesbody = []model.ResourceTagBody{
        {
            ResourceId: "a28531fa-a8d5-468e-8417-86a80962ee5e",
            ResourceType: "disk",
        },
        {
            ResourceId: "a28531fa-a8d5-468e-8417-86a8096ddddd",
            ResourceType: "vpc",
        },
    }
	projectIdReqCreateTag:= "xxxdcffffffff"
	request.Body = &model.ReqCreateTag{
		Tags: listTagsbody,
		Resources: listResourcesbody,
		ProjectId: &projectIdReqCreateTag,
	}
	response, err := client.CreateResourceTag(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

409

Conflict

410

Gone

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

错误码

请参见错误码

分享:

    相关文档

    相关产品