Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/Domain Name Service/Referência de API/APIs/Gerenciamento de grupos de linhas/Consulta de grupos de linhas
Atualizado em 2025-08-19 GMT+08:00
Ver PDF
Compartilhar

Consulta de grupos de linhas

Função

Consulta de grupos 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

GET /v2.1/linegroups

Tabela 1 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

line_id

Não

String

ID do grupo de linhas. A correspondência difusa é usada.

name

Não

String

Nome do grupo de linhas. A correspondência difusa é usada.

limit

Não

Integer

Número de recursos em cada página.

Quando você consulta informações detalhadas, o valor varia de 0 a 100. Os valores comumente usados são 10, 20 e 50, o valor padrão é 100.

Quando você consulta as informações breves, o valor varia de 0 a 3000, e o valor padrão é 3000.

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.

Parâmetros de solicitação

Tabela 2 Parâmetros do cabeçalho 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

Tabela 3 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

linegroups

Array of CreateLineGroupsResp objects

Objeto da lista

metadata

metadata object

Número de recursos que atendem à condição de consulta

Tabela 4 CreateLineGroupsResp

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.

Tabela 5 metadata

Parâmetro

Tipo

Descrição

total_count

Integer

Número de recursos que atendem aos critérios de filtro. O número é irrelevante para limit ou offset.

Código de status: 400

Tabela 6 Parâmetros de corpo de resposta

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

Tabela 7 Parâmetros de corpo de resposta

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 dos grupos de linhas

{
  "linegroups" : [ {
    "name" : "linegroup",
    "lines" : [ "ST", "LA" ],
    "status" : "ACTIVE",
    "description" : "123",
    "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
    "created_at" : "2019-07-29T08:41:38.096",
    "updated_at" : "2019-07-29T08:41:38.610"
  }, {
    "name" : "20190729034848812group",
    "lines" : [ "Liantong", "Dianxin_Guangdong" ],
    "status" : "ACTIVE",
    "description" : "auto create",
    "line_id" : "lgroup_4011afa26c33050b016c3cbeaf650f84",
    "created_at" : "2019-07-29T08:00:25.443",
    "updated_at" : "2019-07-29T08:00:26.040"
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

Códigos de status

Código de status

Descrição

200

Resposta à solicitação de consulta dos grupos de linhas

400

Resposta de erro

500

Resposta de erro

Códigos de erro

Consulte Códigos de erro.