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

Obtém informações sobre um ou mais clientes de backup que atendem às condições especificadas.

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

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor mínimo: 1. Valor máximo: 99. Valor padrão: 10.	10
ClientType	string	Sim	O tipo do cliente de backup. Valores válidos: Valores válidos: CONTAINER_CLIENT : CONTAINER_CLIENT. LOCAL_CLIENT : LOCAL_CLIENT. ECS_CLIENT : ECS_CLIENT.	ECS_CLIENT
ClusterId	string	Não	O ID do cluster de backup.	cl-000ge4wa61b4d337xblq
ClientIds	array	Não	A lista de IDs dos clientes de backup.	["c-*********************"]
	string	Não	O ID do cliente de backup.	c-*********************
InstanceIds	array	Não	A lista de IDs das instâncias ECS.	["i-*********************"]
	string	Não	O ID da instância ECS.	i-*********************
Tag	array<object>	Não	As informações de tag a serem retornadas.	33738719#
	object	Não	As informações da tag.
Key	string	Não	A chave da tag do cofre de backup. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag do cofre de backup. Valores válidos de N: 1 a 20.	TestValue
CrossAccountType	string	Não	O tipo de backup entre contas. Valores válidos:	CROSS_ACCOUNT
CrossAccountUserId	integer	Não	O ID da conta de origem usada para backup entre contas.	129374672382xxxx
CrossAccountRoleName	string	Não	O nome da função RAM criada na conta de origem para backup entre contas.	hbrcrossrole
Filters	array<object>	Não	Os filtros de consulta.
	object	Não	Os filtros de consulta.
Key	string	Não	A chave do filtro de consulta.	InstanceId
Values	array	Não	Os valores a serem correspondidos no filtro de consulta.
	string	Não	Os valores a serem correspondidos no filtro de consulta.	i-*********************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Code	string	O código de resposta. 200 indica sucesso.	200
Message	string	A mensagem retornada. O valor "successful" é retornado para solicitações bem-sucedidas. Uma mensagem de erro é retornada para solicitações com falha.	successful
PageNumber	integer	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valor mínimo: 1. Valor máximo: 99. Valor padrão: 10.	10
TotalCount	integer	O número total de clientes de backup que atendem às condições especificadas.	8
Clients	array<object>	A lista de clientes de backup.	{'Client': []}
	array<object>
Status	string	O status do cliente de backup. Valores válidos:	ACTIVATED
BackupStatus	string	O status de proteção do cliente de backup. Valores válidos:	PROTECTED
ArchType	string	Este parâmetro é válido apenas quando ClientType está definido como ECS_CLIENT. A arquitetura do sistema do cliente de backup. Valores válidos:	amd64
ClientId	string	O ID do cliente de backup.	c-*********************
MaxClientVersion	string	O número da versão mais recente do cliente de backup.	2.4.5
PrivateIpV4	string	Este parâmetro é válido apenas quando ClientType está definido como ECS_CLIENT. O endereço IP interno da instância ECS.	192.168.1.1
InstanceName	string	Este parâmetro é válido apenas quando ClientType está definido como ECS_CLIENT. O nome da instância ECS.	instancename
CreatedTime	integer	A hora em que o cliente de backup foi criado. Este valor é um timestamp UNIX. Unidade: segundos.	1554347313
LastHeartBeatTime	integer	A hora do último heartbeat do cliente de backup. Este valor é um timestamp UNIX. Unidade: segundos.	1554347313
ClientType	string	O tipo do cliente de backup. O valor ECS_CLIENT indica um cliente de Backup de Arquivos ECS.	ECS_CLIENT
Hostname	string	O nome do host do cliente de backup.	hostname
InstanceId	string	O ID da instância.	i-*********************
Appliance	boolean	Indica se o cliente é um cliente de appliance de monitoramento de hardware.	false
UpdatedTime	integer	A hora em que o cliente de backup foi atualizado pela última vez. Este valor é um timestamp UNIX. Unidade: segundos.	1554347313
OsType	string	Este parâmetro é válido apenas quando ClientType está definido como ECS_CLIENT. O tipo de sistema operacional do cliente. Valores válidos:	linux
ZoneId	string	Este parâmetro é válido apenas quando ClientType está definido como ECS_CLIENT. O ID da zona.	cn-hangzhou-f
ClientVersion	string	O número da versão do cliente de backup.	2.4.5
Tags	array<object>	As informações da tag.
	object
Key	string	A chave da tag do repositório. N pode ser um número inteiro de 1 a 20. A chave da tag não pode começar com `aliyun` ou `acs:`. A chave da tag não pode conter `http://` ou `https://`. A chave da tag não pode ser uma string vazia.	TestKey
Value	string	O valor da tag do repositório. N pode ser um número inteiro de 1 a 20. O valor da tag não pode começar com `aliyun` ou `acs:`. O valor da tag não pode conter `http://` ou `https://`. O valor da tag não pode ser uma string vazia.	TestValue
Settings	object	As informações de configuração do cliente de backup.
ProxyHost	string	O endereço IP do servidor proxy personalizado para o plano de dados.	192.168.11.100
MaxCpuCore	string	O número de núcleos de CPU que são usados por um único trabalho de backup. Um valor 0 indica que o número de núcleos de CPU não é limitado.	1
ProxyPort	integer	O número da porta do servidor proxy personalizado para o plano de dados.	3128
UseHttps	string	Indica se os dados são transmitidos por HTTPS no plano de dados. true: Os dados são transmitidos por HTTPS. false: Os dados são transmitidos por HTTP.	false
ProxyPassword	string	A senha para o servidor proxy personalizado para o plano de dados.	******
ProxyUser	string	O nome de usuário para o servidor proxy personalizado para o plano de dados.	user
DataProxySetting	string	As configurações de proxy para o plano de dados. Valores válidos: DISABLE: Um proxy não é usado. USE_CONTROL_PROXY (padrão): As configurações de proxy são as mesmas do plano de controle. CUSTOM: Configurações personalizadas são usadas. O protocolo HTTP é usado.	USE_CONTROL_PROXY
DataNetworkType	string	O tipo de rede do plano de dados. Valores válidos: PUBLIC: Internet VPC: VPC CLASSIC: rede clássica.	VPC
MaxWorker	string	O número de trabalhos de backup simultâneos. Um valor 0 indica que o número de trabalhos de backup simultâneos não é limitado.	1
MaxMemory	integer	A memória máxima que o cliente pode usar. Unidade: bytes. Este parâmetro é suportado apenas para versões de cliente 2.13.0 e posteriores.	0
AlertOnPartialComplete	boolean	Indica se deve ser gerado um alerta para trabalhos parcialmente concluídos. Este parâmetro é válido apenas para backup de arquivos locais e backup de arquivos ECS.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Clients": [
    {
      "Status": "ACTIVATED",
      "BackupStatus": "PROTECTED",
      "ArchType": "amd64",
      "ClientId": "c-*********************",
      "MaxClientVersion": "2.4.5",
      "PrivateIpV4": "192.168.1.1",
      "InstanceName": "instancename",
      "CreatedTime": 1554347313,
      "LastHeartBeatTime": 1554347313,
      "ClientType": "ECS_CLIENT",
      "Hostname": "hostname",
      "InstanceId": "i-*********************",
      "Appliance": false,
      "UpdatedTime": 1554347313,
      "OsType": "linux",
      "ZoneId": "cn-hangzhou-f",
      "ClientVersion": "2.4.5",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Settings": {
        "ProxyHost": "192.168.11.100",
        "MaxCpuCore": "1",
        "ProxyPort": 3128,
        "UseHttps": "false",
        "ProxyPassword": "******",
        "ProxyUser": "user",
        "DataProxySetting": "USE_CONTROL_PROXY",
        "DataNetworkType": "VPC",
        "MaxWorker": "1",
        "MaxMemory": 0,
        "AlertOnPartialComplete": false
      }
    }
  ]
}

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.