DescribeClients - Cloud Backup: Central de Documentação do Alibaba Cloud

Consulta um ou mais clientes do Cloud Backup que atendem às condições especificadas.

Descrição da operação

Esta operação é aplicável apenas ao backup do SAP HANA. Para clientes do Cloud Backup de outras origens de dados, chame a operação DescribeBackupClients.

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

hbr:DescribeClients

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VaultId	string	Não	O ID do cofre de backup.	v-0001vk0z******xdyr
ClientId	string	Não	O ID do cliente do Cloud Backup.	c-000ed600******6b0
PageNumber	integer	Não	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10.	10
ClientType	string	Não	O tipo de cliente do Cloud Backup. Valor válido: ECS_AGENT, que indica um cliente de backup do SAP HANA.	ECS_AGENT
SourceType	string	Não	O tipo da origem de dados. Valor válido: HANA, que indica o backup do SAP HANA.	HANA
ClusterId	string	Não	O ID da instância do SAP HANA.	cl-0005ni1******2l87
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmw6bxl7o5qyq

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	17189276-465D-5EF3-8FFD-0FF51B5A41A0
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Code	string	O código de resposta. O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se a solicitação falhar, uma mensagem de erro será retornada.	successful
PageNumber	integer	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas retornadas.	12
Clients	object
Client	array<object>	Os clientes do Cloud Backup.
	object	As informações do cliente.
Status	string	The status of the Cloud Backup client. Valid values: REGISTERED: The backup client is registered. ACTIVATED: The backup client is activated. DEACTIVATED: The backup client fails to be activated. INSTALLING: The backup client is being installed. INSTALL_FAILED: The backup client fails to be installed. NOT_INSTALLED: The backup client is not installed. UPGRADING: The backup client is being upgraded. UPGRADE_FAILED: The backup client fails to be upgraded. UNINSTALLING: The backup client is being uninstalled. UNINSTALL_FAILED: The backup client fails to be uninstalled. STOPPED: The backup client is out of service. UNKNOWN: The backup client is disconnected.	ACTIVATED
VaultId	string	The ID of the backup vault.	v-00029mx6o******n85lg
UseHttps	boolean	Indicates whether data is transmitted over HTTPS. Valid values: true: Data is transmitted over HTTPS. false: Data is transmitted over HTTP.	false
NetworkType	string	The network type. Valid values: CLASSIC: the classic network VPC: the virtual private cloud (VPC)	VPC
ClientName	string	The client name.	client-20211224-101226
ClientId	string	The ID of the Cloud Backup client.	c-00062uu******2fgj
AlertSetting	string	The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.	INHERITED
InstanceName	string	The name of the ECS instance.	swh-hbr
MaxVersion	string	The maximum version number of the Cloud Backup client.	1.11.23
CreatedTime	integer	The time when the Cloud Backup client was created.	1554347313
StatusMessage	string	The status information.	HANA_NOT_SUPPORT
ClientType	string	The type of the Cloud Backup client. Valid value: ECS_AGENT, which indicates an SAP HANA backup client.	ECS_AGENT
InstanceId	string	The instance ID.	i-wz9b6wya******n8yo
UpdatedTime	integer	The time when the Cloud Backup client was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
ClientVersion	string	The version number of the Cloud Backup client.	1.11.16
ClusterId	string	The ID of the SAP HANA instance.	cl-0008c48frr******ncpk
HeartBeatTime	integer	The latest heartbeat time of the Cloud Backup client. This value is a UNIX timestamp. Unit: seconds.	1554347313

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": {
    "Client": [
      {
        "Status": "ACTIVATED",
        "VaultId": "v-00029mx6o******n85lg",
        "UseHttps": false,
        "NetworkType": "VPC",
        "ClientName": "client-20211224-101226",
        "ClientId": "c-00062uu******2fgj",
        "AlertSetting": "INHERITED",
        "InstanceName": "swh-hbr",
        "MaxVersion": "1.11.23",
        "CreatedTime": 1554347313,
        "StatusMessage": "HANA_NOT_SUPPORT",
        "ClientType": "ECS_AGENT",
        "InstanceId": "i-wz9b6wya******n8yo",
        "UpdatedTime": 1554347313,
        "ClientVersion": "1.11.16",
        "ClusterId": "cl-0008c48frr******ncpk",
        "HeartBeatTime": 1554347313
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.