Triggering Savepoints for Flink Jobs

This API is used to trigger savepoints for Flink jobs.

POST /v1.0/{project_id}/streaming/jobs/{job_id}/savepoint

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	ID of a Flink job
project_id	Yes	String	Project ID, which is used for resource isolation. For how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Operation type Enumerated value: TRIGGER
savepoint_path	Yes	String	Savepoint path. Make sure you have authorized operations on OBS before using it. Example: obs://bucket-name/dir/savepoint/

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
is_success	Boolean	Whether the request is successfully executed. true indicates that the request is successfully executed.
message	String	System prompt. If the execution succeeds, this parameter may be left blank.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Trigger savepoints for a Flink job.

{
 "action": "TRIGGER",
 "savepoint_path": "obs://bucket-name/dir/savepoint"
}

{
    "is_success": true,
    "message": "{\"is_success\":\"true\",\"message\":\"api.msg.deal_savepoint_success\"}"
}

Status Code	Description
200	The modification is successful.
400	Request error.
500	Internal server error.

Parent topic: Flink Job Management APIs

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.