Consulta de parámetros de configuración de instancia de DCS
Función
Esta API se utiliza para consultar los parámetros de configuración de una instancia de DCS.
URI
GET /v2/{project_id}/instances/{instance_id}/configs
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
instance_id |
Sí |
String |
ID de instancia. |
|
project_id |
Sí |
String |
ID del proyecto. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
config_time |
String |
Hora en la que se operó la instancia. Por ejemplo, 2017-03-31T12:24:46.297Z. |
|
instance_id |
String |
ID de instancia. |
|
redis_config |
Array of QueryRedisConfig objects |
Matriz de elementos de configuración de la instancia DCS. |
|
config_status |
String |
Estado de modificación de instancia.
Valores de enumeración:
|
|
status |
String |
Estado de la instancia. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
param_value |
String |
Valor del parámetro de configuración. |
|
value_type |
String |
Tipo del valor del parámetro de configuración. |
|
value_range |
String |
Rango del valor del parámetro de configuración. |
|
description |
String |
Descripción del elemento de configuración. |
|
default_value |
String |
Valor predeterminado del parámetro de configuración. |
|
param_name |
String |
Nombre del parámetro de configuración. |
|
param_id |
String |
ID del parámetro de configuración. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
|
error_code |
String |
Código de error. Máximo: 9 |
|
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
|
error_code |
String |
Código de error. Máximo: 9 |
|
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Solicitudes de ejemplo
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs
Ejemplo de respuestas
Código de estado: 200
Parámetros de configuración de instancia consultados correctamente.
{
"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 estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Parámetros de configuración de instancia consultados correctamente. |
|
400 |
Solicitud no válida. |
|
500 |
Error interno del servicio. |
Códigos de error
Consulte Códigos de error.