Querying DR Initialization Object Details in Batches

Function

This API is used to query details about DR initialization objects in batches by task ID.

Debugging

You can debug the API in API Explorer to support automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

POST /v3/{project_id}/jobs/{type}/batch-struct-detail

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region For details about how to obtain the project ID, see Obtaining a Project ID.
type	Yes	String	Supported migration object types. Values: database schema table view procedure trigger index table_indexs table_structure

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	The content type. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM.
X-Language	No	String	Request language type Default value: en-us Values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
jobs	Yes	Array of strings	Querying task details in batches
page_req	No	Object	Pagination information. For details, see Table 4.

**Table 4** Data structure description of field **page_req**
Parameter	Mandatory	Type	Description
cur_page	No	Integer	Current page number, which cannot exceed the maximum number of pages. (Number of pages = Number of items/Number of tasks on each page) The default value is 1.
per_page	No	Integer	Number of items on each page. If this parameter is set to 0, all items are obtained. Minimum value: 0 Maximum value: 100 Default value: 5

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
count	Integer	Total number.
results	Array of objects	DR initialization object details that are queried in batches. For details, see Table 6.

**Table 6** Data structure description of field **results**
Parameter	Type	Description
job_id	String	Task ID.
error_code	String	Error code.
error_message	String	Error meaasge.
struct_detail	Object	Details about the DR initialization objects. For details, see Table 7.

**Table 7** Data structure description of field **struct_detail**
Parameter	Type	Description
total_record	Long	Total number of tasks
create_time	String	Data generation time
list	Array of objects	Comparison result. For details, see Table 8.

**Table 8** Data structure description of field **list**
Parameter	Type	Description
progress	Integer	Progress.
src_DB	String	Source database name. If the source database has a three-layer structure, the format of the value is database.schema.
src_TB	String	Source object name.
dst_DB	String	Destination database name.
dst_TB	String	Destination object name.

Example Request

Example of querying details about DR initialization objects in batches:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/database/batch-struct-detail

{
  "jobs" : [ "0ea5c5a0-e1b5-4421-80a9-7c9ff27jb502" ],
  "page_req" : {
    "cur_page" : 1,
    "per_page" : 10
  }
}

Example Response

Status code: 200

{
  "count" : 1,
  "results" : [ {
    "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
    "struct_detail" : {
      "list" : [ {
        "progress" : 100,
        "src_DB" : "test1",
        "src_TB" : "test1",
        "dst_DB" : "test1",
        "dst_TB" : "test1"
      } ],
      "total_record" : 1,
      "create_time" : "1608429484785"
    }
  } ]
}