Unusual Logon Detection API Parameters & Config Reference - Security Center - Alibaba Cloud - Security Center

Queries the configuration of unusual logon detection rules for servers.

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:DescribeLoginBaseConfigs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	Settings for paged query. The number of logon configuration entries to display on each page during paging. Default value: 5, which indicates that five logon configuration entries are displayed on each page.	5
Type	string	Yes	The type of logon configuration to query. Valid values: login_common_location: common logon location. login_common_ip: common logon IP address. login_common_time: common logon time. login_common_account: common logon account.	login_common_location
CurrentPage	integer	No	The page number of the page to return. Default value: 1, which indicates that the first page is returned.	1
Target	string	No	The selection mode for the assets on which the policy takes effect. This parameter is in JSON format and contains the following fields: Target: the UUID of the server to add or delete, or the ID of the server group. Note If the targetType parameter is set to uuid, this parameter specifies the UUID of the server. If the targetType parameter is set to groupId, this parameter specifies the ID of the server group. If the targetType parameter is set to global, this parameter is set to a hyphen (-). targetType: the selection mode for the assets on which the policy takes effect. Valid values: uuid: queries by individual server. groupId: queries by server group. global: queries all servers.	[ {"target": "inet-7c676676-06fa-442e-90fb-b802e5d6****", "targetType": "uuid" } ]

Response elements

Element	Type	Description	Example
	object	The response data of unusual logon detection rule configurations.
CurrentPage	integer	The page number of the current page in a paged query. This is used for paging through the results.	1
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	2C2D4B3C-0524-17B1-93D2-DA50119F4E1E
PageSize	integer	The number of logon configuration entries displayed on each page in a paged query. This is used for paging through the results. Default value: 20, which indicates that 20 logon configuration entries are displayed on each page.	20
TotalCount	integer	The total number of logon configuration entries returned.	200
BaseConfigs	array<object>	The list of logon configuration details.
	array<object>	The logon configuration details.
EndTime	string	The end time of the common logon time range. The time is in the HH:mm format, which represents a daily time range in the 24-hour clock.	07:00
Account	string	The common logon account.	1582318****
StartTime	string	The start time of the common logon time range. The time is in the HH:mm format, which represents a daily time range in the 24-hour clock.	08:00
Ip	string	The common logon IP address.	192.168.XX.XX
TotalCount	integer	The total number of servers.	172
UuidCount	integer	The number of servers on which the rule takes effect.	13
Location	string	The common logon location.	BeiJing
TargetList	array<object>	The list of details about the servers on which the rule takes effect.
	object	The details about a server on which the rule takes effect.
Target	string	The UUID of the server on which the rule takes effect, or the ID of the server group to which the server belongs.	0011ea53-738c-4bff-93be-ce6a1cc9****
TargetType	string	The selection mode for the assets on which the rule takes effect. Valid values: uuid: added by individual asset. groupId: added by server group. global: all assets are selected.	uuid
Remark	string	The remark information displayed for the corresponding configuration.	test

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "2C2D4B3C-0524-17B1-93D2-DA50119F4E1E",
  "PageSize": 20,
  "TotalCount": 200,
  "BaseConfigs": [
    {
      "EndTime": "07:00",
      "Account": "1582318****",
      "StartTime": "08:00",
      "Ip": "192.168.XX.XX",
      "TotalCount": 172,
      "UuidCount": 13,
      "Location": "BeiJing",
      "TargetList": [
        {
          "Target": "0011ea53-738c-4bff-93be-ce6a1cc9****",
          "TargetType": "uuid"
        }
      ],
      "Remark": "test"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.