Consulta de um grupo de linhas
Função
Consulta de um grupo de linhas
Depuração
Você pode depurar esta API por meio da autenticação automática no API Explorer ou usar o código de exemplo do SDK gerado pelo API Explorer.
URI
GET /v2.1/linegroups/{linegroup_id}
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
linegroup_id |
Sim |
String |
ID do grupo de linhas a ser consultado |
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 |
---|---|---|
name |
String |
Nome do grupo de linhas |
lines |
Array of strings |
Lista de linhas contidas em um grupo de linhas (IDs de linha de resolução são usados aqui.) |
status |
String |
Status do recurso. Opções de valor: PENDING_CREATE, ACTIVE, PENDING_DELETE, PENDING_UPDATE, ERROR, FREEZE e DISABLE. |
description |
String |
Descrição do grupo de linhas |
line_id |
String |
ID do grupo de linhas |
created_at |
String |
Tempo de criação. Formato: aaaa-MM-dd'T'HH:mm:ss.SSS. |
updated_at |
String |
Hora da atualização. Formato: aaaa-MM-dd'T'HH:mm:ss.SSS. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
Código de erro Mínimo: 8 Máximo: 36 |
message |
String |
Descrição Mínimo: 2 Máximo: 512 |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
Código de erro Mínimo: 8 Máximo: 36 |
message |
String |
Descrição Mínimo: 2 Máximo: 512 |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
Resposta à solicitação de consulta de um grupo de linhas
{ "name" : "linegroup", "lines" : [ "LA", "ST" ], "status" : "ACTIVE", "description" : "123", "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf", "created_at" : "2019-07-29T08:41:38.096", "updated_at" : "2019-07-29T08:41:38.610" }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Resposta à solicitação de consulta de um grupo de linhas |
400 |
Resposta de erro |
500 |
Resposta de erro |
Códigos de erro
Consulte Códigos de erro.