调用DescribeUserStatus查询用户账号状态。

接口说明

通过调用本接口，您可以获取当前登录账号的相关信息，便于您全面了解使用 DSC 的使用效果。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sddp:DescribeUserStatus	Read	acs:yundun-sddp::{#accountId}:*	无	无

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	请求和接收消息的语言类型。取值： zh_cn：默认值，中文（简体）。 en_us：英文（美国）。	zh_cn
FeatureType	integer	否	此参数已废弃。	2

返回参数

名称	类型	描述	示例值
	object
RequestId	string	返回结果的请求 ID。	769FB3C1-F4C9-42DF-9B72-7077A8989C13
UserStatus	object	返回当前登录账号详情列表。
UseOssSize	long	已使用的 OSS 存储量。单位：字节。	234
UseInstanceNum	integer	已使用的实例数量。	125
InstanceNum	integer	当前登录账号包含的实例数量。	32
ChargeType	string	当前登录账号购买 DSC 服务的付费类型。取值： PREPAY：预付费。 POSTPAY：后付费。	PREPAY
Authed	boolean	当前登录账号是否已授权 DSC RAM 的权限。取值： true：已授权。 false：未授权。	true
LabStatus	integer	是否开通资产实验室功能。取值： 1：已开通。 0：未开通。	1
RemainDays	integer	当前登录账号中资产的保护期剩余天数。	131
Trail	boolean	当前登录账号是否试用 DSC 服务。取值： true：试用。 false：非试用。	true
InstanceId	string	主账号购买的数据安全中心产品实例 ID。	sddp-cn-****
AccessKeyId	string	用户授权的 AccessKey ID。	LTAI4G67HRBzNRmMhfyv****
Purchased	boolean	是否购买 DSC 服务。取值： true：已购买。 false：未购买。	true
DataManagerRole	integer	当前账号拥有的权限。取值： 0: 拥有数据安全中心的管理权限或只读权限。 1: 拥有数据域管理权限。	1
ReleaseDays	integer	过期到释放的时间。单位：天。	15
AuditClosable	boolean	是否可以关闭 sql 洞察。取值： true：可以。 false：不可以。	true
AuditReleasable	boolean	是否可以释放 sql 洞察。 true：可以。 false：不可以。	true
ReleaseTime	long	释放时间。单位：毫秒。	15000
InstanceTotalCount	long	实例总数。	10
OssTotalSize	long	OSS 总存储量。单位：字节。	2048
UseAgentAudit	boolean	是否曾经使用过 Agent 审计功能。取值： 1：使用过。 0：未使用过。	1
ProtectionDays	integer	累计保护用户资产的天数。	22

示例

正常返回示例

JSON格式

{
  "RequestId": "769FB3C1-F4C9-42DF-9B72-7077A8989C13",
  "UserStatus": {
    "UseOssSize": 234,
    "UseInstanceNum": 125,
    "InstanceNum": 32,
    "ChargeType": "PREPAY",
    "Authed": true,
    "LabStatus": 1,
    "RemainDays": 131,
    "Trail": true,
    "InstanceId": "sddp-cn-****",
    "AccessKeyId": "LTAI4G67HRBzNRmMhfyv****",
    "Purchased": true,
    "DataManagerRole": 1,
    "ReleaseDays": 15,
    "AuditClosable": true,
    "AuditReleasable": true,
    "ReleaseTime": 15000,
    "InstanceTotalCount": 10,
    "OssTotalSize": 2048,
    "UseAgentAudit": true,
    "ProtectionDays": 22
  }
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2024-03-25

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：FeatureType

2023-12-27

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-09-01

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。