tccli 3.0.1181.1__py2.py3-none-any.whl → 3.0.1183.1__py2.py3-none-any.whl

tccli/services/cdb/v20170320/api.json

@@ -602,6 +602,13 @@
       "output": "DescribeInstanceParamsResponse",
       "status": "online"
     },
+    "DescribeInstanceUpgradeCheckJob": {
+      "document": "该接口（DescribeInstanceUpgradeCheckJob）查询实例版本升级校验任务。",
+      "input": "DescribeInstanceUpgradeCheckJobRequest",
+      "name": "查询实例版本升级校验任务",
+      "output": "DescribeInstanceUpgradeCheckJobResponse",
+      "status": "online"
+    },
     "DescribeInstanceUpgradeType": {
       "document": "本接口(DescribeInstanceUpgradeType)用于查询数据库实例升级类型。",
       "input": "DescribeInstanceUpgradeTypeRequest",
@@ -1120,6 +1127,13 @@
       "output": "StopRollbackResponse",
       "status": "online"
     },
+    "SubmitInstanceUpgradeCheckJob": {
+      "document": "该接口（SubmitInstanceUpgradeCheckJob）提交实例版本升级校验任务。",
+      "input": "SubmitInstanceUpgradeCheckJobRequest",
+      "name": "提交实例版本升级检查任务",
+      "output": "SubmitInstanceUpgradeCheckJobResponse",
+      "status": "online"
+    },
     "SwitchCDBProxy": {
       "document": "数据库代理配置变更或则升级版本后手动发起立即切换",
       "input": "SwitchCDBProxyRequest",
@@ -4194,6 +4208,45 @@
       ],
       "type": "object"
     },
+    "ClusterInfo": {
+      "document": "集群版节点信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "节点id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"dbn-ipffzoum\"",
+          "member": "string",
+          "name": "NodeId",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "节点类型：主节点，从节点\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"master\"",
+          "member": "string",
+          "name": "Role",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "地域\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"ap-guangzhou\"",
+          "member": "string",
+          "name": "Zone",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "ClusterNodeInfo": {
       "document": "集群版实例节点信息",
       "members": [
@@ -10072,6 +10125,15 @@
           "name": "EngineTypes",
           "required": false,
           "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "是否获取集群版实例节点信息，可填：true或false",
+          "example": "无",
+          "member": "bool",
+          "name": "QueryClusterInfo",
+          "required": false,
+          "type": "bool"
         }
       ],
       "type": "object"
@@ -11067,6 +11129,62 @@
       ],
       "type": "object"
     },
+    "DescribeInstanceUpgradeCheckJobRequest": {
+      "document": "DescribeInstanceUpgradeCheckJob请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例ID",
+          "example": "\"cdb-g3rbtabc\"",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "目标数据库版本",
+          "example": "\"8.0\"",
+          "member": "string",
+          "name": "DstMysqlVersion",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeInstanceUpgradeCheckJobResponse": {
+      "document": "DescribeInstanceUpgradeCheckJob返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "24小时内是否存在历史升级校验任务",
+          "example": "true",
+          "member": "bool",
+          "name": "ExistUpgradeCheckJob",
+          "output_required": true,
+          "type": "bool",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务id",
+          "example": "123",
+          "member": "int64",
+          "name": "JobId",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeInstanceUpgradeTypeRequest": {
       "document": "DescribeInstanceUpgradeType请求参数结构体",
       "members": [
@@ -12570,6 +12688,7 @@
           "example": "5",
           "member": "int64",
           "name": "TotalCount",
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -12579,6 +12698,7 @@
           "example": "无",
           "member": "TaskDetail",
           "name": "Items",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -14125,6 +14245,16 @@
           "output_required": false,
           "type": "int",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "实例集群版节点信息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ClusterInfo",
+          "name": "ClusterInfo",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"
@@ -19790,6 +19920,52 @@
       ],
       "type": "object"
     },
+    "SubmitInstanceUpgradeCheckJobRequest": {
+      "document": "SubmitInstanceUpgradeCheckJob请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例D",
+          "example": "\"cdb-g3rbtabc\"",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "目标数据库版本",
+          "example": "\"8.0\"",
+          "member": "string",
+          "name": "DstMysqlVersion",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "SubmitInstanceUpgradeCheckJobResponse": {
+      "document": "SubmitInstanceUpgradeCheckJob返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "任务ID",
+          "example": "123",
+          "member": "int64",
+          "name": "JobId",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "SwitchCDBProxyRequest": {
       "document": "SwitchCDBProxy请求参数结构体",
       "members": [
@@ -20382,6 +20558,15 @@
           "required": false,
           "type": "int"
         },
+        {
+          "disabled": false,
+          "document": "5.7升级8.0是否忽略关键字错误，取值范围[0,1]，1表示忽略，0表示不忽略",
+          "example": "1",
+          "member": "int64",
+          "name": "IgnoreErrKeyword",
+          "required": false,
+          "type": "int"
+        },
         {
           "disabled": false,
           "document": "版本升级支持指定参数",

tccli/services/cdb/v20170320/examples.json

@@ -730,6 +730,14 @@
         "title": "查询实例的可设置参数列表"
       }
     ],
+    "DescribeInstanceUpgradeCheckJob": [
+      {
+        "document": "无",
+        "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceUpgradeCheckJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"037c0b3b-1320-11ee-b0c3-6c92bf629868\",\n    \"DstMysqlVersion\": \"8.0\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ExistUpgradeCheckJob\": true,\n        \"JobId\": 145,\n        \"RequestId\": \"60b5d6cd-aecc-4740-a681-353e645293b4\"\n    }\n}",
+        "title": "查询实例升级检查任务"
+      }
+    ],
     "DescribeInstanceUpgradeType": [
       {
         "document": "",
@@ -878,7 +886,7 @@
       {
         "document": "查询云数据库实例任务列表",
         "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTasks\n<公共请求参数>\n\n{}",
-        "output": "{\n    \"Response\": {\n        \"TotalCount\": 5,\n        \"Items\": [\n            {\n                \"Code\": 9013,\n                \"Message\": \"[Operate CDB Fail][Upgrade Service Fail!] reason: ERR#-999: lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n                \"JobId\": 79,\n                \"AsyncRequestId\": \"9d21004b-3aa1896a-eeddca4b-a68f106d\",\n                \"Progress\": 10,\n                \"StartTime\": \"2019-10-09 20:03:39\",\n                \"EndTime\": \"2019-10-09 20:39:34\",\n                \"InstanceIds\": [\n                    \"cdb-qlfpnobr\"\n                ],\n                \"TaskType\": \"OPEN GTID\",\n                \"TaskStatus\": \"FAILED\"\n            },\n            {\n                \"Code\": 0,\n                \"Message\": \"设置参数成功\",\n                \"JobId\": 70,\n                \"AsyncRequestId\": \"1d564380-2e391736-f28fa246-43cea3aa\",\n                \"Progress\": 100,\n                \"StartTime\": \"2018-07-06 22:03:05\",\n                \"EndTime\": \"2018-07-06 22:03:28\",\n                \"InstanceIds\": [\n                    \"cdb-6kd9h71i\"\n                ],\n                \"TaskType\": \"MODIFY PARAM\",\n                \"TaskStatus\": \"SUCCEED\"\n            },\n            {\n                \"Code\": 0,\n                \"Message\": \"初始化实例成功\",\n                \"JobId\": 69,\n                \"AsyncRequestId\": \"ea39295d-420a0b4e-a98298c7-8751e1ad\",\n                \"Progress\": 100,\n                \"StartTime\": \"2018-07-06 22:01:42\",\n                \"EndTime\": \"2018-07-06 22:02:26\",\n                \"InstanceIds\": [\n                    \"cdb-6kd9h71i\"\n                ],\n                \"TaskType\": \"INITIAL\",\n                \"TaskStatus\": \"SUCCEED\"\n            },\n            {\n                \"Code\": 0,\n                \"Message\": \"实例升级任务完成\",\n                \"JobId\": 68,\n                \"AsyncRequestId\": \"\",\n                \"Progress\": 100,\n                \"StartTime\": \"2018-07-05 23:53:48\",\n                \"EndTime\": \"2018-07-06 22:05:10\",\n                \"InstanceIds\": [\n                    \"cdb-6kd9h71i\"\n                ],\n                \"TaskType\": \"UPGRADE MASTER\",\n                \"TaskStatus\": \"SUCCEED\"\n            },\n            {\n                \"Code\": -1,\n                \"Message\": \"设置参数失败\",\n                \"JobId\": 66,\n                \"AsyncRequestId\": \"780b2e32-79cb0f4c-ec7854c5-44ff5371\",\n                \"Progress\": 0,\n                \"StartTime\": \"2018-07-05 23:30:36\",\n                \"EndTime\": \"2018-07-05 23:30:37\",\n                \"InstanceIds\": [\n                    \"cdb-o02fxj9g\"\n                ],\n                \"TaskType\": \"MODIFY PARAM\",\n                \"TaskStatus\": \"FAILED\"\n            }\n        ],\n        \"RequestId\": \"9a4b22f5-0f93-4a72-ba05-1eb6cdf37a1e\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 5,\n        \"Items\": [\n            {\n                \"Code\": 9013,\n                \"Message\": \"[Operate CDB Fail][Upgrade Service Fail!] reason: ERR#-999: lock_inst.cgi: 某些实例id不存在对应的实例记录\",\n                \"JobId\": 79,\n                \"AsyncRequestId\": \"9d21004b-3aa1896a-eeddca4b-a68f106d\",\n                \"TaskAttachInfo\": [],\n                \"Progress\": 10,\n                \"StartTime\": \"2019-10-09 20:03:39\",\n                \"EndTime\": \"2019-10-09 20:39:34\",\n                \"InstanceIds\": [\n                    \"cdb-qlfpnobr\"\n                ],\n                \"TaskType\": \"OPEN GTID\",\n                \"TaskStatus\": \"FAILED\"\n            },\n            {\n                \"Code\": 0,\n                \"Message\": \"设置参数成功\",\n                \"JobId\": 70,\n                \"AsyncRequestId\": \"1d564380-2e391736-f28fa246-43cea3aa\",\n                \"TaskAttachInfo\": [],\n                \"Progress\": 100,\n                \"StartTime\": \"2018-07-06 22:03:05\",\n                \"EndTime\": \"2018-07-06 22:03:28\",\n                \"InstanceIds\": [\n                    \"cdb-6kd9h71i\"\n                ],\n                \"TaskType\": \"MODIFY PARAM\",\n                \"TaskStatus\": \"SUCCEED\"\n            },\n            {\n                \"Code\": 0,\n                \"Message\": \"初始化实例成功\",\n                \"JobId\": 69,\n                \"AsyncRequestId\": \"ea39295d-420a0b4e-a98298c7-8751e1ad\",\n                \"TaskAttachInfo\": [],\n                \"Progress\": 100,\n                \"StartTime\": \"2018-07-06 22:01:42\",\n                \"EndTime\": \"2018-07-06 22:02:26\",\n                \"InstanceIds\": [\n                    \"cdb-6kd9h71i\"\n                ],\n                \"TaskType\": \"INITIAL\",\n                \"TaskStatus\": \"SUCCEED\"\n            },\n            {\n                \"Code\": 0,\n                \"Message\": \"实例升级任务完成\",\n                \"JobId\": 68,\n                \"AsyncRequestId\": \"\",\n                \"TaskAttachInfo\": [\n                    {\n                        \"AttachKey\": \"FastUpgradeStatus\",\n                        \"AttachValue\": \"1\"\n                    }\n                ],\n                \"Progress\": 100,\n                \"StartTime\": \"2018-07-05 23:53:48\",\n                \"EndTime\": \"2018-07-06 22:05:10\",\n                \"InstanceIds\": [\n                    \"cdb-6kd9h71i\"\n                ],\n                \"TaskType\": \"UPGRADE MASTER\",\n                \"TaskStatus\": \"SUCCEED\"\n            },\n            {\n                \"Code\": -1,\n                \"Message\": \"设置参数失败\",\n                \"JobId\": 66,\n                \"AsyncRequestId\": \"780b2e32-79cb0f4c-ec7854c5-44ff5371\",\n                \"TaskAttachInfo\": [],\n                \"Progress\": 0,\n                \"StartTime\": \"2018-07-05 23:30:36\",\n                \"EndTime\": \"2018-07-05 23:30:37\",\n                \"InstanceIds\": [\n                    \"cdb-o02fxj9g\"\n                ],\n                \"TaskType\": \"MODIFY PARAM\",\n                \"TaskStatus\": \"FAILED\"\n            }\n        ],\n        \"RequestId\": \"9a4b22f5-0f93-4a72-ba05-1eb6cdf37a1e\"\n    }\n}",
         "title": "查询云数据库实例任务列表"
       }
     ],
@@ -1328,6 +1336,14 @@
         "title": "撤销回档任务"
       }
     ],
+    "SubmitInstanceUpgradeCheckJob": [
+      {
+        "document": "无",
+        "input": "POST / HTTP/1.1\nHost: cdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SubmitInstanceUpgradeCheckJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"037c0b3b-1320-11ee-b0c3-6c92bf629868\",\n    \"DstMysqlVersion\": \"8.0\"\n}",
+        "output": "{\n    \"Response\": {\n        \"JobId\": 145,\n        \"RequestId\": \"a4b54232-d7af-4df3-8329-5110e3ece9c3\"\n    }\n}",
+        "title": "提交实例升级检查任务"
+      }
+    ],
     "SwitchCDBProxy": [
       {
         "document": "",

tccli/services/cdwdoris/v20211228/api.json

@@ -3734,7 +3734,7 @@
         },
         {
           "disabled": false,
-          "document": "搜索标签列表",
+          "document": "搜索标签列表，没匹配到则不过滤集群列表",
           "example": "无",
           "member": "SearchTags",
           "name": "SearchTags",
@@ -4239,6 +4239,33 @@
     "DescribeSqlApisRequest": {
       "document": "DescribeSqlApis请求参数结构体",
       "members": [
+        {
+          "disabled": false,
+          "document": "实例id",
+          "example": "cdwch-xxxx",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "GetUsers：获取用户列表；\nGetDatabases：获取数据库列表；\nGetTables：获取数据库表列表；\nGetUserPrivilegesV2：获取用户下的权限，粒度到表级别；\nDeleteUser：删除用户；\nGetCatalog：获取Catalog列表；",
+          "example": "GetClusters",
+          "member": "string",
+          "name": "ApiType",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "用户名称",
+          "example": "user1",
+          "member": "string",
+          "name": "UserName",
+          "required": false,
+          "type": "string"
+        },
         {
           "disabled": false,
           "document": "用户链接来自的 IP",
@@ -4265,6 +4292,24 @@
           "name": "Catalogs",
           "required": false,
           "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "数据库名",
+          "example": "无",
+          "member": "string",
+          "name": "DatabaseName",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "表名",
+          "example": "无",
+          "member": "string",
+          "name": "TableName",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -4272,6 +4317,26 @@
     "DescribeSqlApisResponse": {
       "document": "DescribeSqlApis返回参数结构体",
       "members": [
+        {
+          "disabled": false,
+          "document": "返回的查询数据，大部分情况是list，也可能是bool\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "-",
+          "member": "string",
+          "name": "ReturnData",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "错误消息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "-",
+          "member": "string",
+          "name": "ErrorMsg",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
         {
           "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
           "member": "string",
@@ -7614,8 +7679,7 @@
           "member": "string",
           "name": "TagKey",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
@@ -7624,18 +7688,16 @@
           "member": "string",
           "name": "TagValue",
           "required": false,
-          "type": "string",
-          "value_allowed_null": false
+          "type": "string"
         },
         {
           "disabled": false,
-          "document": "1表示只输入标签的键，没有输入值；0表示输入键时且输入值",
+          "document": "1表示只输入标签的键，没有输入值；非1则表示输入键时且输入值",
           "example": "1",
           "member": "int64",
           "name": "AllValue",
           "required": false,
-          "type": "int",
-          "value_allowed_null": false
+          "type": "int"
         }
       ],
       "usage": "in"

tccli/services/cdwdoris/v20211228/examples.json

@@ -289,8 +289,8 @@
     "DescribeSqlApis": [
       {
         "document": "查询集群信息",
-        "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSqlApis\n<公共请求参数>\n\n{}",
-        "output": "{\n    \"Response\": {\n        \"RequestId\": \"abc\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSqlApis\n<公共请求参数>\n\n{\n    \"InstanceId\": \"abc\",\n    \"ApiType\": \"abc\",\n    \"UserName\": \"abc\",\n    \"WhiteHost\": \"abc\",\n    \"Catalog\": \"abc\",\n    \"Catalogs\": [\n        \"abc\"\n    ],\n    \"DatabaseName\": \"abc\",\n    \"TableName\": \"abc\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ReturnData\": \"abc\",\n        \"ErrorMsg\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
         "title": "查询集群信息"
       }
     ],