Deleting Tags from a Cluster in Batches - BatchDeleteClusterTags
Function
This API is used to batch delete tags from a specified MRS cluster. A cluster can have up to 20 tags. This API is idempotent: deleting a non-existent tag is handled as a success by default, and no validation is performed on the tag character set range.
The key length is 128 Unicode characters, and the value length is 255 Unicode characters. When deleting, the tags structure must not be missing, and the key must not be empty or an empty string.
Constraints
None
Debugging
You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.
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, no identity policy-based permissions are required for calling this API.
URI
POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| cluster_id | Yes | String | Definition Cluster ID. For details about how to obtain it, see Obtaining a Cluster ID. Constraints N/A Range The value can contain 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Default Value N/A |
| project_id | Yes | String | Definition Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| action | Yes | String | Definition Operation to be performed. The value can be delete only. Constraints N/A Range
Default Value N/A |
| tags | Yes | Array of Tag objects | Definition Tag list. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 204
Operation succeeded.
None
Example Request
Batch delete tags from a cluster.
POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action
{
"action" : "delete",
"tags" : [ {
"key" : "DEV1",
"value" : "DEV1"
}, {
"key" : "DEV2",
"value" : "DEV2"
} ]
} Example Response
None
SDK Sample Code
The SDK sample code is as follows.
Batch delete tags from a cluster.
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 65 | 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.mrs.v1.region.MrsRegion; import com.huaweicloud.sdk.mrs.v1.*; import com.huaweicloud.sdk.mrs.v1.model.*; import java.util.List; import java.util.ArrayList; public class BatchDeleteClusterTagsSolution { 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); MrsClient client = MrsClient.newBuilder() .withCredential(auth) .withRegion(MrsRegion.valueOf("<YOUR REGION>")) .build(); BatchDeleteClusterTagsRequest request = new BatchDeleteClusterTagsRequest(); request.withClusterId("{cluster_id}"); BatchDeleteClusterTagsReq body = new BatchDeleteClusterTagsReq(); List<Tag> listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("DEV1") .withValue("DEV1") ); listbodyTags.add( new Tag() .withKey("DEV2") .withValue("DEV2") ); body.withTags(listbodyTags); body.withAction(BatchDeleteClusterTagsReq.ActionEnum.fromValue("delete")); request.withBody(body); try { BatchDeleteClusterTagsResponse response = client.batchDeleteClusterTags(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()); } } } |
Batch delete tags from a cluster.
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmrs.v1.region.mrs_region import MrsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmrs.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 = MrsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MrsRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchDeleteClusterTagsRequest() request.cluster_id = "{cluster_id}" listTagsbody = [ Tag( key="DEV1", value="DEV1" ), Tag( key="DEV2", value="DEV2" ) ] request.body = BatchDeleteClusterTagsReq( tags=listTagsbody, action="delete" ) response = client.batch_delete_cluster_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) |
Batch delete tags from a cluster.
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" mrs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/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 := mrs.NewMrsClient( mrs.MrsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchDeleteClusterTagsRequest{} request.ClusterId = "{cluster_id}" var listTagsbody = []model.Tag{ { Key: "DEV1", Value: "DEV1", }, { Key: "DEV2", Value: "DEV2", }, } request.Body = &model.BatchDeleteClusterTagsReq{ Tags: listTagsbody, Action: model.GetBatchDeleteClusterTagsReqActionEnum().DELETE, } response, err := client.BatchDeleteClusterTags(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 | Operation succeeded. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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