All Products
Search
Document Center

Security Center:QueryIncidentVertexNodes

Last Updated:Nov 14, 2024

Queries the detailed information about an event node.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:QueryIncidentVertexNodesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VertexIdstringYes

The ID of the node that you want to query.

Note You can call the QueryIncidentTracingDetail operation to query the node ID.
d6d7738a34cc252219866d223c0093f8
VertexLabelstringYes

The node label. Valid values include but are not limited to:

  • process
  • file
  • alert
  • ip
  • domain
process
EdgeLabelListarrayNo

The types of the edges that you want to query.

EdgeLabelListstringNo

The type of the edge that you want to query. Valid values include but are not limited to:

  • process_exec_file: A process executes a file.
  • process_connect_ip: A process connects to an IP address.
  • domain_trgger_alert: A domain name triggers an alert.
file
OffsetlongNo

The page number. Valid values start from 1.

0
SizeintegerNo

The number of entries per page. Valid values start from 1.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

VertexNodesobject

The results that are returned.

VertexListarray<object>

The information about the node.

VertexListobject
Idstring

The ID of the node.

225
Namestring

The name of the node.

zabbix
Typestring

The type of the node. Valid values include but are not limited to:

  • process
  • file
  • alert
  • ip
  • domain
sys
Timestring

The time when the node was created.

1636081135
Timestamplong

The time when the node was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1645179073
Uuidstring

The UUID of the node.

02ca8614-ecdb-44d3-b3d0-158655080e4f
RuleIdstring

The ID of the rule based on which the node was created.

171
Propertiesstring

The properties of the node. The value is in the text format.

{\"bandWidth\":\"5120\",\"internetIp\":\"47.242.191.206\",\"changeReason\":\"EIP_BIND\",\"bindInstanceId\":\"eci-j6ci7lvci50rore7dkv8\",\"bindType\":\"EIP_ECS\"}
Propertyobject

The property of the node.

UpdateTimestring

The time when the node was updated.

2021-12-16T07:20:33.000Z
Aliuidstring

The ID of the Alibaba Cloud account to which the node belongs.

20973951
NeighborListarray<object>

The neighboring nodes of the node.

NeighborListobject
Typestring

The type of the neighboring node. Valid values include but are not limited to:

  • process
  • file
  • alert
  • ip
  • domain
elf
Countinteger

The number of neighboring nodes.

27
HasMoreboolean

Indicates whether more neighboring nodes exist. Valid values:

  • true
  • false
False
DisplayInfoarray<object>

The display information of the node.

DisplayInfoobject
Namestring

The display name of the property.

zabbix
Valuestring

The display value of the property.

cs-nacos
Langstring

The display language of the neighboring node. Valid values:

  • zh: Chinese.
  • en: English.
zh
EdgeListarray<object>

The edges that are returned.

EdgeListobject
StartIdstring

The ID of the start node for the edge.

52003
StartTypestring

The type of the start node for the edge. Valid values include but are not limited to:

  • process
  • file
  • alert
  • ip
  • domain
process
EndIdstring

The ID of the end node for the edge.

64002
EndTypestring

The type of the end node for the edge. Valid values include but are not limited to:

  • process
  • file
  • alert
  • ip
  • domain
file
Namestring

The name of the edge.

jdk
Typestring

The type of the edge.

cve
Timestring

The time when the edge was created.

2021-11-06 11:00:00
Timestamplong

The time when the edge was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1645168444
Aliuidstring

The ID of the Alibaba Cloud account to which the edge belongs.

20973951
Uuidstring

The UUID of the edge.

549237d6-86d1-47f6-9ffa-3f97da9e6b10
Originstring

The original name of the edge.

distribution
Propertiesstring

The properties of the edge. The value is in the text format.

{\"bandWidth\":\"7810048\",\"internetIp\":\"47.57.13.255\",\"changeReason\":\"MODIFY_SPEC\",\"bindInstanceId\":\"i-j6chvo01tle7qfnhewr3\",\"bindType\":\"EIP_ECS\"}
Propertyobject

The property of the edge.

ShowTypestring

The display type of the edge.

type
RuleIdstring

The ID of the rule based on which the edge was created.

368
UpdateTimestring

The time when the edge was updated.

2021-12-16T07:20:33.000Z
TypeNamestring

The type name of the edge.

weak_password
EntityTypeListarray<object>

The entities that are returned.

EntityTypeListobject
Idstring

The ID of the entity.

33926
Namestring

The name of the entity.

auto-test-policy-name
GmtCreatestring

The time when the entity was created.

2022-09-23T10:50Z
GmtModifiedstring

The time when the entity was updated.

1623317089000
Namespacestring

The namespace of the entity.

78
DisplayTemplatestring

The display template of the entity.

template1
DisplayColorstring

The display color of the entity.

red
SyncIdinteger

The synchronization ID of the entity.

3212024a-1816-46d5-b286-e5d5780fd778
CurrentVersionIdstring

The version of the entity.

993
DisplayIconstring

The display icon of the entity.

http://img.22222.com
DisplayOrderinteger

The display order of the entity.

01
TraceSuccessFlaginteger

Indicates whether the entity is traced. Valid values:

  • 1: The entity is traced.
  • 0: The entity fails to be traced.
true
IsVirtualNodeinteger

Indicates whether the entity is a virtual node.

true
RelationTypeListarray<object>

The relationships that are returned.

RelationTypeListobject
Idstring

The ID of the relationship.

9350
Namestring

The name of the relationship.

mongod
Directedinteger

The direction of the relationship. Valid values:

  • 1: forward.
  • 0: reverse.
in
GmtCreatestring

The time when the relationship was created.

2022-08-02T10:20Z
GmtModifiedstring

The time when the relationship was updated.

1637556498000
Namespacestring

The namespace of the relationship.

default
DisplayTemplatestring

The display template of the relationship.

template1
DisplayColorstring

The display color of the relationship.

red
SyncIdinteger

The synchronization ID of the relationship.

a45185c7-b1b8-4a49-b04a-d6bfa051ef0e
CurrentVersionIdstring

The version of the relationship.

1487
ShowTypestring

The display type of the relationship.

type1
DIsplayIconstring

The display icon of the relationship.

http://img.33.com
Langstring

The language of the content within the request. Valid values:

  • zh: Chinese
  • en: English
zh
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
RequestIdstring

The request ID.

ACF97412-FD09-4D1F-994F-34DF12BREF20

Examples

Sample success responses

JSONformat

{
  "VertexNodes": {
    "VertexList": [
      {
        "Id": "225",
        "Name": "zabbix",
        "Type": "sys",
        "Time": "1636081135",
        "Timestamp": 1645179073,
        "Uuid": "02ca8614-ecdb-44d3-b3d0-158655080e4f",
        "RuleId": "171",
        "Properties": "{\\\"bandWidth\\\":\\\"5120\\\",\\\"internetIp\\\":\\\"47.242.191.206\\\",\\\"changeReason\\\":\\\"EIP_BIND\\\",\\\"bindInstanceId\\\":\\\"eci-j6ci7lvci50rore7dkv8\\\",\\\"bindType\\\":\\\"EIP_ECS\\\"}",
        "Property": {
          "test": "test",
          "test2": 1
        },
        "UpdateTime": "2021-12-16T07:20:33.000Z",
        "Aliuid": "20973951",
        "NeighborList": [
          {
            "Type": "elf",
            "Count": 27,
            "HasMore": true
          }
        ],
        "DisplayInfo": [
          {
            "Name": "zabbix",
            "Value": "cs-nacos"
          }
        ],
        "Lang": "zh"
      }
    ],
    "EdgeList": [
      {
        "StartId": "52003",
        "StartType": "process",
        "EndId": "64002",
        "EndType": "file",
        "Name": "jdk",
        "Type": "cve",
        "Time": "2021-11-06 11:00:00",
        "Timestamp": 1645168444,
        "Aliuid": "20973951",
        "Uuid": "549237d6-86d1-47f6-9ffa-3f97da9e6b10",
        "Origin": "distribution",
        "Properties": "{\\\"bandWidth\\\":\\\"7810048\\\",\\\"internetIp\\\":\\\"47.57.13.255\\\",\\\"changeReason\\\":\\\"MODIFY_SPEC\\\",\\\"bindInstanceId\\\":\\\"i-j6chvo01tle7qfnhewr3\\\",\\\"bindType\\\":\\\"EIP_ECS\\\"}",
        "Property": {
          "test": "test",
          "test2": 1
        },
        "ShowType": "type",
        "RuleId": "368",
        "UpdateTime": "2021-12-16T07:20:33.000Z",
        "TypeName": "weak_password"
      }
    ],
    "EntityTypeList": [
      {
        "Id": "33926",
        "Name": "auto-test-policy-name",
        "GmtCreate": "2022-09-23T10:50Z",
        "GmtModified": "1623317089000",
        "Namespace": "78",
        "DisplayTemplate": "template1",
        "DisplayColor": "red",
        "SyncId": 0,
        "CurrentVersionId": "993",
        "DisplayIcon": "http://img.22222.com",
        "DisplayOrder": 1,
        "TraceSuccessFlag": 0,
        "IsVirtualNode": 0
      }
    ],
    "RelationTypeList": [
      {
        "Id": "9350",
        "Name": "mongod",
        "Directed": 0,
        "GmtCreate": "2022-08-02T10:20Z",
        "GmtModified": "1637556498000",
        "Namespace": "default",
        "DisplayTemplate": "template1",
        "DisplayColor": "red",
        "SyncId": 0,
        "CurrentVersionId": "1487",
        "ShowType": "type1",
        "DIsplayIcon": "http://img.33.com"
      }
    ],
    "Lang": "zh"
  },
  "Success": true,
  "RequestId": "ACF97412-FD09-4D1F-994F-34DF12BREF20"
}

Error codes

HTTP status codeError codeError messageDescription
400VertexNodesErrorGet vertex nodes error, please try again.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history