更新时间:2024-11-07 GMT+08:00
分享

修改预定义标签

功能介绍

修改预定义标签。

调用方法

请参见如何调用API

URI

PUT /v1.0/predefine_tags

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表2 请求Body参数

参数

是否必选

参数类型

描述

new_tag

PredefineTagRequest object

修改后的标签

old_tag

PredefineTagRequest object

修改前的标签

表3 PredefineTagRequest

参数

是否必选

参数类型

描述

key

String

键。

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

value

String

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

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表5 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表7 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表9 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表11 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 405

表12 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表13 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 406

表14 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表15 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 409

表16 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表17 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 410

表18 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表19 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 412

表20 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表21 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 429

表22 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表23 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 500

表24 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表25 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 501

表26 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表27 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

状态码: 503

表28 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

响应错误信息

表29 RespErrorMessage

参数

参数类型

描述

error_code

String

请求错误码

error_msg

String

错误信息

请求示例

修改预定义标签

PUT https://{Endpoint}/v1.0/predefined_tags

{
  "new_tag" : {
    "key" : "ENV1",
    "value" : "DEV1"
  },
  "old_tag" : {
    "key" : "ENV2",
    "value" : "DEV2"
  }
}

响应示例

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
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.*;


public class UpdatePredefineTagsSolution {

    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();
        UpdatePredefineTagsRequest request = new UpdatePredefineTagsRequest();
        ModifyPrefineTag body = new ModifyPrefineTag();
        PredefineTagRequest oldTagbody = new PredefineTagRequest();
        oldTagbody.withKey("ENV2")
            .withValue("DEV2");
        PredefineTagRequest newTagbody = new PredefineTagRequest();
        newTagbody.withKey("ENV1")
            .withValue("DEV1");
        body.withOldTag(oldTagbody);
        body.withNewTag(newTagbody);
        request.withBody(body);
        try {
            UpdatePredefineTagsResponse response = client.updatePredefineTags(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
# 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 = UpdatePredefineTagsRequest()
        oldTagbody = PredefineTagRequest(
            key="ENV2",
            value="DEV2"
        )
        newTagbody = PredefineTagRequest(
            key="ENV1",
            value="DEV1"
        )
        request.body = ModifyPrefineTag(
            old_tag=oldTagbody,
            new_tag=newTagbody
        )
        response = client.update_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)

修改预定义标签

 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
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.UpdatePredefineTagsRequest{}
	oldTagbody := &model.PredefineTagRequest{
		Key: "ENV2",
		Value: "DEV2",
	}
	newTagbody := &model.PredefineTagRequest{
		Key: "ENV1",
		Value: "DEV1",
	}
	request.Body = &model.ModifyPrefineTag{
		OldTag: oldTagbody,
		NewTag: newTagbody,
	}
	response, err := client.UpdatePredefineTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的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

错误码

请参见错误码

相关文档