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

Consulta uma ou mais instâncias SAP HANA 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:DescribeHanaInstances

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-000b0ov******6zs
ClusterId	string	Não	O ID da instância SAP HANA.	cl-0001zfc******50pr3
PageNumber	integer	Não	O número da página. As páginas começam a partir da 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
Tag	array<object>	Não	As tags da instância SAP HANA.
	object	Não	As tags da instância SAP HANA.
Key	string	Não	A chave da tag.	ace:rm:rgld
Value	string	Não	O valor da tag.	rg-acfmwutpyat2kwy
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aekz24ikcjyqjkq

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	4003DD68-3C3C-5071-B4FC-631A6C1BAC1C
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 foi bem-sucedida, "successful" é retornado. Se a solicitação falhou, uma mensagem de erro é retornada.	successful
PageNumber	integer	O número da página. As páginas começam a partir da 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.	21
Hanas	object
Hana	array<object>	As informações sobre as instâncias SAP HANA.
	array<object>	A instância SAP HANA.
Status	integer	The status of the SAP HANA instance. Valid values: INITIALIZING: The instance is being initialized. INITIALIZED: The instance is registered. INVALID_HANA_NODE: The instance is invalid. INITIALIZE_FAILED: The client fails to be installed on the instance.	INITIALIZED
Host	string	The private or internal IP address of the host where the primary node of the SAP HANA instance resides.	47.100.XX.XX
VaultId	string	The ID of the backup vault.	v-0000s974******1hl
UseSsl	boolean	Indicates whether the SAP HANA instance is connected over Secure Sockets Layer (SSL). Valid values: true: The SAP HANA instance is connected over SSL. false: The SAP HANA instance is not connected over SSL.	true
HanaName	string	The name of the SAP HANA instance.	HANA-DEV
InstanceNumber	integer	The instance number of the SAP HANA system.	00
ValidateCertificate	boolean	Indicates whether the SSL certificate of the SAP HANA instance is verified.	false
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
UserName	string	The username of the SYSTEMDB database.	admin
StatusMessage	string	The status information.	INSTALL_CLIENT_FAILED
ClusterId	string	The ID of the SAP HANA instance.	cl-0004cf6g6******0yd7y
Tags	object
Tag	array<object>	The tags of the SAP HANA instance.
	object	The tags of SAP HANA instance.
Key	string	The tag key.	ace:rm:rgld
Value	string	The tag value.	rg-acfmwutpyat2kwy
ResourceGroupId	string	The resource group ID.	rg-acfmvnf22m7itha
CrossAccountType	string	Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	integer	The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	158975xxxxx4625
CrossAccountRoleName	string	The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	hbrcrossrole

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4003DD68-3C3C-5071-B4FC-631A6C1BAC1C",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 21,
  "Hanas": {
    "Hana": [
      {
        "Status": 0,
        "Host": "47.100.XX.XX",
        "VaultId": "v-0000s974******1hl",
        "UseSsl": true,
        "HanaName": "HANA-DEV",
        "InstanceNumber": 0,
        "ValidateCertificate": false,
        "AlertSetting": "INHERITED",
        "UserName": "admin",
        "StatusMessage": "INSTALL_CLIENT_FAILED",
        "ClusterId": "cl-0004cf6g6******0yd7y",
        "Tags": {
          "Tag": [
            {
              "Key": "ace:rm:rgld",
              "Value": "rg-acfmwutpyat2kwy"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmvnf22m7itha",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "hbrcrossrole"
      }
    ]
  }
}

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.