AddUserSourceLogConfig - Security Center - Alibaba Cloud Documentation Center

Adds a log collection task to import log data into Threat Analysis for alerting and event 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:AddUserSourceLogConfig

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceProdCode	string	No	The code of the product.	sas
SourceLogCode	string	No	The code of the log.	cloud_siem_aegis_proc
SubUserId	integer	Yes	The ID of the Alibaba Cloud account for which you want to collect logs.	123XXXXXX
SourceLogInfo	string	Yes	The detailed information about the Simple Log Service (SLS) log to be collected. The value is a JSON string.	{"project":"wafnew-project-1335759343513432-cn-hangzhou","logStore":"wafnew-logstore","regionCode":"cn-hangzhou","prodCode":"waf"}
DisPlayLine	string	No	The detailed information about the SLS log to be collected.	cn-shanghai.siem-project.siem-logstore
Deleted	integer	No	Specifies whether to add or delete the log collection task. Valid values: -1: Deletes the task. 0: Adds the task.	0
RegionId	string	No	The region where the Data Management center of Threat Analysis is located. Select a region based on the region where your assets reside. Valid values: cn-hangzhou: Your assets are in the Chinese mainland or Hong Kong (China). ap-southeast-1: Your assets are in regions outside China.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	CloudSiemSuccessResponse
Data	object	The return value of the request.
DiplayLine	string	The detailed information about the SLS log.	cn-shanghai.siem-project.siem-logstore
SourceProdCode	string	The code of the product.	sas
SourceLogCode	string	The code of the log.	cloud_siem_aegis_proc
Displayed	boolean	Indicates whether the details of the log collection task are returned. Valid values:	0
Imported	boolean	Indicates whether the log is collected. Valid values:	0
MainUserId	integer	The ID of the Alibaba Cloud account that is used to purchase Threat Analysis.	123XXXXXXXXX
SubUserId	integer	The ID of the Alibaba Cloud account for which the logs are collected.	123XXXXXXXX
SubUserName	string	The name of the Alibaba Cloud account for which the logs are collected.	sas_account_xxx
RequestId	string	The ID of the request.	6276D891-***-55B2-87B9-74D413F7**

Examples

Success response

JSON format

{
  "Data": {
    "DiplayLine": "cn-shanghai.siem-project.siem-logstore",
    "SourceProdCode": "sas",
    "SourceLogCode": "cloud_siem_aegis_proc",
    "Displayed": true,
    "Imported": true,
    "MainUserId": 0,
    "SubUserId": 0,
    "SubUserName": "sas_account_xxx"
  },
  "RequestId": "6276D891-*****-55B2-87B9-74D413F7****"
}

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.