获取k8s资源

接口说明

引入增强插件

在pom.xml文件中添加增强插件以提升 Executor 的能力。

注意：请确保该插件在 pom 中放置在xxl-job-core 依赖的上方。

详细信息请参考：插件版本说明文档

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-b6ec1xxxx
K8sClusterId	string	否	同步命名空间的 Kubernetes 集群 ID。Kubernetes 集群已添加到 ServiceMeshId 指定的服务网格中。若查询 k8s 命名空间或 k8s 服务时，该字段为必填。	cadb451ed7af04b0297f4be396a2196fc
K8sNamespace	string	否	k8s 集群的命名空间 ID。若查询 k8s 服务时，该字段为必填。	default
ResourceType	string	是	资源类型定义。	cluster
VpcId	string	否	VPC ID。若选择 ResourceType 值为 cluster 时，该字段为必填。	vpc-aa1a18236n90rqhuhhnhh

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21
Code	integer	响应码。	200
Message	string	错误信息。	Parameter error: content is null.
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	array<object>
data	object
ResourceName	string	k8s 资源名称	q_ecs_enterprise_spot_c
ResourceId	string	k8s 资源 ID	xxljob-01632622cda2f

示例

正常返回示例

JSON格式

{
  "RequestId": "2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21",
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": [
    {
      "ResourceName": "q_ecs_enterprise_spot_c",
      "ResourceId": "xxljob-01632622cda2f"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s
500	InternalError	InternalError: %s.	系统内部错误：%s

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-10-29	新增 OpenAPI	查看变更详情