BatchClient (tencentcloud-sdk-java 3.1.129 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.batch.v20170312.BatchClient

public class BatchClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`BatchClient(Credential credential, String region)`
`BatchClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachInstancesResponse`	`AttachInstances(AttachInstancesRequest req)` 此接口可将已存在实例添加到计算环境中。实例需要满足如下条件： 1.实例不在批量计算系统中。 2.实例状态要求处于运行中。 3.支持预付费实例，按小时后付费实例，专享子机实例。不支持竞价实例。此接口会将加入到计算环境中的实例重设UserData和重装操作系统。
`CreateComputeEnvResponse`	`CreateComputeEnv(CreateComputeEnvRequest req)` 用于创建计算环境
`CreateCpmComputeEnvResponse`	`CreateCpmComputeEnv(CreateCpmComputeEnvRequest req)` 创建黑石计算环境
`CreateTaskTemplateResponse`	`CreateTaskTemplate(CreateTaskTemplateRequest req)` 用于创建任务模板
`DeleteComputeEnvResponse`	`DeleteComputeEnv(DeleteComputeEnvRequest req)` 用于删除计算环境
`DeleteJobResponse`	`DeleteJob(DeleteJobRequest req)` 用于删除作业记录。删除作业的效果相当于删除作业相关的所有信息。删除成功后，作业相关的所有信息都无法查询。待删除的作业必须处于完结状态，且其内部包含的所有任务实例也必须处于完结状态，否则会禁止操作。完结状态，是指处于 SUCCEED 或 FAILED 状态。
`DeleteTaskTemplatesResponse`	`DeleteTaskTemplates(DeleteTaskTemplatesRequest req)` 用于删除任务模板信息
`DescribeAvailableCvmInstanceTypesResponse`	`DescribeAvailableCvmInstanceTypes(DescribeAvailableCvmInstanceTypesRequest req)` 查看可用的CVM机型配置信息
`DescribeComputeEnvResponse`	`DescribeComputeEnv(DescribeComputeEnvRequest req)` 用于查询计算环境的详细信息
`DescribeComputeEnvActivitiesResponse`	`DescribeComputeEnvActivities(DescribeComputeEnvActivitiesRequest req)` 用于查询计算环境的活动信息
`DescribeComputeEnvCreateInfoResponse`	`DescribeComputeEnvCreateInfo(DescribeComputeEnvCreateInfoRequest req)` 查看计算环境的创建信息。
`DescribeComputeEnvCreateInfosResponse`	`DescribeComputeEnvCreateInfos(DescribeComputeEnvCreateInfosRequest req)` 用于查看计算环境创建信息列表，包括名称、描述、类型、环境参数、通知及期望节点数等。
`DescribeComputeEnvsResponse`	`DescribeComputeEnvs(DescribeComputeEnvsRequest req)` 用于查看计算环境列表
`DescribeCpmOsInfoResponse`	`DescribeCpmOsInfo(DescribeCpmOsInfoRequest req)` 创建黑石计算环境时，查询批量计算环境支持的黑石操作系统信息
`DescribeCvmZoneInstanceConfigInfosResponse`	`DescribeCvmZoneInstanceConfigInfos(DescribeCvmZoneInstanceConfigInfosRequest req)` 获取批量计算可用区机型配置信息
`DescribeInstanceCategoriesResponse`	`DescribeInstanceCategories(DescribeInstanceCategoriesRequest req)` 目前对CVM现有实例族分类，每一类包含若干实例族。该接口用于查询实例分类信息。
`DescribeJobResponse`	`DescribeJob(DescribeJobRequest req)` 用于查看一个作业的详细信息，包括内部任务（Task）和依赖（Dependence）信息。
`DescribeJobsResponse`	`DescribeJobs(DescribeJobsRequest req)` 用于查询若干个作业的概览信息
`DescribeJobSubmitInfoResponse`	`DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)` 用于查询指定作业的提交信息，其返回内容包括 JobId 和 SubmitJob 接口中作为输入参数的作业提交信息
`DescribeTaskResponse`	`DescribeTask(DescribeTaskRequest req)` 用于查询指定任务的详细信息，包括任务内部的任务实例信息。
`DescribeTaskLogsResponse`	`DescribeTaskLogs(DescribeTaskLogsRequest req)` 用于获取任务多个实例标准输出和标准错误日志。
`DescribeTaskTemplatesResponse`	`DescribeTaskTemplates(DescribeTaskTemplatesRequest req)` 用于查询任务模板信息
`DetachInstancesResponse`	`DetachInstances(DetachInstancesRequest req)` 将添加到计算环境中的实例从计算环境中移出。若是由批量计算自动创建的计算节点实例则不允许移出。
`ModifyComputeEnvResponse`	`ModifyComputeEnv(ModifyComputeEnvRequest req)` 用于修改计算环境属性
`ModifyTaskTemplateResponse`	`ModifyTaskTemplate(ModifyTaskTemplateRequest req)` 用于修改任务模板
`RetryJobsResponse`	`RetryJobs(RetryJobsRequest req)` 用于重试作业中失败的任务实例。当且仅当作业处于“FAILED”状态，支持重试操作。重试操作成功后，作业会按照“DAG”中指定的任务依赖关系，依次重试各个任务中失败的任务实例。任务实例的历史信息将被重置，如同首次运行一样，参与后续的调度和执行。
`SubmitJobResponse`	`SubmitJob(SubmitJobRequest req)` 用于提交一个作业
`TerminateComputeNodeResponse`	`TerminateComputeNode(TerminateComputeNodeRequest req)` 用于销毁计算节点。对于状态为CREATED、CREATION_FAILED、RUNNING和ABNORMAL的节点，允许销毁处理。
`TerminateComputeNodesResponse`	`TerminateComputeNodes(TerminateComputeNodesRequest req)` 用于批量销毁计算节点，不允许重复销毁同一个节点。
`TerminateJobResponse`	`TerminateJob(TerminateJobRequest req)` 用于终止作业。当作业处于“SUBMITTED”状态时，禁止终止操作；当作业处于“SUCCEED”状态时，终止操作不会生效。终止作业是一个异步过程。整个终止过程的耗时和任务总数成正比。终止的效果相当于所含的所有任务实例进行TerminateTaskInstance操作。具体效果和用法可参考TerminateTaskInstance。
`TerminateTaskInstanceResponse`	`TerminateTaskInstance(TerminateTaskInstanceRequest req)` 用于终止任务实例。对于状态已经为“SUCCEED”和“FAILED”的任务实例，不做处理。对于状态为“SUBMITTED”、“PENDING”、“RUNNABLE”的任务实例，状态将置为“FAILED”状态。对于状态为“STARTING”、“RUNNING”、“FAILED_INTERRUPTED”的任务实例，分区两种情况：如果未显示指定计算环境，会先销毁CVM服务器，然后将状态置为“FAILED”，具有一定耗时；如果指定了计算环境EnvId，任务实例状态置为“FAILED”，并重启执行该任务的CVM服务器，具有一定的耗时。对于状态为“FAILED_INTERRUPTED”的任务实例，终止操作实际成功之后，相关资源和配额才会释放。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BatchClient
```
public BatchClient(Credential credential,
                   String region)
```
  - BatchClient
```
public BatchClient(Credential credential,
                   String region,
                   ClientProfile profile)
```
- Method Detail
  - AttachInstances
```
public AttachInstancesResponse AttachInstances(AttachInstancesRequest req)
                                        throws TencentCloudSDKException
```
    此接口可将已存在实例添加到计算环境中。实例需要满足如下条件：
    1.实例不在批量计算系统中。
    2.实例状态要求处于运行中。
    3.支持预付费实例，按小时后付费实例，专享子机实例。不支持竞价实例。
    此接口会将加入到计算环境中的实例重设UserData和重装操作系统。
    
    Parameters:
    
    req - AttachInstancesRequest
    
    Returns:
    
    AttachInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateComputeEnv
```
public CreateComputeEnvResponse CreateComputeEnv(CreateComputeEnvRequest req)
                                          throws TencentCloudSDKException
```
    用于创建计算环境
    
    Parameters:
    
    req - CreateComputeEnvRequest
    
    Returns:
    
    CreateComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCpmComputeEnv
```
public CreateCpmComputeEnvResponse CreateCpmComputeEnv(CreateCpmComputeEnvRequest req)
                                                throws TencentCloudSDKException
```
    创建黑石计算环境
    
    Parameters:
    
    req - CreateCpmComputeEnvRequest
    
    Returns:
    
    CreateCpmComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTaskTemplate
```
public CreateTaskTemplateResponse CreateTaskTemplate(CreateTaskTemplateRequest req)
                                              throws TencentCloudSDKException
```
    用于创建任务模板
    
    Parameters:
    
    req - CreateTaskTemplateRequest
    
    Returns:
    
    CreateTaskTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteComputeEnv
```
public DeleteComputeEnvResponse DeleteComputeEnv(DeleteComputeEnvRequest req)
                                          throws TencentCloudSDKException
```
    用于删除计算环境
    
    Parameters:
    
    req - DeleteComputeEnvRequest
    
    Returns:
    
    DeleteComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteJob
```
public DeleteJobResponse DeleteJob(DeleteJobRequest req)
                            throws TencentCloudSDKException
```
    用于删除作业记录。删除作业的效果相当于删除作业相关的所有信息。删除成功后，作业相关的所有信息都无法查询。待删除的作业必须处于完结状态，且其内部包含的所有任务实例也必须处于完结状态，否则会禁止操作。完结状态，是指处于 SUCCEED 或 FAILED 状态。
    
    Parameters:
    
    req - DeleteJobRequest
    
    Returns:
    
    DeleteJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTaskTemplates
```
public DeleteTaskTemplatesResponse DeleteTaskTemplates(DeleteTaskTemplatesRequest req)
                                                throws TencentCloudSDKException
```
    用于删除任务模板信息
    
    Parameters:
    
    req - DeleteTaskTemplatesRequest
    
    Returns:
    
    DeleteTaskTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAvailableCvmInstanceTypes
```
public DescribeAvailableCvmInstanceTypesResponse DescribeAvailableCvmInstanceTypes(DescribeAvailableCvmInstanceTypesRequest req)
                                                                            throws TencentCloudSDKException
```
    查看可用的CVM机型配置信息
    
    Parameters:
    
    req - DescribeAvailableCvmInstanceTypesRequest
    
    Returns:
    
    DescribeAvailableCvmInstanceTypesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnv
```
public DescribeComputeEnvResponse DescribeComputeEnv(DescribeComputeEnvRequest req)
                                              throws TencentCloudSDKException
```
    用于查询计算环境的详细信息
    
    Parameters:
    
    req - DescribeComputeEnvRequest
    
    Returns:
    
    DescribeComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvActivities
```
public DescribeComputeEnvActivitiesResponse DescribeComputeEnvActivities(DescribeComputeEnvActivitiesRequest req)
                                                                  throws TencentCloudSDKException
```
    用于查询计算环境的活动信息
    
    Parameters:
    
    req - DescribeComputeEnvActivitiesRequest
    
    Returns:
    
    DescribeComputeEnvActivitiesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvCreateInfo
```
public DescribeComputeEnvCreateInfoResponse DescribeComputeEnvCreateInfo(DescribeComputeEnvCreateInfoRequest req)
                                                                  throws TencentCloudSDKException
```
    查看计算环境的创建信息。
    
    Parameters:
    
    req - DescribeComputeEnvCreateInfoRequest
    
    Returns:
    
    DescribeComputeEnvCreateInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvCreateInfos
```
public DescribeComputeEnvCreateInfosResponse DescribeComputeEnvCreateInfos(DescribeComputeEnvCreateInfosRequest req)
                                                                    throws TencentCloudSDKException
```
    用于查看计算环境创建信息列表，包括名称、描述、类型、环境参数、通知及期望节点数等。
    
    Parameters:
    
    req - DescribeComputeEnvCreateInfosRequest
    
    Returns:
    
    DescribeComputeEnvCreateInfosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeComputeEnvs
```
public DescribeComputeEnvsResponse DescribeComputeEnvs(DescribeComputeEnvsRequest req)
                                                throws TencentCloudSDKException
```
    用于查看计算环境列表
    
    Parameters:
    
    req - DescribeComputeEnvsRequest
    
    Returns:
    
    DescribeComputeEnvsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCpmOsInfo
```
public DescribeCpmOsInfoResponse DescribeCpmOsInfo(DescribeCpmOsInfoRequest req)
                                            throws TencentCloudSDKException
```
    创建黑石计算环境时，查询批量计算环境支持的黑石操作系统信息
    
    Parameters:
    
    req - DescribeCpmOsInfoRequest
    
    Returns:
    
    DescribeCpmOsInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCvmZoneInstanceConfigInfos
```
public DescribeCvmZoneInstanceConfigInfosResponse DescribeCvmZoneInstanceConfigInfos(DescribeCvmZoneInstanceConfigInfosRequest req)
                                                                              throws TencentCloudSDKException
```
    获取批量计算可用区机型配置信息
    
    Parameters:
    
    req - DescribeCvmZoneInstanceConfigInfosRequest
    
    Returns:
    
    DescribeCvmZoneInstanceConfigInfosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstanceCategories
```
public DescribeInstanceCategoriesResponse DescribeInstanceCategories(DescribeInstanceCategoriesRequest req)
                                                              throws TencentCloudSDKException
```
    目前对CVM现有实例族分类，每一类包含若干实例族。该接口用于查询实例分类信息。
    
    Parameters:
    
    req - DescribeInstanceCategoriesRequest
    
    Returns:
    
    DescribeInstanceCategoriesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJob
```
public DescribeJobResponse DescribeJob(DescribeJobRequest req)
                                throws TencentCloudSDKException
```
    用于查看一个作业的详细信息，包括内部任务（Task）和依赖（Dependence）信息。
    
    Parameters:
    
    req - DescribeJobRequest
    
    Returns:
    
    DescribeJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobSubmitInfo
```
public DescribeJobSubmitInfoResponse DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)
                                                    throws TencentCloudSDKException
```
    用于查询指定作业的提交信息，其返回内容包括 JobId 和 SubmitJob 接口中作为输入参数的作业提交信息
    
    Parameters:
    
    req - DescribeJobSubmitInfoRequest
    
    Returns:
    
    DescribeJobSubmitInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobs
```
public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req)
                                  throws TencentCloudSDKException
```
    用于查询若干个作业的概览信息
    
    Parameters:
    
    req - DescribeJobsRequest
    
    Returns:
    
    DescribeJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTask
```
public DescribeTaskResponse DescribeTask(DescribeTaskRequest req)
                                  throws TencentCloudSDKException
```
    用于查询指定任务的详细信息，包括任务内部的任务实例信息。
    
    Parameters:
    
    req - DescribeTaskRequest
    
    Returns:
    
    DescribeTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTaskLogs
```
public DescribeTaskLogsResponse DescribeTaskLogs(DescribeTaskLogsRequest req)
                                          throws TencentCloudSDKException
```
    用于获取任务多个实例标准输出和标准错误日志。
    
    Parameters:
    
    req - DescribeTaskLogsRequest
    
    Returns:
    
    DescribeTaskLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTaskTemplates
```
public DescribeTaskTemplatesResponse DescribeTaskTemplates(DescribeTaskTemplatesRequest req)
                                                    throws TencentCloudSDKException
```
    用于查询任务模板信息
    
    Parameters:
    
    req - DescribeTaskTemplatesRequest
    
    Returns:
    
    DescribeTaskTemplatesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetachInstances
```
public DetachInstancesResponse DetachInstances(DetachInstancesRequest req)
                                        throws TencentCloudSDKException
```
    将添加到计算环境中的实例从计算环境中移出。若是由批量计算自动创建的计算节点实例则不允许移出。
    
    Parameters:
    
    req - DetachInstancesRequest
    
    Returns:
    
    DetachInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyComputeEnv
```
public ModifyComputeEnvResponse ModifyComputeEnv(ModifyComputeEnvRequest req)
                                          throws TencentCloudSDKException
```
    用于修改计算环境属性
    
    Parameters:
    
    req - ModifyComputeEnvRequest
    
    Returns:
    
    ModifyComputeEnvResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTaskTemplate
```
public ModifyTaskTemplateResponse ModifyTaskTemplate(ModifyTaskTemplateRequest req)
                                              throws TencentCloudSDKException
```
    用于修改任务模板
    
    Parameters:
    
    req - ModifyTaskTemplateRequest
    
    Returns:
    
    ModifyTaskTemplateResponse
    
    Throws:
    
    TencentCloudSDKException
  - RetryJobs
```
public RetryJobsResponse RetryJobs(RetryJobsRequest req)
                            throws TencentCloudSDKException
```
    用于重试作业中失败的任务实例。当且仅当作业处于“FAILED”状态，支持重试操作。重试操作成功后，作业会按照“DAG”中指定的任务依赖关系，依次重试各个任务中失败的任务实例。任务实例的历史信息将被重置，如同首次运行一样，参与后续的调度和执行。
    
    Parameters:
    
    req - RetryJobsRequest
    
    Returns:
    
    RetryJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - SubmitJob
```
public SubmitJobResponse SubmitJob(SubmitJobRequest req)
                            throws TencentCloudSDKException
```
    用于提交一个作业
    
    Parameters:
    
    req - SubmitJobRequest
    
    Returns:
    
    SubmitJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateComputeNode
```
public TerminateComputeNodeResponse TerminateComputeNode(TerminateComputeNodeRequest req)
                                                  throws TencentCloudSDKException
```
    用于销毁计算节点。对于状态为CREATED、CREATION_FAILED、RUNNING和ABNORMAL的节点，允许销毁处理。
    
    Parameters:
    
    req - TerminateComputeNodeRequest
    
    Returns:
    
    TerminateComputeNodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateComputeNodes
```
public TerminateComputeNodesResponse TerminateComputeNodes(TerminateComputeNodesRequest req)
                                                    throws TencentCloudSDKException
```
    用于批量销毁计算节点，不允许重复销毁同一个节点。
    
    Parameters:
    
    req - TerminateComputeNodesRequest
    
    Returns:
    
    TerminateComputeNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateJob
```
public TerminateJobResponse TerminateJob(TerminateJobRequest req)
                                  throws TencentCloudSDKException
```
    用于终止作业。当作业处于“SUBMITTED”状态时，禁止终止操作；当作业处于“SUCCEED”状态时，终止操作不会生效。终止作业是一个异步过程。整个终止过程的耗时和任务总数成正比。终止的效果相当于所含的所有任务实例进行TerminateTaskInstance操作。具体效果和用法可参考TerminateTaskInstance。
    
    Parameters:
    
    req - TerminateJobRequest
    
    Returns:
    
    TerminateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateTaskInstance
```
public TerminateTaskInstanceResponse TerminateTaskInstance(TerminateTaskInstanceRequest req)
                                                    throws TencentCloudSDKException
```
    用于终止任务实例。对于状态已经为“SUCCEED”和“FAILED”的任务实例，不做处理。对于状态为“SUBMITTED”、“PENDING”、“RUNNABLE”的任务实例，状态将置为“FAILED”状态。对于状态为“STARTING”、“RUNNING”、“FAILED_INTERRUPTED”的任务实例，分区两种情况：如果未显示指定计算环境，会先销毁CVM服务器，然后将状态置为“FAILED”，具有一定耗时；如果指定了计算环境EnvId，任务实例状态置为“FAILED”，并重启执行该任务的CVM服务器，具有一定的耗时。对于状态为“FAILED_INTERRUPTED”的任务实例，终止操作实际成功之后，相关资源和配额才会释放。
    
    Parameters:
    
    req - TerminateTaskInstanceRequest
    
    Returns:
    
    TerminateTaskInstanceResponse
    
    Throws:
    
    TencentCloudSDKException

Class BatchClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

BatchClient

BatchClient

Method Detail

AttachInstances

CreateComputeEnv

CreateCpmComputeEnv

CreateTaskTemplate

DeleteComputeEnv

DeleteJob

DeleteTaskTemplates

DescribeAvailableCvmInstanceTypes

DescribeComputeEnv

DescribeComputeEnvActivities

DescribeComputeEnvCreateInfo

DescribeComputeEnvCreateInfos

DescribeComputeEnvs

DescribeCpmOsInfo

DescribeCvmZoneInstanceConfigInfos

DescribeInstanceCategories

DescribeJob

DescribeJobSubmitInfo

DescribeJobs

DescribeTask

DescribeTaskLogs

DescribeTaskTemplates

DetachInstances

ModifyComputeEnv

ModifyTaskTemplate

RetryJobs

SubmitJob

TerminateComputeNode

TerminateComputeNodes

TerminateJob

TerminateTaskInstance