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

Consulta um ou mais planos de backup do SAP HANA que correspondem aos critérios especificados.

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

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-000i4lg4kz******ahl
ClusterId	string	Sim	O ID da instância do SAP HANA.	cl-000chxz******lz7bk
PageNumber	integer	Não	O número da página. O valor deve ser um número que começa em 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
DatabaseName	string	Não	O nome do banco de dados.	SYSTEMDB
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmvywqfey5njq

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Code	string	O código de retorno. Um valor 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. O valor deve ser um número que começa em 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 registros.	6
HanaBackupPlans	object
HanaBackupPlan	array<object>	Os detalhes do plano de backup.
	object	Os detalhes do plano de backup.
VaultId	string	The ID of the backup vault.	v-000csihw82pqkd7hcjws
BackupPrefix	string	The backup prefix.	COMPLETE_DATA_BACKUP
Schedule	string	The backup policy. Format: `I\|{startTime}\|{interval}`. The system runs the first backup job at a point in time that is specified by `{startTime}` and repeats the backup job at an interval that is specified by `{interval}`. The system does not run a backup job to compensate for a missed backup job. If a backup job is not complete, the next backup job is not triggered. For example, `I\|1631685600\|P1D` indicates that the system runs a backup job every day, starting from 2021-09-15 14:00:00. startTime: The start time of the backup job. This value is a UNIX timestamp. Unit: seconds. interval: The interval of the backup job. This value follows the ISO 8601 standard. For example, PT1H indicates that the backup job is run every hour. P1D indicates that the backup job is run every day.	I\|1602673264\|P1D
DatabaseName	string	The name of the database.	SYSTEMDB
BackupType	string	The backup type. COMPLETE: full backup. INCREMENTAL: incremental backup. DIFFERENTIAL: differential backup.	COMPLETE
Disabled	boolean	Indicates whether the backup plan is paused. true: The backup plan is paused. false: The backup plan is not paused.	false
PlanId	string	The ID of the backup plan.	pl-0000tnyndg3ne5m4ubeu
ClusterId	string	The ID of the SAP HANA instance.	cl-0002scknka*****
PlanName	string	The name of the backup plan.	plan-20220118-141153
BusinessStatus	string	The business status.	ACTIVE

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "HanaBackupPlans": {
    "HanaBackupPlan": [
      {
        "VaultId": "v-000csihw82pqkd7hcjws",
        "BackupPrefix": "COMPLETE_DATA_BACKUP",
        "Schedule": "I|1602673264|P1D",
        "DatabaseName": "SYSTEMDB",
        "BackupType": "COMPLETE",
        "Disabled": false,
        "PlanId": "pl-0000tnyndg3ne5m4ubeu",
        "ClusterId": "cl-0002scknka*****",
        "PlanName": "plan-20220118-141153",
        "BusinessStatus": "ACTIVE"
      }
    ]
  }
}

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.