Help Center/Host Security Service/API Reference/API Description/Container Assets/Querying Basic Deployment Information
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying Basic Deployment Information

Function

This API is used to query basic deployment 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}/kubernetes/deployments

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

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.

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

deployment_name

No

String

Deployment name

namespace_name

No

String

Namespace

cluster_name

No

String

Cluster name

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

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

total_num

Long

Total number of deployment instances

last_update_time

Long

Updated

type

String

Resource type. The options are as follows:

  • deploy: Deployment

  • sts: StatefulSets

  • job: common job

  • cronjob: scheduled task

resources_info_list

Array of ServerlessDeploymentInfo objects

Basic information about resources

Table 5 ServerlessDeploymentInfo

Parameter

Type

Description

name

String

Deployment name

namespace_name

String

Name

cluster_name

String

Cluster.

status

String

Status. It can be:

  • Running: The system is running properly.

  • Failed: An exception occurs.

protect_status

String

Protection status. It can be:

  • closed

  • opened

pods_num

Integer

Total number of instances

image_name

String

Image name.

match_labels

Array of LabelInfo objects

Label

create_time

Long

Created At

agent_installed_num

Integer

Number of Agents Installed for a Workload

agent_install_failed_num

Integer

Number of pods that fail to be installed under a workload

agent_not_install_num

Integer

Number of instances where no agent is installed in the workload

Table 6 LabelInfo

Parameter

Type

Description

key

String

Tag name

val

String

The tag value.

Example Requests

Description

Query basic deployment information.

GET https://{endpoint}/v5/{project_id}/kubernetes/deployments?offset=0&limit=200&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "last_update_time" : 2025,
  "type" : "job",
  "resources_info_list" : [ {
    "name" : "cgs-provider",
    "namespace_name" : "cgs-provider",
    "protect_status" : "opened",
    "pods_num" : 0,
    "status" : "Failed",
    "create_time" : 1719907180000,
    "cluster_name" : "cce-lxl-0627-2",
    "image_name" : "cgs-provider:1.0",
    "match_labels" : [ {
      "key" : "run",
      "val" : "cgs-provider"
    } ],
    "agent_installed_num" : 1,
    "agent_install_failed_num" : 1,
    "agent_not_install_num" : 1
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Assets