Product Introduction

Product Overview

Product Strengths

Use Cases

Concepts

Purchase Guide

Billing Overview

Purchase Method

Renewal Instructions

Payment Overdue

Console Guide

Getting Started

Key Management

Access Control

Audit

TCCLI Management Guide

Operation Overview

Creating Key

Viewing Key

Editing Key

Enabling/Disabling Key

Key Rotation

Encryption and Decryption

Asymmetric key decryption

Deleting Key

Practical Tutorial

Symmetrical Encryption and Decryption

Asymmetric Encryption and Decryption

Post-Quantum Cryptography Practice In KMS

Importing External Key

Implementing Exponential Backoff to Deal with Service Frequency

Cloud Product Integration with KMS for Transparent Encryption

API documentation

History

Introduction

API Category

Key APIs

Making API Requests

Asymmetric Key APIs

Data Types

Error Codes

Service Level Agreement

FAQS

FAQs

General

KMS Policy

Data Processing And Security Agreement

Glossary

Key Rotation

PDF

Focus Mode

Font Size

Last updated: 2024-01-11 16:28:54

Overview
The key rotation feature involves three APIs:
API Name
Description
Note
GetKeyRotationStatus
Views key rotation status
The KeyId parameter is required for this API. For more information, please see the GetKeyRotationStatus API document.
EnableKeyRotation
Enables key rotation
The KeyId parameter is required for this API. For more information, please see the EnableKeyRotation API document.
DisableKeyRotation
Disables key rotation
The KeyId parameter is required for this API. For more information, please see the DisableKeyRotation API document.
The examples below are called with TCCLI, which can also be called with any supported programming languages.
Examples
Viewing key rotation status
Input
tccli kms GetKeyRotationStatus --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4
Output
If the API is called successfully, the key rotation status of the CMK will be returned.
{
   "KeyRotationEnabled": false,
   "RequestId": "e1432224-4dc2-48da-a8e8-e84d30afd9ef"
}
Enabling key rotation
Input
tccli kms EnableKeyRotation --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4
Output
If the feature is enabled normally, the request information as shown below will be returned.
{
    "RequestId": "4e0fa96f-e86e-4517-af27-3dfe6e5b2a72"
}
Disabling key rotation
Input
tccli kms DisableKeyRotation --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4
Output
If the feature is disabled normally, the request information as shown below will be returned.
{
    "RequestId": "c8b73c8b-1ee5-4b23-b800-7cccc58e7ffb"
}
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Key Management Service

Key Rotation

Overview

Examples

Viewing key rotation status

Input

Output

Enabling key rotation

Input

Output

Disabling key rotation

Input

Output

Help and Support

API Name	Description	Note
GetKeyRotationStatus	Views key rotation status	The `KeyId` parameter is required for this API. For more information, please see the GetKeyRotationStatus API document.
EnableKeyRotation	Enables key rotation	The `KeyId` parameter is required for this API. For more information, please see the EnableKeyRotation API document.
DisableKeyRotation	Disables key rotation	The `KeyId` parameter is required for this API. For more information, please see the DisableKeyRotation API document.