IoT Core Broker Service, gRPC: BrokerService.Create

Статья создана

Yandex Cloud

Обновлена 17 октября 2024 г.

gRPC request
CreateBrokerRequest
Certificate
LogOptions
operation.Operation
CreateBrokerMetadata
Broker
LogOptions

Creates a broker in the specified folder.

gRPC request

rpc Create (CreateBrokerRequest) returns (operation.Operation)

CreateBrokerRequest

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "certificates": [
    {
      "certificateData": "string"
    }
  ],
  "password": "string",
  "logOptions": {
    "disabled": "bool",
    // Includes only one of the fields `logGroupId`, `folderId`
    "logGroupId": "string",
    "folderId": "string",
    // end of the list of possible fields
    "minLevel": "Level"
  }
}

Field	Description
folderId	string Required field. ID of the folder to create a broker in. To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Required field. Name of the broker. The name must be unique within the folder.
description	string Description of the broker.
labels	string Resource labels as `key:value` pairs.
certificates[]	Certificate Broker certificates.
password	string Broker passwords. The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols.
logOptions	LogOptions Options for logging broker events

Certificate

Specification of a broker certificate.

Field

Description

certificateData

string

Public part of the broker certificate.

LogOptions

Field	Description
disabled	bool Is logging from broker disabled.
logGroupId	string Entry should be written to log group resolved by ID. Includes only one of the fields `logGroupId`, `folderId`. Log entries destination.
folderId	string Entry should be written to default log group for specified folder. Includes only one of the fields `logGroupId`, `folderId`. Log entries destination.
minLevel	enum Level Minimum log entry level. See LogLevel.Level for details. `LEVEL_UNSPECIFIED`: Default log level. Equivalent to not specifying log level at all. `TRACE`: Trace log level. Possible use case: verbose logging of some business logic. `DEBUG`: Debug log level. Possible use case: debugging special cases in application logic. `INFO`: Info log level. Mostly used for information messages. `WARN`: Warn log level. May be used to alert about significant events. `ERROR`: Error log level. May be used to alert about errors in infrastructure, logic, etc. `FATAL`: Fatal log level. May be used to alert about unrecoverable failures and events.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "brokerId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "status": "Status",
    "logOptions": {
      "disabled": "bool",
      // Includes only one of the fields `logGroupId`, `folderId`
      "logGroupId": "string",
      "folderId": "string",
      // end of the list of possible fields
      "minLevel": "Level"
    }
  }
  // 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	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	CreateBrokerMetadata 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	google.rpc.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	Broker 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.

CreateBrokerMetadata

Field

Description

brokerId

string

ID of the broker that is being created.

Broker

A broker.

Field	Description
id	string ID of the broker.
folderId	string ID of the folder that the broker belongs to.
createdAt	google.protobuf.Timestamp Creation timestamp.
name	string Name of the broker. The name is unique within the folder.
description	string Description of the broker. 0-256 characters long.
labels	string Resource labels as `key:value` pairs. Maximum of 64 per resource.
status	enum Status Status of the broker. `STATUS_UNSPECIFIED` `CREATING`: Broker is being created. `ACTIVE`: Broker is ready to use. `DELETING`: Broker is being deleted.
logOptions	LogOptions Options for logging broker events

LogOptions

Field	Description
disabled	bool Is logging from broker disabled.
logGroupId	string Entry should be written to log group resolved by ID. Includes only one of the fields `logGroupId`, `folderId`. Log entries destination.
folderId	string Entry should be written to default log group for specified folder. Includes only one of the fields `logGroupId`, `folderId`. Log entries destination.
minLevel	enum Level Minimum log entry level. See LogLevel.Level for details. `LEVEL_UNSPECIFIED`: Default log level. Equivalent to not specifying log level at all. `TRACE`: Trace log level. Possible use case: verbose logging of some business logic. `DEBUG`: Debug log level. Possible use case: debugging special cases in application logic. `INFO`: Info log level. Mostly used for information messages. `WARN`: Warn log level. May be used to alert about significant events. `ERROR`: Error log level. May be used to alert about errors in infrastructure, logic, etc. `FATAL`: Fatal log level. May be used to alert about unrecoverable failures and events.

IoT Core Broker Service, gRPC: BrokerService.Create

gRPC requestgRPC request

CreateBrokerRequestCreateBrokerRequest

CertificateCertificate

LogOptionsLogOptions

operation.Operationoperation.Operation

CreateBrokerMetadataCreateBrokerMetadata

BrokerBroker

LogOptionsLogOptions

Была ли статья полезна?

gRPC request

CreateBrokerRequest

Certificate

LogOptions

operation.Operation

CreateBrokerMetadata

Broker

LogOptions