更新时间:2025-08-20 GMT+08:00

创建标签

功能介绍

创建标签

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

resource_type

String

资源类型,值为groups和topics。

resource_id

String

资源id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

添加标签方式

枚举值:

  • create

  • delete

is_open

Boolean

是否对外接口调用

tags

Array of tagsBody objects

标签字段信息

表4 tagsBody

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键。

约束限制:

  • 标签键名称不可重复。

  • 标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

取值范围:

标签键可以包含任意语种的字母、数字和空格,以及_.:=+-@字符,但首尾不能包含空格,且不能以_sys_开头;长度不能超过128个字符。

默认取值:

不涉及。

value

String

参数解释:

标签值。

约束限制:

标签是以键值对(key-value)的形式表示,key和value为一一对应关系。

取值范围:

  • 标签值可以包含任意语种的字母、数字和空格,以及_.:=+-@字符。

  • 标签值长度不能超过255个字符。

默认取值:

不涉及。

响应参数

状态码:200

添加标签成功。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

创建标签

/v1/2a473356cca5487f8373be891bffc1cf/groups/0933a172-379e-44d0-9ed9-f491b1c528ea/tags/action

{
  "action" : "create",
  "is_open" : false,
  "tags" : [ {
    "key" : "zzz",
    "value" : "zzz"
  }, {
    "key" : "sgq",
    "value" : "123"
  } ]
}

响应示例

状态码:400

BadRequest 非法请求建议根据error_msg直接修改该请求

{
  "error_code" : "LTS.1836",
  "error_msg" : "action is create or delete"
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错

{
  "error_code" : "LTS.0203",
  "error_msg" : "Internal Server Error"
}

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
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;

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

public class CreateTagsSolution {

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

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateTagsRequest request = new CreateTagsRequest();
        request.withResourceType("{resource_type}");
        request.withResourceId("{resource_id}");
        CreateTagsReqbody body = new CreateTagsReqbody();
        List<TagsBody> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new TagsBody()
                .withKey("zzz")
                .withValue("zzz")
        );
        listbodyTags.add(
            new TagsBody()
                .withKey("sgq")
                .withValue("123")
        );
        body.withTags(listbodyTags);
        body.withIsOpen(false);
        body.withAction(CreateTagsReqbody.ActionEnum.fromValue("create"));
        request.withBody(body);
        try {
            CreateTagsResponse response = client.createTags(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateTagsRequest()
        request.resource_type = "{resource_type}"
        request.resource_id = "{resource_id}"
        listTagsbody = [
            TagsBody(
                key="zzz",
                value="zzz"
            ),
            TagsBody(
                key="sgq",
                value="123"
            )
        ]
        request.body = CreateTagsReqbody(
            tags=listTagsbody,
            is_open=False,
            action="create"
        )
        response = client.create_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
54
55
56
57
58
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateTagsRequest{}
	request.ResourceType = "{resource_type}"
	request.ResourceId = "{resource_id}"
	keyTags:= "zzz"
	valueTags:= "zzz"
	keyTags1:= "sgq"
	valueTags1:= "123"
	var listTagsbody = []model.TagsBody{
        {
            Key: &keyTags,
            Value: &valueTags,
        },
        {
            Key: &keyTags1,
            Value: &valueTags1,
        },
    }
	request.Body = &model.CreateTagsReqbody{
		Tags: listTagsbody,
		IsOpen: false,
		Action: model.GetCreateTagsReqbodyActionEnum().CREATE,
	}
	response, err := client.CreateTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

添加标签成功。

400

BadRequest 非法请求建议根据error_msg直接修改该请求

500

表明服务端能被请求访问到,但是服务内部出错

错误码

请参见错误码