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.

Before calling an API, you need to understand the API in Authentication.

Constraints

This API is in OBT. To use this API, contact customer service.
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** Parameter description
Name	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	Instance ID.
name	Yes	Parameter name. Only the value of shared_preload_libraries can be queried.

Request

Request parameters
None
URI example
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
name	String	Parameter name.
value	String	Parameter value.
restart_required	Boolean	Whether a reboot is required. true: A reboot is required. false: A reboot is not required.
value_range	String	Parameter value range. If the parameter type is integer, the value is 0 or 1. If the parameter type is boolean, the value is true or false.
type	String	Parameter type. The value can be string, integer, boolean, list, or float.
description	String	Parameter description.

Example normal response

{
  "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."  
}