Dumping HyG Algorithm Results

Function

This API is used to dump the execution results of the algorithm (jobId) to OBS.

URI

POST /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id}/export-result

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name
job_id	Yes	String	Job ID of the algorithm task in the response result

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
exportPath	Yes	String	Dump path
obsParameters	Yes	String	OBS authentication parameters. For details, see Table 3.
erase	No	Boolean	Whether to delete the original job result after dumping. The value can be true or false. The default value is true, indicating that the job result is deleted and resources are released by default.

**Table 3** obsParameters parameter description
Parameter	Mandatory	Type	Description
accessKey	Yes	string	AK
secretKey	Yes	string	SK

Response Parameters

**Table 4** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code.
jobId	String	ID of an asynchronous job. This parameter is left blank if the request fails. NOTE: You can use the returned job ID to view the task execution status and obtain the algorithm return result. For details, see Querying Job Status on the Service Plane (1.0.0).

Example Request

Dumps algorithm results and returns the job ID.

POST /ges/v1.0/{project_id}/hyg/{graph_name}/jobs/{job_id}/export-result
{
    "exportPath": "demo_movie/",
    "erase":  true,
    "obsParameters": {
        "accessKey": "xxxx",
        "secretKey": "xxxx"
    }
}

SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200
{
    "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"
}

Status code: 400

Example response for a failed request

HttpStatusCode: 400
{
    "errorCode": "GES.8011",
    "errorMessage": "graph : movie2 is not exist"
}

Status Codes

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.