GetFormationCrawler-阿里云帮助中心

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 supported regions and zones, including region IDs.	cn-beijing
CrawlerTaskName	string	No	The task name.	test-crawler-dbname
DBClusterId	string	Yes	The cluster ID.	am-bp1xxxxxxxx47
CrawlerTaskId	integer	No	The task ID.	247

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Data	string	The returned data.	{ "crawlerInfo":{ "scheduleState":"NORMAL", "configuration":{}, "gmtCreated":"2026-07-08T09:05:25.000+00:00", "dbName":"sales_db", "schemaChangePolicy":{ "deleteRule":"IGNORE", "updateRule":"ONLY_ADD_COLUMN" }, "frequency":{ "cron":"", "type":"run_on_demand" }, "uid":"", "sourceInfo":{ "ossSourceInfo":{ "sourceMode":"WAREHOUSE", "ossLocations":[ "oss://test-bucket///" ], "exclusions":[], "inclusions":[] } }, "failedCount":0, "dbClusterId":"am-bp1xxxxxxxx47", "sourceType":"OSSWAREHOUSE", "classifiers":[], "taskName":"[\"oss://test-bucket//**/\"] -> sales_db", "id":36 }, "success":true }
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Success	boolean	Indicates whether the call was successful. Valid values: true: Successful. false: Failed.	true
Code	string	The status code.	200
Message	string	The response message. OK is returned if the call was successful.	OK

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": "{\n    \"crawlerInfo\":{\n        \"scheduleState\":\"NORMAL\",\n        \"configuration\":{},\n        \"gmtCreated\":\"2026-07-08T09:05:25.000+00:00\",\n        \"dbName\":\"sales_db\",\n        \"schemaChangePolicy\":{\n            \"deleteRule\":\"IGNORE\",\n            \"updateRule\":\"ONLY_ADD_COLUMN\"\n        },\n        \"frequency\":{\n            \"cron\":\"\",\n            \"type\":\"run_on_demand\"\n        },\n        \"uid\":\"**\",\n        \"sourceInfo\":{\n            \"ossSourceInfo\":{\n                \"sourceMode\":\"WAREHOUSE\",\n                \"ossLocations\":[\n                    \"oss://test-bucket/***/***/\"\n                ],\n                \"exclusions\":[],\n                \"inclusions\":[]\n            }\n        },\n        \"failedCount\":0,\n        \"dbClusterId\":\"am-bp1xxxxxxxx47\",\n        \"sourceType\":\"OSSWAREHOUSE\",\n        \"classifiers\":[],\n        \"taskName\":\"[\\\"oss://test-bucket/***/***/\\\"] -> sales_db\",\n        \"id\":36\n    },\n    \"success\":true\n}",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Success": true,
  "Code": "200",
  "Message": "OK"
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.