package control

Get desktop application:
View/edit binary Protocol Buffers messages

`ControlService` provides an interface for internal work with the storage node.

• rpc DropObjects (DropObjectsRequest, DropObjectsResponse)

  service.proto:18

  Immediately remove objects from node's local object storage.

  message DropObjectsRequest

  service.proto:108

  Request to drop the objects.

  • optional DropObjectsRequest.Body body = 1

    Body of the request message.

  • optional Signature signature = 2

    Body signature.

  message DropObjectsResponse

  service.proto:124

  Response to request to drop the objects.

  • optional DropObjectsResponse.Body body = 1

    Body of the response message.

  • optional Signature signature = 2

    Body signature.

• rpc DumpShard (DumpShardRequest, DumpShardResponse)

  service.proto:30

  Dump objects from the shard.

  message DumpShardRequest

  service.proto:227

  DumpShard request.

  • optional DumpShardRequest.Body body = 1

    Body of dump shard request message.

  • optional Signature signature = 2

    Body signature.

  message DumpShardResponse

  service.proto:248

  DumpShard response.

  • optional DumpShardResponse.Body body = 1

    Body of dump shard response message.

  • optional Signature signature = 2

    Body signature.

• rpc EvacuateShard (EvacuateShardRequest, EvacuateShardResponse)

  service.proto:36

  EvacuateShard moves all data from one shard to the others.

  message EvacuateShardRequest

  service.proto:296

  EvacuateShard request.

  • optional EvacuateShardRequest.Body body = 1

  • optional Signature signature = 2

  message EvacuateShardResponse

  service.proto:311

  EvacuateShard response.

  • optional EvacuateShardResponse.Body body = 1

  • optional Signature signature = 2

• rpc FlushCache (FlushCacheRequest, FlushCacheResponse)

  service.proto:39

  FlushCache moves all data from one shard to the others.

  message FlushCacheRequest

  service.proto:322

  FlushCache request.

  • optional FlushCacheRequest.Body body = 1

  • optional Signature signature = 2

  message FlushCacheResponse

  service.proto:334

  FlushCache response.

  • optional FlushCacheResponse.Body body = 1

  • optional Signature signature = 2

• rpc HealthCheck (HealthCheckRequest, HealthCheckResponse)

  service.proto:12

  Performs health check of the storage node.

  message HealthCheckRequest

  service.proto:49

  Health check request.

  • optional HealthCheckRequest.Body body = 1

    Body of health check request message.

  • optional Signature signature = 2

    Body signature.

  message HealthCheckResponse

  service.proto:62

  Health check request.

  • optional HealthCheckResponse.Body body = 1

    Body of health check response message.

  • optional Signature signature = 2

    Body signature.

• rpc ListObjects (ListObjectsRequest, stream ListObjectsResponse)

  service.proto:24

  Returns list that contains information about all objects in a node.

  message ListObjectsRequest

  service.proto:165

  Request to list all objects in the node.

  • optional ListObjectsRequest.Body body = 1

    Body of the request message.

  • optional Signature signature = 2

    Body signature.

  message ListObjectsResponse

  service.proto:178

  ListObjects response.

  • optional ListObjectsResponse.Body body = 1

    Body of the response message.

  • optional Signature signature = 2

    Body signature.

• rpc ListShards (ListShardsRequest, ListShardsResponse)

  service.proto:21

  Returns list that contains information about all shards of a node.

  message ListShardsRequest

  service.proto:137

  Request to list all shards of the node.

  • optional ListShardsRequest.Body body = 1

    Body of the request message.

  • optional Signature signature = 2

    Body signature.

  message ListShardsResponse

  service.proto:150

  ListShards response.

  • optional ListShardsResponse.Body body = 1

    Body of the response message.

  • optional Signature signature = 2

    Body signature.

• rpc ObjectStatus (ObjectStatusRequest, ObjectStatusResponse)

  service.proto:42

  ObjectStatus requests object status in the storage engine.

  message ObjectStatusRequest

  service.proto:344

  ObjectStatus request.

  • optional ObjectStatusRequest.Body body = 1

    Body of object status request message.

  • optional Signature signature = 2

    Body signature.

  message ObjectStatusResponse

  service.proto:359

  ObjectStatus response.

  • optional ObjectStatusResponse.Body body = 1

    Body of object status response message.

  • optional Signature signature = 2

    Body signature.

• rpc RestoreShard (RestoreShardRequest, RestoreShardResponse)

  service.proto:33

  Restore objects from dump.

  message RestoreShardRequest

  service.proto:262

  RestoreShard request.

  • optional RestoreShardRequest.Body body = 1

    Body of restore shard request message.

  • optional Signature signature = 2

    Body signature.

  message RestoreShardResponse

  service.proto:283

  RestoreShard response.

  • optional RestoreShardResponse.Body body = 1

    Body of restore shard response message.

  • optional Signature signature = 2

    Body signature.

• rpc ReviveObject (ReviveObjectRequest, ReviveObjectResponse)

  service.proto:45

  ReviveObject purge all removal marks from all metabases for object.

  message ReviveObjectRequest

  service.proto:390

  ReviveObject request.

  • optional ReviveObjectRequest.Body body = 1

    Body of revive object request message.

  • optional Signature signature = 2

    Body signature.

  message ReviveObjectResponse

  service.proto:405

  ReviveObject response.

  • optional ReviveObjectResponse.Body body = 1

    Body of revive object response message.

  • optional Signature signature = 2

    Body signature.

• rpc SetNetmapStatus (SetNetmapStatusRequest, SetNetmapStatusResponse)

  service.proto:15

  Sets status of the storage node in NeoFS network map.

  message SetNetmapStatusRequest

  service.proto:80

  Set netmap status request.

  • optional SetNetmapStatusRequest.Body body = 1

    Body of set netmap status request message.

  • optional Signature signature = 2

    Body signature.

  message SetNetmapStatusResponse

  service.proto:95

  Set netmap status response.

  • optional SetNetmapStatusResponse.Body body = 1

    Body of set netmap status response message.

  • optional Signature signature = 2

    Body signature.

• rpc SetShardMode (SetShardModeRequest, SetShardModeResponse)

  service.proto:27

  Sets mode of the shard.

  message SetShardModeRequest

  service.proto:193

  Request to set mode of the shard.

  • optional SetShardModeRequest.Body body = 1

    Body of set shard mode request message.

  • optional Signature signature = 2

    Body signature.

  message SetShardModeResponse

  service.proto:214

  SetShardMode response.

  • optional SetShardModeResponse.Body body = 1

    Body of set shard mode response message.

  • optional Signature signature = 2

    Body signature.

Blobstor component description.

Used in: ShardInfo

• string path = 1

  Path to the root.

• string type = 2

  Component type.

Request body structure.

Used in: DropObjectsRequest

• repeated bytes address_list = 1

  List of object addresses to be removed. in NeoFS API binary format.

Response body structure.

Used in: DropObjectsResponse

(message has no fields)

Request body structure.

Used in: DumpShardRequest

• bytes shard_ID = 1

  ID of the shard.

• string filepath = 2

  Path to the output.

• bool ignore_errors = 3

  Flag indicating whether object read errors should be ignored.

Response body structure.

Used in: DumpShardResponse

(message has no fields)

Request body structure.

Used in: EvacuateShardRequest

• repeated bytes shard_ID = 1

  ID of the shard.

• bool ignore_errors = 2

  Flag indicating whether object read errors should be ignored.

Response body structure.

Used in: EvacuateShardResponse

• uint32 count = 1

Request body structure.

Used in: FlushCacheRequest

• repeated bytes shard_ID = 1

  ID of the shard.

Response body structure.

Used in: FlushCacheResponse

(message has no fields)

Health check request body.

Used in: HealthCheckRequest

(message has no fields)

Health check response body

Used in: HealthCheckResponse

• NetmapStatus netmap_status = 1

  Status of the storage node in NeoFS network map.

• HealthStatus health_status = 2

  Health status of storage node application.

Health status of the storage node application.

Used in: HealthCheckResponse.Body

• HEALTH_STATUS_UNDEFINED = 0

  Undefined status, default value.

• STARTING = 1

  Storage node application is starting.

• READY = 2

  Storage node application is started and serves all services.

• SHUTTING_DOWN = 3

  Storage node application is shutting down.

Request body structure.

Used in: ListObjectsRequest

(message has no fields)

Response body structure.

Used in: ListObjectsResponse

• repeated bytes object_address = 1

  Addresses of the object.

Request body structure.

Used in: ListShardsRequest

(message has no fields)

Response body structure.

Used in: ListShardsResponse

• repeated ShardInfo shards = 1

  List of the node's shards.

Network map structure.

• uint64 epoch = 1

  Network map revision number.

• repeated NodeInfo nodes = 2

  Nodes presented in network.

Status of the storage node in the NeoFS network map.

Used in: HealthCheckResponse.Body, NodeInfo, SetNetmapStatusRequest.Body

• STATUS_UNDEFINED = 0

  Undefined status, default value.

• ONLINE = 1

  Node is online.

• OFFLINE = 2

  Node is offline.

• MAINTENANCE = 3

  Node is maintained by the owner.

NeoFS node description.

Used in: Netmap

• bytes public_key = 1

  Public key of the NeoFS node in a binary format.

• repeated string addresses = 2

  Ways to connect to a node.

• repeated NodeInfo.Attribute attributes = 3

  Carries list of the NeoFS node attributes in a key-value form. Key name must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo structures with duplicated attribute names or attributes with empty values will be considered invalid.

• NetmapStatus state = 4

  Carries state of the NeoFS node.

Administrator-defined Attributes of the NeoFS Storage Node. `Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8 string. Value can't be empty. Node's attributes are mostly used during Storage Policy evaluation to calculate object's placement and find a set of nodes satisfying policy requirements. There are some "well-known" node attributes common to all the Storage Nodes in the network and used implicitly with default values if not explicitly set: * Capacity \ Total available disk space in Gigabytes. * Price \ Price in GAS tokens for storing one GB of data during one Epoch. In node attributes it's a string presenting floating point number with comma or point delimiter for decimal part. In the Network Map it will be saved as 64-bit unsigned integer representing number of minimal token fractions. * Locode \ Node's geographic location in [UN/LOCODE](https://www.unece.org/cefact/codesfortrade/codes_index.html) format approximated to the nearest point defined in standard. * Country \ Country code in [ISO 3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. Calculated automatically from `Locode` attribute * Region \ Country's administrative subdivision where node is located. Calculated automatically from `Locode` attribute based on `SubDiv` field. Presented in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. * City \ City, town, village or rural area name where node is located written without diacritics . Calculated automatically from `Locode` attribute. For detailed description of each well-known attribute please see the corresponding section in NeoFS Technical specification.

Used in: NodeInfo

• string key = 1

  Key of the node attribute.

• string value = 2

  Value of the node attribute.

• repeated string parents = 3

  Parent keys, if any. For example for `City` it could be `Region` and `Country`.

Request body structure.

Used in: ObjectStatusRequest

• string object_address = 1

  Requested object.

Response body structure.

Used in: ObjectStatusResponse

• repeated Body.Shard shards = 1

  Engine's shards that know something about an object.

Information about an object from a single shard.

Used in: Body

• string shard_id = 1

  String presentation of shard ID.

• repeated Shard.Status storages = 2

  Shard's storages (metabase, write-cache, FSTree, etc).

Status from a single shard's component.

Used in: Shard

• string type = 1

  Component identification.

• string status = 2

  Object's status in a free form (human readable).

Request body structure.

Used in: RestoreShardRequest

• bytes shard_ID = 1

  ID of the shard.

• string filepath = 2

  Path to the output.

• bool ignore_errors = 3

  Flag indicating whether object read errors should be ignored.

Response body structure.

Used in: RestoreShardResponse

(message has no fields)

Request body structure.

Used in: ReviveObjectRequest

• bytes object_address = 1

  Requested object.

Response body structure.

Used in: ReviveObjectResponse

• repeated Body.Shard shards = 1

  Engine's shards in which the object was revived.

Information about of object's revival status from a single shard.

Used in: Body

• string shard_id = 1

  String presentation of shard ID.

• string status = 2

  Object's revival status in a free form (human readable).

Set netmap status request body.

Used in: SetNetmapStatusRequest

• NetmapStatus status = 1

  New storage node status in NeoFS network map.

Set netmap status response body

Used in: SetNetmapStatusResponse

(message has no fields)

Request body structure.

Used in: SetShardModeRequest

• repeated bytes shard_ID = 1

  ID of the shard.

• ShardMode mode = 2

  Mode that requested to be set.

• bool resetErrorCounter = 3

  Flag signifying whether error counter should be set to 0.

Response body structure.

Used in: SetShardModeResponse

(message has no fields)

Shard description.

Used in: ListShardsResponse.Body

• bytes shard_ID = 1

  ID of the shard.

• string metabase_path = 2

  Path to shard's metabase.

• optional BlobstorInfo blobstor = 3

  Shard's blobstor info.

• string writecache_path = 4

  Path to shard's write-cache, empty if disabled.

• ShardMode mode = 5

  Work mode of the shard.

• uint32 errorCount = 6

  Amount of errors occured.

• string pilorama_path = 7

  Path to shard's pilorama storage. DEPRECATED.

Work mode of the shard.

Used in: SetShardModeRequest.Body, ShardInfo

• SHARD_MODE_UNDEFINED = 0

  Undefined mode, default value.

• READ_WRITE = 1

  Read-write.

• READ_ONLY = 2

  Read-only.

• DEGRADED = 3

  Degraded.

• DEGRADED_READ_ONLY = 4

  DegradedReadOnly.

Signature of some message.

Used in: DropObjectsRequest, DropObjectsResponse, DumpShardRequest, DumpShardResponse, EvacuateShardRequest, EvacuateShardResponse, FlushCacheRequest, FlushCacheResponse, HealthCheckRequest, HealthCheckResponse, ListObjectsRequest, ListObjectsResponse, ListShardsRequest, ListShardsResponse, ObjectStatusRequest, ObjectStatusResponse, RestoreShardRequest, RestoreShardResponse, ReviveObjectRequest, ReviveObjectResponse, SetNetmapStatusRequest, SetNetmapStatusResponse, SetShardModeRequest, SetShardModeResponse

• bytes key = 1

  Public key used for signing.

• bytes sign = 2

  Binary signature.