DescribeMetaList - PolarDB: Central de Documentação do Alibaba Cloud

Consulta bancos de dados e tabelas recuperáveis.

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

polardb:DescribeMetaList

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster. Nota Chame a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta.	pc-**************
BackupId	string	Não	O ID do conjunto de backup. Nota Você deve especificar o parâmetro `BackupId` ou `RestoreTime`. Chame a operação DescribeBackups para consultar o ID do conjunto de backup.	111111
RestoreTime	string	Não	O ponto no tempo para o qual você deseja restaurar os dados. Especifique o horário no formato YYYY-MM-DDThh:mmZ. O horário deve estar em UTC. Nota Você deve especificar o parâmetro `BackupId` ou `RestoreTime`. Chame a operação DescribeBackups para consultar o ponto no tempo para restauração.	2020-10-04T01:40:00Z
GetDbName	string	Não	O nome do banco de dados, como `test_db`. Se você especificar este parâmetro, os nomes de todas as tabelas que podem ser recuperadas do banco de dados especificado serão retornados. Nota Você pode especificar apenas um nome de banco de dados por vez. Se você não especificar este parâmetro, os nomes de todos os bancos de dados que podem ser recuperados do conjunto de backup atual serão retornados. Os nomes das tabelas em cada banco de dados não serão retornados.	test_db
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 50 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 e não deve exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
RegionCode	string	Não	O ID da região da instância. Você pode chamar DescribeDBClusterAttribute para consultar o ID da região.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalPageCount	string	O número total de páginas.	1
TotalRecordCount	string	O número total de registros.	2
PageSize	string	O número de registros na página atual.	30
RequestId	string	O ID da solicitação.	AA815DE7-B576-4B22-B33C-3FB31A******
PageNumber	string	O número da página.	1
Items	array<object>	Os detalhes dos bancos de dados e tabelas recuperáveis.
	object
Database	string	O nome do banco de dados que pode ser recuperado.	test_db
Tables	array	Os nomes das tabelas que podem ser recuperadas.
	string	O nome da tabela recuperável.	test_tb1
Size	array	O tamanho do banco de dados ou da tabela, em bytes.
	integer	O tamanho do banco de dados ou da tabela em bytes.	16384
DBClusterId	string	O ID do cluster.	pc-bp1s826a1up******

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalPageCount": "1",
  "TotalRecordCount": "2",
  "PageSize": "30",
  "RequestId": "AA815DE7-B576-4B22-B33C-3FB31A******",
  "PageNumber": "1",
  "Items": [
    {
      "Database": "test_db",
      "Tables": [
        "test_tb1"
      ],
      "Size": [
        16384
      ]
    }
  ],
  "DBClusterId": "pc-bp1s826a1up******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidRestoreType.Format	Specified restore type is not valid.	The specified restore type is invalid.
400	InvalidRestoreTime.Format	Specified restore time is not valid.	The specified restoration time is invalid.
400	InvalidBackupSetID.NotFound	Specified backup set ID does not exist.
400	IncorrectBackupSetState	Current backup set state does not support operations.
400	InvalidDBName.Duplicate	Specified DB name already exists in the This instance.	The specified DBName parameter already exists in the cluster.
400	InvalidParameters.Format	Specified parameters is not valid.	The specified parameters are invalid.
400	InsufficientResourceCapacity	There is insufficient capacity available for the requested instance.	Insufficient storage capacity for the specified cluster.
400	InvalidRestoreType.NotFound	At least one of BackupId and RestoreTime is malformed.	The format of the specified BackupId or RestoreTime parameter is invalid.
400	MissingUserID	The request is missing a user_id parameter.	You must specify the UserID parameter in the request.
400	MissingUID	The request is missing a uid parameter.	You must specify the UID parameter in the request.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidBackup.NotFound	The available backup does not exist in recovery time.	The specified backup does not exist within the time range for restoration.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.