tccli 3.0.1168.1__py2.py3-none-any.whl → 3.0.1170.1__py2.py3-none-any.whl

tccli/services/cls/v20201016/api.json

@@ -70,6 +70,13 @@
       "output": "CreateConfigExtraResponse",
       "status": "online"
     },
+    "CreateConsoleSharing": {
+      "document": "创建控制台分享",
+      "input": "CreateConsoleSharingRequest",
+      "name": "创建免密分享",
+      "output": "CreateConsoleSharingResponse",
+      "status": "online"
+    },
     "CreateConsumer": {
       "document": "本接口用于创建投递CKafka任务",
       "input": "CreateConsumerRequest",
@@ -203,6 +210,13 @@
       "output": "DeleteConfigFromMachineGroupResponse",
       "status": "online"
     },
+    "DeleteConsoleSharing": {
+      "document": "删除控制台分享",
+      "input": "DeleteConsoleSharingRequest",
+      "name": "删除免密分享",
+      "output": "DeleteConsoleSharingResponse",
+      "status": "online"
+    },
     "DeleteConsumer": {
       "document": "本接口用于删除投递配置",
       "input": "DeleteConsumerRequest",
@@ -336,6 +350,13 @@
       "output": "DescribeConfigsResponse",
       "status": "online"
     },
+    "DescribeConsoleSharingList": {
+      "document": "批量查询控制台分享列表",
+      "input": "DescribeConsoleSharingListRequest",
+      "name": "获取免密分享列表",
+      "output": "DescribeConsoleSharingListResponse",
+      "status": "online"
+    },
     "DescribeConsumer": {
       "document": "本接口用于获取投递配置",
       "input": "DescribeConsumerRequest",
@@ -525,6 +546,13 @@
       "output": "ModifyConfigExtraResponse",
       "status": "online"
     },
+    "ModifyConsoleSharing": {
+      "document": "修改控制台分享，目前仅允许修改有效期",
+      "input": "ModifyConsoleSharingRequest",
+      "name": "修改免密分享",
+      "output": "ModifyConsoleSharingResponse",
+      "status": "online"
+    },
     "ModifyConsumer": {
       "document": "本接口用于修改投递Ckafka任务",
       "input": "ModifyConsumerRequest",
@@ -2413,6 +2441,172 @@
       ],
       "usage": "out"
     },
+    "ConsoleSharingConfig": {
+      "document": "控制台分享配置",
+      "members": [
+        {
+          "disabled": false,
+          "document": "分享链接名称",
+          "example": "my-sharing",
+          "member": "string",
+          "name": "Name",
+          "output_required": true,
+          "required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "仪表盘: 1; 检索页:2",
+          "example": "1",
+          "member": "uint64",
+          "name": "Type",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "分享链接有效期，单位：毫秒，最长支持30天",
+          "example": "1800000",
+          "member": "uint64",
+          "name": "DurationMilliseconds",
+          "output_required": true,
+          "required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "允许访问的资源列表",
+          "example": "当Type为1时:['qcs::cls::uin/100001127589:dashboard/dashboard-1223fa03--44f9-f118-69a8-21aa33ea5aa1']; 当Type为2时:['qcs::cls:ap-guangzhou:uin/10000000001:topic/c1306921-2180-3e45-9azb-31d12217871e6']",
+          "member": "string",
+          "name": "Resources",
+          "output_required": true,
+          "required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "分享链接域名，可选范围\n- 公网匿名分享：填写clsshare.com\n- datasight内网匿名分享(若开启)：datasight内网域名\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "clsshare.com",
+          "member": "string",
+          "name": "Domain",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "验证码\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "lEC0V0",
+          "member": "string",
+          "name": "VerifyCode",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "开始时间，支持绝对时间(13位时间戳字符串)/相对时间字符串",
+          "example": "now-1d或'1706781017413'",
+          "member": "string",
+          "name": "StartTime",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "结束时间，支持绝对时间(13位时间戳字符串)/相对时间字符串",
+          "example": "now或'1706780117413'",
+          "member": "string",
+          "name": "EndTime",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "当StartTime/EndTime为相对时间时，基于NowTime计算绝对时间，默认为创建时间\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1706787306086",
+          "member": "uint64",
+          "name": "NowTime",
+          "output_required": false,
+          "required": false,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "params参数列表，当Type为2时支持\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[     {         \"Name\":\"query\",         \"Values\":[             \"* | select *\"         ]     } ]",
+          "member": "ConsoleSharingParam",
+          "name": "Params",
+          "output_required": false,
+          "required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "是否允许访问者自行修改检索分析时间范围，默认不锁定",
+          "example": "true",
+          "member": "bool",
+          "name": "IsLockTimeRange",
+          "output_required": true,
+          "required": false,
+          "type": "bool",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "是否允许访问者自行修改日志检索语句。在检索页分享中表示检索语句锁定状态；在仪表盘中表示过滤变量锁定状态",
+          "example": "true",
+          "member": "bool",
+          "name": "IsLockQuery",
+          "output_required": true,
+          "required": false,
+          "type": "bool",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "both"
+    },
+    "ConsoleSharingParam": {
+      "document": "控制台分享链接params参数",
+      "members": [
+        {
+          "disabled": false,
+          "document": "名称\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "query",
+          "member": "string",
+          "name": "Name",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "值\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "test",
+          "member": "string",
+          "name": "Value",
+          "output_required": false,
+          "required": false,
+          "type": "string",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "both"
+    },
     "ConsumerContent": {
       "document": "投递任务出入参 Content",
       "members": [
@@ -3605,6 +3799,53 @@
       ],
       "type": "object"
     },
+    "CreateConsoleSharingRequest": {
+      "document": "CreateConsoleSharing请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "免密分享配置",
+          "example": "无",
+          "member": "ConsoleSharingConfig",
+          "name": "SharingConfig",
+          "required": true,
+          "type": "object"
+        }
+      ],
+      "type": "object"
+    },
+    "CreateConsoleSharingResponse": {
+      "document": "CreateConsoleSharing返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "免密分享链接",
+          "example": "https://clsshare.tencent-cloud.com/s/13cez28h",
+          "member": "string",
+          "name": "SharingUrl",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "免密分享链接ID",
+          "example": "13cez28h",
+          "member": "string",
+          "name": "SharingId",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "CreateConsumerRequest": {
       "document": "CreateConsumer请求参数结构体",
       "members": [
@@ -5592,6 +5833,33 @@
       ],
       "type": "object"
     },
+    "DeleteConsoleSharingRequest": {
+      "document": "DeleteConsoleSharing请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "免密分享Id",
+          "example": "13cez28h",
+          "member": "string",
+          "name": "SharingId",
+          "required": true,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DeleteConsoleSharingResponse": {
+      "document": "DeleteConsoleSharing返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DeleteConsumerRequest": {
       "document": "DeleteConsumer请求参数结构体",
       "members": [
@@ -6383,6 +6651,33 @@
       ],
       "type": "object"
     },
+    "DescribeConsoleSharingListRequest": {
+      "document": "DescribeConsoleSharingList请求参数结构体",
+      "members": [],
+      "type": "object"
+    },
+    "DescribeConsoleSharingListResponse": {
+      "document": "DescribeConsoleSharingList返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "分页的总数目",
+          "example": "100",
+          "member": "uint64",
+          "name": "TotalCount",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeConsumerRequest": {
       "document": "DescribeConsumer请求参数结构体",
       "members": [
@@ -10507,6 +10802,42 @@
       ],
       "type": "object"
     },
+    "ModifyConsoleSharingRequest": {
+      "document": "ModifyConsoleSharing请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "免密分享链接Id",
+          "example": "13cez28h",
+          "member": "string",
+          "name": "SharingId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "指定分享链接有效期，单位：毫秒，最长可设定有效期为30天",
+          "example": "1800000",
+          "member": "uint64",
+          "name": "DurationMilliseconds",
+          "required": true,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "ModifyConsoleSharingResponse": {
+      "document": "ModifyConsoleSharing返回参数结构体",
+      "members": [
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "ModifyConsumerRequest": {
       "document": "ModifyConsumer请求参数结构体",
       "members": [
@@ -13017,7 +13348,16 @@
         },
         {
           "disabled": false,
-          "document": "表示单次查询返回的原始日志条数，默认为100，最大值为1000，获取后续日志需使用Context参数\n注意：\n* 仅当检索分析语句(Query)不包含SQL时有效\n* SQL结果条数指定方式参考<a href=\"https://cloud.tencent.com/document/product/614/58977\" target=\"_blank\">SQL LIMIT语法</a>",
+          "document": "原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc\n注意：\n* 仅当检索分析语句(Query)不包含SQL时有效\n* SQL结果排序方式参考<a href=\"https://cloud.tencent.com/document/product/614/58978\" target=\"_blank\">SQL ORDER BY语法</a>",
+          "example": "asc",
+          "member": "string",
+          "name": "Sort",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "表示单次查询返回的原始日志条数，默认为100，最大值为1000。\n注意：\n* 仅当检索分析语句(Query)不包含SQL时有效\n* SQL结果条数指定方式参考<a href=\"https://cloud.tencent.com/document/product/614/58977\" target=\"_blank\">SQL LIMIT语法</a>\n\n可通过两种方式获取后续更多日志：\n* Context:透传上次接口返回的Context值，获取后续更多日志，总计最多可获取1万条原始日志\n* Offset:偏移量，表示从第几行开始返回原始日志，无日志条数限制",
           "example": "100",
           "member": "int64",
           "name": "Limit",
@@ -13026,12 +13366,12 @@
         },
         {
           "disabled": false,
-          "document": "原始日志是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc\n注意：\n* 仅当检索分析语句(Query)不包含SQL时有效\n* SQL结果排序方式参考<a href=\"https://cloud.tencent.com/document/product/614/58978\" target=\"_blank\">SQL ORDER BY语法</a>",
-          "example": "asc",
-          "member": "string",
-          "name": "Sort",
+          "document": "查询原始日志的偏移量，表示从第几行开始返回原始日志，默认为0。 \n注意：\n* 仅当检索分析语句(Query)不包含SQL时有效\n* 不能与Context参数同时使用\n* 仅适用于单日志主题检索",
+          "example": "0",
+          "member": "uint64",
+          "name": "Offset",
           "required": false,
-          "type": "string"
+          "type": "int"
         },
         {
           "disabled": false,

tccli/services/cls/v20201016/examples.json

@@ -98,6 +98,14 @@
         "title": "创建特殊采集配置任务"
       }
     ],
+    "CreateConsoleSharing": [
+      {
+        "document": "创建控制台检索页/仪表盘免登陆分享站点",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateConsoleSharing\n<公共请求参数>\n\n{\n    \"SharingConfig\": {\n        \"Name\": \"my-sharing\",\n        \"Type\": 1,\n        \"VerifyCode\": \"lEC0V0\",\n        \"DurationMilliseconds\": 1800000,\n        \"NowTime\": 1706787306086,\n        \"IsLockTimeRange\": true,\n        \"IsLockQuery\": true,\n        \"Params\": [\n            {\n                \"Name\": \"query\"\n            }\n        ],\n        \"Resources\": [\n            \"qcs::cls:ap-guangzhou:uin/10000000001:topic/c1306921-2180-3e45-9azb-31d12217871e6\"\n        ]\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"SharingUrl\": \"https://clsshare.tencent-cloud.com/s/13cez28h\",\n        \"SharingId\": \"13cez28h\",\n        \"RequestId\": \"714cf720-43e9-460b-bd9a-42a193ca3d94\"\n    }\n}",
+        "title": "创建控制台匿名分享请求示例"
+      }
+    ],
     "CreateConsumer": [
       {
         "document": "CLS 日志投递Ckafka之后，您可以对日志进行实时计算后入库。",
@@ -250,6 +258,14 @@
         "title": "删除应用到机器组的采集配置"
       }
     ],
+    "DeleteConsoleSharing": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteConsoleSharing\n<公共请求参数>\n\n{\n    \"SharingId\": \"13cez28h\"\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"714cf720-43e9-460b-bd9a-42a193ca3d94\"\n    }\n}",
+        "title": "删除控制台匿名分享请求示例"
+      }
+    ],
     "DeleteConsumer": [
       {
         "document": "",
@@ -402,6 +418,14 @@
         "title": "获取采集配置"
       }
     ],
+    "DescribeConsoleSharingList": [
+      {
+        "document": "",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeConsoleSharingList\n<公共请求参数>\n\n{}",
+        "output": "{\n    \"Response\": {\n        \"TotalCount\": 1,\n        \"RequestId\": \"714cf720-43e9-460b-bd9a-42a193ca3d94\"\n    }\n}",
+        "title": "批量查询控制台检索页/仪表盘免登陆分享站点示例"
+      }
+    ],
     "DescribeConsumer": [
       {
         "document": "",
@@ -630,6 +654,14 @@
         "title": "修改特殊采集配置任务"
       }
     ],
+    "ModifyConsoleSharing": [
+      {
+        "document": "目前仅支持修改有效期",
+        "input": "POST / HTTP/1.1\nHost: cls.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyConsoleSharing\n<公共请求参数>\n\n{\n    \"SharingId\": \"13cez28h\",\n    \"DurationMilliseconds\": 1800000\n}",
+        "output": "{\n    \"Response\": {\n        \"RequestId\": \"714cf720-43e9-460b-bd9a-42a193ca3d94\"\n    }\n}",
+        "title": "修改控制台匿名分享请求示例"
+      }
+    ],
     "ModifyConsumer": [
       {
         "document": "修改投递Ckafka任务",