Criação de um grupo de linhas
Função
Esta API é usada para criar um grupo de linhas.
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
POST /v2.1/linegroups
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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | String | Nome do grupo de linhas. O nome não pode ser igual ao nome de linha personalizada ou ao nome de linha pré-configurada. O nome pode conter de 1 a 64 caracteres, incluindo dígitos, letras, sublinhados (_), hifens (-) e pontos (.). |
| description | Não | String | Descrição do grupo de linhas. São permitidos no máximo 255 caracteres. É deixado em branco por padrão. |
| lines | Sim | Array of strings | Lista de linhas contidas em um grupo de linhas. São necessárias pelo menos duas linhas. IDs de linhas de resolução são usados aqui. |
Parâmetros de resposta
Código de status: 202
| 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
{
"name" : "linegroup",
"description" : "123",
"lines" : [ "ST", "LA" ]
} Exemplo de respostas
Código de status: 202
Resposta à solicitação de criação de um grupo de linhas
{
"name" : "linegroup",
"lines" : [ "ST", "LA" ],
"status" : "PENDING_CREATE",
"description" : "123",
"line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
"created_at" : "2019-07-29T08:41:38.096",
"updated_at" : null
} Códigos de status
| Código de status | Descrição |
|---|---|
| 202 | Resposta à solicitação de criação de um grupo de linhas |
| 400 | Resposta de erro |
| 500 | Resposta de erro |
Códigos de erro
Consulte Códigos de erro.