Deleting a Training Job Configuration

Function

This API is used to delete a training job configuration.

URI

DELETE /v1/{project_id}/training-job-configs/{config_name}

Table 1 describes the required parameters.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

config_name

Yes

String

Name of a training job configuration

Request Body

None

Response Body

Table 2 describes the response parameters.

Table 2 Parameter description

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

error_message

String

Error message of a failed API call.

This parameter is not included when the API call succeeds.

error_code

String

Error code of a failed API call. For details, see Error Codes. This parameter is not included when the API call succeeds.

Samples

The following shows how to delete the job configuration named test-trainconfig.

  • Sample request

    DELETE    https://endpoint/v1/{project_id}/training-job-configs/test-trainconfig
    
  • Successful sample response

    {
        "is_success": true
    }
    
  • Failed sample response

    {
        "is_success": false,
        "error_message": "Error string",
        "error_code": "ModelArts.0105"
    }
    

Status Code

For details about the status code, see Table 1.

Error Codes

See Error Codes.