Updated on 2025-09-19 GMT+08:00

Querying Identity Source Synchronization Records

Function

This API is used to query identity source synchronization records.

Constraints

This function is disabled by default. The query result is displayed only when the feature is enabled and there are synchronization records.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/db-manager/sync-records

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Page offset, which starts from 0 (page number minus 1).

Constraints

N/A

Range

Greater than or equal to 0

Default Value

0

limit

No

Integer

Definition

Size of a single page.

Constraints

N/A

Range

Greater than 0

Default Value

1000

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Definition

Number of synchronization records.

Range

An integer greater than or equal to 0

sync_records

Array of IdentitySourceSyncRecordVo objects

Definition

Synchronization record details.

Range

N/A

Table 4 IdentitySourceSyncRecordVo

Parameter

Type

Description

id

String

Definition

Record ID.

Range

N/A

identity_source_id

String

Definition

Identity source ID.

Range

N/A

identity_source_type

String

Definition

Identity source type.

Range

N/A

start_time

Long

Definition

Task start time.

Range

N/A

end_time

Long

Definition

Task end time.

Range

N/A

add_count

Integer

Definition

Number of added records.

Range

Greater than or equal to 0

update_count

Integer

Definition

Number of updated records.

Range

Greater than or equal to 0

delete_count

Integer

Definition

Number of deleted records.

Range

Greater than or equal to 0

failed_count

Integer

Definition

Number of failure records.

Range

Greater than or equal to 0

status

String

Definition

Status.

Range

N/A

fail_reason

String

Definition

Failure cause.

Range

N/A

Example Requests

Query identity source synchronization records.

GET https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/cc6588d6-8301-4c9a-b0c0-186bb824e8c0/db-manager/sync-records

Example Responses

Status code: 200

Record list.

{
  "sync_records" : [ {
    "id" : "05cea375-4b7a-4ebd-a2dc-035043dec3d3",
    "identity_source_id" : "79d6458e-85ee-4f8b-9cfb-2349de8a5132",
    "identity_source_type" : "ldap",
    "start_time" : 1747637723055,
    "end_time" : 1747637723055,
    "add_count" : 3,
    "update_count" : 0,
    "delete_count" : 0,
    "failed_count" : 0,
    "status" : "FINISHED",
    "fail_reason" : null
  } ],
  "count" : 1
}

Status Codes

Status Code

Description

200

Record list.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

417

Internal server error.

500

Internal server error.