Deleting Tags from a Port in Batches
Function
This API is used to delete tags from a specified port in batches. This is an idempotent API. If some tags to be deleted do not exist, the deletion is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.
This API is available only in the CN South-Shenzhen region.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
vpc:ports:deleteTags
Tagging
port *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
vpc:PortId
-
vpc:SubnetId
-
vpc:VpcId
- vpc:portTags:delete
-
-
g:TagKeys
-
URI
POST /v3/{project_id}/ports/{port_id}/tags/delete
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
port_id |
Yes |
String |
The unique ID of a port. The value is a string in UUID format. The port with a given ID must exist. |
|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
tags |
Yes |
Array of DeleteResourceTagRequestBody objects |
Tags |
Response Parameters
Status code: 204
Normal request response.
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Example Requests
Delete tags from a port in batches. The key of the tag is keyxxx, and the value is value1.
POST https://{Endpoint}/v3/{project_id}/ports/{port_id}/tags/delete
{
"tags" : [ {
"key" : "keyxxx",
"value" : "value1"
} ]
}
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Delete tags from a port in batches. The key of the tag is keyxxx, and the value is value1.
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 |
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.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; import java.util.List; import java.util.ArrayList; public class BatchDeletePortTagsSolution { 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); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); BatchDeletePortTagsRequest request = new BatchDeletePortTagsRequest(); request.withPortId("{port_id}"); BatchDeletePortTagsRequestBody body = new BatchDeletePortTagsRequestBody(); List<DeleteResourceTagRequestBody> listbodyTags = new ArrayList<>(); listbodyTags.add( new DeleteResourceTagRequestBody() .withKey("keyxxx") .withValue("value1") ); body.withTags(listbodyTags); request.withBody(body); try { BatchDeletePortTagsResponse response = client.batchDeletePortTags(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()); } } } |
Delete tags from a port in batches. The key of the tag is keyxxx, and the value is value1.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 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 = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchDeletePortTagsRequest() request.port_id = "{port_id}" listTagsbody = [ DeleteResourceTagRequestBody( key="keyxxx", value="value1" ) ] request.body = BatchDeletePortTagsRequestBody( tags=listTagsbody ) response = client.batch_delete_port_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) |
Delete tags from a port in batches. The key of the tag is keyxxx, and the value is value1.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/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 := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchDeletePortTagsRequest{} request.PortId = "{port_id}" valueTags:= "value1" var listTagsbody = []model.DeleteResourceTagRequestBody{ { Key: "keyxxx", Value: &valueTags, }, } request.Body = &model.BatchDeletePortTagsRequestBody{ Tags: listTagsbody, } response, err := client.BatchDeletePortTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
|---|---|
|
204 |
Normal request response. |
|
400 |
Invalid parameter. |
|
401 |
Authentication failure. |
|
403 |
Insufficient permissions. |
|
404 |
Not found. |
|
500 |
System exception. |
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