DescribeLogFields - Security Center - Alibaba Cloud Documentation Center

Retrieves the list of configurable fields for custom rules.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LogType	string	No	The log source for the rule.	cloud_siem_aegis_sas_alert
LogSource	string	No	The log source for the rule.	cloud_siem_aegis_sas_alert
RoleType	integer	No	The view type. 0: The view of the current Alibaba Cloud account. 1: The view of all accounts in the enterprise.	1
RoleFor	integer	No	The user ID of the member whose view the administrator switches to.	113091674488****
RegionId	string	No	The region where the threat analysis Management Hub is located. Select the region of the Management Hub based on the region 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	PlainResponse<List>
Data	array<object>	The data returned.	123456
	object
FieldName	string	The name of the rule field.	activity_name
FieldDesc	string	The Medusa code for the field description.	sas.cloudsiem.prod.activity_name
LogCode	string	The log source to which the field belongs.	cloud_siem_aegis_sas_alert
ActivityName	string	The log type to which the field belongs.	HTTP_ACTIVITY
FieldType	string	The data type of the field. Valid values: varchar: string bigint: number	varchar
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	integer	The request status code.	200
Message	string	The message returned.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****

Examples

Success response

JSON format

{
  "Data": [
    {
      "FieldName": "activity_name",
      "FieldDesc": "sas.cloudsiem.prod.activity_name",
      "LogCode": "cloud_siem_aegis_sas_alert",
      "ActivityName": "HTTP_ACTIVITY",
      "FieldType": "varchar"
    }
  ],
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****"
}

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.