# 更新用户（组）与IAM委托的映射关系-UpdateAgencyMapping #### 功能介绍 更新用户（组）与IAM委托之间的映射关系，用于配置集群访问外部云服务资源时的权限委托。与查询用户（组）与IAM委托的映射关系接口配合使用，可验证更新结果。 #### 接口约束 无 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-mrs/zh-cn_topic_0013582897.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-mrs/mrs_02_0221.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | mrs:cluster:updateAgencyMapping | Write | cluster \* | - g:ResourceTag/\ - g:EnterpriseProjectId | mrs:cluster:syncUser | - iam:agencies:pass - bms:servers:updateMetadata - ecs:cloudServers:updateMetadata | #### URI PUT /v2/{project_id}/clusters/{cluster_id}/agency-mapping 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-mrs/mrs_02_0011.html)。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及 | | cluster_id | 是 | String | **参数解释：** 集群ID。获取方法，请参见[获取集群ID](https://support.huaweicloud.com/api-mrs/mrs_02_9001.html#mrs_02_9001__zh-cn_topic_0264280065_section177891315153619)。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字以及"_"和"-"组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | agency_mappings | 是 | Array of [AgencyMapping] objects | **参数解释：** 用户（组）与委托之间的映射关系详细信息，详细参数说明请参考下表。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3AgencyMapping | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | agency | 是 | String | **参数解释：** 该映射绑定的IAM委托名称，可前往IAM管理控制台获取相关委托名称。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | identifier_type | 是 | String | **参数解释：** 委托类型，分为"User"和"Group"两种。 **约束限制：** 不涉及 **取值范围：** - User：表示该映射关系为针对用户的映射，identifiers中填写用户名称列表。 - Group：表示该映射关系为针对用户组的映射，identifiers中填写用户组名称列表。 **默认取值：** 不涉及 | | identifiers | 是 | Array of strings | **参数解释：** IAM委托映射的用户（组）名称列表，命名规则及限制要求与IAM服务要求相同。请前往IAM服务管理控制台，单击"用户/用户组"按钮，获取用户/用户组名称列表。获取方法，请参见[获取委托用户组名称](https://support.huaweicloud.com/api-organizations/org_04_0028.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | agency_id | 是 | String | **参数解释：** 该映射关系绑定的委托的唯一标识码。请前往IAM，单击"委托"按钮，进入委托页面，将鼠标放置委托名称上，在弹窗中获取委托唯一标识码。获取方法，请参见[获取委托名称和ID](https://support.huaweicloud.com/api-organizations/org_04_0028.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 更新映射请求操作结果。 **取值范围：** - succeeded：操作成功 - failed：操作失败 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 400：操作执行失败 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 400：操作执行失败 | #### 请求示例 更新用户（组）与IAM委托的映射关系示例 ``` PUT https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/agency-mapping { "agency_mappings" : [ { "agency" : "agency01", "identifier_type" : "User", "identifiers" : [ "test" ], "agency_id" : "xxxx" } ] } ``` #### 响应示例 **状态码：200** 更新用户（组）与IAM委托的映射关系成功 ``` { "result" : "succeeded" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新用户（组）与IAM委托的映射关系示例 ``` 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 UpdateAgencyMappingSolution { 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("")) .build(); UpdateAgencyMappingRequest request = new UpdateAgencyMappingRequest(); request.withClusterId("{cluster_id}"); AgencyMappingArray body = new AgencyMappingArray(); List listAgencyMappingsIdentifiers = new ArrayList<>(); listAgencyMappingsIdentifiers.add("test"); List listbodyAgencyMappings = new ArrayList<>(); listbodyAgencyMappings.add( new AgencyMapping() .withAgency("agency01") .withIdentifierType("User") .withIdentifiers(listAgencyMappingsIdentifiers) .withAgencyId("xxxx") ); body.withAgencyMappings(listbodyAgencyMappings); request.withBody(body); try { UpdateAgencyMappingResponse response = client.updateAgencyMapping(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()); } } } ``` - [Python] 更新用户（组）与IAM委托的映射关系示例 ``` # 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("")) \ .build() try: request = UpdateAgencyMappingRequest() request.cluster_id = "{cluster_id}" listIdentifiersAgencyMappings = [ "test" ] listAgencyMappingsbody = [ AgencyMapping( agency="agency01", identifier_type="User", identifiers=listIdentifiersAgencyMappings, agency_id="xxxx" ) ] request.body = AgencyMappingArray( agency_mappings=listAgencyMappingsbody ) response = client.update_agency_mapping(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 更新用户（组）与IAM委托的映射关系示例 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := mrs.NewMrsClient(hcClient) request := &model.UpdateAgencyMappingRequest{} request.ClusterId = "{cluster_id}" var listIdentifiersAgencyMappings = []string{ "test", } var listAgencyMappingsbody = []model.AgencyMapping{ { Agency: "agency01", IdentifierType: "User", Identifiers: listIdentifiersAgencyMappings, AgencyId: "xxxx", }, } request.Body = &model.AgencyMappingArray{ AgencyMappings: listAgencyMappingsbody, } response, err := client.UpdateAgencyMapping(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/MRS/sdk?api=UpdateAgencyMapping&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 更新用户（组）与IAM委托的映射关系成功 | | 400 | 更新用户（组）与IAM委托的映射关系失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-mrs/ErrorCode.html)。