DescribeRouterInterfaceAttribute - Virtual Private Cloud: Central de Documentação do Alibaba Cloud

Consulta a configuração de uma interface de roteador.

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

get

*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.	cn-qingdao
InstanceId	string	Sim	O ID da interface de roteador a ser consultada.	ri-m5egfc10sednwk2yt****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
ReservationActiveTime	string	A hora de ativação da renovação. A hora é exibida no padrão ISO 8601, no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2022-06-11T16:00:00Z
HealthCheckTargetIp	string	O endereço IP de destino do health check.	2.2.XX.XX
Status	string	O status da interface de roteador. Valores válidos:	Active
CreationTime	string	A hora em que a interface de roteador foi criada. A hora é exibida no padrão ISO 8601, no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2022-04-14T08:57:24Z
ReservationOrderType	string	O tipo de pedido de renovação. Valores válidos: RENEW, que indica um pedido de renovação.	RENEW
OppositeInterfaceId	string	O ID da interface de roteador par.	ri-bp1xkrzttximaoxbl****
Spec	string	A especificação da interface de roteador. Valores válidos:	Mini.2
ChargeType	string	O método de cobrança. Valores válidos:	AfterPay
RouterInterfaceId	string	O ID da interface de roteador.	ri-m5egfc10sednwk2yt****
Message	string	A mensagem retornada.	successful
HcThreshold	integer	O limite do health check. O valor indica o número de pacotes de sondagem enviados durante um health check. Unidade: pacotes.	8
OppositeRouterType	string	O tipo de roteador ao qual a interface de roteador par pertence. Valores válidos:	VRouter
GmtModified	string	A hora em que a interface de roteador foi modificada pela última vez.	2022-04-28T10:02:12Z
VpcInstanceId	string	O ID da nuvem privada virtual (VPC) à qual a interface de roteador pertence.	vpc-bp1b49rqrybk45nio****
OppositeInterfaceOwnerId	string	O ID da conta à qual a interface de roteador par pertence.	1321932713****
OppositeVpcInstanceId	string	O ID da VPC par.	vpc-bp1b49rqrybk45nio****
ReservationInternetChargeType	string	O tipo de cobrança da renovação. Valores válidos: PayByBandwidth, que indica cobrança por largura de banda.	PayByBandwidth
CrossBorder	boolean	Indica se a conexão é uma conexão transfronteiriça. Valores válidos:	false
RequestId	string	O ID da solicitação.	01818199-04F6-47F4-9ADF-7CC824CF57A4
Bandwidth	integer	A largura de banda da interface de roteador. Unidade: Mbps.	2
Description	string	A descrição da interface de roteador.	Peer interface
HcRate	integer	A taxa do health check. Unidade: segundos. O valor indica o intervalo entre pacotes de sondagem consecutivos enviados durante um health check.	2
ReservationBandwidth	string	A largura de banda da renovação. Unidade: Mbps.	100
Code	string	O código de status HTTP.	200
Name	string	O nome da interface de roteador.	RouterInterface1
OppositeRouterId	string	O ID do roteador ao qual a interface de roteador par pertence.	vrt-bp11xvy6lb9photuu****
OppositeInterfaceSpec	string	A especificação da interface de roteador par. Valores válidos:	Negative
RouterId	string	O ID do roteador ao qual a interface de roteador pertence.	vbr-m5ex0xf63xk8s5bob****
Success	boolean	Indica se a chamada foi bem-sucedida.	true
OppositeInterfaceBusinessStatus	string	O status comercial da interface de roteador par. Valores válidos:	Normal
ConnectedTime	string	A hora em que a conexão foi estabelecida. A hora é exibida no padrão ISO 8601, no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2022-04-14T08:58:04Z
HealthCheckSourceIp	string	O endereço IP de origem do health check.	1.1.XX.XX
OppositeInterfaceStatus	string	O status da interface de roteador par. Valores válidos:	Active
EndTime	string	A hora final da recuperação de dados. A hora é exibida no padrão ISO 8601, no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2999-09-08T16:00:00Z
OppositeRegionId	string	O ID da região da interface de roteador par.	cn-hangzhou
OppositeAccessPointId	string	O ID do ponto de acesso par.	ap-cn-qingdao-ls-B
BusinessStatus	string	O status comercial da interface de roteador. Valores válidos:	Normal
HealthCheckStatus	string	O status do health check. Valores válidos:	normal
OppositeBandwidth	integer	A largura de banda da interface de roteador par. Unidade: Mbps.	0
RouterType	string	O tipo de roteador ao qual a tabela de rotas pertence. Valores válidos:	VRouter
Role	string	A função na conexão de peering.	InitiatingSide
HasReservationData	string	Indica se existem dados de renovação. Valores válidos:	false
AccessPointId	string	O ID do ponto de acesso.	ap-cn-qingdao-ls-A
ResourceGroupId	string	O ID do 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. Você deve especificar pelo menos 1 chave de tag e pode especificar no máximo 20 chaves de tag. A chave da tag não pode ser uma string vazia.	FinanceDept
Value	string	O valor da tag do recurso. Você pode especificar no máximo 20 valores de tag. O valor da tag pode ser uma string vazia.	FinanceJoshua
FastLinkMode	string	Indica se a interface de roteador no VBR foi criada no modo de link rápido. No modo de link rápido, as interfaces de roteador no VBR e na VPC são conectadas automaticamente após serem criadas. Valores válidos:	false

Exemplos

Resposta de sucesso

JSON formato

{
  "ReservationActiveTime": "2022-06-11T16:00:00Z",
  "HealthCheckTargetIp": "2.2.XX.XX",
  "Status": "Active",
  "CreationTime": "2022-04-14T08:57:24Z",
  "ReservationOrderType": "RENEW",
  "OppositeInterfaceId": "ri-bp1xkrzttximaoxbl****",
  "Spec": "Mini.2",
  "ChargeType": "AfterPay",
  "RouterInterfaceId": "ri-m5egfc10sednwk2yt****",
  "Message": "successful",
  "HcThreshold": 8,
  "OppositeRouterType": "VRouter",
  "GmtModified": "2022-04-28T10:02:12Z",
  "VpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "OppositeInterfaceOwnerId": "1321932713****",
  "OppositeVpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "ReservationInternetChargeType": "PayByBandwidth",
  "CrossBorder": false,
  "RequestId": "01818199-04F6-47F4-9ADF-7CC824CF57A4",
  "Bandwidth": 2,
  "Description": "Peer interface",
  "HcRate": 2,
  "ReservationBandwidth": "100",
  "Code": "200",
  "Name": "RouterInterface1",
  "OppositeRouterId": "vrt-bp11xvy6lb9photuu****",
  "OppositeInterfaceSpec": "Negative",
  "RouterId": "vbr-m5ex0xf63xk8s5bob****",
  "Success": true,
  "OppositeInterfaceBusinessStatus": "Normal",
  "ConnectedTime": "2022-04-14T08:58:04Z",
  "HealthCheckSourceIp": "1.1.XX.XX",
  "OppositeInterfaceStatus": "Active",
  "EndTime": "2999-09-08T16:00:00Z",
  "OppositeRegionId": "cn-hangzhou",
  "OppositeAccessPointId": "ap-cn-qingdao-ls-B",
  "BusinessStatus": "Normal",
  "HealthCheckStatus": "normal",
  "OppositeBandwidth": 0,
  "RouterType": "VRouter",
  "Role": "InitiatingSide",
  "HasReservationData": "false",
  "AccessPointId": "ap-cn-qingdao-ls-A",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Tags": {
    "Tags": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "FastLinkMode": "false"
}

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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.