Obtaining Cluster Node Tags

Function

This API is used to obtain cluster node tags.

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 permission required for calling this API.

URI

POST /v5/{project_id}/container/kubernetes/clusters/nodes/batch-label

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
type	Yes	String	Node tag type. label: Search by label tolerate: Search by taint

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
cluster_ids	Yes	Array of strings	Definition Cluster ID list Range Value range: 0 to 65,535

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
data_list	Array of NodeLabelInfoResponse objects	Definition Data list. Range 1 to 100
total_num	Integer	Definition Total number of NodeLabels in a cluster. Range Minimum value: 0; maximum value: 2147483647

**Table 6** NodeLabelInfoResponse
Parameter	Type	Description
label	String	Definition Node label name. Range Length: 1 to 512 characters
children	Array of strings	Definition Node name Range Length: 0 to 256 characters

Example Requests

Obtain cluster node tags.

POST https://{endpoint}/v5/{project_id}/container/kubernetes/clusters/nodes/batch-label?limit=10&offset=0&type=label&enterprise_project_id=all_granted_eps

{
  "cluster_ids" : [ "test1", "test2" ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 10,
  "data_list" : [ {
    "label" : "label-name",
    "children" : [ "label1" ]
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration

Previous topic: Acquiring Cluster DaemonSet Lists

Next topic: Deleting a Cluster Daemonset

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot