Help Center/ Host Security Service/ API Reference/ API Description/ Container Management/ Querying the Kubernetes Service List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Kubernetes Service List

Function

This API is used to query the Kubernetes service list.

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/services

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.

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

name

No

String

Service name

cluster_name

No

String

Cluster name

namespace

No

String

Namespaces

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

Integer

Total number of services.

last_update_time

Long

Updated

service_info_list

Array of KubernetesServiceInfo objects

Services
Table 5 KubernetesServiceInfo

Parameter

Type

Description

id

String

id

name

String

Service name

endpoint_name

String

Endpoint name

namespace

String

Namespaces

creation_timestamp

Long

Creation timestamp.

type

String

Definition

Service type (access mode)

Constraints

N/A

Range

  • ClusterIP: accessible only to internal personnel

  • NodePort: exposed externally using NodePort

  • LoadBalancer: exposed externally using LoadBalancer

Default Value

N/A

cluster_ip

String

Cluster IP address

cluster_name

String

Cluster name

cluster_type

String

Cluster type. Its value can be:

  • k8s: native Kubernetes cluster

  • cce: CCE cluster

  • ali: Alibaba Cloud cluster

  • tencent: Tencent Cloud cluster

  • azure: Microsoft Azure Cloud cluster

  • aws: AWS Cloud cluster

  • self_built_hw: customer-built cluster on Huawei Cloud

  • self_built_idc: IDC on-premises cluster

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 21,
  "last_update_time" : 1744311874662,
  "service_info_list" : [ {
    "id" : "1aee3ca1-69f0-4390-a7e5-adcf90e4728f",
    "name" : "proxy-exporter",
    "namespace" : "monitoring",
    "type" : "ClusterIP",
    "cluster_name" : "yescrypt",
    "cluster_ip" : "10.247.69.251",
    "cluster_type" : "self_built_hw",
    "creation_timestamp" : 1720765128000,
    "endpoint_name" : "prometheus-operator"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Management