查询容器Kubernetes服务列表 - ListKubernetesServiceDetails
功能介绍
查询容器Kubernetes服务列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/kubernetes/services
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
name |
否 |
String |
服务名称 |
|
cluster_name |
否 |
String |
集群名称 |
|
namespace |
否 |
String |
命名空间 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
服务总数 |
|
last_update_time |
Long |
最近更新时间 |
|
service_info_list |
Array of KubernetesServiceInfo objects |
服务列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
id |
|
name |
String |
服务名称 |
|
endpoint_name |
String |
端点名称 |
|
namespace |
String |
命名空间 |
|
creation_timestamp |
Long |
创建时间戳 |
|
type |
String |
参数解释: 服务类型（访问方式） 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
cluster_ip |
String |
集群IP |
|
cluster_name |
String |
集群名称 |
|
cluster_type |
String |
集群类型，包含以下几种：
|
请求示例
无
响应示例
状态码：200
请求已成功
{
"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"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
