Obtaining Details About a Parameter Template

Description

This API is used to obtain parameter details of a specified parameter template.

Restrictions

This API applies only to DDS Community Edition.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	String	header	Yes	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A
project_id	String	path	Yes	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
config_id	String	path	Yes	Definition Parameter template ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Parameter description

**Table 2** Response body parameters
Name	Type	Description
id	String	Definition The parameter template ID. Range N/A
name	String	Definition Parameter template name. Range N/A
datastore_version	String	Definition Database version. Range N/A
datastore_name	String	Definition Database type. Range N/A
description	String	Definition The parameter template description. Range N/A
created	String	Definition Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A
updated	String	Definition Update time in the "yyyy-MM-ddTHH:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. Range N/A
parameters	Array of objects	Definition The parameters defined by users based on the default parameter templates. For details, see Table 3. Range N/A

**Table 3** Data structure description of the parameters field
Name	Type	Description
name	String	Definition The parameter name. Range N/A
value	String	Definition The parameter value. Range N/A
description	String	Definition The parameter description. Range N/A
type	String	Definition Parameter type. Range integer string boolean float list
value_range	String	Definition Value range. Range For the integer type, the value ranges from 0 to 1. For the boolean type, the value is true or false.
restart_required	Boolean	Definition Whether the instance needs to be restarted. Range If the value is true, restart is required. If the value is false, restart is not required.
readonly	Boolean	Definition Whether the parameter is read-only. Range If the value is true, the parameter is read-only. If the value false, the parameter is not read-only.

Response example

{
  "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
  "name": "paramsGroup-test",
  "description": "",
  "datastore_name": "mongodb",
  "datastore_version": "4.0",
  "created": "2017-01-01T10:00:00",
  "updated": "2017-01-01T10:00:00",
  "parameters": [
    {
      "name": "cursorTimeoutMillis",
      "type": "integer",
      "value": 600000,
      "description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.",
      "value_range": "600000-1000000",
      "restart_required": false,
      "readonly": false
    }
  ]
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.