全部产品
Search
文档中心

数据管理 DMS:ListAuthorizedInstancesForUser - 获取用户有权限的实例

更新时间:Nov 28, 2024

调用此API可以获取指定用户有权限的实例列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListAuthorizedInstancesForUsernone
*全部资源
*

请求参数

名称类型必填描述示例值
UserIdstring

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

说明 当 IdentityType 参数的值选择 USER 时需要填写。
51****
EnvTypestring

环境类型,取值如下:

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

数据库类型,取值为:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
MySQL
SearchKeystring

搜索关键字。

policy_test
PageNumberstring

第几页。

1
PageSizestring

每页记录数。

20
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。用于定位日志,排查问题。

B7DB89CC-017D-5503-8953-38FFE241A618
Instancesarray<object>

有权限的实例列表。

instancesobject

实例列表。

InstanceIdstring

实例 ID。

21****
Hoststring

实例连接地址。

rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com
Portstring

实例连接端口。

3306
DbTypestring

数据库类型。

MySQL
UserIdstring

用户 ID。

51****
UserNamestring

用户名。

user_test
InstanceAliasstring

实例别名。

DMS_TEST
EnvTypestring

实例的环境类型。

product
PermissionDetailobject

权限详情。根据权限来源不同,权限详情格式有所不同。下面以权限来源为普通权限为示例。

DsTypestring

操作对象类型。

DATABASE
PermTypestring

权限类型,取值如下:

  • QUERY:查询。
  • EXPORT:导出。
  • CORRECT:变更。
CORRECT
ExpireDatestring

权限到期时间。

2024-12-06 10:00:00
Messagestring

如果权限来源为权限策略,该字段会包括权限策略的名称以及允许用户进行的操作信息。

权限策略通过,策略名:INSTANCE_OWNER,被允许的操作:instance:InstanceQuery

示例

正常返回示例

JSON格式

{
  "RequestId": "B7DB89CC-017D-5503-8953-38FFE241A618",
  "Instances": [
    {
      "InstanceId": "21****",
      "Host": "rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com",
      "Port": "3306",
      "DbType": "MySQL",
      "UserId": "51****",
      "UserName": "user_test",
      "InstanceAlias": "DMS_TEST",
      "EnvType": "product",
      "PermissionDetail": {
        "DsType": "DATABASE",
        "PermType": "CORRECT",
        "ExpireDate": "2024-12-06 10:00:00\n",
        "Message": "权限策略通过,策略名:INSTANCE_OWNER,被允许的操作:instance:InstanceQuery"
      }
    }
  ]
}

错误码

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