更新时间:2025-08-04 GMT+08:00

获取实例指定参数的值

功能介绍

获取实例指定参数的值。

接口约束

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

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释

    租户在某一Region下的项目ID。

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

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    name

    参数解释

    参数名称。

    约束限制

    不涉及。

    取值范围

    当前只支持修改shared_preload_libraries。

    默认取值

    shared_preload_libraries

请求消息

  • 请求参数

    无。

  • URI样例

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

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    name

    String

    参数解释

    参数名称。

    取值范围

    不涉及。

    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_sql_history",  
      "restart_required" : true,  
      "value_range" : "passwordcheck.so,pg_stat_statements,pg_sql_history",  
      "type" : "list",  
      "description" : "Lists shared libraries to preload into server."  
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码