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

查询可应用的实例

接口说明

查询指定参数模板可被应用的实例。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

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

表2 路径参数

名称

是否必选

参数类型

说明

config_id

是

String

参数模板ID。

表3 Query参数

名称

是否必选

参数类型

说明

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

limit

否

Integer

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求参数

表4 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

响应参数

表5 响应Body参数

参数

参数类型

说明

instances

Array of 表5-5 objects

可以应用的实例列表。

表6 ApplicableInstancesInfo

参数

参数类型

说明

instance_id

String

实例ID。

instance_name

String

实例名称。

entities

Array of 表6-6 objects

节点组信息或节点信息的列表对象。

  • 当参数模板是集群类型时，如果是shard组或者config组的参数模板，则返回的是对应类型的节点组信息；如果是mongos组的参数模板，则返回的是对应类型的的节点信息。
  • 当参数模板是副本集，直接应用到对应实例。如果是readonly的参数模板，则可应用到的是对应类型的的节点。
表7 EntityInfo

参数

参数类型

说明

entity_id

String

组ID或节点ID。

entity_name

String

组名称或节点名称。

  • 响应示例
{  
  instances:[ 
    { 
      "instance_id": "1967d9d9d6ef4c5ea38bd5a754f5737ein02", 
      "instance_name": "dds-5425", 
      "entities": [ 
        { 
          "entity_id": "36457a9af7c7486a882727d205ef37afgr02", 
          "entity_name": "shard_1" 
        }, 
        { 
          "entity_id": "a36651f1807f40be891db839e8bbe9e7gr02", 
          "entity_name": "shard_2" 
        } 
      ] 
    }, 
    { 
      "instance_id": "4809355b9836467c8749610089b1ef3bin02", 
      "instance_name": "dds-9d67", 
      "entities": [ 
        { 
          "entity_id": "08e61e50220c49728eb49dbb092d6ec4gr02", 
          "entity_name": "shard_2" 
        }, 
        { 
          "entity_id": "24d58cd41c20486e9745e7f5b424e641gr02", 
          "entity_name": "shard_3" 
        }, 
        { 
          "entity_id": "602807fcb2b24e38952347e030ec4a61gr02", 
          "entity_name": "shard_1" 
        } 
      ] 
    } 
  ] 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：参数配置