Paginação no Instana REST API
A paginação é utilizada no Instana REST API para navegar com eficiência por grandes volumes de dados retornados pelos pontos de extremidade API do Instana. Este guia explica como funciona a paginação e como você pode usá-la de forma eficaz.
Entendendo a paginação
Quando um endpoint do API retorna uma lista extensa de recursos, o API utiliza a paginação para dividir os resultados em blocos de tamanho mais manejável. Os parâmetros de paginação determinam qual subconjunto de dados é retornado em cada resposta do método ` API `. A paginação baseada em páginas e a paginação baseada em cursor são os dois tipos de paginação utilizados no site Instana.
Paginação por páginas
Na paginação baseada em páginas, os parâmetros page (às pageSize vezes chamados de limit ou offset) e são comumente usados para controlar o subconjunto de dados que é retornado em cada solicitação API.
Modelo de dados
O tipo de paginação baseada em Pagination páginas do Instana possui o seguinte modelo de dados:
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1
}
}
}
Tabela de atributos
A tabela a seguir apresenta as definições dos atributos do tipo Pagination :
| Atributo | Descrição |
|---|---|
page |
A página específica dentro do conjunto de dados onde os resultados retornados são exibidos. |
pageSize |
O tamanho de cada página ou bloco de dados retornado. |
Exemplo de paginação
O exemplo a seguir mostra como usar Pagination:
{
"page": 2,
"pageSize": 50
}
Onde pode ser usado?
Os seguintes grupos de pontos de extremidade do API utilizam o Pagination esquema:
Os Recursos da Aplicação, que consistem em pontos de extremidade do tipo API, também oferecem paginação baseada em páginas. Os recursos da aplicação não utilizam o Pagination esquema, mas incluem um atributo page e um pageSize atributo no esquema da carga útil da solicitação.
Paginação baseada no cursor
Na paginação baseada em cursor, um cursor aponta para uma posição no conjunto de dados da qual os dados são recuperados. Instana possui dois subtipos de paginação baseada em cursor: uma paginação por cursor de uso geral (CursorPagination) e uma paginação por cursor específica para o Monitoramento de Infraestrutura (CursorPaginationInfraExploreCursor).
Paginação com cursor para uso geral
Esse CursorPagination tipo é a forma mais comum de paginação baseada em cursor no ambiente API da Instana.
Modelo de dados
O tipo de paginação de uso geral baseado em cursor do Instana, CursorPagination, possui o seguinte modelo de dados:
{
"type": "object",
"properties": {
"ingestionTime": {
"type": "integer",
"format": "int64"
},
"offset": {
"type": "integer",
"format": "int32"
},
"retrievalSize": {
"type": "integer",
"format": "int32",
"maximum": 200,
"minimum": 1
}
}
}
Tabela de atributos
A tabela a seguir apresenta as definições dos atributos do tipo CursorPagination :
| Atributo | Descrição |
|---|---|
ingestionTime |
Um ponteiro para um ponto de partida a ser usado entre consultas sucessivas. |
offset |
Um ponteiro para um ponto de partida a ser usado entre consultas sucessivas. |
retrievalSize |
O número de valores a serem recuperados. |
Exemplo de paginação baseada no cursor
O exemplo a seguir mostra como usar CursorPagination:
{
"ingestionTime": 1720104883,
"offset": 2,
"retrievalSize": 45
}
Onde pode ser usado?
Os seguintes grupos de pontos de extremidade do API utilizam o CursorPagination esquema:
Paginação por cursor para monitoramento de infraestrutura
Este tipo de paginação é denominadoCursorPaginationInfraExploreCursor e tem tanto umcursor e umretrievalSize . CursorPaginationInfraExploreCursor utilizado apenas no grupo de terminais “Análise de Infraestrutura ”.
Modelo de dados
O tipo de paginação baseada em cursorCursorPaginationInfraExploreCursor que é usado em Análise de infraestrutura tem o seguinte modelo de dados:
{
"type": "object",
"properties": {
"cursor": {
"$ref": "#/components/schemas/InfraExploreCursor"
},
"retrievalSize": {
"type": "integer",
"format": "int32",
"description": "number of values to return"
}
}
}
A InfraExplorerCursor propriedade da paginação baseada em cursor é, por si só, um objeto e possui o seguinte modelo de dados:
{
"type": "object",
"description": "cursor to use between successive queries"
}
Tabela de atributos
A tabela a seguir apresenta as definições dos atributos do tipo CursorPaginationInfraExploreCursor :
| Atributo | Descrição |
|---|---|
cursor |
Um ponteiro para um ponto de partida a ser usado entre consultas sucessivas. |
retrievalSize |
O número de valores a serem recuperados. |
{
"type": "object",
"properties": {
"cursor": {
"$ref": "#/components/schemas/InfraExploreCursor"
},
"retrievalSize": {
"type": "integer",
"format": "int32",
"description": "number of values to return"
}
}
}
Onde pode ser usado?
Os seguintes grupos de pontos de extremidade do API utilizam o CursorPaginationInfraExploreCursor esquema:
Para obter mais informações sobre o uso e as práticas recomendadas do ` API `, consulte a documentação em API.