Saltar al contenido principal
GET
/
v1
/
settings
/
metadata-indexes
Listar Índices de Metadatos
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes
import requests

url = "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes")
.asString();
require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "indexName": "metadata.tier_1",
    "entityName": "transaction",
    "metadataKey": "tier",
    "unique": false,
    "sparse": true,
    "stats": {
      "accesses": 150,
      "statsSince": "2024-01-15T10:30:00Z"
    }
  },
  {
    "indexName": "metadata.externalId_1",
    "entityName": "account",
    "metadataKey": "externalId",
    "unique": true,
    "sparse": false,
    "stats": {
      "accesses": 1200,
      "statsSince": "2024-01-10T08:00:00Z"
    }
  }
]

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de consulta

entity_name
string

El nombre de la entidad para filtrar los índices de metadatos.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

indexName
string
requerido

El nombre del índice en la base de datos.

Ejemplo:

"metadata.tier_1"

entityName
string
requerido

El nombre de la entidad asociada con el índice.

Ejemplo:

"transaction"

metadataKey
string
requerido

La clave de metadatos utilizada en el índice.

Ejemplo:

"tier"

unique
boolean
requerido

Indica si el índice exige unicidad.

Ejemplo:

false

sparse
boolean
requerido

Indica si el índice es disperso (ignora documentos sin el campo indexado).

Ejemplo:

true

stats
object

Estadísticas de uso del índice.