tccli 3.0.1284.1__py2.py3-none-any.whl → 3.0.1286.1__py2.py3-none-any.whl

tccli/services/dlc/dlc_client.py

@@ -381,7 +381,7 @@ def doDescribeWorkGroupInfo(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
-def doListTaskJobLogName(args, parsed_globals):
+def doDescribeTaskMonitorInfos(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
     if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -410,11 +410,11 @@ def doListTaskJobLogName(args, parsed_globals):
     client = mod.DlcClient(cred, g_param[OptionsDefine.Region], profile)
     client._sdkVersion += ("_CLI_" + __version__)
     models = MODELS_MAP[g_param[OptionsDefine.Version]]
-    model = models.ListTaskJobLogNameRequest()
+    model = models.DescribeTaskMonitorInfosRequest()
     model.from_json_string(json.dumps(args))
     start_time = time.time()
     while True:
-        rsp = client.ListTaskJobLogName(model)
+        rsp = client.DescribeTaskMonitorInfos(model)
         result = rsp.to_json_string()
         try:
             json_obj = json.loads(result)
@@ -1785,7 +1785,7 @@ def doDescribeTables(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
-def doModifySparkAppBatch(args, parsed_globals):
+def doListTaskJobLogName(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
     if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -1814,11 +1814,11 @@ def doModifySparkAppBatch(args, parsed_globals):
     client = mod.DlcClient(cred, g_param[OptionsDefine.Region], profile)
     client._sdkVersion += ("_CLI_" + __version__)
     models = MODELS_MAP[g_param[OptionsDefine.Version]]
-    model = models.ModifySparkAppBatchRequest()
+    model = models.ListTaskJobLogNameRequest()
     model.from_json_string(json.dumps(args))
     start_time = time.time()
     while True:
-        rsp = client.ModifySparkAppBatch(model)
+        rsp = client.ListTaskJobLogName(model)
         result = rsp.to_json_string()
         try:
             json_obj = json.loads(result)
@@ -6829,6 +6829,58 @@ def doDeleteThirdPartyAccessUser(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doModifySparkAppBatch(args, parsed_globals):
+    g_param = parse_global_arg(parsed_globals)
+
+    if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
+        cred = credential.CVMRoleCredential()
+    elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
+        cred = credential.STSAssumeRoleCredential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
+            g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
+        )
+    elif os.getenv(OptionsDefine.ENV_TKE_REGION)             and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID)             and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE)             and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
+        cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
+    else:
+        cred = credential.Credential(
+            g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
+        )
+    http_profile = HttpProfile(
+        reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
+        reqMethod="POST",
+        endpoint=g_param[OptionsDefine.Endpoint],
+        proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
+    )
+    profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
+    if g_param[OptionsDefine.Language]:
+        profile.language = g_param[OptionsDefine.Language]
+    mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
+    client = mod.DlcClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.ModifySparkAppBatchRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.ModifySparkAppBatch(model)
+        result = rsp.to_json_string()
+        try:
+            json_obj = json.loads(result)
+        except TypeError as e:
+            json_obj = json.loads(result.decode('utf-8'))  # python3.3
+        if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
+            break
+        cur_time = time.time()
+        if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
+            raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
+            (g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
+            search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
+        else:
+            print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
+        time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
+    FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
+
+
 def doDescribeDMSDatabase(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -7523,7 +7575,7 @@ ACTION_MAP = {
     "DescribeUserRoles": doDescribeUserRoles,
     "ModifyUserType": doModifyUserType,
     "DescribeWorkGroupInfo": doDescribeWorkGroupInfo,
-    "ListTaskJobLogName": doListTaskJobLogName,
+    "DescribeTaskMonitorInfos": doDescribeTaskMonitorInfos,
     "DescribeNotebookSession": doDescribeNotebookSession,
     "CreateNotebookSession": doCreateNotebookSession,
     "DeleteWorkGroup": doDeleteWorkGroup,
@@ -7550,7 +7602,7 @@ ACTION_MAP = {
     "RevokeDLCCatalogAccess": doRevokeDLCCatalogAccess,
     "CreateUser": doCreateUser,
     "DescribeTables": doDescribeTables,
-    "ModifySparkAppBatch": doModifySparkAppBatch,
+    "ListTaskJobLogName": doListTaskJobLogName,
     "DescribeNotebookSessions": doDescribeNotebookSessions,
     "DescribeLakeFsTaskResult": doDescribeLakeFsTaskResult,
     "AddOptimizerEngines": doAddOptimizerEngines,
@@ -7647,6 +7699,7 @@ ACTION_MAP = {
     "ModifySparkApp": doModifySparkApp,
     "DescribeViews": doDescribeViews,
     "DeleteThirdPartyAccessUser": doDeleteThirdPartyAccessUser,
+    "ModifySparkAppBatch": doModifySparkAppBatch,
     "DescribeDMSDatabase": doDescribeDMSDatabase,
     "BindWorkGroupsToUser": doBindWorkGroupsToUser,
     "DescribeUserDataEngineConfig": doDescribeUserDataEngineConfig,

tccli/services/dlc/v20210125/api.json

@@ -637,6 +637,13 @@
       "output": "DescribeTaskLogResponse",
       "status": "online"
     },
+    "DescribeTaskMonitorInfos": {
+      "document": "查询任务监控指标信息",
+      "input": "DescribeTaskMonitorInfosRequest",
+      "name": "查询任务监控信息",
+      "output": "DescribeTaskMonitorInfosResponse",
+      "status": "online"
+    },
     "DescribeTaskResult": {
       "document": "查询任务结果，仅支持30天以内的任务查询结果，且返回数据大小超过近50M会进行截断。",
       "input": "DescribeTaskResultRequest",
@@ -1093,7 +1100,44 @@
     },
     "AddOptimizerEnginesRequest": {
       "document": "AddOptimizerEngines请求参数结构体",
-      "members": [],
+      "members": [
+        {
+          "disabled": false,
+          "document": "数据目录名称",
+          "example": "DataLakeCatalog",
+          "member": "string",
+          "name": "Catalog",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "引擎信息列表",
+          "example": "无",
+          "member": "OptimizerEngineInfo",
+          "name": "Engines",
+          "required": true,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "数据库名称",
+          "example": "test_db",
+          "member": "string",
+          "name": "Database",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "数据表名称",
+          "example": "test_tb",
+          "member": "string",
+          "name": "Table",
+          "required": false,
+          "type": "string"
+        }
+      ],
       "type": "object"
     },
     "AddOptimizerEnginesResponse": {
@@ -11037,10 +11081,10 @@
         {
           "disabled": false,
           "document": "下一次分页参数，第一次传空。透传上次接口返回的Context值，可获取后续更多日志，总计最多可获取1万条原始日志，过期时间1小时。",
-          "example": "xx",
+          "example": "下一次分页参数",
           "member": "string",
           "name": "Context",
-          "required": true,
+          "required": false,
           "type": "string"
         },
         {
@@ -11125,6 +11169,98 @@
       ],
       "type": "object"
     },
+    "DescribeTaskMonitorInfosRequest": {
+      "document": "DescribeTaskMonitorInfos请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "任务ID列表，上限50个",
+          "example": "[\"bba8a49efe4911ef9e535254001a35f3\",\"bba8a49efe4911ef9e535254001a3523]",
+          "member": "string",
+          "name": "TaskIdList",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "引擎名称",
+          "example": "uanalysis_dlc_presto_512s",
+          "member": "string",
+          "name": "HouseName",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "任务创建时间的起始时间",
+          "example": "20250301",
+          "member": "string",
+          "name": "CreateTimeStart",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "任务创建时间的结束时间",
+          "example": "20250302",
+          "member": "string",
+          "name": "CreateTimeEnd",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "每一页条数",
+          "example": "100",
+          "member": "int64",
+          "name": "Limit",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "偏移量",
+          "example": "100",
+          "member": "int64",
+          "name": "Offset",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeTaskMonitorInfosResponse": {
+      "document": "DescribeTaskMonitorInfos返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "任务监控信息列表",
+          "example": "无",
+          "member": "TaskMonitorInfo",
+          "name": "TaskMonitorInfoList",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务总数",
+          "example": "10",
+          "member": "int64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeTaskResultRequest": {
       "document": "DescribeTaskResult请求参数结构体",
       "members": [
@@ -15375,6 +15511,45 @@
       ],
       "usage": "out"
     },
+    "OptimizerEngineInfo": {
+      "document": "数据优化引擎信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "引擎资源名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "test_engine",
+          "member": "string",
+          "name": "HouseName",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "引擎资源ID\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "DataEngine-123456",
+          "member": "string",
+          "name": "HouseId",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "该参数仅针对spark作业引擎有效，用于执行数据优化任务的资源大小，不填时将采用该引擎所有资源\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "36",
+          "member": "int64",
+          "name": "HouseSize",
+          "output_required": true,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "Other": {
       "document": "数据格式其它类型。",
       "members": [
@@ -18373,6 +18548,82 @@
       ],
       "usage": "in"
     },
+    "TaskMonitorInfo": {
+      "document": "任务监控信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "任务id",
+          "example": "3c2c581afe4d11efbde1525400b3a056",
+          "member": "string",
+          "name": "TaskId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "引擎名称",
+          "example": "engine1",
+          "member": "string",
+          "name": "HouseName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "sql语句",
+          "example": "select 1;",
+          "member": "string",
+          "name": "QuerySQL",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务时间",
+          "example": "2023-08-10T12:35:02.123Z",
+          "member": "string",
+          "name": "CreateTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "执行时间",
+          "example": "100",
+          "member": "string",
+          "name": "UsedTime",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "数据扫描量",
+          "example": "1024",
+          "member": "string",
+          "name": "DataAmount",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "指标信息",
+          "example": "{\"elapsedTime\": \"5.34s\",     \"executionTime\": \"4.89s\",     \"cumulativeUserMemory\": 1234567.89,     \"peakUserMemoryReservation\": \"64MB\",     \"totalBytes\": \"1.23MB\",     \"totalRows\": 1000   }",
+          "member": "string",
+          "name": "QueryStats",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "TaskResponseInfo": {
       "document": "任务实例。",
       "members": [

tccli/services/dlc/v20210125/examples.json

@@ -11,7 +11,7 @@
     "AddOptimizerEngines": [
       {
         "document": "",
-        "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddOptimizerEngines\n<公共请求参数>\n\n{}",
+        "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddOptimizerEngines\n<公共请求参数>\n\n{\n    \"Catalog\": \"DataLakeCatalog\",\n    \"Engines\": [\n        {\n            \"HouseName\": \"test_engine\",\n            \"HouseId\": \"DataEngine-123\",\n            \"HouseSize\": 0\n        }\n    ],\n    \"Database\": \"mydb\",\n    \"Table\": \"mytb\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"1304581893_25027_1709796072623_223\"\n    }\n}",
         "title": "实例一"
       }
@@ -729,11 +729,19 @@
     "DescribeTaskLog": [
       {
         "document": "",
-        "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTaskLog\n<公共请求参数>\n\n{\n    \"TaskId\": \"abc\",\n    \"StartTime\": 0,\n    \"EndTime\": 0,\n    \"Limit\": 0,\n    \"Context\": \"abc\",\n    \"Asc\": true,\n    \"Filters\": [\n        {\n            \"Name\": \"abc\",\n            \"Values\": [\n                \"abc\"\n            ]\n        }\n    ],\n    \"BatchId\": \"abc\"\n}",
-        "output": "{\n    \"Response\": {\n        \"Context\": \"abc\",\n        \"ListOver\": true,\n        \"Results\": [\n            {\n                \"Time\": 0,\n                \"TopicId\": \"abc\",\n                \"TopicName\": \"abc\",\n                \"LogJson\": \"abc\",\n                \"PkgLogId\": \"abc\"\n            }\n        ],\n        \"LogUrl\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTaskLog\n<公共请求参数>\n\n{\n    \"TaskId\": \"84f55bb7-4f9c-4995-90c5-a40fdff9bc62\",\n    \"StartTime\": 1736931692631,\n    \"EndTime\": 1737104492631,\n    \"Limit\": 10,\n    \"Context\": \"\"\n}",
+        "output": "{\n    \"Response\": {\n        \"Context\": \"\",\n        \"ListOver\": true,\n        \"LogUrl\": \"\",\n        \"RequestId\": \"********-****-****-****-303d24983adb\",\n        \"Results\": []\n    }\n}",
         "title": "获取spark 作业任务日志详情"
       }
     ],
+    "DescribeTaskMonitorInfos": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: dlc.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTaskMonitorInfos\n<公共请求参数>\n\n{\n    \"TaskIdList\": [\n        \"bba8a49efe4911ef9e535254001a35f3\"\n    ],\n    \"HouseName\": \"engine1\",\n    \"CreateTimeStart\": \"20250301\",\n    \"CreateTimeEnd\": \"20250302\",\n    \"Limit\": 100,\n    \"Offset\": 0\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"9a79d797-2c6c-4773-a983-895e401b0a86\",\n        \"TaskMonitorInfoList\": [\n            {\n                \"TaskId\": \"bba8a49efe4911ef9e535254001a35f3\",\n                \"HouseName\": \"engine1\",\n                \"QuerySQL\": \"select 1;\",\n                \"CreateTime\": \"2023-08-10T12:35:02.123Z\",\n                \"UsedTime\": \"100\",\n                \"DataAmount\": \"1024\",\n                \"QueryStats\": \"{\\\"elapsedTime\\\": \\\"5.34s\\\",     \\\"executionTime\\\": \\\"4.89s\\\",     \\\"cumulativeUserMemory\\\": 1234567.89,     \\\"peakUserMemoryReservation\\\": \\\"64MB\\\",     \\\"totalBytes\\\": \\\"1.23MB\\\",    \\\"totalRows\\\": 1000   }\"\n            }\n        ],\n        \"TotalCount\": 1\n    }\n}",
+        "title": "获取任务监控信息"
+      }
+    ],
     "DescribeTaskResult": [
       {
         "document": "查询任务结果，每次返回1000行数据",