TsfClient (tencentcloud-sdk-java 3.0.78 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tsf.v20180326.TsfClient

public class TsfClient
extends AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`TsfClient(Credential credential, String region)` 构造client
`TsfClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddInstancesResponse`	`AddInstances(AddInstancesRequest req)` 添加云主机节点至TSF集群
`CreateApplicationResponse`	`CreateApplication(CreateApplicationRequest req)` 创建应用
`CreateClusterResponse`	`CreateCluster(CreateClusterRequest req)` 创建集群
`CreateContainGroupResponse`	`CreateContainGroup(CreateContainGroupRequest req)` 创建容器部署组
`CreateGroupResponse`	`CreateGroup(CreateGroupRequest req)` 创建容器部署组
`CreateMicroserviceResponse`	`CreateMicroservice(CreateMicroserviceRequest req)` 新增微服务
`CreateNamespaceResponse`	`CreateNamespace(CreateNamespaceRequest req)` 创建命名空间
`DeleteApplicationResponse`	`DeleteApplication(DeleteApplicationRequest req)` 删除应用
`DeleteContainerGroupResponse`	`DeleteContainerGroup(DeleteContainerGroupRequest req)` 删除容器部署组
`DeleteGroupResponse`	`DeleteGroup(DeleteGroupRequest req)` 删除容器部署组
`DeleteImageTagsResponse`	`DeleteImageTags(DeleteImageTagsRequest req)` 批量删除镜像版本
`DeleteMicroserviceResponse`	`DeleteMicroservice(DeleteMicroserviceRequest req)` 删除微服务
`DeleteNamespaceResponse`	`DeleteNamespace(DeleteNamespaceRequest req)` 删除命名空间
`DeletePkgsResponse`	`DeletePkgs(DeletePkgsRequest req)` 从软件仓库批量删除程序包。一次最多支持删除1000个包，数量超过1000，返回UpperDeleteLimit错误。
`DeployContainerGroupResponse`	`DeployContainerGroup(DeployContainerGroupRequest req)` 部署容器应用
`DeployGroupResponse`	`DeployGroup(DeployGroupRequest req)` 部署虚拟机部署组应用
`DescribeApplicationResponse`	`DescribeApplication(DescribeApplicationRequest req)` 获取应用详情
`DescribeApplicationAttributeResponse`	`DescribeApplicationAttribute(DescribeApplicationAttributeRequest req)` 获取应用列表其它字段，如实例数量信息等
`DescribeApplicationsResponse`	`DescribeApplications(DescribeApplicationsRequest req)` 获取应用列表
`DescribeClusterInstancesResponse`	`DescribeClusterInstances(DescribeClusterInstancesRequest req)` 查询集群实例
`DescribeContainerGroupDetailResponse`	`DescribeContainerGroupDetail(DescribeContainerGroupDetailRequest req)` 容器部署组详情
`DescribeContainerGroupsResponse`	`DescribeContainerGroups(DescribeContainerGroupsRequest req)` 容器部署组列表
`DescribeDownloadInfoResponse`	`DescribeDownloadInfo(DescribeDownloadInfoRequest req)` TSF上传的程序包存放在腾讯云对象存储（COS）中，通过该API可以获取从COS下载程序包需要的信息，包括包所在的桶、存储路径、鉴权信息等，之后使用COS API（或SDK）进行下载。 COS相关文档请查阅：https://cloud.tencent.com/document/product/436
`DescribeGroupResponse`	`DescribeGroup(DescribeGroupRequest req)` 查询虚拟机部署组详情
`DescribeGroupInstancesResponse`	`DescribeGroupInstances(DescribeGroupInstancesRequest req)` 查询虚拟机部署组云主机列表
`DescribeGroupsResponse`	`DescribeGroups(DescribeGroupsRequest req)` 获取虚拟机部署组列表
`DescribeImageTagsResponse`	`DescribeImageTags(DescribeImageTagsRequest req)` 镜像版本列表
`DescribeMicroserviceResponse`	`DescribeMicroservice(DescribeMicroserviceRequest req)` 查询微服务详情
`DescribeMicroservicesResponse`	`DescribeMicroservices(DescribeMicroservicesRequest req)` 获取微服务列表
`DescribePkgsResponse`	`DescribePkgs(DescribePkgsRequest req)` 无
`DescribeSimpleApplicationsResponse`	`DescribeSimpleApplications(DescribeSimpleApplicationsRequest req)` 查询简单应用列表
`DescribeSimpleClustersResponse`	`DescribeSimpleClusters(DescribeSimpleClustersRequest req)` 查询简单集群列表
`DescribeSimpleGroupsResponse`	`DescribeSimpleGroups(DescribeSimpleGroupsRequest req)` 查询简单部署组列表
`DescribeSimpleNamespacesResponse`	`DescribeSimpleNamespaces(DescribeSimpleNamespacesRequest req)` 查询简单命名空间列表
`DescribeUploadInfoResponse`	`DescribeUploadInfo(DescribeUploadInfoRequest req)` TSF会将软件包上传到腾讯云对象存储（COS）。调用此接口获取上传信息，如目标地域，桶，包Id，存储路径，鉴权信息等，之后请使用COS API（或SDK）进行上传。 COS相关文档请查阅：https://cloud.tencent.com/document/product/436
`ExpandGroupResponse`	`ExpandGroup(ExpandGroupRequest req)` 虚拟机部署组添加实例
`ModifyContainerGroupResponse`	`ModifyContainerGroup(ModifyContainerGroupRequest req)` 修改容器部署组
`ModifyContainerReplicasResponse`	`ModifyContainerReplicas(ModifyContainerReplicasRequest req)` 修改容器部署组实例数
`ModifyMicroserviceResponse`	`ModifyMicroservice(ModifyMicroserviceRequest req)` 修改微服务详情
`ModifyUploadInfoResponse`	`ModifyUploadInfo(ModifyUploadInfoRequest req)` 调用该接口和COS的上传接口后，需要调用此接口更新TSF中保存的程序包状态。调用此接口完成后，才标志上传包流程结束。
`RemoveInstancesResponse`	`RemoveInstances(RemoveInstancesRequest req)` 从 TSF 集群中批量移除云主机节点
`ShrinkGroupResponse`	`ShrinkGroup(ShrinkGroupRequest req)` 下线部署组所有机器实例
`ShrinkInstancesResponse`	`ShrinkInstances(ShrinkInstancesRequest req)` 虚拟机部署组下线实例
`StartContainerGroupResponse`	`StartContainerGroup(StartContainerGroupRequest req)` 启动容器部署组
`StartGroupResponse`	`StartGroup(StartGroupRequest req)` 启动分组
`StopContainerGroupResponse`	`StopContainerGroup(StopContainerGroupRequest req)` 停止容器部署组
`StopGroupResponse`	`StopGroup(StopGroupRequest req)` 停止虚拟机部署组

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

TsfClient

public TsfClient(Credential credential,
                 String region)

构造client

Parameters:: credential - 认证信息实例; region - 产品地域

TsfClient

public TsfClient(Credential credential,
                 String region,
                 ClientProfile profile)

构造client

Parameters:: credential - 认证信息实例; region - 产品地域; profile - 配置实例

Method Detail

AddInstances

public AddInstancesResponse AddInstances(AddInstancesRequest req)
                                  throws TencentCloudSDKException

添加云主机节点至TSF集群

Parameters:: req - AddInstancesRequest
Returns:: AddInstancesResponse
Throws:: TencentCloudSDKException

CreateApplication

public CreateApplicationResponse CreateApplication(CreateApplicationRequest req)
                                            throws TencentCloudSDKException

创建应用

Parameters:: req - CreateApplicationRequest
Returns:: CreateApplicationResponse
Throws:: TencentCloudSDKException

CreateCluster

public CreateClusterResponse CreateCluster(CreateClusterRequest req)
                                    throws TencentCloudSDKException

创建集群

Parameters:: req - CreateClusterRequest
Returns:: CreateClusterResponse
Throws:: TencentCloudSDKException

CreateContainGroup

public CreateContainGroupResponse CreateContainGroup(CreateContainGroupRequest req)
                                              throws TencentCloudSDKException

创建容器部署组

Parameters:: req - CreateContainGroupRequest
Returns:: CreateContainGroupResponse
Throws:: TencentCloudSDKException

CreateGroup

public CreateGroupResponse CreateGroup(CreateGroupRequest req)
                                throws TencentCloudSDKException

创建容器部署组

Parameters:: req - CreateGroupRequest
Returns:: CreateGroupResponse
Throws:: TencentCloudSDKException

CreateMicroservice

public CreateMicroserviceResponse CreateMicroservice(CreateMicroserviceRequest req)
                                              throws TencentCloudSDKException

新增微服务

Parameters:: req - CreateMicroserviceRequest
Returns:: CreateMicroserviceResponse
Throws:: TencentCloudSDKException

CreateNamespace

public CreateNamespaceResponse CreateNamespace(CreateNamespaceRequest req)
                                        throws TencentCloudSDKException

创建命名空间

Parameters:: req - CreateNamespaceRequest
Returns:: CreateNamespaceResponse
Throws:: TencentCloudSDKException

DeleteApplication

public DeleteApplicationResponse DeleteApplication(DeleteApplicationRequest req)
                                            throws TencentCloudSDKException

删除应用

Parameters:: req - DeleteApplicationRequest
Returns:: DeleteApplicationResponse
Throws:: TencentCloudSDKException

DeleteContainerGroup

public DeleteContainerGroupResponse DeleteContainerGroup(DeleteContainerGroupRequest req)
                                                  throws TencentCloudSDKException

删除容器部署组

Parameters:: req - DeleteContainerGroupRequest
Returns:: DeleteContainerGroupResponse
Throws:: TencentCloudSDKException

DeleteGroup

public DeleteGroupResponse DeleteGroup(DeleteGroupRequest req)
                                throws TencentCloudSDKException

删除容器部署组

Parameters:: req - DeleteGroupRequest
Returns:: DeleteGroupResponse
Throws:: TencentCloudSDKException

DeleteImageTags

public DeleteImageTagsResponse DeleteImageTags(DeleteImageTagsRequest req)
                                        throws TencentCloudSDKException

批量删除镜像版本

Parameters:: req - DeleteImageTagsRequest
Returns:: DeleteImageTagsResponse
Throws:: TencentCloudSDKException

DeleteMicroservice

public DeleteMicroserviceResponse DeleteMicroservice(DeleteMicroserviceRequest req)
                                              throws TencentCloudSDKException

删除微服务

Parameters:: req - DeleteMicroserviceRequest
Returns:: DeleteMicroserviceResponse
Throws:: TencentCloudSDKException

DeleteNamespace

public DeleteNamespaceResponse DeleteNamespace(DeleteNamespaceRequest req)
                                        throws TencentCloudSDKException

删除命名空间

Parameters:: req - DeleteNamespaceRequest
Returns:: DeleteNamespaceResponse
Throws:: TencentCloudSDKException

DeletePkgs
```
public DeletePkgsResponse DeletePkgs(DeletePkgsRequest req)
                              throws TencentCloudSDKException
```
从软件仓库批量删除程序包。一次最多支持删除1000个包，数量超过1000，返回UpperDeleteLimit错误。

Parameters:

req - DeletePkgsRequest

Returns:

DeletePkgsResponse

Throws:

TencentCloudSDKException

DeployContainerGroup

public DeployContainerGroupResponse DeployContainerGroup(DeployContainerGroupRequest req)
                                                  throws TencentCloudSDKException

部署容器应用

Parameters:: req - DeployContainerGroupRequest
Returns:: DeployContainerGroupResponse
Throws:: TencentCloudSDKException

DeployGroup

public DeployGroupResponse DeployGroup(DeployGroupRequest req)
                                throws TencentCloudSDKException

部署虚拟机部署组应用

Parameters:: req - DeployGroupRequest
Returns:: DeployGroupResponse
Throws:: TencentCloudSDKException

DescribeApplication

public DescribeApplicationResponse DescribeApplication(DescribeApplicationRequest req)
                                                throws TencentCloudSDKException

获取应用详情

Parameters:: req - DescribeApplicationRequest
Returns:: DescribeApplicationResponse
Throws:: TencentCloudSDKException

DescribeApplicationAttribute

public DescribeApplicationAttributeResponse DescribeApplicationAttribute(DescribeApplicationAttributeRequest req)
                                                                  throws TencentCloudSDKException

获取应用列表其它字段，如实例数量信息等

Parameters:: req - DescribeApplicationAttributeRequest
Returns:: DescribeApplicationAttributeResponse
Throws:: TencentCloudSDKException

DescribeApplications

public DescribeApplicationsResponse DescribeApplications(DescribeApplicationsRequest req)
                                                  throws TencentCloudSDKException

获取应用列表

Parameters:: req - DescribeApplicationsRequest
Returns:: DescribeApplicationsResponse
Throws:: TencentCloudSDKException

DescribeClusterInstances

public DescribeClusterInstancesResponse DescribeClusterInstances(DescribeClusterInstancesRequest req)
                                                          throws TencentCloudSDKException

查询集群实例

Parameters:: req - DescribeClusterInstancesRequest
Returns:: DescribeClusterInstancesResponse
Throws:: TencentCloudSDKException

DescribeContainerGroupDetail

public DescribeContainerGroupDetailResponse DescribeContainerGroupDetail(DescribeContainerGroupDetailRequest req)
                                                                  throws TencentCloudSDKException

容器部署组详情

Parameters:: req - DescribeContainerGroupDetailRequest
Returns:: DescribeContainerGroupDetailResponse
Throws:: TencentCloudSDKException

DescribeContainerGroups

public DescribeContainerGroupsResponse DescribeContainerGroups(DescribeContainerGroupsRequest req)
                                                        throws TencentCloudSDKException

容器部署组列表

Parameters:: req - DescribeContainerGroupsRequest
Returns:: DescribeContainerGroupsResponse
Throws:: TencentCloudSDKException

DescribeDownloadInfo
```
public DescribeDownloadInfoResponse DescribeDownloadInfo(DescribeDownloadInfoRequest req)
                                                  throws TencentCloudSDKException
```
TSF上传的程序包存放在腾讯云对象存储（COS）中，通过该API可以获取从COS下载程序包需要的信息，包括包所在的桶、存储路径、鉴权信息等，之后使用COS API（或SDK）进行下载。 COS相关文档请查阅：https://cloud.tencent.com/document/product/436

Parameters:

req - DescribeDownloadInfoRequest

Returns:

DescribeDownloadInfoResponse

Throws:

TencentCloudSDKException

DescribeGroup

public DescribeGroupResponse DescribeGroup(DescribeGroupRequest req)
                                    throws TencentCloudSDKException

查询虚拟机部署组详情

Parameters:: req - DescribeGroupRequest
Returns:: DescribeGroupResponse
Throws:: TencentCloudSDKException

DescribeGroupInstances

public DescribeGroupInstancesResponse DescribeGroupInstances(DescribeGroupInstancesRequest req)
                                                      throws TencentCloudSDKException

查询虚拟机部署组云主机列表

Parameters:: req - DescribeGroupInstancesRequest
Returns:: DescribeGroupInstancesResponse
Throws:: TencentCloudSDKException

DescribeGroups

public DescribeGroupsResponse DescribeGroups(DescribeGroupsRequest req)
                                      throws TencentCloudSDKException

获取虚拟机部署组列表

Parameters:: req - DescribeGroupsRequest
Returns:: DescribeGroupsResponse
Throws:: TencentCloudSDKException

DescribeImageTags

public DescribeImageTagsResponse DescribeImageTags(DescribeImageTagsRequest req)
                                            throws TencentCloudSDKException

镜像版本列表

Parameters:: req - DescribeImageTagsRequest
Returns:: DescribeImageTagsResponse
Throws:: TencentCloudSDKException

DescribeMicroservice

public DescribeMicroserviceResponse DescribeMicroservice(DescribeMicroserviceRequest req)
                                                  throws TencentCloudSDKException

查询微服务详情

Parameters:: req - DescribeMicroserviceRequest
Returns:: DescribeMicroserviceResponse
Throws:: TencentCloudSDKException

DescribeMicroservices

public DescribeMicroservicesResponse DescribeMicroservices(DescribeMicroservicesRequest req)
                                                    throws TencentCloudSDKException

获取微服务列表

Parameters:: req - DescribeMicroservicesRequest
Returns:: DescribeMicroservicesResponse
Throws:: TencentCloudSDKException

DescribePkgs

public DescribePkgsResponse DescribePkgs(DescribePkgsRequest req)
                                  throws TencentCloudSDKException

无

Parameters:: req - DescribePkgsRequest
Returns:: DescribePkgsResponse
Throws:: TencentCloudSDKException

DescribeSimpleApplications

public DescribeSimpleApplicationsResponse DescribeSimpleApplications(DescribeSimpleApplicationsRequest req)
                                                              throws TencentCloudSDKException

查询简单应用列表

Parameters:: req - DescribeSimpleApplicationsRequest
Returns:: DescribeSimpleApplicationsResponse
Throws:: TencentCloudSDKException

DescribeSimpleClusters

public DescribeSimpleClustersResponse DescribeSimpleClusters(DescribeSimpleClustersRequest req)
                                                      throws TencentCloudSDKException

查询简单集群列表

Parameters:: req - DescribeSimpleClustersRequest
Returns:: DescribeSimpleClustersResponse
Throws:: TencentCloudSDKException

DescribeSimpleGroups

public DescribeSimpleGroupsResponse DescribeSimpleGroups(DescribeSimpleGroupsRequest req)
                                                  throws TencentCloudSDKException

查询简单部署组列表

Parameters:: req - DescribeSimpleGroupsRequest
Returns:: DescribeSimpleGroupsResponse
Throws:: TencentCloudSDKException

DescribeSimpleNamespaces

public DescribeSimpleNamespacesResponse DescribeSimpleNamespaces(DescribeSimpleNamespacesRequest req)
                                                          throws TencentCloudSDKException

查询简单命名空间列表

Parameters:: req - DescribeSimpleNamespacesRequest
Returns:: DescribeSimpleNamespacesResponse
Throws:: TencentCloudSDKException

DescribeUploadInfo
```
public DescribeUploadInfoResponse DescribeUploadInfo(DescribeUploadInfoRequest req)
                                              throws TencentCloudSDKException
```
TSF会将软件包上传到腾讯云对象存储（COS）。调用此接口获取上传信息，如目标地域，桶，包Id，存储路径，鉴权信息等，之后请使用COS API（或SDK）进行上传。 COS相关文档请查阅：https://cloud.tencent.com/document/product/436

Parameters:

req - DescribeUploadInfoRequest

Returns:

DescribeUploadInfoResponse

Throws:

TencentCloudSDKException

ExpandGroup

public ExpandGroupResponse ExpandGroup(ExpandGroupRequest req)
                                throws TencentCloudSDKException

虚拟机部署组添加实例

Parameters:: req - ExpandGroupRequest
Returns:: ExpandGroupResponse
Throws:: TencentCloudSDKException

ModifyContainerGroup

public ModifyContainerGroupResponse ModifyContainerGroup(ModifyContainerGroupRequest req)
                                                  throws TencentCloudSDKException

修改容器部署组

Parameters:: req - ModifyContainerGroupRequest
Returns:: ModifyContainerGroupResponse
Throws:: TencentCloudSDKException

ModifyContainerReplicas

public ModifyContainerReplicasResponse ModifyContainerReplicas(ModifyContainerReplicasRequest req)
                                                        throws TencentCloudSDKException

修改容器部署组实例数

Parameters:: req - ModifyContainerReplicasRequest
Returns:: ModifyContainerReplicasResponse
Throws:: TencentCloudSDKException

ModifyMicroservice

public ModifyMicroserviceResponse ModifyMicroservice(ModifyMicroserviceRequest req)
                                              throws TencentCloudSDKException

修改微服务详情

Parameters:: req - ModifyMicroserviceRequest
Returns:: ModifyMicroserviceResponse
Throws:: TencentCloudSDKException

ModifyUploadInfo
```
public ModifyUploadInfoResponse ModifyUploadInfo(ModifyUploadInfoRequest req)
                                          throws TencentCloudSDKException
```
调用该接口和COS的上传接口后，需要调用此接口更新TSF中保存的程序包状态。调用此接口完成后，才标志上传包流程结束。

Parameters:

req - ModifyUploadInfoRequest

Returns:

ModifyUploadInfoResponse

Throws:

TencentCloudSDKException

RemoveInstances
```
public RemoveInstancesResponse RemoveInstances(RemoveInstancesRequest req)
                                        throws TencentCloudSDKException
```
从 TSF 集群中批量移除云主机节点

Parameters:

req - RemoveInstancesRequest

Returns:

RemoveInstancesResponse

Throws:

TencentCloudSDKException

ShrinkGroup

public ShrinkGroupResponse ShrinkGroup(ShrinkGroupRequest req)
                                throws TencentCloudSDKException

下线部署组所有机器实例

Parameters:: req - ShrinkGroupRequest
Returns:: ShrinkGroupResponse
Throws:: TencentCloudSDKException

ShrinkInstances

public ShrinkInstancesResponse ShrinkInstances(ShrinkInstancesRequest req)
                                        throws TencentCloudSDKException

虚拟机部署组下线实例

Parameters:: req - ShrinkInstancesRequest
Returns:: ShrinkInstancesResponse
Throws:: TencentCloudSDKException

StartContainerGroup

public StartContainerGroupResponse StartContainerGroup(StartContainerGroupRequest req)
                                                throws TencentCloudSDKException

启动容器部署组

Parameters:: req - StartContainerGroupRequest
Returns:: StartContainerGroupResponse
Throws:: TencentCloudSDKException

StartGroup

public StartGroupResponse StartGroup(StartGroupRequest req)
                              throws TencentCloudSDKException

启动分组

Parameters:: req - StartGroupRequest
Returns:: StartGroupResponse
Throws:: TencentCloudSDKException

StopContainerGroup

public StopContainerGroupResponse StopContainerGroup(StopContainerGroupRequest req)
                                              throws TencentCloudSDKException

停止容器部署组

Parameters:: req - StopContainerGroupRequest
Returns:: StopContainerGroupResponse
Throws:: TencentCloudSDKException

StopGroup

public StopGroupResponse StopGroup(StopGroupRequest req)
                            throws TencentCloudSDKException

停止虚拟机部署组

Parameters:: req - StopGroupRequest
Returns:: StopGroupResponse
Throws:: TencentCloudSDKException

Class TsfClient

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

TsfClient

TsfClient

Method Detail

AddInstances

CreateApplication

CreateCluster

CreateContainGroup

CreateGroup

CreateMicroservice

CreateNamespace

DeleteApplication

DeleteContainerGroup

DeleteGroup

DeleteImageTags

DeleteMicroservice

DeleteNamespace

DeletePkgs

DeployContainerGroup

DeployGroup

DescribeApplication

DescribeApplicationAttribute

DescribeApplications

DescribeClusterInstances

DescribeContainerGroupDetail

DescribeContainerGroups

DescribeDownloadInfo

DescribeGroup

DescribeGroupInstances

DescribeGroups

DescribeImageTags

DescribeMicroservice

DescribeMicroservices

DescribePkgs

DescribeSimpleApplications

DescribeSimpleClusters

DescribeSimpleGroups

DescribeSimpleNamespaces

DescribeUploadInfo

ExpandGroup

ModifyContainerGroup

ModifyContainerReplicas

ModifyMicroservice

ModifyUploadInfo

RemoveInstances

ShrinkGroup

ShrinkInstances

StartContainerGroup

StartGroup

StopContainerGroup

StopGroup