文档中心

持续交付

部署资源

ListDeployResources

获取部署资源列表。

请求说明

为获得低延迟，建议您根据资源所在的地域选择对应的服务地址，详情参见服务地址。

请求方式：POST

请求地址：https://cp.cn-beijing.volcengineapi.com?Action=ListDeployResources&Version=2023-05-01

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListDeployResources	接口名称。当前 API 的名称为 ListDeployResources。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 2023-05-01。
PageNumber	Long	否	1	当前页码，用于分页查询部署资源列表。
PageSize	Long	否	10	每页返回的部署资源数量，用于分页查询。
Filter	Object of DRFilter	否	-	过滤参数，用于筛选部署资源列表。支持通过部署资源 ID、名称、来源、地域和工作区 ID 进行过滤。
HideKubeconfig	Boolean	否	false	是否在返回结果中隐藏 Kubeconfig 信息。支持以下取值： true：隐藏 Kubeconfig 信息。 false（默认）：不隐藏 Kubeconfig 信息。

DRFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["18be9***a1aca409f5e19c**"]	用于筛选部署资源的 ID 数组，支持通过多个 ID 进行精确匹配。
Name	String	否	test-cluster	搜索关键字，用于模糊匹配部署资源名称。默认为空字符串。
Source	String	否	VKE	部署资源的来源，用于筛选特定来源的部署资源。支持以下取值： VKE：容器服务集群。 K8S：自建或第三方 Kubernetes 集群。
Regions	Array of String	否	["cn-beijing"]	部署资源对应集群所属的地域数组，用于筛选特定地域的部署资源。
WorkspaceId	String	否	cp-ws-18be9***a1aca409f5e19c**	CP（持续交付平台）的工作区 ID，用于筛选归属于指定 CP 工作区的部署资源。支持跨环境（如开发、测试、生产）的部署资源过滤。

请求示例

POST https://cp.cn-beijing.volcengineapi.com?Action=ListDeployResources&Version=2023-05-01 HTTP/1.1​
Content-Type: application/json​
{​
    "PageNumber": 1,​
    "PageSize": 10,​
    "Filter": {​
        "Ids": [​
            "18be9a1aca409f5e19c****"​
        ],​
        "Name": "test",​
        "Source": "VKE",​
        "Regions": [​
            "cn-beijing"​
        ],​
        "WorkspaceId": "18be9*****a1aca409f5e19c****"​
    },​
    "HideKubeconfig": true​
}​

返回参数

参数	类型	示例值	描述
Total	Long	10	部署资源的总数，表示当前查询结果中符合条件的部署资源数量。
Items	Array of DeployResource	-	部署资源的列表，包含多个部署资源的详细信息。

DeployResource

参数	类型	示例值	描述
Id	String	18be9***a1aca409f5e19c**	部署资源的 ID。
Name	String	production-cluster-01	部署资源的名称，用于标识和区分不同的部署资源实例。
Owner	String	12**89,98**21	部署资源的所属人，通常以用户 ID 的形式表示，多个用户 ID 之间用逗号分隔。
Region	String	cn-beijing	部署资源对应集群所属的地域，用于标识部署资源所在的物理位置。
Source	String	VKE	部署资源的来源，用于筛选特定来源的部署资源。支持的取值如下所示。 VKE：容器服务集群。 K8S：自建或第三方 Kubernetes 集群。
Creator	String	123****4567	部署资源的创建人，通常以用户 ID 的形式表示，用于标识创建该部署资源的用户。
CreateTime	String	2023-05-01T12:00:00+08:00	部署资源的创建时间，采用 ISO 8601 格式，包含时区信息。
Identifier	String	deploy-resource-123	部署资源的 ID。
Kubeconfig	String	YXBpVmVyc2lvb****YTogKioqKioq	部署资源的 Kubeconfig 信息，采用 Base64 编码格式，仅当部署资源来源为自建或第三方 K8S 时返回。该信息用于访问和管理对应的 Kubernetes 集群。
UpdateTime	String	2023-05-01T12:10:00+08:00	部署资源的最近更新时间，采用 ISO 8601 格式，包含时区信息。该时间表示部署资源最后一次被修改的时间点。
Description	String	Kubernetes cluster deployment resource for production environment	部署资源的描述信息，用于说明该资源的用途或特性。
VkeClusterId	String	18be9***a1aca409f5e19c**	部署资源对应的容器服务（VKE）集群 ID，用于标识该部署资源关联的 VKE 集群。
SpecifiedWorkspaceIds	Array of String	["18be9***a1aca409f5e19c**"]	指定的工作区 ID 数组，用于标识该部署资源关联的工作区。
OnlyForSpecifiedWorkspaces	Boolean	false	标识该部署资源是否仅对指定的工作区开放。 true：仅 SpecifiedWorkspaceIds 中列出的工作区可以访问该资源。 false：默认值，所有工作区均可访问。

返回示例

HTTP/1.1 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****10023228002****",​
        "Action": "ListDeployResources",​
        "Version": "2023-05-01",​
        "Service": "cp",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Total": 10,​
        "Items": [​
            {​
                "Id": "18be9a1aca409f5e19c****",​
                "Name": "production-cluster-01",​
                "Owner": "123****89",​
                "Region": "cn-beijing",​
                "Source": "VKE",​
                "Creator": "123****4567",​
                "CreateTime": "2023-05-01T12:00:00+08:00",​
                "Identifier": "deploy-resource-123",​
                "Kubeconfig": "YXBpVmVyc2lvbjogdjEKY2x1c3Rl****YTogKioqKioq=",​
                "UpdateTime": "2023-05-01T12:10:00+08:00",​
                "Description": "Kubernetes cluster deployment resource for production environment",​
                "VkeClusterId": "18be9a1aca409f5e19c****",​
                "SpecifiedWorkspaceIds": [​
                    "18be9a1aca409f5e19c****"​
                ],​
                "OnlyForSpecifiedWorkspaces": false​
            }​
        ]​
    }​
}​

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2026.05.07 19:25:48

这个页面对您有帮助吗？

有用

无用