Checking Ongoing IAM User Synchronization in a Cluster - ListClusterSyncTaskStatus

Function

This API is used to check whether IAM user synchronization is currently in progress in the cluster.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v2/{project_id}/clusters/{cluster_id}/iam-sync

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Value range The value can contain 1 to 64 characters. Only letters and digits are allowed. Default value N/A
cluster_id	Yes	String	Explanation Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
is_synchronizing	Boolean	Explanation Whether the IAM synchronization task is in progress. Constraints N/A Value range is-synchronizing: true indicates that an IAM synchronization task is in progress. is-synchronizing: false indicates that no IAM synchronization task is in progress. Default value N/A