Help Center/ Relational Database Service/ API Reference/ API v3/ Extension Management (RDS for PostgreSQL)/ Obtaining the Value of a Specified Parameter for an Instance
Updated on 2026-08-25 GMT+08:00
View PDF
Share

Obtaining the Value of a Specified Parameter for an Instance

Function

This API is used to obtain the value of a specified parameter for an instance.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:getParameter

-

-

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Constraints

  • This operation cannot be performed when the instance is in the abnormal or frozen state.
  • Only the value of shared_preload_libraries can be queried.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    name

    Yes

    Definition

    Name of the extension-related parameter.

    Constraints

    N/A

    Range

    Only the shared_preload_libraries parameter can be modified.

    Default Value

    shared_preload_libraries

Request

  • Request parameters

    None

  • URI example

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

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    name

    String

    Definition

    Name of the extension-related parameter.

    Range

    shared_preload_libraries

    value

    String

    Definition

    Name of the loaded extension.

    Range

    N/A

    restart_required

    Boolean

    Definition

    Whether a reboot is required.

    Range

    • true: A reboot is required.
    • false: A reboot is not required.

    value_range

    String

    Definition

    Supported extensions.

    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

    type

    String

    Definition

    Parameter type.

    Range

    The value can be string, integer, boolean, list, or float.

    description

    String

    Definition

    Parameter description.

    Range

    N/A
  • Example normal response 
    {
 "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"
}
  • Abnormal response

    For details, see Abnormal Response Results.

Status Code

Error Code

For details, see Error Codes.