tccli 3.0.1250.1__py2.py3-none-any.whl → 3.0.1252.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/aiart/v20221229/api.json +13 -4
  3. tccli/services/bi/v20220105/api.json +6 -6
  4. tccli/services/cat/v20180409/api.json +25 -24
  5. tccli/services/cat/v20180409/examples.json +17 -17
  6. tccli/services/ccc/ccc_client.py +53 -0
  7. tccli/services/ccc/v20200210/api.json +89 -0
  8. tccli/services/ccc/v20200210/examples.json +8 -0
  9. tccli/services/cdb/v20170320/api.json +12 -0
  10. tccli/services/cdn/v20180606/api.json +1 -1
  11. tccli/services/cdwdoris/v20211228/api.json +233 -193
  12. tccli/services/cdwdoris/v20211228/examples.json +6 -6
  13. tccli/services/cloudaudit/v20190319/api.json +2 -2
  14. tccli/services/cloudaudit/v20190319/examples.json +2 -2
  15. tccli/services/config/v20220802/api.json +20 -9
  16. tccli/services/config/v20220802/examples.json +1 -1
  17. tccli/services/dc/v20180410/api.json +13 -11
  18. tccli/services/dc/v20180410/examples.json +8 -2
  19. tccli/services/emr/v20190103/api.json +26 -21
  20. tccli/services/emr/v20190103/examples.json +2 -2
  21. tccli/services/ess/v20201111/api.json +474 -467
  22. tccli/services/ess/v20201111/examples.json +10 -10
  23. tccli/services/essbasic/v20210526/api.json +405 -408
  24. tccli/services/essbasic/v20210526/examples.json +12 -12
  25. tccli/services/hunyuan/v20230901/api.json +22 -0
  26. tccli/services/lcic/v20220817/api.json +1 -1
  27. tccli/services/monitor/v20180724/api.json +68 -50
  28. tccli/services/monitor/v20180724/examples.json +22 -22
  29. tccli/services/mps/mps_client.py +379 -61
  30. tccli/services/mps/v20190612/api.json +495 -13
  31. tccli/services/mps/v20190612/examples.json +48 -0
  32. tccli/services/nlp/v20190408/api.json +1 -1
  33. tccli/services/ocr/v20181119/api.json +7 -7
  34. tccli/services/ocr/v20181119/examples.json +6 -6
  35. tccli/services/pts/v20210728/api.json +589 -497
  36. tccli/services/pts/v20210728/examples.json +17 -17
  37. tccli/services/rum/v20210622/api.json +79 -19
  38. tccli/services/ssl/v20191205/api.json +3 -3
  39. tccli/services/ssl/v20191205/examples.json +1 -1
  40. tccli/services/teo/v20220901/api.json +10 -10
  41. tccli/services/trtc/v20190722/api.json +11 -0
  42. tccli/services/tse/v20201207/api.json +10 -0
  43. tccli/services/vpc/v20170312/api.json +1 -1
  44. tccli/services/wedata/v20210820/api.json +382 -96
  45. tccli/services/wedata/v20210820/examples.json +1 -1
  46. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/METADATA +2 -2
  47. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/RECORD +50 -50
  48. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/WHEEL +0 -0
  49. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/entry_points.txt +0 -0
  50. {tccli-3.0.1250.1.dist-info → tccli-3.0.1252.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/essbasic/v20210526/examples.json CHANGED
@@ -420,13 +420,13 @@
420
420
  {
421
421
  "document": "创建一码多扫流程签署二维码，设置该二维码在7天内有效，并将最大合同流程签署数量限制为100份。 设定签署合同的有效期为7天。\n",
422
422
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateMultiFlowSignQRCode\n<公共请求参数>\n\n{\n \"FlowName\": \"通过签署二维码创建的示例合同\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"proxy-operator-openid\"\n },\n \"ProxyOrganizationOpenId\": \"proxy-org-openid\",\n \"AppId\": \"yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ\"\n },\n \"FlowEffectiveDay\": 7,\n \"TemplateId\": \"yDRvzUUgygqj42ouUuO4zjEueBrK5MeV\",\n \"MaxFlowNum\": 100,\n \"QrEffectiveDay\": 7\n}",
423
- "output": "{\n \"Response\": {\n \"QrCode\": {\n \"ExpiredTime\": 1695783727,\n \"QrCodeId\": \"yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR\",\n \"QrCodeUrl\": \"https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR.png\"\n },\n \"RequestId\": \"s1695178926924585393\",\n \"SignUrls\": {\n \"AppSignUrl\": \"pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\",\n \"EffectiveTime\": \"\",\n \"HttpSignUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\"\n }\n }\n}",
423
+ "output": "{\n \"Response\": {\n \"QrCode\": {\n \"ExpiredTime\": 1695783727,\n \"QrCodeId\": \"yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR\",\n \"QrCodeUrl\": \"https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR.png\",\n \"WeixinQrCodeUrl\": \"https://file.ess.tencent.cn/bresource/resource/resource/0/0.PNG?hkey=a976edda49eacc2b264c2df468c30fcd69023cd782421bdbedddf8a95c7859d4467844c38fb9ea20b47d4b2f89396717f8deac5dcb25f32d718f0c13b48f53a2f6f69096b3b301aad56de87d7a8499fe374e5e2891dd778bb0c82394640fe124be22c63ba4e022a046cbc298006d3341\"\n },\n \"RequestId\": \"s1695178926924585393\",\n \"SignUrls\": {\n \"AppSignUrl\": \"pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\",\n \"EffectiveTime\": \"\",\n \"HttpSignUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\"\n }\n }\n}",
424
424
  "title": "创建有数量或时间限制的一码多签签署码"
425
425
  },
426
426
  {
427
427
  "document": "1.使用B2C模板 yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ 创建了一个签署二维码。\n2.指定RecipientId 为 yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh 的签署人在签名时可以手写（HANDWRITE） 或者使用系统签名 (SYSTEM_ESIGN)。\n3.指定RecipientId 为 yDwJNUUckpkojrmqUxTFHk0yndh70CpW 的签署人在签名时只能使用AI智能识别手写签名（OCR_ESIGN）。",
428
428
  "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateMultiFlowSignQRCode\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"proxy-operator-openid\"\n },\n \"ProxyOrganizationOpenId\": \"proxy-org-openid\",\n \"AppId\": \"yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ\"\n },\n \"TemplateId\": \"yDRvzUUgygqj42ouUuO4zjEueBrK5MeV\",\n \"FlowName\": \"通过签署二维码创建的示例合同\",\n \"FlowEffectiveDay\": 5,\n \"QrEffectiveDay\": 7,\n \"MaxFlowNum\": 100,\n \"ApproverComponentLimitTypes\": [\n {\n \"RecipientId\": \"yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh\",\n \"Values\": [\n \"HANDWRITE\",\n \"SYSTEM_ESIGN\"\n ]\n },\n {\n \"RecipientId\": \"yDwJNUUckpkojrmqUxTFHk0yndh70CpW\",\n \"Values\": [\n \"OCR_ESIGN\"\n ]\n }\n ]\n}",
429
- "output": "{\n \"Response\": {\n \"QrCode\": {\n \"ExpiredTime\": 1695783727,\n \"QrCodeId\": \"yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR\",\n \"QrCodeUrl\": \"https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR.png\"\n },\n \"RequestId\": \"s1695178926924585393\",\n \"SignUrls\": {\n \"AppSignUrl\": \"pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\",\n \"EffectiveTime\": \"\",\n \"HttpSignUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\"\n }\n }\n}",
429
+ "output": "{\n \"Response\": {\n \"QrCode\": {\n \"ExpiredTime\": 1695783727,\n \"QrCodeId\": \"yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR\",\n \"QrCodeUrl\": \"https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR.png\",\n \"WeixinQrCodeUrl\": \"https://file.ess.tencent.cn/bresource/resource/resource/0/0.PNG?hkey=a976edda49eacc2b264c2df468c30fcd69023cd782421bdbedddf8a95c7859d4467844c38fb9ea20b47d4b2f89396717f8deac5dcb25f32d718f0c13b48f53a2f6f69096b3b301aad56de87d7a8499fe374e5e2891dd778bb0c82394640fe124be22c63ba4e022a046cbc298006d3341\"\n },\n \"RequestId\": \"s1695178926924585393\",\n \"SignUrls\": {\n \"AppSignUrl\": \"pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\",\n \"EffectiveTime\": \"\",\n \"HttpSignUrl\": \"https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727\"\n }\n }\n}",
430
430
  "title": "创建指定了签署方签名方式的一码多签签署码"
431
431
  }
432
432
  ],
@@ -477,31 +477,31 @@
477
477
  "ChannelCreateReleaseFlow": [
478
478
  {
479
479
  "document": "1. 使用原流程的签署人\n2. 包含了详细的解除内容",
480
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReliveInfo\": {\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\",\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\"\n }\n}",
480
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReliveInfo\": {\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\",\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\"\n }\n}",
481
481
  "output": "{\n \"Response\": {\n \"FlowId\": \"yDwFdUUckps******xAhL7zuaIwkMth\",\n \"RequestId\": \"s1669**2203341\"\n }\n}",
482
482
  "title": "发起解除协议(默认情况，使用原流程的签署人)"
483
483
  },
484
484
  {
485
485
  "document": "1. 解除某个包含个人类型签署人的合同\n2. 更换其他个人类型签署人作为解除协议的参与人",
486
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 2,\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"15100000000\",\n \"Name\": \"李四\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
486
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 2,\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"15100000000\",\n \"Name\": \"李四\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
487
487
  "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"FailedOperation\",\n \"Message\": \"不能更换非企业签署人身份信息\"\n },\n \"RequestId\": \"s16939***23898\"\n }\n}",
488
488
  "title": "错误示例-解除协议中更换原合同个人类型的参与人"
489
489
  },
490
490
  {
491
491
  "document": "1. 更换原合同中本方企业的参与人\n2. 该企业参与人指定为自动签署(ApproverType 设置为 ENTERPRISESERVER)",
492
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"ApproverNumber\": 2,\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
492
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDR1AUUgygjazuesUuO4zjESPW4PkfNi\",\n \"ReleasedApprovers\": [\n {\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"ApproverNumber\": 2,\n \"ApproverType\": \"ENTERPRISESERVER\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方以作赔偿\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
493
493
  "output": "{\n \"Response\": {\n \"FlowId\": \"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\",\n \"RequestId\": \"s312334445587989\"\n }\n}",
494
494
  "title": "发起解除协议（替换原流程中本企业的参与人并指定其为自动签署）"
495
495
  },
496
496
  {
497
497
  "document": "1. 使用本企业的签署人\n2. 包含了详细的解除内容\n3. 替换原流程中本企业的签署人\n4. 被替换的原流程中的签署人ApproverNumber=1(即第二个签署人，在原流程签署人列表中的第二位)\n\n扩展信息：\n针对ApproverNumber举个例子，\n例如在原流程中共有三个签署人(a, b, c)，\n那么a是第一位(ApproverNumber=0)，b是第二位(ApproverNumber=1)，c是第三位(ApproverNumber=2)，\n注意这里的顺序不是签署顺序，仅仅是签署人列表中的自然顺序，签署人列表的获取可以参考DescribeFlowDetailInfo接口。",
498
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 1,\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\",\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\"\n }\n}",
498
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 1,\n \"Name\": \"典子谦\",\n \"Mobile\": \"13200000000\",\n \"ApproverType\": \"ORGANIZATION\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\",\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\"\n }\n}",
499
499
  "output": "{\n \"Response\": {\n \"FlowId\": \"yDwFdUUckps******xAhL7zuaIwkMth4\",\n \"RequestId\": \"s1669**2203341\"\n }\n}",
500
500
  "title": "发起解除协议(使用本企业的签署人，替换用原流程中本企业的签署人)"
501
501
  },
502
502
  {
503
503
  "document": "1. 更换原合同中本方企业的参与人\n2. 给该企业参与人指定自定义的角色名称(通过设置ApproverSignRole)\n3. 给该企业参与人指定签署控件类型为手写签名(通过设置ApproverSignComponentType)",
504
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 1,\n \"ApproverSignComponentType\": \"SIGN_SIGNATURE\",\n \"ApproverSignRole\": \"自定义的签署方角色(供应商)\",\n \"ApproverType\": \"ORGANIZATION\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"无\",\n \"OtherDeals\": \"无\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
504
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateReleaseFlow\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyOrganizationOpenId\": \"org_dianziqian\"\n },\n \"NeedRelievedFlowId\": \"yDwFmUUckpst10i3UubBSat8PWOt2iQF\",\n \"ReleasedApprovers\": [\n {\n \"ApproverNumber\": 1,\n \"ApproverSignComponentType\": \"SIGN_SIGNATURE\",\n \"ApproverSignRole\": \"自定义的签署方角色(供应商)\",\n \"ApproverType\": \"ORGANIZATION\",\n \"Mobile\": \"13200000000\",\n \"Name\": \"典子谦\",\n \"OrganizationName\": \"典子谦示例企业\"\n }\n ],\n \"ReliveInfo\": {\n \"OriginalExpenseSettlement\": \"甲方需付给乙方xxxx以作赔偿。\",\n \"OriginalOtherSettlement\": \"原合同中的补充条款依然生效\",\n \"OtherDeals\": \"解除后1天内部签署新的合同\",\n \"Reason\": \"因为业务调整, 结束合作。\",\n \"RemainInForceItem\": \"在业务结束前已产生的订单依旧有效。\"\n }\n}",
505
505
  "output": "{\n \"Response\": {\n \"FlowId\": \"yDwgkUU7y***********zWBfv\",\n \"RequestId\": \"s168809**839\"\n }\n}",
506
506
  "title": "发起解除协议(替换原流程中本企业的参与人并指定签署人角色、签署控件)"
507
507
  }
@@ -529,14 +529,14 @@
529
529
  },
530
530
  {
531
531
  "document": "授权时，缺少印章ID",
532
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"SealId\": \"\",\n \"UserIds\": [\n \"abc\"\n ],\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Organization\": {\n \"OrganizationId\": \"abc\",\n \"Channel\": \"abc\",\n \"OrganizationOpenId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n }\n}",
533
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"缺失印章ID\"\n },\n \"RequestId\": \"abc\"\n }\n}",
532
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"jsdk812kxkdfjks***k88123123\",\n \"ProxyOrganizationOpenId\": \"test_org_openid\",\n \"ProxyOperator\": {\n \"OpenId\": \"test_openid\",\n \"Channel\": \"CHANNEL\",\n \"CustomUserId\": \"zhangsan\",\n \"ClientIp\": \"1.2.3.4\",\n \"ProxyIp\": \"1.2.3.4\"\n },\n \"ProxyAppId\": \"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\n \"ProxyOrganizationId\": \"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"\n },\n \"SealId\": \"\",\n \"UserIds\": [\n \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n ],\n \"Operator\": {\n \"OpenId\": \"test_openid\",\n \"Channel\": \"CHANNEL\",\n \"CustomUserId\": \"zhangsan\",\n \"ClientIp\": \"8.8.8.8\",\n \"ProxyIp\": \"8.8.8.8\"\n },\n \"Organization\": {\n \"OrganizationId\": \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\",\n \"Channel\": \"CHANNEL\",\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"ClientIp\": \"1.2.3.4\",\n \"ProxyIp\": \"8.8.8.8\"\n }\n}",
533
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"缺失印章ID\"\n },\n \"RequestId\": \"s1111999868619888777\"\n }\n}",
534
534
  "title": "授权时，缺少印章ID"
535
535
  },
536
536
  {
537
537
  "document": "授权时，找不到对应的 UserId",
538
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"abc\",\n \"ProxyOrganizationOpenId\": \"abc\",\n \"ProxyOperator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"ProxyAppId\": \"abc\",\n \"ProxyOrganizationId\": \"abc\"\n },\n \"SealId\": \"abc\",\n \"UserIds\": [\n \"abc\",\n \"xxxid\"\n ],\n \"Operator\": {\n \"OpenId\": \"abc\",\n \"Channel\": \"abc\",\n \"CustomUserId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n },\n \"Organization\": {\n \"OrganizationId\": \"abc\",\n \"Channel\": \"abc\",\n \"OrganizationOpenId\": \"abc\",\n \"ClientIp\": \"abc\",\n \"ProxyIp\": \"abc\"\n }\n}",
539
- "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"无效的授权用户Id\"\n },\n \"RequestId\": \"abc\"\n }\n}",
538
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateSealPolicy\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"jsdk812kxkdfjks***k88123123\",\n \"ProxyOrganizationOpenId\": \"test_org_openid\",\n \"ProxyOperator\": {\n \"OpenId\": \"test_openid\",\n \"Channel\": \"CHANNEL\",\n \"CustomUserId\": \"zhangsan\",\n \"ClientIp\": \"1.2.3.4\",\n \"ProxyIp\": \"1.2.3.4\"\n },\n \"ProxyAppId\": \"yDRS4UUgygqdcj56UuO4zjExBQcOiB68\",\n \"ProxyOrganizationId\": \"yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP\"\n },\n \"SealId\": \"\",\n \"UserIds\": [\n \"yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy\"\n ],\n \"Operator\": {\n \"OpenId\": \"test_openid\",\n \"Channel\": \"CHANNEL\",\n \"CustomUserId\": \"zhangsan\",\n \"ClientIp\": \"8.8.8.8\",\n \"ProxyIp\": \"8.8.8.8\"\n },\n \"Organization\": {\n \"OrganizationId\": \"yDxbWUyKQDxgXVUuO4zjEB8mxCcDjAyF\",\n \"Channel\": \"CHANNEL\",\n \"OrganizationOpenId\": \"org_dianziqian\",\n \"ClientIp\": \"1.2.3.4\",\n \"ProxyIp\": \"8.8.8.8\"\n }\n}",
539
+ "output": "{\n \"Response\": {\n \"Error\": {\n \"Code\": \"InvalidParameter.ParamError\",\n \"Message\": \"无效的授权用户Id\"\n },\n \"RequestId\": \"s1111999868619888777\"\n }\n}",
540
540
  "title": "授权时，找不到对应的 UserId"
541
541
  }
542
542
  ],
@@ -1293,7 +1293,7 @@
1293
1293
  "PrepareFlows": [
1294
1294
  {
1295
1295
  "document": "创建待发起文件",
1296
- "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PrepareFlows\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"test\",\n \"ProxyOperator\": {\n \"OpenId\": \"test\"\n },\n \"AppId\": \"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"\n },\n \"JumpUrl\": \"http://www.test.com\",\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试签署流程一\",\n \"TemplateId\": \"test\",\n \"FlowDescription\": \"测试签署流程一的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"李四\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Name\": \"李四\",\n \"Mobile\": \"13888888888\",\n \"Deadline\": 1604910798\n }\n ]\n },\n {\n \"FlowName\": \"测试签署流程二\",\n \"TemplateId\": \"test\",\n \"FlowDescription\": \"测试签署流程二的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"张三\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Name\": \"鹅鹅子\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"Deadline\": 1663336465\n },\n {\n \"Name\": \"发起方\",\n \"ApproverType\": \"ORGANIZATION\",\n \"Mobile\": \"13700000000\",\n \"OpenId\": \"12345678\",\n \"Deadline\": 1663336465\n }\n ]\n }\n ]\n}",
1296
+ "input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: PrepareFlows\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"AppId\": \"yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw\"\n },\n \"JumpUrl\": \"http://www.test.com\",\n \"FlowInfos\": [\n {\n \"FlowName\": \"测试签署流程一\",\n \"TemplateId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"FlowDescription\": \"测试签署流程一的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"李四\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Name\": \"李四\",\n \"Mobile\": \"13888888888\",\n \"Deadline\": 1604910798\n }\n ]\n },\n {\n \"FlowName\": \"测试签署流程二\",\n \"TemplateId\": \"yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc\",\n \"FlowDescription\": \"测试签署流程二的描述信息\",\n \"FlowType\": \"合同\",\n \"Deadline\": 1604910797,\n \"FormFields\": [\n {\n \"ComponentName\": \"姓名\",\n \"ComponentValue\": \"张三\"\n }\n ],\n \"FlowApprovers\": [\n {\n \"Name\": \"鹅鹅子\",\n \"ApproverType\": \"PERSON\",\n \"Mobile\": \"13200000000\",\n \"Deadline\": 1663336465\n },\n {\n \"Name\": \"发起方\",\n \"ApproverType\": \"ORGANIZATION\",\n \"Mobile\": \"13700000000\",\n \"OpenId\": \"12345678\",\n \"Deadline\": 1663336465\n }\n ]\n }\n ]\n}",
1297
1297
  "output": "{\n \"Response\": {\n \"ConfirmUrl\": \"https://www.xx.com\",\n \"RequestId\": \"id\"\n }\n}",
1298
1298
  "title": "创建待发起文件"
1299
1299
  }
tccli/services/hunyuan/v20230901/api.json CHANGED
@@ -2501,6 +2501,28 @@
2501
2501
  "required": false,
2502
2502
  "type": "string",
2503
2503
  "value_allowed_null": true
2504
+ },
2505
+ {
2506
+ "disabled": false,
2507
+ "document": "搜索引文站点名",
2508
+ "example": "无",
2509
+ "member": "string",
2510
+ "name": "Text",
2511
+ "output_required": false,
2512
+ "required": false,
2513
+ "type": "string",
2514
+ "value_allowed_null": false
2515
+ },
2516
+ {
2517
+ "disabled": false,
2518
+ "document": "搜索引文图标",
2519
+ "example": "无",
2520
+ "member": "string",
2521
+ "name": "Icon",
2522
+ "output_required": false,
2523
+ "required": false,
2524
+ "type": "string",
2525
+ "value_allowed_null": false
2504
2526
  }
2505
2527
  ],
2506
2528
  "usage": "both"
tccli/services/lcic/v20220817/api.json CHANGED
@@ -1375,7 +1375,7 @@
1375
1375
  {
1376
1376
  "disabled": false,
1377
1377
  "document": "文档大小，单位 字节",
1378
- "example": "123",
1378
+ "example": "486",
1379
1379
  "member": "uint64",
1380
1380
  "name": "DocumentSize",
1381
1381
  "required": false,
tccli/services/monitor/v20180724/api.json CHANGED
@@ -890,7 +890,7 @@
890
890
  "status": "online"
891
891
  },
892
892
  "ModifyPrometheusRecordRuleYaml": {
893
- "document": "通过yaml的方式修改Prometheus聚合实例",
893
+ "document": "通过yaml的方式修改Prometheus预聚合规则",
894
894
  "input": "ModifyPrometheusRecordRuleYamlRequest",
895
895
  "name": "通过yaml的方式修改Prometheus聚合实例",
896
896
  "output": "ModifyPrometheusRecordRuleYamlResponse",
@@ -2558,9 +2558,10 @@
2558
2558
  {
2559
2559
  "disabled": false,
2560
2560
  "document": "用户名\n注意：此字段可能返回 null，表示取不到有效值。",
2561
- "example": "cherry",
2561
+ "example": "user-name",
2562
2562
  "member": "string",
2563
2563
  "name": "UserName",
2564
+ "output_required": true,
2564
2565
  "required": false,
2565
2566
  "type": "string",
2566
2567
  "value_allowed_null": true
@@ -2568,9 +2569,10 @@
2568
2569
  {
2569
2570
  "disabled": false,
2570
2571
  "document": "密码\n注意：此字段可能返回 null，表示取不到有效值。",
2571
- "example": "无",
2572
+ "example": "user-password",
2572
2573
  "member": "string",
2573
2574
  "name": "Password",
2575
+ "output_required": true,
2574
2576
  "required": false,
2575
2577
  "type": "string",
2576
2578
  "value_allowed_null": true
@@ -3934,7 +3936,7 @@
3934
3936
  {
3935
3937
  "disabled": false,
3936
3938
  "document": "返回创建成功的集成名称列表",
3937
- "example": "无",
3939
+ "example": "kafka-name",
3938
3940
  "member": "string",
3939
3941
  "name": "Names",
3940
3942
  "output_required": true,
@@ -4461,7 +4463,7 @@
4461
4463
  {
4462
4464
  "disabled": false,
4463
4465
  "document": "Agent 名称",
4464
- "example": "test",
4466
+ "example": "example",
4465
4467
  "member": "string",
4466
4468
  "name": "Name",
4467
4469
  "required": true,
@@ -4476,10 +4478,10 @@
4476
4478
  {
4477
4479
  "disabled": false,
4478
4480
  "document": "创建成功的 Agent Id",
4479
- "example": "无",
4481
+ "example": "agent-abcd",
4480
4482
  "member": "string",
4481
4483
  "name": "AgentId",
4482
- "required": true,
4484
+ "output_required": true,
4483
4485
  "type": "string",
4484
4486
  "value_allowed_null": false
4485
4487
  },
@@ -4880,7 +4882,7 @@
4880
4882
  {
4881
4883
  "disabled": false,
4882
4884
  "document": "实例id",
4883
- "example": "prom-xxx",
4885
+ "example": "prom-abcd",
4884
4886
  "member": "string",
4885
4887
  "name": "InstanceId",
4886
4888
  "required": true,
@@ -4889,7 +4891,7 @@
4889
4891
  {
4890
4892
  "disabled": false,
4891
4893
  "document": "yaml的内容",
4892
- "example": "xxx",
4894
+ "example": " - name: example rules: - record: code:prometheus_http_requests_total:sum expr: sum by (code) (prometheus_http_requests_total)",
4893
4895
  "member": "string",
4894
4896
  "name": "Content",
4895
4897
  "required": true,
@@ -4898,7 +4900,7 @@
4898
4900
  {
4899
4901
  "disabled": false,
4900
4902
  "document": "规则名称",
4901
- "example": "xxx",
4903
+ "example": "example",
4902
4904
  "member": "string",
4903
4905
  "name": "Name",
4904
4906
  "required": false,
@@ -4925,7 +4927,7 @@
4925
4927
  {
4926
4928
  "disabled": false,
4927
4929
  "document": "Prometheus 实例 ID",
4928
- "example": "prom-id",
4930
+ "example": "prom-abcd",
4929
4931
  "member": "string",
4930
4932
  "name": "InstanceId",
4931
4933
  "required": true,
@@ -4934,7 +4936,7 @@
4934
4936
  {
4935
4937
  "disabled": false,
4936
4938
  "document": "Agent ID(可通过DescribePrometheusAgents 接口获取)",
4937
- "example": "agent-id",
4939
+ "example": "agent-asfd",
4938
4940
  "member": "string",
4939
4941
  "name": "AgentId",
4940
4942
  "required": true,
@@ -4958,7 +4960,7 @@
4958
4960
  {
4959
4961
  "disabled": false,
4960
4962
  "document": "成功创建抓取任务 Id",
4961
- "example": "无",
4963
+ "example": "job-3er5",
4962
4964
  "member": "string",
4963
4965
  "name": "JobId",
4964
4966
  "output_required": true,
@@ -11481,7 +11483,7 @@
11481
11483
  {
11482
11484
  "disabled": false,
11483
11485
  "document": "实例 ID",
11484
- "example": "xx",
11486
+ "example": "prom-abcd",
11485
11487
  "member": "string",
11486
11488
  "name": "InstanceId",
11487
11489
  "required": true,
@@ -11490,7 +11492,7 @@
11490
11492
  {
11491
11493
  "disabled": false,
11492
11494
  "document": "Agent 名称",
11493
- "example": "无",
11495
+ "example": "example",
11494
11496
  "member": "string",
11495
11497
  "name": "Name",
11496
11498
  "required": false,
@@ -11499,7 +11501,7 @@
11499
11501
  {
11500
11502
  "disabled": false,
11501
11503
  "document": "Agent ID 列表",
11502
- "example": "无",
11504
+ "example": "agent-abcd",
11503
11505
  "member": "string",
11504
11506
  "name": "AgentIds",
11505
11507
  "required": false,
@@ -11508,7 +11510,7 @@
11508
11510
  {
11509
11511
  "disabled": false,
11510
11512
  "document": "偏移量，默认为0",
11511
- "example": "无",
11513
+ "example": "0",
11512
11514
  "member": "int64",
11513
11515
  "name": "Offset",
11514
11516
  "required": false,
@@ -11517,7 +11519,7 @@
11517
11519
  {
11518
11520
  "disabled": false,
11519
11521
  "document": "返回数量，默认为20，最大值为100",
11520
- "example": "无",
11522
+ "example": "10",
11521
11523
  "member": "int64",
11522
11524
  "name": "Limit",
11523
11525
  "required": false,
@@ -11938,7 +11940,7 @@
11938
11940
  {
11939
11941
  "disabled": false,
11940
11942
  "document": "实例级别抓取配置",
11941
- "example": "prom-xxx",
11943
+ "example": "prom-abcd",
11942
11944
  "member": "string",
11943
11945
  "name": "InstanceId",
11944
11946
  "required": true,
@@ -11962,7 +11964,7 @@
11962
11964
  {
11963
11965
  "disabled": false,
11964
11966
  "document": "配置内容",
11965
- "example": "xxxx",
11967
+ "example": "global: scrape_interval: 15s evaluation_interval: 15s scrape_configs: - job_name: \"prometheus\" static_configs: - targets: [\"localhost:9090\"] ",
11966
11968
  "member": "string",
11967
11969
  "name": "Config",
11968
11970
  "output_required": true,
@@ -12576,7 +12578,7 @@
12576
12578
  {
12577
12579
  "disabled": false,
12578
12580
  "document": "总数",
12579
- "example": "无",
12581
+ "example": "1",
12580
12582
  "member": "uint64",
12581
12583
  "name": "Total",
12582
12584
  "output_required": true,
@@ -12911,7 +12913,7 @@
12911
12913
  {
12912
12914
  "disabled": false,
12913
12915
  "document": "地域 ID（RegionId 和 RegionName 只需要填一个）",
12914
- "example": "1234",
12916
+ "example": "1",
12915
12917
  "member": "int64",
12916
12918
  "name": "RegionId",
12917
12919
  "required": false,
@@ -12975,7 +12977,7 @@
12975
12977
  {
12976
12978
  "disabled": false,
12977
12979
  "document": "偏移量，默认为 0",
12978
- "example": "无",
12980
+ "example": "0",
12979
12981
  "member": "int64",
12980
12982
  "name": "Offset",
12981
12983
  "required": false,
@@ -12984,7 +12986,7 @@
12984
12986
  {
12985
12987
  "disabled": false,
12986
12988
  "document": "规则 ID",
12987
- "example": "无",
12989
+ "example": "rrule-abc",
12988
12990
  "member": "string",
12989
12991
  "name": "RuleId",
12990
12992
  "required": false,
@@ -13002,7 +13004,7 @@
13002
13004
  {
13003
13005
  "disabled": false,
13004
13006
  "document": "规则名称",
13005
- "example": "无",
13007
+ "example": "example",
13006
13008
  "member": "string",
13007
13009
  "name": "Name",
13008
13010
  "required": false,
@@ -13700,8 +13702,7 @@
13700
13702
  "member": "string",
13701
13703
  "name": "Type",
13702
13704
  "required": false,
13703
- "type": "string",
13704
- "value_allowed_null": false
13705
+ "type": "string"
13705
13706
  },
13706
13707
  {
13707
13708
  "disabled": false,
@@ -13710,8 +13711,7 @@
13710
13711
  "member": "string",
13711
13712
  "name": "Key",
13712
13713
  "required": false,
13713
- "type": "string",
13714
- "value_allowed_null": false
13714
+ "type": "string"
13715
13715
  },
13716
13716
  {
13717
13717
  "disabled": false,
@@ -13720,18 +13720,16 @@
13720
13720
  "member": "string",
13721
13721
  "name": "Value",
13722
13722
  "required": false,
13723
- "type": "string",
13724
- "value_allowed_null": false
13723
+ "type": "string"
13725
13724
  },
13726
13725
  {
13727
13726
  "disabled": false,
13728
13727
  "document": "过滤条件名称",
13729
- "example": "abc",
13728
+ "example": "filter-name",
13730
13729
  "member": "string",
13731
13730
  "name": "Name",
13732
13731
  "required": false,
13733
- "type": "string",
13734
- "value_allowed_null": true
13732
+ "type": "string"
13735
13733
  },
13736
13734
  {
13737
13735
  "disabled": false,
@@ -13740,8 +13738,7 @@
13740
13738
  "member": "string",
13741
13739
  "name": "Values",
13742
13740
  "required": false,
13743
- "type": "list",
13744
- "value_allowed_null": true
13741
+ "type": "list"
13745
13742
  }
13746
13743
  ],
13747
13744
  "usage": "in"
@@ -16226,7 +16223,7 @@
16226
16223
  {
16227
16224
  "disabled": false,
16228
16225
  "document": "实例id",
16229
- "example": "prom-xxx",
16226
+ "example": "prom-abcd",
16230
16227
  "member": "string",
16231
16228
  "name": "InstanceId",
16232
16229
  "required": true,
@@ -16235,7 +16232,7 @@
16235
16232
  {
16236
16233
  "disabled": false,
16237
16234
  "document": "聚合实例名称",
16238
- "example": "xxx",
16235
+ "example": "example",
16239
16236
  "member": "string",
16240
16237
  "name": "Name",
16241
16238
  "required": true,
@@ -16244,7 +16241,7 @@
16244
16241
  {
16245
16242
  "disabled": false,
16246
16243
  "document": "新的内容",
16247
- "example": "xxx",
16244
+ "example": " - name: example rules: - record: code:prometheus_http_requests_total:sum expr: sum by (code) (prometheus_http_requests_total)",
16248
16245
  "member": "string",
16249
16246
  "name": "Content",
16250
16247
  "required": true,
@@ -16307,7 +16304,7 @@
16307
16304
  {
16308
16305
  "disabled": false,
16309
16306
  "document": "实例ID",
16310
- "example": "无",
16307
+ "example": "prom-abcd",
16311
16308
  "member": "string",
16312
16309
  "name": "InstanceId",
16313
16310
  "required": true,
@@ -18383,7 +18380,7 @@
18383
18380
  {
18384
18381
  "disabled": false,
18385
18382
  "document": "该Job的targets列表",
18386
- "example": "xxx",
18383
+ "example": "[{\"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\"}]",
18387
18384
  "member": "PrometheusTarget",
18388
18385
  "name": "Targets",
18389
18386
  "output_required": true,
@@ -18393,7 +18390,7 @@
18393
18390
  {
18394
18391
  "disabled": false,
18395
18392
  "document": "job的名称",
18396
- "example": "xxx",
18393
+ "example": "prom-job",
18397
18394
  "member": "string",
18398
18395
  "name": "JobName",
18399
18396
  "output_required": true,
@@ -18403,7 +18400,7 @@
18403
18400
  {
18404
18401
  "disabled": false,
18405
18402
  "document": "targets总数",
18406
- "example": "xxx",
18403
+ "example": "1",
18407
18404
  "member": "uint64",
18408
18405
  "name": "Total",
18409
18406
  "output_required": true,
@@ -18413,7 +18410,7 @@
18413
18410
  {
18414
18411
  "disabled": false,
18415
18412
  "document": "健康的target总数",
18416
- "example": "xxx",
18413
+ "example": "1",
18417
18414
  "member": "uint64",
18418
18415
  "name": "Up",
18419
18416
  "output_required": true,
@@ -18594,7 +18591,7 @@
18594
18591
  },
18595
18592
  {
18596
18593
  "disabled": false,
18597
- "document": "Yaml内容",
18594
+ "document": "如果该聚合规则来至模板，则TemplateId为模板id",
18598
18595
  "example": "temp-abc",
18599
18596
  "member": "string",
18600
18597
  "name": "TemplateId",
@@ -18604,8 +18601,8 @@
18604
18601
  },
18605
18602
  {
18606
18603
  "disabled": false,
18607
- "document": "如果该聚合规则来至模板，则TemplateId为模板id\n注意：此字段可能返回 null，表示取不到有效值。",
18608
- "example": "abc",
18604
+ "document": "Yaml内容\n注意：此字段可能返回 null，表示取不到有效值。",
18605
+ "example": "metadata:\\n name: tttttttt\\nspec:\\n groups:\\n - name: kube-apiserver.rules4\\n rules:\\n - expr: sum(metrics_test)\\n labels:\\n verb: read\\n record: apiserver_request:burnrate1d4",
18609
18606
  "member": "string",
18610
18607
  "name": "Content",
18611
18608
  "output_required": true,
@@ -18615,7 +18612,7 @@
18615
18612
  {
18616
18613
  "disabled": false,
18617
18614
  "document": "该聚合规则如果来源于用户集群crd资源定义，则ClusterId为所属集群ID\n注意：此字段可能返回 null，表示取不到有效值。",
18618
- "example": "cls-abc",
18615
+ "example": "cls-jsghgr",
18619
18616
  "member": "string",
18620
18617
  "name": "ClusterId",
18621
18618
  "output_required": true,
@@ -18635,7 +18632,7 @@
18635
18632
  {
18636
18633
  "disabled": false,
18637
18634
  "document": "id\n注意：此字段可能返回 null，表示取不到有效值。",
18638
- "example": "abc",
18635
+ "example": "rrule-djkrhbf",
18639
18636
  "member": "string",
18640
18637
  "name": "Id",
18641
18638
  "output_required": true,
@@ -18957,7 +18954,28 @@
18957
18954
  },
18958
18955
  "PrometheusTarget": {
18959
18956
  "document": "prometheus一个抓取目标的信息",
18960
- "members": [],
18957
+ "members": [
18958
+ {
18959
+ "disabled": false,
18960
+ "document": "抓取目标的URL",
18961
+ "example": "https://kubernetes.default.svc:443/api/v1/nodes/1.1.0.1/proxy/metrics",
18962
+ "member": "string",
18963
+ "name": "Url",
18964
+ "output_required": true,
18965
+ "type": "string",
18966
+ "value_allowed_null": false
18967
+ },
18968
+ {
18969
+ "disabled": false,
18970
+ "document": "target当前状态,当前支持\nup = 健康\ndown = 不健康\nunknown = 未知",
18971
+ "example": "up",
18972
+ "member": "string",
18973
+ "name": "State",
18974
+ "output_required": true,
18975
+ "type": "string",
18976
+ "value_allowed_null": false
18977
+ }
18978
+ ],
18961
18979
  "usage": "out"
18962
18980
  },
18963
18981
  "PrometheusTemp": {