Consulta de uma linha personalizada
Função
Consulta de uma linha personalizada
Depuração
Você pode depurar esta API por meio da autenticação automática no Chamada das API ou usar o código de exemplo do SDK gerado pelo API Explorer.
URI
GET /v2.1/customlines
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
line_id |
Não |
String |
ID da linha de resolução |
|
name |
Não |
String |
Nome da linha de resolução |
|
limit |
Não |
Integer |
Número de recursos em cada página. O valor varia de 0 a 500. Os valores comumente usados são 10, 20 e 50, o valor padrão é 500. |
|
offset |
Não |
Integer |
Iniciar deslocamento da consulta de paginação. A consulta começará a partir do próximo recurso do valor deslocamento. O valor varia de 0 a 2147483647. O valor padrão é 0. Se o marker não for deixado em branco, a consulta será iniciada a partir do recurso especificado pelo marker. |
|
show_detail |
Não |
Boolean |
Se para consultar informações detalhadas. Opções de valor:
|
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Ele pode ser obtido pela chamada de uma API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
lines |
Array of line objects |
Lista de linhas |
|
metadata |
metadata object |
Número de recursos que atendem à condição de consulta |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
line_id |
String |
ID da linha de resolução |
|
name |
String |
Nome de linha personalizada |
|
ip_segments |
Array of strings |
Intervalo de endereços IP |
|
created_at |
String |
Tempo de criação |
|
updated_at |
String |
Hora da atualização |
|
status |
String |
Status do recurso |
|
description |
String |
Descrição de linha personalizada |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
Consulta de uma linha personalizada
{
"lines" : [ {
"line_id" : "custom_2ce45ef669fc87870169fcbada7a0007",
"name" : "customline",
"ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ],
"status" : "ACTIVE",
"created_at" : "2019-04-10T10:03:17.827",
"updated_at" : "2019-04-10T10:03:57.207",
"description" : "1234"
} ],
"metadata" : {
"total_count" : 1
}
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Consulta de uma linha personalizada |
Códigos de erro
Consulte Códigos de erro.