更新时间:2025-11-14 GMT+08:00

查询实例配置参数

功能介绍

查询指定实例的配置参数信息。

URI

GET /v2/{project_id}/instances/{instance_id}/configs

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

config_time

String

参数解释

实例操作时间。格式为:2017-03-31T12:24:46.297Z

取值范围

不涉及。

instance_id

String

参数解释

实例ID。

取值范围

不涉及。

redis_config

Array of QueryRedisConfig objects

参数解释

实例配置项数组。

取值范围

不涉及。

config_status

String

参数解释

实例修改状态。

取值范围

  • UPDATING:更新中。

  • FAILURE:修改失败。

  • SUCCESS:修改成功。

status

String

参数解释

实例运行状态。

取值范围

  • PAYING:订单未支付或处理中。

  • CREATING:缓存实例开始创建。

  • RUNNING:缓存实例运行中。

  • CLOSING:缓存实例关闭中。

  • STARTING:缓存实例启动中。

  • RESTARTING:缓存实例重启中。

  • CLOSED:缓存实例已经关闭。

  • DELETING:缓存实例删除中。

  • DELETED:缓存实例已删除。

  • ERROR:缓存实例运行异常。

  • FAILURE:缓存实例配置失败。

  • SUCCESS:缓存实例配置成功。

  • CREATEFAILED:缓存实例创建异常。

  • DELETEFAILED:缓存实例删除异常。

  • FREEZING:实例冻结。

  • EXTENDING:缓存实例扩容中。

  • EXTENDEDFAILED:实例扩容失败。

  • MIGRATING:缓存实例迁移中。

  • OTHER:其他状态。

  • FLUSHING:实例清空数据中。

  • RESTORING:备份数据恢复中。

  • UPGRADING:实例软件升级中。

  • IPEXCHANGING:IP交换中。

  • IPROLLBACKING:IP回滚中。

  • MS_SWAPPING:主备切换中。

  • AZMigrating:AZ迁移中。

表3 QueryRedisConfig

参数

参数类型

描述

param_value

String

参数解释

配置参数值。

取值范围

不涉及。

value_type

String

参数解释

配置参数的值类型,例如:Integer,String。

取值范围

不涉及。

value_range

String

参数解释

配置参数的取值范围。

取值范围

不涉及。

description

String

参数解释

配置项的描述。

取值范围

不涉及。

default_value

String

参数解释

配置参数的默认值。

取值范围

不涉及。

param_name

String

参数解释

配置参数名称。

取值范围

不涉及。

param_id

String

参数解释

配置参数ID。

取值范围

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

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

内部服务错误。

错误码

请参见错误码