获取实例指定参数的值 - ShowPostgresqlParamValue

功能介绍

获取实例指定参数的值。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要了解请求Header参数说明。

调试

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

授权信息

接口约束

• 实例在异常或冻结状态下不能执行该操作。
• 当前只支持查询shared_preload_libraries。

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	参数解释： 租户在某一region下的project ID。 约束限制： 非空。 取值范围： 获取方法请参见获取项目ID。 默认取值： 不涉及。
  instance_id	是	参数解释： 实例ID。 约束限制： 非空。 取值范围： 该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。 默认取值： 不涉及。
  name	是	参数解释： 参数名称。 约束限制： 不涉及。 取值范围： 当前只支持修改shared_preload_libraries。 默认取值： shared_preload_libraries

请求消息

• 请求参数

  无。

• URI样例

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  name	String	参数解释： 参数名称。 取值范围： shared_preload_libraries
  value	String	参数解释： 参数值。 取值范围： 不涉及。
  restart_required	Boolean	参数解释： 实例是否需要重启。 取值范围： true，需要重启。 false，不需要重启。
  value_range	String	参数解释： 参数值范围。 取值范围： 如Integer取值0~1、Boolean取值true或false等。
  type	String	参数解释： 参数类型。 取值范围： 取值为“string”、“integer”、“boolean”、“list”或“float”之一。
  description	String	参数解释： 参数描述。 取值范围： 不涉及。

• 正常响应样例

  {
   "name": "shared_preload_libraries",
   "value": "passwordcheck.so,pg_stat_statements,pg_sql_history,pgaudit,auth_delay,rds_pg_sql_ccl,rds_performance_statements",
   "type": "list",
   "description": "Lists shared libraries to preload into server.",
   "restart_required": true,
   "value_range": "pg_cron,pg_stat_statements,pg_qualstats,pg_stat_kcache,pg_wait_sampling,pgaudit,timescaledb,pglogical,passwordcheck.so,pg_sql_history,auth_delay,pg_hint_plan,anon,rds_pg_sql_ccl,pg_stat_monitor,pg_tle,rds_performance_statements"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。