# 修改用户参数 - UpdateUser #### 功能介绍 修改用户参数。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:user:modify | Write | rocketmq | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:modify | - | #### URI PUT /v2/{project_id}/instances/{instance_id}/users/{user_name} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | user_name | 是 | String | **参数解释**： 用户名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | access_key | 是 | String | **参数解释**： 用户名，不支持修改，需要填写当前已设置的用户名称。 **约束限制**： 与原用户保持一致。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | secret_key | 是 | String | **参数解释**： 密钥。 **约束限制**： 8-32个字符。 不能以-开头，至少包含以下字符中的3种： - 大写字母 - 小写字母 - 数字 - 特殊字符\`\~!@#$%\^\&\*()-_=+\\\|\[{}\];:'",\<.\>/?。 不能与名称或倒序的名称相同。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | white_remote_address | 否 | String | **参数解释**： IP白名单。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | admin | 否 | Boolean | **参数解释**： 是否为管理员。 **约束限制**： 不涉及。 **取值范围**： - true：是管理员。 - false：不是管理员。 **默认取值**： 不涉及。 | | default_topic_perm | 否 | String | **参数解释**： 默认的主题权限。 **约束限制**： 不涉及。 **取值范围**： - PUB：拥有发布权限。 - SUB：拥有订阅权限。 - PUB\|SUB：拥有发布订阅权限。 - DENY：无权限。 **默认取值**： 不涉及。 | | default_group_perm | 否 | String | **参数解释**： 默认的消费组权限。 **约束限制**： 不涉及。 **取值范围**： - SUB：拥有订阅权限。 - DENY：无权限。 **默认取值**： 不涉及。 | | topic_perms | 否 | Array of [topic_perms] objects | **参数解释**： 特殊的主题权限。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | group_perms | 否 | Array of [group_perms] objects | **参数解释**： 特殊的消费组权限。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3topic_perms | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 主题名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | perm | 否 | String | **参数解释**： Topic权限。 **约束限制**： 不涉及。 **取值范围**： - PUB：拥有发布权限。 - SUB：拥有订阅权限。 - PUB\|SUB：拥有发布订阅权限。 - DENY：无权限。 **默认取值**： 不涉及。 | 表4group_perms | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 消费组名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | perm | 否 | String | **参数解释**： 消费组权限。 **约束限制**： 不涉及。 **取值范围**： - SUB：拥有订阅权限。 - DENY：无权限。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | access_key | String | **参数解释**： 用户名。 **取值范围**： 不涉及。 | | secret_key | String | **参数解释**： 密钥。 **取值范围**： 不涉及。 | | white_remote_address | String | **参数解释**： IP白名单。 **取值范围**： 不涉及。 | | admin | Boolean | **参数解释**： 是否为管理员。 **取值范围**： - true：是管理员。 - false：不是管理员。 | | default_topic_perm | String | **参数解释**： 默认的主题权限。 **取值范围**： - PUB：拥有发布权限。 - SUB：拥有订阅权限。 - PUB\|SUB：拥有发布订阅权限。 - DENY：无权限。 | | default_group_perm | String | **参数解释**： 默认的消费组权限。 **取值范围**： - SUB：拥有订阅权限。 - DENY：无权限。 | | topic_perms | Array of [topic_perms] objects | **参数解释**： 特殊的主题权限。 **取值范围**： 不涉及。 | | group_perms | Array of [group_perms] objects | **参数解释**： 特殊的消费组权限。 **取值范围**： 不涉及。 | 表6topic_perms | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 主题名称。 **取值范围**： 不涉及。 | | perm | String | **参数解释**： Topic权限。 **取值范围**： - PUB：拥有发布权限。 - SUB：拥有订阅权限。 - PUB\|SUB：拥有发布订阅权限。 - DENY：无权限。 | 表7group_perms | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 消费组名称。 **取值范围**： 不涉及。 | | perm | String | **参数解释**： 消费组权限。 **取值范围**： - SUB：拥有订阅权限。 - DENY：无权限。 | #### 请求示例 修改用户参数，授予user_name用户发布、订阅topic1和group1的权限。 ``` PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name} { "access_key" : "user_name", "secret_key" : "Abcd1234!", "white_remote_address" : "", "admin" : false, "default_topic_perm" : "DENY", "default_group_perm" : "DENY", "topic_perms" : [ { "name" : "topic1", "perm" : "PUB|SUB" } ], "group_perms" : [ { "name" : "group1", "perm" : "SUB" } ] } ``` #### 响应示例 **状态码：200** 修改成功。 ``` { "access_key" : "test_01", "admin" : false, "default_group_perm" : "DENY", "default_topic_perm" : "SUB", "group_perms" : [ ], "secret_key" : "Abcd1234!", "topic_perms" : [ ], "white_remote_address" : "" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改用户参数，授予user_name用户发布、订阅topic1和group1的权限。 ``` 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.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateUserSolution { 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); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("")) .build(); UpdateUserRequest request = new UpdateUserRequest(); request.withInstanceId("{instance_id}"); request.withUserName("{user_name}"); User body = new User(); List listbodyGroupPerms = new ArrayList<>(); listbodyGroupPerms.add( new UserGroupPerms() .withName("group1") .withPerm(UserGroupPerms.PermEnum.fromValue("SUB")) ); List listbodyTopicPerms = new ArrayList<>(); listbodyTopicPerms.add( new UserRespTopicPerms() .withName("topic1") .withPerm(UserRespTopicPerms.PermEnum.fromValue("PUB|SUB")) ); body.withGroupPerms(listbodyGroupPerms); body.withTopicPerms(listbodyTopicPerms); body.withDefaultGroupPerm(User.DefaultGroupPermEnum.fromValue("DENY")); body.withDefaultTopicPerm(User.DefaultTopicPermEnum.fromValue("DENY")); body.withAdmin(false); body.withWhiteRemoteAddress(""); body.withSecretKey("Abcd1234!"); body.withAccessKey("user_name"); request.withBody(body); try { UpdateUserResponse response = client.updateUser(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] 修改用户参数，授予user_name用户发布、订阅topic1和group1的权限。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.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 = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("")) \ .build() try: request = UpdateUserRequest() request.instance_id = "{instance_id}" request.user_name = "{user_name}" listGroupPermsbody = [ UserGroupPerms( name="group1", perm="SUB" ) ] listTopicPermsbody = [ UserRespTopicPerms( name="topic1", perm="PUB|SUB" ) ] request.body = User( group_perms=listGroupPermsbody, topic_perms=listTopicPermsbody, default_group_perm="DENY", default_topic_perm="DENY", admin=False, white_remote_address="", secret_key="Abcd1234!", access_key="user_name" ) response = client.update_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) ``` - [Go] 修改用户参数，授予user_name用户发布、订阅topic1和group1的权限。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rocketmq.NewRocketMQClient(hcClient) request := &model.UpdateUserRequest{} request.InstanceId = "{instance_id}" request.UserName = "{user_name}" nameGroupPerms:= "group1" permGroupPerms:= model.GetUserGroupPermsPermEnum().SUB var listGroupPermsbody = []model.UserGroupPerms{ { Name: &nameGroupPerms, Perm: &permGroupPerms, }, } nameTopicPerms:= "topic1" permTopicPerms:= model.GetUserRespTopicPermsPermEnum().PUB|SUB var listTopicPermsbody = []model.UserRespTopicPerms{ { Name: &nameTopicPerms, Perm: &permTopicPerms, }, } defaultGroupPermUser:= model.GetUserDefaultGroupPermEnum().DENY defaultTopicPermUser:= model.GetUserDefaultTopicPermEnum().DENY adminUser:= false whiteRemoteAddressUser:= "" request.Body = &model.User{ GroupPerms: &listGroupPermsbody, TopicPerms: &listTopicPermsbody, DefaultGroupPerm: &defaultGroupPermUser, DefaultTopicPerm: &defaultTopicPermUser, Admin: &adminUser, WhiteRemoteAddress: &whiteRemoteAddressUser, SecretKey: "Abcd1234!", AccessKey: "user_name", } response, err := client.UpdateUser(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/sdk?api=UpdateUser)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 修改成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。