DescribeRotationDetail

Last updated: 2021-09-13 16:19:01

1. API Description

Domain name for API request: ssm.tencentcloudapi.com.

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

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeRotationDetail.
Version Yes String Common parameter. The value used for this API: 2019-09-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SecretName Yes String Specifies the name of the credential for which to get the credential rotation details.

3. Output Parameters

Parameter Name Type Description
EnableRotation Boolean Whether to enable rotation. true: enabled; false: disabled.
Frequency Integer Rotation frequency in days. Default value: 1 day.
Note: this field may return null, indicating that no valid values can be obtained.
LatestRotateTime String Last rotation time, which is an explicitly visible time string in the format of 2006-01-02 15:04:05.
Note: this field may return null, indicating that no valid values can be obtained.
NextRotateBeginTime String Next rotation start time, which is an explicitly visible time string in the format of 2006-01-02 15:04:05.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying credential rotation details

Input Example

https://ssm.tencentcloudapi.com/?Action=DescribeRotationDetail
&SecretName=test
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4",
    "EnableRotation": true,
    "Frequency": 35,
    "LatestRotateTime": "2021-01-02 15:04:05",
    "NextRotateBeginTime": "2021-02-02 15:04:05"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
FailedOperation.AccessKmsError KMS operation failed.
InternalError An internal error occurred.
InvalidParameter Incorrect parameter.
InvalidParameterValue The parameter value is invalid.
InvalidParameterValue.TagKeysDuplicated The tag keys are duplicated.
InvalidParameterValue.TagsNotExisted The tag key or tag value does not exist.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.AutoRotatedResource It is not allowed to manually update credentials with automatic rotation enabled.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is in use.
ResourceInUse.SecretExists The Secret name already exists.
ResourceInUse.VersionIdExists The Version ID already exists.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.NotPurchased The service is not purchased.
ResourceUnavailable.ResourceDisabled The Secret is disabled.
ResourceUnavailable.ResourcePendingDeleted The Secret is in PendingDelete status.
ResourceUnavailable.ResourceUninitialized The credential has not been initialized.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.AccessKmsError Failed to access KMS.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.