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 this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

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. Constraints N/A Range N/A Default Value N/A
name	Yes	Definition Parameter name. 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 Parameter name. Range N/A
value	String	Definition Parameter value. 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 Parameter value range. Range If the parameter type is integer, the value is 0 or 1. If the type is boolean, the value is true or false.
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_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."  
}