commit
c224470d98
36 changed files with 179 additions and 90 deletions
|
@ -20,6 +20,10 @@
|
|||
- [ListRequest.Body](#frost.fs.container.ListRequest.Body)
|
||||
- [ListResponse](#frost.fs.container.ListResponse)
|
||||
- [ListResponse.Body](#frost.fs.container.ListResponse.Body)
|
||||
- [ListStreamRequest](#frost.fs.container.ListStreamRequest)
|
||||
- [ListStreamRequest.Body](#frost.fs.container.ListStreamRequest.Body)
|
||||
- [ListStreamResponse](#frost.fs.container.ListStreamResponse)
|
||||
- [ListStreamResponse.Body](#frost.fs.container.ListStreamResponse.Body)
|
||||
- [PutRequest](#frost.fs.container.PutRequest)
|
||||
- [PutRequest.Body](#frost.fs.container.PutRequest.Body)
|
||||
- [PutResponse](#frost.fs.container.PutResponse)
|
||||
|
@ -58,6 +62,7 @@ rpc Put(PutRequest) returns (PutResponse);
|
|||
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
||||
rpc Get(GetRequest) returns (GetResponse);
|
||||
rpc List(ListRequest) returns (ListResponse);
|
||||
rpc ListStream(ListStreamRequest) returns (stream ListStreamResponse);
|
||||
|
||||
```
|
||||
|
||||
|
@ -113,7 +118,7 @@ Statuses:
|
|||
| Get | [GetRequest](#frost.fs.container.GetRequest) | [GetResponse](#frost.fs.container.GetResponse) |
|
||||
#### Method List
|
||||
|
||||
Returns all owner's containers from 'Container` smart contract' storage.
|
||||
Returns all owner's containers from `Container` smart contract storage.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS): \
|
||||
|
@ -125,6 +130,21 @@ Statuses:
|
|||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| List | [ListRequest](#frost.fs.container.ListRequest) | [ListResponse](#frost.fs.container.ListResponse) |
|
||||
#### Method ListStream
|
||||
|
||||
Returns all owner's containers from `Container` smart contract storage
|
||||
via stream.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS): \
|
||||
container list has been successfully read;
|
||||
- Common failures (SECTION_FAILURE_COMMON);
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
container list access denied.
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| ListStream | [ListStreamRequest](#frost.fs.container.ListStreamRequest) | [ListStreamResponse](#frost.fs.container.ListStreamResponse) |
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
|
@ -276,6 +296,54 @@ List containers response body.
|
|||
| container_ids | [frost.fs.refs.ContainerID](#frost.fs.refs.ContainerID) | repeated | List of `ContainerID`s belonging to the requested `OwnerID` |
|
||||
|
||||
|
||||
<a name="frost.fs.container.ListStreamRequest"></a>
|
||||
|
||||
### Message ListStreamRequest
|
||||
List containers stream
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [ListStreamRequest.Body](#frost.fs.container.ListStreamRequest.Body) | | Body of list containers stream request message. |
|
||||
| meta_header | [frost.fs.session.RequestMetaHeader](#frost.fs.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [frost.fs.session.RequestVerificationHeader](#frost.fs.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="frost.fs.container.ListStreamRequest.Body"></a>
|
||||
|
||||
### Message ListStreamRequest.Body
|
||||
List containers stream request body.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| owner_id | [frost.fs.refs.OwnerID](#frost.fs.refs.OwnerID) | | Identifier of the container owner. |
|
||||
|
||||
|
||||
<a name="frost.fs.container.ListStreamResponse"></a>
|
||||
|
||||
### Message ListStreamResponse
|
||||
List containers stream
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [ListStreamResponse.Body](#frost.fs.container.ListStreamResponse.Body) | | Body of list containers stream response message. |
|
||||
| meta_header | [frost.fs.session.ResponseMetaHeader](#frost.fs.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [frost.fs.session.ResponseVerificationHeader](#frost.fs.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="frost.fs.container.ListStreamResponse.Body"></a>
|
||||
|
||||
### Message ListStreamResponse.Body
|
||||
List containers stream response body.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| container_ids | [frost.fs.refs.ContainerID](#frost.fs.refs.ContainerID) | repeated | List of `ContainerID`s belonging to the requested `OwnerID` |
|
||||
|
||||
|
||||
<a name="frost.fs.container.PutRequest"></a>
|
||||
|
||||
### Message PutRequest
|
||||
|
|
|
@ -218,6 +218,9 @@ Returns the object Headers without data payload. By default full header is
|
|||
returned. If `main_only` request field is set, the short header with only
|
||||
the very minimal information will be returned instead.
|
||||
|
||||
Max header size is currently not limited by this API, but may be restricted
|
||||
on the service level. By default, gRPC uses a message size of 4 MiB.
|
||||
|
||||
Extended headers can change `Head` behaviour:
|
||||
* [ __SYSTEM__NETMAP_EPOCH ] \
|
||||
Will use the requested version of Network Map for object placement
|
||||
|
@ -715,7 +718,7 @@ Object HEAD response body
|
|||
| ----- | ---- | ----- | ----------- |
|
||||
| header | [HeaderWithSignature](#frost.fs.object.HeaderWithSignature) | | Full object's `Header` with `ObjectID` signature |
|
||||
| short_header | [ShortHeader](#frost.fs.object.ShortHeader) | | Short object header |
|
||||
| split_info | [SplitInfo](#frost.fs.object.SplitInfo) | | Meta information of split hierarchy. |
|
||||
| split_info | [SplitInfo](#frost.fs.object.SplitInfo) | | Meta information of split hierarchy. Indicates that the object is virtual, manual assembly is required. |
|
||||
| ec_info | [ECInfo](#frost.fs.object.ECInfo) | | Meta information for EC object assembly. |
|
||||
|
||||
|
||||
|
@ -763,6 +766,7 @@ PATCH request body
|
|||
| replace_attributes | [bool](#bool) | | If this flag is set, then the object's attributes will be entirely replaced by `new_attributes` list. The empty `new_attributes` list with `replace_attributes = true` just resets attributes list for the object.
|
||||
|
||||
Default `false` value for this flag means the attributes will be just merged. If the incoming `new_attributes` list contains already existing key, then it just replaces it while merging the lists. |
|
||||
| new_split_header | [Header.Split](#frost.fs.object.Header.Split) | | New split header for the object. This defines how the object will relate to other objects in a split operation. |
|
||||
| patch | [PatchRequest.Body.Patch](#frost.fs.object.PatchRequest.Body.Patch) | | The patch that is applied for the object. |
|
||||
|
||||
|
||||
|
@ -1133,7 +1137,8 @@ And some well-known attributes used by applications only:
|
|||
* Name \
|
||||
Human-friendly name
|
||||
* FileName \
|
||||
File name to be associated with the object on saving
|
||||
File name to be associated with the object on saving. FileName must not
|
||||
contain the delimiting symbol '/'.
|
||||
* FilePath \
|
||||
Full path to be associated with the object on saving. Should start with a
|
||||
'/' and use '/' as a delimiting symbol. Trailing '/' should be
|
||||
|
|
|
@ -102,6 +102,7 @@ Section of failed statuses independent of the operation.
|
|||
| SIGNATURE_VERIFICATION_FAIL | 2 | [**1026**] Signature verification failure. |
|
||||
| NODE_UNDER_MAINTENANCE | 3 | [**1027**] Node is under maintenance. |
|
||||
| INVALID_ARGUMENT | 4 | [**1028**] Invalid argument error. If the server fails on validation of a request parameter as the client sent it incorrectly, then this code should be used. |
|
||||
| RESOURCE_EXHAUSTED | 5 | [**1029**] Resource exhausted failure. This code should be used if the operation cannot be performed due to a lack of resources. |
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue