修改实例指定参数的值

功能介绍

修改实例指定参数的值。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

接口约束

• 实例在异常或冻结状态下不能执行该操作。
• 不支持修改只读实例参数。
• 当前只支持修改shared_preload_libraries。

URI

• URI格式

  PUT /v3/{project_id}/instances/{instance_id}/parameter/{name}

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。
  name	是	参数名称。当前只支持修改shared_preload_libraries。

请求消息

请求示例

修改实例shared_preload_libraries参数的值。

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries
{
  "value" : "passwordcheck.so,pg_stat_statements,pg_sql_history"
}

响应消息

• 正常响应要素说明

  表3 要素说明

  名称	参数类型	说明
  job_id	String	任务ID。
  restart_required	Boolean	实例是否需要重启。 true，需要重启。 false，不需要重启。

• 正常响应样例

  {
    "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",  
    "restart_required" : true  
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。