获取策略实例任务列表 - ListPolicyJobs

功能介绍

获取策略实例任务列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/policy/jobs

表1 Query参数
参数	是否必选	参数类型	描述
kind	否	String	指定的任务类型，没有则使用默认值EnablePolicy

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
items	Array of UCSJob objects	Job列表
kind	String	API类型
apiVersion	String	API版本

表4 UCSJob
参数	参数类型	描述
kind	String	API类型
apiVersion	String	API版本
metadata	ObjectMeta object	资源元数据
spec	UCSJobSpec object	Job的具体规范信息
status	UCSJobStatus object	Job的当前状态

表5 UCSJobSpec
参数	参数类型	描述
taskList	Array of UCSTask objects	任务列表
domainID	String	用户的domainID
operation	String	操作，create和retry二选一
waitTimeOut	Integer	Job等待时间，单位：秒
type	String	Job类别
relatedObjects	Map<String,String>	相关目标
extendParam	Map<String,Object>	额外参数

表6 UCSTask
参数	参数类型	描述
kind	String	API类型
apiVersion	String	API版本
metadata	ObjectMeta object	任务对象元数据
spec	UCSTaskSpec object	任务的详细配置信息
status	UCSTaskStatus object	任务的实际状态

表7 ObjectMeta
参数	参数类型	描述
uid	String	资源ID
name	String	资源名称
generateName	String	当未提供name时，服务器使用的前缀来生成唯一名称
namespace	String	命名空间
labels	Map<String,String>	标签
annotations	Map<String,String>	注解
creationTimestamp	String	创建时间
updateTimestamp	String	更新时间
resourceVersion	String	资源内部版本
generation	Integer	资源期望状态的代数
managedFields	Array of ManagedFieldsEntry objects	记录哪些字段由哪些工作流管理
ownerReferences	Array of OwnerReference objects	用于定义对象间所有权关系，管理对象的依赖关系和垃圾回收机制，支持控制器对资源的管理

表8 ManagedFieldsEntry
参数	参数类型	描述
manager	String	管理者的名称
operation	String	记录导致此条目创建的操作类型，只能是 Apply 或 Update 两种操作类型
apiVersion	String	该管理者定义字段时所依据的资源 API 版本
time	String	此管理条目被创建或最后一次更新的时间戳
fieldsType	String	固定为 "FieldsV1"，标记字段结构格式
fieldsV1	Object	用于存储实际被管理的字段信息

表9 OwnerReference
参数	参数类型	描述
apiVersion	String	标识引用对象的API版本
kind	String	引用对象的类型
name	String	引用对象的名称
uid	String	引用对象的uid
controller	Boolean	如果为true，表示该引用指向管理该资源的控制器
blockOwnerDeletion	Boolean	当为true且拥有者有名为"foregroundDeletion"的finalizer 时，会阻止拥有者被删除，直到这个引用被移除

**表10** UCSTaskSpec
参数	参数类型	描述
jobID	String	所属job的ID
target	String	执行目标
targetType	String	执行目标类型
waitTimeOut	Integer	Task执行等待时间，单位：秒
type	String	Task类别
runway	String	执行方式：parallel和serial二选一

**表11** UCSTaskStatus
参数	参数类型	描述
status	String	状态
reason	String	当前状态原因
startTime	String	开始时间
finishTime	String	结束时间

**表12** UCSJobStatus
参数	参数类型	描述
status	String	Job状态： Running：运行中 TimedOut：运行超时 Succeeded：运行成功 Failed：运行失败
reason	String	原因
startTime	String	开始时间
finishTime	String	结束时间

状态码：500

**表13** 响应Body参数
参数	参数类型	描述
-	String	-

请求示例

无

响应示例

状态码：200

任务列表

{
  "items" : [ {
    "kind" : "job",
    "apiVersion" : "job.workflow.io/v1alpha1",
    "metadata" : {
      "name" : "UpdateConstraint_2ea2e874",
      "uid" : "c7678551-1f7e-4699-9ea1-3baa2d32f552",
      "creationTimestamp" : "2025-11-10 07:24:03.529155 +0000 UTC",
      "updateTimestamp" : "2025-11-10 07:24:08.526889 +0000 UTC"
    },
    "spec" : {
      "taskList" : [ {
        "kind" : "task",
        "apiVersion" : "task.workflow.io/v1alpha1",
        "metadata" : {
          "name" : "be72df63-7dfa-426d-acc9-6c426c4e979c",
          "uid" : "b387d7e9-b99f-4914-acf6-cd666b7473aa",
          "creationTimestamp" : "2025-11-10 07:24:03.536701 +0000 UTC",
          "updateTimestamp" : "2025-11-10 07:24:08.513561 +0000 UTC"
        },
        "spec" : {
          "jobID" : "c7678551-1f7e-4699-9ea1-3baa2d32f552",
          "target" : "be72df63-7dfa-426d-acc9-6c426c4e979c",
          "targetType" : "cluster",
          "type" : "UpdateConstraint",
          "runway" : "parallel",
          "waitTimeOut" : 3600
        },
        "status" : {
          "status" : "Succeeded",
          "startTime" : "2025-11-10T15:24:03.553733+08:00",
          "finishTime" : "2025-11-10T15:24:04.689462+08:00"
        }
      } ],
      "domainID" : "05495693d180d3c90f9ec0171879f760",
      "operation" : "create",
      "waitTimeOut" : 3600,
      "type" : "UpdateConstraint",
      "extendParam" : {
        "constraintID" : "eb6e4196-1508-49d3-98a5-ee656d146c4f"
      }
    },
    "status" : {
      "status" : "Succeeded",
      "startTime" : "2025-11-10T15:24:03.540316+08:00",
      "finishTime" : "2025-11-10T15:24:08.524767+08:00"
    }
  }, {
    "kind" : "job",
    "apiVersion" : "job.workflow.io/v1alpha1",
    "metadata" : {
      "name" : "CreateConstraint_a6b24118",
      "uid" : "5b0367b3-6651-4cef-8a4b-f93f377db5a4",
      "creationTimestamp" : "2025-11-10 07:23:12.442745 +0000 UTC",
      "updateTimestamp" : "2025-11-10 07:23:13.415506 +0000 UTC"
    },
    "spec" : {
      "taskList" : [ {
        "kind" : "task",
        "apiVersion" : "task.workflow.io/v1alpha1",
        "metadata" : {
          "name" : "be72df63-7dfa-426d-acc9-6c426c4e979c",
          "uid" : "866f323a-dbfa-4925-9324-f68c936c9992",
          "creationTimestamp" : "2025-11-10 07:23:12.451539 +0000 UTC",
          "updateTimestamp" : "2025-11-10 07:23:13.406122 +0000 UTC"
        },
        "spec" : {
          "jobID" : "5b0367b3-6651-4cef-8a4b-f93f377db5a4",
          "target" : "be72df63-7dfa-426d-acc9-6c426c4e979c",
          "targetType" : "cluster",
          "type" : "CreateConstraint",
          "runway" : "parallel",
          "waitTimeOut" : 3600
        },
        "status" : {
          "status" : "Succeeded",
          "startTime" : "2025-11-10T15:23:12.60286+08:00",
          "finishTime" : "2025-11-10T15:23:12.808264+08:00"
        }
      } ],
      "domainID" : "05495693d180d3c90f9ec0171879f760",
      "operation" : "create",
      "waitTimeOut" : 3600,
      "type" : "CreateConstraint",
      "relatedObjects" : {
        "fleet" : "1bb7effb-2afc-4eb1-9818-8de8a2bd9c80"
      },
      "extendParam" : {
        "constraintID" : "5044f128-0162-489a-b00f-3880c3f47832"
      }
    },
    "status" : {
      "status" : "Succeeded",
      "startTime" : "2025-11-10T15:23:12.455389+08:00",
      "finishTime" : "2025-11-10T15:23:13.414079+08:00"
    }
  } ]
}