DocsICP FilingConsole
Documentation

UpdateFormationCrawler

Updated at:
Copy as MD
My Favorites

Updates the information of a metadata discovery task.

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.

Note

You can call the DescribeRegions operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.

cn-beijing
CrawlerInfo

string

Yes

The JSON string that contains the complete configuration of the crawler. This is the most important parameter. For more information about the internal JSON structure, see the CrawlerInfo structure definition section.

{"sourceType":"OSSWAREHOUSE","dbName":"sales_db","sourceInfo":{"ossSourceInfo":{"sourceMode":"WAREHOUSE","ossLocations":"oss://test-bucket/***/***/","inclusions":[],"exclusions":[]}},"classifiers":"[]","frequency":{"type":"run_on_demand","cron":""},"configuration":"","schemaChangePolicy":{"updateRule":"ONLY_ADD_COLUMN","deleteRule":"IGNORE"}}
DBClusterId

string

Yes

The cluster ID.

am-bp1r053byu48p****
CrawlerTaskId

string

No

The task ID.

21

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200
Data

boolean

Indicates whether the request is processed successfully.

true
RequestId

string

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Success

boolean

Indicates whether the call is successful. Valid values:

  • true: Successful.

  • false: Failed.

true
Code

string

The status code.

200
Message

string

The additional information about the call result. Valid values:

  • If the request is successful, OK is returned.

  • If the request fails, a specific error code is returned.

OK
TaskId

integer

The task ID.

15

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": true,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "TaskId": 15
}

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.
500 ServerStoreError A server storage error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.