tccli-intl-en 3.1.1.1__py2.py3-none-any.whl → 3.1.11.1__py2.py3-none-any.whl

tccli/services/mongodb/v20190725/examples.json

@@ -8,6 +8,14 @@
         "title": "Specifying the Associated Project of a TencentDB for MongoDB Instance"
       }
     ],
+    "CreateAccountUser": [
+      {
+        "document": "This example shows you how to customize an instance account.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAccountUser\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-9d0p****\",\n    \"UserName\": \"test_user\",\n    \"Password\": \"Abc@123...\",\n    \"MongoUserPassword\": \"Abc@123...\",\n    \"UserDesc\": \"Test user\",\n    \"AuthRole\": [\n        {\n            \"Mask\": 0,\n            \"NameSpace\": \"collection\"\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1680767468,\n        \"RequestId\": \"1df930fb-eb7e-4e3f-bcab-15a1aa5fede0\"\n    }\n}",
+        "title": "Customizing an Account"
+      }
+    ],
     "CreateBackupDBInstance": [
       {
         "document": "This example shows how to back up an instance.",
@@ -40,6 +48,30 @@
         "title": "Creating a TencentDB for MongoDB Instance (Pay-as-You-Go)"
       }
     ],
+    "CreateLogDownloadTask": [
+      {
+        "document": "This example shows you how to create a log download task.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateLogDownloadTask\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-k2p5su09\",\n    \"StartTime\": \"2024-03-07 9:22:15\",\n    \"EndTime\": \"2024-03-07 15:33:15\",\n    \"LogComponents\": [\n        \"NETWORK\"\n    ],\n    \"LogConnections\": [],\n    \"LogIds\": [],\n    \"LogDetailParams\": [\n        \"client metadata\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Status\": 0,\n        \"RequestId\": \"1233vvae-23f9dfd\"\n    }\n}",
+        "title": "Creating a Log Download Task"
+      }
+    ],
+    "DeleteAccountUser": [
+      {
+        "document": "This example shows you how to delete an instance account.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteAccountUser\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-9d0p****\",\n    \"UserName\": \"test_user\",\n    \"MongoUserPassword\": \"Abc@123\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 0,\n        \"RequestId\": \"1df930fb-eb7e-4e3f-bcab-15a1aa5fede0\"\n    }\n}",
+        "title": "Deleting an Instance Account"
+      }
+    ],
+    "DeleteLogDownloadTask": [
+      {
+        "document": "This example shows you how to delete a log download task.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteLogDownloadTask\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-k2p5su09\",\n    \"TaskId\": \"export-28439fb3-90a6-4ca2-bd2f-ad99e99a14e9\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"q87sfsfds-897asd\",\n        \"Status\": 0\n    }\n}",
+        "title": "Deleting a Log Download Task"
+      }
+    ],
     "DescribeAsyncRequestInfo": [
       {
         "document": " ",
@@ -56,6 +88,14 @@
         "title": "Querying a Backup Download Task"
       }
     ],
+    "DescribeBackupRules": [
+      {
+        "document": "This example shows you how to query the automatic backup rule information of an instance.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeBackupRules\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-9d0p****\"\n}",
+        "output": "{\n    \"Response\": {\n        \"BackupMethod\": 0,\n        \"BackupSaveTime\": 7,\n        \"BackupTime\": 1,\n        \"RequestId\": \"07ec4290-d682-11ed-aa06-f56fb86dae78\"\n    }\n}",
+        "title": "Querying the Automatic Backup Rule Information of an Instance"
+      }
+    ],
     "DescribeClientConnections": [
       {
         "document": "This example shows you how to query the client connection information on a TencentDB for MongoDB instance.",
@@ -64,6 +104,14 @@
         "title": "Querying the Client Connection Information on a TencentDB for MongoDB Instance"
       }
     ],
+    "DescribeCurrentOp": [
+      {
+        "document": "This example shows you how to query the current operation on the TencentDB for MongoDB instance.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeCurrentOp\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-r3p8****\",\n    \"State\": \"primary\"\n}",
+        "output": "{\n    \"Response\": {\n        \"CurrentOps\": [\n            {\n                \"ExecNode\": \"Primary node\",\n                \"MicrosecsRunning\": 103,\n                \"NodeName\": \"**.**.**.**:****:*********\",\n                \"Ns\": \"admin.$cmd.aggregate\",\n                \"Op\": \"command\",\n                \"OpId\": 42431451,\n                \"Operation\": \"{\\\"Active\\\":true,\\\"AppName\\\":\\\"CMongo\\\",\\\"Client\\\":\\\"**.**.**.**:**\\\",\\\"ClientMetadata\\\":{\\\"application\\\":{\\\"name\\\":\\\"CMongo\\\"},\\\"driver\\\":{\\\"name\\\":\\\"mongo-go-driver\\\",\\\"version\\\":\\\"v1.*.*\\\"},\\\"os\\\":{\\\"architecture\\\":\\\"amd64\\\",\\\"type\\\":\\\"linux\\\"},\\\"platform\\\":\\\"***.**.*\\\"},\\\"Command\\\":{\\\"$db\\\":\\\"admin\\\",\\\"$readPreference\\\":{\\\"mode\\\":\\\"primaryPreferred\\\"},\\\"currentOp\\\":1,\\\"lsid\\\":{\\\"id\\\":{\\\"Data\\\":\\\"************************==\\\",\\\"Subtype\\\":4}},\\\"microsecs_running\\\":{\\\"$gt\\\":0}},\\\"ConnectionId\\\":********,\\\"CurrentOpTime\\\":\\\"2025-09-25T17:41:42.146+0800\\\",\\\"Desc\\\":\\\"conn*******\\\",\\\"Host\\\":\\\"*******64.site:7029\\\",\\\"Insert\\\":null,\\\"KillPending\\\":false,\\\"LockStats\\\":{},\\\"Locks\\\":{},\\\"Lsid\\\":{\\\"id\\\":{\\\"Data\\\":\\\"*******************==\\\",\\\"Subtype\\\":4},\\\"uid\\\":{\\\"Data\\\":\\\"********************************=\\\",\\\"Subtype\\\":0}},\\\"MicroSecsRunning\\\":103,\\\"Msg\\\":\\\"\\\",\\\"Ns\\\":\\\"admin.$cmd.aggregate\\\",\\\"NumYields\\\":0,\\\"Op\\\":\\\"command\\\",\\\"OpId\\\":********,\\\"OriginatingCommand\\\":null,\\\"PlanSummary\\\":\\\"\\\",\\\"Progress\\\":null,\\\"Query\\\":null,\\\"SecsRunning\\\":0,\\\"Transaction\\\":null,\\\"WaitingForLock\\\":false}\",\n                \"Query\": \"{\\\"$db\\\":\\\"admin\\\",\\\"$readPreference\\\":{\\\"mode\\\":\\\"primaryPreferred\\\"},\\\"currentOp\\\":1,\\\"lsid\\\":{\\\"id\\\":{\\\"Data\\\":\\\"***********************==\\\",\\\"Subtype\\\":4}},\\\"microsecs_running\\\":{\\\"$gt\\\":0}}\",\n                \"ReplicaSetName\": \"cmgo-r3p8****_0\",\n                \"State\": \"primary\"\n            }\n        ],\n        \"RequestId\": \"a1f20aaa-83c2-4062-b4f3-7c46ad2e1157\",\n        \"TotalCount\": 1\n    }\n}",
+        "title": "Querying the Current Operation on the TencentDB for MongoDB Instance"
+      }
+    ],
     "DescribeDBBackups": [
       {
         "document": " ",
@@ -126,6 +174,30 @@
         "title": "InstanceEnumParam"
       }
     ],
+    "DescribeInstanceSSL": [
+      {
+        "document": " ",
+        "input": "https://mongodb.tencentcloudapi.com/?Action=DescribeInstanceSSL\n&InstanceId=cmgo-eqmoaxxx\n&<Common request parameters>",
+        "output": "{\n    \"Response\": {\n        \"Status\": 1,\n        \"ExpiredTime\": \"2023-05-04 12:13:00\",\n        \"CertUrl\": \"http://sample/cert\",\n        \"RequestId\": \"12345-abcdef\"\n    }\n}",
+        "title": "Viewing the Enabling Status of SSL for an Instance"
+      }
+    ],
+    "DescribeLogDownloadTasks": [
+      {
+        "document": "This example shows you how to query a log download task.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeLogDownloadTasks\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-k2p5su09\",\n    \"StartTime\": \"2024-03-07 9:22:15\",\n    \"EndTime\": \"2024-03-07 15:33:15\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"832423fdfsfsd-312jdsf\",\n        \"Tasks\": [\n            {\n                \"CreateTime\": \"2024-03-07 21:01:00\",\n                \"FileSize\": 372432,\n                \"Percent\": 100,\n                \"Status\": 2,\n                \"TaskId\": \"export-28439fb3-90a6-4ca2-bd2f-ad99e99a14e9\",\n                \"TaskType\": 0,\n                \"UpdateTime\": \"2024-03-07 21:14:02\",\n                \"Url\": \"\"\n            }\n        ],\n        \"TotalCount\": 1\n    }\n}",
+        "title": "Querying a Log Download Task"
+      }
+    ],
+    "DescribeMongodbLogs": [
+      {
+        "document": "This example shows you how to query instance logs.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMongodbLogs\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-k2p5su09\",\n    \"StartTime\": \"2024-03-07 9:22:15\",\n    \"EndTime\": \"2024-03-07 15:33:15\",\n    \"LogComponents\": [\n        \"NETWORK\"\n    ],\n    \"LogConnections\": [],\n    \"LogIds\": [],\n    \"LogDetailParams\": [\n        \"client metadata\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"LogList\": [\n            {\n                \"LogComponent\": \"NETWORK\",\n                \"LogConnection\": \"conn269939\",\n                \"LogDetail\": \"{\\\"t\\\":{\\\"$date\\\":\\\"2024-03-07T10:29:50.027+08:00\\\"},\\\"s\\\":\\\"I\\\",  \\\"c\\\":\\\"NETWORK\\\",  \\\"id\\\":51800,   \\\"ctx\\\":\\\"conn269939\\\",\\\"msg\\\":\\\"client metadata\\\",\\\"attr\\\":{\\\"remote\\\":\\\"127.0.0.1:39024\\\",\\\"client\\\":\\\"conn269939\\\",\\\"doc\\\":{\\\"driver\\\":{\\\"name\\\":\\\"mongo-go-driver\\\",\\\"version\\\":\\\"v1.10.6\\\"},\\\"os\\\":{\\\"type\\\":\\\"linux\\\",\\\"architecture\\\":\\\"amd64\\\"},\\\"platform\\\":\\\"go1.20.4\\\",\\\"application\\\":{\\\"name\\\":\\\"CMongo\\\"}}}}\",\n                \"LogId\": \"51800\",\n                \"LogLevel\": \"WARNING\",\n                \"LogTime\": \"2024-03-07T10:29:50.027+08:00\"\n            }\n        ],\n        \"RequestId\": \"ab2323tf-rqew1111\",\n        \"TotalCount\": 1\n    }\n}",
+        "title": "Querying Logs"
+      }
+    ],
     "DescribeSecurityGroup": [
       {
         "document": "This example shows you how to query all security groups bound to the current instance.",
@@ -158,6 +230,14 @@
         "title": "Querying Saleable TencentDB for MongoDB Specifications"
       }
     ],
+    "EnableTransparentDataEncryption": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: EnableTransparentDataEncryption\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-igjy****\",\n    \"KmsRegion\": \"ap-guangzhou\",\n    \"KeyId\": \"AKID********************************\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 17316505316,\n        \"RequestId\": \"a8dce7a4-d488-49c9-8d24-33cf623f5992\"\n    }\n}",
+        "title": "Enabling TDE for an Instance"
+      }
+    ],
     "FlushInstanceRouterConfig": [
       {
         "document": " ",
@@ -190,6 +270,14 @@
         "title": "Querying the renewal price of an instance"
       }
     ],
+    "InstanceEnableSSL": [
+      {
+        "document": "This example shows you how to disable SSL.",
+        "input": "https://mongodb.tencentcloudapi.com/?Action=InstanceEnableSSL\n&InstanceId=cmgo-eqmoaxxx\n&Enable=true\n&<Common request parameters>",
+        "output": "{\n    \"Response\": {\n        \"CertUrl\": \"https://cert-****\",\n        \"ExpiredTime\": \"2024-03-29 13:40:56\",\n        \"RequestId\": \"5297ebe2-63f8-465f-be7d-41058ce438\",\n        \"Status\": 1\n    }\n}",
+        "title": "Setting the SSL Status for an Instance"
+      }
+    ],
     "IsolateDBInstance": [
       {
         "document": " ",
@@ -198,6 +286,14 @@
         "title": "Terminating a pay-as-you-go TencentDB instance"
       }
     ],
+    "KillOps": [
+      {
+        "document": " ",
+        "input": "https://mongodb.tencentcloudapi.com/?Action=KillOps\n&InstanceId=cmgo-p8vnipr5\n&Operations.0.ReplicaSetName=cmgo-p8vnipr5_0\n&Operations.0.NodeName=10.108.93.135:7017:39920912\n&Operations.0.OpId=61\n&<Common request parameters>",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"302530d2-ee57-495e-89d0-51e03b11815e\"\n    }\n}",
+        "title": "Terminating a Specific Operation Performed on a TencentDB for MongoDB Instance"
+      }
+    ],
     "ModifyDBInstanceNetworkAddress": [
       {
         "document": "This example shows you how to modify the VIP information on a TencentDB for MongoDB instance.",
@@ -234,6 +330,14 @@
         "title": "Adding Secondary Nodes to a TencentDB for MongoDB Instance"
       }
     ],
+    "ModifyInstanceParams": [
+      {
+        "document": "This example shows you how to initiate a modification task of the parameter configuration for a TencentDB for MongoDB instance.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceParams\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-9d0p6umb\",\n    \"InstanceParams\": [\n        {\n            \"Value\": \"operation.profiling.slowOpThresholdMs\",\n            \"Key\": \"operation.profiling.slowOpThresholdMs\"\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"Changed\": true,\n        \"RequestId\": \"e51b4590-db7b-4835-9899-1f5c33f92fbf\",\n        \"TaskId\": 0\n    }\n}",
+        "title": "Modifying the Parameter for a TencentDB for MongoDB Instance"
+      }
+    ],
     "OfflineIsolatedDBInstance": [
       {
         "document": " ",
@@ -266,6 +370,14 @@
         "title": "Changing the Password of the User Accessing the Instance"
       }
     ],
+    "SetAccountUserPrivilege": [
+      {
+        "document": "This example shows you how to set operation permissions for the specified account of the current instance.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetAccountUserPrivilege\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-9d0p6umb\",\n    \"UserName\": \"test_user\",\n    \"AuthRole\": [\n        {\n            \"Mask\": 0,\n            \"NameSpace\": \"eg_collection\"\n        }\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1680767468,\n        \"RequestId\": \"1df930fb-eb7e-4e3f-bcab-15a1aa5fede0\"\n    }\n}",
+        "title": "Setting Account Permissions for the Current Instance"
+      }
+    ],
     "SetDBInstanceDeletionProtection": [
       {
         "document": "",
@@ -274,6 +386,14 @@
         "title": "Setting Instance Termination Protection"
       }
     ],
+    "SetInstanceMaintenance": [
+      {
+        "document": "This example shows how to modify the instance maintenance window.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetInstanceMaintenance\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-9d0p****\",\n    \"MaintenanceEnd\": \"21:00\",\n    \"MaintenanceStart\": \"20:00\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"1df930fb-eb7e-4e3f-bcab-15a1aa5fede0\"\n    }\n}",
+        "title": "Modifying the Instance Maintenance Window"
+      }
+    ],
     "TerminateDBInstances": [
       {
         "document": "",
@@ -281,6 +401,22 @@
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"ccfe11c0-b1d3-11ea-8b51-552abe435100\"\n    }\n}",
         "title": "Return and Refund for Monthly Subscription Instance"
       }
+    ],
+    "UpgradeDBInstanceKernelVersion": [
+      {
+        "document": "When a new kernel version is launched, you can upgrade the kernel to the latest version.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeDBInstanceKernelVersion\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-p8vnipr5\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"2efcf780-9970-11ec-8975-6bc44e3bfad7\",\n        \"FlowId\": 19677\n    }\n}",
+        "title": "Upgrading the Current Kernel Version Number of the Instance"
+      }
+    ],
+    "UpgradeDbInstanceVersion": [
+      {
+        "document": "This example shows you how to upgrade a TencentDB for MongoDB instance from 3.6 to 4.0.",
+        "input": "POST / HTTP/1.1\nHost: mongodb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpgradeDbInstanceVersion\n<Common request parameters>\n\n{\n    \"InstanceId\": \"cmgo-p8vnipr5\",\n    \"MongoVersion\": \"MONGO_42_WT\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"2efcf780-9970-11ec-8975-6bc44e3bfad7\",\n        \"FlowId\": 19677\n    }\n}",
+        "title": "Upgrading an Instance from 3.6 to 4.0"
+      }
     ]
   },
   "version": "1.0"

tccli/services/monitor/v20180724/api.json

@@ -2247,7 +2247,7 @@
       "document": "BindPrometheusManagedGrafana response structure.",
       "members": [
         {
-          "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
           "member": "string",
           "name": "RequestId",
           "type": "string"
@@ -3172,12 +3172,12 @@
           "example": "arule-f2vx2owo",
           "member": "string",
           "name": "RuleId",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
         {
-          "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
+          "document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
           "member": "string",
           "name": "RequestId",
           "type": "string"