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

Consulta os snapshots de backups completos.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SourceType	string	Sim	O tipo da fonte de dados. Valores válidos: UDM_ECS: backup de instância ECS UDM_ECS_DISK: uma subtarefa de backup de disco de um backup de instância ECS UDM_DISK: backup de disco	UDM_ECS
StartTime	integer	Sim	O início do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX em segundos.	1642057551
EndTime	integer	Sim	O fim do intervalo de tempo a ser consultado. Este valor é um timestamp UNIX em segundos.	1643092168
UdmRegionId	string	Sim	O ID da região da instância ECS.	cn-hangzhou
InstanceId	string	Não	O ID da instância ECS.	i-bp18x2k7sw925ir7ofh8
DiskId	string	Não	O ID do disco.	d-bp1560750pclffpzxy70
JobId	string	Não	O ID do job de backup.	job-*********************
SnapshotIds	object	Não	A lista de IDs de snapshot.	[\"s-000e3vhhu62xsm6v92r0\"]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status HTTP. Um valor 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem que é retornada. Se a solicitação foi bem-sucedida, successful é retornado. Se a solicitação falhou, uma mensagem de erro é retornada.	successful
RequestId	string	O ID da solicitação.	51CDEECB-7001-51CC-94AC-2A0F2A4B71D2
TotalCount	integer	O número total de snapshots.	3
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Snapshots	array<object>	Os detalhes dos snapshots.
	array<object>	Os detalhes dos snapshots.
Status	string	O status do snapshot de backup. Valores válidos: COMPLETE: O backup foi bem-sucedido. PARTIAL_COMPLETE: O backup foi parcialmente bem-sucedido. FAILED: O backup falhou.	COMPLETE
SnapshotHash	string	O valor de hash do snapshot.	f2fe...
BackupType	string	O tipo de backup. O valor COMPLETE indica um backup completo.	COMPLETE
CreateTime	integer	A hora em que o snapshot de backup foi criado.	1607436917
ActualBytes	string	O tamanho real do snapshot. Unidade: bytes.	600
SourceType	string	O tipo da fonte de dados. Valores válidos: UDM_ECS: backup de instância ECS UDM_ECS_DISK: uma subtarefa de backup de disco de um backup de instância ECS UDM_DISK: backup de disco	UDM_ECS
Prefix	string	O prefixo do snapshot.	example/
DiskId	string	O ID do disco. O disco pode ser um disco em nuvem ou um disco local.	d-2ze86h5fga5rfwxxa8ef
BytesTotal	integer	O tamanho total da fonte de dados. Unidade: bytes.	1000
NativeSnapshotInfo	string	As informações sobre o snapshot nativo.	{ "sourceDiskId":"d-bp17misjuy636t82v7b0", "lastModifiedTime":"2022-03-09T11:35:12Z", "snapshotSN":"64588-429372675-857161235", "snapshotId":"s-bp1fbtwv3e6xr6wpe9e0", "creationTime":"2022-03-09T11:31:12Z", "snapshotType":"user", "usage":"none", "description":"", "sourceStorageType":"disk", "tags":[ { "tagValue":"job-0007e0wqjl0imbrtkmnm", "tagKey":"HBR JobId" } ], "productCode":"", "encrypted":false, "sourceDiskType":"system", "retentionDays":30, "snapshotName":"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm", "kMSKeyId":"", "progress":"100%", "category":"standard", "sourceDiskSize":"20", "status":"accomplished" }
CompleteTime	integer	A hora em que o snapshot de backup foi concluído. Este valor é um timestamp UNIX em segundos.	1646895666
Retention	integer	O período de retenção do snapshot em dias.	7
CreatedTime	integer	A hora em que o snapshot de backup foi criado. Este valor é um timestamp UNIX em segundos.	1642496679
RealSnapshotTime	integer	O timestamp do snapshot. Este valor é um timestamp UNIX em segundos.	1642496679
ParentSnapshotHash	string	O valor de hash do snapshot pai.	f2fe..
InstanceId	string	O ID da instância ECS.	i-bp1f0pe78dxizrsdcgxd
StartTime	integer	A hora em que o snapshot foi iniciado. Este valor é um timestamp UNIX em segundos.	1554347313
UpdatedTime	integer	A hora em que o snapshot de backup foi atualizado. Este valor é um timestamp UNIX em segundos.	1642496679
SnapshotId	string	O ID do snapshot de backup.	s-00047mxg17p26*****b
JobId	string	O ID do job de backup.	job-00030j3chkt******2
NativeSnapshotId	string	O ID do snapshot nativo.	s-00047mg17p26x*****b
Detail	object	Os detalhes do snapshot.
DiskDevName	string	The name of the disk device.	/dev/xvdb
DowngradeReason	string	The reason for the downgrade.	HBR.NoRamRoleBound
OsDiskId	string	The ID of the system disk.	d-bp1e6427vhd320hifvc
OsName	string	The name of the operating system.	Debian 10.10 64-bit (UEFI)
ContainOsDisk	boolean	Indicates whether the system disk is included.	true
ConsistentLevel	string	The consistency level.	CRASH
VmName	string	The name of the instance.	BNSHSVR42 IPGUARD
DiskHbrSnapshotIdWithDeviceMap	object	The mapping between devices and backup point IDs.	{ "/dev/xvdb":"s-0000u7y6wm3v1e7hxh5a", "/dev/xvda":"s-0004bl6yr5pt89jjsv5a" }
InstanceIdWithDiskIdListMap	object	The mapping between instance IDs and disk IDs.	{ "i-bp1dlp0keohh7ids4uo6":"d-bp1e6427vhd320hifvs", "i-bp1dlp0keohh7ids4uo6":"d-bp1e6427vhd320hifvd" }
InstanceName	string	The name of the instance.	swh-hbr
OsType	string	The type of the operating system. Valid values: linux, windows.	windows
Platform	string	The operating system.	CentOS
OsNameEn	string	The English name of the operating system.	Debian 11.1 64 bit
HostName	string	The hostname.	iZbpxxxxxxxxxxxxxxxxe2Z
SystemDisk	boolean	Indicates whether the disk is a system disk.	true
DiskIdList	array	The list of disk IDs that are included in the backup point.
	string	The ID of a disk that is included in the backup point.	d-bp1e6427vhd320hifvs
NativeSnapshotIdList	array	The list of native snapshot IDs. The native snapshot IDs in this list have a one-to-one correspondence with the disk IDs in the DiskIdList.
	string	The ID of the native snapshot.	s-0004bl6yr5pt89jjsv5a
SnapshotGroupId	string	The ID of the snapshot group.	ssg-uf6856txcaq31uj***
InstanceType	string	The instance type of the source instance.	ecs.c6.xlarge
DiskCategory	string	The type of the source disk.	cloud_essd
PerformanceLevel	string	The performance level of the source disk.	PL0
InstantAccess	boolean	Indicates whether the backup is created for the instant clone feature.	false
AdvancedRetentionType	string	O tipo de retenção especial. Este parâmetro é válido apenas para backups de retenção especial. Valores válidos: WEEKLY: backup de retenção especial semanal MONTHLY: backup de retenção especial mensal YEARLY: backup de retenção especial anual	WEEKLY
ExpireTime	integer	A hora em que o backup expira.	1640334062
CanBeDeleted	boolean	Indica se o ponto de backup do disco pode ser excluído. Este parâmetro é válido apenas se SourceType estiver definido como UDM_ECS_DISK.	false
ArchiveStatus	string	O status de arquivamento.	ARCHIVED
ArchiveErrorMessage	string	A mensagem de erro que é retornada se o arquivamento falhar.	InternalError
ArchiveTriggerTime	integer	A hora em que o arquivamento foi acionado.	1763373304

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "51CDEECB-7001-51CC-94AC-2A0F2A4B71D2",
  "TotalCount": 3,
  "Success": true,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2fe...",
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": "600",
      "SourceType": "UDM_ECS",
      "Prefix": "example/",
      "DiskId": "d-2ze86h5fga5rfwxxa8ef",
      "BytesTotal": 1000,
      "NativeSnapshotInfo": "{\n\t\t\t\t\t\"sourceDiskId\":\"d-bp17misjuy636t82v7b0\",\n\t\t\t\t\t\"lastModifiedTime\":\"2022-03-09T11:35:12Z\",\n\t\t\t\t\t\"snapshotSN\":\"64588-429372675-857161235\",\n\t\t\t\t\t\"snapshotId\":\"s-bp1fbtwv3e6xr6wpe9e0\",\n\t\t\t\t\t\"creationTime\":\"2022-03-09T11:31:12Z\",\n\t\t\t\t\t\"snapshotType\":\"user\",\n\t\t\t\t\t\"usage\":\"none\",\n\t\t\t\t\t\"description\":\"\",\n\t\t\t\t\t\"sourceStorageType\":\"disk\",\n\t\t\t\t\t\"tags\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"tagValue\":\"job-0007e0wqjl0imbrtkmnm\",\n\t\t\t\t\t\t\t\"tagKey\":\"HBR JobId\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"productCode\":\"\",\n\t\t\t\t\t\"encrypted\":false,\n\t\t\t\t\t\"sourceDiskType\":\"system\",\n\t\t\t\t\t\"retentionDays\":30,\n\t\t\t\t\t\"snapshotName\":\"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm\",\n\t\t\t\t\t\"kMSKeyId\":\"\",\n\t\t\t\t\t\"progress\":\"100%\",\n\t\t\t\t\t\"category\":\"standard\",\n\t\t\t\t\t\"sourceDiskSize\":\"20\",\n\t\t\t\t\t\"status\":\"accomplished\"\n\t\t\t\t}",
      "CompleteTime": 1646895666,
      "Retention": 7,
      "CreatedTime": 1642496679,
      "RealSnapshotTime": 1642496679,
      "ParentSnapshotHash": "f2fe..",
      "InstanceId": "i-bp1f0pe78dxizrsdcgxd",
      "StartTime": 1554347313,
      "UpdatedTime": 1642496679,
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "NativeSnapshotId": "s-00047mg17p26x*****b",
      "Detail": {
        "DiskDevName": "/dev/xvdb",
        "DowngradeReason": "HBR.NoRamRoleBound",
        "OsDiskId": "d-bp1e6427vhd320hifvc",
        "OsName": "Debian 10.10 64-bit (UEFI)",
        "ContainOsDisk": true,
        "ConsistentLevel": "CRASH",
        "VmName": "BNSHSVR42 IPGUARD",
        "DiskHbrSnapshotIdWithDeviceMap": {
          "/dev/xvdb": "s-0000u7y6wm3v1e7hxh5a",
          "/dev/xvda": "s-0004bl6yr5pt89jjsv5a"
        },
        "InstanceIdWithDiskIdListMap": {
          "i-bp1dlp0keohh7ids4uo6": "d-bp1e6427vhd320hifvd"
        },
        "InstanceName": "swh-hbr",
        "OsType": "windows",
        "Platform": "CentOS",
        "OsNameEn": "Debian  11.1 64 bit",
        "HostName": "iZbpxxxxxxxxxxxxxxxxe2Z",
        "SystemDisk": true,
        "DiskIdList": [
          "d-bp1e6427vhd320hifvs"
        ],
        "NativeSnapshotIdList": [
          "s-0004bl6yr5pt89jjsv5a"
        ],
        "SnapshotGroupId": "ssg-uf6856txcaq31uj***",
        "InstanceType": "ecs.c6.xlarge",
        "DiskCategory": "cloud_essd",
        "PerformanceLevel": "PL0",
        "InstantAccess": false
      },
      "AdvancedRetentionType": "WEEKLY",
      "ExpireTime": 1640334062,
      "CanBeDeleted": false,
      "ArchiveStatus": "ARCHIVED",
      "ArchiveErrorMessage": "InternalError",
      "ArchiveTriggerTime": 1763373304
    }
  ]
}

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.