DescribeUserStatus - Data Security Center - Alibaba Cloud Documentation Center

Call the DescribeUserStatus operation to query the status of a user account.

Operation description

Call this operation to retrieve information about the current account. This helps you understand your usage of Data Security Center (DSC).

QPS limit

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed this limit, API calls are throttled. This may affect your business. Call this operation at a reasonable 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: The default value. Simplified Chinese. en_us: American English.	zh_cn
FeatureType	integer	No	This parameter is deprecated.	2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	769FB3C1-F4C9-42DF-9B72-7077A8989C13
UserStatus	object	The details of the current account.
UseOssSize	integer	The used Object Storage Service (OSS) storage. Unit: bytes.	234
UseInstanceNum	integer	The number of used instances.	125
InstanceNum	integer	The number of instances in the current account.	32
ChargeType	string	The billing method of the DSC service for the current account. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.	PREPAY
Authed	boolean	Indicates whether the current account is granted Resource Access Management (RAM) permissions on DSC. Valid values: true: The account is granted the permissions. false: The account is not granted the permissions.	true
LabStatus	integer	Indicates whether the Asset Lab feature is enabled. Valid values: 1: enabled. 0: disabled.	1
RemainDays	integer	The number of remaining days in the protection period for the assets of the current account.	131
Trail	boolean	Indicates whether the current account uses the trial version of the DSC service. Valid values: true: yes. false: no.	true
InstanceId	string	The ID of the Data Security Center instance purchased by the Alibaba Cloud account.	sddp-cn-****
AccessKeyId	string	The authorized AccessKey ID of the user.	yourAccessKeyID
Purchased	boolean	Indicates whether the DSC service is purchased. Valid values: true: yes. false: no.	true
DataManagerRole	integer	The permissions that the current account has. Valid values: 0: The account has the management or read-only permissions on Data Security Center. 1: The account has the management permissions on data domains.	1
ReleaseDays	integer	The number of days from service expiration to service release. Unit: days.	15
AuditClosable	boolean	Indicates whether SQL Insights can be disabled. Valid values: true: yes. false: no.	true
AuditReleasable	boolean	Indicates whether SQL Insights can be released. true: yes. false: no.	true
ReleaseTime	integer	The release time. Unit: milliseconds.	15000
InstanceTotalCount	integer	The total number of instances.	10
OssTotalSize	integer	The total OSS storage. Unit: bytes.	2048
UseAgentAudit	boolean	Indicates whether the agent-based audit feature has been used. Valid values: 1: yes. 0: no.	1
ProtectionDays	integer	The total number of days that assets have been protected.	22
AssetRoleAuthed	boolean

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": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.