tccli 3.0.1215.1__py2.py3-none-any.whl → 3.0.1217.1__py2.py3-none-any.whl

tccli/services/dcdb/v20180411/api.json

@@ -70,6 +70,13 @@
       "output": "CreateHourDCDBInstanceResponse",
       "status": "online"
     },
+    "CreateOnlineDDLJob": {
+      "document": "创建在线DDL任务",
+      "input": "CreateOnlineDDLJobRequest",
+      "name": "创建在线DDL任务",
+      "output": "CreateOnlineDDLJobResponse",
+      "status": "online"
+    },
     "CreateTmpDCDBInstance": {
       "document": "回档TDSQL实例",
       "input": "CreateTmpDCDBInstanceRequest",
@@ -2085,6 +2092,133 @@
       ],
       "type": "object"
     },
+    "CreateOnlineDDLJobRequest": {
+      "document": "CreateOnlineDDLJob请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例Id",
+          "example": "tdsqlshard-gayfdsflx",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要执行的 DDL 语句。常用的在线DDL参考此API文档示例部分",
+          "example": "alter table test_tbl add column add_col_2 int not null;",
+          "member": "string",
+          "name": "Alter",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要修改的数据库\t",
+          "example": "test_db",
+          "member": "string",
+          "name": "DbName",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "要修改的表",
+          "example": "test_tbl",
+          "member": "string",
+          "name": "Table",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "指定账号执行DDL，需确保账号有 ALTER, CREATE, INSERT, UPDATE, DROP, DELETE, INDEX, CREATE TEMPORARY TABLES, LOCK TABLES, TRIGGER, REPLICATION CLIENT, REPLICATION SLAVE 等相关权限 （若不填写将默认使用系统账号）",
+          "example": "test_user",
+          "member": "string",
+          "name": "User",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "指定账号的密码",
+          "example": "test_pwd",
+          "member": "string",
+          "name": "Password",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "运行线程数大于此值时，将终止DDL。不填则默认58",
+          "example": "30",
+          "member": "int64",
+          "name": "CriticalLoad",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "是否检查自增字段。为1则不允许修改自增字段，0或不填写则不检查",
+          "example": "1",
+          "member": "int64",
+          "name": "CheckAutoInc",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "允许的主备延迟时间(单位s)，0或不填写则不检查延迟",
+          "example": "5",
+          "member": "int64",
+          "name": "MaxDelay",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "是否使用pt-osc工具做DDL",
+          "example": "1",
+          "member": "int64",
+          "name": "UsePt",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "开始执行时间",
+          "example": "2024-04-01 01:00:00",
+          "member": "string",
+          "name": "StartTime",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateOnlineDDLJobResponse": {
+      "document": "CreateOnlineDDLJob返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "在线DDL任务Id",
+          "example": "1314",
+          "member": "int64",
+          "name": "FlowId",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateTmpDCDBInstanceRequest": {
       "document": "CreateTmpDCDBInstance请求参数结构体",
       "members": [
@@ -8069,7 +8203,7 @@
           "example": "long_query_time",
           "member": "string",
           "name": "Param",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -8079,7 +8213,7 @@
           "example": "1",
           "member": "string",
           "name": "Value",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -8089,7 +8223,7 @@
           "example": "2",
           "member": "string",
           "name": "SetValue",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -8099,7 +8233,7 @@
           "example": "1",
           "member": "string",
           "name": "Default",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -8109,7 +8243,7 @@
           "example": "无",
           "member": "ParamConstraint",
           "name": "Constraint",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": false
         },
@@ -8119,7 +8253,7 @@
           "example": "true",
           "member": "bool",
           "name": "HaveSetValue",
-          "required": true,
+          "output_required": true,
           "type": "bool",
           "value_allowed_null": false
         },
@@ -8129,7 +8263,7 @@
           "example": "false",
           "member": "bool",
           "name": "NeedRestart",
-          "required": true,
+          "output_required": true,
           "type": "bool",
           "value_allowed_null": false
         }

tccli/services/dcdb/v20180411/examples.json

@@ -80,6 +80,38 @@
         "title": "创建TDSQL按量计费实例"
       }
     ],
+    "CreateOnlineDDLJob": [
+      {
+        "document": "为 test_tbl 添加字段",
+        "input": "POST / HTTP/1.1\nHost: dcdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOnlineDDLJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"tdsqlshard-h2yimmox\",\n    \"Alter\": \"alter table test_tbl add column test_add_col  varchar(32) not null default 'test' comment 'test add col';\",\n    \"DbName\": \"test_db\",\n    \"Table\": \"test_tbl\",\n    \"CriticalLoad\": 58,\n    \"CheckAutoInc\": 0,\n    \"MaxDelay\": 10,\n    \"UsePt\": 1,\n    \"User\": \"test_user\",\n    \"Password\": \"test_pwd\",\n    \"StartTime\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1140696,\n        \"RequestId\": \"bd07e59f-dee8-4680-9a43-492a8a52c894\"\n    }\n}",
+        "title": "添加字段"
+      },
+      {
+        "document": "为 test_tbl添加索引\n添加唯一索引 ：alter table test_tbl add unique key my_idx(id,name); \n添加普通索引：alter table test_tbl add key my_idx_1(id,name); ",
+        "input": "POST / HTTP/1.1\nHost: dcdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOnlineDDLJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"tdsql-4z38cfwj\",\n    \"Alter\": \"alter table test_tbl add unique key my_idx(id,name); \",\n    \"DbName\": \"test_db\",\n    \"Table\": \"test_tbl\",\n    \"CriticalLoad\": 58,\n    \"CheckAutoInc\": 0,\n    \"MaxDelay\": 10,\n    \"UsePt\": 1,\n    \"User\": \"test_user\",\n    \"Password\": \"test_pwd\",\n    \"StartTime\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1140697,\n        \"RequestId\": \"c5afb15f-70c8-4e71-84b5-688dd326a8c3\"\n    }\n}",
+        "title": "添加索引"
+      },
+      {
+        "document": "从test_tbl删除字段 test_add_col ",
+        "input": "POST / HTTP/1.1\nHost: dcdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOnlineDDLJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"tdsqlshard-h2yimmox\",\n    \"Alter\": \"alter table test_tbl drop column test_add_col; \",\n    \"DbName\": \"test_db\",\n    \"Table\": \"test_tbl\",\n    \"CriticalLoad\": 58,\n    \"CheckAutoInc\": 0,\n    \"MaxDelay\": 10,\n    \"UsePt\": 1,\n    \"User\": \"test_user\",\n    \"Password\": \"test_pwd\",\n    \"StartTime\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1140698,\n        \"RequestId\": \"a9f824be-fc53-41f7-9e24-2aca60457331\"\n    }\n}",
+        "title": "删除字段"
+      },
+      {
+        "document": "将 test_tbl 表字段 test_add_col 从varchar(32) 修改为 varchar(64)",
+        "input": "POST / HTTP/1.1\nHost: dcdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOnlineDDLJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"tdsqlshard-h2yimmox\",\n    \"Alter\": \"alter table test_tbl modify column test_add_col varchar(64) not null default 'test' comment 'test change type'; \",\n    \"DbName\": \"test_db\",\n    \"Table\": \"test_tbl\",\n    \"CriticalLoad\": 58,\n    \"CheckAutoInc\": 0,\n    \"MaxDelay\": 10,\n    \"UsePt\": 1,\n    \"User\": \"test_user\",\n    \"Password\": \"test_pwd\",\n    \"StartTime\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1140699,\n        \"RequestId\": \"7e2e0512-e429-4702-a9a6-d920eebd6536\"\n    }\n}",
+        "title": "修改字段"
+      },
+      {
+        "document": "表空间优化",
+        "input": "POST / HTTP/1.1\nHost: dcdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateOnlineDDLJob\n<公共请求参数>\n\n{\n    \"InstanceId\": \"tdsqlshard-h2yimmox\",\n    \"Alter\": \"alter table test_tbl engine=innodb; \",\n    \"DbName\": \"test_db\",\n    \"Table\": \"test_tbl\",\n    \"CriticalLoad\": 58,\n    \"CheckAutoInc\": 0,\n    \"MaxDelay\": 10,\n    \"UsePt\": 1,\n    \"User\": \"test_user\",\n    \"Password\": \"test_pwd\",\n    \"StartTime\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"FlowId\": 1140701,\n        \"RequestId\": \"9df10ff7-9db5-4cad-81e2-3ad742f7bc06\"\n    }\n}",
+        "title": "表空间优化"
+      }
+    ],
     "CreateTmpDCDBInstance": [
       {
         "document": "回档TDSQL分布式数据库实例",

tccli/services/dlc/v20210125/api.json

@@ -10981,7 +10981,7 @@
         },
         {
           "disabled": false,
-          "document": "排序字段，支持如下字段类型，instance-start-time (任务开始时间）, instance-complete-time (任务结束时间）,job-time-sum （单位毫秒，引擎内执行耗时）,task-time-sum （CU资源消耗，单位秒）,input-bytes-sum（数据扫描总大小，单位bytes）,shuffle-read-bytes-sum（数据shuffle总大小，单位bytes）",
+          "document": "排序字段，支持如下字段类型，instance-start-time (任务开始时间）,job-time-sum （单位毫秒，引擎内执行耗时）,task-time-sum （CU资源消耗，单位秒）,input-bytes-sum（数据扫描总大小，单位bytes）,shuffle-read-bytes-sum（数据shuffle总大小，单位bytes）",
           "example": "instance-start-time",
           "member": "string",
           "name": "SortBy",
@@ -10999,7 +10999,7 @@
         },
         {
           "disabled": false,
-          "document": "起始时间点，格式为yyyy-mm-dd HH:MM:SS",
+          "document": "任务开始时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近30天数据查询。默认为当前时刻",
           "example": "2019-01-21 00:00:00",
           "member": "string",
           "name": "StartTime",
@@ -11008,7 +11008,7 @@
         },
         {
           "disabled": false,
-          "document": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近45天数据查询。默认为当前时刻",
+          "document": "结束时间点，格式为yyyy-mm-dd HH:MM:SS时间跨度在(0,30天]，支持最近30天数据查询。默认为当前时刻",
           "example": "2019-01-22 00:00:00",
           "member": "string",
           "name": "EndTime",
@@ -19647,7 +19647,7 @@
           "example": "12",
           "member": "int64",
           "name": "WorkGroupId",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": true
         },
@@ -19657,7 +19657,7 @@
           "example": "testGroup",
           "member": "string",
           "name": "WorkGroupName",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -19667,7 +19667,7 @@
           "example": "User",
           "member": "string",
           "name": "Type",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -19677,7 +19677,7 @@
           "example": "无",
           "member": "Users",
           "name": "UserInfo",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": true
         },
@@ -19687,7 +19687,7 @@
           "example": "无",
           "member": "Policys",
           "name": "DataPolicyInfo",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": true
         },
@@ -19697,7 +19697,7 @@
           "example": "无",
           "member": "Policys",
           "name": "EnginePolicyInfo",
-          "required": true,
+          "output_required": true,
           "type": "object",
           "value_allowed_null": true
         },
@@ -19707,7 +19707,7 @@
           "example": "group for admin",
           "member": "string",
           "name": "WorkGroupDescription",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": true
         },
@@ -19717,7 +19717,17 @@
           "example": "无",
           "member": "Policys",
           "name": "RowFilterInfo",
-          "required": true,
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "数据目录权限集\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "Policy",
+          "name": "CatalogPolicyInfo",
+          "output_required": false,
           "type": "object",
           "value_allowed_null": true
         }