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

Consulta as informações de verificação de integridade de um roteador de borda virtual (VBR) 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

cen:DescribeCenVbrHealthCheck

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CenId	string	Não	O ID da instância da Cloud Enterprise Network (CEN).	cen-6hpdgj7ni6pz1k****
VbrInstanceRegionId	string	Sim	O ID da região onde o Roteador de Borda Virtual (VBR) está implantado. Para mais informações, consulte DescribeChildInstanceRegions.	cn-hangzhou
VbrInstanceId	string	Não	O ID do VBR.	vbr-bp1kznorjeembsuhl****
VbrInstanceOwnerId	integer	Não	O ID da conta Alibaba Cloud que possui o VBR.	1250123456123456
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. Valores válidos: 1 a 50. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	B8C9702E-304A-4E18-AC89-BE2D91C2C176
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas retornadas.	1
VbrHealthChecks	object
VbrHealthCheck	array<object>	As configurações de verificação de integridade do VBR.
	object	The health check configuration.
HealthCheckTargetIp	string	The destination IP address of the health check.	192.XX.XX.1
VbrInstanceId	string	The VBR ID.	vbr-bp1kznorjeembsuhl****
VbrInstanceRegionId	string	The ID of the region where the VBR is deployed.	cn-hangzhou
CenId	string	The CEN ID.	cen-6hpdgj7ni6pz1k****
HealthyThreshold	integer	The number of probe packets that are sent during a health check.	8
HealthCheckInterval	integer	The interval, in seconds, at which probe packets are sent during a health check.	2
HealthCheckSourceIp	string	The source IP address of the health check.	172.XX.XX.1
HealthCheckOnly	boolean	Specifies whether to enable the detection-only feature for the health check. true: The system detects the link status but does not switch routes if the health check fails. `If this feature is enabled, the system detects the link status but does not switch routes when the health check fails.` false: If a redundant route is available in the CEN instance, the system switches to the redundant route if the health check fails. `If this feature is disabled and a redundant route is available in the CEN instance, the system switches to the redundant route when the health check fails.`	false
Description	string	The description of the health check.	healthcheck_description

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "B8C9702E-304A-4E18-AC89-BE2D91C2C176",
  "PageNumber": 1,
  "TotalCount": 1,
  "VbrHealthChecks": {
    "VbrHealthCheck": [
      {
        "HealthCheckTargetIp": "192.XX.XX.1",
        "VbrInstanceId": "vbr-bp1kznorjeembsuhl****",
        "VbrInstanceRegionId": "cn-hangzhou",
        "CenId": "cen-6hpdgj7ni6pz1k****",
        "HealthyThreshold": 8,
        "HealthCheckInterval": 2,
        "HealthCheckSourceIp": "172.XX.XX.1",
        "HealthCheckOnly": false,
        "Description": "healthcheck_description"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.