文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 开发工具/ 查询所有类型实例列表 - ListInstances
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

查询所有类型实例列表 - ListInstances

功能介绍

查询所有类型实例列表。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das::listInstances

    list

    connection

    -

    das:connections:list

    -

URI

GET /v3/{project_id}/all-type-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

实例名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cur_page

否

Integer

参数解释：

页码。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

per_page

否

Integer

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

[0, 100]，实际取决于查询。

默认取值：

不涉及。

network_type

否

String

参数解释：

数据库来源类型。

约束限制：

不涉及。

取值范围：

  • rds
  • gaussdb
  • dds
  • ddm

默认取值：

不涉及。

engine_type

否

String

参数解释：

数据库引擎类型。

约束限制：

不涉及。

取值范围：

  • mysql
  • sqlserver
  • postgresql
  • taurus
  • gaussdbv5
  • mongodb
  • ddm

默认取值：

不涉及。

id

否

String

参数解释：

实例ID。标识实例的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

无。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

总记录数目。

取值范围：

不涉及。

instances

Array of 表4 objects

参数解释：

实例信息列表。

取值范围：

不涉及。
表4 DasCommonInstanceDto

参数

参数类型

描述

name

String

参数解释：

实例名称。

取值范围：

不涉及。

id

String

参数解释：

实例ID。

取值范围：

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

status

String

参数解释：

实例状态。

取值范围：

不涉及。

type

String

参数解释：

实例类型。

取值范围：

不涉及。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

engine_type

String

参数解释：

数据库引擎类型。

取值范围：

  • mysql
  • sqlserver
  • postgresql
  • taurus
  • gaussdbv5
  • mongodb
  • ddm

engine_version

String

参数解释：

实例引擎版本。

取值范围：

不涉及。

port

String

参数解释：

实例引擎端口。

取值范围：

不涉及。

region

String

参数解释：

区域。

取值范围：

不涉及。

nodes

Array of 表5 objects

参数解释：

实例节点列表。

取值范围：

不涉及。

network_type

String

参数解释：

数据库来源类型。

约束限制：

不涉及。

取值范围：

  • rds
  • gaussdb
  • dds
  • ddm

默认取值：

不涉及

related_instance

Array of 表6 objects

参数解释：

相关实例列表。

取值范围：

不涉及。
表5 DasCommonInstanceNodeDto

参数

参数类型

描述

id

String

参数解释：

节点ID。

取值范围：

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

name

String

参数解释：

节点名称。

取值范围：

不涉及。

status

String

参数解释：

节点状态。

取值范围：

不涉及。

role

String

参数解释：

节点角色。

取值范围：

不涉及。

private_ip

String

参数解释：

节点私有IP。

取值范围：

不涉及。

public_ip

String

参数解释：

节点公共IP。

取值范围：

不涉及。

group_id

String

参数解释：

节点组ID。

取值范围：

不涉及。

group_name

String

参数解释：

节点组名称。

取值范围：

不涉及。
表6 RelatedInstance

参数

参数类型

描述

id

String

参数解释：

实例ID。

取值范围：

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

type

String

参数解释：

实例类型。

取值范围：

不涉及。

name

String

参数解释：

实例名称。

取值范围：

不涉及。

请求示例

GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/all-type-instances?per_page=5&cur_page=1&name=&network_type=rds&engine_type=mysql

响应示例

状态码： 200

Success.

{
    "instances": [
        {
            "id": "14f3ae83797947f2b9669e645202a757in01",
            "name": "rds-7be6",
            "status": "ACTIVE",
            "type": "Single",
            "enterprise_project_id": "2d92cf15-8698-4ade-ad00-b206b5256c36",
            "engine_type": "mysql",
            "engine_version": "5.7",
            "port": "3306",
            "region": "cn-south-4",
            "network_type": "rds",
            "related_instance": []
        }
    ],
    "total_count": 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 开发工具

相关文档