Use DescribeUserStatus to query user account status - Data Security Center - Alibaba Cloud - Data Security Center

Queries the status of a user account by calling DescribeUserStatus.

Operation description

Queries information about the current logon account. This helps you gain a comprehensive understanding of the effectiveness of Data Security Center (DSC).

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sddp:DescribeUserStatus

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Valid values: zh_cn: Chinese (Simplified). This is the default value. en_us: English (US).	zh_cn
FeatureType	integer	No	This parameter is deprecated.	2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
UserStatus	object	The details of the current logon account.
UseOssSize	integer	The used OSS storage capacity. Unit: bytes.	234
UseInstanceNum	integer	The number of instances that are used.	125
InstanceNum	integer	The number of instances in the current logon account.	32
ChargeType	string	The billing method of the DSC service purchased by the current logon account. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.	PREPAY
Authed	boolean	Indicates whether the current logon account has authorized DSC to access RAM. Valid values: true: authorized. false: not authorized.	true
LabStatus	integer	Indicates whether the asset lab feature is enabled. Valid values: 1: enabled. 0: not enabled.	1
RemainDays	integer	The remaining days of the protection period for assets in the current logon account.	131
Trail	boolean	Indicates whether the current logon account is using a trial version of DSC. Valid values: true: trial. false: non-trial.	true
InstanceId	string	The instance ID of the Data Security Center product purchased by the Alibaba Cloud account.	sddp-cn-****
AccessKeyId	string	The AccessKey ID authorized by the user.	yourAccessKeyID
Purchased	boolean	Indicates whether the DSC service is purchased. Valid values: true: purchased. false: not purchased.	true
DataManagerRole	integer	The permissions of the current account. Valid values: 0: has management or read-only permissions for Data Security Center. 1: has data domain management permissions.	1
ReleaseDays	integer	The number of days from expiration to release. Unit: days.	15
AuditClosable	boolean	Indicates whether SQL Explorer can be disabled. Valid values: true: can be disabled. false: cannot be disabled.	true
AuditReleasable	boolean	Indicates whether SQL Explorer can be released. Valid values: true: can be released. false: cannot be released.	true
ReleaseTime	integer	The release time. Unit: milliseconds.	15000
InstanceTotalCount	integer	The total number of instances.	10
OssTotalSize	integer	The total OSS storage capacity. Unit: bytes.	2048
UseAgentAudit	boolean	Indicates whether the Agent audit feature has been used. Valid values: 1: has been used. 0: has not been used.	1
ProtectionDays	integer	The total number of days that user assets have been protected.	22
AssetRoleAuthed	boolean	Indicates whether the current logon account has authorized the service-linked role for DSC asset synchronization. Valid values: true: authorized. false: not authorized.	true

Examples

Success response

JSON format

{
  "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": "yourAccessKeyID",
    "Purchased": true,
    "DataManagerRole": 1,
    "ReleaseDays": 15,
    "AuditClosable": true,
    "AuditReleasable": true,
    "ReleaseTime": 15000,
    "InstanceTotalCount": 10,
    "OssTotalSize": 2048,
    "UseAgentAudit": true,
    "ProtectionDays": 22,
    "AssetRoleAuthed": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.