ListKubeconfigs--容器服务-火山引擎

文档中心

立即注册

导航

容器服务

ListKubeconfigs

最近更新时间：2024.09.29 18:50:57首次发布时间：2022.12.14 14:54:08

查询符合条件的集群 Kubeconfig 详情列表。

使用说明

查询集群 Kubeconfig 凭证时，根据接口调用者权限的区别，包含如下两种：

调用者拥有火山引擎账号（主账号）权限：可以查询自身以及其下子用户和角色的 Kubeconfig 信息。
调用者拥有子用户或角色权限：只能查询自身的 Kubeconfig 信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListKubeconfigs&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListKubeconfigs	接口名称。当前 API 的名称为 `ListKubeconfigs`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10
Filter	Object of ListKubeconfigsFilter	否	-	待查询 Kubeconfig 的筛选条件。

ListKubeconfigsFilter

参数	类型	是否必选	示例值	描述
ClusterIds	Array of String	否	["cc5silumrsf******"]	集群 ID。可以调用 ListClusters 接口，获取集群 ID。说明单次最多填写 100 个集群 ID。此参数为空数组时，基于账号下指定地域的所有集群进行筛选。
Ids	Array of String	否	["kc9l74mvqtof******"]	Kubeconfig ID。在容器服务控制台的集群页面，单击目标集群名称后，在集群的基本信息页面连接信息页签获取 Kubeconfig ID，也可以查看调用 CreateKubeconfig 接口后保存的 Kubeconfig ID 信息。
UserIds	Array of Long	否	[2100******]	用户 ID。可以调用获取用户详情接口，获取用户 ID。注意若不传入用户 ID，则由系统判断接口调用者的权限并返回对应的 Kubeconfig 信息：调用者具有火山引擎账号（主账号）权限：返回火山引擎账号及其下子用户的所有 Kubeconfig 信息。调用者具有子用户权限：仅返回该子用户下的 Kubeconfig 信息。单次最多填写 20 个用户 ID。
RoleIds	Array of Long	否	[7890******]	角色 ID。可以调用获取角色详情接口，获取角色 ID。注意若不传入角色 ID，则由系统判断接口调用者的权限并返回对应的 Kubeconfig 信息：调用者具有火山引擎账号（主账号）权限：返回火山引擎账号及其下角色的所有 Kubeconfig 信息。调用者具有角色权限：仅返回该角色下的 Kubeconfig 信息。单次最多填写 20 个角色 ID。
Types	Array of String	否	["Private"]	集群 Kubeconfig 文件类型，取值： Private：私网访问类型的 Kubeconfig 文件。 Public：公网访问类型的 Kubeconfig 文件。

请求示例

POST https://open.volcengineapi.com/?Action=ListKubeconfigs&Version=2022-05-12
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "ClusterIds": ["cc5silumrsfeq****"],
        "Ids": ["kc9l74mvqtofjnoj5*****"],
        "UserIds": [210000*****],
        "Types": ["Private"]
    }
}

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
Items	Array of KubeconfigResponse	-	Kubeconfig 的详细信息列表。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	每页显示的 Kubeconfig 信息条数。
TotalCount	Integer	11	符合条件的 Kubeconfig 总数。

KubeconfigResponse

参数	类型	示例值	描述
Id	String	kc9q8pbf********	Kubeconfig ID。
UserId	Long	21000*****	用户 ID。
ClusterId	String	cc9q8pbf********	集群 ID。
Type	String	Private	集群 Kubeconfig 文件类型，参数值有： Private：私网访问类型的 Kubeconfig 文件。 Public：公网访问类型的 Kubeconfig 文件。
CreateTime	String	2022-05-06T02:49:19Z	Kubeconfig 生成时间。标准 RFC3339 格式的 UTC+0 时间。
ExpireTime	String	2022-05-06T02:49:19Z	Kubeconfig 到期时间。标准 RFC3339 格式的 UTC+0 时间。
Kubeconfig	String	YXBpVmVyc2******	Kubeconfig 文本。以 Base64 编码返回。说明如果`Type=Public`但`ClusterIds`中指定的集群的`ClusterConfig.ApiServerPublicAccessEnabled=false`，则此处返回为空。
RoleId	Long	13******	角色 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "20220515130014****",
        "Action": "ListKubeconfigs",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10,
        "Items": [
            {
                "Id": "kc9q8pbfqtofn8j****",
                "UserId": 210000****,
                "ClusterId": "cc9q8pbfqtofn8j****",
                "Type": "Private",
                "CreateTime": "2022-05-06T02:49:19Z",
                "ExpireTime": "2022-05-06T02:49:19Z",
                "Kubeconfig": "YXBpVmVyc2lvbjogdj*********MUzB0TFMxQ*********TMHRDazFKU1xDUVVSQlRrS*********"
            }
        ]
    }
}

错误码

本接口无专有错误码，公共错误码请参见公共错误码。