文档首页/ 云防火墙 CFW/ API参考/ API/ 标签管理/ 保存资源标签接口
更新时间:2025-01-03 GMT+08:00
分享

保存资源标签接口

功能介绍

保存资源标签接口

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/save

表1 路径参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙ID,可通过防火墙ID获取方式获取

project_id

String

项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,可通过如何获取用户Token获取

表4 请求Body参数

参数

是否必选

参数类型

描述

tags

Array of CreateTag objects

创建防火墙标签列表

表5 CreateTag

参数

是否必选

参数类型

描述

key

String

标签键

value

String

标签值

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

data

String

请求示例

保存项目id为408972e72dcd4c1a9b033e955802a36b的防火墙资源标签,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。请求体中包含两个标签,分别为key:test、value:1和key:tag_zjw-1、value:1。

https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/e743cfaf-8164-4807-aa13-d893d83313cf/tags/save?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4

{
  "tags" : [ {
    "key" : "test",
    "value" : "1"
  }, {
    "key" : "tag_zjw-1",
    "value" : "1"
  } ]
}

响应示例

状态码: 200

OK

{ }

SDK代码示例

SDK代码示例如下。

Java

保存项目id为408972e72dcd4c1a9b033e955802a36b的防火墙资源标签,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。请求体中包含两个标签,分别为key:test、value:1和key:tag_zjw-1、value:1。

 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
63
64
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

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

public class SaveTagsSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        SaveTagsRequest request = new SaveTagsRequest();
        request.withFwInstanceId("{fw_instance_id}");
        CreateTagsDto body = new CreateTagsDto();
        List<CreateTag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new CreateTag()
                .withKey("test")
                .withValue("1")
        );
        listbodyTags.add(
            new CreateTag()
                .withKey("tag_zjw-1")
                .withValue("1")
        );
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            SaveTagsResponse response = client.saveTags(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

保存项目id为408972e72dcd4c1a9b033e955802a36b的防火墙资源标签,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。请求体中包含两个标签,分别为key:test、value:1和key:tag_zjw-1、value:1。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = SaveTagsRequest()
        request.fw_instance_id = "{fw_instance_id}"
        listTagsbody = [
            CreateTag(
                key="test",
                value="1"
            ),
            CreateTag(
                key="tag_zjw-1",
                value="1"
            )
        ]
        request.body = CreateTagsDto(
            tags=listTagsbody
        )
        response = client.save_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

保存项目id为408972e72dcd4c1a9b033e955802a36b的防火墙资源标签,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。请求体中包含两个标签,分别为key:test、value:1和key:tag_zjw-1、value:1。

 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 main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/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")
    projectId := "{project_id}"

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

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SaveTagsRequest{}
	request.FwInstanceId = "{fw_instance_id}"
	keyTags:= "test"
	valueTags:= "1"
	keyTags1:= "tag_zjw-1"
	valueTags1:= "1"
	var listTagsbody = []model.CreateTag{
        {
            Key: &keyTags,
            Value: &valueTags,
        },
        {
            Key: &keyTags1,
            Value: &valueTags1,
        },
    }
	request.Body = &model.CreateTagsDto{
		Tags: &listTagsbody,
	}
	response, err := client.SaveTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档