tccli 3.0.1152.1__py2.py3-none-any.whl → 3.0.1154.1__py2.py3-none-any.whl

tccli/services/essbasic/v20210526/api.json

@@ -43,7 +43,7 @@
       "status": "online"
     },
     "ChannelCreateBatchSignUrl": {
-      "document": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注：\n- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，<font color=\"red\">请确保此企业已完成腾讯电子签企业认证</font>。暂时仅支持给<font color=\"red\">自建应用集成企业</font>生成员工批签链接，不支持子客企业。\n- 生成批量签署链接时，合同目标参与方状态需为<font color=\"red\">待签署</font>状态。\n- 个人批量签署进行的合同的签名区， 全部变成<font color=\"red\">手写签名</font>（不管合同里边设置的签名限制）来进行。",
+      "document": "通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注：\n- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n- 个人用户批量签署，需要传Name，Mobile，IdCardNumber(IdCardType) 参数。\n- saas企业员工用户批量签署，在传递了姓名等基本信息参数的情况下，还需要传OrganizationName（参与方所在企业名称）参数生成签署链接，<font color=\"red\">请确保此企业已完成腾讯电子签企业认证</font>。\n- 子客企业员工用户批签签署，需要传递员工OpenId和子客企业的OrganizationOpenId。<font color=\"red\">请确保此OrganizationOpenId对应子客已经认证，且OpenId对应员工此子客下已经实名</font>。Name，Mobile, IdCard等信息此时可以不传，系统会查询此OpenId实名信息自动补充。\n- 生成批量签署链接时，合同目标参与方状态需为<font color=\"red\">待签署</font>状态。\n- 个人批量签署进行的合同的签名区， 全部变成<font color=\"red\">手写签名</font>（不管合同里边设置的签名限制）来进行。",
       "input": "ChannelCreateBatchSignUrlRequest",
       "name": "获取跳转至腾讯电子签小程序的批量签署链接",
       "output": "ChannelCreateBatchSignUrlResponse",
@@ -337,7 +337,7 @@
       "status": "online"
     },
     "CreateConsoleLoginUrl": {
-      "document": "此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态，进入不同的流程，主要情况分类如下：\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程，首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程，需要注意如下情况：\n\n1. 若在激活过程中，**更换用户OpenID重新生成链接，之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作，会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证，**可通过更换用户OpenID重新生成链接的方式，来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 &  子企业认证示例</a><br>",
+      "document": "此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。\n\nWeb链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态，进入不同的流程，主要情况分类如下：\n<table>\n<thead>\n<tr>\n<th>子客企业状态</th>\n<th>子客企业员工状态</th>\n<th>点击链接进入的流程</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>企业未激活</td>\n<td>员工未认证</td>\n<td>进入企业激活流程，首次完成企业激活流程的员工会成为超管</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工未认证</td>\n<td>进入员工认证并加入企业流程</td>\n</tr>\n<tr>\n<td>企业已激活</td>\n<td>员工已认证</td>\n<td>进入子客企业Web控制台</td>\n</tr>\n</tbody>\n</table>\n如果是企业激活流程，需要注意如下情况：\n\n1. 若在激活过程中，**更换用户OpenID重新生成链接，之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作，会导致认证过程互相影响。\n2. 若您认证中发现信息有误需要重新认证，**可通过更换用户OpenID重新生成链接的方式，来清理掉已有的流程**。\n\n系统的渠道企业, 应用, 子客企业, 子客员工的组织形式\n![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)\n\n\n<font color=\"red\">相关视频指引</font> <br>\n1. <a href=\"https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4\" target=\"_blank\">【生成子客登录链接】代码编写 &  子企业认证示例</a><br>",
       "input": "CreateConsoleLoginUrlRequest",
       "name": "生成子客登录链接",
       "output": "CreateConsoleLoginUrlResponse",
@@ -1686,7 +1686,7 @@
         },
         {
           "disabled": false,
-          "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`，`除动态签署人场景外，此参数必填`",
+          "document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。\n\n注：`请确保和合同中填入的一致`，`除动态签署人或子客员工经办人场景外，此参数必填`",
           "example": "无",
           "member": "string",
           "name": "Name",
@@ -1695,7 +1695,7 @@
         },
         {
           "disabled": false,
-          "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`",
+          "document": "手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人或子客员工经办人场景外，此参数必填`",
           "example": "无",
           "member": "string",
           "name": "Mobile",
@@ -1749,7 +1749,7 @@
         },
         {
           "disabled": false,
-          "document": "目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。\n\n注：\n<ul>\n<li>请确认该名称与企业营业执照中注册的名称一致。</li>\n<li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>\n<li>请确保此企业已完成腾讯电子签企业认证。</li>\n<li>暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。</li>\n</ul>",
+          "document": "SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份，此参数必填。\n\n注：\n<ul>\n<li>请确认该名称与企业营业执照中注册的名称一致。</li>\n<li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>\n<li>请确保此企业已完成腾讯电子签企业认证。</li>\n<li>**若为子客企业员工，请使用OpenId，OrganizationOpenId参数，此参数留空即可**</li>\n</ul>",
           "example": "无",
           "member": "string",
           "name": "OrganizationName",
@@ -1773,6 +1773,24 @@
           "name": "FlowBatchUrlInfo",
           "required": false,
           "type": "object"
+        },
+        {
+          "disabled": false,
+          "document": "第三方平台子客企业员工的标识OpenId，批签合同经办人为子客员工的情况下为必填。\n\n注：\n<ul>\n<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>\n<li>传递了此参数可以无需传递Name，Mobile，IdCardNumber，IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>\n</ul>",
+          "example": "无",
+          "member": "string",
+          "name": "OpenId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId，批签合同经办人为子客企业员工是为必填。",
+          "example": "无",
+          "member": "string",
+          "name": "OrganizationOpenId",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -6803,7 +6821,7 @@
         },
         {
           "disabled": false,
-          "document": "电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li></ul>注: `同企业下只能有<font color=\"red\">一个</font>公章, 重复创建会报错`",
+          "document": "电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**OTHER**: 其他</li></ul>注: 同企业下只能有<font color=\"red\">一个</font>公章, 重复创建会报错",
           "example": "OFFICIAL",
           "member": "string",
           "name": "SealType",

tccli/services/essbasic/v20210526/examples.json

@@ -122,10 +122,10 @@
         "title": "生成个人小程序批量签署链接"
       },
       {
-        "document": "按照合同发起时候填入的信息生成企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制",
+        "document": "按照合同发起时候填入的信息生成saas企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制",
         "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n    \"IdCardNumber\": \"610000000000000000\",\n    \"IdCardType\": \"ID_CARD\",\n    \"Name\": \"小明\",\n    \"NotifyType\": \"SMS\",\n    \"Mobile\": \"1234567890\",\n    \"OrganizationName\": \"典子谦示例企业\",\n    \"Agent\": {\n        \"ProxyOperator\": {\n            \"OpenId\": \"test_open_id\"\n        },\n        \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n        \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n    },\n    \"FlowIds\": [\n        \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n        \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n    ]\n}",
         "output": "{\n    \"Response\": {\n        \"ExpiredTime\": 1684899114,\n        \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n        \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n        \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n    }\n}",
-        "title": "生成企业经办人小程序批量签署链接"
+        "title": "生成saas企业经办人小程序批量签署链接"
       },
       {
         "document": "合同（yDR1AUUgygja******uO4zjEB8zAkJEFN）中的参与方为：【姓名：张三 ，手机号：18888888888】，发起的时候并未填入证件号且18888888888手机号并未在腾讯电子签注册实名。 \n\n此时，如果使用 【姓名：张三，手机号：17777777777】生成批量签署链接，且FlowIds参数传入（yDR1AUUgygja******uO4zjEB8zAkJEFN）时，会报错，提示签署方信息不存在。\n\n因为手机号不同，无法定位到签署方。 此时，除了将手机号修改成 18888888888 之外来解决问题，也可以在发起合同和生成链接的时候传入证件信息，保证姓名和证件一致的情况下，手机号可以不相同。",
@@ -138,6 +138,12 @@
         "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n    \"Agent\": {\n        \"ProxyOperator\": {\n            \"OpenId\": \"test_open_id\"\n        },\n        \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n        \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n    },\n    \"FlowIds\": [\n        \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n        \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n    ],\n    \"FlowBatchUrlInfo\": {\n        \"FlowBatchApproverInfos\": [\n            {\n                \"FlowId\": \"yDC5yUUckpwexoz4UuoHfkT1DMEDQSG5\",\n                \"RecipientId\": \"yDC5yUUckpwexozwUuoHfkTwB00zdfLo\"\n            }\n        ]\n    }\n}",
         "output": "{\n    \"Response\": {\n        \"ExpiredTime\": 1684899114,\n        \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n        \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n        \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n    }\n}",
         "title": "生成动态签署人批量领取链接"
+      },
+      {
+        "document": "按照合同发起时候填入的信息生成子客企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制",
+        "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n    \"OpenId\": \"test_open_id\",\n    \"OrganizationOpenId\": \"test_org_open_id\",\n    \"Name\": \"\",\n    \"NotifyType\": \"SMS\",\n    \"Mobile\": \"\",\n    \"OrganizationName\": \"\",\n    \"Agent\": {\n        \"ProxyOperator\": {\n            \"OpenId\": \"test_open_id\"\n        },\n        \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n        \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n    },\n    \"FlowIds\": [\n        \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n        \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n    ]\n}",
+        "output": "{\n    \"Response\": {\n        \"ExpiredTime\": 1684899114,\n        \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n        \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n        \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n    }\n}",
+        "title": "生成子客经办人小程序批量签署链接"
       }
     ],
     "ChannelCreateBoundFlows": [

tccli/services/faceid/v20180301/api.json

@@ -978,11 +978,11 @@
       "members": [
         {
           "disabled": false,
-          "document": "认证结果码，收费情况如下。\n收费结果码：\n0: 一致\n-1: 不一致\n不收费结果码：\n-2: 非法身份证号（长度、校验位等不正确）\n-3: 非法姓名（长度、格式等不正确）\n-4: 非法有效期（长度、格式等不正确）\n-5: 身份信息无效\n-6: 证件库服务异常\n-7: 证件库中无此身份证记录",
+          "document": "认证结果码，收费情况如下。\n收费结果码：\n0: 一致\n-1: 不一致\n不收费结果码：\n-2: 非法身份证号（长度、校验位等不正确）\n-3: 非法姓名（长度、格式等不正确）\n-4: 非法有效期（长度、格式等不正确）\n-5: 身份信息无效\n-6: 证件库服务异常\n-7: 证件库中无此身份证记录\n-8: 认证次数超过当日限制，请次日重试",
           "example": "\"0\"",
           "member": "string",
           "name": "Result",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -992,7 +992,7 @@
           "example": "核验一致",
           "member": "string",
           "name": "Description",
-          "required": true,
+          "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
@@ -1043,7 +1043,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "认证结果码，收费情况如下。\n收费结果码：\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码：\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法",
+          "document": "认证结果码，收费情况如下。\n收费结果码：\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码：\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常\n-4:姓名校验不通过\n-5:手机号码不合法\n-6: 认证次数超过当日限制，请次日重试",
           "example": "0",
           "member": "string",
           "name": "Result",
@@ -4945,7 +4945,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "认证结果码:\n收费结果码\n0: 三要素信息一致\n-4: 三要素信息不一致\n不收费结果码\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙",
+          "document": "认证结果码:\n收费结果码\n0: 三要素信息一致\n-4: 三要素信息不一致\n不收费结果码\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-11: 验证中心服务繁忙\n-12: 认证次数超过当日限制，请次日重试",
           "example": "0",
           "member": "string",
           "name": "Result",

tccli/services/hunyuan/v20230901/api.json

@@ -8,7 +8,7 @@
       "status": "online"
     },
     "GetEmbedding": {
-      "document": "腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。",
+      "document": "腾讯混元 Embedding 接口，可以将文本转化为高质量的向量数据。向量维度为1024维。",
       "input": "GetEmbeddingRequest",
       "name": "hunyuan-embedding",
       "output": "GetEmbeddingResponse",
@@ -711,7 +711,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空，推荐使用中文。最多可传100个 utf-8 字符。",
+          "document": "文本描述。 \n算法将根据输入的文本智能生成与之相关的图像。 \n不能为空，推荐使用中文。最多可传1024个 utf-8 字符。",
           "example": "雨中, 竹林,  小路",
           "member": "string",
           "name": "Prompt",

tccli/services/lighthouse/v20200324/api.json

@@ -4559,7 +4559,7 @@
           "example": "4",
           "member": "int64",
           "name": "TotalCount",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -4569,7 +4569,7 @@
           "example": "无",
           "member": "RegionInfo",
           "name": "RegionSet",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -4837,7 +4837,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "可用区列表排序的依据字段。取值范围：\n<li>ZONE：依据可用区排序。\n<li>INSTANCE_DISPLAY_LABEL：依据可用区展示标签排序，可用区展示标签包括：HIDDEN（隐藏）、NORMAL（普通）、SELECTED（默认选中），默认采用的升序排列为：['HIDDEN', 'NORMAL', 'SELECTED']。\n默认按可用区排序。",
+          "document": "可用区列表排序的依据字段。取值范围：\n<li>ZONE：依据可用区排序。</li>\n<li>INSTANCE_DISPLAY_LABEL：依据可用区展示标签排序，可用区展示标签包括：HIDDEN（隐藏）、NORMAL（普通）、SELECTED（默认选中），默认采用的升序排列为：['HIDDEN', 'NORMAL', 'SELECTED']。\n默认按可用区排序。</li>",
           "example": "\"ZONE\"",
           "member": "string",
           "name": "OrderField",
@@ -4846,7 +4846,7 @@
         },
         {
           "disabled": false,
-          "document": "输出可用区列表的排列顺序。取值范围：\n<li>ASC：升序排列。 \n<li>DESC：降序排列。\n默认按升序排列。",
+          "document": "输出可用区列表的排列顺序。取值范围：\n<li>ASC：升序排列。 </li>\n<li>DESC：降序排列。</li>\n默认按升序排列。",
           "example": "\"DESC\"",
           "member": "string",
           "name": "Order",
@@ -4865,7 +4865,7 @@
           "example": "1",
           "member": "int64",
           "name": "TotalCount",
-          "required": true,
+          "output_required": true,
           "type": "int",
           "value_allowed_null": false
         },
@@ -4875,7 +4875,7 @@
           "example": "无",
           "member": "ZoneInfo",
           "name": "ZoneInfoSet",
-          "required": true,
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },

tccli/services/live/v20180801/api.json

@@ -162,7 +162,7 @@
       "status": "online"
     },
     "CreateRecordTask": {
-      "document": "创建一个在指定时间启动、结束的录制任务，并使用指定录制模板ID对应的配置进行录制。\n- 使用前提\n1. 录制文件存放于点播平台，所以用户如需使用录制功能，需首先自行开通点播服务。\n2. 录制文件存放后相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，具体请参考[对应文档](https://cloud.tencent.com/document/product/266/2837)。\n- 注意事项\n1. 断流会结束当前录制并生成录制文件。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常录制，与是否多次推、断流无关。\n2. 使用上避免创建时间段相互重叠的录制任务。若同一条流当前存在多个时段重叠的任务，为避免重复录制系统将启动最多3个录制任务。\n3. 创建的录制任务记录在平台侧只保留3个月。\n4. 当前录制任务管理API（[CreateRecordTask](https://cloud.tencent.com/document/product/267/45983)/[StopRecordTask](https://cloud.tencent.com/document/product/267/45981)/[DeleteRecordTask](https://cloud.tencent.com/document/product/267/45982)）与旧API（CreateLiveRecord/StopLiveRecord/DeleteLiveRecord）不兼容，两套接口不能混用。\n5. 避免 创建录制任务 与 推流 操作同时进行，可能导致因录制任务未生效而引起任务延迟启动问题，两者操作间隔建议大于3秒。",
+      "document": "创建一个在指定时间启动、结束的录制任务，并使用指定录制模板ID对应的配置进行录制。\n- 使用前提\n1. 录制文件存放于点播平台或对象存储内，所以用户如需使用录制功能，需首先自行开通点播服务或对象存储服务。\n2. 录制文件存放后相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，具体请参考[对应文档](https://cloud.tencent.com/document/product/266/2837)。\n- 注意事项\n1. 断流会结束当前录制并生成录制文件。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常录制，与是否多次推、断流无关。\n2. 使用上避免创建时间段相互重叠的录制任务。若同一条流当前存在多个时段重叠的任务，为避免重复录制系统将启动最多3个录制任务。\n3. 创建的录制任务记录在平台侧只保留3个月。\n4. 当前录制任务管理API（[CreateRecordTask](https://cloud.tencent.com/document/product/267/45983)/[StopRecordTask](https://cloud.tencent.com/document/product/267/45981)/[DeleteRecordTask](https://cloud.tencent.com/document/product/267/45982)）与旧API（CreateLiveRecord/StopLiveRecord/DeleteLiveRecord）不兼容，两套接口不能混用。\n5. 避免 创建录制任务 与 推流 操作同时进行，可能导致因录制任务未生效而引起任务延迟启动问题，两者操作间隔建议大于3秒。",
       "input": "CreateRecordTaskRequest",
       "name": "创建录制任务（新）",
       "output": "CreateRecordTaskResponse",

tccli/services/lke/v20231130/api.json

@@ -5059,7 +5059,7 @@
         {
           "disabled": false,
           "document": "任务类型",
-          "example": "ModifyAttributeLabel",
+          "example": "编辑标签任务类型：ModifyAttributeLabel  导出标签任务类型：ExportAttributeLabel",
           "member": "string",
           "name": "TaskType",
           "required": true,
@@ -5093,7 +5093,7 @@
         {
           "disabled": false,
           "document": "任务类型",
-          "example": "ModifyAttributeLabel",
+          "example": "编辑标签任务类型：ModifyAttributeLabel  导出标签任务类型：ExportAttributeLabel",
           "member": "string",
           "name": "TaskType",
           "output_required": false,
@@ -5103,7 +5103,7 @@
         {
           "disabled": false,
           "document": "任务状态\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "RUNNING",
+          "example": "执行中：RUNNING  成功：SUCCESS 失败：FAILED 等待中：PENDING",
           "member": "string",
           "name": "Status",
           "output_required": false,

tccli/services/mongodb/v20190725/api.json

@@ -921,7 +921,7 @@
         },
         {
           "disabled": false,
-          "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
+          "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
           "example": "2",
           "member": "uint64",
           "name": "NodeNum",
@@ -1166,7 +1166,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
+          "document": "- 创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
           "example": "3",
           "member": "uint64",
           "name": "NodeNum",

tccli/services/monitor/v20180724/api.json

@@ -869,7 +869,7 @@
       "status": "online"
     },
     "ModifyPrometheusConfig": {
-      "document": "修改prometheus配置，如果配置项不存在，则会新增",
+      "document": "修改prometheus采集配置",
       "input": "ModifyPrometheusConfigRequest",
       "name": "修改prometheus配置",
       "output": "ModifyPrometheusConfigResponse",
@@ -4372,7 +4372,7 @@
         {
           "disabled": false,
           "document": "实例ID",
-          "example": "prom-xxx",
+          "example": "prom-oejhr",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -4917,7 +4917,7 @@
         },
         {
           "disabled": false,
-          "document": "服务发现配置信息，YAML 格式\n\n示例值：\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n  name: go-demo    # 填写一个唯一名称\n  namespace: cm-prometheus  # namespace固定，不要修改\nspec:\n  endpoints:\n  - interval: 30s\n    # 填写service yaml中Prometheus Exporter对应的Port的Name\n    port: 2112\n    # 填写Prometheus Exporter对应的Path的值，不填默认/metrics\n    path: /metrics\n    relabelings:\n    # ** 必须要有一个 label 为 application，这里假设 k8s 有一个 label 为 app，\n    # 我们通过 relabel 的 replace 动作把它替换成了 application\n    - action: replace\n      sourceLabels:  [__meta_kubernetes_pod_label_app]\n      targetLabel: application\n  # 选择要监控service所在的namespace\n  namespaceSelector:\n    matchNames:\n    - golang-demo\n    # 填写要监控service的Label值，以定位目标service\n  selector:\n    matchLabels:\n      app: golang-app-demo\n```",
+          "document": "服务发现配置信息，YAML 格式，[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)",
           "example": "yaml",
           "member": "string",
           "name": "Yaml",
@@ -5426,7 +5426,7 @@
         {
           "disabled": false,
           "document": "agent列表",
-          "example": "无",
+          "example": "{\"ClusterType\":\"cls-kehr\",\"ClusterId\":\"tke\",\"Describe\":\"test-des\"}",
           "member": "PrometheusAgentInfo",
           "name": "Agents",
           "required": true,
@@ -5435,7 +5435,7 @@
         {
           "disabled": false,
           "document": "实例id",
-          "example": "prome-xx",
+          "example": "prom-kehf",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -5489,7 +5489,7 @@
         {
           "disabled": false,
           "document": "要删除的ServiceMonitor名字列表",
-          "example": "xxx",
+          "example": "[\"test-sm\"]",
           "member": "string",
           "name": "ServiceMonitors",
           "required": false,
@@ -5498,7 +5498,7 @@
         {
           "disabled": false,
           "document": "要删除的PodMonitor名字列表",
-          "example": "xxx",
+          "example": "[\"test-pm\"]",
           "member": "string",
           "name": "PodMonitors",
           "required": false,
@@ -5507,7 +5507,7 @@
         {
           "disabled": false,
           "document": "要删除的RawJobs名字列表",
-          "example": "xxx",
+          "example": "[\"test-rj\"]",
           "member": "string",
           "name": "RawJobs",
           "required": false,
@@ -5534,7 +5534,7 @@
         {
           "disabled": false,
           "document": "实例id",
-          "example": "xxx",
+          "example": "prom-wjheg",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -5543,7 +5543,7 @@
         {
           "disabled": false,
           "document": "聚合规则列表",
-          "example": "xxx",
+          "example": "[\"test-rule\"]",
           "member": "string",
           "name": "Names",
           "required": true,
@@ -5785,7 +5785,7 @@
         },
         {
           "disabled": false,
-          "document": "服务发现配置信息，YAML 格式\n\n示例值：\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n  name: go-demo    # 填写一个唯一名称\n  namespace: cm-prometheus  # namespace固定，不要修改\nspec:\n  endpoints:\n  - interval: 30s\n    # 填写service yaml中Prometheus Exporter对应的Port的Name\n    port: 2112\n    # 填写Prometheus Exporter对应的Path的值，不填默认/metrics\n    path: /metrics\n    relabelings:\n    # ** 必须要有一个 label 为 application，这里假设 k8s 有一个 label 为 app，\n    # 我们通过 relabel 的 replace 动作把它替换成了 application\n    - action: replace\n      sourceLabels:  [__meta_kubernetes_pod_label_app]\n      targetLabel: application\n  # 选择要监控service所在的namespace\n  namespaceSelector:\n    matchNames:\n    - golang-demo\n    # 填写要监控service的Label值，以定位目标service\n  selector:\n    matchLabels:\n      app: golang-app-demo\n```",
+          "document": "服务发现配置信息，YAML 格式，[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)",
           "example": "yaml",
           "member": "string",
           "name": "Yaml",
@@ -11163,7 +11163,7 @@
         {
           "disabled": false,
           "document": "集群id\n可以是tke, eks, edge的集群id",
-          "example": "cls-xxx",
+          "example": "cls-dkrb",
           "member": "string",
           "name": "ClusterId",
           "required": true,
@@ -11178,7 +11178,7 @@
         {
           "disabled": false,
           "document": "关联该集群的实例列表\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "prom-xxx",
+          "example": "[\"prom-oebnrfg\"]",
           "member": "string",
           "name": "Instances",
           "output_required": true,
@@ -11448,7 +11448,7 @@
         },
         {
           "disabled": false,
-          "document": "用于分页",
+          "document": "偏移量，默认为0。",
           "example": "1",
           "member": "uint64",
           "name": "Offset",
@@ -11457,7 +11457,7 @@
         },
         {
           "disabled": false,
-          "document": "用于分页",
+          "document": "返回数量，默认为20，最大值为100。",
           "example": "1",
           "member": "uint64",
           "name": "Limit",
@@ -11937,7 +11937,7 @@
         {
           "disabled": false,
           "document": "实例ID",
-          "example": "prom-xxx",
+          "example": "prom-asdfghjk",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -11962,7 +11962,7 @@
         {
           "disabled": false,
           "document": "初始化任务步骤\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "{\"Step\":\"abc\",\"LifeState\":\"abc\",\"StartAt\":\"abc\",\"EndAt\":\"abc\",\"FailedMsg\":\"abc\"}",
+          "example": "无",
           "member": "TaskStepInfo",
           "name": "Steps",
           "output_required": true,
@@ -11972,7 +11972,7 @@
         {
           "disabled": false,
           "document": "实例eks集群ID\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "cls-abc",
+          "example": "cls-asdf1234",
           "member": "string",
           "name": "EksClusterId",
           "output_required": true,
@@ -11982,7 +11982,7 @@
         {
           "disabled": false,
           "document": "eks集群内pod的安全组\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "sg-abc",
+          "example": "sg-asdf1234",
           "member": "string",
           "name": "SecurityGroupId",
           "output_required": false,
@@ -12058,7 +12058,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "用于分页",
+          "document": "分页偏移量，默认为0",
           "example": "1",
           "member": "uint64",
           "name": "Offset",
@@ -12067,7 +12067,7 @@
         },
         {
           "disabled": false,
-          "document": "用于分页",
+          "document": "返回数量，默认为20，最大值为100",
           "example": "20",
           "member": "uint64",
           "name": "Limit",
@@ -12077,7 +12077,7 @@
         {
           "disabled": false,
           "document": "过滤实例，目前支持：\nID: 通过实例ID来过滤 \nName: 通过实例名称来过滤",
-          "example": "无",
+          "example": "[{\"Name\": \"Name\",\"Values\": [\"test\"]}]",
           "member": "Filter",
           "name": "Filters",
           "required": false,
@@ -12535,7 +12535,7 @@
         },
         {
           "disabled": false,
-          "document": "targets偏移量，默认为0",
+          "document": "targets分页偏移量，默认为0",
           "example": "0",
           "member": "uint64",
           "name": "Offset",
@@ -12560,7 +12560,7 @@
         {
           "disabled": false,
           "document": "所有Job的targets信息",
-          "example": "{                 \"Targets\": [                     {                         \"LastScrape\": \"xx\",                         \"ScrapeDuration\": 0.0,                         \"Url\": \"xx\",                         \"Labels\": [                             {                                 \"Name\": \"xx\",                                 \"Value\": \"xx\"                             }                         ],                         \"State\": \"xx\",                         \"Error\": \"xx\"                     }                 ],                 \"Total\": 1,                 \"Up\": 1,                 \"JobName\": \"xx\"             }",
+          "example": "{\"Targets\":[{\"LastScrape\":\"2024-06-19 16:22:26\",\"ScrapeDuration\":0.2,\"Url\":\"http://1.1.1.1:9000\",\"Labels\":[{\"Name\":\"label-name\",\"Value\":\"label-value\"}],\"State\":\"down\",\"Error\":\"scrape timeout\"}],\"Total\":1,\"Up\":0,\"JobName\":\"test-job\"}",
           "member": "PrometheusJobTargets",
           "name": "Jobs",
           "output_required": true,
@@ -12590,7 +12590,7 @@
         },
         {
           "disabled": false,
-          "document": "分页偏移",
+          "document": "分页偏移量，默认为0",
           "example": "0",
           "member": "uint64",
           "name": "Offset",
@@ -14389,7 +14389,7 @@
         {
           "disabled": false,
           "document": "map表中的Name",
-          "example": "xxx",
+          "example": "label-name",
           "member": "string",
           "name": "Name",
           "output_required": true,
@@ -14400,7 +14400,7 @@
         {
           "disabled": false,
           "document": "map表中的Value",
-          "example": "xxx",
+          "example": "label-value",
           "member": "string",
           "name": "Value",
           "output_required": true,
@@ -15719,7 +15719,7 @@
         {
           "disabled": false,
           "document": "新的external_labels",
-          "example": "Name=xx, Value=xxx",
+          "example": "{\"Name\":\"label-name\",\"Value\":\"label-value\"}",
           "member": "Label",
           "name": "ExternalLabels",
           "required": true,
@@ -15836,7 +15836,7 @@
         {
           "disabled": false,
           "document": "0: 更新实例组件镜像版本；\n1: 不更新实例组件镜像版本",
-          "example": "0,1",
+          "example": "0",
           "member": "int64",
           "name": "UpdateImage",
           "required": false,
@@ -19257,7 +19257,7 @@
         {
           "disabled": false,
           "document": "实例ID",
-          "example": "prom-xxx",
+          "example": "prom-asdfghjk",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -19266,7 +19266,7 @@
         {
           "disabled": false,
           "document": "子网ID，默认使用实例所用子网初始化，也可通过该参数传递新的子网ID初始化",
-          "example": "xx-xxx",
+          "example": "subnet-asdfghjk",
           "member": "string",
           "name": "SubnetId",
           "required": false,
@@ -20637,8 +20637,8 @@
       "members": [
         {
           "disabled": false,
-          "document": "Prometheus 实例 ID，例如：prom-abcd1234",
-          "example": "xx",
+          "document": "Prometheus 实例 ID",
+          "example": "prom-abcd1234",
           "member": "string",
           "name": "InstanceId",
           "required": true,
@@ -20646,8 +20646,8 @@
         },
         {
           "disabled": false,
-          "document": "Agent ID 列表，例如：agent-abcd1234，可在控制台 Agent 管理中获取\n\n示例值：[\"agent-abcd1234\"]",
-          "example": "[\"xx\"]",
+          "document": "Agent ID 列表，例如：agent-abcd1234，可在控制台 Agent 管理中获取",
+          "example": "[\"agent-abcd1234\"]",
           "member": "string",
           "name": "AgentIds",
           "required": true,
@@ -21044,7 +21044,7 @@
         },
         {
           "disabled": false,
-          "document": "服务发现配置信息，YAML 格式\n\n示例值：\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n  name: go-demo    # 填写一个唯一名称\n  namespace: cm-prometheus  # namespace固定，不要修改\nspec:\n  endpoints:\n  - interval: 30s\n    # 填写service yaml中Prometheus Exporter对应的Port的Name\n    port: 2112\n    # 填写Prometheus Exporter对应的Path的值，不填默认/metrics\n    path: /metrics\n    relabelings:\n    # ** 必须要有一个 label 为 application，这里假设 k8s 有一个 label 为 app，\n    # 我们通过 relabel 的 replace 动作把它替换成了 application\n    - action: replace\n      sourceLabels:  [__meta_kubernetes_pod_label_app]\n      targetLabel: application\n  # 选择要监控service所在的namespace\n  namespaceSelector:\n    matchNames:\n    - golang-demo\n    # 填写要监控service的Label值，以定位目标service\n  selector:\n    matchLabels:\n      app: golang-app-demo\n```",
+          "document": "服务发现配置信息，YAML 格式，[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)",
           "example": "yaml",
           "member": "string",
           "name": "Yaml",