Updated on 2024-05-23 GMT+08:00

Community Evolution (temporal_graph)

Function

The community evolution algorithm generates a temporal graph that shows structure changes of a community over time.

Figure 1 Principle

URL

POST /ges/v1.0/{project_id}/graphs/{graph_name}/dynamicgraphs/action?action_id=execute-analysis

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

graph_name

Yes

String

Graph name

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

algorithmName

Yes

String

Algorithm name

dynamicRange

Yes

Object

Temporal parameters

parameters

Yes

String

Algorithm parameters

Table 3 dynamicRange parameters

Parameter

Mandatory

Type

Description

start

Yes

Date or integer

Start time of the temporal analysis. The start time must be earlier than the end time.

end

Yes

Date or integer

End time of the temporal analysis

time_props

Yes

Object

Time properties for the temporal analysis

Table 4 time_props parameters

Parameter

Mandatory

Type

Description

stime

Yes

String

Property name of the start time

etime

Yes

String

Property name of the end time

Table 5 parameters parameter description

Parameter

Mandatory

Type

Description

source

Yes

String

Vertices in the community network. You can specify a maximum of 100,000 vertices.

temporal_vertex

No

Boolean

Whether to perform community evolution on a node. The default value is false.

Response Parameters

Table 6 Parameters in a response

Parameter

Type

Description

errorMessage

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

errorCode

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

jobId

String

ID of the edge query job

NOTE:

You can view the job execution status and obtain the return result by querying the job ID. For details, see Job Management APIs.

jobType

String

Type of an asynchronous job

Example Request

Observe the community evolution of some nodes. The algorithm name is temporal_graph, the start time of dynamic analysis is ${startTime}, and the end time is ${endTime}.

POST  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/dynamicgraphs/action?action_id=execute-analysis
{
  "algorithmName":"temporal_graph",
  "dynamicRange":{
    "start":"${startTime}",
    "end":"${endTime}",
    "time_props":{"stime":"${property(start_time)}","etime":"${property(start_time)}"}
  },
  "parameters":{
        "sources":[],
        "temporal_vertex":false
  }
}

Example Response

Status code: 200

Example response for a successful request

{
  "jobId": "f9987cab-64d3-4b3d-ac43-e91ae0c21bef168127124",
  "jobType": 0
}

Status code: 400

Example response for a failed request

{
"errorMessage":"${errorMessage}",
"errorCode":"GES.8301"
}

Status Code

Return Value

Description

400 Bad Request

Request error

401 Unauthorized

Authorization failed

403 Forbidden

No operation permissions

404 Not Found

No resources found

500 Internal Server Error

Internal server error

503 Service Unavailable

Service unavailable