# 创建预定义标签 - CreatePredefineTags #### 功能介绍 用于创建预定义标签。用户创建预定义标签后，可以使用预定义标签来给资源创建标签。 该接口支持幂等特性和处理批量数据。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-tms/zh-cn_topic_0056283725.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-tms/zh-cn_topic_0170638684.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | tms:predefineTags:create | Write | - | - | - | - | #### URI POST /v1.0/predefine_tags/action #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。（获取方式参考"[认证鉴权](https://support.huaweicloud.com/api-tms/zh-cn_topic_0173938834.html)"）。 **约束限制**： 由于TMS是全局服务，因此调用IAM服务获取用户Token接口时需要注意，作用域即scope字段应该设置为domain。 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | action | 是 | String | **参数解释**： 操作标识，用于指定对预定义标签的执行动作。 **约束限制**： action为create时，tags中传入需要创建的预定义标签列表。 **取值范围**： create：创建预定义标签 **默认取值**： 不涉及 | | tags | 是 | Array of [PredefineTagRequest] objects | **参数解释**： 创建的预定义标签列表，每个元素为一个PredefineTagRequest对象，包含标签的键（key）和值（value）。 **约束限制**： 1.每个账号最多支持创建500个预定义标签。 2.创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签；若只有"键"相同，"值"不同，则为新创建的预定义标签。 | 表3PredefineTagRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 标签的键。 **约束限制**： 不涉及 **取值范围**： 支持中文字符、英文字母、数字、中划线（-）、下划线（_），长度为1\~36个字符。 **默认取值**： 不涉及 | | value | 是 | String | **参数解释**： 标签的值。 **约束限制**： 不涉及 **取值范围**： 支持中文字符、英文字母、数字、句号（.）、中划线（-）、下划线（_），长度为0\~43个字符，可以为空字符串。 **默认取值**： 不涉及 | #### 响应参数 **状态码：204** No Content **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表5RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表7RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表9RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：404** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表11RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：405** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表13RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：406** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表15RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：409** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表17RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：410** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表19RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：412** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表21RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：429** 表22响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表23RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：500** 表24响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表25RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：501** 表26响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表27RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | **状态码：503** 表28响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error | [RespErrorMessage] object | **参数解释**： 响应的错误信息。 | 表29RespErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。请到"[错误码](https://console.huaweicloud.com/apiexplorer/#/errorcenter)"页面查询对应云服务的错误码。 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述。 **取值范围**： 不涉及 | #### 请求示例 创建预定义标签 ``` POST https://{Endpoint}/v1.0/predefine_tags/action { "action" : "create", "tags" : [ { "key" : "ENV1", "value" : "DEV1" }, { "key" : "ENV2", "value" : "DEV2" } ] } ``` #### 响应示例 无 #### SDK代码示例 SDK代码示例如下。 #### Java 创建预定义标签 ``` 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("")) .build(); CreatePredefineTagsRequest request = new CreatePredefineTagsRequest(); ReqCreatePredefineTag body = new ReqCreatePredefineTag(); List 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.ReqCreatePredefineTag.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()); } } } ``` #### Python 创建预定义标签 ``` # 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("")) \ .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) ``` #### Go 创建预定义标签 ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := tms.TmsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := tms.NewTmsClient(hcClient) 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) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/TMS/sdk?api=CreatePredefineTags)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-tms/ErrorCode.html)。