SsmClient (tencentcloud-sdk-java 3.0.119 API)

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

public class SsmClient
extends AbstractClient

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

构造器概要

构造器
构造器和说明

SsmClient(Credential credential, String region)

SsmClient(Credential credential, String region, ClientProfile profile)

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreateSecretResponse`	`CreateSecret(CreateSecretRequest req)` 创建新的凭据信息，通过KMS进行加密保护。
`DeleteSecretResponse`	`DeleteSecret(DeleteSecretRequest req)` 删除指定的凭据信息，可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。
`DeleteSecretVersionResponse`	`DeleteSecretVersion(DeleteSecretVersionRequest req)` 该接口用于直接删除指定凭据下的单个版本凭据，删除操作立即生效，对所有状态下的凭据版本都可以删除。
`DescribeSecretResponse`	`DescribeSecret(DescribeSecretRequest req)` 获取凭据的详细属性信息。
`DisableSecretResponse`	`DisableSecret(DisableSecretRequest req)` 停用指定的凭据，停用后状态为 Disabled，无法通过接口获取该凭据的明文。
`EnableSecretResponse`	`EnableSecret(EnableSecretRequest req)` 该接口用于开启凭据，状态为Enabled。
`GetRegionsResponse`	`GetRegions(GetRegionsRequest req)` 获取控制台展示region列表
`GetSecretValueResponse`	`GetSecretValue(GetSecretValueRequest req)` 获取指定凭据名称和版本的凭据明文信息，只能获取启用状态的凭据明文。
`GetServiceStatusResponse`	`GetServiceStatus(GetServiceStatusRequest req)` 该接口用户获取用户SecretsManager服务开通状态。
`ListSecretsResponse`	`ListSecrets(ListSecretsRequest req)` 该接口用于获取所有凭据的详细列表，可以指定过滤字段、排序方式等。
`ListSecretVersionIdsResponse`	`ListSecretVersionIds(ListSecretVersionIdsRequest req)` 该接口用于获取指定凭据下的版本列表信息
`PutSecretValueResponse`	`PutSecretValue(PutSecretValueRequest req)` 该接口在指定名称的凭据下增加新版本的凭据内容，一个凭据下最多可以支持10个版本。
`RestoreSecretResponse`	`RestoreSecret(RestoreSecretRequest req)` 该接口用于恢复计划删除（PendingDelete状态）中的凭据，取消计划删除。
`UpdateDescriptionResponse`	`UpdateDescription(UpdateDescriptionRequest req)` 该接口用于修改指定凭据的描述信息，仅能修改Enabled 和 Disabled 状态的凭据。
`UpdateSecretResponse`	`UpdateSecret(UpdateSecretRequest req)` 该接口用于更新指定凭据名称和版本号的内容，调用该接口会对新的凭据内容加密后覆盖旧的内容。

从类继承的方法 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

- 构造器详细资料
  - SsmClient
```
public SsmClient(Credential credential,
                 String region)
```
  - SsmClient
```
public SsmClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- 方法详细资料
  - CreateSecret
```
public CreateSecretResponse CreateSecret(CreateSecretRequest req)
                                  throws TencentCloudSDKException
```
    创建新的凭据信息，通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。
    
    参数:
    
    req - CreateSecretRequest
    
    返回:
    
    CreateSecretResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteSecret
```
public DeleteSecretResponse DeleteSecret(DeleteSecretRequest req)
                                  throws TencentCloudSDKException
```
    删除指定的凭据信息，可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据，在删除日期到达之前状态为 PendingDelete，并可以通过RestoreSecret 进行恢复，超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行（计划）删除操作。
    
    参数:
    
    req - DeleteSecretRequest
    
    返回:
    
    DeleteSecretResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteSecretVersion
```
public DeleteSecretVersionResponse DeleteSecretVersion(DeleteSecretVersionRequest req)
                                                throws TencentCloudSDKException
```
    该接口用于直接删除指定凭据下的单个版本凭据，删除操作立即生效，对所有状态下的凭据版本都可以删除。
    
    参数:
    
    req - DeleteSecretVersionRequest
    
    返回:
    
    DeleteSecretVersionResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeSecret
```
public DescribeSecretResponse DescribeSecret(DescribeSecretRequest req)
                                      throws TencentCloudSDKException
```
    获取凭据的详细属性信息。
    
    参数:
    
    req - DescribeSecretRequest
    
    返回:
    
    DescribeSecretResponse
    
    抛出:
    
    TencentCloudSDKException
  - DisableSecret
```
public DisableSecretResponse DisableSecret(DisableSecretRequest req)
                                    throws TencentCloudSDKException
```
    停用指定的凭据，停用后状态为 Disabled，无法通过接口获取该凭据的明文。
    
    参数:
    
    req - DisableSecretRequest
    
    返回:
    
    DisableSecretResponse
    
    抛出:
    
    TencentCloudSDKException
  - EnableSecret
```
public EnableSecretResponse EnableSecret(EnableSecretRequest req)
                                  throws TencentCloudSDKException
```
    该接口用于开启凭据，状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启，需要通过RestoreSecret 恢复后再开启使用。
    
    参数:
    
    req - EnableSecretRequest
    
    返回:
    
    EnableSecretResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetRegions
```
public GetRegionsResponse GetRegions(GetRegionsRequest req)
                              throws TencentCloudSDKException
```
    获取控制台展示region列表
    
    参数:
    
    req - GetRegionsRequest
    
    返回:
    
    GetRegionsResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetSecretValue
```
public GetSecretValueResponse GetSecretValue(GetSecretValueRequest req)
                                      throws TencentCloudSDKException
```
    获取指定凭据名称和版本的凭据明文信息，只能获取启用状态的凭据明文。
    
    参数:
    
    req - GetSecretValueRequest
    
    返回:
    
    GetSecretValueResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetServiceStatus
```
public GetServiceStatusResponse GetServiceStatus(GetServiceStatusRequest req)
                                          throws TencentCloudSDKException
```
    该接口用户获取用户SecretsManager服务开通状态。
    
    参数:
    
    req - GetServiceStatusRequest
    
    返回:
    
    GetServiceStatusResponse
    
    抛出:
    
    TencentCloudSDKException
  - ListSecretVersionIds
```
public ListSecretVersionIdsResponse ListSecretVersionIds(ListSecretVersionIdsRequest req)
                                                  throws TencentCloudSDKException
```
    该接口用于获取指定凭据下的版本列表信息
    
    参数:
    
    req - ListSecretVersionIdsRequest
    
    返回:
    
    ListSecretVersionIdsResponse
    
    抛出:
    
    TencentCloudSDKException
  - ListSecrets
```
public ListSecretsResponse ListSecrets(ListSecretsRequest req)
                                throws TencentCloudSDKException
```
    该接口用于获取所有凭据的详细列表，可以指定过滤字段、排序方式等。
    
    参数:
    
    req - ListSecretsRequest
    
    返回:
    
    ListSecretsResponse
    
    抛出:
    
    TencentCloudSDKException
  - PutSecretValue
```
public PutSecretValueResponse PutSecretValue(PutSecretValueRequest req)
                                      throws TencentCloudSDKException
```
    该接口在指定名称的凭据下增加新版本的凭据内容，一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。
    
    参数:
    
    req - PutSecretValueRequest
    
    返回:
    
    PutSecretValueResponse
    
    抛出:
    
    TencentCloudSDKException
  - RestoreSecret
```
public RestoreSecretResponse RestoreSecret(RestoreSecretRequest req)
                                    throws TencentCloudSDKException
```
    该接口用于恢复计划删除（PendingDelete状态）中的凭据，取消计划删除。取消计划删除的凭据将处于Disabled 状态，如需恢复使用，通过EnableSecret 接口开启凭据。
    
    参数:
    
    req - RestoreSecretRequest
    
    返回:
    
    RestoreSecretResponse
    
    抛出:
    
    TencentCloudSDKException
  - UpdateDescription
```
public UpdateDescriptionResponse UpdateDescription(UpdateDescriptionRequest req)
                                            throws TencentCloudSDKException
```
    该接口用于修改指定凭据的描述信息，仅能修改Enabled 和 Disabled 状态的凭据。
    
    参数:
    
    req - UpdateDescriptionRequest
    
    返回:
    
    UpdateDescriptionResponse
    
    抛出:
    
    TencentCloudSDKException
  - UpdateSecret
```
public UpdateSecretResponse UpdateSecret(UpdateSecretRequest req)
                                  throws TencentCloudSDKException
```
    该接口用于更新指定凭据名称和版本号的内容，调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。
    
    参数:
    
    req - UpdateSecretRequest
    
    返回:
    
    UpdateSecretResponse
    
    抛出:
    
    TencentCloudSDKException

类 SsmClient

字段概要

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

构造器概要

方法概要

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

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

构造器详细资料

SsmClient

SsmClient

方法详细资料

CreateSecret

DeleteSecret

DeleteSecretVersion

DescribeSecret

DisableSecret

EnableSecret

GetRegions

GetSecretValue

GetServiceStatus

ListSecretVersionIds

ListSecrets

PutSecretValue

RestoreSecret

UpdateDescription

UpdateSecret