SsmClient (tencentcloud-sdk-java-ssm 3.1.894 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.ssm.v20190923.SsmClient

public class SsmClient
extends com.tencentcloudapi.common.AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`SsmClient(com.tencentcloudapi.common.Credential credential, String region)`
`SsmClient(com.tencentcloudapi.common.Credential credential, String region, com.tencentcloudapi.common.profile.ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateProductSecretResponse`	`CreateProductSecret(CreateProductSecretRequest req)` 创建云产品凭据
`CreateSecretResponse`	`CreateSecret(CreateSecretRequest req)` 创建新的凭据信息，通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。
`CreateSSHKeyPairSecretResponse`	`CreateSSHKeyPairSecret(CreateSSHKeyPairSecretRequest req)` 创建用于托管SSH密钥对的凭据
`DeleteSecretResponse`	`DeleteSecret(DeleteSecretRequest req)` 删除指定的凭据信息，可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据，在删除日期到达之前状态为 PendingDelete，并可以通过RestoreSecret 进行恢复，超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行（计划）删除操作。
`DeleteSecretVersionResponse`	`DeleteSecretVersion(DeleteSecretVersionRequest req)` 该接口用于直接删除指定凭据下的单个版本凭据，删除操作立即生效，对所有状态下的凭据版本都可以删除。本接口仅适用于用户自定义凭据，本接口不能对云产品凭据进行操作。
`DescribeAsyncRequestInfoResponse`	`DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)` 查询异步任务的执行结果
`DescribeRotationDetailResponse`	`DescribeRotationDetail(DescribeRotationDetailRequest req)` 查询凭据轮转策略详情。本接口只适用于云产品凭据。
`DescribeRotationHistoryResponse`	`DescribeRotationHistory(DescribeRotationHistoryRequest req)` 查询凭据轮转历史版本。本接口仅适用于云产品凭据。
`DescribeSecretResponse`	`DescribeSecret(DescribeSecretRequest req)` 获取凭据的详细属性信息。
`DescribeSupportedProductsResponse`	`DescribeSupportedProducts(DescribeSupportedProductsRequest req)` 查询支持的云产品列表
`DisableSecretResponse`	`DisableSecret(DisableSecretRequest req)` 停用指定的凭据，停用后状态为 Disabled，无法通过接口获取该凭据的明文。
`EnableSecretResponse`	`EnableSecret(EnableSecretRequest req)` 该接口用于开启凭据，状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启，需要通过RestoreSecret 恢复后再开启使用。
`GetRegionsResponse`	`GetRegions(GetRegionsRequest req)` 获取控制台展示region列表
`GetSecretValueResponse`	`GetSecretValue(GetSecretValueRequest req)` 对于用户自定义凭据，通过指定凭据名称和版本来获取凭据的明文信息；对于云产品凭据如Mysql凭据，通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息，如果要获取当前正在使用的凭据版本的明文，需要将版本号指定为：SSM_Current。
`GetServiceStatusResponse`	`GetServiceStatus(GetServiceStatusRequest req)` 该接口用户获取用户SecretsManager服务开通状态。
`GetSSHKeyPairValueResponse`	`GetSSHKeyPairValue(GetSSHKeyPairValueRequest req)` 获取SSH密钥对凭据明文信息。
`ListSecretsResponse`	`ListSecrets(ListSecretsRequest req)` 该接口用于获取所有凭据的详细列表，可以指定过滤字段、排序方式等。
`ListSecretVersionIdsResponse`	`ListSecretVersionIds(ListSecretVersionIdsRequest req)` 该接口用于获取指定凭据下的版本列表信息
`PutSecretValueResponse`	`PutSecretValue(PutSecretValueRequest req)` 该接口在指定名称的凭据下增加新版本的凭据内容，一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。本接口仅适用于用户自定义凭据，对云产品凭据不能操作。
`RestoreSecretResponse`	`RestoreSecret(RestoreSecretRequest req)` 该接口用于恢复计划删除（PendingDelete状态）中的凭据，取消计划删除。取消计划删除的凭据将处于Disabled 状态，如需恢复使用，通过EnableSecret 接口开启凭据。
`RotateProductSecretResponse`	`RotateProductSecret(RotateProductSecretRequest req)` 轮转云产品凭据或云API密钥对凭据。该接口仅适用于处于Enabled状态的云产品凭据或处于Enable状态的云API密钥对凭据，对于其他状态的云产品凭据或云API密钥对凭据或用户自定义凭据不适用。
`UpdateDescriptionResponse`	`UpdateDescription(UpdateDescriptionRequest req)` 该接口用于修改指定凭据的描述信息，仅能修改Enabled 和 Disabled 状态的凭据。
`UpdateRotationStatusResponse`	`UpdateRotationStatus(UpdateRotationStatusRequest req)` 设置云产品凭据轮转策略，可以设置：是否开启轮转轮转周期轮转开始时间
`UpdateSecretResponse`	`UpdateSecret(UpdateSecretRequest req)` 该接口用于更新指定凭据名称和版本号的内容，调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。本接口仅适用于用户自定义凭据，不能对云产品凭据操作。

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
  - SsmClient
```
public SsmClient(com.tencentcloudapi.common.Credential credential,
                 String region)
```
  - SsmClient
```
public SsmClient(com.tencentcloudapi.common.Credential credential,
                 String region,
                 com.tencentcloudapi.common.profile.ClientProfile profile)
```
- Method Detail
  - CreateProductSecret
```
public CreateProductSecretResponse CreateProductSecret(CreateProductSecretRequest req)
                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    创建云产品凭据
    
    Parameters:
    
    req - CreateProductSecretRequest
    
    Returns:
    
    CreateProductSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateSSHKeyPairSecret
```
public CreateSSHKeyPairSecretResponse CreateSSHKeyPairSecret(CreateSSHKeyPairSecretRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    创建用于托管SSH密钥对的凭据
    
    Parameters:
    
    req - CreateSSHKeyPairSecretRequest
    
    Returns:
    
    CreateSSHKeyPairSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateSecret
```
public CreateSecretResponse CreateSecret(CreateSecretRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    创建新的凭据信息，通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。
    
    Parameters:
    
    req - CreateSecretRequest
    
    Returns:
    
    CreateSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteSecret
```
public DeleteSecretResponse DeleteSecret(DeleteSecretRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    删除指定的凭据信息，可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据，在删除日期到达之前状态为 PendingDelete，并可以通过RestoreSecret 进行恢复，超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行（计划）删除操作。
    
    Parameters:
    
    req - DeleteSecretRequest
    
    Returns:
    
    DeleteSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteSecretVersion
```
public DeleteSecretVersionResponse DeleteSecretVersion(DeleteSecretVersionRequest req)
                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于直接删除指定凭据下的单个版本凭据，删除操作立即生效，对所有状态下的凭据版本都可以删除。本接口仅适用于用户自定义凭据，本接口不能对云产品凭据进行操作。
    
    Parameters:
    
    req - DeleteSecretVersionRequest
    
    Returns:
    
    DeleteSecretVersionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeAsyncRequestInfo
```
public DescribeAsyncRequestInfoResponse DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    查询异步任务的执行结果
    
    Parameters:
    
    req - DescribeAsyncRequestInfoRequest
    
    Returns:
    
    DescribeAsyncRequestInfoResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeRotationDetail
```
public DescribeRotationDetailResponse DescribeRotationDetail(DescribeRotationDetailRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    查询凭据轮转策略详情。本接口只适用于云产品凭据。
    
    Parameters:
    
    req - DescribeRotationDetailRequest
    
    Returns:
    
    DescribeRotationDetailResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeRotationHistory
```
public DescribeRotationHistoryResponse DescribeRotationHistory(DescribeRotationHistoryRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    查询凭据轮转历史版本。本接口仅适用于云产品凭据。
    
    Parameters:
    
    req - DescribeRotationHistoryRequest
    
    Returns:
    
    DescribeRotationHistoryResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSecret
```
public DescribeSecretResponse DescribeSecret(DescribeSecretRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    获取凭据的详细属性信息。
    
    Parameters:
    
    req - DescribeSecretRequest
    
    Returns:
    
    DescribeSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSupportedProducts
```
public DescribeSupportedProductsResponse DescribeSupportedProducts(DescribeSupportedProductsRequest req)
                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    查询支持的云产品列表
    
    Parameters:
    
    req - DescribeSupportedProductsRequest
    
    Returns:
    
    DescribeSupportedProductsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DisableSecret
```
public DisableSecretResponse DisableSecret(DisableSecretRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    停用指定的凭据，停用后状态为 Disabled，无法通过接口获取该凭据的明文。
    
    Parameters:
    
    req - DisableSecretRequest
    
    Returns:
    
    DisableSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - EnableSecret
```
public EnableSecretResponse EnableSecret(EnableSecretRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于开启凭据，状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启，需要通过RestoreSecret 恢复后再开启使用。
    
    Parameters:
    
    req - EnableSecretRequest
    
    Returns:
    
    EnableSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - GetRegions
```
public GetRegionsResponse GetRegions(GetRegionsRequest req)
                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    获取控制台展示region列表
    
    Parameters:
    
    req - GetRegionsRequest
    
    Returns:
    
    GetRegionsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - GetSSHKeyPairValue
```
public GetSSHKeyPairValueResponse GetSSHKeyPairValue(GetSSHKeyPairValueRequest req)
                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    获取SSH密钥对凭据明文信息。
    
    Parameters:
    
    req - GetSSHKeyPairValueRequest
    
    Returns:
    
    GetSSHKeyPairValueResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - GetSecretValue
```
public GetSecretValueResponse GetSecretValue(GetSecretValueRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    对于用户自定义凭据，通过指定凭据名称和版本来获取凭据的明文信息；对于云产品凭据如Mysql凭据，通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息，如果要获取当前正在使用的凭据版本的明文，需要将版本号指定为：SSM_Current。
    
    Parameters:
    
    req - GetSecretValueRequest
    
    Returns:
    
    GetSecretValueResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - GetServiceStatus
```
public GetServiceStatusResponse GetServiceStatus(GetServiceStatusRequest req)
                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用户获取用户SecretsManager服务开通状态。
    
    Parameters:
    
    req - GetServiceStatusRequest
    
    Returns:
    
    GetServiceStatusResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ListSecretVersionIds
```
public ListSecretVersionIdsResponse ListSecretVersionIds(ListSecretVersionIdsRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于获取指定凭据下的版本列表信息
    
    Parameters:
    
    req - ListSecretVersionIdsRequest
    
    Returns:
    
    ListSecretVersionIdsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ListSecrets
```
public ListSecretsResponse ListSecrets(ListSecretsRequest req)
                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于获取所有凭据的详细列表，可以指定过滤字段、排序方式等。
    
    Parameters:
    
    req - ListSecretsRequest
    
    Returns:
    
    ListSecretsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - PutSecretValue
```
public PutSecretValueResponse PutSecretValue(PutSecretValueRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口在指定名称的凭据下增加新版本的凭据内容，一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。本接口仅适用于用户自定义凭据，对云产品凭据不能操作。
    
    Parameters:
    
    req - PutSecretValueRequest
    
    Returns:
    
    PutSecretValueResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - RestoreSecret
```
public RestoreSecretResponse RestoreSecret(RestoreSecretRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于恢复计划删除（PendingDelete状态）中的凭据，取消计划删除。取消计划删除的凭据将处于Disabled 状态，如需恢复使用，通过EnableSecret 接口开启凭据。
    
    Parameters:
    
    req - RestoreSecretRequest
    
    Returns:
    
    RestoreSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - RotateProductSecret
```
public RotateProductSecretResponse RotateProductSecret(RotateProductSecretRequest req)
                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    轮转云产品凭据或云API密钥对凭据。该接口仅适用于处于Enabled状态的云产品凭据或处于Enable状态的云API密钥对凭据，对于其他状态的云产品凭据或云API密钥对凭据或用户自定义凭据不适用。
    
    Parameters:
    
    req - RotateProductSecretRequest
    
    Returns:
    
    RotateProductSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - UpdateDescription
```
public UpdateDescriptionResponse UpdateDescription(UpdateDescriptionRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于修改指定凭据的描述信息，仅能修改Enabled 和 Disabled 状态的凭据。
    
    Parameters:
    
    req - UpdateDescriptionRequest
    
    Returns:
    
    UpdateDescriptionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - UpdateRotationStatus
```
public UpdateRotationStatusResponse UpdateRotationStatus(UpdateRotationStatusRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    设置云产品凭据轮转策略，可以设置：是否开启轮转轮转周期轮转开始时间
    
    Parameters:
    
    req - UpdateRotationStatusRequest
    
    Returns:
    
    UpdateRotationStatusResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - UpdateSecret
```
public UpdateSecretResponse UpdateSecret(UpdateSecretRequest req)
                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    该接口用于更新指定凭据名称和版本号的内容，调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。本接口仅适用于用户自定义凭据，不能对云产品凭据操作。
    
    Parameters:
    
    req - UpdateSecretRequest
    
    Returns:
    
    UpdateSecretResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException

Class SsmClient

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

SsmClient

SsmClient

Method Detail

CreateProductSecret

CreateSSHKeyPairSecret

CreateSecret

DeleteSecret

DeleteSecretVersion

DescribeAsyncRequestInfo

DescribeRotationDetail

DescribeRotationHistory

DescribeSecret

DescribeSupportedProducts

DisableSecret

EnableSecret

GetRegions

GetSSHKeyPairValue

GetSecretValue

GetServiceStatus

ListSecretVersionIds

ListSecrets

PutSecretValue

RestoreSecret

RotateProductSecret

UpdateDescription

UpdateRotationStatus

UpdateSecret