StopFormationCrawler

Updated at:
Copy as MD

Stops a metadata discovery task that is currently running.

Operation description

Stops only the currently running task without canceling subsequent cron-scheduled executions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID. You can call the DescribeRegions operation to query available region IDs.

cn-hangzhou

CrawlerTaskName

string

Yes

The task name.

test-crawler-dbname

DBClusterId

string

Yes

The instance ID.

am-bp1xxxxxxxx47

CrawlerTaskId

integer

Yes

The task ID.

21

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

Data

string

The ID of the successfully created task.

true

RequestId

string

The request ID.

9CCFAAB4-97B7-5800-B9F2-685EB596E3EF

Success

boolean

Indicates whether the operation was successful.

true

Code

string

The status code.

200

Message

string

The error message.

Success

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": "true",
  "RequestId": "9CCFAAB4-97B7-5800-B9F2-685EB596E3EF",
  "Success": true,
  "Code": "200",
  "Message": "Success"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidInput The specified parameter is invalid.
400 NotExists The formation task does not exist.
400 NotRunning The instance is not running.
500 ServerStoreError A server storage error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.