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

Obtém um ou mais planos 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:DescribeBackupPlans

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
SourceType	string	Não	O tipo da fonte de dados. Valores válidos:	ECS_FILE
Filters	array<object>	Não	Os filtros de consulta.
	object	Não
Key	string	Não	A chave do filtro de consulta. Valores válidos:	vaultId
Values	array	Não	Os valores a serem correspondidos no filtro de consulta.	["v-*********************"]
	string	Não	Os valores a serem correspondidos no filtro de consulta.	v-*********************
Edition	string	Não	O tipo de edição. Valores válidos: BASIC e STANDARD. Valor padrão: STANDARD.	STANDARD

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 retorno. Um valor 200 indica sucesso.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se a solicitação falhar, a mensagem de erro correspondente será retornada.	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 planos de backup que atendem às condições especificadas.	8
BackupPlans	object
BackupPlan	array<object>	A lista de planos de backup que atendem às condições especificadas.
	array<object>
VaultId	string	O ID do repositório de backup.	v-*********************
BackupType	string	O tipo de backup. O valor COMPLETE indica um backup completo.	COMPLETE
CreateTime	integer	A hora em que o sistema de arquivos foi criado. Este parâmetro é válido apenas se SourceType estiver definido como NAS. Este valor é um timestamp UNIX, em segundos.	1554347313
DataSourceId	string	O ID da fonte de dados.	ds-000ht6o9*****w61
SourceType	string	O tipo da fonte de dados. Valores válidos: ECS_FILE: Arquivos de uma instância ECS. OSS: Objetos no OSS. NAS: Sistemas de arquivos do NAS. OTS: Instâncias do Tablestore. UDM_ECS: Instâncias ECS inteiras. SYNC: Sincronização de dados.	ECS_FILE
Disabled	boolean	Especifica se o plano de backup está pausado. true: O plano de backup está pausado. false: O plano de backup não está pausado.	false
Prefix	string	O prefixo dos objetos a serem copiados. Este parâmetro é válido apenas se SourceType estiver definido como OSS.	oss-prefix
Options	string	Especifica se o Windows Volume Shadow Copy Service (VSS) deve ser usado para criar uma cópia de sombra. Este parâmetro é válido apenas se SourceType estiver definido como ECS_FILE.	{"UseVSS":false}
ClientId	string	O ID do cliente.	c-000ge4w*****1qb
Exclude	string	O caminho dos arquivos a serem excluídos do backup. Este parâmetro é válido apenas se SourceType estiver definido como ECS_FILE. Os arquivos no caminho especificado não são copiados.	["/var", "/proc"]
Retention	integer	O período de retenção dos dados de backup, em dias.	7
CreatedTime	integer	A hora em que o plano de backup foi criado. Este valor é um timestamp UNIX, em segundos.	1554347313
ClusterId	string	O ID do grupo de clientes.	cl-000ht6o9******h
Bucket	string	O nome do bucket OSS. Este parâmetro é válido apenas se SourceType estiver definido como OSS.	hbr-backup-oss
Detail	string	Os detalhes do backup da instância ECS.	{\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false}
Schedule	string	A política de backup, formatada como `I\|{startTime}\|{interval}`. Um job de backup é executado a cada `{interval}` a partir de `{startTime}`. Jobs atrasados são ignorados. Um novo job não é iniciado se o anterior ainda estiver em execução. Por exemplo, `I\|1631685600\|P1D` significa que um job de backup é executado diariamente a partir de 2021-09-15 14:00:00. startTime: A hora de início do backup. Este é um timestamp UNIX em segundos. interval: O intervalo de backup no formato ISO 8601. Por exemplo, PT1H significa uma hora e P1D significa um dia.	I\|1602673264\|P1D
SpeedLimit	string	A política de controle de tráfego para o backup. Este parâmetro é válido apenas se SourceType estiver definido como ECS_FILE. Formato: `{start}\|{end}\|{bandwidth}`. Separe múltiplas políticas com um caractere de pipe (`\|`). Os períodos de tempo das políticas não podem se sobrepor. start: A hora de início. end: A hora de término. bandwidth: O limite de largura de banda. Unidade: KB.	0:24:5120
InstanceId	string	O ID da instância ECS. Este parâmetro é válido apenas se SourceType estiver definido como ECS_FILE.	i-*********************
PlanId	string	O ID do plano de backup.	plan-*********************
BackupSourceGroupId	string	O ID do grupo de fontes de dados de backup.	System-Database
FileSystemId	string	O ID do sistema de arquivos. Este parâmetro é válido apenas se SourceType estiver definido como NAS.	00594
OtsDetail	object	Os detalhes da instância do Tablestore.
TableNames	object
TableName	array	As tabelas na instância do Tablestore.
	string	O nome da tabela de dados na instância do Tablestore.	test2_HBR_RESTORED
InstanceName	string	O nome da instância do Tablestore.	instancename
UpdatedTime	integer	A hora em que o plano de backup foi atualizado. Este valor é um timestamp UNIX, em segundos.	1554347313
PlanName	string	O nome do plano de backup.	planname
Include	string	O caminho dos arquivos a serem copiados. Este parâmetro é válido apenas se SourceType estiver definido como ECS_FILE. Todos os arquivos no caminho especificado são copiados.	["/home/alice/.pdf", "/home/bob/.txt"]
Rules	object
Rule	array<object>	As políticas de backup. Este parâmetro é válido apenas para backups de disco.
	object	A política de backup.
DestinationRetention	integer	O período de retenção do backup georredundante, em dias.	90
Schedule	string	A política de backup, formatada como `I\|{startTime}\|{interval}`. Um job de backup é executado a cada `{interval}` a partir de `{startTime}`. Jobs atrasados são ignorados. Um novo job não é iniciado se o anterior ainda estiver em execução. Por exemplo, `I\|1631685600\|P1D` significa que um job de backup é executado diariamente a partir de 2021-09-15 14:00:00. `startTime`: A hora de início do backup. Este é um timestamp UNIX em segundos. `interval`: O intervalo de backup no formato ISO 8601. Por exemplo, PT1H significa uma hora e P1D significa um dia.	I\|1631685600\|P1D
Retention	integer	O período de retenção dos dados de backup, em dias.	90
Disabled	boolean	Especifica se a política está desativada.	true
DoCopy	boolean	Especifica se o snapshot de backup deve ser copiado para o repositório de backup.	false
DestinationRegionId	string	O ID da região de destino para o backup georredundante.	cn-shanghai
RuleId	string	O ID da política.	rule-0008i52rf0ulpni6kn6m
RuleName	string	O nome da política.	Disk Golden Rule
BackupType	string	O tipo de backup. O valor COMPLETE indica um backup completo.	COMPLETE
Resources	object
Resource	array<object>	Os recursos de backup. Este parâmetro é válido apenas para backups de disco.
	object	O recurso de backup.
SourceType	string	O tipo da fonte de dados. Valor válido: UDM_DISK.	UDM_DISK
ResourceId	string	O ID da fonte de dados.	d-j6cgioir6m******lu4
Extra	string	As informações estendidas sobre a fonte de dados.	{\"doBackup\":false,\"diskName\":\"data_disk\",\"size\":100,\"type\":\"data\",\"category\":\"cloud_essd\",\"imageId\":\"\",\"device\":\"/dev/xvdb\",\"encrypted\":false}
Paths	object
Path	array	Os caminhos de backup. Este parâmetro é válido apenas se SourceType estiver definido como ECS_FILE.
	string	O caminho de backup.	["/home"]
TrialInfo	object	As informações do período de avaliação gratuita.
TrialStartTime	integer	A hora em que o período de avaliação gratuita começa.	1579413159
TrialVaultReleaseTime	integer	A hora em que o repositório do período de avaliação gratuita é liberado.	1594965600
TrialExpireTime	integer	A hora em que o período de avaliação gratuita expira.	1584597600
KeepAfterTrialExpiration	boolean	Especifica se o plano deve ser convertido para um plano pay-as-you-go após o término do período de avaliação gratuita.	true
InstanceGroupId	string	O ID do grupo de instâncias.	i-**
CrossAccountType	string	O tipo de backup entre contas. Valores válidos: SELF_ACCOUNT CROSS_ACCOUNT	CROSS_ACCOUNT
CrossAccountUserId	integer	O ID da conta de origem para o backup entre contas.	1841642xxxxx9795
CrossAccountRoleName	string	O nome da role RAM na conta de origem para o backup entre contas.	BackupRole
KeepLatestSnapshots	integer	Especifica se pelo menos uma versão de backup deve ser retida. 0: Não retém. 1: Retém.	0
DestSourceType	string	O tipo da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização de dados.	OSS
DestDataSourceId	string	O ID da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização de dados.	ds-*********************
DestDataSourceDetail	string	Os detalhes da fonte de dados de destino. Este parâmetro é necessário apenas para sincronização de dados.	{\"prefix\":\"/\"}
ChangeListPath	string	As configurações da sincronização incremental de arquivos. Este parâmetro é necessário apenas para sincronização de dados.	{"dataSourceId": "ds-123456789", "path": "/changelist"}
LatestExecuteJobId	string	O ID do último job de backup executado pelo plano.	job-12345678
LatestFinishJobId	string	O ID do último job de backup concluído.	job-00**************9khz
CreatedByTag	boolean	Especifica se o plano de backup foi criado automaticamente com base em tags.	false
HitTags	object
HitTag	array<object>	As regras de tag correspondentes.
	object	As regras de tag correspondentes.
Key	string	A chave da tag.	type
Value	string	O valor da tag.	0
Operator	string	A regra de correspondência de tag. Valores válidos: EQUAL: Corresponde à chave da tag e ao valor da tag. NOT: Corresponde à chave da tag, mas não ao valor da tag.	EQUAL
BusinessStatus	string	O status comercial.	ACTIVE

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupPlans": {
    "BackupPlan": [
      {
        "VaultId": "v-*********************",
        "BackupType": "COMPLETE",
        "CreateTime": 1554347313,
        "DataSourceId": "ds-000ht6o9*****w61",
        "SourceType": "ECS_FILE",
        "Disabled": false,
        "Prefix": "oss-prefix",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-000ge4w*****1qb",
        "Exclude": "[\"/var\", \"/proc\"]\t",
        "Retention": 7,
        "CreatedTime": 1554347313,
        "ClusterId": "cl-000ht6o9******h",
        "Bucket": "hbr-backup-oss",
        "Detail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
        "Schedule": "I|1602673264|P1D",
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-*********************",
        "BackupSourceGroupId": "System-Database",
        "FileSystemId": "00594",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "test2_HBR_RESTORED"
            ]
          }
        },
        "InstanceName": "instancename",
        "UpdatedTime": 1554347313,
        "PlanName": "planname",
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "Rules": {
          "Rule": [
            {
              "DestinationRetention": 90,
              "Schedule": "I|1631685600|P1D",
              "Retention": 90,
              "Disabled": true,
              "DoCopy": false,
              "DestinationRegionId": "cn-shanghai",
              "RuleId": "rule-0008i52rf0ulpni6kn6m",
              "RuleName": "Disk Golden Rule",
              "BackupType": "COMPLETE"
            }
          ]
        },
        "Resources": {
          "Resource": [
            {
              "SourceType": "UDM_DISK",
              "ResourceId": "d-j6cgioir6m******lu4",
              "Extra": "{\\\"doBackup\\\":false,\\\"diskName\\\":\\\"data_disk\\\",\\\"size\\\":100,\\\"type\\\":\\\"data\\\",\\\"category\\\":\\\"cloud_essd\\\",\\\"imageId\\\":\\\"\\\",\\\"device\\\":\\\"/dev/xvdb\\\",\\\"encrypted\\\":false}"
            }
          ]
        },
        "Paths": {
          "Path": [
            "[\"/home\"]"
          ]
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "InstanceGroupId": "i-**",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "KeepLatestSnapshots": 0,
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-*********************",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "LatestExecuteJobId": "job-12345678",
        "LatestFinishJobId": "job-00**************9khz",
        "CreatedByTag": false,
        "HitTags": {
          "HitTag": [
            {
              "Key": "type",
              "Value": "0",
              "Operator": "EQUAL"
            }
          ]
        },
        "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.