Updated on 2024-11-08 GMT+08:00

Creating Predefined Tags

Function

This API is used to create predefined tags. This API supports idempotency and batch data processing.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/predefine_tags/action

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. TMS is a global service. When calling the Identity and Access Management (IAM) API to obtain a user token, set the scope field to domain. The value of X-Subject-Token in the response header is the user token.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Specifies the operation (case sensitive). The value is create.

tags

Yes

Array of PredefineTagRequest objects

Tag list.

Table 3 PredefineTagRequest

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

The value can contain up to 36 characters including letters, digits, hyphens (-), and underscores (_).

value

Yes

String

Specifies the tag value. The value can contain up to 43 characters including letters, digits, periods (.), hyphens (-), and underscores (_). It can be an empty string.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 5 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 7 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 9 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 11 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 405

Table 12 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 13 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 406

Table 14 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 15 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 409

Table 16 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 17 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 410

Table 18 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 19 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 412

Table 20 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 21 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 429

Table 22 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 23 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 500

Table 24 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 25 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 501

Table 26 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 27 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Status code: 503

Table 28 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.

Table 29 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code

error_msg

String

Error message

Example Requests

Creating predefined tags

POST https://{Endpoint}/v1.0/predefine_tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "ENV1",
    "value" : "DEV1"
  }, {
    "key" : "ENV2",
    "value" : "DEV2"
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Creating predefined tags

 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.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 CreatePredefineTagsSolution {

    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();
        CreatePredefineTagsRequest request = new CreatePredefineTagsRequest();
        ReqCreatePredefineTag body = new ReqCreatePredefineTag();
        List<PredefineTagRequest> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new PredefineTagRequest()
                .withKey("ENV1")
                .withValue("DEV1")
        );
        listbodyTags.add(
            new PredefineTagRequest()
                .withKey("ENV2")
                .withValue("DEV2")
        );
        body.withTags(listbodyTags);
        body.withAction(ReqCreatePredefineTag.ActionEnum.fromValue("create"));
        request.withBody(body);
        try {
            CreatePredefineTagsResponse response = client.createPredefineTags(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 predefined tags

 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
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = TmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(TmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePredefineTagsRequest()
        listTagsbody = [
            PredefineTagRequest(
                key="ENV1",
                value="DEV1"
            ),
            PredefineTagRequest(
                key="ENV2",
                value="DEV2"
            )
        ]
        request.body = ReqCreatePredefineTag(
            tags=listTagsbody,
            action="create"
        )
        response = client.create_predefine_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 predefined tags

 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
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.CreatePredefineTagsRequest{}
	var listTagsbody = []model.PredefineTagRequest{
        {
            Key: "ENV1",
            Value: "DEV1",
        },
        {
            Key: "ENV2",
            Value: "DEV2",
        },
    }
	request.Body = &model.ReqCreatePredefineTag{
		Tags: listTagsbody,
		Action: model.GetReqCreatePredefineTagActionEnum().CREATE,
	}
	response, err := client.CreatePredefineTags(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

No Content

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

Error Codes

See Error Codes.