Obtenção da lista de coleções de banco de dados que podem ser restauradas
Descrição
Esta API é usada para obter a lista de coleções de bancos de dados que podem ser restauradas.
Restrições
Essa API se aplica somente a conjuntos de réplicas.
Depuração
Você pode depurar essa API no API Explorer.
URI
- Formato de URI
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-collection?db_name={db_name}&restore_time={restore_time}&offset={offset}&limit={limit}
- Exemplo de URI
https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-collection?db_name=mydbx&restore_time=1607689584000&limit=10&offset=0
Nome |
Tipo |
Obrigatório |
Descrição |
---|---|---|---|
x-auth-token |
String |
Sim |
Token do usuário |
X-Language |
String |
Não |
Língua |
project_id |
String |
Sim |
Especifica a ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
instance_id |
String |
Sim |
ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma. |
db_name |
String |
Sim |
Especifica o nome do banco de dados. |
restore_time |
String |
Sim |
Especifica o ponto de tempo de restauração. O valor é um carimbo de data/hora UNIX, em milissegundos. O fuso horário é UTC. |
offset |
Integer |
Não |
Especifica a posição do índice.
|
limit |
Integer |
Não |
Especifica o limite superior do número de registros consultados.
|
Solicitações
Nenhuma
Respostas
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
collections
Array of objects
Sim
Indica a lista de coleções. Cada elemento na lista indica uma coleção.
total_count
Integer
Sim
Indica o número total de coleções.
Tabela 3 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
name
String
Sim
Indica o nome da coleção.
- Exemplo de resposta
{ "collections": [ "dds-test" ], "total_count": 1 }
SDK
Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.
Código de status
Para obter mais informações, consulte Código de status.
Código de erro
Para obter mais informações, consulte Código de erro.