DescribeEntityInfo - Security Center - Alibaba Cloud Documentation Center

Retrieves the details of an entity.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EntityId	integer	No	The logical ID of the entity.	12345
EntityIdentity	string	No	The feature value of the entity. You can perform a fuzzy search for the entity.	test22.php
IncidentUuid	string	No	The globally unique UUID of the event.	85ea4241-798f-4684-a876-65d4f0c3****
SophonTaskId	string	No	The ID of the SOAR response policy.	577bbf90-a770-44a7-8154-586aa2d318fa
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. The administrator can use this ID to switch to the view of this member.	113091674488****
RegionId	string	No	The region of the Data Management center. Select a region 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	BaseResponse
Data	object	The data returned.	123456
EntityId	integer	The logical ID of the entity.	12345
EntityType	string	The type of the entity. Valid values: ip: IP address domain: domain name url: URL process: process file: file host: host	ip
EntityInfo	object	The information about the entity.	{ location: "xian", net_connect_dir: "in", malware_type: "${aliyun.siem.sas.alert_tag.login_unusual_account}" }
TipInfo	object	The threat intelligence information.	{ "Ip": { "queryHot": "0", "country": "China", "province": "shanxi", "ip": "221.11.XX.XXX", "asn": "4837", "asn_label": "CHINAXXX-Backbone - CHINA UNICOM ChinaXXX Backbone, CN" } }
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 request.	200
Message	string	The message returned for the request.	success
RequestId	string	The request ID.	9AAA9ED9-78F4-5021-86DC-D51C7511****

Examples

Success response

JSON format

{
  "Data": {
    "EntityId": 12345,
    "EntityType": "ip",
    "EntityInfo": {
      "test": "test",
      "test2": 1
    },
    "TipInfo": {
      "Ip": {
        "queryHot": "0",
        "country": "China",
        "province": "shanxi",
        "ip": "221.11.XX.XXX",
        "asn": "4837",
        "asn_label": "CHINAXXX-Backbone - CHINA UNICOM ChinaXXX Backbone, CN"
      }
    }
  },
  "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.