ThpcClient (tencentcloud-sdk-java 3.1.1354 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.thpc.v20230321.ThpcClient

public class ThpcClient
extends AbstractClient

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddClusterStorageOptionResponse`	`AddClusterStorageOption(AddClusterStorageOptionRequest req)` 本接口（AddClusterStorageOption）用于添加集群存储选项信息。
`AddNodesResponse`	`AddNodes(AddNodesRequest req)` 本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。
`AddQueueResponse`	`AddQueue(AddQueueRequest req)` 本接口(AddQueue)用于添加队列到指定集群。本接口为目前只支持SchedulerType为SLURM的集群。单个集群中队列数量上限为10个。
`AttachNodesResponse`	`AttachNodes(AttachNodesRequest req)` 本接口 (AttachNodes) 用于绑定一个或者多个计算节点指定资源到指定集群中。
`CreateClusterResponse`	`CreateCluster(CreateClusterRequest req)` 本接口 (CreateCluster) 用于创建并启动集群。本接口为异步接口，当创建集群请求下发成功后会返回一个集群`ID`和一个`RequestId`，此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”，集群创建结果可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/1527/72100) 接口查询，如果集群状态(ClusterStatus)变为“RUNNING(运行中)”，则代表集群创建成功，“ INIT_FAILED”代表集群创建失败。
`CreateWorkspacesResponse`	`CreateWorkspaces(CreateWorkspacesRequest req)` 本接口 (CreateWorkspaces) 用于创建工作空间。
`DeleteClusterResponse`	`DeleteCluster(DeleteClusterRequest req)` 本接口（DeleteCluster）用于删除一个指定的集群。
`DeleteClusterStorageOptionResponse`	`DeleteClusterStorageOption(DeleteClusterStorageOptionRequest req)` 本接口 (DeleteClusterStorageOption) 用于删除集群存储选项信息。
`DeleteJobResponse`	`DeleteJob(DeleteJobRequest req)` 本接口 (DeleteJob) 用于删除一个作业任务。
`DeleteNodesResponse`	`DeleteNodes(DeleteNodesRequest req)` 本接口(DeleteNodes)用于删除指定集群中一个或者多个计算节点或者登录节点。
`DeleteQueueResponse`	`DeleteQueue(DeleteQueueRequest req)` 本接口(DeleteQueue)用于从指定集群删除队列。本接口为目前只支持SchedulerType为SLURM的集群。删除队列时，需要保证队列内不存在节点。
`DescribeAutoScalingConfigurationResponse`	`DescribeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest req)` 本接口(DescribeAutoScalingConfiguration)用于查询集群弹性伸缩配置信息。本接口仅适用于弹性伸缩类型为THPC_AS的集群。
`DescribeClusterActivitiesResponse`	`DescribeClusterActivities(DescribeClusterActivitiesRequest req)` 本接口（DescribeClusterActivities）用于查询集群活动历史记录列表。
`DescribeClustersResponse`	`DescribeClusters(DescribeClustersRequest req)` 本接口（DescribeClusters）用于查询集群列表。
`DescribeClusterStorageOptionResponse`	`DescribeClusterStorageOption(DescribeClusterStorageOptionRequest req)` 本接口 (DescribeClusterStorageOption) 用于查询集群存储选项信息。
`DescribeInitNodeScriptsResponse`	`DescribeInitNodeScripts(DescribeInitNodeScriptsRequest req)` 本接口 (DescribeInitNodeScripts) 用于查询节点初始化脚本列表。
`DescribeJobsResponse`	`DescribeJobs(DescribeJobsRequest req)` 本接口 (DescribeJobs) 用于查询作业任务列表信息。
`DescribeJobsOverviewResponse`	`DescribeJobsOverview(DescribeJobsOverviewRequest req)` 本接口 (DescribeJobs) 用于查询作业任务列表信息。
`DescribeJobSubmitInfoResponse`	`DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)` 本接口用于查询作业的提交信息。
`DescribeNodesResponse`	`DescribeNodes(DescribeNodesRequest req)` 本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。
`DescribeQueuesResponse`	`DescribeQueues(DescribeQueuesRequest req)` 本接口(DescribeQueues)用于查询指定集群队列概览信息列表。
`DescribeWorkspacesResponse`	`DescribeWorkspaces(DescribeWorkspacesRequest req)` 本接口（DescribeWorkspaces）用于查询工作空间列表。
`DetachNodesResponse`	`DetachNodes(DetachNodesRequest req)` 本接口 (DetachNodes) 用于将一个或者多个计算节点从集群中移除，但是不销毁指定计算资源。
`ModifyInitNodeScriptsResponse`	`ModifyInitNodeScripts(ModifyInitNodeScriptsRequest req)` 本接口 (ModifyInitNodeScripts) 用于修改节点初始化脚本。
`ModifyWorkspacesAttributeResponse`	`ModifyWorkspacesAttribute(ModifyWorkspacesAttributeRequest req)` 本接口 (ModifyWorkspacesAttribute) 用于修改工作空间的属性（目前只支持修改工作空间的名称）。
`ModifyWorkspacesRenewFlagResponse`	`ModifyWorkspacesRenewFlag(ModifyWorkspacesRenewFlagRequest req)` 本接口 (ModifyWorkspacesAttribute) 用于修改工作空间的属性（目前只支持修改工作空间的名称）。
`SetAutoScalingConfigurationResponse`	`SetAutoScalingConfiguration(SetAutoScalingConfigurationRequest req)` 本接口(SetAutoScalingConfiguration)用于为集群设置集群弹性伸缩配置信息。
`SubmitJobResponse`	`SubmitJob(SubmitJobRequest req)` 本接口 (SubmitJob) 用于提交一个作业任务。
`TerminateJobResponse`	`TerminateJob(TerminateJobRequest req)` 本接口 (TerminateJob) 用于终止一个作业任务。
`TerminateWorkspacesResponse`	`TerminateWorkspaces(TerminateWorkspacesRequest req)` 本接口 (TerminateWorkspaces) 用于主动退还工作空间。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

- Constructor Detail
  - ThpcClient
```
public ThpcClient(Credential credential,
                  String region)
```
  - ThpcClient
```
public ThpcClient(Credential credential,
                  String region,
                  ClientProfile profile)
```
- Method Detail
  - AddClusterStorageOption
```
public AddClusterStorageOptionResponse AddClusterStorageOption(AddClusterStorageOptionRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（AddClusterStorageOption）用于添加集群存储选项信息。
    
    Parameters:
    
    req - AddClusterStorageOptionRequest
    
    Returns:
    
    AddClusterStorageOptionResponse
    
    Throws:
    
    TencentCloudSDKException
  - AddNodes
```
public AddNodesResponse AddNodes(AddNodesRequest req)
                          throws TencentCloudSDKException
```
    本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。
    
    Parameters:
    
    req - AddNodesRequest
    
    Returns:
    
    AddNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - AddQueue
```
public AddQueueResponse AddQueue(AddQueueRequest req)
                          throws TencentCloudSDKException
```
    本接口(AddQueue)用于添加队列到指定集群。本接口为目前只支持SchedulerType为SLURM的集群。单个集群中队列数量上限为10个。
    
    Parameters:
    
    req - AddQueueRequest
    
    Returns:
    
    AddQueueResponse
    
    Throws:
    
    TencentCloudSDKException
  - AttachNodes
```
public AttachNodesResponse AttachNodes(AttachNodesRequest req)
                                throws TencentCloudSDKException
```
    本接口 (AttachNodes) 用于绑定一个或者多个计算节点指定资源到指定集群中。
    
    Parameters:
    
    req - AttachNodesRequest
    
    Returns:
    
    AttachNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateCluster
```
public CreateClusterResponse CreateCluster(CreateClusterRequest req)
                                    throws TencentCloudSDKException
```
    本接口 (CreateCluster) 用于创建并启动集群。本接口为异步接口，当创建集群请求下发成功后会返回一个集群`ID`和一个`RequestId`，此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”，集群创建结果可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/1527/72100) 接口查询，如果集群状态(ClusterStatus)变为“RUNNING(运行中)”，则代表集群创建成功，“ INIT_FAILED”代表集群创建失败。
    
    Parameters:
    
    req - CreateClusterRequest
    
    Returns:
    
    CreateClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateWorkspaces
```
public CreateWorkspacesResponse CreateWorkspaces(CreateWorkspacesRequest req)
                                          throws TencentCloudSDKException
```
    本接口 (CreateWorkspaces) 用于创建工作空间。
    
    Parameters:
    
    req - CreateWorkspacesRequest
    
    Returns:
    
    CreateWorkspacesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteCluster
```
public DeleteClusterResponse DeleteCluster(DeleteClusterRequest req)
                                    throws TencentCloudSDKException
```
    本接口（DeleteCluster）用于删除一个指定的集群。
    
    Parameters:
    
    req - DeleteClusterRequest
    
    Returns:
    
    DeleteClusterResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteClusterStorageOption
```
public DeleteClusterStorageOptionResponse DeleteClusterStorageOption(DeleteClusterStorageOptionRequest req)
                                                              throws TencentCloudSDKException
```
    本接口 (DeleteClusterStorageOption) 用于删除集群存储选项信息。
    
    Parameters:
    
    req - DeleteClusterStorageOptionRequest
    
    Returns:
    
    DeleteClusterStorageOptionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteJob
```
public DeleteJobResponse DeleteJob(DeleteJobRequest req)
                            throws TencentCloudSDKException
```
    本接口 (DeleteJob) 用于删除一个作业任务。
    
    Parameters:
    
    req - DeleteJobRequest
    
    Returns:
    
    DeleteJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteNodes
```
public DeleteNodesResponse DeleteNodes(DeleteNodesRequest req)
                                throws TencentCloudSDKException
```
    本接口(DeleteNodes)用于删除指定集群中一个或者多个计算节点或者登录节点。
    
    Parameters:
    
    req - DeleteNodesRequest
    
    Returns:
    
    DeleteNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteQueue
```
public DeleteQueueResponse DeleteQueue(DeleteQueueRequest req)
                                throws TencentCloudSDKException
```
    本接口(DeleteQueue)用于从指定集群删除队列。本接口为目前只支持SchedulerType为SLURM的集群。删除队列时，需要保证队列内不存在节点。
    
    Parameters:
    
    req - DeleteQueueRequest
    
    Returns:
    
    DeleteQueueResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAutoScalingConfiguration
```
public DescribeAutoScalingConfigurationResponse DescribeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest req)
                                                                          throws TencentCloudSDKException
```
    本接口(DescribeAutoScalingConfiguration)用于查询集群弹性伸缩配置信息。本接口仅适用于弹性伸缩类型为THPC_AS的集群。
    
    Parameters:
    
    req - DescribeAutoScalingConfigurationRequest
    
    Returns:
    
    DescribeAutoScalingConfigurationResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterActivities
```
public DescribeClusterActivitiesResponse DescribeClusterActivities(DescribeClusterActivitiesRequest req)
                                                            throws TencentCloudSDKException
```
    本接口（DescribeClusterActivities）用于查询集群活动历史记录列表。
    
    Parameters:
    
    req - DescribeClusterActivitiesRequest
    
    Returns:
    
    DescribeClusterActivitiesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusterStorageOption
```
public DescribeClusterStorageOptionResponse DescribeClusterStorageOption(DescribeClusterStorageOptionRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口 (DescribeClusterStorageOption) 用于查询集群存储选项信息。
    
    Parameters:
    
    req - DescribeClusterStorageOptionRequest
    
    Returns:
    
    DescribeClusterStorageOptionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClusters
```
public DescribeClustersResponse DescribeClusters(DescribeClustersRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DescribeClusters）用于查询集群列表。
    
    Parameters:
    
    req - DescribeClustersRequest
    
    Returns:
    
    DescribeClustersResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInitNodeScripts
```
public DescribeInitNodeScriptsResponse DescribeInitNodeScripts(DescribeInitNodeScriptsRequest req)
                                                        throws TencentCloudSDKException
```
    本接口 (DescribeInitNodeScripts) 用于查询节点初始化脚本列表。
    
    Parameters:
    
    req - DescribeInitNodeScriptsRequest
    
    Returns:
    
    DescribeInitNodeScriptsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobSubmitInfo
```
public DescribeJobSubmitInfoResponse DescribeJobSubmitInfo(DescribeJobSubmitInfoRequest req)
                                                    throws TencentCloudSDKException
```
    本接口用于查询作业的提交信息。
    
    Parameters:
    
    req - DescribeJobSubmitInfoRequest
    
    Returns:
    
    DescribeJobSubmitInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobs
```
public DescribeJobsResponse DescribeJobs(DescribeJobsRequest req)
                                  throws TencentCloudSDKException
```
    本接口 (DescribeJobs) 用于查询作业任务列表信息。
    
    Parameters:
    
    req - DescribeJobsRequest
    
    Returns:
    
    DescribeJobsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeJobsOverview
```
public DescribeJobsOverviewResponse DescribeJobsOverview(DescribeJobsOverviewRequest req)
                                                  throws TencentCloudSDKException
```
    本接口 (DescribeJobs) 用于查询作业任务列表信息。
    
    Parameters:
    
    req - DescribeJobsOverviewRequest
    
    Returns:
    
    DescribeJobsOverviewResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeNodes
```
public DescribeNodesResponse DescribeNodes(DescribeNodesRequest req)
                                    throws TencentCloudSDKException
```
    本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。
    
    Parameters:
    
    req - DescribeNodesRequest
    
    Returns:
    
    DescribeNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeQueues
```
public DescribeQueuesResponse DescribeQueues(DescribeQueuesRequest req)
                                      throws TencentCloudSDKException
```
    本接口(DescribeQueues)用于查询指定集群队列概览信息列表。
    
    Parameters:
    
    req - DescribeQueuesRequest
    
    Returns:
    
    DescribeQueuesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWorkspaces
```
public DescribeWorkspacesResponse DescribeWorkspaces(DescribeWorkspacesRequest req)
                                              throws TencentCloudSDKException
```
    本接口（DescribeWorkspaces）用于查询工作空间列表。
    
    Parameters:
    
    req - DescribeWorkspacesRequest
    
    Returns:
    
    DescribeWorkspacesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetachNodes
```
public DetachNodesResponse DetachNodes(DetachNodesRequest req)
                                throws TencentCloudSDKException
```
    本接口 (DetachNodes) 用于将一个或者多个计算节点从集群中移除，但是不销毁指定计算资源。
    
    Parameters:
    
    req - DetachNodesRequest
    
    Returns:
    
    DetachNodesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyInitNodeScripts
```
public ModifyInitNodeScriptsResponse ModifyInitNodeScripts(ModifyInitNodeScriptsRequest req)
                                                    throws TencentCloudSDKException
```
    本接口 (ModifyInitNodeScripts) 用于修改节点初始化脚本。
    
    Parameters:
    
    req - ModifyInitNodeScriptsRequest
    
    Returns:
    
    ModifyInitNodeScriptsResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyWorkspacesAttribute
```
public ModifyWorkspacesAttributeResponse ModifyWorkspacesAttribute(ModifyWorkspacesAttributeRequest req)
                                                            throws TencentCloudSDKException
```
    本接口 (ModifyWorkspacesAttribute) 用于修改工作空间的属性（目前只支持修改工作空间的名称）。
    
    Parameters:
    
    req - ModifyWorkspacesAttributeRequest
    
    Returns:
    
    ModifyWorkspacesAttributeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyWorkspacesRenewFlag
```
public ModifyWorkspacesRenewFlagResponse ModifyWorkspacesRenewFlag(ModifyWorkspacesRenewFlagRequest req)
                                                            throws TencentCloudSDKException
```
    本接口 (ModifyWorkspacesAttribute) 用于修改工作空间的属性（目前只支持修改工作空间的名称）。
    
    Parameters:
    
    req - ModifyWorkspacesRenewFlagRequest
    
    Returns:
    
    ModifyWorkspacesRenewFlagResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetAutoScalingConfiguration
```
public SetAutoScalingConfigurationResponse SetAutoScalingConfiguration(SetAutoScalingConfigurationRequest req)
                                                                throws TencentCloudSDKException
```
    本接口(SetAutoScalingConfiguration)用于为集群设置集群弹性伸缩配置信息。
    
    Parameters:
    
    req - SetAutoScalingConfigurationRequest
    
    Returns:
    
    SetAutoScalingConfigurationResponse
    
    Throws:
    
    TencentCloudSDKException
  - SubmitJob
```
public SubmitJobResponse SubmitJob(SubmitJobRequest req)
                            throws TencentCloudSDKException
```
    本接口 (SubmitJob) 用于提交一个作业任务。
    
    Parameters:
    
    req - SubmitJobRequest
    
    Returns:
    
    SubmitJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateJob
```
public TerminateJobResponse TerminateJob(TerminateJobRequest req)
                                  throws TencentCloudSDKException
```
    本接口 (TerminateJob) 用于终止一个作业任务。
    
    Parameters:
    
    req - TerminateJobRequest
    
    Returns:
    
    TerminateJobResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateWorkspaces
```
public TerminateWorkspacesResponse TerminateWorkspaces(TerminateWorkspacesRequest req)
                                                throws TencentCloudSDKException
```
    本接口 (TerminateWorkspaces) 用于主动退还工作空间。
    
    Parameters:
    
    req - TerminateWorkspacesRequest
    
    Returns:
    
    TerminateWorkspacesResponse
    
    Throws:
    
    TencentCloudSDKException

Class ThpcClient

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

ThpcClient

ThpcClient

Method Detail

AddClusterStorageOption

AddNodes

AddQueue

AttachNodes

CreateCluster

CreateWorkspaces

DeleteCluster

DeleteClusterStorageOption

DeleteJob

DeleteNodes

DeleteQueue

DescribeAutoScalingConfiguration

DescribeClusterActivities

DescribeClusterStorageOption

DescribeClusters

DescribeInitNodeScripts

DescribeJobSubmitInfo

DescribeJobs

DescribeJobsOverview

DescribeNodes

DescribeQueues

DescribeWorkspaces

DetachNodes

ModifyInitNodeScripts

ModifyWorkspacesAttribute

ModifyWorkspacesRenewFlag

SetAutoScalingConfiguration

SubmitJob

TerminateJob

TerminateWorkspaces