BatchClient (tencentcloud-sdk-java-intl-en 3.0.488 API)

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

public class BatchClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明
`BatchClient(Credential credential, String region)`
`BatchClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`AttachInstancesResponse`	`AttachInstances(AttachInstancesRequest req)` This API is used to add existing instances to the compute environment.
`CreateComputeEnvResponse`	`CreateComputeEnv(CreateComputeEnvRequest req)` This API is used to create a compute environment.
`CreateTaskTemplateResponse`	`CreateTaskTemplate(CreateTaskTemplateRequest req)` This API is used to create a task template.
`DeleteComputeEnvResponse`	`DeleteComputeEnv(DeleteComputeEnvRequest req)` This API is used to delete a compute environment.
`DeleteJobResponse`	`DeleteJob(DeleteJobRequest req)` This API is used to delete a job.
`DeleteTaskTemplatesResponse`	`DeleteTaskTemplates(DeleteTaskTemplatesRequest req)` This API is used to delete task template information.
`DescribeAvailableCvmInstanceTypesResponse`	`DescribeAvailableCvmInstanceTypes(DescribeAvailableCvmInstanceTypesRequest req)` This API is used to view the information of available CVM model configurations.
`DescribeComputeEnvResponse`	`DescribeComputeEnv(DescribeComputeEnvRequest req)` This API is used to query compute environment details.
`DescribeComputeEnvActivitiesResponse`	`DescribeComputeEnvActivities(DescribeComputeEnvActivitiesRequest req)` This API is used to query the information of activities in the compute environment.
`DescribeComputeEnvCreateInfoResponse`	`DescribeComputeEnvCreateInfo(DescribeComputeEnvCreateInfoRequest req)` Views compute environment creation information.
`DescribeComputeEnvCreateInfosResponse`	`DescribeComputeEnvCreateInfos(DescribeComputeEnvCreateInfosRequest req)` This API is used to view the list of information of compute environment creation, including name, description, type, environment parameters, notifications, and number of desired nodes.
`DescribeComputeEnvsResponse`	`DescribeComputeEnvs(DescribeComputeEnvsRequest req)` This API is used to view the list of compute environments.
`DescribeCvmZoneInstanceConfigInfosResponse`	`DescribeCvmZoneInstanceConfigInfos(DescribeCvmZoneInstanceConfigInfosRequest req)` This API is used to get the model configuration information of the availability zone of BatchCompute.
`DescribeInstanceCategoriesResponse`	`DescribeInstanceCategories(DescribeInstanceCategoriesRequest req)` Currently, CVM instance families are classified into different category, and each category contains several instance families.
`DescribeJobResponse`	`DescribeJob(DescribeJobRequest req)` This API is used to view the details of a job, including internal task (Task) and dependency (Dependence) information.
`DescribeJobsResponse`	`DescribeJobs(DescribeJobsRequest req)` This API is used to query the overview information of several instances.
`DescribeJobSubmitInfoResponse`	`DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)` This API is used to query the submission information of the specified job, with the return including the job submission information used as input parameters in the JobId and SubmitJob APIs.
`DescribeTaskResponse`	`DescribeTask(DescribeTaskRequest req)` This API is used to query the details of a specified task, including information of the task instances inside the task.
`DescribeTaskLogsResponse`	`DescribeTaskLogs(DescribeTaskLogsRequest req)` This API is used to get the standard outputs and standard error logs of multiple task instances.
`DescribeTaskTemplatesResponse`	`DescribeTaskTemplates(DescribeTaskTemplatesRequest req)` This API is used to query the information of task templates.
`DetachInstancesResponse`	`DetachInstances(DetachInstancesRequest req)` This API is used to remove instances that from compute environment.
`ModifyComputeEnvResponse`	`ModifyComputeEnv(ModifyComputeEnvRequest req)` This API is used to modify the attributes of a compute environment.
`ModifyTaskTemplateResponse`	`ModifyTaskTemplate(ModifyTaskTemplateRequest req)` This API is used to modify a task template.
`RetryJobsResponse`	`RetryJobs(RetryJobsRequest req)` This API is used to retry the failing task instance in instances.
`TerminateComputeNodeResponse`	`TerminateComputeNode(TerminateComputeNodeRequest req)` This API is used to terminate a compute node.
`TerminateComputeNodesResponse`	`TerminateComputeNodes(TerminateComputeNodesRequest req)` This API is used to terminate compute nodes in batches.
`TerminateJobResponse`	`TerminateJob(TerminateJobRequest req)` This API is used to terminate an instance.
`TerminateTaskInstanceResponse`	`TerminateTaskInstance(TerminateTaskInstanceRequest req)` This API is used to terminate a task instance.

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - BatchClient
```
public BatchClient(Credential credential,
                   String region)
```
  - BatchClient
```
public BatchClient(Credential credential,
                   String region,
                   ClientProfile profile)
```
- 方法详细资料
  - AttachInstances
```
public AttachInstancesResponse AttachInstances(AttachInstancesRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to add existing instances to the compute environment. Considerations:
    1. The instance should not be in the batch compute system.
    2. The instance status should be 'running'.
    3. It supports dedicated CVMs and pay-as-you-go instances that billed on an hourly basis. Spot instances are not supported. For instances added to the compute environment, their UserData will be reset and the operating systems will be reinstalled.
    
    参数:
    
    req - AttachInstancesRequest
    
    返回:
    
    AttachInstancesResponse
    
    抛出:
    
    TencentCloudSDKException
  CreateComputeEnv
  
  public CreateComputeEnvResponse CreateComputeEnv(CreateComputeEnvRequest req) throws TencentCloudSDKException
  
  This API is used to create a compute environment.
  
  参数:
  
  req - CreateComputeEnvRequest
  
  返回:
  
  CreateComputeEnvResponse
  
  抛出:
  
  TencentCloudSDKException
  
  CreateTaskTemplate
  
  public CreateTaskTemplateResponse CreateTaskTemplate(CreateTaskTemplateRequest req) throws TencentCloudSDKException
  
  This API is used to create a task template.
  
  参数:
  
  req - CreateTaskTemplateRequest
  
  返回:
  
  CreateTaskTemplateResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DeleteComputeEnv
  
  public DeleteComputeEnvResponse DeleteComputeEnv(DeleteComputeEnvRequest req) throws TencentCloudSDKException
  
  This API is used to delete a compute environment.
  
  参数:
  
  req - DeleteComputeEnvRequest
  
  返回:
  
  DeleteComputeEnvResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DeleteJob
  
  public DeleteJobResponse DeleteJob(DeleteJobRequest req) throws TencentCloudSDKException
  
  This API is used to delete a job. Deleting a job is equivalent to deleting all the information related to the job. After successful deletion, all information related to the job cannot be queried. The job to be deleted must be in a completed state, and all task instances contained in it must also be in a completed state; otherwise, the operation will be prohibited. The completed state can be either SUCCEED or FAILED.
  
  参数:
  
  req - DeleteJobRequest
  
  返回:
  
  DeleteJobResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DeleteTaskTemplates
  
  public DeleteTaskTemplatesResponse DeleteTaskTemplates(DeleteTaskTemplatesRequest req) throws TencentCloudSDKException
  
  This API is used to delete task template information.
  
  参数:
  
  req - DeleteTaskTemplatesRequest
  
  返回:
  
  DeleteTaskTemplatesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeAvailableCvmInstanceTypes
  
  public DescribeAvailableCvmInstanceTypesResponse DescribeAvailableCvmInstanceTypes(DescribeAvailableCvmInstanceTypesRequest req) throws TencentCloudSDKException
  
  This API is used to view the information of available CVM model configurations.
  
  参数:
  
  req - DescribeAvailableCvmInstanceTypesRequest
  
  返回:
  
  DescribeAvailableCvmInstanceTypesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeComputeEnv
  
  public DescribeComputeEnvResponse DescribeComputeEnv(DescribeComputeEnvRequest req) throws TencentCloudSDKException
  
  This API is used to query compute environment details.
  
  参数:
  
  req - DescribeComputeEnvRequest
  
  返回:
  
  DescribeComputeEnvResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeComputeEnvActivities
  
  public DescribeComputeEnvActivitiesResponse DescribeComputeEnvActivities(DescribeComputeEnvActivitiesRequest req) throws TencentCloudSDKException
  
  This API is used to query the information of activities in the compute environment.
  
  参数:
  
  req - DescribeComputeEnvActivitiesRequest
  
  返回:
  
  DescribeComputeEnvActivitiesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeComputeEnvCreateInfo
  
  public DescribeComputeEnvCreateInfoResponse DescribeComputeEnvCreateInfo(DescribeComputeEnvCreateInfoRequest req) throws TencentCloudSDKException
  
  Views compute environment creation information.
  
  参数:
  
  req - DescribeComputeEnvCreateInfoRequest
  
  返回:
  
  DescribeComputeEnvCreateInfoResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeComputeEnvCreateInfos
  
  public DescribeComputeEnvCreateInfosResponse DescribeComputeEnvCreateInfos(DescribeComputeEnvCreateInfosRequest req) throws TencentCloudSDKException
  
  This API is used to view the list of information of compute environment creation, including name, description, type, environment parameters, notifications, and number of desired nodes.
  
  参数:
  
  req - DescribeComputeEnvCreateInfosRequest
  
  返回:
  
  DescribeComputeEnvCreateInfosResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeComputeEnvs
  
  public DescribeComputeEnvsResponse DescribeComputeEnvs(DescribeComputeEnvsRequest req) throws TencentCloudSDKException
  
  This API is used to view the list of compute environments.
  
  参数:
  
  req - DescribeComputeEnvsRequest
  
  返回:
  
  DescribeComputeEnvsResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeCvmZoneInstanceConfigInfos
  
  public DescribeCvmZoneInstanceConfigInfosResponse DescribeCvmZoneInstanceConfigInfos(DescribeCvmZoneInstanceConfigInfosRequest req) throws TencentCloudSDKException
  
  This API is used to get the model configuration information of the availability zone of BatchCompute.
  
  参数:
  
  req - DescribeCvmZoneInstanceConfigInfosRequest
  
  返回:
  
  DescribeCvmZoneInstanceConfigInfosResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeInstanceCategories
  
  public DescribeInstanceCategoriesResponse DescribeInstanceCategories(DescribeInstanceCategoriesRequest req) throws TencentCloudSDKException
  
  Currently, CVM instance families are classified into different category, and each category contains several instance families. This API is used to query the instance category information.
  
  参数:
  
  req - DescribeInstanceCategoriesRequest
  
  返回:
  
  DescribeInstanceCategoriesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeJob
  
  public DescribeJobResponse DescribeJob(DescribeJobRequest req) throws TencentCloudSDKException
  
  This API is used to view the details of a job, including internal task (Task) and dependency (Dependence) information.
  
  参数:
  
  req - DescribeJobRequest
  
  返回:
  
  DescribeJobResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeJobSubmitInfo
  
  public DescribeJobSubmitInfoResponse DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req) throws TencentCloudSDKException
  
  This API is used to query the submission information of the specified job, with the return including the job submission information used as input parameters in the JobId and SubmitJob APIs.
  
  参数:
  
  req - DescribeJobSubmitInfoRequest
  
  返回:
  
  DescribeJobSubmitInfoResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeJobs
  
  public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req) throws TencentCloudSDKException
  
  This API is used to query the overview information of several instances.
  
  参数:
  
  req - DescribeJobsRequest
  
  返回:
  
  DescribeJobsResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeTask
  
  public DescribeTaskResponse DescribeTask(DescribeTaskRequest req) throws TencentCloudSDKException
  
  This API is used to query the details of a specified task, including information of the task instances inside the task.
  
  参数:
  
  req - DescribeTaskRequest
  
  返回:
  
  DescribeTaskResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeTaskLogs
  
  public DescribeTaskLogsResponse DescribeTaskLogs(DescribeTaskLogsRequest req) throws TencentCloudSDKException
  
  This API is used to get the standard outputs and standard error logs of multiple task instances.
  
  参数:
  
  req - DescribeTaskLogsRequest
  
  返回:
  
  DescribeTaskLogsResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DescribeTaskTemplates
  
  public DescribeTaskTemplatesResponse DescribeTaskTemplates(DescribeTaskTemplatesRequest req) throws TencentCloudSDKException
  
  This API is used to query the information of task templates.
  
  参数:
  
  req - DescribeTaskTemplatesRequest
  
  返回:
  
  DescribeTaskTemplatesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  DetachInstances
  
  public DetachInstancesResponse DetachInstances(DetachInstancesRequest req) throws TencentCloudSDKException
  
  This API is used to remove instances that from compute environment.
  
  参数:
  
  req - DetachInstancesRequest
  
  返回:
  
  DetachInstancesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  ModifyComputeEnv
  
  public ModifyComputeEnvResponse ModifyComputeEnv(ModifyComputeEnvRequest req) throws TencentCloudSDKException
  
  This API is used to modify the attributes of a compute environment.
  
  参数:
  
  req - ModifyComputeEnvRequest
  
  返回:
  
  ModifyComputeEnvResponse
  
  抛出:
  
  TencentCloudSDKException
  
  ModifyTaskTemplate
  
  public ModifyTaskTemplateResponse ModifyTaskTemplate(ModifyTaskTemplateRequest req) throws TencentCloudSDKException
  
  This API is used to modify a task template.
  
  参数:
  
  req - ModifyTaskTemplateRequest
  
  返回:
  
  ModifyTaskTemplateResponse
  
  抛出:
  
  TencentCloudSDKException
  
  RetryJobs
  
  public RetryJobsResponse RetryJobs(RetryJobsRequest req) throws TencentCloudSDKException
  
  This API is used to retry the failing task instance in instances. Job retry is supported only if a job is in the "FAILED" state. After the retry operation succeeds, the instance will retry the failing task instances in each task in turn according to the task dependencies specified in the "DAG". The history information of the task instances will be reset, the instances will participate in subsequent scheduling and execution as if they are run for the first time.
  
  参数:
  
  req - RetryJobsRequest
  
  返回:
  
  RetryJobsResponse
  
  抛出:
  
  TencentCloudSDKException
  
  TerminateComputeNode
  
  public TerminateComputeNodeResponse TerminateComputeNode(TerminateComputeNodeRequest req) throws TencentCloudSDKException
  
  This API is used to terminate a compute node. Termination is allowed for nodes in the CREATED, CREATION_FAILED, RUNNING or ABNORMAL state.
  
  参数:
  
  req - TerminateComputeNodeRequest
  
  返回:
  
  TerminateComputeNodeResponse
  
  抛出:
  
  TencentCloudSDKException
  
  TerminateComputeNodes
  
  public TerminateComputeNodesResponse TerminateComputeNodes(TerminateComputeNodesRequest req) throws TencentCloudSDKException
  
  This API is used to terminate compute nodes in batches. It is not allowed to repeatedly terminate the same node.
  
  参数:
  
  req - TerminateComputeNodesRequest
  
  返回:
  
  TerminateComputeNodesResponse
  
  抛出:
  
  TencentCloudSDKException
  
  TerminateJob
  
  public TerminateJobResponse TerminateJob(TerminateJobRequest req) throws TencentCloudSDKException
  
  This API is used to terminate an instance. Termination is prohibited if an instance is in the "SUBMITTED" state and does not take effect if it is in the "SUCCEED" state. Instance 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 an instance 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.
  
  参数:
  
  req - TerminateJobRequest
  
  返回:
  
  TerminateJobResponse
  
  抛出:
  
  TencentCloudSDKException
  
  TerminateTaskInstance
  
  public TerminateTaskInstanceResponse TerminateTaskInstance(TerminateTaskInstanceRequest req) throws TencentCloudSDKException
  
  This API is used to terminate a task instance. Task instances in the "SUCCEED" or "FAILED" state will not be processed. Task instances in the "SUBMITTED", "PENDING", or "RUNNABLE" state will be set to the "FAILED" state. For task instances in the "STARTING", "RUNNING", or "FAILED_INTERRUPTED" state, there will be two cases: if no compute environment is specified, the CVM instance will be terminated first, and then the state will be set to "FAILED"; if a compute environment's EnvId is specified, the state of the task instances will be set to "FAILED" first, and then the CVM instance that performs the task will be restarted. Both cases takes a certain amount of time to be completed. For task instances in the "FAILED_INTERRUPTED" state, the related resources and quotas will be released only after the termination actually succeeds.
  
  参数:
  
  req - TerminateTaskInstanceRequest
  
  返回:
  
  TerminateTaskInstanceResponse
  
  抛出:
  
  TencentCloudSDKException

类 BatchClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

BatchClient

BatchClient

方法详细资料

AttachInstances

CreateComputeEnv

CreateTaskTemplate

DeleteComputeEnv

DeleteJob

DeleteTaskTemplates

DescribeAvailableCvmInstanceTypes

DescribeComputeEnv

DescribeComputeEnvActivities

DescribeComputeEnvCreateInfo

DescribeComputeEnvCreateInfos

DescribeComputeEnvs

DescribeCvmZoneInstanceConfigInfos

DescribeInstanceCategories

DescribeJob

DescribeJobSubmitInfo

DescribeJobs

DescribeTask

DescribeTaskLogs

DescribeTaskTemplates

DetachInstances

ModifyComputeEnv

ModifyTaskTemplate

RetryJobs

TerminateComputeNode

TerminateComputeNodes

TerminateJob

TerminateTaskInstance