Help Center/ MapReduce Service/ API Reference/ API V2/ IAM Synchronization/ Cancelling Synchronization of Specified Users and User Groups
Updated on 2024-12-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Cancelling Synchronization of Specified Users and User Groups

Function

This API is used to cancel synchronization of specified users and user groups.

Debugging

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

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/iam-sync-user

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 must consist of 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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

group_names

No

Array of strings

Explanation

IAM user group whose synchronization is to be canceled

Constraints

The number of records cannot exceed 1,000.

Value range

N/A

Default value

N/A

user_names

No

Array of strings

Explanation

IAM user whose synchronization is to be canceled.

Constraints

The number of records cannot exceed 1,000.

Value range

N/A

Default value

N/A

Response Parameters

Status code: 202

Table 3 Response body parameter

Parameter

Type

Description

state

String

Explanation

Request result

Constraints

N/A

Value range

N/A

Default value

N/A

Example Request

/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/iam-sync-user

{
  "group_names" : [ "groups1" ],
  "user_names" : [ "user1", "user2" ]
}

Example Response

Status code: 202

Request result

{
  "state" : "synchronizing"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: IAM Synchronization