Help Center/MapReduce Service/API Reference/API V2/IAM Synchronization/Querying IAM User Synchronization Status of a Specified Cluster - ListClusterSyncStatus
Updated on 2026-01-04 GMT+08:00

Querying IAM User Synchronization Status of a Specified Cluster - ListClusterSyncStatus

Function

This API is used to query the IAM user synchronization status of a specified 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/is-synchronous

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_synchronous

Boolean

Explanation

Whether the current cluster has completed IAM synchronization

Constraints

N/A

Value range

  • is-synchronous: true indicates that the current cluster has completed IAM synchronization.

  • is-synchronous: false indicates that the current cluster has not completed IAM synchronization.

Default value

N/A

Example Request

None

Example Response

Status code: 200

The IAM synchronization status of a specified cluster is obtained.

{
  "is_synchronous" : false
}

Status Codes

For details about status codes, see Status Codes.

Error Codes

For details about error codes, see Error Codes.