文档首页/ 弹性公网IP EIP/ API参考/ API/ 弹性公网IP标签管理/ 批量创建弹性公网IP资源标签
更新时间:2024-08-27 GMT+08:00
分享

批量创建弹性公网IP资源标签

功能介绍

为指定的弹性公网IP资源实例批量添加标签,每个弹性公网IP资源实例最多同时添加10个标签。 此接口为幂等接口: 创建时如果请求体中存在重复key则报错。 创建时,不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。

接口约束

此接口为幂等接口: 创建时如果请求体中存在重复key则报错。 创建时不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。

调用方法

请参见如何调用API

URI

POST /v2.0/{project_id}/publicips/{publicip_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

publicip_id

String

资源ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of ResourceTagOption objects

  • 功能说明:标签列表

action

String

  • 功能说明:操作标识

    • create:创建

    • delete: 删除

  • 约束:action为create时,tag的value必选

枚举值:

  • create

  • delete

表3 ResourceTagOption

参数

是否必选

参数类型

描述

key

String

  • 功能说明:标签名称

  • 约束:

    • 不能为空。

    • 长度不超过128个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

    • 同一资源的key值不能重复。

最大长度:128

value

String

  • 功能说明:标签值

  • 约束:

    • 长度不超过255个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

    • 同一资源的key值不能重复。

最大长度:255

响应参数

请求示例

批量创建标签。

POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ]
}

响应示例

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

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

public class BatchCreatePublicipTagsSolution {

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

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCreatePublicipTagsRequest request = new BatchCreatePublicipTagsRequest();
        BatchCreatePublicipTagsRequestBody body = new BatchCreatePublicipTagsRequestBody();
        List<ResourceTagOption> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new ResourceTagOption()
                .withKey("key1")
                .withValue("value1")
        );
        listbodyTags.add(
            new ResourceTagOption()
                .withKey("key2")
                .withValue("value2")
        );
        body.withAction(BatchCreatePublicipTagsRequestBody.ActionEnum.fromValue("create"));
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            BatchCreatePublicipTagsResponse response = client.batchCreatePublicipTags(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v2.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = BatchCreatePublicipTagsRequest()
        listTagsbody = [
            ResourceTagOption(
                key="key1",
                value="value1"
            ),
            ResourceTagOption(
                key="key2",
                value="value2"
            )
        ]
        request.body = BatchCreatePublicipTagsRequestBody(
            action="create",
            tags=listTagsbody
        )
        response = client.batch_create_publicip_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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCreatePublicipTagsRequest{}
	var listTagsbody = []model.ResourceTagOption{
        {
            Key: "key1",
            Value: "value1",
        },
        {
            Key: "key2",
            Value: "value2",
        },
    }
	request.Body = &model.BatchCreatePublicipTagsRequestBody{
		Action: model.GetBatchCreatePublicipTagsRequestBodyActionEnum().CREATE,
		Tags: listTagsbody,
	}
	response, err := client.BatchCreatePublicipTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

204

No Content

错误码

请参见错误码

相关文档