UpdateUser--云堡垒机-火山引擎

文档中心

立即注册

导航

UpdateUser

最近更新时间：2024.04.16 19:47:31首次发布时间：2023.12.15 10:45:22

更新用户信息，修改已导入云堡垒机用户的配置信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=UpdateUser&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateUser	接口名称。当前 API 的名称为 `UpdateUser`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
Password	String	否	pAssw0rd	云堡垒机密码。密码需要同时包含大写字母、小写字母、数字以及特殊字符，密码长度不能小于 8 位。
Enable	Boolean	否	true	是否启用该用户，取值: true：启用。 false：禁用。
FullTime	Boolean	否	true	是否全时段可登录，取值： true：全时段可登录。设置此值则不需要设置有效登录起始时间以及有效登录结束时间。 false：有限时间段可登录。设置此值后必须设置有效登录起始时间以及有效登录结束时间。
StartTime	String	否	2023-09-12 10:34:30	用户允许登录的起始时间。
EndTime	String	否	2023-09-12 10:34:30	用户允许登录的结束时间。
UserId	String	是	5e5***-c3ba-11ec-890f-0a***c8352	用户 ID 。
UserGroupIds	Array of String	否	["cf***-a0e2-11ec-ba2c-d2***51543"]	该用户需要关联的用户组 ID 列表。
InstanceId	String	是	vbh-21****2257-6vcphcm8	云堡垒机 ID。

请求示例

POST https://open.volcengineapi.com/?Action=UpdateUser&Version=2021-06-01
Content-Type: application/json
{
    "Password": "pAssw0rd",
    "Enable": true,
    "FullTime": true,
    "StartTime": "2023-09-12 10:34:30",
    "EndTime": "2023-09-12 10:34:30",
    "UserId": "5e5****e-c3ba-11ec-890f-*****a9c8352",
    "UserGroupIds": ["cf*****b-a0e2-11ec-ba2c-d****951543"],
    "InstanceId": "vbh-21****2257-6vcphcm8"
}

返回参数

无

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "UpdateUser",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。