tccli-intl-en 3.0.1188.1__py2.py3-none-any.whl → 3.1.28.1__py2.py3-none-any.whl

tccli/services/kms/v20190118/examples.json

@@ -32,6 +32,14 @@
         "title": "Binding a key with a Tencent Cloud resource"
       }
     ],
+    "CancelDataKeyDeletion": [
+      {
+        "document": "Cancel scheduled deletion for a data key",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CancelDataKeyDeletion\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"2a87094f-4c0e-11f0-8c25-52540073b995\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DataKeyId\": \"2a87094f-4c0e-11f0-8c25-52540073b995\",\n        \"RequestId\": \"9c08a46c-b2cd-448c-970b-581c1ce436c5\"\n    }\n}",
+        "title": "Canceling Scheduled Deletion of a Data Key Example"
+      }
+    ],
     "CancelKeyArchive": [
       {
         "document": " ",
@@ -88,12 +96,28 @@
         "title": "Deleting a white-box key"
       }
     ],
+    "DescribeDataKey": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDataKey\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"c0fb30d1-4ceb-11f0-bcaa-525400eb1719\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DataKeyMetadata\": {\n            \"CreateTime\": 1750323588,\n            \"CreatorUin\": 100000007998,\n            \"DataKeyId\": \"c0fb30d1-4ceb-11f0-bcaa-525400eb1719\",\n            \"DataKeyName\": \"42tofUJQy1gVjfsuIS0sbDoSqtpKuiw3\",\n            \"DeletionDate\": 0,\n            \"Description\": \"TestDateKey_01\",\n            \"HsmClusterId\": \"\",\n            \"KeyId\": \"0397abd8-4029-11f0-aa65-52540064acab\",\n            \"KeyState\": \"Enabled\",\n            \"NumberOfBytes\": 1024,\n            \"Origin\": \"TENCENT_KMS\",\n            \"Owner\": \"user\",\n            \"ResourceId\": \"creatorUin/100000007998/c0fb30d1-4ceb-11f0-bcaa-525400eb1719\"\n        },\n        \"RequestId\": \"46107db0-5b2b-4d1d-b71d-acfefcaf6d12\"\n    }\n}",
+        "title": "Retrieving Data Key Details"
+      }
+    ],
+    "DescribeDataKeys": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDataKeys\n<Common request parameters>\n\n{\n    \"DataKeyIds\": [\n        \"7fe31abf-5018-11f0-b672-52540073b995\",\n        \"8042dfcb-5018-11f0-b672-52540073b995\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"DataKeyMetadatas\": [\n            {\n                \"CreateTime\": 1750672660,\n                \"CreatorUin\": 100000007998,\n                \"DataKeyId\": \"7fe31abf-5018-11f0-b672-52540073b995\",\n                \"DataKeyName\": \"Test6331120\",\n                \"DeletionDate\": 0,\n                \"Description\": \"\",\n                \"HsmClusterId\": \"\",\n                \"KeyId\": \"0397abd8-4029-11f0-aa65-52540064acab\",\n                \"KeyState\": \"Enabled\",\n                \"NumberOfBytes\": 32,\n                \"Origin\": \"EXTERNAL\",\n                \"Owner\": \"user\",\n                \"ResourceId\": \"creatorUin/100000007998/7fe31abf-5018-11f0-b672-52540073b995\"\n            },\n            {\n                \"CreateTime\": 1750672660,\n                \"CreatorUin\": 100000007998,\n                \"DataKeyId\": \"8042dfcb-5018-11f0-b672-52540073b995\",\n                \"DataKeyName\": \"miNAmDEc09znOK7jw9Yi3L9cmq8xk6z1\",\n                \"DeletionDate\": 0,\n                \"Description\": \"TestDateKey_01\",\n                \"HsmClusterId\": \"\",\n                \"KeyId\": \"0397abd8-4029-11f0-aa65-52540064acab\",\n                \"KeyState\": \"Enabled\",\n                \"NumberOfBytes\": 1024,\n                \"Origin\": \"TENCENT_KMS\",\n                \"Owner\": \"user\",\n                \"ResourceId\": \"creatorUin/100000007998/8042dfcb-5018-11f0-b672-52540073b995\"\n            }\n        ],\n        \"RequestId\": \"33c0c722-09e0-4f19-b16b-187a5898fd66\"\n    }\n}",
+        "title": "Retrieving Data Key Detail List Example"
+      }
+    ],
     "DescribeKey": [
       {
-        "document": "This example shows you how to obtain the attribute details of a designated CMK.",
+        "document": "This example shows you how to obtain the detailed information of attributes for the designated CMK.",
         "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeKey\n<Common request parameters>\n\n{\n    \"KeyId\": \"93866e69-9755-11ef-8e65-52540089bc41\"\n}",
-        "output": "{\n    \"Response\": {\n        \"KeyMetadata\": {\n            \"Alias\": \"test11-lzc\",\n            \"CreateTime\": 1730357927,\n            \"CreatorUin\": 700001224419,\n            \"DeletionDate\": 0,\n\"Description\": \"Import an external key\"\n            \"HsmClusterId\": \"cls-hsm-3dflmo9g\",\n            \"KeyId\": \"93866e69-9755-11ef-8e65-52540089bc41\",\n            \"KeyRotationEnabled\": false,\n            \"KeyState\": \"Enabled\",\n            \"KeyUsage\": \"ENCRYPT_DECRYPT\",\n            \"NextRotateTime\": 1761893927,\n            \"Origin\": \"EXTERNAL\",\n            \"Owner\": \"user\",\n            \"ResourceId\": \"creatorUin/700001224419/93866e69-9755-11ef-8e65-52540089bc41\",\n            \"Type\": 4,\n            \"ValidTo\": 0\n        },\n        \"RequestId\": \"5575a949-8eda-497f-bee3-9d8a07763747\"\n    }\n}",
-        "title": "Get CMK Attribute Example"
+        "output": "{\n    \"Response\": {\n        \"KeyMetadata\": {\n            \"Alias\": \"test11-lzc\",\n            \"CreateTime\": 1730357927,\n            \"CreatorUin\": 700001224419,\n            \"DeletionDate\": 0,\n\"Description\": \"Import external key\"\n            \"HsmClusterId\": \"cls-hsm-3dflmo9g\",\n            \"KeyId\": \"93866e69-9755-11ef-8e65-52540089bc41\",\n            \"KeyRotationEnabled\": false,\n            \"KeyState\": \"Enabled\",\n            \"KeyUsage\": \"ENCRYPT_DECRYPT\",\n            \"NextRotateTime\": 1761893927,\n            \"Origin\": \"EXTERNAL\",\n            \"Owner\": \"user\",\n            \"ResourceId\": \"creatorUin/700001224419/93866e69-9755-11ef-8e65-52540089bc41\",\n            \"Type\": 4,\n            \"ValidTo\": 0\n        },\n        \"RequestId\": \"5575a949-8eda-497f-bee3-9d8a07763747\"\n    }\n}",
+        "title": "Retrieving CMK Attributes Example"
       }
     ],
     "DescribeKeys": [
@@ -144,6 +168,22 @@
         "title": "Querying the white-box key service status"
       }
     ],
+    "DisableDataKey": [
+      {
+        "document": "This example shows you how to disable a data key.",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DisableDataKey\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"26299dfb-4f42-11f0-b672-52540073b995\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"7f4bb2ac-283f-41c0-9ff5-0f35cf551609\"\n    }\n}",
+        "title": "Disabling a Data Key Example"
+      }
+    ],
+    "DisableDataKeys": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DisableDataKeys\n<Common request parameters>\n\n{\n    \"DataKeyIds\": [\n        \"7fe31abf-5018-11f0-b672-52540073b995\",\n        \"8042dfcb-5018-11f0-b672-52540073b995\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"1b4bfd47-df00-4494-9131-da3870a76295\"\n    }\n}",
+        "title": "Bulk Disabling Data Keys Example"
+      }
+    ],
     "DisableKey": [
       {
         "document": "Disable the specified CMK.",
@@ -184,6 +224,22 @@
         "title": "Batching disabling white-box keys "
       }
     ],
+    "EnableDataKey": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableDataKey\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"c0fb30d1-4ceb-11f0-bcaa-525400eb1719\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"93a3bea5-f32f-4319-8d8d-956540dfc422\"\n    }\n}",
+        "title": "Enabling a Data Key"
+      }
+    ],
+    "EnableDataKeys": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableDataKeys\n<Common request parameters>\n\n{\n    \"DataKeyIds\": [\n        \"eb46f9c0-5015-11f0-ace9-525400eb1719\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"54d25f02-cb69-4045-9fc8-433eaedcac70\"\n    }\n}",
+        "title": "Batch Enable Data Keys"
+      }
+    ],
     "EnableKey": [
       {
         "document": "Enable a CMK for use.",
@@ -256,6 +312,22 @@
         "title": "Generating a random number"
       }
     ],
+    "GetDataKeyCiphertextBlob": [
+      {
+        "document": "This example shows you how to download the encrypted data key.",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetDataKeyCiphertextBlob\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"cb0f16e6-4f49-11f0-b672-52540073b995\"\n}",
+        "output": "{\n    \"Response\": {\n        \"CiphertextBlob\": \"KoFmB5Ro70M6wfNJe1xlzriwwyn4Ypj6cjXNUbhbEE7+cAtl4ym/EIj3aAzK0Sa6GKgPzyor+zC7bUhRyB5eeQ==-k-fKVP3WIlGpg8m9LMW4jEkQ==-k-yMhT0yaoSueIApZePMxwBZ0y6EjfaKdxvvPhk9LT1ldmhb+Z\",\n        \"RequestId\": \"88d9d828-f019-4625-b0f7-75b57dd2e582\"\n    }\n}",
+        "title": "Downloading a DEK Ciphertext"
+      }
+    ],
+    "GetDataKeyPlaintext": [
+      {
+        "document": "Obtain the plaintext of the data key",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetDataKeyPlaintext\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"cb0f16e6-4f49-11f0-b672-52540073b995\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Plaintext\": \"3434\",\n        \"RequestId\": \"bd05b0b7-8019-44cf-a67e-fd9a940cee82\"\n    }\n}",
+        "title": "Retrieving the Data Key Plaintext Example"
+      }
+    ],
     "GetKeyRotationStatus": [
       {
         "document": "Query whether key rotation is enabled for the specified CMK.",
@@ -296,6 +368,14 @@
         "title": "Querying the service status"
       }
     ],
+    "ImportDataKey": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ImportDataKey\n<Common request parameters>\n\n{\n    \"DataKeyName\": \"test_weijia_0123456\",\n    \"ImportKeyMaterial\": \"MTIzNAo=\",\n    \"ImportType\": 2,\n\"Description\": \"Data key import test\"\n    \"KeyId\": \"0397abd8-4029-11f0-aa65-52540064acab\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DataKeyId\": \"eb46f9c0-5015-11f0-ace9-525400eb1719\",\n        \"KeyId\": \"0397abd8-4029-11f0-aa65-52540064acab\",\n        \"RequestId\": \"85568b48-a19c-43e1-9850-6d9101dc2b3a\"\n    }\n}",
+        "title": "Data Key Import Example"
+      }
+    ],
     "ImportKeyMaterial": [
       {
         "document": " ",
@@ -312,6 +392,22 @@
         "title": "Listing encryption methods supported in the current region"
       }
     ],
+    "ListDataKeyDetail": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListDataKeyDetail\n<Common request parameters>\n\n{\n    \"SearchKeyAlias\": \"e6c1f360-4ceb-11f0-8428-52540073b995\"\n}",
+        "output": "{\n    \"Response\": {\n        \"DataKeyMetadatas\": [\n            {\n                \"CreateTime\": 1750323652,\n                \"CreatorUin\": 100000007998,\n                \"DataKeyId\": \"e6c1f360-4ceb-11f0-8428-52540073b995\",\n                \"DataKeyName\": \"eY66EuC61oAhm6qXyjZAPWhX0Gn9oe8g\",\n                \"DeletionDate\": 1750928452,\n                \"Description\": \"TestDateKey_01\",\n                \"HsmClusterId\": \"\",\n                \"KeyId\": \"0397abd8-4029-11f0-aa65-52540064acab\",\n                \"KeyState\": \"PendingDelete\",\n                \"NumberOfBytes\": 1024,\n                \"Origin\": \"TENCENT_KMS\",\n                \"Owner\": \"user\",\n                \"ResourceId\": \"creatorUin/100000007998/e6c1f360-4ceb-11f0-8428-52540073b995\"\n            }\n        ],\n        \"RequestId\": \"75bd39cb-1e80-4b54-9b83-b991b6f684d6\",\n        \"TotalCount\": 1\n    }\n}",
+        "title": "Retrieving Data Key List Details Example"
+      }
+    ],
+    "ListDataKeys": [
+      {
+        "document": "This example shows you how to retrieve the data key.",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListDataKeys\n<Common request parameters>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"DataKeys\": [\n            {\n                \"DataKeyId\": \"50cc8e9f-4f44-11f0-ace9-525400eb1719\"\n            },\n            {\n                \"DataKeyId\": \"32e9bd2c-4f44-11f0-ace9-525400eb1719\"\n            },\n            {\n                \"DataKeyId\": \"d02ea923-4f43-11f0-b672-52540073b995\"\n            },\n            {\n                \"DataKeyId\": \"1a6a8465-4dc8-11f0-b672-52540073b995\"\n            },\n            {\n                \"DataKeyId\": \"f3fd3a12-4dba-11f0-ace9-525400eb1719\"\n            },\n            {\n                \"DataKeyId\": \"d6e6cf2d-4ceb-11f0-8428-52540073b995\"\n            },\n            {\n                \"DataKeyId\": \"c0fb30d1-4ceb-11f0-bcaa-525400eb1719\"\n            },\n            {\n                \"DataKeyId\": \"72da485a-4ceb-11f0-bcaa-525400eb1719\"\n            },\n            {\n                \"DataKeyId\": \"602b4824-4ceb-11f0-bcaa-525400eb1719\"\n            },\n            {\n                \"DataKeyId\": \"52293da7-4cc1-11f0-a29a-525400eb1719\"\n            }\n        ],\n        \"RequestId\": \"e9033eb2-e7ba-46a6-b83e-3bc2fc8d906c\",\n        \"TotalCount\": 132\n    }\n}",
+        "title": "Get Key List"
+      }
+    ],
     "ListKeyDetail": [
       {
         "document": " ",
@@ -376,6 +472,14 @@
         "title": "Re-Encryption API Example"
       }
     ],
+    "ScheduleDataKeyDeletion": [
+      {
+        "document": "Schedule deletion for a data key",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ScheduleDataKeyDeletion\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"2a87094f-4c0e-11f0-8c25-52540073b995\",\n    \"PendingWindowInDays\": 7\n}",
+        "output": "{\n    \"Response\": {\n        \"DataKeyId\": \"2a87094f-4c0e-11f0-8c25-52540073b995\",\n        \"DeletionDate\": 1751276581,\n        \"RequestId\": \"f610236f-580d-49d3-a766-71163d9108eb\"\n    }\n}",
+        "title": "Example of Scheduling a Data Key for Deletion"
+      }
+    ],
     "ScheduleKeyDeletion": [
       {
         "document": "This example shows you how to delete a specified CMK on the 7th day upon schedule deletion.",
@@ -408,6 +512,28 @@
         "title": "Modifying alias"
       }
     ],
+    "UpdateDataKeyDescription": [
+      {
+        "document": "Modify data key description",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateDataKeyDescription\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"cb0f16e6-4f49-11f0-b672-52540073b995\",\n    \"Description\": \"Test modify description\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"ea9ab121-2339-4176-b2fc-eb6f428789ec\"\n    }\n}",
+        "title": "Modifying Data Key Description Example"
+      },
+      {
+        "document": "Modify Data Key Description",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateDataKeyDescription\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"cb0f16e6-4f49-11f0-b672-52540073b995\",\n    \"Description\": \"Test modify description\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"ea9ab121-2339-4176-b2fc-eb6f428789ec\"\n    }\n}",
+        "title": "Examples of Modifying Data Key Description"
+      }
+    ],
+    "UpdateDataKeyName": [
+      {
+        "document": "Rename a data key",
+        "input": "POST / HTTP/1.1\nHost: kms.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateDataKeyName\n<Common request parameters>\n\n{\n    \"DataKeyId\": \"cb0f16e6-4f49-11f0-b672-52540073b995\",\n    \"DataKeyName\": \"updatedatakeyname\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"130b3e73-e6dc-4adf-b9ea-c3e087be45cb\"\n    }\n}",
+        "title": "Modifying the Key Name of Data"
+      }
+    ],
     "UpdateKeyDescription": [
       {
         "document": "Modify the description of the specified CMK.",