DescribeEntityInfo - 获取实体详情_云安全中心(Security Center)-阿里云帮助中心

获取实体详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeEntityInfo	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
EntityId	long	否	实体逻辑 ID。	12345
EntityIdentity	string	否	实体特征值，可以对处置实体进行模糊搜索。	test22.php
IncidentUuid	string	否	事件全局唯一 UUID。	85ea4241-798f-4684-a876-65d4f0c3****
SophonTaskId	string	否	SOAR 处置策略 ID。	577bbf90-a770-44a7-8154-586aa2d318fa
RoleType	integer	否	视图类型。 0：当前阿里云账号视图。 1：企业下所有账号的视图。	1
RoleFor	long	否	管理员切换成其他成员视角的用户 ID。	113091674488****
RegionId	string	否	威胁分析的数据管理中心所在地。您需要根据资产所在地域，选择管理中心所在地。取值： cn-hangzhou：资产属于中国内地与中国香港 ap-southeast-1：资产属于海外地域	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	BaseResponse
Data	object	请求返回值。
EntityId	long	实体逻辑 ID。	12345
EntityType	string	实体类型。取值： ip：ip domain：域名 url：url process：进程 file：文件 host：主机	ip
EntityInfo	object	实体信息。	{ location: "xian", net_connect_dir: "in", malware_type: "${aliyun.siem.sas.alert_tag.login_unusual_account}" }
TipInfo	object	威胁情报信息。	{ "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	请求是否成功。取值： true：成功 false：失败	true
Code	integer	请求状态码。	200
Message	string	请求返回消息。	success
RequestId	string	请求 ID。	9AAA9ED9-78F4-5021-86DC-D51C7511****

示例

正常返回示例

JSON格式

{
  "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****"
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	服务发生某些未知错误，请稍后再试

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-17	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情