文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 参数管理/ 查询应用参数模板的实例列表 - ListInstancesConfigurations
更新时间：2025-11-14 GMT+08:00
查看PDF
分享

查询应用参数模板的实例列表 - ListInstancesConfigurations

功能介绍

查询应用参数模板的实例列表。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:listAll

read

-

-

rds:instance:list

-

接口约束

  • 支持的数据库引擎：MySQL、TaurusDB标准版、MariaDB、PostgreSQL、Microsoft SQL Server。

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    参数解释：

    租户在某一Region下的项目ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    config_id

    是

    String

    参数解释：

    参数模板ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    offset

    否

    Integer

    参数解释：

    索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

    约束限制：

    不涉及。

    取值范围：

    大于等于0，必须为数字。

    默认取值：

    默认为0。偏移0条数据，表示从第一条数据开始查询。

    limit

    否

    Integer

    参数解释：

    查询记录数。

    约束限制：

    不涉及。

    取值范围：

    [1, 100]

    默认取值：

    10

请求消息

  • 请求参数

    无。

  • URI样例 
    https://{endpoint}/v3/54623db08b174c858ba779d2aa7923a3/configurations/0fb680b064cb496ca7acc7634070a652pr01/query-instances

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    entities

    Arrays of Object

    参数解释：

    实例列表。详见表3。

    instance_count_limit

    Integer

    参数解释：

    实例的限制数量。

    取值范围：

    不涉及。

    total_count

    Integer

    参数解释：

    应用参数模板的实例总数。

    取值范围：

    不涉及。
    表3 entities字段数据结构说明

    名称

    参数类型

    说明

    entity_id

    String

    参数解释：

    实例ID。

    取值范围：

    不涉及。

    entity_name

    String

    参数解释：

    实例名称。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
  "entities": [
    {
      "entity_id": "70308e5ca5dd4555be02a596ecd3e5acin01",
      "entity_name": "instance01"
    }
  ],
  "instance_count_limit": 1000,
  "total_count": 1
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 参数管理

相关文档