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

Consulta as instâncias de Virtual Border Router (VBR) que você criou.

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 do filtro.
	object	Não	As informações do filtro.
Key	string	Não	A condição do filtro. Você pode especificar até 5 condições de filtro. Há suporte para as seguintes condições de filtro: PhysicalConnectionId: ID da instância do circuito do Express Connect. VbrId: ID da instância do Virtual Border Router. Status: o status do Virtual Border Router. Name: o nome do Virtual Border Router. AccessPointId: ID da instância do ponto de acesso. eccId: ID da instância do Express Cloud Connect. type: o tipo do circuito do Express Connect.	Status
Value	array	Não	O valor do filtro com base na chave especificada. Você pode especificar vários valores de filtro para uma chave. A relação entre os valores de filtro é OR, o que significa que uma correspondência é encontrada se qualquer um dos valores de filtro for atendido.	Active
	string	Não	O valor do filtro com base na chave especificada. Você pode especificar vários valores de filtro para uma chave. A relação entre os valores de filtro é OR, o que significa que uma correspondência é encontrada se qualquer um dos valores de filtro for atendido.	Active
IncludeCrossAccountVbr	boolean	Não	Especifica se devem ser incluídos Virtual Border Routers de contas cruzadas. true: Incluídos. false (padrão): Não incluídos.	false
ResourceGroupId	string	Não	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	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. Uma chave de tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	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 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 consultados.
	array<object>	A hora em que o VBR foi criado.
CreationTime	string	The time when the VBR was created.	2020-06-08T12:20:55
Status	string	The instance status of the VBR. unconfirmed: waiting for confirmation from others. active: Normal. terminating: stopping access. terminated: access stopped. recovering: being recovered. deleting: being deleted.	active
Type	string	The type of the VBR.	pconnVBR
MinTxInterval	integer	The send alert interval of Bidirectional Forwarding Detection (BFD) packets. Valid values: 200 to 1000. Unit: ms.	300
PeerIpv6GatewayIp	string	The IPv6 address of the VBR instance on the customer side.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PConnVbrExpireTime	string	The expiration time of the billable VBR.	2021-06-08T12:20:55
PhysicalConnectionOwnerUid	string	The ID of the account to which the Express Connect circuit belongs.	1688000000000****
ActivationTime	string	The time when the VBR was first activated.	2021-06-08T12:20:55
PhysicalConnectionBusinessStatus	string	The business status of the Express Connect circuit. Normal: Normal. FinancialLocked: financial lock.	Normal
Description	string	The description of the VBR.	desc
TerminationTime	string	The time when the VBR was most recently terminated.	2021-06-08T12:20:55
MinRxInterval	integer	The receive interval of BFD packets. Valid values: 200 to 1000. Unit: ms.	300
PeerGatewayIp	string	The IPv4 address of the VBR instance on the customer side.	192.168.XX.XX
Name	string	The name of the VBR instance.	test
VbrId	string	The instance ID of the VBR.	vbr-bp1jcg5cmxjbl9xgc****
VlanId	integer	The VLAN ID of the VBR instance.	10
VlanInterfaceId	string	The ID of the router interface of the VBR.	ri-2zeo3xzyf38r4xx****
CircuitCode	string	The circuit code provided by the carrier for the Express Connect circuit.	longtel0****
LocalIpv6GatewayIp	string	The IPv6 address of the VBR instance on the Alibaba Cloud side.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalGatewayIp	string	The IPv4 address of the VBR instance on the Alibaba Cloud side.	192.168.XX.XX
PeeringSubnetMask	string	The subnet mask for the IPv4 addresses on the Alibaba Cloud side and the customer side of the VBR instance.	255.255.255.252
EnableIpv6	boolean	Indicates whether IPv6 is enabled. true: Enabled. false: Disabled.	false
RouteTableId	string	The route table ID of the VBR.	rtb-bp1****
DetectMultiplier	integer	The detection time multiplier. This is the maximum number of consecutive packet losses that the receiver allows from the sender, which is used to detect whether the link is normal. Valid values: 3 to 10.	3
EccId	string	The instance ID of the Express Cloud Connect instance.	ecc-h****
CloudBoxInstanceId	string	The instance ID of the CloudBox.	cb-****
RecoveryTime	string	The time when the VBR most recently recovered from the terminated state to the active state.	2021-05-08T12:20:55
PhysicalConnectionStatus	string	The status of the Express Connect circuit. Initial: applying. Approved: approved. Allocating: allocating resources. Allocated: under construction. Confirmed: waiting for user confirmation. Enabled: enabled. Rejected: application rejected. Canceled: canceled. Allocation Failed: resource allocation failed. Terminated: terminated.	Normal
PeeringIpv6SubnetMask	string	The subnet mask for the IPv6 addresses on the Alibaba Cloud side and the customer side of the VBR instance.	2000:1234:0:a000::/55
AccessPointId	string	The ID of the access point for the Express Connect circuit.	ap-cn-kojok1x****
PConnVbrChargeType	string	The billing method of the Virtual Border Router bound to the Express Connect circuit. PrePaid: subscription. If you select this billing method, make sure that your account supports balance payment or credit payment. PostPaid: pay-as-you-go.	PrePaid
PhysicalConnectionId	string	The ID of the Express Connect circuit to which the VBR belongs.	pc-119mfjzm7x****
AssociatedPhysicalConnections	object
AssociatedPhysicalConnection	array<object>	The information about the associated Express Connect circuits.
	object	The information about the associated Express Connect circuits.
Status	string	The instance status of the VBR. unconfirmed: waiting for confirmation from others. active: Normal. terminating: stopping access. terminated: access stopped. recovering: being recovered. deleting: being deleted.	active
VlanInterfaceId	string	The ID of the router interface of the VBR, which can be used as the next hop of a VBR route.	ri-kojok19x3j0q6k****
CircuitCode	string	The circuit code provided by the carrier for the Express Connect circuit.	longtel0**
PeerIpv6GatewayIp	string	The IPv6 address of the VBR instance on the customer side.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
LocalIpv6GatewayIp	string	The IPv6 address of the VBR instance on the Alibaba Cloud side.	2001:XXXX:3c4d:0015:0000:0000:0000:1a2b
PhysicalConnectionOwnerUid	string	The ID of the account that owns the Express Connect circuit.	12345678****
LocalGatewayIp	string	The IPv4 address of the VBR instance on the Alibaba Cloud side.	192.168.XX.XX
PhysicalConnectionBusinessStatus	string	The business status of the Express Connect circuit. Normal: Normal. FinancialLocked: financial lock.	Normal
PeeringSubnetMask	string	The subnet mask for the IPv4 addresses on the Alibaba Cloud side and the customer side of the VBR instance. The two IPv4 addresses must be in the same subnet.	255.255.255.252
EnableIpv6	boolean	Indicates whether IPv6 is enabled. true: Enabled. false: Disabled.	true
PhysicalConnectionStatus	string	The status of the Express Connect circuit. Initial: applying. Approved: approved. Allocating: allocating resources. Allocated: under construction. Confirmed: waiting for user confirmation. Enabled: enabled. Rejected: application rejected. Canceled: canceled. Allocation Failed: resource allocation failed. Terminated: terminated.	Enabled
PeerGatewayIp	string	The IPv4 address of the VBR instance on the customer side.	116.62.XX.XX
PeeringIpv6SubnetMask	string	The subnet mask for the IPv6 addresses on the Alibaba Cloud side and the customer side of the VBR instance. The two IPv6 addresses must be in the same subnet.	2408:4004:cc:400::/56
PhysicalConnectionId	string	The ID of the Express Connect circuit.	pc-119mfjzm7****
VlanId	string	The VLAN ID of the VBR instance.	0
AssociatedCens	object
AssociatedCen	array<object>	The information about the associated Cloud Enterprise Network (CEN) instances.
	object	The instance information.
CenOwnerId	integer	The ID of the account to which the CEN instance belongs.	1688000000000****
CenId	string	The instance ID of the CEN.	cen-kojok19xxx****
CenStatus	string	The status of the CEN instance. Attached: associated. Attaching: being associated. Detached: dissociated. Detaching: being dissociated. Empty: not associated.	Attached
Bandwidth	integer	The bandwidth of the VBR instance. Unit: Mbit/s.	50
ResourceGroupId	string	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	The tags of the resource.
	object	The tag.
Key	string	The tag key of the resource.	FinanceDept
Value	string	The tag value of the resource.	FinanceJoshua
EcrId	string	The instance ID of the associated Express Connect Router (ECR).	ecr-7vrbqv9lcgvzqbwwkm
SitelinkEnable	boolean	Indicates whether communication between IDCs is allowed. Valid values: true: allowed. false: not allowed. Nota If no value is specified, communication between IDCs is not allowed.	false
EcrAttatchStatus	string	The association status of the Express Connect Router (ECR). Attached: associated. Attaching: being associated. Detached: dissociated. Detaching: being dissociated. Empty: not associated.	Attached
EcrOwnerId	string	The ID of the Alibaba Cloud account that owns the ECR instance.	192732132151xxxx
Mtu	integer	The MTU value supported by the VBR. Valid values: 1500 and 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": "rtb-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.	Unknown error. Please retry the operation. The error still exists. Please submit the work order for processing.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Filter.X.key is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.