DescribeCloudSiemAssets - Security Center - Alibaba Cloud Documentation Center

Queries a list of assets that are associated with an event.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IncidentUuid	string	No	The UUID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
AssetType	string	No	The asset type. Valid values: ip: IP address domain: domain name url: URL process: process file: file host: host	ip
AssetName	string	No	The asset name.	test123
AssetUuid	string	No	The UUID of the asset.	123456-2222-3333-5555-3435345****
CurrentPage	integer	Yes	The page number. The value must be greater than or equal to 1.	1
PageSize	integer	Yes	The number of entries to return on each page. The maximum value is 100.	10
RoleType	integer	No	The view type. 0: The view of the current Alibaba Cloud account. 1: The view of all accounts that belong to the enterprise.	1
RoleFor	integer	No	The user ID of the member whose data you want to view. This parameter is available only when an administrator wants to switch to the perspective of a member.	113091674488****
RegionId	string	No	The region where the Data Management center of Threat Analysis is deployed. Select a region based on the region where your assets are located. Valid values: cn-hangzhou: assets in the Chinese mainland or China (Hong Kong) ap-southeast-1: assets outside China	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	PageResponse<List>
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	integer	The HTTP status code.	200
Message	string	The returned message.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	The data returned.	123456
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries.	100
ResponseData	array<object>	The detailed data.
	object
Id	integer	The asset ID.	123
GmtCreate	string	The time when the asset was synchronized.	2021-01-06 16:37:29
GmtModified	string	The time when the asset was last updated.	2021-01-06 16:37:29
Aliuid	integer	The ID of the Alibaba Cloud account.	1276085894174392
SubUserId	integer	The ID of the linked account.	176555323***
IncidentUuid	string	The UUID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
AlertUuid	string	The UUID of the alert that is associated with the event.	sas_71e24437d2797ce8fc59692905a4****
AssetName	string	The asset name.	zsw-agentless-centos****
AssetType	string	The asset type. Valid values: ip: IP address domain: domain name url: URL process: process file: file host: host	domain
AssetInfo	array<object>	The asset information, in a JSON array.	[{"KeyName": "${aliyun.siem.asset.asset_name}","Values": "zsw-agentless-ubuntu20","Key": "asset_name"}]
	object
Key	string	The key of the alert property.	suspicious.wbd.wb.trojanpath
KeyName	string	The name of the alert property.	Trojan Path
Values	string	The value of the alert property.	/root/test33.php
AssetId	string	The logical ID of the asset.	0616caeb-acb8-45e0-8520-4ee5fbe251f0
CloudCode	string	The cloud service provider of the entity. Valid values: aliyun: Alibaba Cloud qcloud: Tencent Cloud hcloud: Huawei Cloud	aliyun

Examples

Success response

JSON format

{
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
  "Data": {
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 10,
      "TotalCount": 100
    },
    "ResponseData": [
      {
        "Id": 123,
        "GmtCreate": "2021-01-06 16:37:29",
        "GmtModified": "2021-01-06 16:37:29",
        "Aliuid": 1276085894174392,
        "SubUserId": 0,
        "IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
        "AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
        "AssetName": "zsw-agentless-centos****",
        "AssetType": "domain",
        "AssetInfo": [
          {
            "Key": "suspicious.wbd.wb.trojanpath",
            "KeyName": "Trojan Path",
            "Values": "/root/test33.php"
          }
        ],
        "AssetId": "0616caeb-acb8-45e0-8520-4ee5fbe251f0",
        "CloudCode": "aliyun"
      }
    ]
  }
}

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.