Help Center/ DataArts Studio/ API Reference/ DataArts Factory APIs (V2)/ Job Development APIs/ Stopping a PatchData Instance
Updated on 2025-11-17 GMT+08:00
View PDF

Stopping a PatchData Instance

Function

This API is used to stop a specified PatchData instance. A PatchData instance can be stopped only when it is in running state.

URI

  • URI format

    POST /v2/{project_id}/factory/supplement-data/{instance_name}/stop

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

    instance_name

    Yes

    String

    PatchData instance name

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.
    NOTE:
    • You need to specify a workspace for multiple DataArts Studio instances.
    • This parameter is mandatory if no default workspace is available. If you do not set it, an error is reported.

X-Auth-Token

Yes

String

IAM Token

Minimum length: 0

Maximum length: 4096

Response Parameters

None

Example Request

POST /v2/62099355b894428e8916573ae635f1f9/factory/supplement-data/P_job_8002_203_aa/stop

Example Response

  • Success response

    HTTP status code 200

  • Failure response

    HTTP status code 400

    {
    "error_code": "DLF.0113",
    "error_msg": "The supplement [P_job_1000_20230821_1540182] does not exist."
}
Parent Topic: Job Development APIs