GetIndex - - Centre de documentation Alibaba Cloud

Consulte les informations d'index d'un Logstore spécifié.

Description de l'opération

Le Host dans la syntaxe de la requête se compose du nom du projet et du point de terminaison de Simple Log Service. Vous devez spécifier le projet dans le Host.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

log:GetIndex

get

*LogStore.

acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}

log:TLSVersion

Aucune

Syntaxe de la requête

GET /logstores/{logstore}/index HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
logstore	string	Oui	Le nom du Logstore.	test-logstore

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
project	string	Oui	Le nom du projet.	ali-test-project

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de la réponse.
index_mode	string	Le type d'index.	v2
keys	object	La configuration de l'index de champ. La clé est le nom du champ et la valeur est la configuration de l'index.
	object	La configuration de l'index d'un champ unique.
caseSensitive	boolean	Indique si la sensibilité à la casse est activée. Ce paramètre n'est requis que lorsque type est défini sur text. Valeurs valides : true false	false
chn	boolean	Indique si les caractères chinois sont inclus. Ce paramètre n'est requis que lorsque type est défini sur text. Valeurs valides : true false	false
token	array	Les délimiteurs.
	string	Le délimiteur. Ce paramètre n'est requis que lorsque type est défini sur text.	,
type	string	Le type de données de la valeur du champ. Valeurs valides : text, json, double et long.	text
doc_value	boolean	Indique si la fonctionnalité d'analyse est activée pour le champ. Valeurs valides : true false	false
alias	string	L'alias du champ.	myAlias
lastModifyTime	integer	L'heure de la dernière mise à jour de l'index. Cette valeur est un horodatage UNIX représentant le nombre de secondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.	1524155379
line	object	La configuration de l'index en texte intégral.
caseSensitive	boolean	Indique si la sensibilité à la casse est activée. Valeurs valides : true : la sensibilité à la casse est activée. false : la sensibilité à la casse est désactivée.	false
chn	boolean	Indique si les caractères chinois sont inclus. Valeurs valides : true : les caractères chinois sont inclus. false : les caractères chinois ne sont pas inclus.	false
exclude_keys	array	La liste des champs exclus.
	string	La liste des champs exclus.	excludeField
include_keys	array	La liste des champs inclus.
	string	La liste des champs inclus.	includeField
token	array	La liste des jetons.
	string	Le jeton. Par exemple, ",", ".", "\r" ou "\n".	,
log_reduce	boolean	Indique si LogReduce est activé.	false
log_reduce_black_list	array	La liste noire pour le filtrage des champs LogReduce. Ce paramètre n'est valide que lorsque LogReduce est activé.
	string	Le champ sur liste noire.	b
log_reduce_white_list	array	La liste blanche pour le filtrage des champs LogReduce. Ce paramètre n'est valide que lorsque LogReduce est activé.
	string	Le champ sur liste blanche.	a
max_text_len	integer	La longueur maximale par défaut d'une valeur de champ dans Simple Log Service est de 2 048 octets (2 Ko). Pour modifier la longueur maximale d'une valeur de champ, définissez la longueur maximale du champ statistique (texte). Valeurs valides : 64 à 16 384 octets.	2048
storage	string	Le type de stockage. La valeur est fixée à pg.	pg
ttl	integer	Le cycle de vie du fichier d'index. Valeurs valides : 7, 30 et 90. Unité : jours.	30

Exemples

JSON format

{
  "index_mode": "v2",
  "keys": {
    "key": {
      "caseSensitive": false,
      "chn": false,
      "token": [
        ","
      ],
      "type": "text",
      "doc_value": false,
      "alias": "myAlias"
    }
  },
  "lastModifyTime": 1524155379,
  "line": {
    "caseSensitive": false,
    "chn": false,
    "exclude_keys": [
      "excludeField"
    ],
    "include_keys": [
      "includeField"
    ],
    "token": [
      ","
    ]
  },
  "log_reduce": false,
  "log_reduce_black_list": [
    "b"
  ],
  "log_reduce_white_list": [
    "a"
  ],
  "max_text_len": 2048,
  "storage": "pg",
  "ttl": 30
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.