Common Algorithm Parameters

Updated on 2024-12-03 GMT+08:00

View PDF

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
algorithmName	Yes	String	Algorithm name. For details, see the description of each algorithm.
parameters	No	Object	Algorithm parameters. For details, see the parameter description of each algorithm.
output	No	Object	Result output parameter. For details, see Table 2.
timeout	No	Integer	Timeout interval, in seconds NOTE: The max_clique and MCCIS algorithms do not support this parameter.

**Table 2** output parameter description
Parameter	Mandatory	Type	Description
format	No	String	Output format of the algorithm result. The options are JSON and TXT. The default value is JSON. For the TXT format, see Algorithm Results in TXT Format.
mode	No	String	Output mode of algorithm results. The options include FULL and TRUNCATED. The default value is TRUNCATED. FULL indicates that all algorithm results are output. In FULL mode, only the TXT format is supported. Algorithm results are written to the local directory of the nodes in the cluster. To access all results, you must utilize the export-result interface to write them to OBS. TRUNCATED indicates that algorithm results are truncated and then output. Currently, only the JSON format is supported.

Example Response

Algorithms are executed based on input parameters. You can call Querying Job Status and Execution Results to use the job_id returned by the algorithm to obtain the algorithm execution result.

Status code: 200

Example response for a successful request

{
    "data": {
   "outputs": {
           $response_data //Result of each algorithm. The results vary with the algorithm.
           "runtime": 1.365867,
           "data_return_size": 3,
           "data_offset": 0,
           "data_total_size": 100
    }
  },
  "status": "complete"
}

NOTE:

response_data indicates the result of each algorithm. The results vary with algorithms.

Status code: 400

Example response for a failed request

Http Status Code: 400
{
"errorMessage":"Running algorithm [XXXX] error: YYYYYYYYY!",
"errorCode":"GES.8301"
}

Parent topic: Algorithm API Parameter Reference

Previous topic: Algorithm API Parameter Reference

Next topic: PageRank

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot