You need to enable JavaScript to run this app.
Volcengine Kubernetes Engine

Volcengine Kubernetes Engine

Copy page
Download PDF
Task management
UpdateTask
Copy page
Download PDF
UpdateTask
Update a task in the VKE cluster.​
Request description​
VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point based on the region where your business is located.​
  • Request method: POST​
  • Request URL: https://vke.cn-beijing.volcengineapi.com?Action=UpdateTask&Version=2022-05-12​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameter​
The following table describes the API request parameters. You also need to provide public parameters when calling this API. For details about public request parameters, see Public parameters.​
​
Parameter​
Type​
Required​
Sample value​
Description​
Action​
String​
Yes​
UpdateTask​
The API name. The current API name is UpdateTask.​
Version​
String​
Yes​
2022-05-12​
The API version. The current version of the API is 2022-05-12.​
Id​
String​
Yes​
tcax******​
Task ID.​
You can call ListTasks to get the task ID.​
Status​
String​
No​
Running​
Task status. Valid values:​
  • Running: It is running.​
  • Succeeded: Succeeded​
  • Failed: Failed​
  • Aborted: Aborted​
  • Paused: Paused​
  • Pending: Pending​
  • Approving: Approving​
  • Waiting: Waiting to be executed​
Operation​
String​
No​
Pause​
Task control operations. Valid values:​
  • Pause: Pause the task​
  • Resume: Resume the task​
  • Abort: Abort the task​
​
Sample requests​
​
POST https://vke.cn-beijing.volcengineapi.com?Action=UpdateTask&Version=2022-05-12​
Content-Type: application/json​
{​
"Id": "tcax******",​
"Status": "Running",​
"Operation": "Pause"​
}
​
Response parameter​
The following table contains the response parameters of this API. See Response results for details about public response parameters.​
​
Parameter​
Type​
Sample value​
Description​
Id​
String​
tcax******​
Task ID.​
Status​
String​
Running​
Task status. Valid values:​
  • Running: It is running.​
  • Succeeded: Succeeded​
  • Failed: Failed​
  • Aborted: Aborted​
  • Paused: Paused​
  • Pending: Pending​
  • Approving: Approving​
  • Waiting: Waiting to be executed​
Operation​
String​
Pause​
Task control operations. Valid values:​
  • Pause: Pause the task​
  • Resume: Resume the task​
  • Abort: Abort the task​
​
Sample responses​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420**********",​
"Action": "UpdateTask",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "tcax******",​
"Status": "Running",​
"Operation": "Pause"​
}​
}
​
Error code​
There are no proprietary error codes for this API. See Public error codes for details about public error codes.​
Last updated: 2026.09.10 16:24:17