文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 获取用户实例 - SqlLimitGetUserInstanceList
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

获取用户实例 - SqlLimitGetUserInstanceList

功能介绍

获取用户实例。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das::listInstances

    list

    -

    -

    -

    -

URI

POST /v3/{project_id}/instance/sql-limiting/get-user-instance-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 Query参数

参数

是否必选

参数类型

描述

engine_type

是

String

参数解释：

数据库引擎类型。

约束限制：

不涉及。

取值范围：

不涉及

默认取值：

不涉及

page_num

否

Integer

参数解释：

页码。

约束限制：

不涉及。

取值范围：

[0, 5000]

默认取值：

默认为0。

page_size

否

Integer

参数解释：

查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。

约束限制：

不涉及。

取值范围：

[0, 100]

默认取值：

默认为20。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

das_instances

Array of 表4 Objects

参数解释：

实例列表。

取值范围：

数组长度：0 - 200

total

Integer

参数解释：

总数。

取值范围：

[0,10000]
表4 DASInstanceInfo

参数

参数类型

描述

instance_id

String

参数解释：

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

取值范围：

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

instance_name

String

参数解释：

实例名称。

取值范围：

不涉及。

instance_status

String

参数解释：

实例状态。

取值范围：

不涉及。

engine_version

String

参数解释：

实例版本号。

取值范围：

不涉及。

engine_type

String

参数解释：

引擎类型。

取值范围：

不涉及。

请求示例

POST https://das.cn-north-1.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instance/sql-limiting/get-user-instance-list 
 
{
    "page_size": 5,
    "page_num": 1,
    "engine_type": "mysql"
}

响应示例

状态码： 200

Success.

{
    "das_instances": [
        {
            "instance_id": "bcfa975193f1402fa11a6d4fd6baf5fbin01",
            "instance_name": "rds-sql-勿删1",
            "engine_type": "mysql",
            "engine_version": "5.7",
            "instance_status": "ACTIVE"
        }
    ],
    "total": 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 云DBA

相关文档