tccli 3.0.1223.1__py2.py3-none-any.whl → 3.0.1224.1__py2.py3-none-any.whl

tccli/services/bi/bi_client.py

@@ -381,6 +381,58 @@ def doModifyUserRole(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doExportScreenPage(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.BiClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.ExportScreenPageRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.ExportScreenPage(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 doCreateEmbedToken(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -693,6 +745,58 @@ def doDescribeUserRoleList(args, parsed_globals):
     FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
 
 
+def doDescribePageWidgetList(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.BiClient(cred, g_param[OptionsDefine.Region], profile)
+    client._sdkVersion += ("_CLI_" + __version__)
+    models = MODELS_MAP[g_param[OptionsDefine.Version]]
+    model = models.DescribePageWidgetListRequest()
+    model.from_json_string(json.dumps(args))
+    start_time = time.time()
+    while True:
+        rsp = client.DescribePageWidgetList(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 doDescribeUserRoleProjectList(args, parsed_globals):
     g_param = parse_global_arg(parsed_globals)
 
@@ -1179,12 +1283,14 @@ ACTION_MAP = {
     "CreateProject": doCreateProject,
     "CreateDatasourceCloud": doCreateDatasourceCloud,
     "ModifyUserRole": doModifyUserRole,
+    "ExportScreenPage": doExportScreenPage,
     "CreateEmbedToken": doCreateEmbedToken,
     "CreateUserRole": doCreateUserRole,
     "DeleteDatasource": doDeleteDatasource,
     "DeleteUserRole": doDeleteUserRole,
     "ModifyProject": doModifyProject,
     "DescribeUserRoleList": doDescribeUserRoleList,
+    "DescribePageWidgetList": doDescribePageWidgetList,
     "DescribeUserRoleProjectList": doDescribeUserRoleProjectList,
     "ModifyDatasourceCloud": doModifyDatasourceCloud,
     "CreateUserRoleProject": doCreateUserRoleProject,

tccli/services/bi/v20220105/api.json

@@ -84,6 +84,13 @@
       "output": "DescribeDatasourceListResponse",
       "status": "online"
     },
+    "DescribePageWidgetList": {
+      "document": "查询页面组件信息",
+      "input": "DescribePageWidgetListRequest",
+      "name": "查询页面组件信息",
+      "output": "DescribePageWidgetListResponse",
+      "status": "online"
+    },
     "DescribeProjectInfo": {
       "document": "项目详情接口",
       "input": "DescribeProjectInfoRequest",
@@ -119,6 +126,13 @@
       "output": "DescribeUserRoleProjectListResponse",
       "status": "online"
     },
+    "ExportScreenPage": {
+      "document": "页面截图导出",
+      "input": "ExportScreenPageRequest",
+      "name": "分享页截图导出",
+      "output": "ExportScreenPageResponse",
+      "status": "online"
+    },
     "ModifyDatasource": {
       "document": "更新数据源",
       "input": "ModifyDatasourceRequest",
@@ -2243,6 +2257,82 @@
       ],
       "type": "object"
     },
+    "DescribePageWidgetListRequest": {
+      "document": "DescribePageWidgetList请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "项目id",
+          "example": "123",
+          "member": "string",
+          "name": "ProjectId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "页面id",
+          "example": "1",
+          "member": "string",
+          "name": "PageId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribePageWidgetListResponse": {
+      "document": "DescribePageWidgetList返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "自定义错误信息对象\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ErrorInfo",
+          "name": "ErrorInfo",
+          "output_required": false,
+          "type": "object",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "扩展参数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"ext\"",
+          "member": "string",
+          "name": "Extra",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "返回数据结果\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "{}",
+          "member": "WidgetListVO",
+          "name": "Data",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "返回消息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"success\"",
+          "member": "string",
+          "name": "Msg",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeProjectInfoRequest": {
       "document": "DescribeProjectInfo请求参数结构体",
       "members": [
@@ -2993,6 +3083,127 @@
       ],
       "usage": "out"
     },
+    "ExportScreenPageRequest": {
+      "document": "ExportScreenPage请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "项目id",
+          "example": "123",
+          "member": "string",
+          "name": "ProjectId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "页面id",
+          "example": "1",
+          "member": "string",
+          "name": "PageId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "画布类型。栅格画布：GRID；自由画布：FREE",
+          "example": "\"GRID\"",
+          "member": "string",
+          "name": "CanvasType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "图片导出类型。base64；url（有效期：1天）",
+          "example": "\"base64\"",
+          "member": "string",
+          "name": "PicType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "组件Ids。为空时，导出整个页面",
+          "example": "[\"123\",\"456\"]",
+          "member": "string",
+          "name": "WidgetIds",
+          "required": false,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "是否是异步请求",
+          "example": "无",
+          "member": "bool",
+          "name": "AsyncRequest",
+          "required": false,
+          "type": "bool"
+        },
+        {
+          "disabled": false,
+          "document": "事务id",
+          "example": "无",
+          "member": "string",
+          "name": "TranId",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "ExportScreenPageResponse": {
+      "document": "ExportScreenPage返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "自定义错误信息对象\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "ErrorInfo",
+          "name": "ErrorInfo",
+          "output_required": false,
+          "type": "object",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "扩展参数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"ext\"",
+          "member": "string",
+          "name": "Extra",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "返回数据结果\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "{}",
+          "member": "PageScreenListVO",
+          "name": "Data",
+          "output_required": true,
+          "type": "object",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "返回消息\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"success\"",
+          "member": "string",
+          "name": "Msg",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "IdDTO": {
       "document": "仅包含id的对象",
       "members": [
@@ -3929,6 +4140,78 @@
       ],
       "type": "object"
     },
+    "PageScreenListVO": {
+      "document": "页面截图列表",
+      "members": [
+        {
+          "disabled": false,
+          "document": "图片导出类型。base64；url\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"base64\"",
+          "member": "string",
+          "name": "PicType",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "图片列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "PageScreenVO",
+          "name": "List",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "异步事务id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "TranId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "事务状态\n1: 处理中; 2: 处理成功; 3 处理失败(错误内容见外层Msg)\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "int64",
+          "name": "TranStatus",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
+    "PageScreenVO": {
+      "document": "页面截图信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "截图base64或 url\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "Content",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件Id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "WidgetId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "PermissionComponent": {
       "document": "商业版本权限单元",
       "members": [
@@ -4966,6 +5249,78 @@
         }
       ],
       "usage": "out"
+    },
+    "WidgetListVO": {
+      "document": "页面组件信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "uin\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "CorpId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "项目id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "ProjectId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "页面id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "string",
+          "name": "PageId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件数组\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "WidgetVO",
+          "name": "WidgetList",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
+    "WidgetVO": {
+      "document": "组件信息",
+      "members": [
+        {
+          "disabled": false,
+          "document": "组件Id\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "WidgetId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "组件name\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "\"\"",
+          "member": "string",
+          "name": "WidgetName",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
     }
   },
   "version": "1.0"

tccli/services/bi/v20220105/examples.json

@@ -114,6 +114,14 @@
         "title": "success"
       }
     ],
+    "DescribePageWidgetList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: bi.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePageWidgetList\n<公共请求参数>\n\n{\n    \"ProjectId\": \"662\",\n    \"PageId\": \"6465\"\n}",
+        "output": "{\n    \"Response\": {\n        \"ErrorInfo\": {\n            \"ErrorTip\": \"abc\",\n            \"ErrorMessage\": \"abc\",\n            \"ErrorLevel\": \"abc\",\n            \"DocLink\": \"abc\",\n            \"FAQ\": \"abc\",\n            \"ReservedField\": \"abc\"\n        },\n        \"Extra\": \"abc\",\n        \"Data\": {\n            \"CorpId\": \"abc\",\n            \"ProjectId\": \"abc\",\n            \"PageId\": \"abc\",\n            \"WidgetList\": [\n                {\n                    \"WidgetId\": \"abc\",\n                    \"WidgetName\": \"abc\"\n                }\n            ]\n        },\n        \"Msg\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "成功"
+      }
+    ],
     "DescribeProjectInfo": [
       {
         "document": "展示项目详情接口示例",
@@ -154,6 +162,14 @@
         "title": "项目内-用户角色列表"
       }
     ],
+    "ExportScreenPage": [
+      {
+        "document": "导出自由画布",
+        "input": "POST / HTTP/1.1\nHost: bi.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportScreenPage\n<公共请求参数>\n\n{\n    \"ProjectId\": \"1907\",\n    \"PageId\": \"39618\",\n    \"CanvasType\": \"FREE\",\n    \"PicType\": \"url\",\n    \"WidgetIds\": []\n}",
+        "output": "{\n    \"Response\": {\n        \"ErrorInfo\": {\n            \"ErrorTip\": \"abc\",\n            \"ErrorMessage\": \"abc\",\n            \"ErrorLevel\": \"abc\",\n            \"DocLink\": \"abc\",\n            \"FAQ\": \"abc\",\n            \"ReservedField\": \"abc\"\n        },\n        \"Extra\": \"abc\",\n        \"Data\": {\n            \"PicType\": \"abc\",\n            \"List\": [\n                {\n                    \"Content\": \"abc\",\n                    \"WidgetId\": \"abc\"\n                }\n            ],\n            \"TranId\": \"abc\",\n            \"TranStatus\": 0\n        },\n        \"Msg\": \"abc\",\n        \"RequestId\": \"abc\"\n    }\n}",
+        "title": "导出自由画布"
+      }
+    ],
     "ModifyDatasource": [
       {
         "document": "",