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

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

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

调试

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

请求参数

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

系统规定参数。取值:DisableUser

Tid Long -1

租户ID。

说明 取自【系统管理】-【实例管理】或【系统管理】-【用户管理】的产品规格
Uid Long 12345

阿里云账号uid

返回数据

名称 类型 示例值 描述
ErrorCode String 403

错误码

ErrorMessage String The specified user not exists.

错误消息

RequestId String 34E01EDD-6A16-4CF0-9541-C644D1BE01AA

请求唯一ID

Success Boolean true
  • true:禁用成功
  • false:禁用失败

示例

请求示例


http(s)://[Endpoint]/?Action=DisableUser
&Tid=-1
&Uid=12345
&<公共请求参数>

正常返回示例

XML 格式

<DisableUserResponse>
    <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>
    <Success>true</Success>
</DisableUserResponse>

JSON 格式

{
	"RequestId":"34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
	"Success":true
}

错误码

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