Pagination dans l' Instana REST API

Modifier en ligne

La pagination est utilisée dans l'interface Instana REST API pour naviguer efficacement parmi les volumes importants de données renvoyées par les points de terminaison API de Instana. Ce guide explique comment fonctionne la pagination et comment vous pouvez l'utiliser efficacement.

Comprendre la pagination

Modifier en ligne

Lorsqu'un point de terminaison API renvoie une liste de ressources très longue, l' API utilise la pagination pour diviser les résultats en blocs d'une taille plus raisonnable. Les paramètres de pagination déterminent quel sous-ensemble de données est renvoyé dans chaque réponse de l' API. La pagination par page et la pagination par curseur sont les deux types de pagination utilisés dans Instana.

Pagination par pages

Modifier en ligne

Dans la pagination par pages, les paramètres page ( pageSize parfois appelés limit ou offset) et sont couramment utilisés pour contrôler le sous-ensemble de données renvoyé à chaque requête API.

Modèle de données

Modifier en ligne

Le type de pagination par page de InstanaPagination présente le modèle de données suivant :

{
    "type": "object",
    "properties": {
        "page": {
            "type": "integer",
            "format": "int32",
            "minimum": 1
        },
        "pageSize": {
            "type": "integer",
            "format": "int32",
            "maximum": 200,
            "minimum": 1
        }
    }
}

Table d'attributs

Modifier en ligne

Le tableau suivant présente les définitions des attributs du type Pagination :

Attribut Description
page La page spécifique du jeu de données sur laquelle s'affichent les résultats renvoyés.
pageSize Taille de chaque page ou bloc de données renvoyé.

Exemple de pagination

Modifier en ligne

L'exemple suivant illustre l'utilisation de Pagination:

{
    "page": 2,
    "pageSize": 50
}

Où peut-on l'utiliser?

Modifier en ligne

Les groupes suivants de points de terminaison d' API s utilisent le Pagination schéma :

Les ressources d'application, qui constituent un ensemble de points de terminaison API, proposent également une pagination par page. Les ressources de l'application n'utilisent pas le Pagination schéma, mais incluent plutôt un attribut page et un pageSize attribut dans le schéma de la charge utile de la requête.

Pagination par curseur

Modifier en ligne

Dans la pagination basée sur un curseur, un curseur pointe vers une position dans l'ensemble de données à partir de laquelle les données sont récupérées. Instana comporte deux sous-types de pagination par curseur : une pagination par curseur à usage général (CursorPagination) et une pagination par curseur spécifique à la surveillance de l'infrastructure (CursorPaginationInfraExploreCursor).

Pagination par curseur à usage général

Modifier en ligne

Ce CursorPagination type de pagination est la forme la plus courante de pagination par curseur dans l'environnement API d' Instana.

Modèle de données

Modifier en ligne

Le type de pagination polyvalent basé sur un curseur de Instana, CursorPagination, présente le modèle de données suivant :

{
    "type": "object",
    "properties": {
        "ingestionTime": {
            "type": "integer",
            "format": "int64"
        },
        "offset": {
            "type": "integer",
            "format": "int32"
        },
        "retrievalSize": {
            "type": "integer",
            "format": "int32",
            "maximum": 200,
            "minimum": 1
        }
    }
}

Table d'attributs

Modifier en ligne

Le tableau suivant présente les définitions des attributs du type CursorPagination :

Attribut Description
ingestionTime Pointeur vers un point de départ à utiliser entre des requêtes successives.
offset Pointeur vers un point de départ à utiliser entre des requêtes successives.
retrievalSize Le nombre de valeurs à récupérer.

Exemple de pagination à l'aide du curseur

Modifier en ligne

L'exemple suivant illustre l'utilisation de CursorPagination:

{
    "ingestionTime": 1720104883,
    "offset": 2,
    "retrievalSize": 45
}

Pagination par curseur pour la surveillance des infrastructures

Modifier en ligne

Ce type de pagination est nomméCursorPaginationInfraExploreCursor et possède à la fois uncursor et unretrievalSize . CursorPaginationInfraExploreCursor utilisé uniquement dans le groupe de terminaux « Infrastructure Analyze ».

Modèle de données

Modifier en ligne

Le type de pagination basé sur le curseurCursorPaginationInfraExploreCursor qui est utilisé dans Analyse des infrastructures a le modèle de données suivant :

{
    "type": "object",
    "properties": {
        "cursor": {
            "$ref": "#/components/schemas/InfraExploreCursor"
        },
        "retrievalSize": {
            "type": "integer",
            "format": "int32",
            "description": "number of values to return"
        }
    }
}

La InfraExplorerCursor propriété de la pagination par curseur est elle-même un objet et présente le modèle de données suivant :

{
    "type": "object",
    "description": "cursor to use between successive queries"
}

Table d'attributs

Modifier en ligne

Le tableau suivant présente les définitions des attributs du type CursorPaginationInfraExploreCursor :

Attribut Description
cursor Pointeur vers un point de départ à utiliser entre des requêtes successives.
retrievalSize Le nombre de valeurs à récupérer. 
{
    "type": "object",
    "properties": {
        "cursor": {
            "$ref": "#/components/schemas/InfraExploreCursor"
        },
        "retrievalSize": {
            "type": "integer",
            "format": "int32",
            "description": "number of values to return"
        }
    }
}

Où peut-on l'utiliser?

Modifier en ligne

Les groupes suivants de points de terminaison d' API s utilisent le CursorPaginationInfraExploreCursor schéma :

Pour plus d'informations sur l'utilisation d' API et les bonnes pratiques, consultez la documentation disponible à l'adresse API.