查询账号列表V3

功能介绍

查询账号列表。

接口约束

无

调用方法

请参见如何调用API。

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ddm:instance:listUser	Read	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	ddm:user:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/users

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID，此参数是实例的唯一标识。约束限制：不涉及。取值范围：只能由英文字母、数字组成，后缀为in09，长度为36个字符。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	参数解释：分页参数: 起始值。约束限制：不涉及。取值范围：大于等于0。默认取值：默认值是0。
limit	否	Integer	参数解释：分页参数: 每页记录数。约束限制：不涉及。取值范围：大于0且小于等于128。默认取值：默认值是10。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求示例

创建账号。

get https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein09/users

{
  "total" : 3,
  "offset" : 0,
  "limit" : 1,
  "users" : [ {
    "databases" : [ ],
    "created" : "2025-12-12T04:03:46+0000",
    "name" : "testwuli61",
    "password_lifetime" : null,
    "expiration_time" : null,
    "description" : "",
    "base_authority" : [ "ALTER", "CREATE", "DELETE", "DROP", "INDEX", "INSERT", "SELECT", "UPDATE" ],
    "password_last_changed" : "2025-12-12T04:03:46+0000",
    "status" : "RUNNING"
  } ]
}

响应参数

正常响应参数说明

表4 响应Body参数
参数	参数类型	描述
users	Array of GetUsersListDetailResponses objects	参数解释： DDM实例账号相关信息的集合。参数范围：不涉及
offset	Integer	参数解释：分页参数: 起始值。参数范围：大于等于0。
limit	Integer	参数解释：分页参数: 每页记录数。参数范围：大于0且小于等于128。
total	Integer	参数解释：总记录数。参数范围：不涉及。

表5 GetUsersListDetailResponses
参数	参数类型	描述
name	String	参数解释： DDM实例账号的名称。参数范围：不涉及。
status	String	参数解释： DDM实例账号的状态。参数范围：不涉及。
base_authority	Array of strings	参数解释： DDM实例账号的基础权限。参数范围：取值为：CREATE、DROP、ALTER、INDEX、INSERT、DELETE、UPDATE、SELECT
password_lifetime	Long	参数解释： DDM实例账号密码的有效期。取值范围：取值范围为0-65535的整数，单位为天。 0与空表示密码永不过期。
password_last_changed	String	参数解释： DDM实例账号密码最近一次的修改时间。格式为yyyy-mm-ddThh:mm:ssZ。其中，T指定某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。取值范围：不涉及。
description	String	参数解释：账号的描述信息。参数范围：不涉及。
created	String	参数解释： DDM实例账号的创建时间。格式为yyyy-mm-ddThh:mm:ssZ。其中，T指定某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。取值范围：不涉及。
databases	Array of GetUsersListdatabase objects	参数解释：关联的逻辑库集合。账号只对已关联的逻辑库有访问权限。参数范围：不涉及。
expiration_time	String	参数解释： DDM实例账号密码过期的时间。格式为yyyy-mm-ddThh:mm:ssZ。其中，T指定某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。取值范围：不涉及。

表6 GetUsersListdatabase
参数	参数类型	描述
name	String	参数解释：关联的逻辑库名称。参数范围：不涉及。

响应示例

正常响应示例

{
  "users" : [ {
    "name" : "testuser",
    "status" : "RUNNING",
    "base_authority" : [ "SELECT" ],
    "description" : "for project a",
    "created" : "2025-12-12T04:03:46+0000",
    "password_last_changed" : "2025-12-12T04:03:46+0000",
    "password_lifetime" : null,
    "expiration_time" : null,
    "databases" : [ {
      "name" : "logicdb1"
    } ]
  } ],
  "offset" : 0,
  "limit" : 1,
  "total" : 3
}