Help Center/ MapReduce Service/ API Reference/ API V2/ Tag Management APIs/ Enabling or Disabling the Default Tag of a Cluster
Updated on 2024-09-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling or Disabling the Default Tag of a Cluster

Function

This API is used to enable or disable default cluster tags. If this function is enabled, nodes in a cluster are added with the default cluster tag.

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and support sample SDK code debugging.

URI

POST /v2/{project_id}/clusters/{cluster_id}/tags/switch

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Value range

The value must consist of 1 to 64 characters. Only letters and digits are allowed.

Default value

N/A

cluster_id

Yes

String

Explanation

Cluster ID If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Explanation

Operation, which can be create or delete.

Constraints

N/A

Value range

  • create: Create a cluster tag.
  • delete: Delete a cluster tag.

Default value

N/A

Response Parameters

None

Example Request

  • Disable default tags for a cluster. 
    /v2/174ee662a7e24cc99bfc858c455xxxxxx/clusters/848cd341-cbc8-4ac3-82f2-35cd58c077d9/tags/switch

{
  "action" : "delete"
}
  • Enable default tags for a cluster. 
    /v2/174ee662a7e24cc99bfc858c455xxxxxx/clusters/848cd341-cbc8-4ac3-82f2-35cd58c077d9/tags/switch

{
  "action" : "create"
}

Example Response

Status code: 400

Response for a failed request

{
  "error_code" : "MRS.00000000",
  "error_msg" : "Insufficient tag quotas."
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Tag Management APIs