Component management-related APIs

CCE CCE

  • Function Release Records
  • Common Tools
    • Command Line Scenario Examples
  • API Reference
    • Overview
    • Common Headers and Error Responses
    • General Description
  • Product Announcement
    • Announcement on the Discontinuation of CCE Standalone Clusters
    • CCE New Cluster Management Release Announcement
    • Upgrade Announcement for CCE Cluster Audit Component kube-external-auditor
    • CCE Console Upgrade Announcement
    • Announcement on Management Fees for CCE Managed Clusters
    • Container Runtime Version Release Notes
    • Announcement on the Decommissioning of CCE Image Repository
    • Kubernetes Version Release Notes
      • CCE Release of Kubernetes v1_26 History
      • CCE Kubernetes Version Update Notes
      • CCE Release of Kubernetes v1_24 History
      • CCE Release of Kubernetes v1_30 History
      • CCE Release of Kubernetes v1_22 History
      • CCE Release of Kubernetes v1_18 History
      • CCE Release of Kubernetes v1_20 History
      • CCE Release of Kubernetes v1_28 History
      • Release Notes for CCE Kubernetes 1_31 Version
      • Kubernetes Version Overview and Mechanism
    • Security Vulnerability Fix Announcement
      • Vulnerability CVE-2019-5736 Fix Announcement
      • Vulnerability CVE-2021-30465 Fix Announcement
      • CVE-2025-1097, CVE-2025-1098, and Other Vulnerabilities Fix Announcement
      • CVE-2020-14386 Vulnerability Fix Announcement
      • Impact Statement on runc Security Issue (CVE-2024-21626)
  • Service Level Agreement (SLA)
    • CCE Service Level Agreement SLA (V1_0)
  • Typical Practices
    • Pod Anomaly Troubleshooting
    • Adding CGroup V2 Node
    • Common Linux System Configuration Parameters Description
    • Encrypting etcd Data Using KMS
    • Configuring Container Network Parameters Using CNI
    • CCE - Public Network Access Practice
    • Practice of using private images in CCE clusters
    • Unified Access for Virtual Machines and Container Services via CCE Ingress
    • User Guide for Custom CNI Plugins
    • CCE Cluster Network Description and Planning
    • Cross-Cloud Application Migration to Baidu CCE Using Velero
    • CCE Resource Recommender User Documentation
    • Continuous Deployment with Jenkins in CCE Cluster
    • CCE Best Practice-Guestbook Setup
    • CCE Best Practice-Container Network Mode Selection
    • CCE Usage Checklist
    • VPC-ENI Mode Cluster Public Network Access Practice
    • CCE Container Runtime Selection
    • Cloud-native AI
      • Elastic and Fault-Tolerant Training Using CCE AITraining Operator
      • Deploy the TensorFlow Serving inference service
      • Best Practice for GPU Virtualization with Optimal Isolation
  • FAQs
    • How do business applications use load balancer
    • Using kubectl on Windows
    • Cluster management FAQs
    • Common Questions Overview
    • Auto scaling FAQs
    • Create a simple service via kubectl
  • Operation guide
    • Prerequisites for use
    • Identity and access management
    • Permission Management
      • Configure IAM Tag Permission Policy
      • Permission Overview
      • Configure IAM Custom Permission Policy
      • Configure Predefined RBAC Permission Policy
      • Configure IAM Predefined Permission Policy
      • Configure Cluster OIDC Authentication
    • Configuration Management
      • Configmap Management
      • Secret Management
    • Traffic access
      • BLB ingress annotation description
      • Use K8S_Service via CCE
      • Use K8S_Ingress via CCE
      • Implement Canary Release with CCE Based on Nginx-Ingress
      • Create CCE_Ingress via YAML
      • LoadBalancer Service Annotation Description
      • Service Reuses Existing Load Balancer BLB
      • Use Direct Pod Mode LoadBalancer Service
      • NGINX Ingress Configuration Reference
      • Create LoadBalancer_Service via YAML
      • Use NGINX Ingress
    • Virtual Node
      • Configuring BCIPod
      • Configuring bci-profile
      • Managing virtual nodes
    • Node management
      • Add a node
      • Managing Taints
      • Setting Node Blocking
      • Setting GPU Memory Sharing
      • Remove a node
      • Customizing Kubelet Parameters
      • Kubelet Container Monitor Read-Only Port Risk Warning
      • Managing Node Tag
      • Drain node
    • Component Management
      • CCE CSI CDS Plugin Description
      • CCE Fluid Description
      • CCE CSI PFS L2 Plugin
      • CCE Calico Felix Description
      • CCE Ingress Controller Description
      • CCE QoS Agent Description
      • CCE GPU Manager Description
      • CCE Ingress NGINX Controller Description
      • CCE P2P Accelerator Description
      • CCE Virtual Kubelet Component
      • CoreDNS Description
      • CCE Log Operator Description
      • CCE Node Remedier Description
      • CCE Descheduler Description
      • CCE Dynamic Scheduling Plugin Description
      • Kube Scheduler Documentation
      • CCE NPU Manager Description
      • CCE CronHPA Controller Description
      • CCE LB Controller Description
      • Kube ApiServer Description
      • CCE Backup Controller Description
      • CCE Network Plugin Description
      • CCE CSI PFS Plugin Description
      • CCE Credential Controller Description
      • CCE Deep Learning Frameworks Operator Description
      • Component Overview
      • CCE Image Accelerate Description
      • CCE CSI BOS Plugin Description
      • CCE Onepilot Description
      • Description of Kube Controller Manager
      • CCE_Hybrid_Manager Description
      • CCE NodeLocal DNSCache Description
      • CCE Node Problem Detector Description
      • CCE Ascend Mindx DL Description
      • CCE RDMA Device Plugin Description
      • CCE AI Job Scheduler Description
    • Image registry
      • Image Registry Basic Operations
      • Using Container Image to Build Services
    • Helm Management
      • Helm Template
      • Helm Instance
    • Cluster management
      • Upgrade Cluster Kubernetes Version
      • CCE Node CDS Dilatation
      • Managed Cluster Usage Instructions
      • Create cluster
      • CCE Supports GPUSharing Cluster
      • View Cluster
      • Connect to Cluster via kubectl
      • CCE Security Group
      • CCE Node Resource Reservation Instructions
      • Operate Cluster
      • Cluster Snapshot
    • Serverless Cluster
      • Product overview
      • Using Service in Serverless Cluster
      • Creating a Serverless Cluster
    • Storage Management
      • Using Cloud File System
      • Overview
      • Using Parallel File System PFS
      • Using RapidFS
      • Using Object Storage BOS
      • Using Parallel File System PFS L2
      • Using Local Storage
      • Using Cloud Disk CDS
    • Inspection and Diagnosis
      • Cluster Inspection
      • GPU Runtime Environment Check
      • Fault Diagnosis
    • Cloud-native AI
      • Cloud-Native AI Overview
      • AI Monitoring Dashboard
        • Connecting to a Prometheus Instance and Starting a Job
        • NVIDIA Chip Resource Observation
          • AI Job Scheduler component
          • GPU node resources
          • GPU workload resources
          • GPUManager component
          • GPU resource pool overview
        • Ascend Chip Resource Observation
          • Ascend resource pool overview
          • Ascend node resource
          • Ascend workload resource
      • Task Management
        • View Task Information
        • Create TensorFlow Task
        • Example of RDMA Distributed Training Based on NCCL
        • Create PaddlePaddle Task
        • Create AI Training Task
        • Delete task
        • Create PyTorch Task
        • Create Mxnet Task
      • Queue Management
        • Modify Queue
        • Create Queue
        • Usage Instructions for Logical Queues and Physical Queues
        • Queue deletion
      • Dataset Management
        • Create Dataset
        • Delete dataset
        • View Dataset
        • Operate Dataset
      • AI Acceleration Kit
        • AIAK Introduction
        • Using AIAK-Training PyTorch Edition
        • Deploying Distributed Training Tasks Using AIAK-Training
        • Accelerating Inference Business Using AIAK-Inference
      • GPU Virtualization
        • GPU Exclusive and Shared Usage Instructions
        • Image Build Precautions in Shared GPU Scenarios
        • Instructions for Multi-GPU Usage in Single-GPU Containers
        • GPU Virtualization Adaptation Table
        • GPU Online and Offline Mixed Usage Instructions
        • MPS Best Practices & Precautions
        • Precautions for Disabling Node Video Memory Sharing
    • Elastic Scaling
      • Container Timing Horizontal Scaling (CronHPA)
      • Container Horizontal Scaling (HPA)
      • Implementing Second-Level Elastic Scaling with cce-autoscaling-placeholder
      • CCE Cluster Node Auto-Scaling
    • Network Management
      • How to Continue Dilatation When Container Network Segment Space Is Exhausted (VPC-ENI Mode)
      • Container Access to External Services in CCE Clusters
      • CCE supports dual-stack networks of IPv4 and IPv6
      • Using NetworkPolicy Network Policy
      • Traffic Forwarding Configuration for Containers in Peering Connections Scenarios
      • CCE IP Masquerade Agent User Guide
      • Creating VPC-ENI Mode Cluster
      • How to Continue Dilatation When Container Network Segment Space Is Exhausted (VPC Network Mode)
      • Using NetworkPolicy in CCE Clusters
      • Network Orchestration
        • Container Network QoS Management
        • VPC-ENI Specified Subnet IP Allocation (Container Network v2)
        • Cluster Pod Subnet Topology Distribution (Container Network v2)
      • Network Connectivity
        • Container network accesses the public network via NAT gateway
      • Network Maintenance
        • Common Error Code Table for CCE Container Network
      • DNS
        • CoreDNS Component Manual Dilatation Guide
        • DNS Troubleshooting Guide
        • DNS Principle Overview
    • Namespace Management
      • Set Limit Range
      • Set Resource Quota
      • Basic Namespace Operations
    • Workload
      • CronJob Management
      • Set Workload Auto-Scaling
      • Deployment Management
      • Job Management
      • View the Pod
      • StatefulSet Management
      • Password-Free Pull of Container Image
      • Create Workload Using Private Image
      • DaemonSet Management
    • Monitor Logs
      • Monitor Cluster with Prometheus
      • CCE Event Center
      • Cluster Service Profiling
      • CCE Cluster Anomaly Event Alerts
      • Java Application Monitor
      • Cluster Audit Dashboard
      • Logging
      • Cluster Audit
      • Log Center
        • Configure Collection Rules Using CRD
        • View Cluster Control Plane Logs
        • View Business Logs
        • Log Overview
        • Configure Collection Rules in Cloud Container Engine Console
    • Application management
      • Overview
      • Secret
      • Configuration dictionary
      • Deployment
      • Service
      • Pod
    • NodeGroup Management
      • NodeGroup Management
      • NodeGroup Node Fault Detection and Self-Healing
      • Configuring Scaling Policies
      • NodeGroup Introduction
      • Adding Existing External Nodes
      • Custom NodeGroup Kubelet Configuration
      • Adding Alternative Models
      • Dilatation NodeGroup
    • Backup Center
      • Restore Management
      • Backup Overview
      • Backup Management
      • Backup repository
  • Quick Start
    • Quick Deployment of Nginx Application
    • CCE Container Engine Usage Process Overview
  • Product pricing
    • Product pricing
  • Product Description
    • Application scenarios
    • Introduction
    • Usage restrictions
    • Features
    • Advantages
    • Core concepts
  • Solution-Fabric
    • Fabric Solution
  • Development Guide
    • EFK Log Collection System Deployment Guide
    • Using Network Policy in CCE Cluster
    • Creating a LoadBalancer-Type Service
    • Prometheus Monitoring System Deployment Guide
    • kubectl Management Configuration
  • API_V2 Reference
    • Overview
    • Common Headers and Error Responses
    • Cluster Related Interfaces
    • Instance Related Interfaces
    • Service domain
    • General Description
    • Kubeconfig Related Interfaces
    • RBAC Related Interfaces
    • Autoscaler Related Interfaces
    • Network Related Interfaces
    • InstanceGroup Related Interfaces
    • Appendix
    • Component management-related APIs
    • Package adaptation-related APIs
    • Task Related Interfaces
  • Solution-Xchain
    • Hyperchain Solution
  • SDK
    • Go-SDK
      • Overview
      • NodeGroup Management
      • Initialization
      • Install the SDK Package
      • Cluster management
      • Node management
All documents
menu
No results found, please re-enter

CCE CCE

  • Function Release Records
  • Common Tools
    • Command Line Scenario Examples
  • API Reference
    • Overview
    • Common Headers and Error Responses
    • General Description
  • Product Announcement
    • Announcement on the Discontinuation of CCE Standalone Clusters
    • CCE New Cluster Management Release Announcement
    • Upgrade Announcement for CCE Cluster Audit Component kube-external-auditor
    • CCE Console Upgrade Announcement
    • Announcement on Management Fees for CCE Managed Clusters
    • Container Runtime Version Release Notes
    • Announcement on the Decommissioning of CCE Image Repository
    • Kubernetes Version Release Notes
      • CCE Release of Kubernetes v1_26 History
      • CCE Kubernetes Version Update Notes
      • CCE Release of Kubernetes v1_24 History
      • CCE Release of Kubernetes v1_30 History
      • CCE Release of Kubernetes v1_22 History
      • CCE Release of Kubernetes v1_18 History
      • CCE Release of Kubernetes v1_20 History
      • CCE Release of Kubernetes v1_28 History
      • Release Notes for CCE Kubernetes 1_31 Version
      • Kubernetes Version Overview and Mechanism
    • Security Vulnerability Fix Announcement
      • Vulnerability CVE-2019-5736 Fix Announcement
      • Vulnerability CVE-2021-30465 Fix Announcement
      • CVE-2025-1097, CVE-2025-1098, and Other Vulnerabilities Fix Announcement
      • CVE-2020-14386 Vulnerability Fix Announcement
      • Impact Statement on runc Security Issue (CVE-2024-21626)
  • Service Level Agreement (SLA)
    • CCE Service Level Agreement SLA (V1_0)
  • Typical Practices
    • Pod Anomaly Troubleshooting
    • Adding CGroup V2 Node
    • Common Linux System Configuration Parameters Description
    • Encrypting etcd Data Using KMS
    • Configuring Container Network Parameters Using CNI
    • CCE - Public Network Access Practice
    • Practice of using private images in CCE clusters
    • Unified Access for Virtual Machines and Container Services via CCE Ingress
    • User Guide for Custom CNI Plugins
    • CCE Cluster Network Description and Planning
    • Cross-Cloud Application Migration to Baidu CCE Using Velero
    • CCE Resource Recommender User Documentation
    • Continuous Deployment with Jenkins in CCE Cluster
    • CCE Best Practice-Guestbook Setup
    • CCE Best Practice-Container Network Mode Selection
    • CCE Usage Checklist
    • VPC-ENI Mode Cluster Public Network Access Practice
    • CCE Container Runtime Selection
    • Cloud-native AI
      • Elastic and Fault-Tolerant Training Using CCE AITraining Operator
      • Deploy the TensorFlow Serving inference service
      • Best Practice for GPU Virtualization with Optimal Isolation
  • FAQs
    • How do business applications use load balancer
    • Using kubectl on Windows
    • Cluster management FAQs
    • Common Questions Overview
    • Auto scaling FAQs
    • Create a simple service via kubectl
  • Operation guide
    • Prerequisites for use
    • Identity and access management
    • Permission Management
      • Configure IAM Tag Permission Policy
      • Permission Overview
      • Configure IAM Custom Permission Policy
      • Configure Predefined RBAC Permission Policy
      • Configure IAM Predefined Permission Policy
      • Configure Cluster OIDC Authentication
    • Configuration Management
      • Configmap Management
      • Secret Management
    • Traffic access
      • BLB ingress annotation description
      • Use K8S_Service via CCE
      • Use K8S_Ingress via CCE
      • Implement Canary Release with CCE Based on Nginx-Ingress
      • Create CCE_Ingress via YAML
      • LoadBalancer Service Annotation Description
      • Service Reuses Existing Load Balancer BLB
      • Use Direct Pod Mode LoadBalancer Service
      • NGINX Ingress Configuration Reference
      • Create LoadBalancer_Service via YAML
      • Use NGINX Ingress
    • Virtual Node
      • Configuring BCIPod
      • Configuring bci-profile
      • Managing virtual nodes
    • Node management
      • Add a node
      • Managing Taints
      • Setting Node Blocking
      • Setting GPU Memory Sharing
      • Remove a node
      • Customizing Kubelet Parameters
      • Kubelet Container Monitor Read-Only Port Risk Warning
      • Managing Node Tag
      • Drain node
    • Component Management
      • CCE CSI CDS Plugin Description
      • CCE Fluid Description
      • CCE CSI PFS L2 Plugin
      • CCE Calico Felix Description
      • CCE Ingress Controller Description
      • CCE QoS Agent Description
      • CCE GPU Manager Description
      • CCE Ingress NGINX Controller Description
      • CCE P2P Accelerator Description
      • CCE Virtual Kubelet Component
      • CoreDNS Description
      • CCE Log Operator Description
      • CCE Node Remedier Description
      • CCE Descheduler Description
      • CCE Dynamic Scheduling Plugin Description
      • Kube Scheduler Documentation
      • CCE NPU Manager Description
      • CCE CronHPA Controller Description
      • CCE LB Controller Description
      • Kube ApiServer Description
      • CCE Backup Controller Description
      • CCE Network Plugin Description
      • CCE CSI PFS Plugin Description
      • CCE Credential Controller Description
      • CCE Deep Learning Frameworks Operator Description
      • Component Overview
      • CCE Image Accelerate Description
      • CCE CSI BOS Plugin Description
      • CCE Onepilot Description
      • Description of Kube Controller Manager
      • CCE_Hybrid_Manager Description
      • CCE NodeLocal DNSCache Description
      • CCE Node Problem Detector Description
      • CCE Ascend Mindx DL Description
      • CCE RDMA Device Plugin Description
      • CCE AI Job Scheduler Description
    • Image registry
      • Image Registry Basic Operations
      • Using Container Image to Build Services
    • Helm Management
      • Helm Template
      • Helm Instance
    • Cluster management
      • Upgrade Cluster Kubernetes Version
      • CCE Node CDS Dilatation
      • Managed Cluster Usage Instructions
      • Create cluster
      • CCE Supports GPUSharing Cluster
      • View Cluster
      • Connect to Cluster via kubectl
      • CCE Security Group
      • CCE Node Resource Reservation Instructions
      • Operate Cluster
      • Cluster Snapshot
    • Serverless Cluster
      • Product overview
      • Using Service in Serverless Cluster
      • Creating a Serverless Cluster
    • Storage Management
      • Using Cloud File System
      • Overview
      • Using Parallel File System PFS
      • Using RapidFS
      • Using Object Storage BOS
      • Using Parallel File System PFS L2
      • Using Local Storage
      • Using Cloud Disk CDS
    • Inspection and Diagnosis
      • Cluster Inspection
      • GPU Runtime Environment Check
      • Fault Diagnosis
    • Cloud-native AI
      • Cloud-Native AI Overview
      • AI Monitoring Dashboard
        • Connecting to a Prometheus Instance and Starting a Job
        • NVIDIA Chip Resource Observation
          • AI Job Scheduler component
          • GPU node resources
          • GPU workload resources
          • GPUManager component
          • GPU resource pool overview
        • Ascend Chip Resource Observation
          • Ascend resource pool overview
          • Ascend node resource
          • Ascend workload resource
      • Task Management
        • View Task Information
        • Create TensorFlow Task
        • Example of RDMA Distributed Training Based on NCCL
        • Create PaddlePaddle Task
        • Create AI Training Task
        • Delete task
        • Create PyTorch Task
        • Create Mxnet Task
      • Queue Management
        • Modify Queue
        • Create Queue
        • Usage Instructions for Logical Queues and Physical Queues
        • Queue deletion
      • Dataset Management
        • Create Dataset
        • Delete dataset
        • View Dataset
        • Operate Dataset
      • AI Acceleration Kit
        • AIAK Introduction
        • Using AIAK-Training PyTorch Edition
        • Deploying Distributed Training Tasks Using AIAK-Training
        • Accelerating Inference Business Using AIAK-Inference
      • GPU Virtualization
        • GPU Exclusive and Shared Usage Instructions
        • Image Build Precautions in Shared GPU Scenarios
        • Instructions for Multi-GPU Usage in Single-GPU Containers
        • GPU Virtualization Adaptation Table
        • GPU Online and Offline Mixed Usage Instructions
        • MPS Best Practices & Precautions
        • Precautions for Disabling Node Video Memory Sharing
    • Elastic Scaling
      • Container Timing Horizontal Scaling (CronHPA)
      • Container Horizontal Scaling (HPA)
      • Implementing Second-Level Elastic Scaling with cce-autoscaling-placeholder
      • CCE Cluster Node Auto-Scaling
    • Network Management
      • How to Continue Dilatation When Container Network Segment Space Is Exhausted (VPC-ENI Mode)
      • Container Access to External Services in CCE Clusters
      • CCE supports dual-stack networks of IPv4 and IPv6
      • Using NetworkPolicy Network Policy
      • Traffic Forwarding Configuration for Containers in Peering Connections Scenarios
      • CCE IP Masquerade Agent User Guide
      • Creating VPC-ENI Mode Cluster
      • How to Continue Dilatation When Container Network Segment Space Is Exhausted (VPC Network Mode)
      • Using NetworkPolicy in CCE Clusters
      • Network Orchestration
        • Container Network QoS Management
        • VPC-ENI Specified Subnet IP Allocation (Container Network v2)
        • Cluster Pod Subnet Topology Distribution (Container Network v2)
      • Network Connectivity
        • Container network accesses the public network via NAT gateway
      • Network Maintenance
        • Common Error Code Table for CCE Container Network
      • DNS
        • CoreDNS Component Manual Dilatation Guide
        • DNS Troubleshooting Guide
        • DNS Principle Overview
    • Namespace Management
      • Set Limit Range
      • Set Resource Quota
      • Basic Namespace Operations
    • Workload
      • CronJob Management
      • Set Workload Auto-Scaling
      • Deployment Management
      • Job Management
      • View the Pod
      • StatefulSet Management
      • Password-Free Pull of Container Image
      • Create Workload Using Private Image
      • DaemonSet Management
    • Monitor Logs
      • Monitor Cluster with Prometheus
      • CCE Event Center
      • Cluster Service Profiling
      • CCE Cluster Anomaly Event Alerts
      • Java Application Monitor
      • Cluster Audit Dashboard
      • Logging
      • Cluster Audit
      • Log Center
        • Configure Collection Rules Using CRD
        • View Cluster Control Plane Logs
        • View Business Logs
        • Log Overview
        • Configure Collection Rules in Cloud Container Engine Console
    • Application management
      • Overview
      • Secret
      • Configuration dictionary
      • Deployment
      • Service
      • Pod
    • NodeGroup Management
      • NodeGroup Management
      • NodeGroup Node Fault Detection and Self-Healing
      • Configuring Scaling Policies
      • NodeGroup Introduction
      • Adding Existing External Nodes
      • Custom NodeGroup Kubelet Configuration
      • Adding Alternative Models
      • Dilatation NodeGroup
    • Backup Center
      • Restore Management
      • Backup Overview
      • Backup Management
      • Backup repository
  • Quick Start
    • Quick Deployment of Nginx Application
    • CCE Container Engine Usage Process Overview
  • Product pricing
    • Product pricing
  • Product Description
    • Application scenarios
    • Introduction
    • Usage restrictions
    • Features
    • Advantages
    • Core concepts
  • Solution-Fabric
    • Fabric Solution
  • Development Guide
    • EFK Log Collection System Deployment Guide
    • Using Network Policy in CCE Cluster
    • Creating a LoadBalancer-Type Service
    • Prometheus Monitoring System Deployment Guide
    • kubectl Management Configuration
  • API_V2 Reference
    • Overview
    • Common Headers and Error Responses
    • Cluster Related Interfaces
    • Instance Related Interfaces
    • Service domain
    • General Description
    • Kubeconfig Related Interfaces
    • RBAC Related Interfaces
    • Autoscaler Related Interfaces
    • Network Related Interfaces
    • InstanceGroup Related Interfaces
    • Appendix
    • Component management-related APIs
    • Package adaptation-related APIs
    • Task Related Interfaces
  • Solution-Xchain
    • Hyperchain Solution
  • SDK
    • Go-SDK
      • Overview
      • NodeGroup Management
      • Initialization
      • Install the SDK Package
      • Cluster management
      • Node management
  • Document center
  • arrow
  • CCECCE
  • arrow
  • API_V2 Reference
  • arrow
  • Component management-related APIs
Table of contents on this page
  • Get component status
  • Install component
  • Uninstall component
  • Update component deployment parameters
  • Component dilatation
  • Component name list
  • Component example parameters
  • CCE GPU Manager
  • CCE AI Job Scheduler
  • CCE RDMA Device Plugin
  • CCE PaddleFlow
  • CCE Fluid
  • CCE Deep Learning Frameworks Operator
  • CCE Image Accelerate
  • CCE Hybrid Manager
  • CCE Ingress NGINX Controller
  • CCE Ingress Controller
  • CCE CSI CDS Plugin
  • CCE CSI BOS Plugin
  • CCE CSI PFS Plugin
  • CCE NPU Manager
  • CCE Log Operator

Component management-related APIs

Updated at：2025-10-27

Component management-related APIs

Get component status

Access basic component information and status.

If already installed, deployment parameters and related information will be displayed.

Request structure

Plain Text 
1GET /v2/cluster/{ClusterID}/addon
2Host: cce.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name Types Required or not Parameter location Description
clusterID String Yes URL parameter Cluster ID.
addons String No Query If null, retrieves information on all components. When querying multiple components, separate with commas, e.g., cce-ingress-controller,cce-gpu-controller. Refer to the appendix for valid values.

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name Types Required or not Description
requestID String Yes Request ID, useful for issue troubleshooting.
items List<[AddOnInfo](CCE/API_V2 Reference/Appendix.md#AddOnInfo)> No Component query results, where each array element corresponds to the result for a particular component.
code String No Error code, present only when the request fails.
message String No Error description, available only in case of a request failure.

Request example

Plain Text 
1GET /v2/cluster/cce-5e130ugt/addon?addons=cce-ingress-controller HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

Response example

Plain Text 
1HTTP/1.1 200 OK
2X-Bce-Request-Id: aef503ab-66e2-4b7f-9044-e922389ed03f
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6    "items": [
7        {
8            "meta": {
9                "name": "cce-ingress-controller",
10                "type": "Networking",
11                "latestVersion": "1.3.5",
12 "shortIntroduction": "Implement K8s Ingress semantics based on Baidu AI Cloud Application Load Balancer (Application BLB), providing Layer 7 network load balancing capabilities",
13 "defaultParams": "\n# Default values for cce-ingress-controller\n# This is a YAML-formatted file.\n# Declare variables to be passed into your templates.\n\nClusterVersion: v2\nImageID: registry.baidubce.com/cce-plugin-dev/cce-ingress-controller:rc853b4b_20230117\n\nOpenCCEGatewayEndpoint:\nBLBOpenAPIEndpoint:\nEIPOpenAPIEndpoint:\nVPCEndpoint:\nCCEV2Endpoint:\nTagEndpoint:\n\nEIPPurchaseType:\n\nRegion:   # Cluster region\nClusterID: # Cluster ID\nConcurrentIngressSyncs: # Maximum number of services processed simultaneously\nDefaultMaxRSCount: # Maximum number of backends mounted by default for BLB by component\n",
14                "installInfo": {
15                    "allowInstall": true
16                }
17            },
18            "instance": {
19                "name": "cce-ingress-controller",
20                "installedVersion": "2022.11.08.1552",
21                "params": "# No Params",
22                "status": {
23                    "phase": "Running"
24                },
25                "uninstallInfo": {
26                    "allowUninstall": true
27                },
28                "upgradeInfo": {
29                    "allowUpgrade": false,
30                    "nextVersion": "",
31 "message": "Version upgrade is not supported now"
32                },
33                "updateInfo": {
34                    "allowUpdate": false,
35 "message": "Parameter update is not supported"
36                }
37            }
38        }
39    ],
40    "requestID": "62709f56-3f0b-4fcc-86e0-c18547ba1ce7"
41}

Install component

Install a component in the cluster.

Installation parameters differ based on the component. Deployment parameters are provided as strings.

Request structure

Plain Text 
1POST /v2/cluster/{ClusterID}/addon
2Host: cce.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name Types Required or not Parameter location Description
clusterID String Yes URL parameter Cluster ID.
name String Yes Request Body parameters Specify the name of the component to install.
params String No Request Body parameters Component installation parameters vary. Refer to [Appendix] for details, as some components do not require installation parameters.
version String No Request Body parameters Specify the version of the component to install. This parameter is usually not set.

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name Types Required or not Description
requestID String Yes Request ID, useful for issue troubleshooting.
code String No Error code, present only when the request fails.
message String No Error description, available only in case of a request failure.

Request example

Plain Text 
1POST /v2/cluster/cce-5e130ugt/addon HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "name": "cce-gpu-manager",
6    "params": "EnableHook: true\nEnableSGPU: true\n\n"
7}

Response example

Plain Text 
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 6f593304-6787-45ea-8e0f-426ee331cc8b
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6	"requestID": "6f593304-6787-45ea-8e0f-426ee331cc8b"
7}

Uninstall component

Uninstall a component that has been deployed in the cluster.

Request structure

Plain Text 
1DELETE /v2/cluster/{ClusterID}/addon
2Host: cce.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name Types Required or not Parameter location Description
clusterID String Yes URL parameter Cluster ID.
name String Yes Request Body parameters Provide the name of the component to uninstall.
instanceName String No Request Body parameters Enter the name of the component instance to uninstall. This is applicable only for components supporting multi-instance deployment to indicate the specific instance to remove. This field is generally not used.

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name Types Required or not Description
requestID String Yes Request ID, useful for issue troubleshooting.
code String No Error code, present only when the request fails.
message String No Error description, available only in case of a request failure.

Request example

Plain Text 
1DELETE /v2/cluster/cce-5e130ugt/addon HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "name": "cce-ingress-controller"
6}

Response example

Plain Text 
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 6f593304-6787-45ea-8e0f-426ee331cc8b
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6	"requestID": "6f593304-6787-45ea-8e0f-426ee331cc8b"
7}

Update component deployment parameters

Update the deployment parameters for a component installed in the cluster.

Request structure

Plain Text 
1PUT /v2/cluster/{ClusterID}/addon
2Host: cce.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name Types Required or not Parameter location Description
clusterID String Yes URL parameter Cluster ID.
name String Yes Request Body parameters Enter the name of the component to update.
instanceName String No Request Body parameters Specify the name of the component instance to update. This applies only to components allowing multi-instance deployment. This field is typically not used.
params String Yes Request Body parameters Provide the deployment parameters to be updated.

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name Types Required or not Description
requestID String Yes Request ID, useful for issue troubleshooting.
code String No Error code, present only when the request fails.
message String No Error description, available only in case of a request failure.

Request example

Plain Text 
1PUT /v2/cluster/cce-mehgoi9r/addon HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "name": "cce-hybrid-manager",
6    "params": "A: a"
7}

Response example

Plain Text 
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 6f593304-6787-45ea-8e0f-426ee331cc8b
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6	"requestID": "6f593304-6787-45ea-8e0f-426ee331cc8b"
7}

Component dilatation

Upgrade the version of a component deployed in the cluster.

Request structure

Plain Text 
1POST /v2/cluster/{ClusterID}/addon/upgrade
2Host: cce.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name Types Required or not Parameter location Description
clusterID String Yes URL parameter Cluster ID.
name String Yes Request Body parameters Specify the name of the component to upgrade.
targetVersion String No Request Body parameters Indicate the target upgrade version. This field is rarely used, as the target version is typically determined automatically by the backend.
instanceName String No Request Body parameters Enter the name of the component instance to upgrade. This applies only for components supporting multi-instance deployment. This field is generally not used.
params String No Request Body parameters Provide the parameters to be updated during the upgrade. This field is typically not used.

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name Types Required or not Description
requestID String Yes Request ID, useful for issue troubleshooting.
code String No Error code, present only when the request fails.
message String No Error description, available only in case of a request failure.

Request example

Plain Text 
1POST /v2/cluster/cce-jx4l7afz/addon/upgrade HTTP/1.1
2Host: cce.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "name": "cce-npu-manager"
6}

Response example

Plain Text 
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 6f593304-6787-45ea-8e0f-426ee331cc8b
3Date: Thu, 16 Mar 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5{
6	"requestID": "6f593304-6787-45ea-8e0f-426ee331cc8b"
7}

Component name list

Component name Parameter name
CCE GPU Manager cce-gpu-manager
CCE AI Job Scheduler cce-volcano
CCE RDMA Device Plugin cce-rdma-plugin
CCE PaddleFlow cce-paddleflow
CCE Fluid cce-fluid
CCE Deep Learning Frameworks Operator cce-aibox
CCE Image Accelerate cce-image-accelerate
CCE Hybrid Manager cce-hybrid-manager
CCE Ingress NGINX Controller cce-ingress-nginx-controller
CCE Ingress Controller cce-ingress-controller
CCE CSI CDS Plugin cce-csi-cds-plugin
CCE CSI BOS Plugin cce-csi-bos-plugin
CCE CSI PFS Plugin cce-csi-pfs-plugin
CCE NPU Manager cce-npu-manager
CCE Log Operator cce-log-operator

Component example parameters

CCE GPU Manager

YAML 
1EnableSGPU: false # true: isolated in kernel mode; false: isolated in user mode
2 GPUShareMemoryUnit: GiB # memory sharing resource reporting unit GiB/MiB
3 IgnoreDeviceType: false # whether to ignore card type, defaulting to false, with card model included in the reported resource

CCE AI Job Scheduler

YAML 
1Binpack: true # Binpack: false indicates enabling spread
2 Reclaimgang: true # whether to start preemption in the queue
3 Preemptgang: true # whether to start inter-queue preemption

CCE RDMA Device Plugin

This component does not require user to set parameters

CCE PaddleFlow

YAML 
1global:
2  PF_SELFED_DB_ENABLED: &selfd_mysql true
3  PF_DB_DATABASE: &pf_db_database paddleflow
4  PF_DB_HOST: &pf_db_host mysql-standalone
5  PF_DB_PASSWORD: &mysqlpwd Paddle@2022
6  PF_DB_USER: &pf_db_user root
7  PF_DB_PORT: &pf_db_port 3306
8  PF_SVC_TYPE: &pf_svc_type NodePort
9  PF_SERVER_NODE_PORT: &pf_server_node_port 30999
10  PF_LB_IP: &eip "0.0.0.0"
11  CCE_LB_ID: "lb-12345678"
12  CCE_LB_SBN_ID: "sbn-123456789123"
13  CCE_LB_INTERNAL: true
14  CCE_LB_POD_DERICT: false
15  IMAGE_REPOSITORY: registry.baidubce.com/cce-plugin-dev/paddleflow
16paddleflow-server:
17  out_depend_msg:
18    PF_DB_DATABASE: *pf_db_database
19    PF_DB_HOST: *pf_db_host
20    PF_DB_PASSWORD: *mysqlpwd
21    PF_DB_PORT: *pf_db_port
22    PF_DB_USER: *pf_db_user
23  paddleflow_server:
24    service:
25      extra_usr_define_services:
26        paddleflow-server:
27          ports:
28            port-0:
29              nodePort: *pf_server_node_port
30          loadBalancerIP: *eip
31          type: *pf_svc_type
32paddleflow-db-init:
33  out_depend_msg:
34    PF_DB_DATABASE: *pf_db_database
35    PF_DB_HOST: *pf_db_host
36    PF_DB_PASSWORD: *mysqlpwd
37    PF_DB_PORT: *pf_db_port
38    PF_DB_USER: *pf_db_user
39mysql-replication:
40  enabled: *selfd_mysql
41  fullnameOverride: *pf_db_host
42  nameOverride: *pf_db_host
43  auth:
44    rootPassword: *mysqlpwd
45    database: *pf_db_database
46    username: *pf_db_user
47    password: *mysqlpwd
48  primary:
49    service:
50      port: *pf_db_port

CCE Fluid

This component does not require user to set parameters

CCE Deep Learning Frameworks Operator

YAML 
1TFOperatorEnable: false
2MPIOperatorEnable: false
3PyTorchOperatorEnable: false
4PaddleOperatorEnable: false
5MXNetOperatorEnable: false
6AITrainingOperatorEnable: false

CCE Image Accelerate

This component does not require user to set parameters

CCE Hybrid Manager

YAML 
1version:
2  scheduler: 1.2.8
3  hybridlet: 1.2.8
4globalSLA:
5  cpu:
6    highPercent: 65
7    bestEffortMaxCores: 60
8  memory:
9    highPercent: 80
10    bestEffortMax: 60
11  net:
12    inHigh: 10000
13    bestEffortInHigh: 10000
14    outHigh: 10000
15    bestEffortOutHigh: 10000
16  coolDownSec: 10
17  expulsionDelaySec: 60
18  maxInstances: 256

CCE Ingress NGINX Controller

YAML 
1controller:
2  ingressClass: ads
3  kind: DaemonSet
4  nodeSelector:
5    instance-group-id: cce-ig-ubn1700b
6  resources:
7    limits:
8      cpu: 0.5
9      memory: 1024Mi
10    requests:
11      cpu: 0.25
12      memory: 256Mi
13  scope:
14    enabled: false
15    namespace: ""
16  service:
17    annotations:
18      service.beta.kubernetes.io/cce-load-balancer-internal-vpc: true
19  tolerations: []
20fullnameOverride: ads-ngx-control
21isArchArm64: false

CCE Ingress Controller

This component does not require user to set parameters

CCE CSI CDS Plugin

YAML 
1maxVolumesPerNode: 5 # Maximum number of CDS PVs mounted on each node in the maxVolumesPerNode cluster
2 cluster:             # kubeletRootPath user node Kubelet data directory. List all data directories that have appeared on any node in the cluster here. If the node has not specifically modified the kubelet data directory, it can be omitted.
3  nodes:
4    - kubeletRootPath: "/home/cce/kubelet"
5      kubeletRootPathAffinity: true
6    - kubeletRootPath: "/data/kubelet"
7      kubeletRootPathAffinity: true
8    - kubeletRootPath: "/var/lib/kubelet"
9      kubeletRootPathAffinity: true

CCE CSI BOS Plugin

YAML 
1maxVolumesPerNode: 5 # Maximum number of BOS PVs mounted on each node in the maxVolumesPerNode cluster
2 cluster:             # kubeletRootPath user node Kubelet data directory. List all data directories that have appeared on any node in the cluster here. If the node has not specifically modified the kubelet data directory, it can be omitted.
3  nodes:
4  - kubeletRootPath: "/home/cce/kubelet"
5    kubeletRootPathAffinity: true
6  - kubeletRootPath: "/data/kubelet"
7    kubeletRootPathAffinity: true
8  - kubeletRootPath: "/var/lib/kubelet"
9    kubeletRootPathAffinity: true

CCE CSI PFS Plugin

YAML 
1pfs:
2 configEndpoint: ""     # configEndpoint PFS connection address and port
3 parentDir: /kubernetes # parentDir represents the subpath with read/write permissions for CSI. Paths requiring static PV mounts must be kept in the range of this path Maximum /, defaulting to /kubernetes. Before mounting, ensure the path has been authorized for the K8S Cluster CCE machines.
4 nodes:                   # kubeletRootPath user node Kubelet data directory. List all data directories that have appeared on any node in the cluster here. If the node has not specifically modified the kubelet data directory, it can be omitted.
5  - kubeletRootPath: "/var/lib/kubelet"
6    kubeletRootPathAffinity: true
7  - kubeletRootPath: "/home/cce/kubelet"
8    kubeletRootPathAffinity: true
9  - kubeletRootPath: "/data/kubelet"
10    kubeletRootPathAffinity: true

CCE NPU Manager

YAML 
1XPUUseSriov: false # If started, segment by hardware isolation, not supporting virtual machine
2 XPUSriovNumVfs: 3 # Specify the number of Kunlun hardware segments

CCE Log Operator

This component does not require user to set parameters

Previous
Appendix
Next
Package adaptation-related APIs