Help Center/ FunctionGraph/ API Reference (Kuala Lumpur Region)/ APIs/ Asynchronous Execution Notification/ Stopping an Asynchronous Invocation Request
Updated on 2023-07-06 GMT+08:00
View PDF
Share

Stopping an Asynchronous Invocation Request

Function

This API is used to stop asynchronous invocation of a function with N concurrent instances. When calling this API, set recursive to false and force to true. The API will also stop the function's other concurrent requests and return "4208 function invocation canceled".

This API is only available in CN South-Guangzhou and CN Southwest-Guiyang1.

URI

POST /v2/{project_id}/fgs/functions/{function_urn}/cancel

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

function_urn

Yes

String

Function URN. For details, see the function model description.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

request_id

Yes

String

ID of a stopped request.

type

No

String

Stop mode. Options:

  • recursive: The subfunction that is being invoked will be stopped.

  • force: The runtime will be directly stopped.

Enumeration values:

  • force

  • recursive

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Stop an asynchronous invocation request of a function.

POST /v2/{project_id}/fgs/functions/{function_urn}/cancel

{
  "request_id" : "xxxx"
}

Example Responses

Status code: 200

OK

null

Status code: 400

Invalid RequestId

{
  "error_code" : "FSS.0400",
  "error_msg" : "Invalid RequestId"
}

Status code: 403

FORBIDDEN

{
  "error_code" : "FSS.0403",
  "error_msg" : "invalid token"
}

Status code: 404

Not Found

{
  "error_code" : "FSS.0404",
  "error_msg" : "can not find function"
}

Status code: 500

Internal error.

{
  "error_code" : "FSS.0500",
  "error_msg" : "xxx"
}

Status Codes

Status Code

Description

200

OK

400

Invalid RequestId

403

FORBIDDEN

404

Not Found

500

Internal error.

Error Codes

See Error Codes.