DocsICP FilingConsole
Documentation

GetNormalizationRule

Updated at:
Copy as MD
Product
My Favorites

Retrieves normalization rule information.

Operation description

The request parameter JsonConfig contains highly complex JSON configurations. To help you configure it, we provide a utility class with specific configuration examples. For more information, refer to Demo.

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

get

*NormalizationRule

acs:yundun-sas::{#accountId}:normalizationrule/{#NormalizationRuleId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

No

The region where the data management center of Threat Analysis is located. You must select the region of the management center based on the region where your assets are located. Valid values:

  • cn-hangzhou: Assets are located in the Chinese mainland.

  • ap-southeast-1: Assets are located outside the Chinese mainland.

cn-hangzhou
Lang

string

No

The language of the response message. Valid values:

  • zh (default): Chinese.

  • en: English.

zh
RoleFor

integer

No

The ID of the user whose perspective the administrator switches to.

173326*******
NormalizationRuleId

string

No

The ID of the normalization rule.

nr-z0b2ssjteut85uoh9nzp
NormalizationSecurityDomainId

string

No

The ID of the normalization security domain.

NETWORK_AND_WEB_SECURITY

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The ID of the request.

6276D891-*****-55B2-87B9-74D413F7****
NormalizationRule

object

The normalization rule.

CreateTime

integer

The creation time. The value is a UNIX timestamp in milliseconds.

1733269771123
UpdateTime

integer

The update time. The value is a UNIX timestamp in milliseconds.

1733269771123
NormalizationRuleId

string

The ID of the normalization rule.

nr-z0b2ssjteut85uoh9nzp
NormalizationRuleName

string

The name of the normalization rule.

normalization_rule_Z57np
NormalizationRuleType

string

The type of the normalization rule. Valid values:

  • predefined: predefined normalization rule

  • custom: custom normalization rule

predefined
NormalizationRuleFormat

string

The format of the normalization rule.

SPL
NormalizationRuleDescription

string

The description of the normalization rule.

normalization_rule_Z57np
NormalizationRuleVersion

integer

The version of the normalization rule.

V1
NormalizationRuleExpression

string

The expression of the normalization rule.

* | pack-fields -include='[\s\S]+' as extend_content
NormalizationRuleStatus

string

The status of the normalization rule.

started
NormalizationCategoryId

string

The category ID of the normalization rule.

NETWORK_CATEGORY
NormalizationSchemaId

string

The ID of the normalization schema.

HTTP_ACTIVITY
NormalizationSecurityDomainId

string

The ID of the normalization security domain.

NETWORK_AND_WEB_SECURITY
VendorId

string

The ID of the vendor corresponding to the normalization rule.

alibaba_cloud
ProductId

string

The product ID.

alibaba_cloud_sas
NormalizationRuleMode

string

The mode of the normalization rule. Valid values:

  • both

  • scan

  • realtime

both
NormalizationFieldSource

string

The field source:

  • "native": raw logs

  • "normalized": normalized logs

normalized
ExtendContentPacked

string

Specifies whether to pack non-standard fields into the extended field extend_content. Valid values:

  • enabled: Enabled.

  • disabled: Disabled.

enabled
OrderField

string

The field used to sort the rule list. Valid values:

  • GmtModified: sort by modification time

  • Id: sort by rule ID (default)

GmtModified
NormalizationRuleIds

array

The IDs of the normalization rules.

string

The IDs of the normalization rules.

nr-z0b2ssjteut85uoh9nzp
ExtendFieldStoreMode

string

The storage mode for extended fields. Valid values: flat (ingest as-is), reject (do not ingest), and pack (pack into the extend_content field).

flat

Examples

Success response

JSON format

{
  "RequestId": "6276D891-*****-55B2-87B9-74D413F7****",
  "NormalizationRule": {
    "CreateTime": 1733269771123,
    "UpdateTime": 1733269771123,
    "NormalizationRuleId": "nr-z0b2ssjteut85uoh9nzp",
    "NormalizationRuleName": "normalization_rule_Z57np",
    "NormalizationRuleType": "predefined",
    "NormalizationRuleFormat": "SPL",
    "NormalizationRuleDescription": "normalization_rule_Z57np",
    "NormalizationRuleVersion": 0,
    "NormalizationRuleExpression": "* | pack-fields -include='[\\s\\S]+' as extend_content",
    "NormalizationRuleStatus": "started",
    "NormalizationCategoryId": "NETWORK_CATEGORY",
    "NormalizationSchemaId": "HTTP_ACTIVITY",
    "NormalizationSecurityDomainId": "NETWORK_AND_WEB_SECURITY",
    "VendorId": "alibaba_cloud",
    "ProductId": "alibaba_cloud_sas",
    "NormalizationRuleMode": "both",
    "NormalizationFieldSource": "normalized",
    "ExtendContentPacked": "enabled",
    "OrderField": "GmtModified",
    "NormalizationRuleIds": [
      "nr-z0b2ssjteut85uoh9nzp"
    ],
    "ExtendFieldStoreMode": "flat"
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.