Help Center/ Host Security Service/ API Reference/ API Description/ Container Installation and Configuration/ Obtaining Cluster Daemonset Information
Updated on 2026-05-12 GMT+08:00
View PDF
Share

Obtaining Cluster Daemonset Information

Function

This API is used to obtain cluster daemonset information.

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

GET /v5/{project_id}/container/kubernetes/clusters/{cluster_id}/daemonsets

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

cluster_id

Yes

String

Cluster ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

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.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

yaml_content

String

Original YAML

node_num

Integer

Total number of nodes.

runtime_info

Array of RuntimeRequestBody objects

Container runtime configuration

cluster_status

String

Definition

Cluster status.

Constraints

N/A

Range

Its value can be**:

  • Available: The cluster is running properly.

  • Unavailable: The cluster is exhibiting unexpected behavior. Manually delete the cluster or contact the administrator to delete the cluster.

  • ScalingUp: Nodes are being added to the cluster.

  • ScalingDown: The cluster is being downsized to fewer nodes.

  • Creating: The cluster is being created.

  • Deleting: The cluster is being deleted.

  • Upgrading: The cluster is being upgraded.

  • Resizing: Cluster specifications are being changed.

  • RollingBack: The cluster is being rolled back.

  • RollbackFailed: The cluster fails to be rolled back. In this case, contact the administrator to perform the rollback again.

  • Empty: The cluster has no resources.

Default Value

N/A

ds_info

ds_info object

DS status

installed_status

String

Definition

Cluster DS installation status.

Constraints

N/A

Range

Its value can be**:

  • installing: The component is being installed.

  • install_success: The installation is successful.

  • install_failed: The installation failed.

  • partially_success: The installation is partially successful.

  • upgrade_success: The upgrade is successful.

  • upgrade_failed: The upgrade failed.

  • upgrading: The upgrade is in progress.

  • none: not installed

Default Value

N/A

schedule_info

schedule_info object

Node scheduling information

resource_info

resource_info object

Resource configuration.
Table 5 RuntimeRequestBody

Parameter

Type

Description

runtime_name

String

Runtime name. Its value can be:

  • crio_endpoint: CRIO

  • containerd_endpoint: Containerd

  • docker_endpoint: Docker

  • isulad_endpoint: Isulad

  • podman_endpoint: Podman

runtime_path

String

Runtime path
Table 6 ds_info

Parameter

Type

Description

desired_num

Integer

Target quantity

current_num

Integer

Quantity

ready_num

Integer

Ready quantity
Table 7 schedule_info

Parameter

Type

Description

node_selector

Array of strings

Node selector

pod_tolerances

Array of strings

Pod tolerance
Table 8 resource_info

Parameter

Type

Description

mode

String

Definition

Resource limit type: default,** customized**, or adaptive

Range

  • default: default type

  • customized: user-defined type

  • adaptive: adaptive type

cpu_limit

String

Definition

Maximum number of CPUs

Range

The value can contain 0 to 32 characters.

mem_limit

String

Definition

Maximum memory size

Range

The value can contain 0 to 32 characters.

Example Requests

This API is used to obtain cluster daemonset information.

GET https://{endpoint}/v5/{project_id}/container/kubernetes/clusters/{cluster_id}/daemonsets?enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "node_num" : 0,
  "cluster_status" : "Available",
  "installed_status" : "install_success"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration