Todos os produtos
Search
Central de documentação

Hologres:GetScheduledBackupConfig

Última atualização: Jun 28, 2026

Obtém a configuração de backup.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

GET /api/v1/backups/scheduledConfig HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

RegionId

string

Não

O ID da região.

cn-shenzhen

instanceId

string

Não

O ID da instância.

hgprecn-cn-9lb3bjg1n003

scheduleType

string

Não

O tipo de backup. Por padrão, a operação retorna as configurações de backup periódico e manual. Para obter a configuração de backup remoto, defina este parâmetro como remote.

Valores válidos:

  • periodical :

    Backup periódico.

  • remote :

    Backup remoto.

remote

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

RequestId

string

O ID da solicitação.

623EF0B6-A6C1-5764-82CC-0BC176654CB9

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

ErrorCode

string

O código de erro.

null

ErrorMessage

string

A mensagem de erro.

null

HttpStatusCode

string

O código de status HTTP.

200

Data

object

Os dados retornados.

Enabled

integer

Indica se a configuração de backup está ativada. Valores válidos: 1 (ativado) e 0 (desativado).

true

TaskParameter

string

O parâmetro da tarefa.

{"schedule":"0 10 * * 1,2","instance_id":"hgprecn-cn-lbj3dfgog004","week":"1,2","hour":10,"data_keep_quantity":3,"type":"periodical","enabled":true}

TaskType

string

O tipo de tarefa.

backup

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "623EF0B6-A6C1-5764-82CC-0BC176654CB9",
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200",
  "Data": {
    "Enabled": 0,
    "TaskParameter": "{\"schedule\":\"0 10 * * 1,2\",\"instance_id\":\"hgprecn-cn-lbj3dfgog004\",\"week\":\"1,2\",\"hour\":10,\"data_keep_quantity\":3,\"type\":\"periodical\",\"enabled\":true}",
    "TaskType": "backup\n"
  }
}

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.