Querying the Statistics About a Synchronization Task
Function
This API is used to query the statistics of a synchronization task. The statistics include the number of objects requested for synchronization, the number of objects that are successfully synchronized, the number of objects that fail to be synchronized, the number of objects that are skipped during synchronization, and the size of successfully synchronized objects. This API is available only in CN North-Beijing4 and CN East-Shanghai1.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/sync-tasks/{sync_task_id}/statistics
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
The project ID. Minimum length: 1 character Maximum length: 1,024 characters |
|
sync_task_id |
Yes |
String |
The synchronization task ID. Minimum length: 0 characters Maximum length: 255 characters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
data_type |
Yes |
String |
The statistical data type. Use commas (,) to separate multiple data types. REQUEST: The number of objects requested for synchronization. SUCCESS: The number of objects that are successfully synchronized. FAILURE: The number of objects that fail to be synchronized. SKIP: The number of objects that are skipped during synchronization. SIZE: The size of successfully synchronized objects, in bytes. Minimum length: 1 character Maximum length: 255 characters Enumerated values: |
|
start_time |
Yes |
String |
The start time for the query. Minimum length: 1 character Maximum length: 1,024 characters |
|
end_time |
Yes |
String |
The end time for the query. Minimum length: 1 character Maximum length: 1,024 characters |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
sync_task_id |
String |
The synchronization task ID. Minimum length: 1 character Maximum length: 255 characters |
|
statistic_time_type |
String |
The interval for collecting statistics. FIVE_MINUTES: 5 minutes ONE_HOUR: 1 hour Minimum length: 1 character Maximum length: 255 characters Enumerated values: |
|
statistic_datas |
Array of StatisticTypeData objects |
The statistics of the queried synchronization task. Array length: 0 to 1,000 |
|
Parameter |
Type |
Description |
|---|---|---|
|
data_type |
String |
The statistical data type. REQUEST: The number of objects requested for synchronization. SUCCESS: The number of objects that are successfully synchronized. FAILURE: The number of objects that fail to be synchronized. SKIP: The number of objects that are skipped during synchronization. SIZE: The size of synchronized objects, in bytes. Minimum length: 1 character Maximum length: 255 characters Enumerated values: |
|
data |
Array of StatisticData objects |
The statistics of the queried synchronization task. Array length: 0 to 1,000 |
|
Parameter |
Type |
Description |
|---|---|---|
|
time_stamp |
Long |
The statistics timestamp. Minimum value: 0 Maximum value: 9223372036854775807 |
|
statistic_num |
Long |
The statistics. Minimum value: 0 Maximum value: 9223372036854775807 |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
The error message. |
|
error_code |
String |
The error code. |
Example Request
This example queries the statistics of the task 0d146099-8cf4-437d-b6ef-88e043771c8b in the project 2c0689c860ad4728a497c91ec0844383.
GET https://{endpoint}/v2/2c0689c860ad4728a497c91ec0844383/sync-tasks/0d146099-8cf4-437d-b6ef-88e043771c8b/statistics?data_type=REQUEST
{
"sync_task_id" : "4fb05cd2-c94e-44e4-a07f-e65a2f01ebcb",
"statistic_time_type" : "FIVE_MINUTES",
"statistic_datas" : [ {
"data_type" : "REQUEST",
"data" : [ {
"time_stamp" : 1700150400000,
"statistic_num" : 1
}, {
"time_stamp" : 1700151000000,
"statistic_num" : 20
}, {
"time_stamp" : 1700184000000,
"statistic_num" : 8
}, {
"time_stamp" : 1700188200000,
"statistic_num" : 2
} ]
} ]
}
Example Response
Status code: 200
OK
{
"sync_task_id" : "4fb05cd2-c94e-44e4-a07f-e65a2f01ebcb",
"statistic_time_type" : "FIVE_MINUTES",
"statistic_datas" : [ {
"data_type" : "REQUEST",
"data" : [ {
"time_stamp" : 1700150400000,
"statistic_num" : 1
}, {
"time_stamp" : 1700151000000,
"statistic_num" : 20
}, {
"time_stamp" : 1700151300000,
"statistic_num" : 13
}, {
"time_stamp" : 1700151600000,
"statistic_num" : 12
}, {
"time_stamp" : 1700151900000,
"statistic_num" : 10
}, {
"time_stamp" : 1700152200000,
"statistic_num" : 11
}, {
"time_stamp" : 1700152500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700152800000,
"statistic_num" : 12
}, {
"time_stamp" : 1700153100000,
"statistic_num" : 9
}, {
"time_stamp" : 1700153400000,
"statistic_num" : 10
}, {
"time_stamp" : 1700153700000,
"statistic_num" : 7
}, {
"time_stamp" : 1700154000000,
"statistic_num" : 13
}, {
"time_stamp" : 1700154300000,
"statistic_num" : 9
}, {
"time_stamp" : 1700154600000,
"statistic_num" : 9
}, {
"time_stamp" : 1700154900000,
"statistic_num" : 9
}, {
"time_stamp" : 1700155200000,
"statistic_num" : 10
}, {
"time_stamp" : 1700155500000,
"statistic_num" : 11
}, {
"time_stamp" : 1700155800000,
"statistic_num" : 9
}, {
"time_stamp" : 1700156100000,
"statistic_num" : 8
}, {
"time_stamp" : 1700156400000,
"statistic_num" : 11
}, {
"time_stamp" : 1700156700000,
"statistic_num" : 10
}, {
"time_stamp" : 1700157000000,
"statistic_num" : 8
}, {
"time_stamp" : 1700157300000,
"statistic_num" : 10
}, {
"time_stamp" : 1700157600000,
"statistic_num" : 11
}, {
"time_stamp" : 1700157900000,
"statistic_num" : 9
}, {
"time_stamp" : 1700158200000,
"statistic_num" : 11
}, {
"time_stamp" : 1700158500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700158800000,
"statistic_num" : 10
}, {
"time_stamp" : 1700159100000,
"statistic_num" : 11
}, {
"time_stamp" : 1700159400000,
"statistic_num" : 9
}, {
"time_stamp" : 1700159700000,
"statistic_num" : 11
}, {
"time_stamp" : 1700160000000,
"statistic_num" : 10
}, {
"time_stamp" : 1700160300000,
"statistic_num" : 10
}, {
"time_stamp" : 1700160600000,
"statistic_num" : 9
}, {
"time_stamp" : 1700160900000,
"statistic_num" : 8
}, {
"time_stamp" : 1700161200000,
"statistic_num" : 11
}, {
"time_stamp" : 1700161500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700161800000,
"statistic_num" : 9
}, {
"time_stamp" : 1700162100000,
"statistic_num" : 9
}, {
"time_stamp" : 1700162400000,
"statistic_num" : 10
}, {
"time_stamp" : 1700162700000,
"statistic_num" : 11
}, {
"time_stamp" : 1700163000000,
"statistic_num" : 9
}, {
"time_stamp" : 1700163300000,
"statistic_num" : 9
}, {
"time_stamp" : 1700163600000,
"statistic_num" : 11
}, {
"time_stamp" : 1700163900000,
"statistic_num" : 10
}, {
"time_stamp" : 1700164200000,
"statistic_num" : 9
}, {
"time_stamp" : 1700164500000,
"statistic_num" : 10
}, {
"time_stamp" : 1700164800000,
"statistic_num" : 9
}, {
"time_stamp" : 1700165100000,
"statistic_num" : 11
}, {
"time_stamp" : 1700165400000,
"statistic_num" : 10
}, {
"time_stamp" : 1700165700000,
"statistic_num" : 10
}, {
"time_stamp" : 1700166000000,
"statistic_num" : 11
}, {
"time_stamp" : 1700166300000,
"statistic_num" : 10
}, {
"time_stamp" : 1700166600000,
"statistic_num" : 9
}, {
"time_stamp" : 1700166900000,
"statistic_num" : 9
}, {
"time_stamp" : 1700167200000,
"statistic_num" : 11
}, {
"time_stamp" : 1700167500000,
"statistic_num" : 10
}, {
"time_stamp" : 1700167800000,
"statistic_num" : 8
}, {
"time_stamp" : 1700168100000,
"statistic_num" : 11
}, {
"time_stamp" : 1700168400000,
"statistic_num" : 8
}, {
"time_stamp" : 1700168700000,
"statistic_num" : 10
}, {
"time_stamp" : 1700169000000,
"statistic_num" : 10
}, {
"time_stamp" : 1700169300000,
"statistic_num" : 9
}, {
"time_stamp" : 1700169600000,
"statistic_num" : 10
}, {
"time_stamp" : 1700169900000,
"statistic_num" : 8
}, {
"time_stamp" : 1700170200000,
"statistic_num" : 11
}, {
"time_stamp" : 1700170500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700170800000,
"statistic_num" : 13
}, {
"time_stamp" : 1700171100000,
"statistic_num" : 10
}, {
"time_stamp" : 1700171400000,
"statistic_num" : 8
}, {
"time_stamp" : 1700171700000,
"statistic_num" : 10
}, {
"time_stamp" : 1700172000000,
"statistic_num" : 11
}, {
"time_stamp" : 1700172300000,
"statistic_num" : 11
}, {
"time_stamp" : 1700172600000,
"statistic_num" : 10
}, {
"time_stamp" : 1700172900000,
"statistic_num" : 11
}, {
"time_stamp" : 1700173200000,
"statistic_num" : 9
}, {
"time_stamp" : 1700173500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700173800000,
"statistic_num" : 12
}, {
"time_stamp" : 1700174100000,
"statistic_num" : 9
}, {
"time_stamp" : 1700174400000,
"statistic_num" : 11
}, {
"time_stamp" : 1700174700000,
"statistic_num" : 10
}, {
"time_stamp" : 1700175000000,
"statistic_num" : 10
}, {
"time_stamp" : 1700175300000,
"statistic_num" : 11
}, {
"time_stamp" : 1700175600000,
"statistic_num" : 9
}, {
"time_stamp" : 1700175900000,
"statistic_num" : 11
}, {
"time_stamp" : 1700176200000,
"statistic_num" : 10
}, {
"time_stamp" : 1700176500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700176800000,
"statistic_num" : 11
}, {
"time_stamp" : 1700177100000,
"statistic_num" : 9
}, {
"time_stamp" : 1700177400000,
"statistic_num" : 11
}, {
"time_stamp" : 1700177700000,
"statistic_num" : 9
}, {
"time_stamp" : 1700178000000,
"statistic_num" : 12
}, {
"time_stamp" : 1700178300000,
"statistic_num" : 10
}, {
"time_stamp" : 1700178600000,
"statistic_num" : 9
}, {
"time_stamp" : 1700178900000,
"statistic_num" : 11
}, {
"time_stamp" : 1700179200000,
"statistic_num" : 9
}, {
"time_stamp" : 1700179500000,
"statistic_num" : 10
}, {
"time_stamp" : 1700179800000,
"statistic_num" : 10
}, {
"time_stamp" : 1700180100000,
"statistic_num" : 11
}, {
"time_stamp" : 1700180400000,
"statistic_num" : 10
}, {
"time_stamp" : 1700180700000,
"statistic_num" : 9
}, {
"time_stamp" : 1700181000000,
"statistic_num" : 12
}, {
"time_stamp" : 1700181300000,
"statistic_num" : 9
}, {
"time_stamp" : 1700181600000,
"statistic_num" : 12
}, {
"time_stamp" : 1700181900000,
"statistic_num" : 9
}, {
"time_stamp" : 1700182200000,
"statistic_num" : 11
}, {
"time_stamp" : 1700182500000,
"statistic_num" : 9
}, {
"time_stamp" : 1700182800000,
"statistic_num" : 10
}, {
"time_stamp" : 1700183100000,
"statistic_num" : 11
}, {
"time_stamp" : 1700183400000,
"statistic_num" : 10
}, {
"time_stamp" : 1700183700000,
"statistic_num" : 9
}, {
"time_stamp" : 1700184000000,
"statistic_num" : 8
}, {
"time_stamp" : 1700188200000,
"statistic_num" : 1
} ]
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
404 |
Not Found |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
