All Products
Search
Document Center

Microservices Engine:SetJobInstanceSuccess

Last Updated:Sep 13, 2024

Forcibly sets the state of a job instance to successful. You can call this operation only in the professional edition.

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 parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
NamespacestringYes

The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestringNo

The source of the namespace. This parameter is required only for a special third party.

schedulerx
GroupIdstringYes

The application group ID. You can obtain the application group ID on the Application Management page in the SchedulerX console.

testSchedulerx.defaultGroup
JobIdlongYes

The job ID.

123
JobInstanceIdlongYes

The job instance ID.

123456

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger

The HTTP status code.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Messagestring

The returned error message.

jobId=xxx is not existed

Examples

Sample success responses

JSONformat

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "jobId=xxx is not existed"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history