文档首页/ 云备份 CBR/ API参考/ API/ 标签/ 批量添加删除存储库资源标签
更新时间:2024-06-21 GMT+08:00

批量添加删除存储库资源标签

功能介绍

为指定实例批量添加或删除标签 标签管理服务需要使用该接口批量管理实例的标签。 一个资源上最多有10个标签。 此接口为幂等接口: 创建时如果请求体中存在重复key则报错。 创建时,不允许重复key,如果数据库存在就覆盖。 删除时,允许重复key。 删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。key长度127个字符,value为255个字符。删除时tags结构体不能缺失,key不能为空,或者空字符串。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/vault/{vault_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id

vault_id

String

资源id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of Tag objects

标签列表。

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

sys_tags

Array of SysTag objects

系统标签列表。

op_service权限可以访问,和tags二选一。

目前TMS调用时只包含一个resource_tag结构体 ,key固定为:_sys_enterprise_project_id。

value是UUID或0,value为0表示默认企业项目。

现在仅支持create操作。

action

String

操作标识

  • create: 创建

  • delete: 删除

表3 Tag

参数

是否必选

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

值。

添加标签时value值必选,删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

表4 SysTag

参数

是否必选

参数类型

描述

key

String

键。 系统标签的key,从白名单中取,不能随意定义。 目前仅支持 _sys_enterprise_project_id字段,对应 的value为企业项目ID。

value

String

值。 目前仅会用到企业项目ID,其中默认的企业项目ID为“0”。

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码

error_msg

String

错误信息

请求示例

批量创建tag

POST  https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags/action

{
  "tags" : [ {
    "key" : "string",
    "value" : "string"
  }, {
    "key" : "string1",
    "value" : "string2"
  } ],
  "action" : "create"
}

响应示例

SDK代码示例

SDK代码示例如下。

Java

批量创建tag

 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.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.cbr.v1.region.CbrRegion;
import com.huaweicloud.sdk.cbr.v1.*;
import com.huaweicloud.sdk.cbr.v1.model.*;

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

public class BatchCreateAndDeleteVaultTagsSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CbrClient client = CbrClient.newBuilder()
                .withCredential(auth)
                .withRegion(CbrRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCreateAndDeleteVaultTagsRequest request = new BatchCreateAndDeleteVaultTagsRequest();
        BulkCreateAndDeleteVaultTagsReq body = new BulkCreateAndDeleteVaultTagsReq();
        List<Tag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new Tag()
                .withKey("string")
                .withValue("string")
        );
        listbodyTags.add(
            new Tag()
                .withKey("string1")
                .withValue("string2")
        );
        body.withAction(BulkCreateAndDeleteVaultTagsReq.ActionEnum.fromValue("create"));
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            BatchCreateAndDeleteVaultTagsResponse response = client.batchCreateAndDeleteVaultTags(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

批量创建tag

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

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcbr.v1.region.cbr_region import CbrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcbr.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 = BasicCredentials(ak, sk) \

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

    try:
        request = BatchCreateAndDeleteVaultTagsRequest()
        listTagsbody = [
            Tag(
                key="string",
                value="string"
            ),
            Tag(
                key="string1",
                value="string2"
            )
        ]
        request.body = BulkCreateAndDeleteVaultTagsReq(
            action="create",
            tags=listTagsbody
        )
        response = client.batch_create_and_delete_vault_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

批量创建tag

 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/basic"
    cbr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cbr/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cbr.NewCbrClient(
        cbr.CbrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCreateAndDeleteVaultTagsRequest{}
	var listTagsbody = []model.Tag{
        {
            Key: "string",
            Value: "string",
        },
        {
            Key: "string1",
            Value: "string2",
        },
    }
	request.Body = &model.BulkCreateAndDeleteVaultTagsReq{
		Action: model.GetBulkCreateAndDeleteVaultTagsReqActionEnum().CREATE,
		Tags: &listTagsbody,
	}
	response, err := client.BatchCreateAndDeleteVaultTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

204

No Content

400

Bad Request

错误码

请参见错误码