diff --git a/docs/cce/api-ref/ALL_META.TXT.json b/docs/cce/api-ref/ALL_META.TXT.json index 083d40b2b..33953361e 100644 --- a/docs/cce/api-ref/ALL_META.TXT.json +++ b/docs/cce/api-ref/ALL_META.TXT.json @@ -1118,11 +1118,119 @@ "title":"Changing the Values of Configuration Parameters of a Node Pool", "githuburl":"" }, + { + "uri":"tags_lifecycle_management.html", + "node_id":"tags_lifecycle_management.xml", + "product_code":"cce", + "code":"63", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api2", + "kw":"Tag Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cce" + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"BatchCreateClusterTags.html", + "node_id":"batchcreateclustertags.xml", + "product_code":"cce", + "code":"64", + "des":"This API is used to add resource tags for a specified cluster in batches.Each cluster supports a maximum of 20 resource tags.Each cluster supports a maximum of 20 resourc", + "doc_type":"api2", + "kw":"Adding Resource Tags to a Specified Cluster in Batches,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cce" + } + ], + "title":"Adding Resource Tags to a Specified Cluster in Batches", + "githuburl":"" + }, + { + "uri":"BatchDeleteClusterTags.html", + "node_id":"batchdeleteclustertags.xml", + "product_code":"cce", + "code":"65", + "des":"This API is used to delete resource tags of a specified cluster in batches.This API is idempotent. If the tag key of the to-be-deleted tag does not exist, the tag will be", + "doc_type":"api2", + "kw":"Deleting Resource Tags of a Specified Cluster in Batches,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cce" + } + ], + "title":"Deleting Resource Tags of a Specified Cluster in Batches", + "githuburl":"" + }, + { + "uri":"GetResourceTags.html", + "node_id":"getresourcetags.xml", + "product_code":"cce", + "code":"66", + "des":"This API is used to obtain resource tags.GET /cce/v1/{project_id}/{resource_type}/{resource_id}/tagsStatus code: 200NoneStatus code: 200The resource tags have been obtain", + "doc_type":"api2", + "kw":"Obtaining Resource Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cce" + } + ], + "title":"Obtaining Resource Tags", + "githuburl":"" + }, + { + "uri":"GetCustomizeTags.html", + "node_id":"getcustomizetags.xml", + "product_code":"cce", + "code":"67", + "des":"This API is used to obtain custom tags.GET /cce/v1/{project_id}/{resource_type}/tagsStatus code: 200NoneStatus code: 200The custom tags have been obtained.See Error Codes", + "doc_type":"api2", + "kw":"Obtaining Custom Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cce" + } + ], + "title":"Obtaining Custom Tags", + "githuburl":"" + }, + { + "uri":"GetLabels.html", + "node_id":"getlabels.xml", + "product_code":"cce", + "code":"68", + "des":"This API is used to obtain the labels of all nodes in a cluster.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/labelsStatus code: 200NoneStatus code: 200The node", + "doc_type":"api2", + "kw":"Obtaining Node Labels,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cce" + } + ], + "title":"Obtaining Node Labels", + "githuburl":"" + }, { "uri":"cce_02_0366.html", "node_id":"cce_02_0366.xml", "product_code":"cce", - "code":"63", + "code":"69", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Add-on Instance Parameters", @@ -1140,7 +1248,7 @@ "uri":"cce_02_0407.html", "node_id":"cce_02_0407.xml", "product_code":"cce", - "code":"64", + "code":"70", "des":"CoreDNS is a DNS server that uses chain plug-ins to provide domain name resolution services for Kubernetes clusters. It is the recommended DNS server solution by the Kube", "doc_type":"api2", "kw":"CoreDNS,Add-on Instance Parameters,API Reference", @@ -1158,7 +1266,7 @@ "uri":"cce_02_0408.html", "node_id":"cce_02_0408.xml", "product_code":"cce", - "code":"65", + "code":"71", "des":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", "doc_type":"api2", "kw":"CCE Container Storage (Everest),Add-on Instance Parameters,API Reference", @@ -1176,7 +1284,7 @@ "uri":"cce_02_0409.html", "node_id":"cce_02_0409.xml", "product_code":"cce", - "code":"66", + "code":"72", "des":"CCE Node Problem Detector (node-problem-detector, NPD) is an add-on that monitors abnormal events of cluster nodes and connects to a third-party monitoring platform. It i", "doc_type":"api2", "kw":"CCE Node Problem Detector,Add-on Instance Parameters,API Reference", @@ -1194,7 +1302,7 @@ "uri":"cce_02_0411.html", "node_id":"cce_02_0411.xml", "product_code":"cce", - "code":"67", + "code":"73", "des":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", "doc_type":"api2", "kw":"CCE Cluster Autoscaler,Add-on Instance Parameters,API Reference", @@ -1212,7 +1320,7 @@ "uri":"cce_02_0412.html", "node_id":"cce_02_0412.xml", "product_code":"cce", - "code":"68", + "code":"74", "des":"The NGINX Ingress Controller add-on can automatically modify configurations when there are changes to pods in Services. This add-on uses Nginx's excellent stability, perf", "doc_type":"api2", "kw":"NGINX Ingress Controller,Add-on Instance Parameters,API Reference", @@ -1230,7 +1338,7 @@ "uri":"cce_02_0413.html", "node_id":"cce_02_0413.xml", "product_code":"cce", - "code":"69", + "code":"75", "des":"From version 1.8 onwards, Kubernetes provides resource usage metrics, such as the container CPU and memory usage, through the Metrics API. These metrics can be directly a", "doc_type":"api2", "kw":"Kubernetes Metrics Server,Add-on Instance Parameters,API Reference", @@ -1248,7 +1356,7 @@ "uri":"cce_02_0414.html", "node_id":"cce_02_0414.xml", "product_code":"cce", - "code":"70", + "code":"76", "des":"CCE Advanced HPA (cce-hpa-controller) is an in-house add-on, which can be used to flexibly scale in or out Deployments based on metrics such as CPU usage and memory usage", "doc_type":"api2", "kw":"CCE Advanced HPA,Add-on Instance Parameters,API Reference", @@ -1266,7 +1374,7 @@ "uri":"cce_02_0415.html", "node_id":"cce_02_0415.xml", "product_code":"cce", - "code":"71", + "code":"77", "des":"CCE AI Suite (NVIDIA GPU) is a device management add-on that supports GPUs in containers. To use GPU nodes in a cluster, this add-on must be installed.", "doc_type":"api2", "kw":"CCE AI Suite (NVIDIA GPU),Add-on Instance Parameters,API Reference", @@ -1284,7 +1392,7 @@ "uri":"cce_02_0417.html", "node_id":"cce_02_0417.xml", "product_code":"cce", - "code":"72", + "code":"78", "des":"Volcano is a batch scheduling platform based on Kubernetes. It provides a series of features required by machine learning, deep learning, bioinformatics, genomics, and ot", "doc_type":"api2", "kw":"Volcano Scheduler,Add-on Instance Parameters,API Reference", @@ -1302,7 +1410,7 @@ "uri":"cce_02_0421.html", "node_id":"cce_02_0421.xml", "product_code":"cce", - "code":"73", + "code":"79", "des":"The Cluster Native Cluster Monitoring add-on (kube-prometheus-stack) uses Prometheus-operator and Prometheus to provide easy-to-use, end-to-end Kubernetes cluster monitor", "doc_type":"api2", "kw":"Cloud Native Cluster Monitoring,Add-on Instance Parameters,API Reference", @@ -1320,7 +1428,7 @@ "uri":"cce_02_0422.html", "node_id":"cce_02_0422.xml", "product_code":"cce", - "code":"74", + "code":"80", "des":"The Cloud Native Logging add-on (log-agent) is developed based on Fluent Bit and OpenTelemetry for collecting logs and Kubernetes events. This add-on supports CRD-based l", "doc_type":"api2", "kw":"Cloud Native Log Collection,Add-on Instance Parameters,API Reference", @@ -1338,7 +1446,7 @@ "uri":"cce_02_0340.html", "node_id":"cce_02_0340.xml", "product_code":"cce", - "code":"75", + "code":"81", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Kubernetes APIs", @@ -1356,7 +1464,7 @@ "uri":"kubernetesapi.html", "node_id":"kubernetesapi.xml", "product_code":"cce", - "code":"76", + "code":"82", "des":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", "doc_type":"api2", "kw":"Overview,Kubernetes APIs,API Reference", @@ -1374,7 +1482,7 @@ "uri":"cce_02_0327.html", "node_id":"cce_02_0327.xml", "product_code":"cce", - "code":"77", + "code":"83", "des":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", "doc_type":"api2", "kw":"Permissions Policies and Supported Actions,API Reference", @@ -1392,7 +1500,7 @@ "uri":"cce_02_0083.html", "node_id":"cce_02_0083.xml", "product_code":"cce", - "code":"78", + "code":"84", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Appendix", @@ -1410,7 +1518,7 @@ "uri":"cce_02_0085.html", "node_id":"cce_02_0085.xml", "product_code":"cce", - "code":"79", + "code":"85", "des":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", "doc_type":"api2", "kw":"Patch Request Method Operation Description,Appendix,API Reference", @@ -1428,7 +1536,7 @@ "uri":"cce_02_0086.html", "node_id":"cce_02_0086.xml", "product_code":"cce", - "code":"80", + "code":"86", "des":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", "doc_type":"api2", "kw":"Patch Request Method Operation Example,Appendix,API Reference", @@ -1446,7 +1554,7 @@ "uri":"cce_02_0084.html", "node_id":"cce_02_0084.xml", "product_code":"cce", - "code":"81", + "code":"87", "des":"Table 1 describes the status codes.", "doc_type":"api2", "kw":"Status Code,Appendix,API Reference", @@ -1464,7 +1572,7 @@ "uri":"cce_02_0250.html", "node_id":"cce_02_0250.xml", "product_code":"cce", - "code":"82", + "code":"88", "des":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", "doc_type":"api2", "kw":"Error Codes,Appendix,API Reference", @@ -1482,7 +1590,7 @@ "uri":"cce_02_0341.html", "node_id":"cce_02_0341.xml", "product_code":"cce", - "code":"83", + "code":"89", "des":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", "doc_type":"api2", "kw":"Obtaining a Project ID,Appendix,API Reference", @@ -1500,7 +1608,7 @@ "uri":"cce_02_0342.html", "node_id":"cce_02_0342.xml", "product_code":"cce", - "code":"84", + "code":"90", "des":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", "doc_type":"api2", "kw":"Obtaining the Account ID,Appendix,API Reference", @@ -1518,7 +1626,7 @@ "uri":"cce_02_0271.html", "node_id":"cce_02_0271.xml", "product_code":"cce", - "code":"85", + "code":"91", "des":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", "doc_type":"api2", "kw":"How to Obtain Parameters in the API URI,Appendix,API Reference", @@ -1536,7 +1644,7 @@ "uri":"cce_02_0272.html", "node_id":"cce_02_0272.xml", "product_code":"cce", - "code":"86", + "code":"92", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"API Permissions,Appendix,API Reference", @@ -1554,7 +1662,7 @@ "uri":"cce_02_0100.html", "node_id":"cce_02_0100.xml", "product_code":"cce", - "code":"87", + "code":"93", "des":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", "doc_type":"api2", "kw":"Creating a VPC and Subnet,Appendix,API Reference", @@ -1572,7 +1680,7 @@ "uri":"cce_02_0101.html", "node_id":"cce_02_0101.xml", "product_code":"cce", - "code":"88", + "code":"94", "des":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", "doc_type":"api2", "kw":"Creating a Key Pair,Appendix,API Reference", @@ -1590,7 +1698,7 @@ "uri":"cce_02_0368.html", "node_id":"cce_02_0368.xml", "product_code":"cce", - "code":"89", + "code":"95", "des":"Different regions support different node flavors, and node flavors may be changed. You are advised to log in to the CCE console and check whether the required node flavor", "doc_type":"api2", "kw":"Node Flavor Description,Appendix,API Reference", @@ -1608,7 +1716,7 @@ "uri":"node_storage_example.html", "node_id":"node_storage_example.xml", "product_code":"cce", - "code":"90", + "code":"96", "des":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", "doc_type":"api2", "kw":"Attaching Disks to a Node,Appendix,API Reference", @@ -1626,7 +1734,7 @@ "uri":"cce_02_0273.html", "node_id":"cce_02_0273.xml", "product_code":"cce", - "code":"91", + "code":"97", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api2", "kw":"Change History,API Reference", diff --git a/docs/cce/api-ref/BatchCreateClusterTags.html b/docs/cce/api-ref/BatchCreateClusterTags.html new file mode 100644 index 000000000..cda8178b0 --- /dev/null +++ b/docs/cce/api-ref/BatchCreateClusterTags.html @@ -0,0 +1,228 @@ + + +

Adding Resource Tags to a Specified Cluster in Batches

+

Function

This API is used to add resource tags for a specified cluster in batches.

+

  • Each cluster supports a maximum of 20 resource tags.

    +

  • This API is idempotent. If the to-be-added tag has the same tag key and tag value as an existing tag, the tag will be added. If the to-be-added tag has the same key but different value as an existing tag, the tag will overwrite the existing one.

    +
+
+
+

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/tags/create

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

tags

+

Yes

+

Array of ResourceTag objects

+

List of cluster resource tags to be created. Each cluster supports a maximum of 20 resource tags.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Details:

+

Key

+

Constraints:

+

None

+

Options:

+

  • The value cannot be empty and cannot start or end with spaces. A maximum of 128 characters is supported.

    +

  • The value can contain letters, digits, and spaces in UTF-8 format.

    +

  • The value can contain the following special characters: _.:=+-@

    +

  • The value cannot start with _sys_.

    +
+

Default value:

+

N/A

+

value

+

No

+

String

+

Details:

+

Value

+

Constraints:

+

None

+

Options:

+

  • The value can be null but not the default. Max characters: 255

    +

  • Letters, digits, and spaces in UTF-8 format are supported.

    +

  • The value can contain the following special characters: _.:/=+-@

    +
+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 204

+

No Content

+

None

+
+

Example Requests

Adding Resource Tags to a Specified Cluster in Batches

+
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/tags/create
+
+{
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value3"
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

No Content

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/cce/api-ref/BatchDeleteClusterTags.html b/docs/cce/api-ref/BatchDeleteClusterTags.html new file mode 100644 index 000000000..84eb09f4a --- /dev/null +++ b/docs/cce/api-ref/BatchDeleteClusterTags.html @@ -0,0 +1,200 @@ + + +

Deleting Resource Tags of a Specified Cluster in Batches

+

Function

This API is used to delete resource tags of a specified cluster in batches.

+

  • This API is idempotent. If the tag key of the to-be-deleted tag does not exist, the tag will be deleted.

    +
+
+
+

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/tags/delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

tags

+

Yes

+

Array of ResourceDeleteTag objects

+

List of cluster resource tags to be deleted

+
+
+ +
+ + + + + + + + + + + +
Table 4 ResourceDeleteTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

The key value of the resource tag

+

  • It cannot be null. It can contain a maximum of 128 characters.

    +

  • It can contain letters, digits, and spaces in UTF-8 format.

    +

  • It can contain the following special characters: _.:/=+-@.

    +

  • It cannot start with _sys_.

    +
+
+
+
+

Response Parameters

Status code: 204

+

No Content

+

None

+
+

Example Requests

Deleting Resource Tags of a Specified Cluster in Batches

+
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/tags/delete
+
+{
+  "tags" : [ {
+    "key" : "key1"
+  }, {
+    "key" : "key2"
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

No Content

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/cce/api-ref/CLASS.TXT.json b/docs/cce/api-ref/CLASS.TXT.json index 63f902fb7..b3d96d4bb 100644 --- a/docs/cce/api-ref/CLASS.TXT.json +++ b/docs/cce/api-ref/CLASS.TXT.json @@ -557,6 +557,60 @@ "p_code":"58", "code":"62" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"cce", + "title":"Tag Management", + "uri":"tags_lifecycle_management.html", + "doc_type":"api2", + "p_code":"2", + "code":"63" + }, + { + "desc":"This API is used to add resource tags for a specified cluster in batches.Each cluster supports a maximum of 20 resource tags.Each cluster supports a maximum of 20 resourc", + "product_code":"cce", + "title":"Adding Resource Tags to a Specified Cluster in Batches", + "uri":"BatchCreateClusterTags.html", + "doc_type":"api2", + "p_code":"63", + "code":"64" + }, + { + "desc":"This API is used to delete resource tags of a specified cluster in batches.This API is idempotent. If the tag key of the to-be-deleted tag does not exist, the tag will be", + "product_code":"cce", + "title":"Deleting Resource Tags of a Specified Cluster in Batches", + "uri":"BatchDeleteClusterTags.html", + "doc_type":"api2", + "p_code":"63", + "code":"65" + }, + { + "desc":"This API is used to obtain resource tags.GET /cce/v1/{project_id}/{resource_type}/{resource_id}/tagsStatus code: 200NoneStatus code: 200The resource tags have been obtain", + "product_code":"cce", + "title":"Obtaining Resource Tags", + "uri":"GetResourceTags.html", + "doc_type":"api2", + "p_code":"63", + "code":"66" + }, + { + "desc":"This API is used to obtain custom tags.GET /cce/v1/{project_id}/{resource_type}/tagsStatus code: 200NoneStatus code: 200The custom tags have been obtained.See Error Codes", + "product_code":"cce", + "title":"Obtaining Custom Tags", + "uri":"GetCustomizeTags.html", + "doc_type":"api2", + "p_code":"63", + "code":"67" + }, + { + "desc":"This API is used to obtain the labels of all nodes in a cluster.GET /api/v3/projects/{project_id}/clusters/{cluster_id}/labelsStatus code: 200NoneStatus code: 200The node", + "product_code":"cce", + "title":"Obtaining Node Labels", + "uri":"GetLabels.html", + "doc_type":"api2", + "p_code":"63", + "code":"68" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"cce", @@ -564,7 +618,7 @@ "uri":"cce_02_0366.html", "doc_type":"api2", "p_code":"2", - "code":"63" + "code":"69" }, { "desc":"CoreDNS is a DNS server that uses chain plug-ins to provide domain name resolution services for Kubernetes clusters. It is the recommended DNS server solution by the Kube", @@ -572,8 +626,8 @@ "title":"CoreDNS", "uri":"cce_02_0407.html", "doc_type":"api2", - "p_code":"63", - "code":"64" + "p_code":"69", + "code":"70" }, { "desc":"The CCE Container Storage (Everest) add-on uses the Container Storage Interface (CSI) to link Kubernetes clusters with cloud storage services.", @@ -581,8 +635,8 @@ "title":"CCE Container Storage (Everest)", "uri":"cce_02_0408.html", "doc_type":"api2", - "p_code":"63", - "code":"65" + "p_code":"69", + "code":"71" }, { "desc":"CCE Node Problem Detector (node-problem-detector, NPD) is an add-on that monitors abnormal events of cluster nodes and connects to a third-party monitoring platform. It i", @@ -590,8 +644,8 @@ "title":"CCE Node Problem Detector", "uri":"cce_02_0409.html", "doc_type":"api2", - "p_code":"63", - "code":"66" + "p_code":"69", + "code":"72" }, { "desc":"The CCE Cluster Autoscaler (autoscaler) add-on enables node pools to be scaled in or out.", @@ -599,8 +653,8 @@ "title":"CCE Cluster Autoscaler", "uri":"cce_02_0411.html", "doc_type":"api2", - "p_code":"63", - "code":"67" + "p_code":"69", + "code":"73" }, { "desc":"The NGINX Ingress Controller add-on can automatically modify configurations when there are changes to pods in Services. This add-on uses Nginx's excellent stability, perf", @@ -608,8 +662,8 @@ "title":"NGINX Ingress Controller", "uri":"cce_02_0412.html", "doc_type":"api2", - "p_code":"63", - "code":"68" + "p_code":"69", + "code":"74" }, { "desc":"From version 1.8 onwards, Kubernetes provides resource usage metrics, such as the container CPU and memory usage, through the Metrics API. These metrics can be directly a", @@ -617,8 +671,8 @@ "title":"Kubernetes Metrics Server", "uri":"cce_02_0413.html", "doc_type":"api2", - "p_code":"63", - "code":"69" + "p_code":"69", + "code":"75" }, { "desc":"CCE Advanced HPA (cce-hpa-controller) is an in-house add-on, which can be used to flexibly scale in or out Deployments based on metrics such as CPU usage and memory usage", @@ -626,8 +680,8 @@ "title":"CCE Advanced HPA", "uri":"cce_02_0414.html", "doc_type":"api2", - "p_code":"63", - "code":"70" + "p_code":"69", + "code":"76" }, { "desc":"CCE AI Suite (NVIDIA GPU) is a device management add-on that supports GPUs in containers. To use GPU nodes in a cluster, this add-on must be installed.", @@ -635,8 +689,8 @@ "title":"CCE AI Suite (NVIDIA GPU)", "uri":"cce_02_0415.html", "doc_type":"api2", - "p_code":"63", - "code":"71" + "p_code":"69", + "code":"77" }, { "desc":"Volcano is a batch scheduling platform based on Kubernetes. It provides a series of features required by machine learning, deep learning, bioinformatics, genomics, and ot", @@ -644,8 +698,8 @@ "title":"Volcano Scheduler", "uri":"cce_02_0417.html", "doc_type":"api2", - "p_code":"63", - "code":"72" + "p_code":"69", + "code":"78" }, { "desc":"The Cluster Native Cluster Monitoring add-on (kube-prometheus-stack) uses Prometheus-operator and Prometheus to provide easy-to-use, end-to-end Kubernetes cluster monitor", @@ -653,8 +707,8 @@ "title":"Cloud Native Cluster Monitoring", "uri":"cce_02_0421.html", "doc_type":"api2", - "p_code":"63", - "code":"73" + "p_code":"69", + "code":"79" }, { "desc":"The Cloud Native Logging add-on (log-agent) is developed based on Fluent Bit and OpenTelemetry for collecting logs and Kubernetes events. This add-on supports CRD-based l", @@ -662,8 +716,8 @@ "title":"Cloud Native Log Collection", "uri":"cce_02_0422.html", "doc_type":"api2", - "p_code":"63", - "code":"74" + "p_code":"69", + "code":"80" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -672,7 +726,7 @@ "uri":"cce_02_0340.html", "doc_type":"api2", "p_code":"", - "code":"75" + "code":"81" }, { "desc":"Kubernetes APIs are resource-based (RESTful) programming interfaces provided through HTTP. It supports query, creation, update, and deletion of various cluster resources ", @@ -680,8 +734,8 @@ "title":"Overview", "uri":"kubernetesapi.html", "doc_type":"api2", - "p_code":"75", - "code":"76" + "p_code":"81", + "code":"82" }, { "desc":"This chapter describes fine-grained permissions management for your CCE. If your cloud account does not need individual IAM users, then you may skip over this chapter.A p", @@ -690,7 +744,7 @@ "uri":"cce_02_0327.html", "doc_type":"api2", "p_code":"", - "code":"77" + "code":"83" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -699,7 +753,7 @@ "uri":"cce_02_0083.html", "doc_type":"api2", "p_code":"", - "code":"78" + "code":"84" }, { "desc":"Kubernetes APIs use the HTTP header \"Content-Type\" to distinguish between patch request method operations.Currently, three types of patch request method operations are su", @@ -707,8 +761,8 @@ "title":"Patch Request Method Operation Description", "uri":"cce_02_0085.html", "doc_type":"api2", - "p_code":"78", - "code":"79" + "p_code":"84", + "code":"85" }, { "desc":"This section provides examples of Merge Patch and Strategic Merge Patch method operations.By way of example, Merge Patch and Strategic Merge Patch method operations are p", @@ -716,8 +770,8 @@ "title":"Patch Request Method Operation Example", "uri":"cce_02_0086.html", "doc_type":"api2", - "p_code":"78", - "code":"80" + "p_code":"84", + "code":"86" }, { "desc":"Table 1 describes the status codes.", @@ -725,8 +779,8 @@ "title":"Status Code", "uri":"cce_02_0084.html", "doc_type":"api2", - "p_code":"78", - "code":"81" + "p_code":"84", + "code":"87" }, { "desc":"If an error occurs in API calling, no result is returned. Identify the cause based on the error code of each API. If an error occurs in API calling, HTTP status code 4xx ", @@ -734,8 +788,8 @@ "title":"Error Codes", "uri":"cce_02_0250.html", "doc_type":"api2", - "p_code":"78", - "code":"82" + "p_code":"84", + "code":"88" }, { "desc":"You can obtain the project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{End", @@ -743,8 +797,8 @@ "title":"Obtaining a Project ID", "uri":"cce_02_0341.html", "doc_type":"api2", - "p_code":"78", - "code":"83" + "p_code":"84", + "code":"89" }, { "desc":"An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:On the My Credentials page, view account IDs in t", @@ -752,8 +806,8 @@ "title":"Obtaining the Account ID", "uri":"cce_02_0342.html", "doc_type":"api2", - "p_code":"78", - "code":"84" + "p_code":"84", + "code":"90" }, { "desc":"If you are using Google Chrome, press F12. On the pane displayed on the right, click the Network tab. Enter jobs in the Filter text box to filter the job list. Select a j", @@ -761,8 +815,8 @@ "title":"How to Obtain Parameters in the API URI", "uri":"cce_02_0271.html", "doc_type":"api2", - "p_code":"78", - "code":"85" + "p_code":"84", + "code":"91" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -770,8 +824,8 @@ "title":"API Permissions", "uri":"cce_02_0272.html", "doc_type":"api2", - "p_code":"78", - "code":"86" + "p_code":"84", + "code":"92" }, { "desc":"To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.If you have already created a VPC, you do not need to create it again", @@ -779,8 +833,8 @@ "title":"Creating a VPC and Subnet", "uri":"cce_02_0100.html", "doc_type":"api2", - "p_code":"78", - "code":"87" + "p_code":"84", + "code":"93" }, { "desc":"Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.If you have already created a key pair, ", @@ -788,8 +842,8 @@ "title":"Creating a Key Pair", "uri":"cce_02_0101.html", "doc_type":"api2", - "p_code":"78", - "code":"88" + "p_code":"84", + "code":"94" }, { "desc":"Different regions support different node flavors, and node flavors may be changed. You are advised to log in to the CCE console and check whether the required node flavor", @@ -797,8 +851,8 @@ "title":"Node Flavor Description", "uri":"cce_02_0368.html", "doc_type":"api2", - "p_code":"78", - "code":"89" + "p_code":"84", + "code":"95" }, { "desc":"In disk planning and striped logical disk creation, it is difficult for users to flexibly attach and partition disks when creating a node.During node creation, the storag", @@ -806,8 +860,8 @@ "title":"Attaching Disks to a Node", "uri":"node_storage_example.html", "doc_type":"api2", - "p_code":"78", - "code":"90" + "p_code":"84", + "code":"96" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -816,6 +870,6 @@ "uri":"cce_02_0273.html", "doc_type":"api2", "p_code":"", - "code":"91" + "code":"97" } ] \ No newline at end of file diff --git a/docs/cce/api-ref/GetCustomizeTags.html b/docs/cce/api-ref/GetCustomizeTags.html new file mode 100644 index 000000000..0e4054e69 --- /dev/null +++ b/docs/cce/api-ref/GetCustomizeTags.html @@ -0,0 +1,209 @@ + + +

Obtaining Custom Tags

+

Function

This API is used to obtain custom tags.

+
+

URI

GET /cce/v1/{project_id}/{resource_type}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

resource_type

+

Yes

+

String

+

Definition

+

Resource type

+

Constraints

+

N/A

+

Range

+

  • cce-cluster: cluster

    +
+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of CustomizeResourceTag objects

+

Definition

+

Custom tags

+

Constraints

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 CustomizeResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Key

+

Constraints

+

N/A

+

Range

+

  • The value cannot be empty and cannot start or end with spaces. A maximum of 128 characters is supported.

    +

  • The value can contain letters, digits, and spaces in UTF-8 format.

    +

  • The value can contain the following special characters: _.:=+-@

    +

  • The value cannot start with _sys_.

    +
+

Default Value

+

N/A

+

values

+

Array of strings

+

Definition

+

Value list

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

The custom tags have been obtained.

+
{
+  "tags" : [ {
+    "key" : "key1",
+    "values" : [ "value1", "value2" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The custom tags have been obtained.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/cce/api-ref/GetLabels.html b/docs/cce/api-ref/GetLabels.html new file mode 100644 index 000000000..9ecaa0631 --- /dev/null +++ b/docs/cce/api-ref/GetLabels.html @@ -0,0 +1,201 @@ + + +

Obtaining Node Labels

+

Function

This API is used to obtain the labels of all nodes in a cluster.

+
+

URI

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/labels

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Details:

+

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Cluster IDs

+

Default value:

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

kind

+

String

+

Definition

+

API type

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

Labels

+

apiVersion

+

String

+

Definition

+

API version

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

v3

+

spec

+

Map<String,Map<String,Array<String>>>

+

Definition

+

Node label, which is classified by node pool.

+

  • key indicates the node pool ID. The value for the default node pool is DefaultPool.

    +

  • value indicates the label in the format of key-value pairs. key indicates the label key, and value indicates the value list corresponding to the label key.

    +
+

Constraints

+

N/A

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

The node labels have been obtained.

+
{
+  "kind" : "Labels",
+  "apiVersion" : "v3",
+  "spec" : {
+    "nodePoolId" : {
+      "key1" : [ "value1", "value2" ]
+    },
+    "DefaultPool" : {
+      "key2" : [ "value1", "value2" ]
+    }
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The node labels have been obtained.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/cce/api-ref/GetResourceTags.html b/docs/cce/api-ref/GetResourceTags.html new file mode 100644 index 000000000..44ebb82cd --- /dev/null +++ b/docs/cce/api-ref/GetResourceTags.html @@ -0,0 +1,242 @@ + + +

Obtaining Resource Tags

+

Function

This API is used to obtain resource tags.

+
+

URI

GET /cce/v1/{project_id}/{resource_type}/{resource_id}/tags

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Details:

+

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints:

+

None

+

Options:

+

Project IDs of the account

+

Default value:

+

N/A

+

resource_type

+

Yes

+

String

+

Definition

+

Resource type

+

Constraints

+

N/A

+

Range

+

  • cce-cluster: cluster

    +
+

Default Value

+

N/A

+

resource_id

+

Yes

+

String

+

Definition

+

Resource ID, for example, cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

Details:

+

The request body type or format

+

Constraints:

+

The GET method is not verified.

+

Options:

+

  • application/json

    +

  • application/json;charset=utf-8

    +

  • application/x-pem-file

    +

  • multipart/form-data (used when the FormData parameter is present)

    +
+

Default value:

+

N/A

+

X-Auth-Token

+

Yes

+

String

+

Details:

+

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

+

Constraints:

+

None

+

Options:

+

N/A

+

Default value:

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of ResourceTag objects

+

Definition

+

Custom tags

+

Constraints

+

N/A

+

sys_tags

+

Array of ResourceTag objects

+

Definition

+

System tags

+

Constraints

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Details:

+

Key

+

Constraints:

+

None

+

Options:

+

  • The value cannot be empty and cannot start or end with spaces. A maximum of 128 characters is supported.

    +

  • The value can contain letters, digits, and spaces in UTF-8 format.

    +

  • The value can contain the following special characters: _.:=+-@

    +

  • The value cannot start with _sys_.

    +
+

Default value:

+

N/A

+

value

+

String

+

Details:

+

Value

+

Constraints:

+

None

+

Options:

+

  • The value can be null but not the default. Max characters: 255

    +

  • Letters, digits, and spaces in UTF-8 format are supported.

    +

  • The value can contain the following special characters: _.:/=+-@

    +
+

Default value:

+

N/A

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

The resource tags have been obtained.

+
{
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  } ],
+  "sys_tags" : [ {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The resource tags have been obtained.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/cce/api-ref/cce_02_0103.html b/docs/cce/api-ref/cce_02_0103.html index 03973e52a..cb3d86074 100644 --- a/docs/cce/api-ref/cce_02_0103.html +++ b/docs/cce/api-ref/cce_02_0103.html @@ -16,6 +16,8 @@
  • Configuration Management
    • +
  • Tag Management
    +
  • Add-on Instance Parameters
    • diff --git a/docs/cce/api-ref/cce_02_0273.html b/docs/cce/api-ref/cce_02_0273.html index e920a6c46..d17f3b073 100644 --- a/docs/cce/api-ref/cce_02_0273.html +++ b/docs/cce/api-ref/cce_02_0273.html @@ -8,7 +8,13 @@ -

    2025-06-30

    +

    2025-09-12

    + +

    Add:

    +

    Added Tag Management.

    + + +

    2025-06-30

    Add:

    diff --git a/docs/cce/api-ref/tags_lifecycle_management.html b/docs/cce/api-ref/tags_lifecycle_management.html new file mode 100644 index 000000000..330b7c366 --- /dev/null +++ b/docs/cce/api-ref/tags_lifecycle_management.html @@ -0,0 +1,24 @@ + + +

    Tag Management

    +

    +
    +
    + + +
    +
    Parent topic: APIs
    +
    +
    +