IAM Synchronization - UpdateSyncIamUser
Function
This API is used to synchronize IAM users and user groups to MRS Manager, enabling IAM users to perform management operations on the cluster through MRS Manager. When a user is specified, the IAM user group associated with that user is also synchronized to MRS Manager. It can be used together with the API for retrieving synchronized IAM users and user groups to verify the synchronization result.
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
POST /v2/{project_id}/clusters/{cluster_id}/iam-sync-user
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default Value N/A |
| cluster_id | Yes | String | Definition Cluster ID For details about how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| is_all_sync | No | Boolean | Definition Whether to perform full synchronization. Constraints N/A Range
Default Value false |
| group_names | No | Array of strings | Definition IAM user groups specified for synchronization. The parameter naming rules and constraints are the same as those required by the IAM service. Constraints N/A Range N/A Default Value N/A |
| user_names | No | Array of strings | Definition IAM users specified for synchronization. The parameter naming rules and constraints are the same as those required by the IAM service. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 202
| Parameter | Type | Description |
|---|---|---|
| state | String | Definition Request result Range synchronizing: The synchronization task is in progress. |
Example Request
Synchronize group1 and user1 to the Manager. The IAM user group associated with user1 is automatically synchronized to Manager.
/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/iam-sync-user
{
"is_all_sync" : false,
"group_names" : [ "groups1" ],
"user_names" : [ "user1", "user2" ]
} Example Response
Status code: 202
Result the synchronization request.
{
"state" : "synchronizing"
} SDK Sample Code
The SDK sample code is as follows.
Synchronize group1 and user1 to MRS Manager. The IAM user group associated with user1 is also automatically synchronized to MRS Manager.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.mrs.v2.region.MrsRegion; import com.huaweicloud.sdk.mrs.v2.*; import com.huaweicloud.sdk.mrs.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateSyncIamUserSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MrsClient client = MrsClient.newBuilder() .withCredential(auth) .withRegion(MrsRegion.valueOf("<YOUR REGION>")) .build(); UpdateSyncIamUserRequest request = new UpdateSyncIamUserRequest(); request.withClusterId("{cluster_id}"); UpdateSyncRequest body = new UpdateSyncRequest(); List<String> listbodyUserNames = new ArrayList<>(); listbodyUserNames.add("user1"); listbodyUserNames.add("user2"); List<String> listbodyGroupNames = new ArrayList<>(); listbodyGroupNames.add("groups1"); body.withUserNames(listbodyUserNames); body.withGroupNames(listbodyGroupNames); body.withIsAllSync(false); request.withBody(body); try { UpdateSyncIamUserResponse response = client.updateSyncIamUser(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Synchronize group1 and user1 to MRS Manager. The IAM user group associated with user1 is also automatically synchronized to MRS Manager.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmrs.v2.region.mrs_region import MrsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmrs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MrsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MrsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateSyncIamUserRequest() request.cluster_id = "{cluster_id}" listUserNamesbody = [ "user1", "user2" ] listGroupNamesbody = [ "groups1" ] request.body = UpdateSyncRequest( user_names=listUserNamesbody, group_names=listGroupNamesbody, is_all_sync=False ) response = client.update_sync_iam_user(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Synchronize group1 and user1 to MRS Manager. The IAM user group associated with user1 is also automatically synchronized to MRS Manager.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" mrs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := mrs.MrsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := mrs.NewMrsClient(hcClient) request := &model.UpdateSyncIamUserRequest{} request.ClusterId = "{cluster_id}" var listUserNamesbody = []string{ "user1", "user2", } var listGroupNamesbody = []string{ "groups1", } isAllSyncUpdateSyncRequest:= false request.Body = &model.UpdateSyncRequest{ UserNames: &listUserNamesbody, GroupNames: &listGroupNamesbody, IsAllSync: &isAllSyncUpdateSyncRequest, } response, err := client.UpdateSyncIamUser(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 202 | Synchronous request result. |
Error Codes
For details, see Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot