Obtenção de parâmetros de uma instância de banco de dados especificada
Descrição
Essa API é usada para obter informações sobre parâmetros de uma instância de banco de dados especificada.
Restrições
Esta API aplica-se apenas ao DDS Community Edition.
URI
Solicitações
Descrição do parâmetro
Nome |
Tipo |
IN |
Obrigatório |
Descrição |
|---|---|---|---|---|
x-auth-token |
string |
header |
Sim |
Token do usuário. |
Content-Type |
string |
header |
Sim |
Tipo do corpo da solicitação MIME. É aconselhável usar o valor padrão application/json. Para as API usadas para carregar objetos ou imagens, o valor pode variar dependendo do tipo de fluxo. |
project_id |
string |
path |
Sim |
O 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 |
path |
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. |
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|---|---|---|---|
entity_id |
String |
Sim |
|
Respostas
- Descrição do parâmetro
Tabela 3 Parâmetros de corpo da resposta Nome
Tipo
Descrição
datastore_version
String
Versão do banco de dados.
datastore_name
String
Tipo de banco de dados.
created
String
Tempo de criação no formato "aaaa-MM-ddTHH:mm:ssZ".
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário.
updated
String
Hora de atualização no formato "aaaa-MM-ddTHH:mm:ssZ".
T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário.
parameters
Array of objects
Indica os parâmetros definidos pelos usuários com base nos modelos de parâmetros padrão.
Para mais detalhes, consulte Tabela 4.
Tabela 4 Descrição da estrutura de dados do campo parameters Nome
Tipo
Descrição
name
String
O nome do parâmetro.
value
String
Valor do parâmetro.
value_range
String
O intervalo de valores.
Por exemplo, o valor do tipo Integer varia de 0 a 1, e o valor do tipo Boolean é true ou false.
restart_required
Boolean
Se a instância precisa ser reiniciada.
- Se o valor for true, será necessário reiniciar.
- Se o valor for false, a reinicialização não é necessária.
readonly
Boolean
Se o grupo de parâmetros é somente leitura.
- Se o valor false, o parâmetro não é somente leitura.
- Se o valor for true, o parâmetro é somente leitura.
type
String
O tipo de parâmetro. O valor pode ser integer, string, boolean, float ou list.
description
String
A descrição do parâmetro.
- Exemplo de resposta
{ "datastore_version" : "4.0", "datastore_name" : "mongos", "created" : "2017-01-01T10:00:00", "updated" : "2017-01-01T10:00:00", "parameters" : [ { "name" : "cursorTimeoutMillis", "value" : 600000, "restart_required" : false, "readonly" : false, "description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.", "value_range" : "600000-1000000" } ] }
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.
