tccli 3.0.1113.1__py2.py3-none-any.whl → 3.0.1114.1__py2.py3-none-any.whl

tccli/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1113.1'
+__version__ = '3.0.1114.1'

tccli/services/cat/v20180409/api.json

@@ -36,7 +36,7 @@
       "status": "online"
     },
     "DescribeProbeMetricData": {
-      "document": "查询云拨测指标数据，指标支持使用sum,avg,max,min聚合函数进行指标数据查询",
+      "document": "查询云拨测指标数据，指标支持使用sum,avg,max,min聚合函数进行指标数据查询\n拨测频率与groupby聚合时间设置关联，如拨测频率为 30 分钟，则 grouby 聚合时间建议设置为大于30分钟，避免出现查询数据为空的情况",
       "input": "DescribeProbeMetricDataRequest",
       "name": "列出云拨测指标详细数据",
       "output": "DescribeProbeMetricDataResponse",
@@ -670,7 +670,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "返回指标 JSON 序列化后的字符串,具体如下所示：\n\"[{\\\"name\\\":\\\"task_navigate_request_gauge\\\",\\\"columns\\\":[\\\"time\\\",\\\"avg(first_screen_time) / 1000\\\"],\\\"values\\\":[[1641571200,6.756600000000001]],\\\"tags\\\":null}]\"",
+          "document": " 返回指标 JSON 序列化后的字符串，具体如下所示：\"[{\\\"name\\\":\\\"task_navigate_request_gauge\\\",\\\"columns\\\":[\\\"time\\\",\\\"avg(first_screen_time) / 1000\\\"],\\\"values\\\":[[1641571200,6.756600000000001]],\\\"tags\\\":null}]\"",
           "example": "\"\"",
           "member": "string",
           "name": "MetricSet",

tccli/services/cat/v20180409/examples.json

@@ -49,8 +49,8 @@
     "DescribeProbeMetricData": [
       {
         "document": "请求浏览数据",
-        "input": "POST / HTTP/1.1\nHost: cat.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProbeMetricData\n<公共请求参数>\n\n{\n    \"AnalyzeTaskType\": \"AnalyzeTaskType_Browse\",\n    \"MetricType\": \"gauge\",\n    \"Field\": \"avg(\\\"count\\\")\",\n    \"GroupBy\": \"time(30d), \\\"operator\\\"\",\n    \"Filters\": [\n        \"\\\"host\\\" = 'default-host'\",\n        \"time >= now()-3h\"\n    ]\n}",
-        "output": "{\n    \"Response\": {\n        \"MetricSet\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "input": "POST / HTTP/1.1\nHost: cat.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeProbeMetricData\n<公共请求参数>\n\n{\n    \"AnalyzeTaskType\": \"AnalyzeTaskType_Network\",\n    \"MetricType\": \"gauge\",\n    \"Field\": \"sum(\\\"error_count\\\")\",\n    \"GroupBy\": \"time(30d), \\\"operator\\\"\",\n    \"Filters\": [\n        \"\\\"host\\\" = 'default-host'\",\n        \"time >= now()-1h\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"MetricSet\": \"[{\\\"name\\\":\\\"netenv_request_gauge\\\",\\\"columns\\\":[\\\"time\\\",\\\"sum(error_count)\\\"],\\\"values\\\":[[xxxxx,xxxxx]],\\\"tags\\\":null}]\",\n        \"RequestId\": \"xxxxx\"\n    }\n}",
         "title": "请求浏览数据"
       }
     ],

tccli/services/dbbrain/dbbrain_client.py

@@ -1891,7 +1891,7 @@ def doDescribeAllUserContact(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
-def doDescribeProxyProcessStatistics(args, parsed_globals):
+def doDescribeRedisBigKeyAnalysisTasks(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
     if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
@@ -1920,11 +1920,11 @@ def doDescribeProxyProcessStatistics(args, parsed_globals):
     client = mod.DbbrainClient(cred, g_param[OptionsDefine.Region], profile)
     client._sdkVersion += ("_CLI_" + __version__)
     models = MODELS_MAP[g_param[OptionsDefine.Version]]
-    model = models.DescribeProxyProcessStatisticsRequest()
+    model = models.DescribeRedisBigKeyAnalysisTasksRequest()
     model.from_json_string(json.dumps(args))
     start_time = time.time()
     while True:
-        rsp = client.DescribeProxyProcessStatistics(model)
+        rsp = client.DescribeRedisBigKeyAnalysisTasks(model)
         result = rsp.to_json_string()
         try:
             json_obj = json.loads(result)
@@ -2567,6 +2567,58 @@ def doModifyDiagDBInstanceConf(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doDescribeProxyProcessStatistics(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.DbbrainClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribeProxyProcessStatisticsRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribeProxyProcessStatistics(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 doCreateKillTask(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -3240,7 +3292,7 @@ ACTION_MAP = {
     "DescribeSlowLogTopSqls": doDescribeSlowLogTopSqls,
     "DescribeSecurityAuditLogExportTasks": doDescribeSecurityAuditLogExportTasks,
     "DescribeAllUserContact": doDescribeAllUserContact,
-    "DescribeProxyProcessStatistics": doDescribeProxyProcessStatistics,
+    "DescribeRedisBigKeyAnalysisTasks": doDescribeRedisBigKeyAnalysisTasks,
     "DescribeSlowLogs": doDescribeSlowLogs,
     "DescribeDBDiagEvent": doDescribeDBDiagEvent,
     "DescribeDBDiagHistory": doDescribeDBDiagHistory,
@@ -3253,6 +3305,7 @@ ACTION_MAP = {
     "DescribeIndexRecommendInfo": doDescribeIndexRecommendInfo,
     "DescribeIndexRecommendAggregationSlowLogs": doDescribeIndexRecommendAggregationSlowLogs,
     "ModifyDiagDBInstanceConf": doModifyDiagDBInstanceConf,
+    "DescribeProxyProcessStatistics": doDescribeProxyProcessStatistics,
     "CreateKillTask": doCreateKillTask,
     "UpdateAgentSwitch": doUpdateAgentSwitch,
     "UpdateMonitorSwitch": doUpdateMonitorSwitch,

tccli/services/dbbrain/v20210527/api.json

@@ -252,6 +252,13 @@
       "output": "DescribeProxySessionKillTasksResponse",
       "status": "online"
     },
+    "DescribeRedisBigKeyAnalysisTasks": {
+      "document": "查询redis大key分析任务列表。",
+      "input": "DescribeRedisBigKeyAnalysisTasksRequest",
+      "name": "查询redis大key分析任务列表",
+      "output": "DescribeRedisBigKeyAnalysisTasksResponse",
+      "status": "online"
+    },
     "DescribeRedisProcessList": {
       "document": "获取 Redis 实例所有 proxy 节点的实时会话详情列表。",
       "input": "DescribeRedisProcessListRequest",
@@ -386,7 +393,7 @@
       "status": "online"
     },
     "ModifyDiagDBInstanceConf": {
-      "document": "修改实例巡检开关。",
+      "document": "修改实例的配置信息。",
       "input": "ModifyDiagDBInstanceConfRequest",
       "name": "修改实例巡检开关状态",
       "output": "ModifyDiagDBInstanceConfResponse",
@@ -3116,7 +3123,7 @@
         },
         {
           "disabled": false,
-          "document": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"dbbrain-mysql\" - 自建 MySQL，默认为\"mysql\"。",
+          "document": "服务产品类型，支持值包括：\"mysql\" - 云数据库 MySQL，\"cynosdb\" - 云数据库 TDSQL-C for MySQL，\"dbbrain-mysql\" - 自建 MySQL，\"redis\" - 云数据库 Redis，默认为\"mysql\"。",
           "example": "mysql",
           "member": "string",
           "name": "Product",
@@ -3911,6 +3918,80 @@
       ],
       "type": "object"
     },
+    "DescribeRedisBigKeyAnalysisTasksRequest": {
+      "document": "DescribeRedisBigKeyAnalysisTasks请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "服务产品类型，支持值包括 \"redis\" - 云数据库 Redis。",
+          "example": "redis",
+          "member": "string",
+          "name": "Product",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "实例ID。",
+          "example": "crs-c1nl9rpv",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "查询数目，默认为20，最大值为100。",
+          "example": "20",
+          "member": "int64",
+          "name": "Limit",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "偏移量，默认为0。",
+          "example": "0",
+          "member": "int64",
+          "name": "Offset",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeRedisBigKeyAnalysisTasksResponse": {
+      "document": "DescribeRedisBigKeyAnalysisTasks返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "任务总数。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "100",
+          "member": "int64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "任务列表。",
+          "example": "无",
+          "member": "RedisBigKeyTask",
+          "name": "Tasks",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeRedisProcessListRequest": {
       "document": "DescribeRedisProcessList请求参数结构体",
       "members": [
@@ -6028,7 +6109,7 @@
           "example": "无",
           "member": "string",
           "name": "KeyDelimiters",
-          "output_required": true,
+          "output_required": false,
           "required": false,
           "type": "list",
           "value_allowed_null": true
@@ -6039,7 +6120,18 @@
           "example": "3",
           "member": "string",
           "name": "ShardNum",
-          "output_required": true,
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "是否开启大key周期性分析，仅redis产品有效。\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "Yes",
+          "member": "string",
+          "name": "AnalysisTopKey",
+          "output_required": false,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -6822,7 +6914,7 @@
         },
         {
           "disabled": false,
-          "document": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB  for MySQL。",
+          "document": "服务产品类型，支持值包括： \"mysql\" - 云数据库 MySQL， \"cynosdb\" - 云数据库 CynosDB  for MySQL，\"redis\" - 云数据库 Redis。",
           "example": "mysql",
           "member": "string",
           "name": "Product",
@@ -7515,6 +7607,82 @@
       ],
       "usage": "out"
     },
+    "RedisBigKeyTask": {
+      "document": "Redis大Key分析任务详情。",
+      "members": [
+        {
+          "disabled": false,
+          "document": "异步任务请求 ID。",
+          "example": "12306",
+          "member": "int64",
+          "name": "AsyncRequestId",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务创建时间。",
+          "example": "2024-01-02 21:02:24",
+          "member": "string",
+          "name": "CreateTime",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务开始时间。",
+          "example": "2024-01-02 21:02:25",
+          "member": "string",
+          "name": "StartTime",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务结束时间。",
+          "example": "2024-01-08 11:52:41",
+          "member": "string",
+          "name": "EndTime",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务状态。",
+          "example": "finished",
+          "member": "string",
+          "name": "TaskStatus",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务执行进度。",
+          "example": "100",
+          "member": "int64",
+          "name": "Progress",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "任务包含的分片节点序号列表。",
+          "example": "[2,3]",
+          "member": "int64",
+          "name": "ShardIds",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "RedisKeySpaceData": {
       "document": "redis key空间信息。",
       "members": [

tccli/services/dbbrain/v20210527/examples.json

@@ -288,6 +288,14 @@
         "title": "查询 kill 会话任务执行结果"
       }
     ],
+    "DescribeRedisBigKeyAnalysisTasks": [
+      {
+        "document": "获取某个Redis实例的大Key分析任务列表。",
+        "input": "POST / HTTP/1.1\nHost: dbbrain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeRedisBigKeyAnalysisTasks\n<公共请求参数>\n\n{\n    \"InstanceId\": \"crs-7i2test\",\n    \"Product\": \"redis\",\n    \"Limit\": 50,\n    \"Offset\": 0\n}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"Tasks\": [\n            {\n                \"Progress\": 100,\n                \"AsyncRequestId\": 7309733,\n                \"EndTime\": \"2024-01-12 11:41:53\",\n                \"CreateTime\": \"2024-01-12 11:38:37\",\n                \"StartTime\": \"2024-01-12 11:38:38\",\n                \"TaskStatus\": \"finished\",\n                \"ShardIds\": [\n                    \"2\",\n                    \"3\"\n                ]\n            }\n        ],\n        \"RequestId\": \"e9833850-b113-11ee-8376-93f024a9a001\"\n    }\n}",
+        "title": "获取Redis大Key分析任务列表"
+      }
+    ],
     "DescribeRedisProcessList": [
       {
         "document": "指定 Offset 分页获取实例 Proxy 实时会话详情列表。",
@@ -448,10 +456,16 @@
     ],
     "ModifyDiagDBInstanceConf": [
       {
-        "document": "",
+        "document": "修改实例巡检状态。",
         "input": "https://dbbrain.tencentcloudapi.com/?Action=ModifyDiagDBInstanceConf\n&InstanceIds.0=cdb-fyclrp7r\n&InstanceConfs.DailyInspection=Yes\n&Regions=All\n&Product=mysql\n&<公共请求参数>",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"77db16d7-bbe8-48a7-868b-ed776a96f1ab\"\n    }\n}",
         "title": "修改实例巡检状态"
+      },
+      {
+        "document": "开启Redis实例大key周期性分析并自定义分隔符。",
+        "input": "POST / HTTP/1.1\nHost: dbbrain.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyDiagDBInstanceConf\n<公共请求参数>\n\n{\n    \"Product\": \"redis\",\n    \"Regions\": \"all\",\n    \"InstanceIds\": [\n        \"crs-pz1raq11\"\n    ],\n    \"InstanceConfs\": {\n        \"AnalysisTopKey\": \"Yes\",\n        \"KeyDelimiters\": [\n            \"_\",\n            \"-\",\n            \":\"\n        ]\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"bcd97ab0-16d1-11ef-8e52-3d11a9997f13\"\n    }\n}",
+        "title": "修改Redis实例大key周期性分析"
       }
     ],
     "ModifySqlFilters": [