ListRouteMaps - Cloud Enterprise Network: Central de Documentação do Alibaba Cloud

Consulta os detalhes de um ou mais mapas de rotas.

Descrição da operação

Descrição da solicitação

RouteMapIds: Opcional. Os IDs dos mapas de rotas a serem consultados. Se você não especificar este parâmetro, todos os mapas de rotas serão consultados.
Filter: Opcional. As condições de filtro usadas para filtrar mapas de rotas com base em atributos específicos, como nome e direção.
ResourceGroupId: Opcional. O ID do grupo de recursos usado para filtrar ainda mais os resultados.
DryRun: Opcional. Especifica se deve ser realizado um dry run.
MaxResults e NextToken: Os parâmetros de paginação usados para controlar o número de resultados retornados e recuperar a próxima página.

Nota: Se você especificar RouteMapIds e Filter, o operador lógico OR será usado. Um mapa de rotas que atenda a qualquer uma das condições será retornado.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cen:ListRouteMaps

list

RouteMap

acs:cen:*:{#accountId}:routemap/*

RouteMap

acs:cen:*:{#accountId}:routemap/{#RouteMapId}

Nenhuma

Sintaxe da solicitação

GET / HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o valor, mas deve garantir que ele seja exclusivo entre diferentes solicitações. O token de cliente pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usa automaticamente o RequestId da solicitação de API como o token de cliente. O RequestId de cada solicitação de API pode ser diferente.	02fb3da4-130e-11e9-8e44-001****
RouteMapIds	array	Não	Os IDs dos mapas de rotas a serem consultados. Se você não especificar este parâmetro, todos os mapas de rotas serão consultados.
	string	Não	Os IDs dos mapas de rotas a serem consultados. Se você não especificar este parâmetro, todos os mapas de rotas serão consultados.	rm-0a1b2c3d4e5f6a7b8
Filter	array<object>	Não	As condições de filtro. Você pode especificar até 5 condições de filtro por vez.
	object	Não	As condições de filtro. Você pode especificar até 5 condições de filtro por vez.
Key	string	Não	A condição de filtro. Valores válidos: Direction: a direção do mapa de rotas. Name: o nome do mapa de rotas. Priority: a prioridade do mapa de rotas. Por padrão, várias condições de filtro têm uma relação lógica AND. Um mapa de rotas é retornado apenas quando atende a todas as condições de filtro. Você pode especificar até 5 condições de filtro por vez.	Priority
Value	array	Não	O valor da condição de filtro. Especifique o valor do filtro com base na Key. Você pode especificar vários valores de filtro para uma única Key. Vários valores de filtro têm uma relação lógica OR. Um mapa de rotas é retornado quando atende a qualquer um dos valores de filtro. Você pode especificar até 5 valores de filtro para uma única condição de filtro.
	string	Não	O valor da condição de filtro. Especifique o valor do filtro com base na Key. Você pode especificar vários valores de filtro para uma única Key. Vários valores de filtro têm uma relação lógica OR. Um mapa de rotas é retornado quando atende a qualquer um dos valores de filtro. Você pode especificar até 5 valores de filtro para uma única condição de filtro.	10
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-0a1b2c3d4e5f6a7b8
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run. A consulta real não é executada. O sistema verifica se os parâmetros obrigatórios foram especificados, o formato da solicitação e os limites do serviço. Se a solicitação falhar no dry run, o erro correspondente será retornado. Se a solicitação passar no dry run, o código de erro DryRunOperation será retornado. false: realiza uma solicitação normal. Este é o valor padrão.	true
MaxResults	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Se você não especificar o parâmetro MaxResults, a paginação não será usada. Depois de chamar a operação, o valor de MaxResults indica o número total de entradas. Se você especificar o parâmetro MaxResults, a paginação será usada. Depois de chamar a operação, o valor de MaxResults indica o número de entradas retornadas na consulta atual. Recomendamos que você defina o parâmetro MaxResults como 20.	10
NextToken	string	Não	O token usado para recuperar a próxima página de resultados. Valores válidos: Se esta for a primeira consulta ou nenhuma consulta subsequente for enviada, você não precisa especificar este parâmetro. Se uma consulta subsequente for enviada, defina o valor como o valor de NextToken retornado da chamada de API anterior.	dd20****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A hora em que o mapa de rotas foi criado. A hora segue o padrão ISO 8601 no formato `YYYY-MM-DDThh:mm:ssZ`. A hora é exibida em UTC.
MaxResults	integer	O número de entradas retornadas em cada página. Valor padrão: 20.	20
NextToken	string	O token usado para recuperar a próxima página de resultados. Valores válidos: Se NextToken estiver vazio, nenhuma consulta subsequente será enviada. Se NextToken for retornado, o valor indica o token usado para iniciar a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	B2063B16-852B-5B66-B73D-4ED4D1A5E5C2
RouteMaps	array<object>	As informações sobre os mapas de rotas.
	array<object>	As informações sobre os mapas de rotas.
CreationTime	string	A hora em que o mapa de rotas foi criado. A hora segue o padrão ISO 8601 no formato `YYYY-MM-DDThh:mmZ`. A hora é exibida em UTC.	2026-03-28T02:29:19Z
Description	string	A descrição do mapa de rotas.	desctest
Direction	string	A direção do mapa de rotas. Valores válidos: Inbound: entrada. Outbound: saída.	Inbound
Name	string	O nome do mapa de rotas.	test
Priority	integer	A prioridade do mapa de rotas. Um valor menor indica uma prioridade maior.	10
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmydlzjd6dlhi
RouteMapId	string	O ID do mapa de rotas.	rm-y40mxdvf7joc12****
Status	string	O status do mapa de rotas. Valores válidos: Creating: criando. Updating: atualizando. Active: ativo. Deleting: excluindo.	Active
Tag	array<object>	A lista de tags.
	object	As informações da tag.
Key	string	A chave da tag.	test
Value	string	O valor da tag.	jg
Version	integer	O número da versão da configuração do mapa de rotas. O número da versão aumenta cada vez que o mapa de rotas e suas regras de mapa de rotas associadas são modificados.	7
TotalCount	integer	O número total de entradas.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "B2063B16-852B-5B66-B73D-4ED4D1A5E5C2",
  "RouteMaps": [
    {
      "CreationTime": "2026-03-28T02:29:19Z",
      "Description": "desctest",
      "Direction": "Inbound",
      "Name": "test",
      "Priority": 10,
      "ResourceGroupId": "rg-acfmydlzjd6dlhi",
      "RouteMapId": "rm-y40mxdvf7joc12****",
      "Status": "Active",
      "Tag": [
        {
          "Key": "test",
          "Value": "jg"
        }
      ],
      "Version": 7
    }
  ],
  "TotalCount": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidOperation.UnsupportFilterValue	The specified FeatureFilter Value is not supported by this operation.	O valor de FeatureFilter especificado no parâmetro é inválido.
400	IllegalParam.NextToken	NextToken is illegal	O NextToken é inválido.
400	InvalidParameter.MaxResults	The specified MaxResults is invalid.	O parâmetro MaxResults especificado é inválido.
400	InvalidParameter.RouteMapIds	The specified RouteMapIds is invalid.	O parâmetro RouteMapIds especificado é inválido.
400	InvalidParameter.Filter	The specified Filter is invalid.	O parâmetro Filter especificado é inválido.
400	IllegalParam.TagKey	The tag keys are not valid.	A chave de tag especificada é inválida.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.