Todos os produtos
Search
Central de documentação

PolarDB:DescribeSharedBackups

Última atualização: Jun 28, 2026

Consulta conjuntos de backup compartilhados.

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

POST  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.

Nota

Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis.

cn-hangzhou

DBClusterId

string

Não

O ID do cluster.

pc-**************

BackupId

string

Não

O ID do conjunto de backup.

111111111

ShareType

string

Sim

O tipo de compartilhamento. Valores válidos:

  • ShareIncoming: backups compartilhados com você.

  • ShareOutgoing: backups que você compartilhou.

ShareIncoming

PageSize

integer

Não

O número de entradas por página. Valores válidos: 30 a 100. Valor padrão: 30.

30

PageNumber

integer

Não

O número da página. O valor deve ser um inteiro maior que 0. Valor padrão: 1.

1

DBType

string

Não

O tipo de banco de dados. Valores válidos:

  • MySQL

  • PostgreSQL

  • Oracle

Para especificar vários tipos, separe-os com uma vírgula.

MySQL,PostgreSQL,Oracle

DBVersion

string

Não

A versão do banco de dados.

8.0

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O objeto de resposta.

TotalRecordCount

string

A contagem total de registros.

16

PageRecordCount

string

O número de entradas na página atual.

1

RequestId

string

O ID da solicitação.

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

PageNumber

string

O número da página.

1

Items

array<object>

Uma lista de conjuntos de backup compartilhados.

object

Os detalhes de um conjunto de backup compartilhado.

BackupSetSize

string

O tamanho do conjunto de backup, em bytes.

4639948800

ConsistentTime

string

O timestamp UNIX do snapshot consistente, em segundos.

1589253947

BackupStatus

string

O status do backup. Valores válidos:

  • Success: O backup foi concluído.

  • Failed: O backup falhou.

Success

BackupType

string

O tipo de backup. Somente backups completos são suportados. O valor é fixo em FullBackup.

FullBackup

BackupStartTime

string

A hora de início do backup, em UTC.

2020-11-15T07:30:05Z

BackupEndTime

string

A hora de término do backup, em UTC.

2020-05-12T03:25:55Z

BackupId

string

O ID do conjunto de backup.

111111111

DBClusterId

string

O ID do cluster.

pc-****************

BackupsLevel

string

O nível do backup. Valores válidos:

  • Level-1: Backup de nível 1.

  • Level-2: Backup de nível 2.

Level-2

BackupMode

string

O modo de backup. Valores válidos:

  • Automated: backup automatizado

  • Manual: backup manual

Manual

BackupMethod

string

O método de backup. Somente backup por snapshot é suportado. O valor é fixo em Snapshot.

Snapshot

DBType

string

O tipo de mecanismo de banco de dados.

MySQL

DBVersion

string

A versão do mecanismo de banco de dados.

5.6

ShareType

string

O tipo de compartilhamento.

ShareIncoming

PayType

string

O método de faturamento. Valores válidos:

  • Postpaid: pós-pago (pay-as-you-go).

  • Prepaid: pré-pago (assinatura).

Postpaid

ServerlessType

string

O tipo Serverless. O valor AgileServerless indica um cluster Serverless, enquanto um valor vazio indica um cluster padrão.

AgileServerless

RegionId

string

O ID da região.

cn-hongzhou

SharerUID

string

O UID da conta que compartilhou o conjunto de backup.

170*************

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalRecordCount": "16",
  "PageRecordCount": "1",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "PageNumber": "1",
  "Items": [
    {
      "BackupSetSize": "4639948800",
      "ConsistentTime": "1589253947",
      "BackupStatus": "Success",
      "BackupType": "FullBackup",
      "BackupStartTime": "2020-11-15T07:30:05Z",
      "BackupEndTime": "2020-05-12T03:25:55Z",
      "BackupId": "111111111",
      "DBClusterId": "pc-****************",
      "BackupsLevel": "Level-2",
      "BackupMode": "Manual",
      "BackupMethod": "Snapshot",
      "DBType": "MySQL",
      "DBVersion": "5.6",
      "ShareType": "ShareIncoming",
      "PayType": "Postpaid",
      "ServerlessType": "AgileServerless",
      "RegionId": "cn-hongzhou",
      "SharerUID": "170*************"
    }
  ]
}

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.