DescribeVirtualBorderRouters - Express Connect: Central de Documentação do Alibaba Cloud

Consulta os Virtual Border Routers (VBRs) criados.

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

vpc:DescribeVirtualBorderRouters

list

*VirtualBorderRouter.

acs:vpc:{#regionId}:{#AccountId}:virtualborderrouter/{#VbrId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do VBR. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-shanghai
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
Filter	array<object>	Não	As informações de filtro.
	object	Não	As informações de filtro.
Key	string	Não	A condição de filtro. Você pode especificar até 5 condições de filtro. As seguintes condições de filtro são suportadas:	Status
Value	array	Não	O valor do filtro com base na Key especificada. Você pode especificar vários valores de filtro para uma Key. A relação entre vários valores de filtro é OR, o que significa que uma correspondência com qualquer um dos valores de filtro é considerada uma correspondência com a condição de filtro.	Active
	string	Não	O valor do filtro com base na Key especificada. Você pode especificar vários valores de filtro para uma Key. A relação entre vários valores de filtro é OR, o que significa que uma correspondência com qualquer um dos valores de filtro é considerada uma correspondência com a condição de filtro.	Active
IncludeCrossAccountVbr	boolean	Não	Especifica se devem ser incluídos Virtual Border Routers entre contas. true: Incluídos. false (padrão): Não incluídos.	false
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxazb4ph6aiy****
Tags	array<object>	Não	As tags do recurso.
	object	Não	A tag.
Key	string	Não	A chave da tag do recurso. Você deve especificar pelo menos 1 chave de tag e pode especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações do Virtual Border Router (VBR).
RequestId	string	O ID da solicitação.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
PageNumber	integer	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas retornadas.	1
VirtualBorderRouterSet	object
VirtualBorderRouterType	array<object>	A lista de VBRs.
	array<object>	A hora de criação do VBR.
CreationTime	string	A hora em que o VBR foi criado.	2020-06-08T12:20:55
Status	string	O status da instância do VBR. unconfirmed: aguardando confirmação da outra parte. active: normal. terminating: interrompendo o acesso. terminated: acesso interrompido. recovering: sendo recuperado. deleting: sendo excluído.	active
Type	string	O tipo do VBR.	pconnVBR
MinTxInterval	integer	O intervalo de alerta para envio de pacotes Bidirectional Forwarding Detection (BFD). Valores válidos: 200 a 1000. Unidade: ms.	300
PeerIpv6GatewayIp	string	O endereço IPv6 do VBR no lado do cliente.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PConnVbrExpireTime	string	A hora de expiração do VBR faturável.	2021-06-08T12:20:55
PhysicalConnectionOwnerUid	string	O ID da conta à qual o circuito Express Connect pertence.	1688000000000****
ActivationTime	string	A hora em que o VBR foi ativado pela primeira vez.	2021-06-08T12:20:55
PhysicalConnectionBusinessStatus	string	O status comercial do circuito Express Connect. Normal: Normal. FinancialLocked: bloqueado devido a pagamento em atraso.	Normal
Description	string	A descrição do VBR.	desc
TerminationTime	string	A hora em que o VBR foi encerrado pela última vez.	2021-06-08T12:20:55
MinRxInterval	integer	O intervalo de recebimento de pacotes BFD. Valores válidos: 200 a 1000. Unidade: ms.	300
PeerGatewayIp	string	O endereço IPv4 do VBR no lado do cliente.	192.168.XX.XX
Name	string	O nome da instância do VBR.	test
VbrId	string	O ID da instância do VBR.	vbr-bp1jcg5cmxjbl9xgc****
VlanId	integer	O ID da VLAN da instância do VBR.	10
VlanInterfaceId	string	O ID da interface do roteador do VBR.	ri-2zeo3xzyf38r4xx****
CircuitCode	string	O código do circuito fornecido pela operadora para o circuito Express Connect.	longtel0****
LocalIpv6GatewayIp	string	O endereço IPv6 do VBR no lado da Alibaba Cloud.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalGatewayIp	string	O endereço IPv4 do VBR no lado da Alibaba Cloud.	192.168.XX.XX
PeeringSubnetMask	string	A máscara de sub-rede para os endereços IPv4 no lado da Alibaba Cloud e no lado do cliente da instância do VBR.	255.255.255.252
EnableIpv6	boolean	Indica se o IPv6 está ativado. true: ativado. false: desativado.	false
RouteTableId	string	O ID da tabela de rotas do VBR.	vtb-bp1****
DetectMultiplier	integer	O multiplicador de tempo de detecção. Este é o número máximo de perdas consecutivas de pacotes que o receptor permite do remetente, usado para detectar se o link está normal. Valores válidos: 3 a 10.	3
EccId	string	O ID da instância Express Cloud Connect.	ecc-h****
CloudBoxInstanceId	string	O ID da instância CloudBox.	cb-****
RecoveryTime	string	A hora em que o VBR foi recuperado pela última vez do estado terminated para o estado active.	2021-05-08T12:20:55
PhysicalConnectionStatus	string	O status do circuito Express Connect. Initial: solicitando. Approved: aprovado. Allocating: alocando recursos. Allocated: em construção. Confirmed: aguardando confirmação do usuário. Enabled: ativado. Rejected: solicitação rejeitada. Canceled: cancelado. Allocation Failed: falha na alocação de recursos. Terminated: encerrado.	Normal
PeeringIpv6SubnetMask	string	A máscara de sub-rede para os endereços IPv6 no lado da Alibaba Cloud e no lado do cliente da instância do VBR.	2000:1234:0:a000::/55
AccessPointId	string	O ID do ponto de acesso do circuito Express Connect.	ap-cn-kojok1x****
PConnVbrChargeType	string	O método de cobrança do VBR vinculado ao circuito Express Connect. PrePaid: assinatura. Se você selecionar este método de cobrança, certifique-se de que sua conta suporte pagamento por saldo ou crédito. PostPaid: pay-as-you-go.	PrePaid
PhysicalConnectionId	string	O ID do circuito Express Connect ao qual o VBR pertence.	pc-119mfjzm7x****
AssociatedPhysicalConnections	object
AssociatedPhysicalConnection	array<object>	As informações sobre o circuito Express Connect associado.
	object	As informações sobre o circuito Express Connect associado.
Status	string	O status da instância do VBR. unconfirmed: aguardando confirmação da outra parte. active: normal. terminating: interrompendo o acesso. terminated: acesso interrompido. recovering: sendo recuperado. deleting: sendo excluído.	active
VlanInterfaceId	string	O ID da interface do roteador do VBR, que pode ser usado como o próximo salto de uma rota do VBR.	ri-kojok19x3j0q6k****
CircuitCode	string	O código do circuito fornecido pela operadora para o circuito Express Connect.	longtel0**
PeerIpv6GatewayIp	string	O endereço IPv6 do VBR no lado do cliente.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalIpv6GatewayIp	string	O endereço IPv6 do VBR no lado da Alibaba Cloud.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PhysicalConnectionOwnerUid	string	O ID da conta proprietária do circuito Express Connect.	12345678****
LocalGatewayIp	string	O endereço IPv4 do VBR no lado da Alibaba Cloud.	192.168.XX.XX
PhysicalConnectionBusinessStatus	string	O status comercial do circuito Express Connect. Normal: Normal. FinancialLocked: bloqueado devido a pagamento em atraso.	Normal
PeeringSubnetMask	string	A máscara de sub-rede para os endereços IPv4 no lado da Alibaba Cloud e no lado do cliente da instância do VBR. Os dois endereços IPv4 devem estar na mesma sub-rede.	255.255.255.252
EnableIpv6	boolean	Indica se o IPv6 está ativado. true: ativado. false: desativado.	true
PhysicalConnectionStatus	string	O status do circuito Express Connect. Initial: solicitando. Approved: aprovado. Allocating: alocando recursos. Allocated: em construção. Confirmed: aguardando confirmação do usuário. Enabled: ativado. Rejected: solicitação rejeitada. Canceled: cancelado. Allocation Failed: falha na alocação de recursos. Terminated: encerrado.	Enabled
PeerGatewayIp	string	O endereço IPv4 do VBR no lado do cliente.	116.62.XX.XX
PeeringIpv6SubnetMask	string	A máscara de sub-rede para os endereços IPv6 no lado da Alibaba Cloud e no lado do cliente da instância do VBR. Os dois endereços IPv6 devem estar na mesma sub-rede.	2408:4004:cc:400::/56
PhysicalConnectionId	string	O ID do circuito Express Connect.	pc-119mfjzm7****
VlanId	string	O ID da VLAN da instância do VBR.	0
AssociatedCens	object
AssociatedCen	array<object>	As informações sobre a instância associada da Cloud Enterprise Network (CEN).
	object	As informações da instância.
CenOwnerId	integer	O ID da conta à qual a instância CEN pertence.	1688000000000****
CenId	string	O ID da instância CEN.	cen-kojok19xxx****
CenStatus	string	O status da CEN. Attached: associada. Attaching: sendo associada. Detached: desassociada. Detaching: sendo desassociada. Vazio: não associada.	Attached
Bandwidth	integer	A largura de banda da instância do VBR. Unidade: Mbit/s.	50
ResourceGroupId	string	O ID do grupo de recursos. Para obter mais informações sobre grupos de recursos, consulte O que é um grupo de recursos?.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	As tags do recurso.
	object	A tag.
Key	string	A chave da tag do recurso.	FinanceDept
Value	string	O valor da tag do recurso.	FinanceJoshua
EcrId	string	O ID da instância do Express Connect Router (ECR) associado.	ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnable	boolean	Indica se o acesso comercial entre IDCs é permitido. Valores válidos: true: permitido. false: não permitido. Nota Se nenhum valor for especificado, o acesso comercial entre IDCs não será permitido.	false
EcrAttatchStatus	string	O status de associação do Express Connect Router (ECR). Attached: associado. Attaching: sendo associado. Detached: desassociado. Detaching: sendo desassociado. Empty: não associado.	Attached
EcrOwnerId	string	O ID da conta da Alibaba Cloud proprietária da instância ECR.	192732132151xxxx
Mtu	integer	O valor de MTU suportado pelo VBR. Valores válidos: 1500 e 8500.	1500

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "VirtualBorderRouterSet": {
    "VirtualBorderRouterType": [
      {
        "CreationTime": "2020-06-08T12:20:55",
        "Status": "active",
        "Type": "pconnVBR",
        "MinTxInterval": 300,
        "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "PConnVbrExpireTime": "2021-06-08T12:20:55",
        "PhysicalConnectionOwnerUid": "1688000000000****",
        "ActivationTime": "2021-06-08T12:20:55",
        "PhysicalConnectionBusinessStatus": "Normal",
        "Description": "desc",
        "TerminationTime": "2021-06-08T12:20:55",
        "MinRxInterval": 300,
        "PeerGatewayIp": "192.168.XX.XX",
        "Name": "test",
        "VbrId": "vbr-bp1jcg5cmxjbl9xgc****",
        "VlanId": 10,
        "VlanInterfaceId": "ri-2zeo3xzyf38r4xx****",
        "CircuitCode": "longtel0****",
        "LocalIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
        "LocalGatewayIp": "192.168.XX.XX",
        "PeeringSubnetMask": "255.255.255.252",
        "EnableIpv6": false,
        "RouteTableId": "vtb-bp1****",
        "DetectMultiplier": 3,
        "EccId": "ecc-h****",
        "CloudBoxInstanceId": "cb-****",
        "RecoveryTime": "2021-05-08T12:20:55",
        "PhysicalConnectionStatus": "Normal",
        "PeeringIpv6SubnetMask": "2000:1234:0:a000::/55",
        "AccessPointId": "ap-cn-kojok1x****",
        "PConnVbrChargeType": "PrePaid",
        "PhysicalConnectionId": "pc-119mfjzm7x****",
        "AssociatedPhysicalConnections": {
          "AssociatedPhysicalConnection": [
            {
              "Status": "active",
              "VlanInterfaceId": "ri-kojok19x3j0q6k****",
              "CircuitCode": "longtel0**",
              "PeerIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
              "LocalIpv6GatewayIp": "2001:XXXX:3c4d:0015:0000:0000:0000:1a2b",
              "PhysicalConnectionOwnerUid": "12345678****",
              "LocalGatewayIp": "192.168.XX.XX",
              "PhysicalConnectionBusinessStatus": "Normal",
              "PeeringSubnetMask": "255.255.255.252",
              "EnableIpv6": true,
              "PhysicalConnectionStatus": "Enabled",
              "PeerGatewayIp": "116.62.XX.XX",
              "PeeringIpv6SubnetMask": "2408:4004:cc:400::/56",
              "PhysicalConnectionId": "pc-119mfjzm7****",
              "VlanId": "0"
            }
          ]
        },
        "AssociatedCens": {
          "AssociatedCen": [
            {
              "CenOwnerId": 0,
              "CenId": "cen-kojok19xxx****",
              "CenStatus": "Attached"
            }
          ]
        },
        "Bandwidth": 50,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "EcrId": "ecr-7vrbqv9lcgvzqbwwkm",
        "SitelinkEnable": false,
        "EcrAttatchStatus": "Attached",
        "EcrOwnerId": "192732132151xxxx",
        "Mtu": 1500
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.	Ocorreu um erro desconhecido. Tente novamente a operação. Se o erro persistir, abra um ticket.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	O parâmetro é inválido.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	A chave do filtro não é suportada: Filter.X.key.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.