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

Consulta interfaces de roteador em uma região especificada.

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

list

*RouterInterface.

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da interface de roteador. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
IncludeReservationData	boolean	Não	Especifica se os dados de renovação devem ser incluídos. Valores válidos: true false (padrão)	false
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 quando a paginação é realizada. 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. As seguintes condições de filtro são suportadas: RouterInterfaceId: o ID da interface de roteador. RouterId: o ID do roteador. RouterType: o tipo de roteador. Valores válidos: VRouter e VBR. RouterInterfaceOwnerId: o ID da conta à qual a interface de roteador pertence. OppositeInterfaceId: o ID da interface de roteador par. OppositeRouterType: o tipo da interface de roteador par. Valores válidos: VRouter e VBR. OppositeRouterId: o ID da interface de roteador par. OppositeInterfaceOwnerId: o ID da conta à qual a interface de roteador par pertence. Status: o status da interface de roteador. Name: o nome da interface de roteador. Nota Os múltiplos valores de cada condição de filtro têm uma relação OU. Uma interface de roteador é retornada desde que corresponda a um dos valores. As condições de filtro têm uma relação E. Uma interface de roteador é retornada apenas quando corresponde a todas as condições de filtro especificadas.	Filter.1.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. Os valores de filtro têm uma relação OU. Uma interface de roteador é retornada desde que corresponda a um dos valores de filtro.	Filter.1.Active 1
	string	Não	O valor do filtro com base na chave especificada. Você pode especificar vários valores de filtro para uma chave. Os valores de filtro têm uma relação OU. Uma interface de roteador é retornada desde que corresponda a um dos valores de filtro.	test
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 de comprimento. Não pode começar com `aliyun` ou `acs:` e 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 de comprimento. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	O número da página. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página quando a paginação é realizada. Valor máximo: 50. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas retornadas.	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	Os detalhes das interfaces de roteador.
	array<object>	Os detalhes das interfaces de roteador.
ReservationActiveTime	string	A hora de ativação da renovação. A hora segue o padrão ISO 8601 em UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	O endereço IP de destino da verificação de integridade.	116.62.XX.XX
Status	string	O status da interface de roteador.	active
CreationTime	string	A hora em que a tabela de rotas foi criada. A hora segue o padrão ISO 8601 em UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
ReservationOrderType	string	O tipo de pedido de renovação.	RENEWCHANGE
OppositeInterfaceId	string	O ID da interface de roteador par.	ri-bp1itx13bwe6f2wfh****
Spec	string	A especificação da interface de roteador.	Large
ChargeType	string	O método de cobrança.	PayByTraffic
RouterInterfaceId	string	O ID da interface de roteador.	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	O limite da verificação de integridade.	2
OppositeRouterType	string	O tipo do roteador ao qual a interface de roteador par pertence.	VRouter
VpcInstanceId	string	O ID da VPC local na conexão de peering.	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	O ID da conta à qual a interface de roteador par pertence.	271598332402530847
OppositeVpcInstanceId	string	O ID da VPC par.	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	O tipo de cobrança de renovação.	PayByBandwidth
CrossBorder	boolean	Indica se a conexão é uma conexão transfronteiriça.	false
Bandwidth	integer	A largura de banda da interface de roteador. Unidade: Mbit/s.	10
Description	string	A descrição da interface de roteador.	Descrição da interface de roteador
HcRate	integer	A taxa de verificação de integridade.	1
ReservationBandwidth	string	A largura de banda de renovação. Unidade: Mbit/s.	10
Name	string	O nome personalizado.	test
OppositeRouterId	string	O ID do roteador ao qual a interface de roteador par pertence.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	A especificação da interface de roteador par.	Large
RouterId	string	O ID do roteador ao qual a entrada de rota pertence.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	O status comercial da interface de roteador par.	Normal
ConnectedTime	string	A hora em que a conexão foi estabelecida. A hora segue o padrão ISO 8601 em UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
HealthCheckSourceIp	string	O endereço IP de origem da verificação de integridade.	116.62.XX.XX
OppositeInterfaceStatus	string	O status da interface de roteador par.	Normal
EndTime	string	A hora final dos dados recuperados. A hora segue o padrão ISO 8601 em UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
OppositeRegionId	string	O ID da região da interface de roteador par.	cn-shanghai
OppositeAccessPointId	string	O ID do ponto de acesso par.	ap-cn-shanghaiSZ-****
BusinessStatus	string	O status comercial da interface de roteador. Valores válidos: Normal: Normal. FinancialLocked: bloqueio financeiro. SecurityLocked: bloqueado devido ao controle de risco de segurança.	Normal
OppositeBandwidth	integer	A largura de banda par. Unidade: Mbit/s.	12
RouterType	string	O tipo do roteador ao qual a tabela de rotas pertence. Valores válidos: VRouter: vRouter da VPC. VBR: Virtual Border Router.	VRouter
Role	string	A função na conexão de peering.	InitiatingSide
HasReservationData	string	Indica se existem dados de renovação.	false
AccessPointId	string	O ID do ponto de acesso.	ap-cn-shanghaiSZ-****
Ipv6Status	string	Indica se a proteção de segurança IPv6 está ativada. Valores válidos: on: ativado. off: desativado. unsupport: não suportado.	on
FastLinkMode	boolean	Indica se a interface de roteador no VBR foi criada no modo de link rápido. O modo de link rápido permite que as interfaces de roteador no VBR e na VPC se conectem automaticamente após serem criadas. Valores válidos: true false (padrão)	false
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

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "ReservationActiveTime": "2021-03-11T16:00:00Z",
        "HealthCheckTargetIp": "116.62.XX.XX",
        "Status": "active",
        "CreationTime": "2021-06-08T12:20:55",
        "ReservationOrderType": "RENEWCHANGE",
        "OppositeInterfaceId": "ri-bp1itx13bwe6f2wfh****",
        "Spec": "Large",
        "ChargeType": "PayByTraffic",
        "RouterInterfaceId": "ri-2zenfgfpyu3v93koa****",
        "HcThreshold": 2,
        "OppositeRouterType": "VRouter",
        "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
        "OppositeInterfaceOwnerId": "271598332402530847",
        "OppositeVpcInstanceId": "vpc-bp1qpo0kug3a20qqe****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "CrossBorder": false,
        "Bandwidth": 10,
        "Description": "Descrição da interface de roteador",
        "HcRate": 1,
        "ReservationBandwidth": "10",
        "Name": "test",
        "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceSpec": "Large",
        "RouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceBusinessStatus": "Normal",
        "ConnectedTime": "2021-06-08T12:20:55",
        "HealthCheckSourceIp": "116.62.XX.XX",
        "OppositeInterfaceStatus": "Normal",
        "EndTime": "2021-06-08T12:20:55",
        "OppositeRegionId": "cn-shanghai",
        "OppositeAccessPointId": "ap-cn-shanghaiSZ-****",
        "BusinessStatus": "Normal",
        "OppositeBandwidth": 12,
        "RouterType": "VRouter",
        "Role": "InitiatingSide",
        "HasReservationData": "false",
        "AccessPointId": "ap-cn-shanghaiSZ-****",
        "Ipv6Status": "on",
        "FastLinkMode": false,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParam.NotNull	The parameter must not be null.
400	EndPoint.Empty	the rc endpoint is empty.
400	InvalidConnectionType.MalFormed	Connection type must be vpc2vpc or vbr2vpc.
400	InvalidProductForm.MalFormed	Product form must be routerinterface or expressconnect.
400	InvalidRole.Malformed	role must be InitiatingSide or AcceptingSide.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
400	Parameter.Illegal	The parameter is illegal.	O parâmetro é inválido.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	O parâmetro é inválido.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
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.