- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practices
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Data Security APIs
- PutSecretValue
- RestoreSecret
- ListSecretVersionIds
- GetServiceStatus
- CreateSSHKeyPairSecret
- UpdateRotationStatus
- CreateSecret
- DeleteSecret
- DeleteSecretVersion
- DescribeSecret
- DisableSecret
- EnableSecret
- GetRegions
- GetSecretValue
- UpdateDescription
- UpdateSecret
- GetSSHKeyPairValue
- CreateProductSecret
- DescribeAsyncRequestInfo
- DescribeRotationDetail
- RotateProductSecret
- DescribeRotationHistory
- ListSecrets
- Other APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Contact Us
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practices
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Data Security APIs
- PutSecretValue
- RestoreSecret
- ListSecretVersionIds
- GetServiceStatus
- CreateSSHKeyPairSecret
- UpdateRotationStatus
- CreateSecret
- DeleteSecret
- DeleteSecretVersion
- DescribeSecret
- DisableSecret
- EnableSecret
- GetRegions
- GetSecretValue
- UpdateDescription
- UpdateSecret
- GetSSHKeyPairValue
- CreateProductSecret
- DescribeAsyncRequestInfo
- DescribeRotationDetail
- RotateProductSecret
- DescribeRotationHistory
- ListSecrets
- Other APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- Contact Us
- Glossary
1. API Description
Domain name for API request: ssm.tencentcloudapi.com.
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
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 Params. The value used for this API: UpdateRotationStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-23. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| SecretName | Yes | String | Tencent Cloud service credential name. |
| EnableRotation | Yes | Boolean | Specifies whether to enable rotation.true: enables rotation.false: disables rotation. |
| Frequency | No | Integer | Rotation frequency in days. Value range: 30–365. |
| RotationBeginTime | No | String | User-defined rotation start time in the format of 2006-01-02 15:04:05. When EnableRotation is true and RotationBeginTime is left empty, the current time will be entered by default. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Setting Tencent Cloud service credential rotation policy
Input Example
https://ssm.tencentcloudapi.com/?Action=UpdateRotationStatus
&SecretName=test
&EnableRotation=true
&Frequency=35
&RotationBeginTime=2006-01-02 15:04:05
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| FailedOperation.RotationForbidden | The rotation is prohibited. |
| 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. |
Yes
No
Was this page helpful?