Help Center/ ModelArts/ API Reference/ Training Management/ Obtaining the Path for Storing a Hyperparameter Sensitivity Analysis Image
Updated on 2026-07-24 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Path for Storing a Hyperparameter Sensitivity Analysis Image

Function

This API is used to obtain the path of the hyperparameter sensitivity analysis result image.

This API is used when you need to view the hyperparameter sensitivity analysis result of a training job. Before using this API, ensure that the training job exists, hyperparameter sensitivity analysis has been completed, and you have the permission to view the training job. The response message body of the API contains the image path. If the training job does not exist, hyperparameter sensitivity analysis is not performed, or you do not have the required permission, the API will return an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    modelarts:trainJob:get

    Read

    trainJob *

    g:ResourceTag/<tag-key>

    -

    -

    -

    • modelarts:poolType

    • modelarts:poolId

URI

GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-analysis/{parameter_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

parameter_name

Yes

String

Definition: Search parameter name.

Constraints: N/A

Range: N/A

Default Value: N/A

project_id

Yes

String

Definition: Project ID. For details, see Obtaining a Project ID and Name.

Constraints: N/A

Range: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value: N/A

training_job_id

Yes

String

Definition: Training job ID. For details, see Obtaining Training Jobs.

Constraints: N/A

Range: N/A

Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

file_path

String

Definition: Path for storing the hyperparameter sensitivity analysis image.

Range: N/A

Example Requests

The following shows how to query the path for storing the sensitivity analysis image of hyperparameter batch_size in the yperparameter sensitivity analysis results of the job whose training_job_id is e346206c-6fde-4c33-9dcd-55be17858ceb.

GET https://{endpoint}/v2/{project_id}/training-jobs/e346206c-6fde-4c33-9dcd-55be17858ceb/autosearch-parameter-analysis/batch_size

Example Responses

Status code: 200

ok

{
  "file_path" : "/test-wrk/autosearch-test/output/log/hyperparameter-analysis/fanova/batch_size.png"
}

Status Codes

Status Code

Description

200

ok

Error Codes

See Error Codes.

Parent topic: Training Management