Consulta de parâmetros de configuração da instância DCS
Função
Essa API é usada para consultar os parâmetros de configuração de uma instância de DCS.
URI
GET /v2/{project_id}/instances/{instance_id}/configs
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
instance_id |
Sim |
String |
ID da instância. |
|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
config_time |
String |
Hora em que a instância foi operada. Por exemplo, 2017-03-31T12:24:46.297Z. |
|
instance_id |
String |
ID da instância. |
|
redis_config |
Array of QueryRedisConfig objects |
Matriz de itens de configuração da instância do DCS. |
|
config_status |
String |
Status de modificação da instância.
Valores de enumeração:
|
|
status |
String |
Status da instância. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
param_value |
String |
Valor do parâmetro de configuração. |
|
value_type |
String |
Tipo do valor do parâmetro de configuração. |
|
value_range |
String |
Intervalo do valor do parâmetro de configuração. |
|
description |
String |
Descrição do item de configuração. |
|
default_value |
String |
Valor padrão do parâmetro de configuração. |
|
param_name |
String |
Nome do parâmetro de configuração. |
|
param_id |
String |
ID do parâmetro de configuração. |
Código de estado: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
|
error_code |
String |
Código de erro. Máximo: 9 |
|
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_msg |
String |
Mensagem de erro. Máximo: 1024 |
|
error_code |
String |
Código de erro. Máximo: 9 |
|
error_ext_msg |
String |
Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs
Exemplo de respostas
Código de estado: 200
Parâmetros de configuração da instância consultados com êxito.
{
"instance_id" : "50829e5a-a4fc-4c01-8651-80be8a491602",
"config_status" : "SUCCESS",
"config_time" : "2020-07-06T07:04:31.464Z",
"redis_config" : {
"param_id" : "1",
"param_name" : "timeout",
"description" : "Close the connection after a client is idle for N seconds (0 to disable)",
"param_value" : "101",
"value_range" : "0-7200",
"value_type" : "Interger",
"default_value" : "0"
},
"status" : "RUNNING"
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
Parâmetros de configuração da instância consultados com êxito. |
|
400 |
Pedido inválido. |
|
500 |
Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.