Obtaining the Parameter Template of a Specified DB Instance

Function

This API is used to obtain information about the parameter template of a specified DB instance.

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

• Before calling this API, obtain the required region and endpoint.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the 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	Specifies the DB instance ID compliant with the UUID format.

Request

• Request parameters

  None

• Example

  GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  datastore_version_name	String	Indicates the database version name.
  datastore_name	String	Indicates the database name.
  created	String	Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
  updated	String	Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.
  configuration_parameters	Array of objects	Indicates the parameters defined by users based on the default parameter templates. For details, see Table 3.

  Table 3 configuration_parameters field data structure description

  Name	Type	Description
  name	String	Indicates the parameter name.
  value	String	Indicates the parameter value.
  restart_required	Boolean	Indicates whether a reboot is required. false: A reboot is not required. true: A reboot is required.
  readonly	Boolean	Indicates whether the parameter is read-only. false: The parameter is not read-only. true: The parameter is read-only.
  value_range	String	Indicates the parameter value range. If the type is Integer, the value is 0 or 1. If the type is Boolean, the value is true or false.
  type	String	Indicates the parameter type, which can be integer, string, boolean, list, or float.
  description	String	Indicates the parameter description.

• Example normal response

  {
      "datastore_version_name": "5.7",
      "datastore_name": "mysql",
      "created": "2018-10-11 11:40:44",
      "updated": "2018-10-11 11:40:44",
      "configuration_parameters": [{
          "name": "auto_increment_increment",
          "value": "1",
          "restart_required": false,
          "readonly": false,
          "value_range": "1-65535",
          "type": "integer",
          "description": "auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column."
      }]
  }
  

• 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.

last updated: 2024-11-27 14:48 UTC - commit: 41d07235d05421e76b41a614ca9cd524f2489dc0