DescribeBackups - : Central de Documentação do Alibaba Cloud

Nota

Esta operação está disponível apenas para clusters do ApsaraDB for ClickHouse na versão 21.8 ou posterior.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeBackups	A operação a ser executada. Defina o valor como DescribeBackups.
DBClusterId	String	Sim	cc-bp1qx68m06981****	O ID do cluster.
BackupId	String	Não	117403****	O ID da tarefa de backup.
StartTime	String	Sim	2021-11-21T16:00Z	Início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601, no formato yyyy-MM-ddTHH:mmZ. A hora deve estar no Horário Universal Coordenado (UTC).
EndTime	String	Sim	2021-11-25T16:00Z	Fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601, no formato yyyy-MM-ddTHH:mmZ. A hora deve estar em UTC.
PageSize	Integer	Não	30	Número de entradas a serem retornadas em cada página. Valores válidos: 30 (padrão) 50 100
PageNumber	Integer	Não	1	Número da página a ser retornada.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	String	1	Número total de entradas retornadas.
PageSize	String	30	Número de entradas retornadas por página. Valores válidos: 30 (padrão) 50 100
RequestId	String	F5178C10-1407-4987-9133-DE4DC9119F75	ID da solicitação.
PageNumber	String	1	Número da página retornada.
Items	Array of Backup		Conjuntos de backup retornados.
DBClusterId	String	cc-bp1qx68m06981****	ID do cluster.
BackupStatus	String	Success	Status da tarefa de backup. Valores válidos: Success: a tarefa de backup foi concluída com êxito. Failure: a tarefa de backup falhou.
BackupType	String	IncrementalBackup	Tipo de backup. Valores válidos: FullBackup IncrementalBackup
BackupStartTime	String	2021-11-22T18:28:22Z	Hora de início da tarefa de backup. Segue o padrão ISO 8601, no formato yyyy-MM-ddTHH:mmZ. Exibida em UTC.
BackupSize	Long	131072	Tamanho do conjunto de backup. Unidade: MB.
BackupEndTime	String	2021-11-22T18:28:41Z	Hora de término da tarefa de backup. Segue o padrão ISO 8601, no formato yyyy-MM-ddTHH:mmZ. Exibida em UTC.
BackupSetInfo	String	{"shard_count": 4}	Número de nós no cluster. Para clusters da Edição de Réplica Única, o valor varia de 1 a 48. Para clusters da Edição de Réplica Dupla, o valor varia de 1 a 24.
BackupId	String	117403****	ID da tarefa de backup.
BackupMethod	String	Physical	Método de backup. Apenas Physical é retornado. Este valor indica que um backup físico foi executado.
ExpireDate	String	2022-07-22T18:28:41Z	Data de expiração do conjunto de backup. Segue o padrão ISO 8601, no formato yyyy-MM-ddTHH:mmZ. Exibida em UTC.

Exemplos

Solicitações de exemplo

http(s)://clickhouse.aliyuncs.com/?Action=DescribeBackups
&DBClusterId=cc-bp1qx68m06981****
&StartTime=2021-11-21T16:00Z
&EndTime=2021-11-22T16:00Z
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <DBClusterId>cc-bp1qx68m06981****</DBClusterId>
        <BackupStatus>Success</BackupStatus>
        <BackupType>IncrementalBackup</BackupType>
        <BackupStartTime>2021-11-22T18:28:22Z</BackupStartTime>
        <BackupSize>131072</BackupSize>
        <BackupEndTime>2021-11-22T18:28:41Z</BackupEndTime>
        <BackupSetInfo>{"shard_count": 4}</BackupSetInfo>
        <BackupId>117403****</BackupId>
        <BackupMethod>Physical</BackupMethod>
        <ExpireDate>2022-07-22T18:28:41Z</ExpireDate>
    </Items>
</DescribeBackupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : "1",
  "PageSize" : "30",
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber" : "1",
  "Items" : [ {
    "DBClusterId" : "cc-bp1qx68m06981****",
    "BackupStatus" : "Success",
    "BackupType" : "IncrementalBackup",
    "BackupStartTime" : "2021-11-22T18:28:22Z",
    "BackupSize" : 131072,
    "BackupEndTime" : "2021-11-22T18:28:41Z",
    "BackupSetInfo" : "{\"shard_count\": 4}",
    "BackupId" : "117403****",
    "BackupMethod" : "Physical",
    "ExpireDate" : "2022-07-22T18:28:41Z"
  } ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	O ID do cluster não existe. Verifique se o valor especificado para o parâmetro DBClusterId é válido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.