文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 参数配置/ 获取指定实例的参数信息
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

获取指定实例的参数信息

接口说明

获取指定实例的参数信息。

约束说明

该接口仅支持DDS社区版。

URI

  • URI格式

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

请求参数

表1 请求参数

参数

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

Content-Type

string

header

是

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
表2 Query参数

参数

参数类型

是否必选

描述

entity_id

String

是

实例ID或组ID或节点ID。可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。

  • 当获取的实例类型是集群，如果获取的是shard组或者config组的参数模板，传值为组ID。如果获取的是mongos节点的参数模板，传值为节点ID。
  • 当获取的实例类型是副本集，传值为实例ID。如果获取的是readonly节点的参数模板，传值为节点ID。

响应参数

  • 参数说明
    表3 响应Body参数

    名称

    参数类型

    说明

    id

    String

    实例参数配置ID。仅可用于参数的比较。

    node_type

    String

    参数模板节点类型。

    • mongos，表示集群mongos节点类型。
    • shard，表示集群shard节点类型。
    • config，表示集群config节点类型。
    • replica，表示副本集类型。
    • readonly，表示只读节点类型。

    datastore_version

    String

    数据库版本。

    datastore_name

    String

    数据库类型。

    created

    String

    创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。

    其中，T指某个时间的开始；Z指时区偏移量。

    updated

    String

    更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。

    其中，T指某个时间的开始；Z指时区偏移量。

    parameters

    Array of objects

    参数对象，用户基于默认参数模板自定义的参数配置。

    详情请参见表4。
    表4 parameters字段数据结构说明

    名称

    参数类型

    说明

    name

    String

    参数名称。

    value

    String

    参数值。

    value_range

    String

    参数值范围。

    示例：Integer类型取值范围为0~1、Boolean类型取值为“true”或“false”。

    restart_required

    Boolean

    参数是否需要重启。

    • 取值为“true”，需要重启。
    • 取值为“false”，不需要重启。

    readonly

    Boolean

    是否只读。

    • 取值为“false”，非只读参数。
    • 取值为“true”，只读参数。

    type

    String

    参数类型，取值为“integer”，“string”，“boolean”，“float”或“list”。

    description

    String

    参数描述。
  • 响应示例 
    { 
  "configurations" : { 
    "id" : "5afa71df29ed4378bd7f6fef107daf6fin02", 
    "node_type" : "replica", 
    "datastore_version" : "4.0", 
    "datastore_name" : "mongodb", 
    "created" : "2017-01-01T10:00:00", 
    "updated" : "2017-01-01T10:00:00", 
    "parameters" : [ { 
      "name" : "cursorTimeoutMillis", 
      "value" : 600000, 
      "restart_required" : false, 
      "readonly" : false, 
      "description" : "设置空闲游标的超期时间，DDS将删除空闲的游标", 
      "value_range" : "600000-1000000" 
    } ] 
  } 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 参数配置