forked from TrueCloudLab/frostfs-api
Release v2.3.0 - Seonyudo (선유도, 仙遊島)
UN-LOCODE support and Container's used space reporting Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev
parent
5152f607f1
commit
a37a7c5ef4
5 changed files with 190 additions and 22 deletions
|
|
@ -8,6 +8,11 @@
|
|||
- [ContainerService](#neo.fs.v2.container.ContainerService)
|
||||
|
||||
- Messages
|
||||
- [AnnounceUsedSpaceRequest](#neo.fs.v2.container.AnnounceUsedSpaceRequest)
|
||||
- [AnnounceUsedSpaceRequest.Body](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body)
|
||||
- [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement)
|
||||
- [AnnounceUsedSpaceResponse](#neo.fs.v2.container.AnnounceUsedSpaceResponse)
|
||||
- [AnnounceUsedSpaceResponse.Body](#neo.fs.v2.container.AnnounceUsedSpaceResponse.Body)
|
||||
- [DeleteRequest](#neo.fs.v2.container.DeleteRequest)
|
||||
- [DeleteRequest.Body](#neo.fs.v2.container.DeleteRequest.Body)
|
||||
- [DeleteResponse](#neo.fs.v2.container.DeleteResponse)
|
||||
|
|
@ -68,6 +73,7 @@ rpc Get(GetRequest) returns (GetResponse);
|
|||
rpc List(ListRequest) returns (ListResponse);
|
||||
rpc SetExtendedACL(SetExtendedACLRequest) returns (SetExtendedACLResponse);
|
||||
rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
|
||||
rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest) returns (AnnounceUsedSpaceResponse);
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -122,9 +128,74 @@ storage.
|
|||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| GetExtendedACL | [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest) | [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse) |
|
||||
#### Method AnnounceUsedSpace
|
||||
|
||||
Announce container used space values for P2P synchronization.
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| AnnounceUsedSpace | [AnnounceUsedSpaceRequest](#neo.fs.v2.container.AnnounceUsedSpaceRequest) | [AnnounceUsedSpaceResponse](#neo.fs.v2.container.AnnounceUsedSpaceResponse) |
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceRequest"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceRequest
|
||||
Announce container used space
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [AnnounceUsedSpaceRequest.Body](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body) | | Body of announce used space request message. |
|
||||
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.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="neo.fs.v2.container.AnnounceUsedSpaceRequest.Body"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceRequest.Body
|
||||
Container used space announcement body.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| announcements | [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement) | repeated | List of announcements. If nodes share several containers, then announcements transferred in a batch. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceRequest.Body.Announcement
|
||||
Announcement contains used space information about single container.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| epoch | [uint64](#uint64) | | Epoch number for which container size estimation was produced. |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container. |
|
||||
| used_space | [uint64](#uint64) | | Used space is a sum of object payload sizes of specified container, stored in the node. It must not include inhumed objects. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceResponse"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceResponse
|
||||
Announce container used space
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [AnnounceUsedSpaceResponse.Body](#neo.fs.v2.container.AnnounceUsedSpaceResponse.Body) | | Body of announce used space response message. |
|
||||
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.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="neo.fs.v2.container.AnnounceUsedSpaceResponse.Body"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceResponse.Body
|
||||
`AnnounceUsedSpaceResponse` has an empty body because announcements are
|
||||
one way communication.
|
||||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.DeleteRequest"></a>
|
||||
|
||||
### Message DeleteRequest
|
||||
|
|
|
|||
|
|
@ -177,21 +177,37 @@ explicitly set:
|
|||
* Subnet \
|
||||
String ID of Node's storage subnet. There can be only one subnet served
|
||||
by the Storage Node.
|
||||
* Locode \
|
||||
* UN-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 \
|
||||
format approximated to the nearest point defined in the standard.
|
||||
* CountryCode \
|
||||
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 administative 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.
|
||||
format. Calculated automatically from `UN-LOCODE` attribute.
|
||||
* Country \
|
||||
Country short name in English, as defined in
|
||||
[ISO-3166](https://www.iso.org/obp/ui/#search). Calculated automatically
|
||||
from `UN-LOCODE` attribute.
|
||||
* Location \
|
||||
Place names are given, whenever possible, in their national language
|
||||
versions as expressed in the Roman alphabet using the 26 characters of
|
||||
the character set adopted for international trade data interchange,
|
||||
written without diacritics . Calculated automatically from `UN-LOCODE`
|
||||
attribute.
|
||||
* SubDivCode \
|
||||
Country's administrative subdivision where node is located. Calculated
|
||||
automatically from `UN-LOCODE` attribute based on `SubDiv` field.
|
||||
Presented in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)
|
||||
format.
|
||||
* SubDiv \
|
||||
Country's administrative subdivision name, as defined in
|
||||
[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). Calculated
|
||||
automatically from `UN-LOCODE` attribute.
|
||||
* Continent \
|
||||
Node's continent name according to the [Seven-Continent model]
|
||||
(https://en.wikipedia.org/wiki/Continent#Number). Calculated
|
||||
automatically from `UN-LOCODE` attribute.
|
||||
|
||||
For detailed description of each well-known attribute please see the
|
||||
corresponding section in NeoFS Technical specification.
|
||||
|
|
|
|||
|
|
@ -597,6 +597,10 @@ properties:
|
|||
Returns only objects physically stored in the system. This filter is
|
||||
activated if the `key` exists, disregarding the value and matcher type.
|
||||
|
||||
Note: using filters with a key with prefix `$Object:` and match type
|
||||
`NOT_PRESENT `is not recommended since this is not a cross-version approach.
|
||||
Behavior when processing this kind of filters is undefined.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
|
|
@ -780,6 +784,8 @@ Type of match expression
|
|||
| ---- | ------ | ----------- |
|
||||
| MATCH_TYPE_UNSPECIFIED | 0 | Unknown. Not used |
|
||||
| STRING_EQUAL | 1 | Full string match |
|
||||
| STRING_NOT_EQUAL | 2 | Full string mismatch |
|
||||
| NOT_PRESENT | 3 | Lack of key |
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ Session creation request body
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Dession initiating user's or node's key derived `OwnerID`. |
|
||||
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Session initiating user's or node's key derived `OwnerID` |
|
||||
| expiration | [uint64](#uint64) | | Session expiration `Epoch` |
|
||||
|
||||
|
||||
|
|
@ -243,7 +243,25 @@ Lifetime parameters of the token. Field names taken from rfc7519.
|
|||
<a name="neo.fs.v2.session.XHeader"></a>
|
||||
|
||||
### Message XHeader
|
||||
Extended headers for Request/Response.
|
||||
Extended headers for Request/Response. May contain any user-defined headers
|
||||
to be interpreted on application level.
|
||||
|
||||
Key name must be unique valid UTF-8 string. Value can't be empty. Requests or
|
||||
Responses with duplicated header names or headers with empty values will be
|
||||
considered invalid.
|
||||
|
||||
There are some "well-known" headers starting with `__NEOFS__` prefix that
|
||||
affect system behaviour:
|
||||
|
||||
* __NEOFS__NETMAP_EPOCH \
|
||||
Netmap epoch to use for object placement calculation. The `value` is string
|
||||
encoded `uint64` in decimal presentation. If set to '0' or not set, the
|
||||
current epoch only will be used.
|
||||
* __NEOFS__NETMAP_LOOKUP_DEPTH \
|
||||
If object can't be found using current epoch's netmap, this header limits
|
||||
how many past epochs back the node can lookup. The `value` is string
|
||||
encoded `uint64` in decimal presentation. If set to '0' or not set, the
|
||||
current epoch only will be used.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue