tencent cloud

Batch Compute

Product Introduction
What's Batch?
Scenarios
Strengths
Glossary
Quota & Limits
Data Security
Purchase Guide
Getting Started
Preparation
Using CLI - Submit a Job
Using CLI - Compute Environment
Configuring a Job
Using Console
Console User Guide
Task Template Management
Job Management
User Guide
How to create images usable by BatchCompute
Windows Custom Images
Environment Variables
Entering COS & CFS Paths
Event Notice & Callback
Cloud Access Management
Command Line Interface
Preparation
Quick Start
Running Remote Package
Mapping Remote Storage
Use Cases
Building Cluster Using Compute Environment
Example: 3ds Max 2018 Rendering
Example: Deep Learning
API Documentation
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
SDK Documentation
Instructions
FAQs
Contact Us
Glossary
ドキュメントBatch Compute API Documentation Job-related APIsTerminateJob

TerminateJob

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-30 21:28:46

1. API Description

Domain name for API request: batch.intl.tencentcloudapi.com.

This API is used to terminate a job.
Termination is prohibited if a job is in the SUBMITTED state and does not take effect if it is in the SUCCEED state.
Job termination is an asynchronous process, and the time it takes to complete the entire process is directly proportional to the total number of tasks. The effect of terminating a job is equivalent to performing the TerminateTaskInstance operation on all the task instances contained in the job. For more information on the specific effect and usage, see TerminateTaskInstance.

A maximum of 2 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: TerminateJob.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
JobId Yes String Job ID

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Terminating a job

Input Example

https://batch.intl.tencentcloudapi.com/?Action=TerminateJob
&JobId=job-rybewp57
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "970e5a9f-2963-436c-8dad-4847360676f7"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter.JobIdMalformed Invalid job ID format.
ResourceInUse.Job The job is in use.
ResourceNotFound.Job The specified job does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.TerminateOperationWithEnvId This operation is prohibited for the task instances in the specified compute environment.
前の記事へ: RetryJobs次の記事へ: TerminateTaskInstance

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック