All Products
Search
Document Center

OpenSearch:StopTask

Last Updated:Jul 16, 2024

Stops an FSM task.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/stop-task/{fsmId}

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

PUT /openapi/ha3/instances/{instanceId}/stop-task/{fsmId}

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-7mz2nx41h01
fsmIdstringYes

The ID of the finite state machine (FSM).

tisplus_opensearch@datasource_flow_fsm@1865410598556969-ha-cn-0ju2rrogr01_test_api_2@sz_vpc_domain_1@null@MANUAL-ha-cn-0ju2rrogr01_test_api_2@1657511220772@165343

Sample requests

PUT /openapi/ha3/instances/{instanceId}/stop-task/tisplus_opensearch@add_index_config@1062017779051424-ha-cn-0ju2i0e5z01_mx1228@null@index_11@null@1641282725526@607017

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

id of request

FE03180A-0E29-5474-8A86-33F0683294A4
resultobject

The information about the index

{}

Sample responses

Sample success responses

{
 
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
 
  "result": []
 
}

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-01-12Add OperationView Change Details