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

文档中心

立即注册

导航

DeleteUsers

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

删除用户，将彻底删除云堡垒机中的用户，但不会删除认证源（例如：IAM 用户）中的原始用户。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	DeleteUsers	接口名称。当前 API 的名称为 `DeleteUsers`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
UserIds	Array of String	是	["b394**-9f7a-11ec-9b4b-c272***451"]	待删除的用户 ID 列表。
InstanceId	String	是	vbh-21****2257-6vcphcm8	云堡垒机 ID。待删除的用户需要是该云堡垒机的用户。

请求示例

POST https://open.volcengineapi.com/?Action=DeleteUsers&Version=2021-06-01
Content-Type: application/json
{
    "UserIds": ["b3****6c-9f7a-11ec-9b4b-c272*****51"],
    "InstanceId": "vbh-21****2257-6vcphcm8"
}

返回参数

无

返回示例

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

错误码

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