DescribeLoginBaseConfigs - Security Center - Alibaba Cloud Documentation Center

Queries the information about the configurations that are used to detect unusual logons to your servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeLoginBaseConfigs	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries to return on each page. Default value: 5.	5
Type	string	Yes	The logon type of the configuration to query. Valid values: login_common_location: common logon location login_common_ip: common logon IP address login_common_time: common logon time range login_common_account: common logon account	login_common_location
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
Target	string	No	The server to which the configuration is applied. The value of this parameter is in the JSON format and contains the following fields: Target: the UUID or group ID of the server to add or delete. Note If targetType is set to uuid, the value of Target is the UUID of the server. If targetType is set to groupId, the value of Target is the group ID of the server. If targetType is set to global, the value of Target is a hyphen (-). targetType: the type of the server to which the configuration is applied. Valid values: uuid: a server groupId: a server group global: all servers	[ {"target": "inet-7c676676-06fa-442e-90fb-b802e5d6****", "targetType": "uuid" } ]

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
CurrentPage	integer	The page number of the returned page.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	2C2D4B3C-0524-17B1-93D2-DA50119F4E1E
PageSize	integer	The number of entries returned per page. Default value: 20.	20
TotalCount	integer	The total number of entries returned.	200
BaseConfigs	object []	The description of the configuration.
EndTime	string	The end time of the common logon time range.	07:00
Account	string	The common logon account.	1582318****
StartTime	string	The start time of the common logon time range.	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 to which the configuration is applied.	13
Location	string	The common logon location.	Montenegro
TargetList	object []	The details of the servers to which the configuration is applied.
Target	string	The UUID or group ID of the server.	0011ea53-738c-4bff-93be-ce6a1cc9****
TargetType	string	The type of the server to which the configuration is applied. Valid values: uuid: a server groupId: a server group global: all servers	uuid
Remark	string	Corresponding configuration remark information.	test

Examples

Sample success responses

JSONformat

{
  "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": "Montenegro\n",
      "TargetList": [
        {
          "Target": "0011ea53-738c-4bff-93be-ce6a1cc9****",
          "TargetType": "uuid"
        }
      ],
      "Remark": "test"
    }
  ]
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-04-06

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.