获取参数模板列表
接口说明
获取参数模板列表，包括DDS数据库的所有默认参数模板和用户创建的参数模板。
约束说明
该接口仅支持DDS社区版。
URI
|
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|
|
X-Auth-Token |
String |
是 |
参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
project_id |
String |
是 |
参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
offset |
Integer |
否 |
参数解释： 索引位置，偏移量。 约束限制： 必须为数字。 取值范围： 不能为负数。 默认取值： 0。偏移0条数据，表示从第一条数据开始查询。 |
|
limit |
Integer |
否 |
参数解释： 每页显示的数量。 约束限制： 不涉及。 取值范围： 1~100。 默认取值： 100。 |
请求消息
无。
响应消息
- 参数说明
表3 响应Body参数 名称
参数类型
描述
total_count
Integer
参数解释：
总记录数。
取值范围：
不涉及。
configurations
Array of objects
参数解释：
参数模板列表。请参见表4。
取值范围：
不涉及。
表4 configurations字段数据结构说明 参数
参数类型
描述
id
String
参数解释：
参数模板ID。
取值范围：
不涉及。
name
String
参数解释：
参数模板名称。
取值范围：
不涉及。
description
String
参数解释：
参数模板描述。
取值范围：
不涉及。
datastore_version
String
参数解释：
数据库版本。
取值范围：
不涉及。
datastore_name
String
参数解释：
数据库类型。
取值范围：
不涉及。
node_type
String
参数解释：
参数模板节点类型。
取值范围：
- mongos，表示集群mongos节点类型。
- shard，表示集群shard节点类型。
- config，表示集群config节点类型。
- replica，表示副本集类型。
- readonly，表示副本集只读节点类型。
- shard_readonly，表示集群只读节点类型。
- single，表示单节点类型。
created
String
参数解释：
创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量。
取值范围：
不涉及。
updated
String
参数解释：
更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。
其中，T指某个时间的开始；Z指时区偏移量。
取值范围：
不涉及。
user_defined
Boolean
参数解释：
是否是用户自定义参数模板。
取值范围：
- 取值为“false”，表示为系统默认参数模板。
- 取值为“true”，表示为用户自定义参数模板。
- 响应示例
{ "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
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
