Obtaining Parameter Templates

Description

This API is used to obtain parameter templates, including all databases' default parameter templates and user-created parameter templates.

Restrictions

This API applies only to DDS Community Edition.

URI

URI format
GET https://{Endpoint}/v3/{project_id}/configurations
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations?offset=0&limit=100

**Table 1** Request parameters
Name	Type	Mandatory	Description
X-Auth-Token	String	Yes	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A
project_id	String	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

**Table 2** Query parameters
Parameter	Type	Mandatory	Description
offset	Integer	No	Definition The index position. Constraints The value must be a number. Range The value cannot be a negative number. Default Value 0: The query starts from the first data record.
limit	Integer	No	Definition Number of records displayed on each page. Constraints N/A Range 1 to 100 Default Value 100

Request Parameters

None

Response Parameters

Parameter description

**Table 3** Response body parameters
Name	Type	Description
total_count	Integer	Definition The total number of queried records. Range N/A
configurations	Array of objects	Definition The parameter template list. For details, see Table 4. Range N/A

**Table 4** Data structure description of the configurations field
Parameter	Type	Description
id	String	Definition Parameter template ID. Range N/A
name	String	Definition Parameter template name. Range N/A
description	String	Definition Parameter template description. Range N/A
datastore_version	String	Definition Database version. Range N/A
datastore_name	String	Definition Database type. Range N/A
node_type	String	Definition Node type of the parameter template. Range mongos: the mongos node type. shard: the shard node type. config: the config node type. replica: the replica set type. readonly: the read replica type of a replica set instance. shard_readonly: the read replica type of a cluster instance. single: the single node type.
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
user_defined	Boolean	Definition Indicates whether the parameter template is created by users. Range false: The parameter template is a default parameter template. true: The parameter template is a custom template.

Response example

{ 
  "total_count" : 1, 
  "configurations" : [ { 
    "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", 
    "name" : "test1", 
    "description" : "", 
    "datastore_name" : "mongos", 
    "node_type":"shard",
    "datastore_version" : "4.0", 
    "created" : "2017-01-01T10:00:00", 
    "updated" : "2017-01-01T10:00:00", 
    "user_defined" : true 
  } ] 
}

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.