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

Chama a operação ListTransitRouterRouteEntries para consultar os detalhes das entradas de rota em uma tabela de rotas de roteador de trânsito da Enterprise Edition.

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:ListTransitRouterRouteEntries

get

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

TransitRouterRouteEntry

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
MaxResults	integer	Não	O número de entradas por página quando as entradas são retornadas em páginas. Valores válidos: 1 a 100. Valor padrão: 20.	20
TransitRouterRouteEntryDestinationCidrBlock `deprecated`	string	Não	O bloco CIDR de destino da entrada de rota (Este parâmetro será descontinuado. Use o parâmetro RouteFilter em vez disso).	192.168.0.0/24
TransitRouterRouteEntryStatus	string	Não	O status da entrada de rota. Valores válidos: All: consulta entradas de rota em todos os estados. Active (padrão): consulta apenas entradas de rota no estado ativo. Rejected: consulta apenas entradas de rota rejeitadas devido a conflitos de rota. Prohibited: consulta apenas entradas de rota proibidas porque correspondem a uma política de roteamento. Standby: consulta apenas entradas de rota que servem como rotas de espera. Candidate: consulta apenas entradas de rota que servem como rotas candidatas. Se você não especificar este parâmetro, apenas as entradas de rota no estado ativo serão consultadas.	Active
TransitRouterRouteTableId	string	Sim	O ID da tabela de rotas do roteador de trânsito da Enterprise Edition.	vtb-bp1dudbh2d5na6b50****
NextToken	string	Não	O token que determina o ponto inicial da consulta. Valores válidos: Você não precisa especificar este parâmetro na primeira consulta ou se nenhuma consulta subsequente for enviada. Se uma consulta subsequente for enviada, defina o valor como o valor NextToken retornado pela chamada de API anterior.	fce19****
TransitRouterRouteEntryNames	array	Não	Os nomes das entradas de rota.	testname
	string	Não	O nome da entrada de rota. O nome pode estar vazio ou ter de 1 a 128 caracteres e não pode começar com http:// ou https://. Nota O sistema suporta apenas o uso deste parâmetro para consultar entradas de rota estáticas configuradas na tabela de rotas atual e é incompatível com condições de consulta diferentes de TransitRouterRouteEntryIds.	testname
TransitRouterRouteEntryIds	array	Não	Os IDs das entradas de rota.	rte-oklkgwmj97z6dn****
	string	Não	O ID da entrada de rota. Nota O sistema suporta apenas o uso deste parâmetro para consultar entradas de rota estáticas configuradas na tabela de rotas atual e é incompatível com condições de consulta diferentes de TransitRouterRouteEntryNames.	rte-oklkgwmj97z6dn****
TransitRouterRouteEntryType	string	Não	O tipo da entrada de rota. Valores válidos: Propagated: gerada por aprendizado automático na tabela de rotas atual. Static: gerada por configuração estática na tabela de rotas atual.	Propagated
TransitRouterRouteEntryNextHopType	string	Não	O tipo do próximo salto. Valores válidos: BlackHole: a entrada de rota é uma rota blackhole. Attachment: o próximo salto da entrada de rota é uma conexão de instância de rede.	Attachment
TransitRouterRouteEntryNextHopId	string	Não	O ID da conexão de instância de rede associada ao próximo salto da entrada de rota.	tr-attach-nls9fzkfat8934****
TransitRouterRouteEntryNextHopResourceId	string	Não	O ID da instância do próximo salto da entrada de rota.	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceType	string	Não	O tipo da instância do próximo salto da entrada de rota. Valores válidos: VPC: instância de Virtual Private Cloud (VPC). VBR: instância de Virtual Border Router (VBR). TR: instância de roteador de trânsito. VPN: instância de conexão IPsec.	VPC
TransitRouterRouteEntryOriginResourceId	string	Não	O ID da instância de origem da entrada de rota.	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryOriginResourceType	string	Não	O tipo da instância de origem da entrada de rota. Valores válidos: VPC: instância de Virtual Private Cloud (VPC). VBR: instância de Virtual Border Router (VBR). TR: instância de roteador de trânsito. VPN: instância de conexão IPsec.	VPC
PrefixListId	string	Não	O ID da lista de prefixos.	pl-6ehtn5kqxgeyy08fi****
RouteFilter	array<object>	Não	As condições de filtro para blocos CIDR de entradas de rota.
	object	Não	A condição de filtro para blocos CIDR de entradas de rota.
Key	string	Não	A condição de filtro. Valores válidos: PrefixExactMatchCidrs: correspondência exata. LongestPrefixMatchCidrs: correspondência de prefixo mais longo. Endereços IP e blocos CIDR são suportados. SubnetOfMatchCidrs: correspondência de sub-rede. Corresponde a sub-redes do bloco CIDR especificado, incluindo o próprio bloco CIDR especificado. SupernetOfMatchCidrs: correspondência de super-rede. Corresponde a super-redes do bloco CIDR especificado, incluindo o próprio bloco CIDR especificado. Múltiplas condições de filtro têm uma relação AND por padrão, o que significa que uma entrada de rota deve atender a todas as condições de filtro para ser considerada uma correspondência. Você não pode especificar a mesma condição de filtro mais de uma vez.	PrefixExactMatchCidrs
Value	array	Não	A lista de valores de condição de filtro.
	string	Não	Especifica os valores de filtro com base no parâmetro Key. Você pode especificar vários valores de filtro para uma única Key. Vários valores de filtro têm uma relação OR, o que significa que uma entrada de rota é considerada uma correspondência se atender a qualquer um dos valores de filtro. Um máximo de 500 valores de filtro pode ser especificado para uma única condição de filtro. Endereços IPv4, endereços IPv6 e blocos CIDR são suportados.	192.168.1.0/24

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
NextToken	string	O token que determina o ponto inicial da próxima consulta. Valores válidos: Se NextToken estiver vazio, nenhuma consulta subsequente deve ser enviada. Se NextToken for retornado, o valor indica o token para a próxima consulta.	fce19****
RequestId	string	O ID da solicitação.	C3835E5E-1504-4344-B1BB-98A4110F1079
TotalCount	integer	O número total de entradas.	6
MaxResults	integer	O número de entradas por página quando as entradas são retornadas em páginas.	20
TransitRouterRouteEntries	array<object>	A lista de entradas de rota.
	array<object>	As informações da entrada de rota.
TransitRouterRouteEntryId	string	O ID da entrada de rota. Nota Este parâmetro é retornado apenas para rotas configuradas estaticamente.	rte-oklkgwmj97z6dn****
TransitRouterRouteEntryDestinationCidrBlock	string	O bloco CIDR de destino da entrada de rota. Um bloco CIDR IPv4 ou um bloco CIDR IPv6 é retornado.	192.168.0.0/24
TransitRouterRouteEntryType	string	O tipo da entrada de rota. Static: uma entrada de rota configurada estaticamente. Propagated: uma entrada de rota gerada por aprendizado automático.	Static
CreateTime	string	A hora em que a entrada de rota foi criada. A hora é exibida em UTC no formato AAAA-MM-DDThh:mmZ. Nota Este parâmetro é retornado apenas para rotas configuradas estaticamente.	2021-06-15T07:01Z
TransitRouterRouteEntryName	string	O nome da entrada de rota. Nota Este parâmetro é retornado apenas para rotas configuradas estaticamente.	testname
TransitRouterRouteEntryStatus	string	O status da entrada de rota. Active: ativo. Rejected: rejeitado devido a um conflito de rota. Prohibited: proibido por uma política de roteamento. Standby: espera. Candidate: candidato. Creating: sendo criado. Deleting: sendo excluído.	Active
TransitRouterRouteEntryNextHopType	string	O tipo do próximo salto da entrada de rota. BlackHole: a entrada de rota é uma rota blackhole. Todo o tráfego destinado ao bloco CIDR de destino é descartado. Attachment: o próximo salto da entrada de rota é uma conexão de instância de rede. Todo o tráfego destinado ao bloco CIDR de destino é encaminhado para a conexão de instância de rede especificada.	BlackHole
TransitRouterRouteEntryNextHopId	string	O ID do próximo salto da entrada de rota. Este parâmetro não é retornado para rotas blackhole.	tr-attach-vx6iwhjr1x1j78****
TransitRouterRouteEntryDescription	string	A descrição da entrada de rota. Nota Este parâmetro é retornado apenas para rotas configuradas estaticamente.	CidrRoute
OperationalMode	boolean	Indica se a entrada de rota atual pode ser modificada. true: a entrada de rota pode ser modificada. Você pode excluir a entrada de rota. false: a entrada de rota não pode ser modificada. A entrada de rota é gerada automaticamente pelo sistema e não suporta edição.	false
Tag	string	A tag da entrada de rota. O único valor válido é PermitVbr, que indica que a entrada de rota atual é propagada apenas para as tabelas de rotas de instâncias VBR sob a instância do roteador de trânsito. Nota Este parâmetro é retornado apenas para rotas geradas pelo sistema para blocos CIDR do roteador de trânsito.	PermitVbr
TransitRouterRouteEntryNextHopResourceId	string	O ID da instância do próximo salto da entrada de rota.	vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceType	string	O tipo da instância do próximo salto da entrada de rota. VPC: instância de Virtual Private Cloud (VPC). VBR: instância de Virtual Border Router (VBR). TR: instância de roteador de trânsito. VPN: instância de conexão IPsec.	VPC
TransitRouterRouteEntryOriginResourceType	string	O tipo da instância de origem da entrada de rota. VPC: instância de Virtual Private Cloud (VPC). VBR: instância de Virtual Border Router (VBR). TR: instância de roteador de trânsito. VPN: instância de conexão IPsec.	VPC
TransitRouterRouteEntryOriginResourceId	string	O ID da instância de origem da entrada de rota.	vpc-m5ent6du8deaq5*****
PrefixListId	string	O ID da lista de prefixos.	pl-k1ainl66z3527773d****
PathAttributes	object	Os atributos de caminho da rota.
Communities	array	A lista de atributos Community da entrada de rota.
	string	O valor do atributo Community da entrada de rota.	65501:1
AsPaths	array	A lista de atributos AS Path da entrada de rota.
	string	O valor do atributo AS Path da entrada de rota.	65501
OriginInstanceId	string	O ID da instância original da qual a entrada de rota se origina.	vbr-m5ent6du8deaq5*****
OriginInstanceType	string	O tipo da instância da qual a rota se origina. VPC: instância de Virtual Private Cloud (VPC). VBR: instância de Virtual Border Router (VBR). TR: instância de roteador de trânsito. VPN: instância de conexão IPsec. CCN: instância de Cloud Connect Network (CCN).	VBR
OriginRouteType	string	O tipo de rota original quando a rota foi gerada. System: rota do sistema. Custom: rota personalizada. Static: rota estática. BGP: rota BGP. BlackHole: rota blackhole.	BGP
Preference	integer	A prioridade da entrada de rota. Um valor menor indica uma prioridade maior.	50

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "fce19****",
  "RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079",
  "TotalCount": 6,
  "MaxResults": 20,
  "TransitRouterRouteEntries": [
    {
      "TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn****",
      "TransitRouterRouteEntryDestinationCidrBlock": "192.168.0.0/24",
      "TransitRouterRouteEntryType": "Static",
      "CreateTime": "2021-06-15T07:01Z",
      "TransitRouterRouteEntryName": "testname",
      "TransitRouterRouteEntryStatus": "Active",
      "TransitRouterRouteEntryNextHopType": "BlackHole",
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
      "TransitRouterRouteEntryDescription": "CidrRoute",
      "OperationalMode": false,
      "Tag": "PermitVbr",
      "TransitRouterRouteEntryNextHopResourceId": "vpc-m5ent6du8deaq5*****",
      "TransitRouterRouteEntryNextHopResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceId": "vpc-m5ent6du8deaq5*****",
      "PrefixListId": "pl-k1ainl66z3527773d****",
      "PathAttributes": {
        "Communities": [
          "65501:1"
        ],
        "AsPaths": [
          "65501"
        ],
        "OriginInstanceId": "vbr-m5ent6du8deaq5*****\n",
        "OriginInstanceType": "VBR",
        "OriginRouteType": "BGP",
        "Preference": 50
      }
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParam.TransitRouterRouteTableId	TransitRouterRouteTableId is illegal.	O TransitRouterRouteTableId especificado na solicitação é inválido.
400	IllegalParam.TransitRouterRouteEntryStatus	TransitRouterRouteEntryStatus is illegal.	O TransitRouterRouteEntryStatus especificado na solicitação é inválido.
400	IllegalParam.NextToken	NextToken is illegal.	O NextToken especificado na solicitação é inválido.
400	ParamExclusive.RouteEntryIdsAndStatus	TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive.	Os parâmetros TransitRouterRouteEntryIds e TransitRouterRouteEntryStatus são mutuamente exclusivos.
400	InvalidTransitRouterRouteTableId.NotFound	TransitRouterRouteTableId is not found.	O ID da instância da tabela de rotas do roteador de trânsito não foi encontrado.
400	FilterKeyDuplicated.RouteFilter	The keys in RouteFilter are duplicated.	Os valores de chave em RouteFilter estão duplicados.
400	InvalidFilterKey	The key in filter is invalid.	A chave no filtro é inválida.
400	IllegalParam.TransitRouterRouteEntryNextHopType	TransitRouterRouteEntryNextHopType is invalid.	O parâmetro TransitRouterRouteEntryNextHopType é inválido.
400	IllegalParam.TransitRouterRouteEntryNextHopAttachmentId	TransitRouterRouteEntryNextHopAttachmentId is invalid.	O parâmetro TransitRouterRouteEntryNextHopAttachmentId é inválido.
400	IllegalParam.TransitRouterRouteEntryNextHopResourceId	TransitRouterRouteEntryNextHopResourceId is invalid.	O parâmetro TransitRouterRouteEntryNextHopResourceId é inválido.
400	IllegalParam.TransitRouterRouteEntryNextHopResourceType	TransitRouterRouteEntryNextHopResourceType is invalid.	O parâmetro TransitRouterRouteEntryNextHopResourceType é inválido.
400	IllegalParam.TransitRouterRouteEntryOriginResourceId	TransitRouterRouteEntryOriginResourceId is invalid.	O parâmetro TransitRouterRouteEntryOriginResourceId é inválido.
400	IllegalParam.TransitRouterRouteEntryOriginResourceType	TransitRouterRouteEntryOriginResourceType is invalid.	O parâmetro TransitRouterRouteEntryOriginResourceType é inválido.
400	IllegalParam.TransitRouterRouteEntryType	TransitRouterRouteEntryType is invalid.	O parâmetro TransitRouterRouteEntryType é inválido.
400	IllegalParam.PrefixExactMatchCidr	PrefixExactMatchCidr is invalid.	O parâmetro PrefixExactMatchCidr é inválido.
400	IllegalParam.LongestPrefixMatchCidr	LongestPrefixMatchCidr is invalid.	O parâmetro LongestPrefixMatchCidr é inválido.
400	IllegalParam.SubnetOfMatchCidr	SubnetOfMatchCidr is invalid.	O parâmetro SubnetOfMatchCidr é inválido.
400	IllegalParam.SupernetOfMatchCidr	SupernetOfMatchCidr is invalid.	O parâmetro SupernetOfMatchCidr é inválido.
400	InvalidName	Name is invalid.	O nome é inválido.
400	IllegalParam.TextMatchCidr	The TextMatchCidr specified in the parameter is illegal.	O TextMatchCidr especificado na solicitação é inválido.
400	ResourceNotFound.PrefixlistAssociation	The prefix list is not associated with this route table.	A lista de prefixos não está associada a uma tabela de rotas.
400	InvalidParameter	Invalid parameter.	O parâmetro é inválido.
400	Unauthorized	The AccessKeyId is unauthorized.	A conta não tem permissão para realizar esta operação.
404	InvalidRouteTableId.NotFound	The specified RouteTableId is not found.	O RouteTableId não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.