Query log analysis configurations - Security Center - Alibaba Cloud - Security Center

Queries the configuration information of log analysis in Security Center.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	123.168.XX.XX
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English.	zh
From	string	No	The source identifier of the request. Default value: aegis. Valid values: aegis: Server Guard edition. sas: Security Center edition. Note Server Guard users should use aegis, and Security Center users should use sas.	sas
ResourceDirectoryAccountId	integer	No	The ID of the member accounts in the resource directory (Alibaba Cloud account). Note You can invoke the DescribeMonitorAccounts operation to obtain this parameter.	127608589417****

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of configuration entries returned.	100
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	D0D6E6E4-CB8C-4897-B852-46AEFDA04B21
LogMetaList	array<object>	The list of log analysis configurations in Security Center.
	object	The log analysis configuration information in Security Center.
LogDesc	string	The name of the log type.	Login
Status	string	The current status. Valid values: disabled: Disabled. enabled: Enabled.	enabled
LogStore	string	The name of the dedicated Logstore where logs are stored.	aegis-log-login
UserProject	string	The name of the dedicated Project where logs are stored.	sasnew-log-XXXX-cn-hangzhou
Category	string	The log category. Valid values: host: Host logs. security: Security logs.	host
Project	string	The Project name.	aegis-log
UserLogStore	string	The name of the dedicated Logstore where user logs are stored.	aegis-log-network
UserRegion	string	The region to which the logs belong.	cn-hangzhou
Ttl	integer	The log retention period, in days.	180
HotTtl	integer	The number of days before hot storage data is converted to cold storage. Unit: days. Note A value of -1 indicates that no conversion is performed.	-1
Topic	string	The topic of the delivered logs.	aegis-log-login

Examples

Success response

JSON format

{
  "TotalCount": 100,
  "RequestId": "D0D6E6E4-CB8C-4897-B852-46AEFDA04B21",
  "LogMetaList": [
    {
      "LogDesc": "Login",
      "Status": "enabled",
      "LogStore": "aegis-log-login",
      "UserProject": "sasnew-log-XXXX-cn-hangzhou",
      "Category": "host",
      "Project": "aegis-log",
      "UserLogStore": "aegis-log-network",
      "UserRegion": "cn-hangzhou",
      "Ttl": 180,
      "HotTtl": -1,
      "Topic": "aegis-log-login"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	RdCheckNoPermission	Resource directory account verification has no permission.
400	ThrottlingUser	Request was denied due to user flow control.
500	RdCheckInnerError	Resource directory account service internal error.
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.