Связаться с намиПодключиться

Managed Service for Apache Kafka® API, REST: User.Create

Статья создана
Обновлена 17 октября 2024 г.

Creates a Kafka user in the specified cluster.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/users

Path parameters

Field

Description

clusterId

string

Required field. ID of the Apache Kafka® cluster to create a user in.

To get the cluster ID, make a ClusterService.List request.

Body parameters

{
  "userSpec": {
    "name": "string",
    "password": "string",
    "permissions": [
      {
        "topicName": "string",
        "role": "string",
        "allowHosts": [
          "string"
        ]
      }
    ]
  }
}

Field

Description

userSpec

UserSpec

Required field. Configuration of the user to create.

UserSpec

Field

Description

name

string

Required field. Name of the Kafka user.

password

string

Required field. Password of the Kafka user.

permissions[]

Permission

Set of permissions granted to the user.

Permission

Field

Description

topicName

string

Name or prefix-pattern with wildcard for the topic that the permission grants access to.

To get the topic name, make a TopicService.List request.

role

enum (AccessRole)

Access role type to grant to the user.

  • ACCESS_ROLE_UNSPECIFIED
  • ACCESS_ROLE_PRODUCER: Producer role for the user.
  • ACCESS_ROLE_CONSUMER: Consumer role for the user.
  • ACCESS_ROLE_ADMIN: Admin role for the user.

allowHosts[]

string

Lists hosts allowed for this permission.
Only ip-addresses allowed as value of single host.
When not defined, access from any host is allowed.

Bare in mind that the same host might appear in multiple permissions at the same time,
hence removing individual permission doesn't automatically restricts access from the allowHosts of the permission.
If the same host(s) is listed for another permission of the same principal/topic, the host(s) remains allowed.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string",
    "userName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "name": "string",
    "clusterId": "string",
    "permissions": [
      {
        "topicName": "string",
        "role": "string",
        "allowHosts": [
          "string"
        ]
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateUserMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

User

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateUserMetadata

Field

Description

clusterId

string

ID of the Apache Kafka® cluster the user is being created in.

userName

string

Name of the user that is being created.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

User

A Kafka user.
For more information, see the Operations -> Accounts section of the documentation.

Field

Description

name

string

Name of the Kafka user.

clusterId

string

ID of the Apache Kafka® cluster the user belongs to.

To get the Apache Kafka® cluster ID, make a ClusterService.List request.

permissions[]

Permission

Set of permissions granted to this user.

Permission

Field

Description

topicName

string

Name or prefix-pattern with wildcard for the topic that the permission grants access to.

To get the topic name, make a TopicService.List request.

role

enum (AccessRole)

Access role type to grant to the user.

  • ACCESS_ROLE_UNSPECIFIED
  • ACCESS_ROLE_PRODUCER: Producer role for the user.
  • ACCESS_ROLE_CONSUMER: Consumer role for the user.
  • ACCESS_ROLE_ADMIN: Admin role for the user.

allowHosts[]

string

Lists hosts allowed for this permission.
Only ip-addresses allowed as value of single host.
When not defined, access from any host is allowed.

Bare in mind that the same host might appear in multiple permissions at the same time,
hence removing individual permission doesn't automatically restricts access from the allowHosts of the permission.
If the same host(s) is listed for another permission of the same principal/topic, the host(s) remains allowed.
Предыдущая
List
Следующая
Update