您可以通过ModifyInstanceState修改运行实例的状态,实现对实例的操作。

调试

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

请求头

您可以使用公共请求参数和该接口必填参数。公共请求参数请参见OpenAPI>调用方式>公共请求参数文档。

请求语法

PUT /api/v2/projects/[projectName]/jobs/[jobName]/instances/[instanceId]/expectstate HTTPS

请求参数

名称 类型 是否必选 示例值 描述
expectState String RUNNING

期望状态:

  • RUNNING:运行中。
  • PAUSED:暂停。
  • TERMINATED:停止。
  • SUCCESS:成功(批作业)。
  • FAILED:失败(流作业)。
instanceId Long -1

实例ID:

  • 流作业:填写实际运行的实例ID或直接填写-1(当前运行的实例)。
  • 批作业:可以通过ListInstance、StartJob等接口获得。
jobName String job1

作业名称

projectName String project1

项目名称

RegionId String cn-hangzhou

区域ID

说明 公共云用户请忽略此参数。
isFlush Boolean true

在恢复作业时,是否使用最新配置。默认值为true。

triggerCheckpoint Boolean true

在暂停或者停止作业时,是否进行一次Checkpoint。

说明 Blink 3.5.0及以上版本支持该参数。

返回数据

名称 类型 示例值 描述
RequestId String EA0059FA-FD69-4A83-B216-6B36B03129A7

请求ID

示例

请求示例

/api/v2/projects/project1/jobs/job1/instances/-1/expectstate
{\"expectState\":\"RUNNING\"}

正常返回示例

XML 格式

<requestId>EA0059FA-FD69-4A83-B216-6B36B03129A7</requestId>

JSON 格式

{
    "requestId": "EA0059FA-FD69-4A83-B216-6B36B03129A7"
}