文档数据库服务 DDS-查询可应用的实例:响应消息

时间:2024-10-25 14:28:47

响应消息

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

    参数

    参数类型

    说明

    instances

    Array of 表5-5 objects

    可以应用的实例列表。

    表5 ApplicableInstancesInfo

    参数

    参数类型

    说明

    instance_id

    String

    实例ID。

    instance_name

    String

    实例名称。

    entities

    Array of 表6-6 objects

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

    当参数模板是副本集或单节点类型时,不返回该字段,模板直接应用到对应实例。

    当参数模板是集群类型时,如果是shard组或者config组的参数模板,则返回的是对应类型的节点组信息;如果是mongos组的参数模板,则返回的是对应类型的的节点信息。

    例如:一个mongos参数模板可应用到一个或多个mongos节点。

    表6 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" 
        } 
      ] 
    } 
  ] 
}
support.huaweicloud.com/api-dds/dds_api_0201.html