doc-exports/docs/opengauss/api-ref/opengauss_newapi_0004.html

Obtaining the Parameters of a Specified DB Instance

Function

This API is used to obtain parameters of a specified DB instance. Before calling this API:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations

• Parameter description

  Table 1 Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	Yes	String	DB instance ID.

Request

None

Response

• Normal response

  Table 2 Parameter description

  Parameter	Type	Description
  datastore_version	String	Engine version.
  datastore_name	String	Engine name.
  created	String	Creation time in the "yyyy-MM-dd HH:mm:ss" format.
  updated	String	Update time in the "yyyy-MM-ddHH:mm:ss" format.
  configuration_parameters	Array of objects	Parameters defined by users based on the default parameter templates. For details, see Table 3.

  Table 3 configuration_parameters field data structure description

  Parameter	Type	Description
  name	String	Parameter name.
  value	String	Parameter value.
  restart_required	Boolean	Whether a reboot is required after the parameter is modified.
  value_range	String	Parameter value range.
  type	String	Parameter type. The value can be string, integer, boolean, list, or float. Value: string integer boolean list float
  description	String	Parameter description.

Example Response

• Normal response

  {
      "created": "2022-04-11 10:46:59",
      "updated": "2022-04-11 10:46:59",
      "datastore_version": "2.0",
      "datastore_name": "GaussDB(for openGauss)",
      "configuration_parameters": [
          {
              "name": "audit_system_object",
              "value": "12295",
              "type": "integer",
              "description": "Whether to audit the CREATE, DROP, and ALTER operations on database objects",
              "restart_required": false,
              "value_range": "0-2097151"
          }
      ]
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Parameter Configuration