com.tencentcloudapi.ssm.v20190923

Class SsmClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ssm.v20190923.SsmClient

public class SsmClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
SsmClient(Credential credential, String region)
SsmClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
CreateProductSecretResponse	CreateProductSecret(CreateProductSecretRequest req) This API is used to create a Tencent Cloud service credential.
CreateSecretResponse	CreateSecret(CreateSecretRequest req) This API is used to create a KMS-encrypted Secret.
CreateSSHKeyPairSecretResponse	CreateSSHKeyPairSecret(CreateSSHKeyPairSecretRequest req) This API is used to create a secret that hosts SSH keys.
DeleteSecretResponse	DeleteSecret(DeleteSecretRequest req) This API is used to delete a Secret.
DeleteSecretVersionResponse	DeleteSecretVersion(DeleteSecretVersionRequest req) This API is used to directly delete a single credential version under the specified credential.
DescribeAsyncRequestInfoResponse	DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req) This API is used to query the execution result of an async task.
DescribeRotationDetailResponse	DescribeRotationDetail(DescribeRotationDetailRequest req) This API is used to query the details of a credential rotation policy.
DescribeRotationHistoryResponse	DescribeRotationHistory(DescribeRotationHistoryRequest req) This API is used to query the historical versions of a rotated credential.
DescribeSecretResponse	DescribeSecret(DescribeSecretRequest req) This API is used to obtain the detailed attribute information of a Secret.
DescribeSupportedProductsResponse	DescribeSupportedProducts(DescribeSupportedProductsRequest req) This API is used to query the list of supported Tencent Cloud services.
DisableSecretResponse	DisableSecret(DisableSecretRequest req) This API is used to disable a Secret and will change its status to `Disabled`.
EnableSecretResponse	EnableSecret(EnableSecretRequest req) This API is used to enable a Secret and will change its status to `Enabled`.
GetRegionsResponse	GetRegions(GetRegionsRequest req) This API is used to obtain the list of regions displayed on Console.
GetSecretValueResponse	GetSecretValue(GetSecretValueRequest req) For user-defined credentials, this API is used to get the plaintext information of a credential by specifying the credential name and version.
GetServiceStatusResponse	GetServiceStatus(GetServiceStatusRequest req) This API is used to obtain the SecretsManager service status of a user.
GetSSHKeyPairValueResponse	GetSSHKeyPairValue(GetSSHKeyPairValueRequest req) This API is used to obtain the plaintext value of the SSH key secret.
ListSecretsResponse	ListSecrets(ListSecretsRequest req) This API is used to obtain the detailed information list of all Secrets.
ListSecretVersionIdsResponse	ListSecretVersionIds(ListSecretVersionIdsRequest req) This API is used to obtain list of versions of a Secret.
PutSecretValueResponse	PutSecretValue(PutSecretValueRequest req) This API adds the new version of the credential content under the specified credential.
RestoreSecretResponse	RestoreSecret(RestoreSecretRequest req) This API is used to restore a `PendingDelete` Secret, canceling its scheduled deletion.
RotateProductSecretResponse	RotateProductSecret(RotateProductSecretRequest req) This API is used to rotate secrets for Tencent Cloud services or Tencent Cloud API key pairs.
UpdateDescriptionResponse	UpdateDescription(UpdateDescriptionRequest req) This API is used to update the description of a Secret.
UpdateRotationStatusResponse	UpdateRotationStatus(UpdateRotationStatusRequest req) This API is used to set a Tencent Cloud service credential rotation policy, including the following parameters: Specifies whether to enable rotation Rotation frequency Rotation start time
UpdateSecretResponse	UpdateSecret(UpdateSecretRequest req) This API is used to update the credential content of the specified credential name and version number.

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

SsmClient

public SsmClient(Credential credential,
                 String region)

SsmClient

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

Method Detail

CreateProductSecret

public CreateProductSecretResponse CreateProductSecret(CreateProductSecretRequest req)
                                                throws TencentCloudSDKException

This API is used to create a Tencent Cloud service credential.

Parameters:

req - CreateProductSecretRequest

Returns:

CreateProductSecretResponse

Throws:

TencentCloudSDKException

CreateSSHKeyPairSecret

public CreateSSHKeyPairSecretResponse CreateSSHKeyPairSecret(CreateSSHKeyPairSecretRequest req)
                                                      throws TencentCloudSDKException

This API is used to create a secret that hosts SSH keys.

Parameters:

req - CreateSSHKeyPairSecretRequest

Returns:

CreateSSHKeyPairSecretResponse

Throws:

TencentCloudSDKException

CreateSecret

public CreateSecretResponse CreateSecret(CreateSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to create a KMS-encrypted Secret. You can create and store up to 1,000 Secrets in each region.

Parameters:

req - CreateSecretRequest

Returns:

CreateSecretResponse

Throws:

TencentCloudSDKException

DeleteSecret

public DeleteSecretResponse DeleteSecret(DeleteSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to delete a Secret. You can set whether to delete the Secret immediately or on schedule using the `RecoveryWindowInDays` parameter. For a Secret to be deleted on schedule, its status will be `PendingDelete` before the scheduled deletion time. You can use `RestoreSecret` to restore a deleted Secret during this time. A deleted Secret will not be restorable after the scheduled deletion time. A Secret can only be deleted after being disabled using `DisableSecret`.

Parameters:

req - DeleteSecretRequest

Returns:

DeleteSecretResponse

Throws:

TencentCloudSDKException

DeleteSecretVersion

public DeleteSecretVersionResponse DeleteSecretVersion(DeleteSecretVersionRequest req)
                                                throws TencentCloudSDKException

This API is used to directly delete a single credential version under the specified credential. The deletion takes effect immediately, and the credential version in all status can be deleted. This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

Parameters:

req - DeleteSecretVersionRequest

Returns:

DeleteSecretVersionResponse

Throws:

TencentCloudSDKException

DescribeAsyncRequestInfo

public DescribeAsyncRequestInfoResponse DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
                                                          throws TencentCloudSDKException

This API is used to query the execution result of an async task.

Parameters:

req - DescribeAsyncRequestInfoRequest

Returns:

DescribeAsyncRequestInfoResponse

Throws:

TencentCloudSDKException

DescribeRotationDetail

public DescribeRotationDetailResponse DescribeRotationDetail(DescribeRotationDetailRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the details of a credential rotation policy. This API is only applicable to Tencent Cloud service credentials.

Parameters:

req - DescribeRotationDetailRequest

Returns:

DescribeRotationDetailResponse

Throws:

TencentCloudSDKException

DescribeRotationHistory

public DescribeRotationHistoryResponse DescribeRotationHistory(DescribeRotationHistoryRequest req)
                                                        throws TencentCloudSDKException

This API is used to query the historical versions of a rotated credential. This API is only applicable to Tencent Cloud service credentials.

Parameters:

req - DescribeRotationHistoryRequest

Returns:

DescribeRotationHistoryResponse

Throws:

TencentCloudSDKException

DescribeSecret

public DescribeSecretResponse DescribeSecret(DescribeSecretRequest req)
                                      throws TencentCloudSDKException

This API is used to obtain the detailed attribute information of a Secret.

Parameters:

req - DescribeSecretRequest

Returns:

DescribeSecretResponse

Throws:

TencentCloudSDKException

DescribeSupportedProducts

public DescribeSupportedProductsResponse DescribeSupportedProducts(DescribeSupportedProductsRequest req)
                                                            throws TencentCloudSDKException

This API is used to query the list of supported Tencent Cloud services.

Parameters:

req - DescribeSupportedProductsRequest

Returns:

DescribeSupportedProductsResponse

Throws:

TencentCloudSDKException

DisableSecret

public DisableSecretResponse DisableSecret(DisableSecretRequest req)
                                    throws TencentCloudSDKException

This API is used to disable a Secret and will change its status to `Disabled`. The plaintext of a disabled Secret cannot be obtained through APIs.

Parameters:

req - DisableSecretRequest

Returns:

DisableSecretResponse

Throws:

TencentCloudSDKException

EnableSecret

public EnableSecretResponse EnableSecret(EnableSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to enable a Secret and will change its status to `Enabled`. You can call the `GetSecretValue` API to obtain the plaintext of this Secret. Secrets in `PendingDelete` status can only be enabled after being restored by using `RestoreSecret`.

Parameters:

req - EnableSecretRequest

Returns:

EnableSecretResponse

Throws:

TencentCloudSDKException

GetRegions

public GetRegionsResponse GetRegions(GetRegionsRequest req)
                              throws TencentCloudSDKException

This API is used to obtain the list of regions displayed on Console.

Parameters:

req - GetRegionsRequest

Returns:

GetRegionsResponse

Throws:

TencentCloudSDKException

GetSSHKeyPairValue

public GetSSHKeyPairValueResponse GetSSHKeyPairValue(GetSSHKeyPairValueRequest req)
                                              throws TencentCloudSDKException

This API is used to obtain the plaintext value of the SSH key secret.

Parameters:

req - GetSSHKeyPairValueRequest

Returns:

GetSSHKeyPairValueResponse

Throws:

TencentCloudSDKException

GetSecretValue

public GetSecretValueResponse GetSecretValue(GetSecretValueRequest req)
                                      throws TencentCloudSDKException

For user-defined credentials, this API is used to get the plaintext information of a credential by specifying the credential name and version. For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as `SSM_Current`.

Parameters:

req - GetSecretValueRequest

Returns:

GetSecretValueResponse

Throws:

TencentCloudSDKException

GetServiceStatus

public GetServiceStatusResponse GetServiceStatus(GetServiceStatusRequest req)
                                          throws TencentCloudSDKException

This API is used to obtain the SecretsManager service status of a user.

Parameters:

req - GetServiceStatusRequest

Returns:

GetServiceStatusResponse

Throws:

TencentCloudSDKException

ListSecretVersionIds

public ListSecretVersionIdsResponse ListSecretVersionIds(ListSecretVersionIdsRequest req)
                                                  throws TencentCloudSDKException

This API is used to obtain list of versions of a Secret.

Parameters:

req - ListSecretVersionIdsRequest

Returns:

ListSecretVersionIdsResponse

Throws:

TencentCloudSDKException

ListSecrets

public ListSecretsResponse ListSecrets(ListSecretsRequest req)
                                throws TencentCloudSDKException

This API is used to obtain the detailed information list of all Secrets. You can specify the filter fields and sorting order as needed.

Parameters:

req - ListSecretsRequest

Returns:

ListSecretsResponse

Throws:

TencentCloudSDKException

PutSecretValue

public PutSecretValueResponse PutSecretValue(PutSecretValueRequest req)
                                      throws TencentCloudSDKException

This API adds the new version of the credential content under the specified credential. One credential can have up to 10 versions. New versions can be added to credentials only in `Enabled` or `Disabled` status. This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

Parameters:

req - PutSecretValueRequest

Returns:

PutSecretValueResponse

Throws:

TencentCloudSDKException

RestoreSecret

public RestoreSecretResponse RestoreSecret(RestoreSecretRequest req)
                                    throws TencentCloudSDKException

This API is used to restore a `PendingDelete` Secret, canceling its scheduled deletion. The restored Secret will be in `Disabled` status. You can call the `EnableSecret` API to enable this Secret again.

Parameters:

req - RestoreSecretRequest

Returns:

RestoreSecretResponse

Throws:

TencentCloudSDKException

RotateProductSecret

public RotateProductSecretResponse RotateProductSecret(RotateProductSecretRequest req)
                                                throws TencentCloudSDKException

This API is used to rotate secrets for Tencent Cloud services or Tencent Cloud API key pairs. Note that only the secrets with the "Enabled" status can be rotated.

Parameters:

req - RotateProductSecretRequest

Returns:

RotateProductSecretResponse

Throws:

TencentCloudSDKException

UpdateDescription

public UpdateDescriptionResponse UpdateDescription(UpdateDescriptionRequest req)
                                            throws TencentCloudSDKException

This API is used to update the description of a Secret. This API can only update Secrets in `Enabled` or `Disabled` status.

Parameters:

req - UpdateDescriptionRequest

Returns:

UpdateDescriptionResponse

Throws:

TencentCloudSDKException

UpdateRotationStatus

public UpdateRotationStatusResponse UpdateRotationStatus(UpdateRotationStatusRequest req)
                                                  throws TencentCloudSDKException

This API is used to set a Tencent Cloud service credential rotation policy, including the following parameters: Specifies whether to enable rotation Rotation frequency Rotation start time

Parameters:

req - UpdateRotationStatusRequest

Returns:

UpdateRotationStatusResponse

Throws:

TencentCloudSDKException

UpdateSecret

public UpdateSecretResponse UpdateSecret(UpdateSecretRequest req)
                                  throws TencentCloudSDKException

This API is used to update the credential content of the specified credential name and version number. Calling this API will encrypt the content of the new credential and overwrite the old content. Only credentials in `Enabled` or `Disabled` status can be updated. This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

Parameters:

req - UpdateSecretRequest

Returns:

UpdateSecretResponse

Throws:

TencentCloudSDKException