查询实例配置参数
功能介绍
查询指定实例的配置参数信息。
URI
GET /v2/{project_id}/instances/{instance_id}/configs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
实例ID。 |
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
config_time |
String |
实例操作时间。格式为：2017-03-31T12:24:46.297Z |
|
instance_id |
String |
实例ID。 |
|
redis_config |
Array of QueryRedisConfig objects |
实例配置项数组。 |
|
config_status |
String |
实例修改状态。
枚举值：
|
|
status |
String |
实例运行状态。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
param_value |
String |
配置参数值。 |
|
value_type |
String |
配置参数的值类型。 |
|
value_range |
String |
配置参数的取值范围。 |
|
description |
String |
配置项的描述。 |
|
default_value |
String |
配置参数的默认值。 |
|
param_name |
String |
配置参数名称。 |
|
param_id |
String |
配置参数ID。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误信息。 最大长度：1024 |
|
error_code |
String |
错误码。 最大长度：9 |
|
error_ext_msg |
String |
扩展错误信息（暂未使用，赋值为null）。 最大长度：1024 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs
响应示例
状态码： 200
查询实例配置参数成功。
{
"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"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询实例配置参数成功。 |
|
400 |
非法请求。 |
|
500 |
内部服务错误。 |
错误码
请参见错误码。
