文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 参数管理/ 查询参数组可应用的实例列表V3
更新时间：2026-05-15 GMT+08:00
查看PDF
分享

查询参数组可应用的实例列表V3

功能介绍

查询参数组可应用的实例列表V3

接口约束

无

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ddm:instance:list

    Read

    parameterGroup *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    ddm:instance:list

    -

URI

GET /v3/{project_id}/configurations/{config_id}/query-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

config_id

是

String

参数解释：

参数组ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，长度为36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

分页参数: 起始值。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

默认值是0。

limit

否

Integer

参数解释：

分页参数: 每页记录数。

约束限制：

不涉及。

取值范围：

大于0且小于等于128。

默认取值：

默认值是10。

请求参数

无

请求示例

查询参数组可应用的实例列表。

GET https://{endpoint}//v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/configurations/849c450a43xxxxxxxxxxf33cff5f0717pr09/query-instances

响应参数

  • 正常响应参数说明

表3 响应Body参数

参数

参数类型

描述

entities

Array of ApplicableInstance objects

参数解释：

查询可应用的实例列表返回相关信息的集合。

取值范围：

不涉及。

total

Integer

参数解释：

参数组可应用的实例总数。

取值范围：

不涉及。
表4 ApplicableInstance

参数

参数类型

描述

instance_id

String

参数解释：

实例ID，此参数是实例的唯一标识。

取值范围：

只能由英文字母、数字组成，后缀为in09，长度为36个字符。

instance_name

String

参数解释：

实例名称。

取值范围：

不涉及。

响应示例

  • 正常响应示例 
    {
  "entities" : [ {
    "instance_id" : "34694c59f8xxxxxxxxxx35bd53e06d8bin09",
    "instance_name" : "ddm-test"
  } ],
  "total" : 9
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 参数管理

相关文档