All Products
Search
Document Center

Security Center:DescribeTraceInfoDetail

Last Updated:Feb 20, 2024

Queries the trace information about alerts.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeTraceInfoDetailRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request. The value of this parameter is specified by the system.

127.0.0.1
LangstringNo

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

  • zh: Chinese
  • en: English
zh
VertexIdstringYes

The ID of the vertex. You can call the DescribeSuspEvents operation to query the ID.

cce1d28dxxxxxxxxxxxxxxxx
UuidstringYes

The UUID of the server.

1627f2d7-aaa2-4ed1-b07a-xxxxxxxxxxxxxx
TypestringYes

The type of the vertex. Set the value to SAS_INCIDENT.

SAS_INCIDENT
FromstringYes

The ID of the request source. Set the value to sas.

sas
IncidentTimelongNo

The timestamp of the detection. Unit: milliseconds.

1670555392000

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
RequestIdstring

The ID of the request.

24A20733-10A0-4AF6-BE6B-XXXXXXXXX
TraceInfoDetailobject

The details of the tracing diagram.

EdgeListobject []

An array that consists of the edges of the tracing diagram.

Typestring

The type of the edge of the tracing diagram.

trigger_file_alert
Timestring

The point in time.

2022-12-21 10:24:42
StartIdstring

The starting vertex ID of the edge of the tracing diagram.

02b4bf933c8e3bb8b9465eee502xxxxx
Countinteger

The number of times.

1
EndIdstring

The ending vertex ID of the edge of the tracing diagram.

a1d1fa39e5345dcef3f9712172cxxxxx
VertexListobject []

An array that consists of all vertexes of the tracing diagram.

Typestring

The type of the entity represented by the vertex.

file_path
Timestring

The point in time.

2022-12-21 10:24:42
Namestring

The name of the entity represented by the vertex.

/usr/local/tomcat
Idstring

The ID of the vertex.

a1d1fa39e5345dcef3f9712172xxxxxx
Countinteger

The number of times.

1
NeighborListobject []

An array that consists of the neighbor nodes.

Typestring

The type of the neighbor node. The value is fixed as alert.

alert
HasMoreboolean

Indicates whether one more page is returned.

False
Countinteger

The number of neighbor nodes.

1
EntityTypeListobject []

An array that consists of the metadata configurations of the vertex type.

DisplayColorstring

The rendering color of the vertex.

#fff
DbIdinteger

This parameter is deprecated.

Deprecated
DisplayTemplatestring

This parameter is deprecated.

[{"name":"${logtime}","value":"$!{time}"}]
DisplayIconstring

The icon style of the vertex.

https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png
Limitinteger

This parameter is deprecated.

Deprecated
GmtCreatelong

The timestamp when the vertex was created.

2022-10-09T11:47Z
Offsetinteger

This parameter is deprecated.

Deprecated
Namespacestring

The namespace.

*
Namestring

The name of the vertex type.

Alert
GmtModifiedlong

The time when the vertex was last modified.

2022-10-09T11:47Z
Idstring

The ID of the vertex type.

Alert
RelationTypeListobject []

An array that consists of the metadata configurations of the edge type.

ShowTypestring

This parameter is deprecated.

Deprecated
DisplayColorstring

The rendering color of the edge.

#fff
Namestring

The name of the edge type.

file
Directedinteger

Indicates whether the edge is a directional edge. Valid values:

  • 1: yes
  • 0: no
1
RelationTypeIdstring

The ID of the edge type.

netflow_to_process

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "24A20733-10A0-4AF6-BE6B-XXXXXXXXX",
  "TraceInfoDetail": {
    "EdgeList": [
      {
        "Type": "trigger_file_alert",
        "Time": "2022-12-21 10:24:42",
        "StartId": "02b4bf933c8e3bb8b9465eee502xxxxx",
        "Count": 1,
        "EndId": "a1d1fa39e5345dcef3f9712172cxxxxx"
      }
    ],
    "VertexList": [
      {
        "Type": "file_path",
        "Time": "2022-12-21 10:24:42",
        "Name": "/usr/local/tomcat",
        "Id": "a1d1fa39e5345dcef3f9712172xxxxxx",
        "Count": 1,
        "NeighborList": [
          {
            "Type": "alert",
            "HasMore": true,
            "Count": 1
          }
        ]
      }
    ],
    "EntityTypeList": [
      {
        "DisplayColor": "#fff",
        "DbId": 0,
        "DisplayTemplate": "[{\"name\":\"${logtime}\",\"value\":\"$!{time}\"}]",
        "DisplayIcon": "https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png",
        "Limit": 0,
        "GmtCreate": 0,
        "Offset": 0,
        "Namespace": "*",
        "Name": "Alert",
        "GmtModified": 0,
        "Id": "Alert"
      }
    ],
    "RelationTypeList": [
      {
        "ShowType": "Deprecated",
        "DisplayColor": "#fff",
        "Name": "file",
        "Directed": 1,
        "RelationTypeId": "netflow_to_process"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
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