All Products
Search
Document Center

OpenSearch:DeleteFunctionTask

Last Updated:Mar 03, 2024

Deletes a training task. The training task in progress cannot be deleted.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:WriteFunctionWrite
  • FunctionTask
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

DELETE /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation}

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

my_app_group_name
functionNamestringYes

The name of the feature.

ctr
instanceNamestringYes

The name of the instance.

ctr_test
generationstringYes

The number of iterations.

1

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

Statusstring

The status of the request.

OK
HttpCodelong

The HTTP status code.

200
RequestIdstring

The ID of the request.

"1081EB05-473C-5BF4-95BE-6D7CAD5E2213"
Messagestring

The error message.

operation success
Codestring

The error code. If no error occurs, this parameter is left empty.

Task.UnableDelete
Latencylong

The time consumed for the request, in milliseconds.

123

Sample success responses

{
  "status": "OK",
  "requestId": "",
  "httpCode": 200,
  "code": "",
  "message": "",
  "latency": 123,
  "result": {}
}

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "\"1081EB05-473C-5BF4-95BE-6D7CAD5E2213\"",
  "Message": "operation success",
  "Code": "Task.UnableDelete",
  "Latency": 123
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history