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

Consulta informações sobre instâncias de roteador de trânsito em uma instância da Cloud Enterprise Network (CEN), incluindo o tipo de instância, o status da instância, o ID da instância do roteador de trânsito e se o recurso de multicast está ativado.

Descrição da operação

Ao chamar esta operação para consultar informações sobre instâncias de roteador de trânsito em uma instância CEN, você pode especificar os parâmetros RegionId e TransitRouterId conforme necessário. A seguir, descreve-se a relação entre esses dois parâmetros:

Se você não especificar RegionId ou TransitRouterId, todas as instâncias de roteador de trânsito na instância CEN serão consultadas.
Se você especificar apenas RegionId, as instâncias de roteador de trânsito na região especificada na instância CEN serão consultadas.
Se você especificar apenas TransitRouterId, a instância de roteador de trânsito especificada na instância CEN será consultada.

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

get

CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*TransitRouter

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

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valores válidos: 1 a 50. Valor padrão: 10. Para mais informações sobre paginação, consulte as descrições dos parâmetros relacionados.	10
CenId	string	Não	O ID da instância CEN.	cen-j3jzhw1zpau2km****
TransitRouterId	string	Não	O ID da instância do roteador de trânsito.	tr-uf654ttymmljlvh2x****
RegionId	string	Não	O ID da região da instância do roteador de trânsito. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou.
Tag	array<object>	Não	As informações da tag. Você pode especificar até 20 tags por vez.
	object	Não	As informações da tag.
Key	string	Não	A chave da tag do recurso. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`. Você pode especificar até 20 chaves de tag por vez.	TagKey.
Value	string	Não	O valor da tag do recurso. O valor da tag pode ser uma string vazia ou ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`. Cada chave de tag corresponde a um valor de tag. Você pode especificar até 20 valores de tag por vez.	TagValue.
Status	string	Não	O status da instância do roteador de trânsito. Valores válidos: Creating: sendo criada. Active: ativa. Modifying: sendo modificada. Deleting: sendo excluída. Upgrading: sendo atualizada.	Active.
Type	string	Não	O tipo da instância do roteador de trânsito. Valores válidos: Enterprise: Roteador de trânsito da Enterprise Edition. Basic: Roteador de trânsito da Basic Edition.	Enterprise.
TransitRouterName	string	Não	O nome da instância do roteador de trânsito. O nome deve ter de 1 a 128 caracteres e não pode começar com `http://` ou `https://`.	testname.
FeatureFilter	array<object>	Não	O filtro de recursos para roteadores de trânsito.
	object	Não	O filtro de recursos para roteadores de trânsito.
Key	string	Não	A chave do filtro de recursos para roteadores de trânsito. Campos suportados atualmente: Multicast: o recurso de multicast.	Multicast.
Value	array	Não	A lista de valores para o filtro de recursos de roteadores de trânsito. Quando a chave é Multicast, apenas um valor é suportado. Valores válidos: Enabled: multicast é suportado. Disabled: multicast não é suportado.
	string	Não	O valor do filtro de recursos para roteadores de trânsito. Quando a chave é Multicast, valores válidos: Enabled: multicast é suportado. Disabled: multicast não é suportado.	Enabled.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	integer	O número de entradas por página em uma consulta paginada. Para mais informações sobre paginação, consulte as descrições dos parâmetros relacionados.	10
RequestId	string	O ID da solicitação.	68521297-5FA6-46CB-B4EB-658F1C68C8CC
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas retornadas.	1
TransitRouters	array<object>	A lista de instâncias de roteador de trânsito.
	array<object>	As informações sobre a instância do roteador de trânsito.
CreationTime	string	A hora em que a instância do roteador de trânsito foi criada. A hora é exibida em UTC no formato `YYYY-MM-DDThh:mmZ`.	2021-03-15T09:39Z
Type	string	O tipo da instância do roteador de trânsito. Valores válidos: Enterprise: Roteador de trânsito da Enterprise Edition. Basic: Roteador de trânsito da Basic Edition.	Enterprise.
Status	string	O status da instância do roteador de trânsito. Valores válidos: Creating: sendo criada. Active: ativa. Modifying: sendo modificada. Deleting: sendo excluída. Upgrading: sendo atualizada.	Active.
TransitRouterId	string	O ID da instância do roteador de trânsito.	tr-bp1su1ytdxtataupl****
TransitRouterDescription	string	A descrição da instância do roteador de trânsito.	testdesc.
TransitRouterName	string	O nome da instância do roteador de trânsito.	testname.
CenId	string	O ID da instância CEN.	cen-j3jzhw1zpau2km****
AliUid	integer	O ID da conta Alibaba Cloud à qual a instância CEN pertence.	1210123456123456
RegionId	string	O ID da região da instância do roteador de trânsito.	cn-hangzhou.
SupportMulticast	boolean	Indica se o recurso de multicast está ativado para a instância do roteador de trânsito. Valores válidos: true: ativado. false: desativado.	false.
TransitRouterCidrList	array<object>	A lista de blocos CIDR do roteador de trânsito.
	object	O bloco CIDR do roteador de trânsito.
Cidr	string	O bloco CIDR do transit router.	192.168.1.0/24
Name	string	O nome do bloco CIDR.	CIDRname
Description	string	A descrição do bloco CIDR.	CIDRdesc
TransitRouterCidrId	string	O ID do bloco CIDR.	cidr-46p5ceg21e8152****
PublishCidrRoute	boolean	Indica se o sistema adiciona automaticamente uma rota para o bloco CIDR do transit router à tabela de rotas do transit router. true: Sim. Se este parâmetro for definido como true, depois que você criar uma conexão VPN do tipo private gateway e ativar o aprendizado de rotas para a conexão VPN, o sistema adicionará automaticamente uma rota blackhole à tabela de rotas do transit router que está em uma correlação de aprendizado de rotas com a conexão VPN. O bloco CIDR de destino da rota blackhole é o bloco CIDR do transit router. O bloco CIDR do transit router é o bloco CIDR do qual um endereço IP é alocado para a conexão IPsec-VPN. Esta rota blackhole é anunciada apenas para as tabelas de rotas dos virtual border routers (VBRs) que estão conectados ao transit router. false: Não.	true
Tags	array<object>	A lista de tags.
	object	As informações da tag.
Key	string	A chave da tag.	TagKey
Value	string	O valor da tag.	TagValue

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
  "PageNumber": 1,
  "TotalCount": 1,
  "TransitRouters": [
    {
      "CreationTime": "2021-03-15T09:39Z",
      "Type": "Enterprise",
      "Status": "Active",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "TransitRouterDescription": "testdesc",
      "TransitRouterName": "testname",
      "CenId": "cen-j3jzhw1zpau2km****",
      "AliUid": 1210123456123456,
      "RegionId": "cn-hangzhou",
      "SupportMulticast": false,
      "TransitRouterCidrList": [
        {
          "Cidr": "192.168.1.0/24",
          "Name": "CIDRname",
          "Description": "CIDRdesc",
          "TransitRouterCidrId": "cidr-46p5ceg21e8152****",
          "PublishCidrRoute": true
        }
      ],
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ]
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameterCombination.TransitRouter	Region ID is required if no TransitRouterId or CenId specified.	Pelo menos um dos parâmetros Region, TransitRouterId ou CenId deve ser especificado.
400	InvalidOperation.UnsupportFilterValue	The specified FeatureFilter Value is not supported by this operation.	O valor de FeatureFilter especificado no parâmetro é inválido.
400	InvalidOperation.UnsupportFilter	The specified FeatureFilter is not supported by this operation.	O FeatureFilter especificado no parâmetro é inválido.
400	IllegalParam.TagValue	The tag values are not valid.	O valor da tag especificado na solicitação é inválido.
400	IllegalParam.TagKey	The tag keys are not valid.	A chave da tag especificada na solicitação é inválida.
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.