DescribeUserBuyStatus - Security Center - Alibaba Cloud Documentation Center

Checks whether the current Alibaba Cloud account or its associated enterprise organization has purchased threat analysis.

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-sas:DescribeUserBuyStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SubUserId	integer	No	The ID of the Alibaba Cloud account.	123XXXXXX
RegionId	string	No	The region of the Data Management center for threat analysis. Select a region for the management center based on where your assets are located. Valid values: cn-hangzhou: Your assets are in the Chinese mainland or China (Hong Kong). ap-southeast-1: Your assets are in a region outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	CloudSiemSuccessResponse
Data	object	The response parameters.
MasterUserId	integer	The ID of the master account of the resource directory.	123XXXXXX
MasterUserName	string	The display name of the master account of the resource directory.	rd_master_xxx
MainUserId	integer	The ID of the Alibaba Cloud account that purchased threat analysis.	123XXXXXX
MainUserName	string	The name of the Alibaba Cloud account that purchased threat analysis.	sas_account_xxx
SubUserId	integer	The ID of the currently logged-on Alibaba Cloud account.	123XXXXXX
SubUserName	string	The name of the currently logged-on Alibaba Cloud account.	sas_account_xxx
Capacity	integer	The purchased capacity of Simple Log Service (SLS) for threat analysis. Unit: GB.	1024
SasInstanceId	string	The ID of the Security Center instance.	sas-instance-xxxxx
CanBuy	boolean	Indicates whether the current account can perform operations on threat analysis orders. Valid values: true: The account can purchase, upgrade, or downgrade threat analysis. false: The account cannot perform operations on threat analysis orders.	true
EndTime	integer	The expiration time of threat analysis. This value is a UNIX timestamp in milliseconds.	1669823999000
DurationDays	integer	The number of days before threat analysis expires.	3
RdOrder	integer	The type of the current order. 0: The order includes threat analysis traffic and capacity. 1: The order includes only threat analysis capacity.	1
RequestId	string	The ID of the request.	81D8EC0C-0804-51AD-8C38-17ED0BC74892

Examples

Success response

JSON format

{
  "Data": {
    "MasterUserId": 0,
    "MasterUserName": "rd_master_xxx",
    "MainUserId": 0,
    "MainUserName": "sas_account_xxx",
    "SubUserId": 0,
    "SubUserName": "sas_account_xxx",
    "Capacity": 1024,
    "SasInstanceId": "sas-instance-xxxxx",
    "CanBuy": true,
    "EndTime": 1669823999000,
    "DurationDays": 3,
    "RdOrder": 1
  },
  "RequestId": "81D8EC0C-0804-51AD-8C38-17ED0BC74892"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.