文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器管理/ 查询容器Kubernetes服务详情 - ShowKubernetesServiceInfo
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询容器Kubernetes服务详情 - ShowKubernetesServiceInfo

功能介绍

查询容器Kubernetes服务详情

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/kubernetes/service/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

id

是

String

服务id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

服务ID

name

String

服务名称

endpoint_name

String

端点名称

namespace

String

命名空间

creation_timestamp

Long

创建时间戳

cluster_name

String

集群名称

labels

String

标签

type

String

参数解释:

服务类型（访问方式）

约束限制:

不涉及

取值范围:

  • ClusterIP：仅内部可访问服务

  • NodePort：通过NodePort对外暴露服务

  • LoadBalancer：通过LoadBalancer对外暴露服务

默认取值:

不涉及

cluster_ip

String

集群IP

selector

String

选择器

session_affinity

String

会话亲和性

service_port_list

Array of KubernetesServicePortInfo objects

Service关联端口列表
表5 KubernetesServicePortInfo

参数

参数类型

描述

id

String

ID

service_id

String

关联服务 ID

name

String

端口名

protocol

String

服务协议

port

Integer

端口号

target_port

String

后端容器端口

node_port

Integer

节点端口

请求示例

查询容器Kubernetes服务详情

GET  https://{endpoint}/v5/{project_id}/kubernetes/service/detail?id=048fa7bd-xxxx-xxxx-xxxx-a2bf44ae8d65&enterprise_project_id=all_granted_eps

响应示例

状态码：200

请求已成功

{
  "id" : "048fa7bd-xxxx-xxxx-xxxx-a2bf44ae8d65",
  "name" : "prometheus-operator",
  "endpoint_name" : "prometheus-operator",
  "namespace" : "monitoring",
  "creation_timestamp" : 1720765128000,
  "cluster_name" : "glz-2451",
  "labels" : "{\"app\":\"prometheus-operator\",\"app.kubernetes.io/managed-by\":\"Helm\",\"release\":\"cceaddon-cie-collector\"}",
  "type" : "ClusterIP",
  "cluster_ip" : "10.247.69.251",
  "selector" : "{\"app\":\"prometheus-operator\"}",
  "session_affinity" : "None",
  "service_port_list" : [ {
    "id" : "8cf93aff-xxxx-xxxx-xxxx-4e906c84b68f",
    "service_id" : "048fa7bd-xxxx-xxxx-xxxx-a2bf44ae8d65",
    "name" : "http",
    "protocol" : "TCP",
    "port" : 8080,
    "target_port" : "http"
  }, {
    "id" : "b509362b-xxxxx-xxxx-xxxx-53fefc664c5e",
    "service_id" : "048fa7bd-xxxx-xxxx-xxxx-a2bf44ae8d65",
    "name" : "ready",
    "protocol" : "TCP",
    "port" : 8081,
    "target_port" : "8081"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 容器管理

相关文档