Spring Cloud Data Flow参考指南（七）

44.5.5. 删除单个流定义

流终结点允许您删除单个流定义。 （另请参阅：删除所有流定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

DELETE /streams/definitions/timelog HTTP/1.1
Host: localhost:9393

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/definitions/timelog' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.5.6. 删除所有流定义

流终结点允许您删除所有单个流定义。 （另请参阅：删除单个流定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

DELETE /streams/definitions HTTP/1.1
Host: localhost:9393

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/definitions' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.6. 流验证

流验证终结点允许你验证流定义中的应用。 以下主题提供了更多详细信息：

• 请求结构
• 路径参数
• 示例请求
• 响应结构

44.6.1. 请求结构

GET /streams/validation/timelog HTTP/1.1
Host: localhost:9393

44.6.2. 路径参数

/streams/validation/{name}

44.6.3. 示例请求

$ curl 'http://localhost:9393/streams/validation/timelog' -i -X GET

44.6.4. 响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 197

{
  "appName" : "timelog",
  "dsl" : "time --format='YYYY MM DD' | log",
  "description" : "Demo stream for testing",
  "appStatuses" : {
    "source:time" : "valid",
    "sink:log" : "valid"
  }
}

44.7. 流部署

部署定义端点提供有关向 Spring 云数据流服务器注册的部署的信息。 以下主题提供了更多详细信息：

• 部署流定义
• 取消部署流定义
• 取消部署所有流定义
• 更新已部署的流
• 回滚流定义
• 获取清单
• 获取部署历史记录
• 获取部署平台
• 规模流定义

44.7.1. 部署流定义

流定义终结点允许您部署单个流定义。 （可选）可以将应用程序参数作为属性传递到请求正文中。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /streams/deployments/timelog HTTP/1.1
Content-Type: application/json
Content-Length: 36
Host: localhost:9393

{"app.time.timestamp.format":"YYYY"}

/streams/deployments/{timelog}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments/timelog' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"app.time.timestamp.format":"YYYY"}'

响应结构

HTTP/1.1 201 Created

44.7.2. 取消部署流定义

流定义终结点允许您取消部署单个流定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

DELETE /streams/deployments/timelog HTTP/1.1
Host: localhost:9393

/streams/deployments/{timelog}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments/timelog' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.7.3. 取消部署所有流定义

流定义终结点允许取消部署所有单个流定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

DELETE /streams/deployments HTTP/1.1
Host: localhost:9393

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.7.4. 更新已部署的流

借助 Skipper，您可以更新已部署的流，并提供其他部署属性。

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /streams/deployments/update/timelog1 HTTP/1.1
Content-Type: application/json
Content-Length: 196
Host: localhost:9393

{"releaseName":"timelog1","packageIdentifier":{"repositoryName":"test","packageName":"timelog1","packageVersion":"1.0.0"},"updateProperties":{"app.time.timestamp.format":"YYYYMMDD"},"force":false}

/streams/deployments/update/{timelog1}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments/update/timelog1' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"releaseName":"timelog1","packageIdentifier":{"repositoryName":"test","packageName":"timelog1","packageVersion":"1.0.0"},"updateProperties":{"app.time.timestamp.format":"YYYYMMDD"},"force":false}'

响应结构

HTTP/1.1 201 Created

44.7.5. 回滚流定义

将流回滚到流的先前版本或特定版本。

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /streams/deployments/rollback/timelog1/1 HTTP/1.1
Content-Type: application/json
Host: localhost:9393

/streams/deployments/rollback/{name}/{version}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments/rollback/timelog1/1' -i -X POST \
    -H 'Content-Type: application/json'

响应结构

HTTP/1.1 201 Created

44.7.6. 获取清单

返回已发布版本的清单。对于具有依赖项的包，清单包含这些依赖项的内容。

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /streams/deployments/manifest/timelog1/1 HTTP/1.1
Content-Type: application/json
Host: localhost:9393

/streams/deployments/manifest/{name}/{version}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments/manifest/timelog1/1' -i -X GET \
    -H 'Content-Type: application/json'

响应结构

HTTP/1.1 200 OK

44.7.7. 获取部署历史记录

获取流的部署历史记录。

• 请求结构
• 示例请求
• 响应结构

请求结构

GET /streams/deployments/history/timelog1 HTTP/1.1
Content-Type: application/json
Host: localhost:9393

示例请求

$ curl 'http://localhost:9393/streams/deployments/history/timelog1' -i -X GET \
    -H 'Content-Type: application/json'

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 162

[ {
  "name" : null,
  "version" : 0,
  "info" : null,
  "pkg" : null,
  "configValues" : {
    "raw" : null
  },
  "manifest" : null,
  "platformName" : null
} ]

44.7.8. 获取部署平台

检索支持的部署平台的列表。

• 请求结构
• 示例请求
• 响应结构

请求结构

GET /streams/deployments/platform/list HTTP/1.1
Content-Type: application/json
Host: localhost:9393

示例请求

$ curl 'http://localhost:9393/streams/deployments/platform/list' -i -X GET \
    -H 'Content-Type: application/json'

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 106

[ {
  "id" : null,
  "name" : "default",
  "type" : "local",
  "description" : null,
  "options" : [ ]
} ]

44.7.9. 规模流定义

流定义终结点允许在流定义中缩放单个应用。 （可选）可以将应用程序参数作为属性传递到请求正文中。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /streams/deployments/scale/timelog/log/instances/1 HTTP/1.1
Content-Type: application/json
Content-Length: 36
Host: localhost:9393

{"app.time.timestamp.format":"YYYY"}

/streams/deployments/scale/{streamName}/{appName}/instances/{count}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/streams/deployments/scale/timelog/log/instances/1' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"app.time.timestamp.format":"YYYY"}'

响应结构

HTTP/1.1 201 Created

44.8. 任务定义

任务定义端点提供有关向 Spring 云数据流服务器注册的任务定义的信息。 以下主题提供了更多详细信息：

• 创建新的任务定义
• 列出所有任务定义
• 检索任务定义详细信息
• 删除任务定义

44.8.1. 创建新的任务定义

任务定义终结点允许您创建新的任务定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /tasks/definitions HTTP/1.1
Host: localhost:9393
Content-Type: application/x-www-form-urlencoded

name=my-task&definition=timestamp+--format%3D%27YYYY+MM+DD%27&description=Demo+task+definition+for+testing

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/definitions' -i -X POST \
    -d 'name=my-task&definition=timestamp+--format%3D%27YYYY+MM+DD%27&description=Demo+task+definition+for+testing'

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 342

{
  "name" : "my-task",
  "dslText" : "timestamp --format='YYYY MM DD'",
  "description" : "Demo task definition for testing",
  "composed" : false,
  "composedTaskElement" : false,
  "lastTaskExecution" : null,
  "status" : "UNKNOWN",
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/definitions/my-task"
    }
  }
}

44.8.2. 列出所有任务定义

任务定义终结点允许您获取所有任务定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/definitions?page=0&size=10&sort=taskName%2CASC&search=&manifest=true HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/definitions?page=0&size=10&sort=taskName%2CASC&search=&manifest=true' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 689

{
  "_embedded" : {
    "taskDefinitionResourceList" : [ {
      "name" : "my-task",
      "dslText" : "timestamp --format='YYYY MM DD'",
      "description" : "Demo task definition for testing",
      "composed" : false,
      "composedTaskElement" : false,
      "lastTaskExecution" : null,
      "status" : "UNKNOWN",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/tasks/definitions/my-task"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/definitions?page=0&size=10&sort=taskName,asc"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.8.3. 检索任务定义详细信息

任务定义终结点允许您获取单个任务定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/definitions/my-task?manifest=true HTTP/1.1
Host: localhost:9393

/tasks/definitions/{my-task}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/tasks/definitions/my-task?manifest=true' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 342

{
  "name" : "my-task",
  "dslText" : "timestamp --format='YYYY MM DD'",
  "description" : "Demo task definition for testing",
  "composed" : false,
  "composedTaskElement" : false,
  "lastTaskExecution" : null,
  "status" : "UNKNOWN",
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/definitions/my-task"
    }
  }
}

44.8.4. 删除任务定义

任务定义终结点允许您删除单个任务定义。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

DELETE /tasks/definitions/my-task?cleanup=true HTTP/1.1
Host: localhost:9393

/tasks/definitions/{my-task}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/tasks/definitions/my-task?cleanup=true' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.9. 任务调度程序

任务计划程序终结点提供有关向计划程序实现注册的任务计划的信息。 以下主题提供了更多详细信息：

• 创建新的任务计划
• 列出所有时间表
• 列出筛选的计划
• 删除任务计划

44.9.1. 创建新的任务计划

任务计划终结点允许您创建新的任务计划。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /tasks/schedules HTTP/1.1
Host: localhost:9393
Content-Type: application/x-www-form-urlencoded

scheduleName=myschedule&taskDefinitionName=mytaskname&properties=scheduler.cron.expression%3D00+22+17+%3F+*&arguments=--foo%3Dbar

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/schedules' -i -X POST \
    -d 'scheduleName=myschedule&taskDefinitionName=mytaskname&properties=scheduler.cron.expression%3D00+22+17+%3F+*&arguments=--foo%3Dbar'

响应结构

HTTP/1.1 201 Created

44.9.2. 列出所有时间表

任务计划终结点允许获取所有任务计划。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/schedules?page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/schedules?page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 587

{
  "_embedded" : {
    "scheduleInfoResourceList" : [ {
      "scheduleName" : "FOO",
      "taskDefinitionName" : "BAR",
      "scheduleProperties" : {
        "scheduler.AAA.spring.cloud.scheduler.cron.expression" : "00 41 17 ? * *"
      },
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/tasks/schedules/FOO"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/schedules?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.9.3. 列出过滤的计划

任务计划终结点允许获取具有指定任务定义名称的所有任务计划。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/schedules/instances/FOO?page=0&size=10 HTTP/1.1
Host: localhost:9393

/tasks/schedules/instances/{task-definition-name}

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/schedules/instances/FOO?page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 599

{
  "_embedded" : {
    "scheduleInfoResourceList" : [ {
      "scheduleName" : "FOO",
      "taskDefinitionName" : "BAR",
      "scheduleProperties" : {
        "scheduler.AAA.spring.cloud.scheduler.cron.expression" : "00 41 17 ? * *"
      },
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/tasks/schedules/FOO"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/schedules/instances/FOO?page=0&size=1"
    }
  },
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.9.4. 删除任务计划

任务计划终结点允许您删除单个任务计划。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

DELETE /tasks/schedules/mytestschedule HTTP/1.1
Host: localhost:9393

/任务/计划/{计划名称}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/tasks/schedules/mytestschedule' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.10. 任务验证

任务验证终结点允许您验证任务定义中的应用。 以下主题提供了更多详细信息：

• 请求结构
• 路径参数
• 示例请求
• 响应结构

44.10.1. 请求结构

GET /tasks/validation/taskC HTTP/1.1
Host: localhost:9393

44.10.2. 路径参数

/tasks/validation/{name}

44.10.3. 示例请求

$ curl 'http://localhost:9393/tasks/validation/taskC' -i -X GET

44.10.4. 响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 144

{
  "appName" : "taskC",
  "dsl" : "timestamp --format='yyyy MM dd'",
  "description" : "",
  "appStatuses" : {
    "task:taskC" : "valid"
  }
}

44.11. 任务执行

任务执行端点提供有关向 Spring 云数据流服务器注册的任务执行的信息。 以下主题提供了更多详细信息：

• 启动任务
• 停止任务
• 列出所有任务执行
• 列出具有指定任务名称的所有任务执行
• 任务执行详细信息
• 删除任务执行
• 任务执行当前计数

44.11.1. 启动任务

通过请求创建新任务执行来完成启动任务。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /tasks/executions HTTP/1.1
Host: localhost:9393
Content-Type: application/x-www-form-urlencoded

name=taskA&properties=app.my-task.foo%3Dbar%2Cdeployer.my-task.something-else%3D3&arguments=--server.port%3D8080+--foo%3Dbar

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/executions' -i -X POST \
    -d 'name=taskA&properties=app.my-task.foo%3Dbar%2Cdeployer.my-task.something-else%3D3&arguments=--server.port%3D8080+--foo%3Dbar'

响应结构

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1

1

44.11.2. 停止任务

停止任务是通过发布现有任务执行的 ID 来完成的。 以下主题提供了更多详细信息：

• 请求结构
• 路径参数
• 请求参数
• 示例请求
• 响应结构

请求结构

POST /tasks/executions/1 HTTP/1.1
Host: localhost:9393
Content-Type: application/x-www-form-urlencoded

platform=default

路径参数

/tasks/executions/{id}

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/executions/1' -i -X POST \
    -d 'platform=default'

响应结构

HTTP/1.1 200 OK

44.11.3. 列出所有任务执行

任务执行终结点允许您列出所有任务执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/executions?page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/executions?page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 2711

{
  "_embedded" : {
    "taskExecutionResourceList" : [ {
      "executionId" : 2,
      "exitCode" : null,
      "taskName" : "taskB",
      "startTime" : null,
      "endTime" : null,
      "exitMessage" : null,
      "arguments" : [ ],
      "jobExecutionIds" : [ ],
      "errorMessage" : null,
      "externalExecutionId" : "taskB-dbdd3ed6-e4d0-423a-a76f-605609f89b37",
      "parentExecutionId" : null,
      "resourceUrl" : "org.springframework.cloud.task.app:timestamp-task:jar:1.2.0.RELEASE",
      "appProperties" : {
        "management.metrics.tags.service" : "task-application",
        "timestamp.format" : "yyyy MM dd",
        "spring.datasource.username" : null,
        "spring.datasource.url" : null,
        "spring.datasource.driverClassName" : null,
        "management.metrics.tags.application" : "${spring.cloud.task.name:unknown}-${spring.cloud.task.executionid:unknown}",
        "spring.cloud.task.name" : "taskB"
      },
      "deploymentProperties" : {
        "app.my-task.foo" : "bar",
        "deployer.my-task.something-else" : "3"
      },
      "platformName" : "default",
      "taskExecutionStatus" : "UNKNOWN",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/tasks/executions/2"
        }
      }
    }, {
      "executionId" : 1,
      "exitCode" : null,
      "taskName" : "taskA",
      "startTime" : null,
      "endTime" : null,
      "exitMessage" : null,
      "arguments" : [ ],
      "jobExecutionIds" : [ ],
      "errorMessage" : null,
      "externalExecutionId" : "taskA-2c9b99b9-3f50-4375-80d1-b5a084a42406",
      "parentExecutionId" : null,
      "resourceUrl" : "org.springframework.cloud.task.app:timestamp-task:jar:1.2.0.RELEASE",
      "appProperties" : {
        "management.metrics.tags.service" : "task-application",
        "timestamp.format" : "yyyy MM dd",
        "spring.datasource.username" : null,
        "spring.datasource.url" : null,
        "spring.datasource.driverClassName" : null,
        "management.metrics.tags.application" : "${spring.cloud.task.name:unknown}-${spring.cloud.task.executionid:unknown}",
        "spring.cloud.task.name" : "taskA"
      },
      "deploymentProperties" : {
        "app.my-task.foo" : "bar",
        "deployer.my-task.something-else" : "3"
      },
      "platformName" : "default",
      "taskExecutionStatus" : "UNKNOWN",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/tasks/executions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/executions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

44.11.4. 列出所有具有指定任务名称的任务执行

任务执行终结点允许您列出具有指定任务名称的任务执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/executions?name=taskB&page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/tasks/executions?name=taskB&page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1492

{
  "_embedded" : {
    "taskExecutionResourceList" : [ {
      "executionId" : 2,
      "exitCode" : null,
      "taskName" : "taskB",
      "startTime" : null,
      "endTime" : null,
      "exitMessage" : null,
      "arguments" : [ ],
      "jobExecutionIds" : [ ],
      "errorMessage" : null,
      "externalExecutionId" : "taskB-dbdd3ed6-e4d0-423a-a76f-605609f89b37",
      "parentExecutionId" : null,
      "resourceUrl" : "org.springframework.cloud.task.app:timestamp-task:jar:1.2.0.RELEASE",
      "appProperties" : {
        "management.metrics.tags.service" : "task-application",
        "timestamp.format" : "yyyy MM dd",
        "spring.datasource.username" : null,
        "spring.datasource.url" : null,
        "spring.datasource.driverClassName" : null,
        "management.metrics.tags.application" : "${spring.cloud.task.name:unknown}-${spring.cloud.task.executionid:unknown}",
        "spring.cloud.task.name" : "taskB"
      },
      "deploymentProperties" : {
        "app.my-task.foo" : "bar",
        "deployer.my-task.something-else" : "3"
      },
      "platformName" : "default",
      "taskExecutionStatus" : "UNKNOWN",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/tasks/executions/2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/executions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.11.5. 任务执行细节

任务执行终结点允许您获取有关任务执行的详细信息。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /tasks/executions/1 HTTP/1.1
Host: localhost:9393

/tasks/executions/{id}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/tasks/executions/1' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1085

{
  "executionId" : 1,
  "exitCode" : null,
  "taskName" : "taskA",
  "startTime" : null,
  "endTime" : null,
  "exitMessage" : null,
  "arguments" : [ ],
  "jobExecutionIds" : [ ],
  "errorMessage" : null,
  "externalExecutionId" : "taskA-2c9b99b9-3f50-4375-80d1-b5a084a42406",
  "parentExecutionId" : null,
  "resourceUrl" : "org.springframework.cloud.task.app:timestamp-task:jar:1.2.0.RELEASE",
  "appProperties" : {
    "management.metrics.tags.service" : "task-application",
    "timestamp.format" : "yyyy MM dd",
    "spring.datasource.username" : null,
    "spring.datasource.url" : null,
    "spring.datasource.driverClassName" : null,
    "management.metrics.tags.application" : "${spring.cloud.task.name:unknown}-${spring.cloud.task.executionid:unknown}",
    "spring.cloud.task.name" : "taskA"
  },
  "deploymentProperties" : {
    "app.my-task.foo" : "bar",
    "deployer.my-task.something-else" : "3"
  },
  "platformName" : "default",
  "taskExecutionStatus" : "UNKNOWN",
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/tasks/executions/1"
    }
  }
}

44.11.6. 删除任务执行

任务执行终端节点允许您：

• 清理用于部署任务的资源
• 从持久性存储中删除相关任务数据以及可能关联的 Spring Batch 作业数据

以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

有关删除任务执行数据，请参阅以下部分。

请求结构

DELETE /tasks/executions/1,2?action=CLEANUP,REMOVE_DATA HTTP/1.1
Host: localhost:9393

/tasks/executions/{ids}

请求参数

此终结点支持一个名为action 的可选请求参数。它是一个枚举，支持以下内容 值：

• 清理
• REMOVE_DATA

示例请求

$ curl 'http://localhost:9393/tasks/executions/1,2?action=CLEANUP,REMOVE_DATA' -i -X DELETE

响应结构

HTTP/1.1 200 OK

44.11.7. 删除任务执行数据

您不仅可以清理用于部署任务的资源，还可以删除与 从基础持久性存储执行任务。此外，如果任务执行与一个或 更多的批处理作业执行，这些也被删除。

以下示例说明了如何使用多个任务执行 ID 和多个操作发出请求：

$ curl 'http://localhost:9393/tasks/executions/1,2?action=CLEANUP,REMOVE_DATA' -i -X DELETE

/tasks/executions/{ids}

44.11.8. 任务执行当前计数

任务执行当前终结点允许您检索当前正在运行的执行数。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

api-guide.adoc 中未解决的指令 - 包括：：/home/runner/work/spring-cloud-dataflow/spring-cloud-dataflow/spring-cloud-dataflow-docs/../spring-cloud-dataflow-classic-docs/target/generated-snippets/task-executions-documentation/launch-task-current-count/http-request.adoc[]

请求参数

此终结点没有请求参数。

示例请求

api-guide.adoc 中未解决的指令 - 包括：：/home/runner/work/spring-cloud-dataflow/spring-cloud-dataflow/spring-cloud-dataflow-docs/../spring-cloud-dataflow-classic-docs/target/generated-snippets/task-executions-documentation/launch-task-current-count/curl-request.adoc[]

响应结构

api-guide.adoc 中未解决的指令 - 包括：：/home/runner/work/spring-cloud-dataflow/spring-cloud-dataflow/spring-cloud-dataflow-docs/../spring-cloud-dataflow-classic-docs/target/generated-snippets/task-executions-documentation/launch-task-current-count/http-response.adoc[]

44.12. 作业执行

作业执行端点提供有关向 Spring 云数据流服务器注册的作业执行的信息。 以下主题提供了更多详细信息：

• 列出所有作业执行
• 列出不包括步骤执行的所有作业执行
• 列出具有指定作业名称的所有作业执行
• 列出具有指定作业名称的所有作业执行，不包括步骤执行
• 列出指定日期范围内的所有作业执行，不包括步骤执行
• 列出指定作业实例 ID 的所有作业执行，不包括步骤执行
• 列出指定任务执行 ID 的所有作业执行，不包括步骤执行
• 作业执行详细信息
• 停止作业执行
• 重新启动作业执行

44.12.1. 列出所有作业执行

作业执行终结点允许您列出所有作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/executions?page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/executions?page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3066

{
  "_embedded" : {
    "jobExecutionResourceList" : [ {
      "executionId" : 2,
      "stepExecutionCount" : 0,
      "jobId" : 2,
      "taskExecutionId" : 2,
      "name" : "DOCJOB1",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "duration" : "00:00:01",
      "jobExecution" : {
        "id" : 2,
        "version" : 1,
        "jobParameters" : {
          "parameters" : { }
        },
        "jobInstance" : {
          "id" : 2,
          "jobName" : "DOCJOB1",
          "version" : null
        },
        "stepExecutions" : [ ],
        "status" : "STOPPED",
        "startTime" : "2022-09-13T10:56:08.255+0000",
        "createTime" : "2022-09-13T10:56:08.252+0000",
        "endTime" : null,
        "lastUpdated" : "2022-09-13T10:56:08.255+0000",
        "exitStatus" : {
          "exitCode" : "UNKNOWN",
          "exitDescription" : ""
        },
        "executionContext" : {
          "dirty" : false,
          "empty" : true,
          "values" : [ ]
        },
        "failureExceptions" : [ ],
        "jobConfigurationName" : null,
        "allFailureExceptions" : [ ]
      },
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : true,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : true,
      "timeZone" : "UTC",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/executions/2"
        }
      }
    }, {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "duration" : "00:00:01",
      "jobExecution" : {
        "id" : 1,
        "version" : 2,
        "jobParameters" : {
          "parameters" : { }
        },
        "jobInstance" : {
          "id" : 1,
          "jobName" : "DOCJOB",
          "version" : null
        },
        "stepExecutions" : [ ],
        "status" : "STOPPING",
        "startTime" : "2022-09-13T10:56:08.246+0000",
        "createTime" : "2022-09-13T10:56:08.244+0000",
        "endTime" : null,
        "lastUpdated" : "2022-09-13T10:56:08.336+0000",
        "exitStatus" : {
          "exitCode" : "UNKNOWN",
          "exitDescription" : ""
        },
        "executionContext" : {
          "dirty" : false,
          "empty" : true,
          "values" : [ ]
        },
        "failureExceptions" : [ ],
        "jobConfigurationName" : null,
        "allFailureExceptions" : [ ]
      },
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : false,
      "timeZone" : "UTC",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/executions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/executions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.2. 列出所有不包含步骤执行的作业执行

作业执行终结点允许您列出所有作业执行，但不包括步骤执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/thinexecutions?page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/thinexecutions?page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1604

{
  "_embedded" : {
    "jobExecutionThinResourceList" : [ {
      "executionId" : 2,
      "stepExecutionCount" : 0,
      "jobId" : 2,
      "taskExecutionId" : 2,
      "instanceId" : 2,
      "name" : "DOCJOB1",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.255+0000",
      "duration" : "00:00:00",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : true,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : true,
      "timeZone" : "UTC",
      "status" : "STOPPED",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/2"
        }
      }
    }, {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "instanceId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.246+0000",
      "duration" : "00:00:00",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : false,
      "stoppable" : true,
      "defined" : false,
      "timeZone" : "UTC",
      "status" : "STARTED",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/thinexecutions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.3. 列出具有指定作业名称的所有作业执行

作业执行终结点允许您列出所有作业执行。 以下主题提供了更多详细信息：

• ​​请求结构​​
• ​​请求参数​​
• ​​示例请求​​
• ​​响应结构​​

请求结构

GET /jobs/executions?name=DOCJOB&page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/executions?name=DOCJOB&page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1669

{
  "_embedded" : {
    "jobExecutionResourceList" : [ {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "duration" : "00:00:01",
      "jobExecution" : {
        "id" : 1,
        "version" : 2,
        "jobParameters" : {
          "parameters" : { }
        },
        "jobInstance" : {
          "id" : 1,
          "jobName" : "DOCJOB",
          "version" : null
        },
        "stepExecutions" : [ ],
        "status" : "STOPPING",
        "startTime" : "2022-09-13T10:56:08.246+0000",
        "createTime" : "2022-09-13T10:56:08.244+0000",
        "endTime" : null,
        "lastUpdated" : "2022-09-13T10:56:08.336+0000",
        "exitStatus" : {
          "exitCode" : "UNKNOWN",
          "exitDescription" : ""
        },
        "executionContext" : {
          "dirty" : false,
          "empty" : true,
          "values" : [ ]
        },
        "failureExceptions" : [ ],
        "jobConfigurationName" : null,
        "allFailureExceptions" : [ ]
      },
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : false,
      "timeZone" : "UTC",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/executions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/executions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.4. 列出所有具有指定作业名称的作业执行，不包括步骤执行

作业执行终结点允许您列出所有作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/thinexecutions?name=DOCJOB&page=0&size=10 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/thinexecutions?name=DOCJOB&page=0&size=10' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 943

{
  "_embedded" : {
    "jobExecutionThinResourceList" : [ {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "instanceId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.246+0000",
      "duration" : "00:00:01",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : false,
      "timeZone" : "UTC",
      "status" : "STOPPING",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/thinexecutions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.5. 列出指定日期范围内的所有作业执行，不包括步骤执行

作业执行终结点允许您列出所有作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/thinexecutions?page=0&size=10&fromDate=2000-09-24T17%3A00%3A45%2C000&toDate=2050-09-24T18%3A00%3A45%2C000 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/thinexecutions?page=0&size=10&fromDate=2000-09-24T17%3A00%3A45%2C000&toDate=2050-09-24T18%3A00%3A45%2C000' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1605

{
  "_embedded" : {
    "jobExecutionThinResourceList" : [ {
      "executionId" : 2,
      "stepExecutionCount" : 0,
      "jobId" : 2,
      "taskExecutionId" : 2,
      "instanceId" : 2,
      "name" : "DOCJOB1",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.255+0000",
      "duration" : "00:00:01",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : true,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : true,
      "timeZone" : "UTC",
      "status" : "STOPPED",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/2"
        }
      }
    }, {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "instanceId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.246+0000",
      "duration" : "00:00:01",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : false,
      "timeZone" : "UTC",
      "status" : "STOPPING",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/thinexecutions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.6. 列出指定作业实例 ID 的所有作业执行，不包括步骤执行

作业执行终结点允许您列出所有作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/thinexecutions?page=0&size=10&jobInstanceId=1 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/thinexecutions?page=0&size=10&jobInstanceId=1' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 943

{
  "_embedded" : {
    "jobExecutionThinResourceList" : [ {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "instanceId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.246+0000",
      "duration" : "00:00:01",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : false,
      "timeZone" : "UTC",
      "status" : "STOPPING",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/thinexecutions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.7. 列出指定任务执行 ID 的所有作业执行，不包括步骤执行

作业执行终结点允许您列出所有作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/thinexecutions?page=0&size=10&taskExecutionId=1 HTTP/1.1
Host: localhost:9393

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/thinexecutions?page=0&size=10&taskExecutionId=1' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 943

{
  "_embedded" : {
    "jobExecutionThinResourceList" : [ {
      "executionId" : 1,
      "stepExecutionCount" : 0,
      "jobId" : 1,
      "taskExecutionId" : 1,
      "instanceId" : 1,
      "name" : "DOCJOB",
      "startDate" : "2022-09-13",
      "startTime" : "10:56:08",
      "startDateTime" : "2022-09-13T10:56:08.246+0000",
      "duration" : "00:00:01",
      "jobParameters" : { },
      "jobParametersString" : "",
      "restartable" : false,
      "abandonable" : true,
      "stoppable" : false,
      "defined" : false,
      "timeZone" : "UTC",
      "status" : "STOPPING",
      "_links" : {
        "self" : {
          "href" : "http://localhost:9393/jobs/thinexecutions/1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/thinexecutions?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

44.12.8. 作业执行细节

通过作业执行终结点，可以获取有关作业执行的详细信息。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

GET /jobs/executions/2 HTTP/1.1
Host: localhost:9393

/jobs/executions/{id}

请求参数

此终结点没有请求参数。

示例请求

$ curl 'http://localhost:9393/jobs/executions/2' -i -X GET

响应结构

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1188

{
  "executionId" : 2,
  "stepExecutionCount" : 0,
  "jobId" : 2,
  "taskExecutionId" : 2,
  "name" : "DOCJOB1",
  "startDate" : "2022-09-13",
  "startTime" : "10:56:08",
  "duration" : "00:00:01",
  "jobExecution" : {
    "id" : 2,
    "version" : 1,
    "jobParameters" : {
      "parameters" : { }
    },
    "jobInstance" : {
      "id" : 2,
      "jobName" : "DOCJOB1",
      "version" : 0
    },
    "stepExecutions" : [ ],
    "status" : "STOPPED",
    "startTime" : "2022-09-13T10:56:08.255+0000",
    "createTime" : "2022-09-13T10:56:08.252+0000",
    "endTime" : null,
    "lastUpdated" : "2022-09-13T10:56:08.255+0000",
    "exitStatus" : {
      "exitCode" : "UNKNOWN",
      "exitDescription" : ""
    },
    "executionContext" : {
      "dirty" : false,
      "empty" : true,
      "values" : [ ]
    },
    "failureExceptions" : [ ],
    "jobConfigurationName" : null,
    "allFailureExceptions" : [ ]
  },
  "jobParameters" : { },
  "jobParametersString" : "",
  "restartable" : true,
  "abandonable" : true,
  "stoppable" : false,
  "defined" : true,
  "timeZone" : "UTC",
  "_links" : {
    "self" : {
      "href" : "http://localhost:9393/jobs/executions/2"
    }
  }
}

44.12.9. 停止作业执行

作业执行终结点允许您停止作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

PUT /jobs/executions/1 HTTP/1.1
Accept: application/json
Host: localhost:9393
Content-Type: application/x-www-form-urlencoded

stop=true

/jobs/executions/{id}

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/executions/1' -i -X PUT \
    -H 'Accept: application/json' \
    -d 'stop=true'

响应结构

HTTP/1.1 200 OK

44.12.10. 重新启动作业执行

作业执行终结点允许您重新启动作业执行。 以下主题提供了更多详细信息：

• 请求结构
• 请求参数
• 示例请求
• 响应结构

请求结构

PUT /jobs/executions/2 HTTP/1.1
Accept: application/json
Host: localhost:9393
Content-Type: application/x-www-form-urlencoded

restart=true

/jobs/executions/{id}

请求参数

示例请求

$ curl 'http://localhost:9393/jobs/executions/2' -i -X PUT \
    -H 'Accept: application/json' \
    -d 'restart=true'

响应结构

HTTP/1.1 200 OK