Querying Whether Object Selection and Column Mapping Are Supported

Function

This API is used to query information such as the object selection type, column mapping, and object type that can be searched for supported by a task.

URI

GET /v5/{project_id}/jobs/{job_id}/object/support

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details, see Obtaining a Project ID.
job_id	Yes	String	Task ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM. It is a response to the API for obtaining a user token. After a request is processed, the value of X-Subject-Token in the header is the token value.
X-Language	No	String	Request language type. Default value: en-us Enumerated values: en-us zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
is_full_trans_support_object	Boolean	Whether objects can be selected for a full task.
is_incre_trans_support_object	Boolean	Whether objects can be selected for an incremental task.
is_full_incre_trans_support_object	Boolean	Whether objects can be selected for a full+incremental task.
support_object_import_engine	Array of strings	DB engine that supports object import.
is_support_column_mapping	Boolean	Whether column mapping is supported.
is_database_support_search	Boolean	Whether the database supports data search.
is_schema_support_search	Boolean	Whether the schema supports data search.
is_table_support_search	Boolean	Whether the table supports data search.
file_size	String	Maximum size of a file that can be imported, in MB.
previous_select	String	Mode in which objects are migrated or synchronized last time. If this parameter is left blank, the required mode has not been selected. srcImportObject: The object file import mode is selected for the task last time.
import_level	String	Object import type. table: table-level import. database: database-level import.
is_import_cloumn	Boolean	Column processing mode selected last time for the current task. true: The column processing mode selected last time for the current task is automatic import. false or empty: The column processing mode selected last time for the current task is manual selection.

Example Request

Querying the information about object selection type and column mapping supported by the task

https://{enpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/429b9210-118d-4711-87cb-be8e2dejb201/object/support

Example Response

Status code: 200

{
  "is_full_trans_support_object" : false,
  "is_incre_trans_support_object" : false,
  "is_full_incre_trans_support_object" : false,
  "file_size" : "5.0",
  "support_object_import_engine" : [ "oracle-to-mrsKafka", "oracle-to-kafka" ],
  "is_support_column_mapping" : false,
  "is_database_support_search" : true,
  "is_table_support_search" : true
}