Saving a Resource Tag
Function
This API is used to save a resource tag.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/save
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fw_instance_id |
Yes |
String |
Firewall ID, which can be obtained by referring to Obtaining a Firewall ID. |
project_id |
Yes |
String |
Project ID, which can be obtained by calling an API or from the console. You can obtain it by referring to Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by referring to Obtaining a User Token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tags |
No |
Array of CreateTag objects |
Create a firewall tag list. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
String |
Example Requests
Save the firewall resource tag of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and the enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4. The request body contains two tags: key:test, value:1 and 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" } ] }
Example Responses
Status code: 200
OK
{ }
SDK Sample Code
The SDK sample code is as follows.
Java
Save the firewall resource tag of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and the enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4. The request body contains two tags: key:test, value:1 and 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
Save the firewall resource tag of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and the enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4. The request body contains two tags: key:test, value:1 and 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
Save the firewall resource tag of the project whose ID is eefb11b22d5944f2aa067954516df1cf. The firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, and the enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4. The request body contains two tags: key:test, value:1 and 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) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
201 |
Created |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot