文档

DisableUser - 禁用产品内的云账号

可禁用产品内暂时不需要的云账号。

接口说明

此 OpenAPI 为产品内【系统管理】-【用户管理】内的“禁用用户”功能,支持 DMS 企业版内的“管理员”角色用户通过调用 API 的方式对暂时不需要的云账号进行产品内的禁用操作。禁用后,对应云账号开通的数据源权限、数据 owner 配置、DBA 配置均会回收与失效。

说明 禁用只是临时限制该云账号不能登录本企业的 DMS 企业版产品,并不是禁用云账号本身。禁用的效果是用户通过该账号不再能登录到 DMS 企业版(除非再次启用),此时仍占用企业开通规格。

调试

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

授权信息

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

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

请求参数

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

租户 ID。

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

阿里云账号 uid。

12345

返回参数

名称类型描述示例值
object
RequestIdstring

请求唯一 ID

34E01EDD-6A16-4CF0-9541-C644D1BE01AA
ErrorCodestring

错误码

403
ErrorMessagestring

错误消息

The specified user not exists.
Successboolean
  • true:禁用成功
  • false:禁用失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "ErrorCode": "403",
  "ErrorMessage": "The specified user not exists.",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)