ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-28 23:55:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: rename deprecated i18n to l10n

Browse Source
This commit is contained in:
Vova Rutskyi
2024-09-23 15:13:11 +03:00
committed by amarantha-k
parent 6cbb3a036f
commit 9a0c010600
502 changed files with 984 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md Normal file
View File

@@ -0,0 +1,121 @@
---
html: ledger-clio.html # Watch carefully for clashes w/ this filename
parent: clio-methods.html
seo:
description: レジャーのバージョン情報を取得します。
labels:
- ブロックチェーン
---
# ledger
[[ソース]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/Ledger.cpp "ソース")
`ledger`コマンドは公開されている[レジャー](../../../../concepts/ledgers/index.md)の情報を取得します。{% badge href="https://github.com/XRPLF/clio/releases/tag/1.0.0" %}新規: Clio v1.0.0{% /badge %}
Clioサーバはデフォルトで検証済みのレジャーデータを返すことに注意してください。
## リクエストのフォーマット
リクエストのフォーマットの例:
{% tabs %}
{% tab label="WebSocket" %}
{% code-snippet file="/_api-examples/ledger-clio/wsrpc-request.json" language="json" /%}
{% /tab %}
{% tab label="JSON-RPC" %}
{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-request.json" language="json" /%}
{% /tab %}
{% /tabs %}
<!-- [Try it! >](websocket-api-tool.html#ledger) -->
リクエストには以下のパラメータを含めることができます。
| `Field` | 型 | 説明 |
|:---------------|:----------------------|:-------------------------------|
| `ledger_hash` | [ハッシュ][] | _(省略可)_ 使用するレジャーバージョンの20バイトの16進文字列。([レジャーの指定][]ご覧ください。) |
| `ledger_index` | [レジャーインデックス][] | _(省略可)_ 使用するレジャーの[レジャーインデックス][]、またはレジャーを自動的に選択するためのショートカット文字列。([レジャーの指定][]をご覧ください) |
| `transactions` | 真偽値 | _(省略可)_ `true`の場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトでは`false`です。レジャーバージョンを指定しない場合は無視されます。 |
| `expand` | 真偽値 | _(省略可)_ ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトでは`false`です。トランザクション、アカウント、またはその両方をリクエストしない場合は無視されます。 |
| `owner_funds` | 真偽値 | _(省略可)_ `true`の場合、レスポンスのOfferCreateトランザクションのメタデータに`owner_funds`フィールドが含まれます。デフォルトでは`false`です。トランザクションが含まれておらず、`expand`がtrueではない場合には無視されます。 |
| `binary` | 真偽値 | _(省略可)_ `true`で、かつ`transactions`と`expand`が両方とも`true`の場合、JSONフォーマットではなくバイナリフォーマット（16進文字列）でトランザクション情報が返されます。 |
| `diff` | 真偽値 | _(省略可)_ `true`の場合、指定したレジャーのトランザクションの一部として追加、変更、または削除されたすべてのオブジェクトを返します。 |
`ledger`フィールドは廃止予定であり、今後予告なしに削除される可能性があります。
{% admonition type="info" name="注記" %}
Clioの`ledger`コマンドは、[rippledのledgerコマンド](../ledger-methods/ledger.md)でサポートされている以下のフィールドをサポートしていません。
* `accounts`
* `full`
* `queue`
上記のフィールドのいずれかが`true`に設定されている場合、Clioは**常に**リクエストを`rippled`に転送します。
{% /admonition %}
## レスポンスのフォーマット
処理が成功したレスポンスの例:
{% tabs %}
{% tab label="WebSocket" %}
{% code-snippet file="/_api-examples/ledger-clio/wsrpc-response.json" language="json" /%}
{% /tab %}
{% tab label="JSON-RPC" %}
{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%}
{% /tab %}
{% /tabs %}
レスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。
| `Field` | 型 | 説明 |
|:-------------------------------|:-----------|:----------------------------------|
| `ledger` | オブジェクト | このレジャーの完全なヘッダーデータ。 |
| `ledger.account_hash` | 文字列 | このレジャーのすべてのアカウントの状態情報のハッシュ値。 |
| `ledger.accountState` | 配列 | (リクエストで指定がない場合省略) このレジャーのすべての[アカウント状態情報](../../../protocol/ledger-data/index.md)(16進数) |
| `ledger.close_flags` | 数値 | このレジャーの[クローズに関するフラグ](../../../protocol/ledger-data/ledger-header.md#close-flags)のビットマップ。 |
| `ledger.close_time` | 数値 | レジャーが閉鎖された時刻（[Rippleエポック以降の経過秒数][]）。 |
| `ledger.close_time_human` | 文字列 | 人間が読めるフォーマットでのこのレジャーが閉鎖された時刻。常にUTCタイムゾーンを使用します。 |
| `ledger.close_time_resolution` | 数値 | レジャー閉鎖時刻が丸められる秒数の範囲。 |
| `ledger.closed` | 真偽値 | このレジャーが閉鎖されているかどうか。 |
| `ledger.ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
| `ledger.ledger_index` | 文字列 | このレジャーの[レジャーインデックス][]。整数を引用符で囲んだ形式で示されます。 |
| `ledger.parent_close_time` | 数値 | 前のレジャーが閉鎖された時刻。 |
| `ledger.parent_hash` | 文字列 | このレジャーの直前のレジャーの一意の識別用ハッシュ。 |
| `ledger.total_coins` | 文字列 | ネットワークのXRPの合計（drop数）。整数を引用符で囲んだ形式で示されます。（トランザクションコストによりXRPが焼却されると、この値は減少します。） |
| `ledger.transaction_hash` | 文字列 | このレジャーに記録されているトランザクション情報のハッシュ（16進数） |
| `ledger.transactions` | 配列 | (リクエストで指定がない場合省略) このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用[ハッシュ][]文字列です。リクエストで`expand`がtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、リクエストで`binary`がtrueとして指定されていたかどうかに応じて決まります。 |
| `ledger_hash` | 文字列 | レジャー全体の一意の識別用ハッシュ。 |
| `ledger_index` | 数値 | このレジャーの[レジャーインデックス][]。 |
| `validated` | 真偽値 | _(省略される場合があります)_ `true`の場合、このレジャーは最終バージョンです。省略または `false` の場合、このレジャーのデータは最終版ではありません。 |
| `diff` | オブジェクト | _(リクエストで`diff`パラメータの指定がない場合省略)_ レジャーのトランザクションの一部として追加、変更、または削除されたハッシュの配列を含むオブジェクト。 |
リクエストに`"owner_funds": true`が指定されておりトランザクションが展開されている場合、レスポンスには、各[OfferCreateトランザクション][]の`metaData`オブジェクトの`owner_funds`フィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとに[オファーの資金化ステータス](../../../../concepts/tokens/decentralized-exchange/offers.md#オファーのライフサイクル)を容易に追跡できるようにすることです。このフィールドの定義は、[オーダーブックサブスクリプションストリーム](../subscription-methods/subscribe.md#オーダーブックストリーム)でのこのフィールドのバージョンとはわずかに異なります。
| `Field` | 値 | 説明 |
|:--------------|:------|:----------------------------------------------------|
| `owner_funds` | 文字列 | このレジャーのすべてのトランザクションの実行後に、このOfferCreateトランザクションを送信する`Account`が保有する`TakerGets`通貨の額。この通貨額が[凍結](../../../../concepts/tokens/fungible-tokens/freezes.md)されているかどうかはチェックされません。 |
リクエストで`”diff": true`を指定した場合、レスポンスにはオブジェクト`diff`が含まれます。このオブジェクトのフィールドは以下の通りです。
| `Field` | 値 | 説明 |
|:--------------|:---------------------------|:----------------------------------------------------|
| `object_id` | 文字列 | オブジェクトのID |
| `Hashes` | オブジェクトまたは16進文字列 | リクエストが`binary`をtrueに設定したかfalseに設定したかに応じて、このフィールドは作成されたオブジェクトの内容、変更されたオブジェクトの新しい値、またはオブジェクトが削除された場合は空の文字列を返します。 |
### `diff`に`true`を設定した場合のレスポンス
`{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-diff-response.json" language="json" /%}`
## 考えられるエラー
* [汎用エラータイプ][]のすべて。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `lgrNotFound` - `ledger_hash`または`ledger_index`で指定したレジャーが存在しないか、存在してはいるもののサーバが保有していません。
{% raw-partial file="/docs/_snippets/common-links.md" /%}

340
@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md Normal file
View File

@@ -0,0 +1,340 @@
---
html: nft_history.html
parent: clio-methods.html
seo:
description: Clioサーバの`nft_history`API を使用して、指定した NFT の所有権と移動の履歴を取得します。
labels:
- 非代替性トークン, NFT
---
# nft_history
[[ソース]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTHistory.cpp "ソース")
`nft_history`コマンドはクエリ対象の[NFT](../../../../concepts/tokens/nfts/index.md)の過去のトランザクションメタデータをClioサーバに問い合わせます。{% badge href="https://github.com/XRPLF/clio/releases/tag/1.1.0" %}新規: Clio v1.1.0{% /badge %}
{% admonition type="info" name="注記" %}`nft_history`はNFTに関連する成功したトランザクションのみを返します。{% /admonition %}
## リクエストのフォーマット
リクエストのフォーマットの例：
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"command": "nft_history",
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"method": "nft_history",
"params": [
{
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
]
}
```
{% /tab %}
{% /tabs %}
[試してみる >](/resources/dev-tools/websocket-api-tool#nft_history)
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:-------------------|:-----------------------|:-------------------------------|
| `nft_id` | 文字列 | 非代替性トークン(NFT)の一意の識別子。 |
| `ledger_index_min` | 整数 | _(省略可)_ NFTを含む最も古いレジャーを指定します。値`-1`を指定すると、検証済みの最も古いレジャーのバージョンを使用するようにサーバに指示します。 |
| `ledger_index_max` | 整数 | _(省略可)_ NFTを含める最新のレジャーを指定します。値`-1`を指定すると、利用可能な最新の有効なレジャーのバージョンを使用するようにサーバに指示します。 |
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーのバージョンを示す20バイトの16進文字列。[レジャーの指定][]をご覧ください）。 |
| `ledger_index` | 文字列 または 符号なし整数 | _(省略可)_ 使用するレジャーの[レジャーインデックス][]あるいは、レジャーを自動的に選択するためのショートカット文字列。 `ledger_index`に`closed`や `current`を指定しないでください。指定した場合、P2Pの`rippled`サーバにリクエストが転送されますが、`nft_history`APIは`rippled`では利用できません。[レジャーの指定][]をご覧ください）。 |
| `binary` | 真偽値 | _(省略可)_ デフォルトは`false`。`true`に設定すると、トランザクションをJSONではなく16進数の文字列で返します。 |
| `forward` | 真偽値 | _(省略可)_ デフォルトは`false`。`true`に設定すると、最も古いレジャーからインデックスを付けて返します。そうでない場合は、新しいレジャーからインデックスが付けられます。(結果の各ページは内部的には順序付けされていないかもしれませんが、ページ全体としては順序付けされています)。 |
| `limit` | UInt32 | _(省略可)_ 取得するNFTの数を制限します。サーバはこの値を守る必要はありません。 |
| `marker` | マーカー | 以前のページ分割されたレスポンスの値。そのレスポンスが終了したところからデータの取得を再開します。サーバで使用可能なレジャーの範囲が変更された場合、この値は変化する可能性があります。"検証済み"レジャーを照会している場合、ページング中に新しいNFTが作成される可能性があります。 |
{% admonition type="info" name="注記" %}レジャーのバージョンを指定しない場合、Clioは検証済みの最新のレジャーを使用します。{% /admonition %}
## レスポンスのフォーマット
処理が成功したレスポンスの例:
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 0,
"type": "response",
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876163,
"transactions": [
{
"meta": {
"AffectedNodes": [
{
"CreatedNode": {
"LedgerEntryType": "NFTokenPage",
"LedgerIndex": "97707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFF",
"NewFields": {
"NFTokens": [
{
"NFToken": {
"NFTokenID": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469"
}
}
]
}
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Balance": "999999988",
"Flags": 0,
"MintedNFTokens": 1,
"OwnerCount": 1,
"Sequence": 27876155
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24",
"PreviousFields": {
"Balance": "1000000000",
"OwnerCount": 0,
"Sequence": 27876154
},
"PreviousTxnID": "B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB6939",
"PreviousTxnLgrSeq": 27876154
}
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Fee": "12",
"Flags": 8,
"LastLedgerSequence": 27876176,
"NFTokenTaxon": 0,
"Sequence": 27876154,
"SigningPubKey": "EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F6",
"TransactionType": "NFTokenMint",
"TransferFee": 10000,
"TxnSignature": "EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C79802",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469",
"hash": "E0774E1B8628E397C6E88F67D4424E55E4C81324607B19318255310A6FBAA4A2",
"ledger_index": 27876158,
"date": 735167200
},
"validated": true
}
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876163,
"transactions": [
{
"meta": {
"AffectedNodes": [
{
"CreatedNode": {
"LedgerEntryType": "NFTokenPage",
"LedgerIndex": "97707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFF",
"NewFields": {
"NFTokens": [
{
"NFToken": {
"NFTokenID": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469"
}
}
]
}
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Balance": "999999988",
"Flags": 0,
"MintedNFTokens": 1,
"OwnerCount": 1,
"Sequence": 27876155
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24",
"PreviousFields": {
"Balance": "1000000000",
"OwnerCount": 0,
"Sequence": 27876154
},
"PreviousTxnID": "B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB6939",
"PreviousTxnLgrSeq": 27876154
}
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "rNoj836fhDm1eXaHHefPKs7iDb4gwzS7nc",
"Fee": "12",
"Flags": 8,
"LastLedgerSequence": 27876176,
"NFTokenTaxon": 0,
"Sequence": 27876154,
"SigningPubKey": "EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F6",
"TransactionType": "NFTokenMint",
"TransferFee": 10000,
"TxnSignature": "EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C79802",
"URI": "697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469",
"hash": "E0774E1B8628E397C6E88F67D4424E55E4C81324607B19318255310A6FBAA4A2",
"ledger_index": 27876158,
"date": 735167200
},
"validated": true
}
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
{% /tab %}
{% /tabs %}
`binary`パラメータを _true_ に設定すると、16進数文字列を使用したコンパクトなレスポンスを受け取ります。人間が読めるものではありませんが、より簡潔です。
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 0,
"type": "response",
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876275,
"transactions": [
{
"meta": "201C00000000F8E31100505697707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFFE8FAEC5A0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B000000007542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469E1F1E1E1E51100612501A95B3A55B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB693956AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24E62401A95B3A2D0000000062400000003B9ACA00E1E722000000002401A95B3B2D00000001202B0000000162400000003B9AC9F4811497707A94B298B50334C39FB46E245D4744C0F5B5E1E1F1031000",
"tx_blob": "12001914271022000000082401A95B3A201B01A95B50202A0000000068400000000000000C7321EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F67440EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C798027542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469811497707A94B298B50334C39FB46E245D4744C0F5B5",
"ledger_index": 27876158,
"date": 735167200,
"validated": true
}
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"result": {
"ledger_index_min": 21377274,
"ledger_index_max": 27876275,
"transactions": [
{
"meta": "201C00000000F8E31100505697707A94B298B50334C39FB46E245D4744C0F5B5FFFFFFFFFFFFFFFFFFFFFFFFE8FAEC5A0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B000000007542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469E1F1E1E1E51100612501A95B3A55B483F0F7100658380E42BCF1B15AD59B71C4082635AD53B78D08A5198BBB693956AC0A2AD29B67B5E6DA1C5DE696440F59BCD8DEA0A4CF7AFD683D1489AAB1ED24E62401A95B3A2D0000000062400000003B9ACA00E1E722000000002401A95B3B2D00000001202B0000000162400000003B9AC9F4811497707A94B298B50334C39FB46E245D4744C0F5B5E1E1F1031000",
"tx_blob": "12001914271022000000082401A95B3A201B01A95B50202A0000000068400000000000000C7321EDDC20C6791F9FB13AFDCE2C717BE8779DD451BB556243F1FDBAA3CD159D68A9F67440EF657AB47E86FDC112BA054D90587DFE64A61604D9EDABAA7B01B61B56433E3C2AC5BF5AD2E8F5D2A9EAC22778F289094AC383A3F172B2304157A533E0C798027542697066733A2F2F62616679626569676479727A74357366703775646D37687537367568377932366E6634646675796C71616266336F636C67747179353566627A6469811497707A94B298B50334C39FB46E245D4744C0F5B5",
"ledger_index": 27876158,
"date": 735167200,
"validated": true
}
],
"nft_id": "0008271097707A94B298B50334C39FB46E245D4744C0F5B50000099B00000000",
"validated": true
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
{% /tab %}
{% /tabs %}
このレスポンスは[標準フォーマット][]に従っており、正常に完了した場合は結果に次のフィールドが含まれます。
| `Field` | 型 | 説明 |
|:-------------------|:----------------------------|:---------------------------|
| `nft_id` | 文字列 | 非代替性トークン(NFT)の一意の識別子。 |
| `ledger_index_min` | 整数 - [レジャーインデックス][] | 実際にトランザクションを検索した最も古いレジャーのレジャーインデックス。 |
| `ledger_index_max` | 整数 - [レジャーインデックス][] | 実際にトランザクションを検索した最新のレジャーのレジャーインデックス。 |
| `limit` | 整数 | リクエストで使われる`limit`の値。(これはサーバによって強制される実際の値とは異なるかもしれません)。 |
| `marker` | [マーカー][] | レスポンスがページ分割されていることを示す、サーバ定義の値。この値を次の呼び出しに渡すと、この呼び出しが中断したところから再開します。 |
| `transactions` | 配列 | 以下に説明するように、リクエストの条件に一致するトランザクションの配列。 |
| `validated` | 真偽値 | レスポンスに含まれ、`true`に設定されている場合、このレスポンスの情報は検証済みのレジャーのバージョンに基づきます。`false`の場合、情報は変更される可能性があります。 |
{% admonition type="info" name="注記" %}例えば、指定したバージョンが手元にない場合、サーバはリクエストで指定した値とは異なる`ledger_index_min`と`ledger_index_max`を返すことがあります。{% /admonition %}
各トランザクションオブジェクトは、JSONまたは16進文字列(`"binary":true`)のどちらの形式でリクエストされたかに応じて、以下のフィールドを含みます。
| `Field` | 型 | 説明 |
|:---------------|:-------------------------------------|:-------------------------|
| `ledger_index` | 整数 | このトランザクションを含むレジャーバージョンの[レジャーインデックス][]。 |
| `meta` | オブジェクト(JSON) または 文字列(バイナリ) | `binary`が`true`の場合、トランザクションメタデータの16文字列が格納されます。`false`の場合は、トランザクションメタデータがJSON 形式で格納されます。 |
| `tx` | オブジェクト | (JSONのみ) トランザクションを定義するJSONオブジェクト |
| `tx_blob` | 文字列 | (Binaryのみ) トランザクションを表す一意のハッシュ化された文字列。 |
| `validated` | 真偽値 | トランザクションが検証済みレジャーに含まれているかどうか。まだ有効なレジャーに含まれていないトランザクションは、変更される可能性があります。 |
`tx`オブジェクトで返されるフィールドの定義については、[トランザクションメタデータ](../../../protocol/transactions/metadata.md)をご覧ください。
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
* `invalidParams` - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
* `actMalformed` - リクエストの`account`フィールドに指定した[アドレス][]が、正しいフォーマットではありません。
* `lgrIdxMalformed` - `ledger_index_min`または`ledger_index_max`で指定されたレジャーが存在しないか、存在してもサーバに保存されていません。
* `lgrIdxsInvalid` - リクエストが`ledger_index_min`よりも前の`ledger_index_max`を指定しているか、サーバが[ネットワークと同期していない](../../../../infrastructure/troubleshooting/server-doesnt-sync.md)ために有効なレジャー範囲を持っていません。
{% raw-partial file="/docs/_snippets/common-links.md" /%}

147
@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md Normal file
View File

@@ -0,0 +1,147 @@
---
html: nft_info.html
parent: clio-methods.html
seo:
description: Clioサーバの`nft_info`APIを使用して、指定したNFTに関する情報を取得します。
labels:
- 非代替性トークン, NFT
---
# nft_info
[[ソース]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTInfo.cpp "ソース")
`nft_info`コマンドはクエリ対象の[NFT](../../../../concepts/tokens/nfts/index.md)に関する情報をClioサーバに問い合わせます。{% badge href="https://github.com/XRPLF/clio/releases/tag/1.1.0" %}新規: Clio v1.1.0{% /badge %}
## リクエストのフォーマット
リクエストのフォーマットの例：
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"command": "nft_info",
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"method": "nft_info",
"params": [
{
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
]
}
```
{% /tab %}
{% /tabs %}
[試してみる >](/resources/dev-tools/websocket-api-tool#nft_info)
リクエストには以下のパラメーターが含まれます。
| `Field` | 型 | 説明 |
|:---------------|:-----------------------|:-----------------------|
| `nft_id` | 文字列 | 非代替性トークン(NFT)の一意の識別子。 |
| `ledger_hash` | 文字列 | _(省略可)_ 使用するレジャーのバージョンを示す20バイトの16進文字列。[レジャーの指定][]をご覧ください）。 |
| `ledger_index` | 文字列 または 符号なし整数 | _(省略可)_ 使用するレジャーの[レジャーインデックス][]あるいは、レジャーを自動的に選択するためのショートカット文字列。`ledger_index`に`closed`や`current`を指定しないでください。指定した場合、P2Pの`rippled`サーバにリクエストが転送されますが、`nft_info`APIは`rippled`では利用できません。[レジャーの指定][]をご覧ください）。 |
レジャーのバージョンを指定しない場合、Clioは検証済みの最新のレジャーを使用します。
## レスポンスのフォーマット
処理が成功したレスポンスの例:
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"result": {
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
"ledger_index": 270,
"owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
"is_burned": true,
"flags": 8,
"transfer_fee": 0,
"issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
"nft_taxon": 0,
"nft_sequence": 0,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"result": {
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
"ledger_index": 269,
"owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
"is_burned": false,
"flags": 8,
"transfer_fee": 0,
"issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
"nft_taxon": 0,
"nft_sequence": 0,
"uri": "https://xrpl.org",
"validated": true,
"status": "success"
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
{% /tab %}
{% /tabs %}
レスポンスは[標準フォーマット][] に従い、成功すると以下のフィールドをいくつか並べた`nft_info`レスポンスオブジェクトが返されます。
| `Field` | 型 | 説明 |
|:----------------------------------|:------|:---------------------|
| `nft_id` | 文字列 | 非代替性トークン(NFT)の一意の識別子。 |
| `ledger_index` | 整数 | NFT がミント(作成)された、所有者が変わった(取引された)、バーンされた(破棄された)など、このNFTの状態が変更された最新のレジャーバージョンの[レジャーインデックス][]。返される情報には、リクエストされたレジャーと比較して直近に起こったことが含まれます。 |
| `owner` | 文字列 | このレジャーインデックスにおけるこのNFTの所有者のアカウントID。 |
| `is_burned` | 真偽値 | NFTがこのレジャーでバーンされていれば`true`を、そうでなければ`false`を返します。 |
| `flags ` | 整数 | このNFTのフラグ |
| `transfer_fee` | 整数 | このNFTの送金手数料。送金手数料の詳細については、[NFTokenMintのフィールド](../../../protocol/transactions/types/nftokenmint.md#nftokenmint-フィールド)をご覧ください。 |
| `issuer` | 文字列　| このNFTの発行者を示すアカウントID。|
| `nft_taxon` | 整数 | このNFTのTaxon。 |
| `nft_sequence` | 整数 | このNFTのシーケンス番号. |
| `uri` | 文字列 | このNFTのURI。NFTがURIを持っていない場合、空の文字列を返します。 {% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" %}更新: Clio v2.0.0{% /badge %} |
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
{% raw-partial file="/docs/_snippets/common-links.md" /%}

629
@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md Normal file
View File

@@ -0,0 +1,629 @@
---
html: server_info-clio.html
parent: clio-methods.html
seo:
description: Clioサーバの状態を人間が読める形式で取得します。
labels:
- コアサーバ
---
# server_info
[[ソース]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/ServerInfo.cpp "ソース")
`server_info`コマンドは[Clioサーバ](../../../../concepts/networks-and-servers/the-clio-server.md)にクエリされるClioサーバに関する様々な情報を人間が読める形で問い合わせます。`rippled`サーバについては、代わりに[`server_info` (`rippled`)](../server-info-methods/server_info.md)をご覧ください。{% badge href="https://github.com/XRPLF/clio/releases/tag/1.0.0" %}新規: Clio v1.0.0{% /badge %}
## リクエストのフォーマット
リクエストのフォーマットの例:
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"command": "server_info"
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
{
"method": "server_info",
"params": [
{}
]
}
```
{% /tab %}
{% /tabs %}
<!-- [Try it! >](websocket-api-tool.html#server_info) -->
リクエストにパラメーターは含みません。
## レスポンスのフォーマット
クライアントが`localhost`経由でClioサーバに接続すると、レスポンスには`counters`オブジェクトと`etl`オブジェクトが含まれます。クライアントが同じサーバに存在せず、`localhost`経由で接続しない場合、これらのオブジェクトはレスポンスから省略されます。
クライアントが`localhost`経由で接続した場合の成功したレスポンスの例：
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"result": {
"info": {
"complete_ledgers": "19499132-19977628",
"counters": {
"rpc": {
"account_objects": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "991"
},
"account_tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "91633"
},
"account_lines": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "4915159"
},
"submit_multisigned": {
"started": "2",
"finished": "2",
"errored": "0",
"forwarded": "2",
"duration_us": "4823"
},
"ledger_entry": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "17806"
},
"server_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "2375580"
},
"account_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "5",
"duration_us": "9256"
},
"account_currencies": {
"started": "4",
"finished": "4",
"errored": "0",
"forwarded": "0",
"duration_us": "517302"
},
"noripple_check": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2218"
},
"tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "562"
},
"gateway_balances": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "1395156"
},
"channel_authorize": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2017"
},
"manifest": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1707"
},
"subscribe": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "116"
},
"random": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "111"
},
"ledger_data": {
"started": "14",
"finished": "3",
"errored": "11",
"forwarded": "0",
"duration_us": "6179145"
},
"ripple_path_find": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1409563"
},
"account_channels": {
"started": "14",
"finished": "14",
"errored": "0",
"forwarded": "0",
"duration_us": "1062692"
},
"submit": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "6",
"duration_us": "11383"
},
"transaction_entry": {
"started": "8",
"finished": "5",
"errored": "3",
"forwarded": "0",
"duration_us": "494131"
}
},
"subscriptions": {
"ledger": 0,
"transactions": 0,
"transactions_proposed": 0,
"manifests": 2,
"validations": 2,
"account": 0,
"accounts_proposed": 0,
"books": 0
}
},
"load_factor": 1,
"clio_version": "0.3.0-b2",
"validation_quorum": 8,
"rippled_version": "1.9.1-rc1",
"validated_ledger": {
"age": 4,
"hash": "4CD25FB70D45646EE5822E76E58B66D39D5AE6BA0F70491FA803DA0DA218F434",
"seq": 19977628,
"base_fee_xrp": 1E-5,
"reserve_base_xrp": 1E1,
"reserve_inc_xrp": 2E0
}
},
"cache": {
"size": 8812733,
"is_full": true,
"latest_ledger_seq": 19977629
},
"etl": {
"etl_sources": [
{
"validated_range": "19405538-19977629",
"is_connected": "1",
"ip": "52.36.182.38",
"ws_port": "6005",
"grpc_port": "50051",
"last_msg_age_seconds": "0"
}
],
"is_writer": true,
"read_only": false,
"last_publish_age_seconds": "2"
},
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
200 OK
{
"result": {
"info": {
"complete_ledgers": "19499132-19977628",
"counters": {
"rpc": {
"account_objects": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "991"
},
"account_tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "91633"
},
"account_lines": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "4915159"
},
"submit_multisigned": {
"started": "2",
"finished": "2",
"errored": "0",
"forwarded": "2",
"duration_us": "4823"
},
"ledger_entry": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "17806"
},
"server_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "2375580"
},
"account_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "5",
"duration_us": "9256"
},
"account_currencies": {
"started": "4",
"finished": "4",
"errored": "0",
"forwarded": "0",
"duration_us": "517302"
},
"noripple_check": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2218"
},
"tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "562"
},
"gateway_balances": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "1395156"
},
"channel_authorize": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2017"
},
"manifest": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1707"
},
"subscribe": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "116"
},
"random": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "111"
},
"ledger_data": {
"started": "14",
"finished": "3",
"errored": "11",
"forwarded": "0",
"duration_us": "6179145"
},
"ripple_path_find": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1409563"
},
"account_channels": {
"started": "14",
"finished": "14",
"errored": "0",
"forwarded": "0",
"duration_us": "1062692"
},
"submit": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "6",
"duration_us": "11383"
},
"transaction_entry": {
"started": "8",
"finished": "5",
"errored": "3",
"forwarded": "0",
"duration_us": "494131"
}
},
"subscriptions": {
"ledger": 0,
"transactions": 0,
"transactions_proposed": 0,
"manifests": 2,
"validations": 2,
"account": 0,
"accounts_proposed": 0,
"books": 0
}
},
"load_factor": 1,
"clio_version": "0.3.0-b2",
"validation_quorum": 8,
"rippled_version": "1.9.1-rc1",
"validated_ledger": {
"age": 4,
"hash": "4CD25FB70D45646EE5822E76E58B66D39D5AE6BA0F70491FA803DA0DA218F434",
"seq": 19977628,
"base_fee_xrp": 1E-5,
"reserve_base_xrp": 1E1,
"reserve_inc_xrp": 2E0
}
},
"cache": {
"size": 8812733,
"is_full": true,
"latest_ledger_seq": 19977629
},
"etl": {
"etl_sources": [
{
"validated_range": "19405538-19977629",
"is_connected": "1",
"ip": "52.36.182.38",
"ws_port": "6005",
"grpc_port": "50051",
"last_msg_age_seconds": "0"
}
],
"is_writer": true,
"read_only": false,
"last_publish_age_seconds": "2"
},
"validated": true,
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
{% /tab %}
{% /tabs %}
クライアントが`localhost`経由で接続しなかった場合の成功レスポンスの例:
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"result": {
"info": {
"complete_ledgers":"32570-73737719",
"load_factor":1,
"clio_version":"1.0.2",
"validation_quorum":28,
"rippled_version":"1.9.1",
"validated_ledger": {
"age":7,
"hash":"4ECDEAF9E6F8B37EFDE297953168AAB42DEED1082A565639EBB2D29E047341B4",
"seq":73737719,
"base_fee_xrp":1E-5,
"reserve_base_xrp":1E1,
"reserve_inc_xrp":2E0
},
"cache": {
"size":15258947,
"is_full":true,
"latest_ledger_seq":73737719
}
},
"validated":true,
"status":"success"
},
"warnings": [
{
"id":2001,
"message":"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
{% /tab %}
{% tab label="JSON-RPC" %}
```json
200 OK
{
"result": {
"info": {
"complete_ledgers":"32570-73737719",
"load_factor":1,
"clio_version":"1.0.2",
"validation_quorum":28,
"rippled_version":"1.9.1",
"validated_ledger": {
"age":7,
"hash":"4ECDEAF9E6F8B37EFDE297953168AAB42DEED1082A565639EBB2D29E047341B4",
"seq":73737719,
"base_fee_xrp":1E-5,
"reserve_base_xrp":1E1,
"reserve_inc_xrp":2E0
},
"cache": {
"size":15258947,
"is_full":true,
"latest_ledger_seq":73737719
}
},
"validated":true,
"status":"success"
},
"warnings": [
{
"id":2001,
"message":"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
}
]
}
```
{% /tab %}
{% /tabs %}
レスポンスは[標準フォーマット][]に従い、結果が正常な場合`info`オブジェクトが唯一のフィールドとして含まれます。
`info`オブジェクトは以下のフィールドを含むことがあります。
| `Field` | 型 | 説明 |
|:---------------------------------------|:--------------|:---------------------|
| `complete_ledgers` | 文字列 | ローカル`rippled`がデータベース内に有するレジャーのバージョンのシーケンス番号の範囲を示す表現。例えば、`24900901-24900984,24901116-24901158`のように、互いに素なシーケンスの場合があります。サーバに完全なレジャーがない場合（例えば、ネットワークとの同期を始めたばかりの場合）、文字列`empty`になります。 |
| `counters` | オブジェクト | _(省略される場合があります)_ サーバ起動以降に処理されたAPIコールの統計。クライアントが`localhost`経由でClioサーバに接続した場合のみ表示されます。
| `rpc` | オブジェクト | _(省略される場合があります)_ 起動時からClioサーバが処理した各API呼び出しの統計情報。これは`counters`オブジェクトの中にネストされているので、クライアントが`localhost`経由でClioサーバに接続した場合のみ存在します。 |
| `rpc.*.started` | 数値 | Clioサーバが起動後に処理を開始した、このタイプのAPIコールの数。 |
| `rpc.*.finished` | 数値 | Clioサーバが起動以降に処理を終了した、このタイプのAPIコールの数。 |
| `rpc.*.errored` | 数値 | 起動後に何らかのエラーが発生した、このタイプのAPIコールの数。 |
| `rpc.*.forwarded` | 数値 | 起動してからClioサーバが`rippled`P2Pサーバに転送したAPI呼び出しの数。 |
| `rpc.*.duration_us` | 数値 | 起動時からこのタイプのAPIコールの処理に費やされたマイクロ秒数の合計。 |
| `subscriptions` | オブジェクト | _(省略される場合があります)_ 各ストリームタイプの現在の接続者数。これは`counters`オブジェクトの中にネストされているので、クライアントが`localhost`経由でClioサーバに接続した場合のみ存在します。 |
| `subscriptions.ledger` | | |
| `subscriptions.transactions` | | |
| `subscriptions.transactions_proposed` | | |
| `subscriptions.manifests` | | |
| `subscriptions.validations` | | |
| `subscriptions.account` | | |
| `subscriptions.accounts_proposed` | | |
| `subscriptions.books` | | |
| `time` | 文字列 | サーバの時計によるUTCでの現在時刻。{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" %}新規: Clio v2.0{% /badge %} |
| `uptime` | 数値 | サーバが連続して稼働している秒数。{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" %}新規: Clio v2.0{% /badge %} |
| `amendment_blocked` | 真偽値 | _(省略される場合があります)_ Clioサーバが[Amendmentブロック](../../../../concepts/networks-and-servers/amendments.md#amendment-blocked-clio-servers)がされているかどうか。{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" %}新規: Clio v2.0{% /badge %} |
| `load_factor` | 数値 | サーバが現在実行中の、負荷スケーリングされたオープンレジャートランザクションコストを、基本トランザクションコストに適用される乗数として示したもの。例えば、負荷係数`1000`でリファレンストランザクションコストが10 dropである場合、負荷スケーリングされたトランザクションコストは10,000 drop（0.01 XRP）です。負荷係数は、[個々のサーバの負荷係数](../../../../concepts/transactions/transaction-cost.md#ローカル負荷コスト)の最高値、クラスターの負荷係数、[オープンレジャーコスト](../../../../concepts/transactions/transaction-cost.md#オープンレジャーコスト)、ネットワーク全体の負荷係数によって決まります。 |
| `clio_version` | 文字列 | 実行中のClioサーバのバージョン番号。 |
| `libxrpl_version` | 文字列 | このClioサーバがビルドされた`libxrpl`ライブラリのバージョン番号。{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" %}新規: Clio v2.0{% /badge %} |
| `validation_quorum` | 数値 | _(省略される場合があります)_ レジャーバージョンを検証するために必要な、信頼できる検証の最小数。状況によっては、サーバがより多くの検証をリクエストすることもあります。この値は`rippled`から取得します。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
| `rippled_version` | 文字列 | _(省略される場合があります)_ Clioサーバが接続している`rippled`サーバのバージョン番号。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。 |
| `network_id` | 文字列 | _(省略される場合があります)_ このClioサーバが接続している`rippled`が動作しているネットワークのネットワークID。何らかの理由でClioサーバが`rippled`に接続できない場合、このフィールドはレスポンスから省略されることがあります。{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" %}新規: Clio v2.0{% /badge %} |
| `validated_ledger` | オブジェクト | _(省略される場合があります)_ 完全に検証された最新のレジャーに関する情報。検証済みの最新のレジャーがない場合、レスポンスではこのフィールドは省略され、代わりに`closed_ledger`が含まれます。 |
| `validated_ledger` | オブジェクト | （省略される場合があります）完全に検証された最新のレジャーについての情報。最新の検証済みレジャーが使用できない場合、このフィールドはレスポンスにて省略され、代わりに`closed_ledger`が含まれます。 |
| `validated_ledger.age` | 数値 | レジャーの閉鎖以降の秒数。 |
| `validated_ledger.base_fee_xrp` | 数値 | XRP単位の基本手数料。0.00005の場合は、`1e-05`などの科学的記数法で表すことができます。 |
| `validated_ledger.hash` | 文字列 | 16進数で表された、レジャーの一意のハッシュ |
| `validated_ledger.reserve_base_xrp` | 数値 | すべてのアカウントで準備金として保有しておく必要があるXRPの最少額（drop数ではありません） |
| `validated_ledger.reserve_inc_xrp` | 数値 | アカウントがレジャー内に保有するオブジェクトごとのアカウント準備金に追加するXRP額（drop数ではありません） |
| `validated_ledger.seq` | 数値 | 最新の検証済みレジャーのレジャーインデックス |
| `validation_quorum` | 数値 | レジャーバージョンの検証に、最低限必要となる信頼できる検証の数。場合によっては、サーバがさらに検証をリクエストする場合があります。 |
| `validator_list_expires` | 文字列 | _（管理者のみ）_ 現在のバリデータリストの有効期限が切れるタイミングを人間が読み取れる時間でを表示、または、サーバが発行済みのバリデータリストをロードしていない場合は文字列`unknown`、サーバが静的なバリデータリストを使用する場合は文字列`never`のいずれかを表示します。 |
| `cache` | オブジェクト | Clioの状態データのキャッシュに関する情報。 |
| `cache.size` | 数値 | 現在キャッシュ内にある状態データオブジェクトの数。 |
| `cache.is_full` | 真偽値 | キャッシュに特定のレジャーのすべての状態データが含まれている場合はtrue、そうでない場合はfalse。[book_offersメソッド][] などの一部の API 呼び出しは、キャッシュが完全な場合、より高速に処理されます。 |
| `cache.latest_ledger_seq` | 数値 | キャッシュに保存されている、検証済みの最新のレジャーの[レジャーインデックス][]。 |
| `etl` | オブジェクト | Clioサーバが接続している`rippled`ソース(ETLソース)。クライアントが`localhost`経由で Clioサーバに接続した場合のみ表示されます。 |
| `etl.etl_sources` | オブジェクト配列 | Clioサーバが接続され、データを抽出する`rippled`ソース(ETLソース)を表示します。 |
| `etl.etl_sources.validated_range` | 文字列 | P2Pの`rippled`サーバから取得した有効なレジャーの範囲。 |
| `etl.etl_sources.is_connected` | 真偽値 | ClioがWebSocket経由でこのソースに接続されていればTrue、そうでなければFalse。ここでfalseが指定された場合は、ネットワークの問題や `rippled`が実行されていないことなどが考えられます。 |
| `etl.etl_sources.ip` | 数値 | `rippled`サーバのIP。 |
| `etl.etl_sources.ws_port` | 数値 | `rippled`サーバのWebSocketポート。 |
| `etl.etl_sources.grpc_port` | 数値 | Clioサーバが接続しているP2P`rippled`サーバのgRPC接続ポート。 |
| `etl.etl_sources.last_msg_age_seconds` | 数値 | Clioが最後に`rippled`から何かを取得してからの経過秒数の合計。これは8より大きくなってはいけません。 |
| `etl.is_writer` | 真偽値 | このClioサーバが現在データベースにデータを書き込んでいる場合はtrue、そうでない場合はfalse。|
| `etl.read_only` | 真偽値 | このClioサーバが読み込み専用モードで設定されている場合はtrue、そうでない場合はfalse。 |
| `etl.last_publish_age_seconds` | 数値 | このClioサーバが最後にレジャーを公開してからの経過時間(秒)。これは8以上であってはなりません。 |
| `validated` | 真偽値 | Trueの場合、レスポンスがコンセンサスによって検証されたレジャーバージョンを使用していることを示します。Clioでは、検証済みのレジャーデータを保存して返すため、これは常にtrueです。リクエストが`rippled`に転送され、サーバが現在のデータを返した場合、値がないかfalseの場合は、このレジャーのデータが確定でないことを示します。 |
| `status` | 文字列 | APIリクエストのステータスを返します。リクエストが正常に完了した場合は`success`を返します。 |
## 考えられるエラー
* いずれかの[汎用エラータイプ][]。
{% raw-partial file="/docs/_snippets/common-links.md" /%}