DocsICP FilingConsole
Documentation

DescribeAlertSource

Updated at:
Copy as MD
Product
My Favorites

Retrieves a list of alert sources.

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

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Level

array

No

The threat levels. Valid values:

  • serious: High

  • suspicious: Medium

  • remind: Low

["serious","suspicious","remind"]

string

No

A threat level. Valid values:

  • serious: High

  • suspicious: Medium

  • remind: Low

["remind","serious"]
StartTime

integer

No

The start of the query time range. The value is a UNIX timestamp in milliseconds.

1577808000000
EndTime

integer

No

The end of the query time range. The value is a UNIX timestamp in milliseconds.

1577808000000
RoleType

integer

No

The type of view. Valid values:

  • 0: View data for the current Alibaba Cloud account.

  • 1: View data for all accounts in the enterprise.

1
RoleFor

integer

No

The user ID of the member whose data you want to view. An administrator uses this parameter to view data from the perspective of a specific member.

113091674488****
RegionId

string

No

The region of the data management center for threat analysis. Select the data management center that corresponds to the region where your assets are located. Valid values:

  • cn-hangzhou: for assets in the Chinese mainland and Hong Kong (China).

  • ap-southeast-1: for assets in regions outside the Chinese mainland.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

BaseResponse<List>

Data

array<object>

The list of alert sources.

123456

object

SourceName

string

The name of the alert source.

sas
Source

string

The internal code for the alert source.

aliyun.siem.alert_datasource.sas
Modules

array

The list of modules.

string

A module.

alibaba_cloud_sas_cwpp
Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true
Code

integer

The status code of the response. A value of 200 indicates success.

200
Message

string

The response message.

success
RequestId

string

The request ID.

9AAA9ED9-78F4-5021-86DC-D51C7511****

Examples

Success response

JSON format

{
  "Data": [
    {
      "SourceName": "sas",
      "Source": "aliyun.siem.alert_datasource.sas",
      "Modules": [
        "alibaba_cloud_sas_cwpp"
      ]
    }
  ],
  "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.