doc-exports/docs/dms/api-ref/BatchDeleteInstanceUsers.html
Chen, Junjie f5b629cc78 DMS API 20240722 version
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-09-06 09:17:23 +00:00

5.3 KiB

Deleting Users in Batches

Function

This API is used to delete multiple users of a Kafka instance.

URI

PUT /v2/{project_id}/instances/{instance_id}/users

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

No

String

Deletion type. Currently, only delete is supported.

This parameter is mandatory for deleting a user.

users

No

Array of strings

User list.

This parameter is mandatory for deleting a user.

Response Parameters

None

Example Requests

Deleting users in batches.

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users

{
  "action" : "delete",
  "users" : [ "testuser" ]
}

Example Responses

None

Status Codes

Status Code

Description

204

The deletion is successful.

Error Codes

See Error Codes.