DescribeUserStatus-阿里云帮助中心

DescribeUserStatus queries the status of a user account.

Operation description

Call this operation to get a comprehensive overview of your DSC usage and information about the current account.

QPS limit

The QPS limit for this operation is 10 queries per second per user. Exceeding this limit results in API call throttling, which can impact your business.

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: Simplified Chinese. This is the default. en_us: American English.	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 account.
UseOssSize	integer	The storage space used in Object Storage Service (OSS). 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 for the DSC service for the current account. Valid values: PREPAY: Subscription. POSTPAY: Pay-as-you-go.	PREPAY
Authed	boolean	Specifies whether the account has authorized DSC through Resource Access Management (RAM). Valid values: true: Authorized. false: Unauthorized.	true
LabStatus	integer	Specifies whether the Asset Lab feature is enabled. Valid values: 1: Enabled. 0: Disabled.	1
RemainDays	integer	The number of days remaining in the protection period for assets in the current account.	131
Trail	boolean	Specifies whether the account is using a trial of the DSC service. Valid values: true: Yes. false: No.	true
InstanceId	string	The ID of the DSC instance purchased by the Alibaba Cloud account.	sddp-cn-****
AccessKeyId	string	The AccessKey ID that is authorized to access DSC.	yourAccessKeyID
Purchased	boolean	Specifies whether the account has purchased the DSC service. Valid values: true: Yes. false: No.	true
DataManagerRole	integer	The data manager role of the account. Valid values: 0: The account has management or read-only permissions for DSC. 1: The account has management permissions for data domains.	1
ReleaseDays	integer	The number of days from service expiration to service release. Unit: days.	15
AuditClosable	boolean	Specifies whether SQL Insights can be disabled. Valid values: true: Yes. false: No.	true
AuditReleasable	boolean	Specifies whether SQL Insights can be released. Valid values: true: Yes. false: No.	true
ReleaseTime	integer	The timestamp when the service is released. Unit: milliseconds.	15000
InstanceTotalCount	integer	The total number of instances.	10
OssTotalSize	integer	The total storage capacity of Object Storage Service (OSS). Unit: bytes.	2048
UseAgentAudit	boolean	Specifies whether the agent 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	Specifies whether the account has granted DSC the service role required for asset synchronization. Valid values: true: Authorized. false: Unauthorized.	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.