调用ListUserPermissions展示指定用户所具备的库表权限。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListUserPermissions

系统规定参数。取值:ListUserPermissions

Tid Long 3***

租户ID。

说明 鼠标移动到界面右上角的头像处,查看租户ID。具体操作,请参见查看租户信息
PermType String DATABASE

资源权限类型,取值如下:

  • DATABASE: 库权限
  • TABLE:表权限
  • COLUMN:列权限
  • INSTANCE: 实例权限
UserId String 51****

用户ID,可通过调用接口GetUserListUsers获取该参数的值。

说明 用户ID不是用户的阿里云Uid。
DatabaseName String db_name

数据库名。

SearchKey String rm-bp144d5ky4l4r****

搜索关键词。例如,搜索实例权限,此处可填入DMS中的实例地址,如:rm-bp144d5ky4l4r

Logic Boolean false

是否逻辑库,取值:

  • true:逻辑库
  • false:物理库
EnvType String dev

环境类型,取值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT环境
  • uat:UAT环境
  • pet:压测环境
  • stag:STAG环境
DbType String polardb

数据库类型,取值请参见DbType参数说明

PageNumber Integer 1

第几页。

PageSize Integer 5

每页数据量。

RegionId String cn-hangzhou

DMS服务地域,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
TotalCount Long 1

满足条件记录总数。

RequestId String C51420E3-144A-4A94-B473-8662FCF4AD10

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

UserPermissions Array of UserPermission

用户权限信息列表。

UserPermission
DbId String 1860****

库ID。

TableName String test_table

表名。

UserId String 51****

用户ID。

SchemaName String test_db

数据库名。

Logic Boolean false

是否逻辑库,取值:

  • true:逻辑库
  • false:物理库
UserNickName String nick_name

用户名。

InstanceId String 174****

实例ID。

PermDetails Array of PermDetail

权限详情。

PermDetail
OriginFrom String xxx授权

权限授予来源信息。

PermType String QUERY

权限类型,返回值如下:

  • QUERY:查询
  • EXPORT:导出
  • CORRECT:变更
ExpireDate String 2020-12-12 00:00:00

授权到期时间。

CreateDate String 2019-12-12 00:00:00

权限授予时间。

UserAccessId String 758****

授权记录ID。

ExtraData String xxx

额外数据,预留参数。

EnvType String dev

数据库所属环境类型,返回值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT环境
  • uat:UAT环境
  • pet:压测环境
  • stag:STAG环境
ColumnName String column_name

字段名。

DbType String polardb

数据库类型,返回值请参见DbType参数说明

DsType String DATABASE

权限类型,取值如下:

  • DATABASE: 物理库权限
  • LOGIC_DATABASE:逻辑库权限
  • TABLE:物理表权限
  • LOGIC_TABLE:逻辑表权限
TableId String 13434

表ID。

SearchName String test_db@xxx:3306

库搜索名。

Alias String instance_alias

实例别名。

Host String rm-bp144d5ky4l4r****

实例地址。

Port Long 3306

实例端口。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListUserPermissions
&PermType=DATABASE
&UserId=51****
&DatabaseName=db_name
&SearchKey=rm-bp144d5ky4l4r****
&Logic=false
&EnvType=dev
&DbType=MySQL
&PageNumber=1
&PageSize=5
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListUserPermissionsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>C51420E3-144A-4A94-B473-8662FCF4AD10</RequestId>
    <ErrorCode>UnknownError</ErrorCode>
    <ErrorMessage>UnknownError</ErrorMessage>
    <UserPermissions>
        <DbId>1860****</DbId>
        <TableName>test_table</TableName>
        <UserId>51****</UserId>
        <SchemaName>test_db</SchemaName>
        <Logic>false</Logic>
        <UserNickName>nick_name</UserNickName>
        <InstanceId>174****</InstanceId>
        <PermDetails>
            <OriginFrom>xxx授权</OriginFrom>
            <PermType>QUERY</PermType>
            <ExpireDate>2020-12-12 00:00:00</ExpireDate>
            <CreateDate>2019-12-12 00:00:00</CreateDate>
            <UserAccessId>758****</UserAccessId>
            <ExtraData>xxx</ExtraData>
        </PermDetails>
        <EnvType>dev</EnvType>
        <ColumnName>column_name</ColumnName>
        <DbType>polardb</DbType>
        <DsType>DATABASE</DsType>
        <TableId>13434</TableId>
        <SearchName>test_db@xxx:3306</SearchName>
        <Alias>instance_alias</Alias>
        <Host>rm-bp144d5ky4l4r****</Host>
        <Port>3306</Port>
    </UserPermissions>
    <Success>true</Success>
</ListUserPermissionsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "C51420E3-144A-4A94-B473-8662FCF4AD10",
  "ErrorCode" : "UnknownError",
  "ErrorMessage" : "UnknownError",
  "UserPermissions" : [ {
    "DbId" : "1860****",
    "TableName" : "test_table",
    "UserId" : "51****",
    "SchemaName" : "test_db",
    "Logic" : false,
    "UserNickName" : "nick_name",
    "InstanceId" : "174****",
    "PermDetails" : [ {
      "OriginFrom" : "xxx授权",
      "PermType" : "QUERY",
      "ExpireDate" : "2020-12-12 00:00:00",
      "CreateDate" : "2019-12-12 00:00:00",
      "UserAccessId" : "758****",
      "ExtraData" : "xxx"
    } ],
    "EnvType" : "dev",
    "ColumnName" : "column_name",
    "DbType" : "polardb",
    "DsType" : "DATABASE",
    "TableId" : "13434",
    "SearchName" : "test_db@xxx:3306",
    "Alias" : "instance_alias",
    "Host" : "rm-bp144d5ky4l4r****",
    "Port" : 3306
  } ],
  "Success" : true
}

错误码

访问错误中心查看更多错误码。