Deletes the deployment instance information of a job in a specified workspace and namespace based on the deployed job name.
Operation description
Deletes the deployment instance information of a job in a specified workspace and namespace based on the deployed job name. This operation is applicable to scenarios where you want to quickly locate job details by deployment identifier.
Try it now
Test
RAM authorization
Request syntax
DELETE /api/v2/namespaces/{namespace}/deployments/deleteDeployment/byName HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| namespace |
string |
Yes |
The namespace. |
default-namespace |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
Yes |
The workspace ID. |
710d6a64d8c34d |
| deploymentName |
string |
Yes |
The name of the deployed job, which is typically specified by the user when submitting the job. |
test |
The deploymentName may not be unique and duplicates are possible. The operation returns a list of all matching deployed job instances.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| requestId |
string |
The request ID. |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
Indicates whether the request was successful. |
True |
| httpCode |
integer |
The HTTP status code, which is always 200. Use the success field to determine whether the request was successful. |
200 |
| errorCode |
string |
The error code. This field is not empty when success is false, indicating a business error code. This field is empty when success is true. |
"" |
| errorMessage |
string |
The error message. This field is not empty when success is false, indicating a business error message. This field is empty when success is true. |
"" |
Examples
Success response
JSON format
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\""
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.