tccli 3.0.1152.1__py2.py3-none-any.whl → 3.0.1153.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +3 -0
- tccli/services/cloudapp/__init__.py +4 -0
- tccli/services/cloudapp/cloudapp_client.py +195 -0
- tccli/services/cloudapp/v20220530/api.json +259 -0
- tccli/services/cloudapp/v20220530/examples.json +13 -0
- tccli/services/dsgc/v20190723/api.json +66 -3
- tccli/services/ess/v20201111/api.json +1 -1
- tccli/services/essbasic/v20210526/api.json +23 -5
- tccli/services/essbasic/v20210526/examples.json +8 -2
- tccli/services/lighthouse/v20200324/api.json +4 -4
- tccli/services/mongodb/v20190725/api.json +2 -2
- tccli/services/monitor/v20180724/api.json +36 -36
- tccli/services/monitor/v20180724/examples.json +25 -25
- tccli/services/tcr/v20190924/api.json +1 -1
- tccli/services/tcr/v20190924/examples.json +1 -1
- tccli/services/vpc/v20170312/api.json +1 -1
- tccli/services/waf/v20180125/examples.json +1 -1
- {tccli-3.0.1152.1.dist-info → tccli-3.0.1153.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1152.1.dist-info → tccli-3.0.1153.1.dist-info}/RECORD +23 -19
- {tccli-3.0.1152.1.dist-info → tccli-3.0.1153.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1152.1.dist-info → tccli-3.0.1153.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1152.1.dist-info → tccli-3.0.1153.1.dist-info}/license_files/LICENSE +0 -0
@@ -43,7 +43,7 @@
|
|
43
43
|
"status": "online"
|
44
44
|
},
|
45
45
|
"ChannelCreateBatchSignUrl": {
|
46
|
-
"document": "通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。\n请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。\n\n注:\n- 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。\n- 参与人点击链接后需短信验证码才能查看合同内容。\n-
|
46
|
+
"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>(不管合同里边设置的签名限制)来进行。",
|
47
47
|
"input": "ChannelCreateBatchSignUrlRequest",
|
48
48
|
"name": "获取跳转至腾讯电子签小程序的批量签署链接",
|
49
49
|
"output": "ChannelCreateBatchSignUrlResponse",
|
@@ -1686,7 +1686,7 @@
|
|
1686
1686
|
},
|
1687
1687
|
{
|
1688
1688
|
"disabled": false,
|
1689
|
-
"document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n
|
1689
|
+
"document": "签署方经办人的姓名。\n经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。\n\n注:`请确保和合同中填入的一致`,`除动态签署人或子客员工经办人场景外,此参数必填`",
|
1690
1690
|
"example": "无",
|
1691
1691
|
"member": "string",
|
1692
1692
|
"name": "Name",
|
@@ -1695,7 +1695,7 @@
|
|
1695
1695
|
},
|
1696
1696
|
{
|
1697
1697
|
"disabled": false,
|
1698
|
-
"document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致,
|
1698
|
+
"document": "手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。\n请确认手机号所有方为此业务通知方。\n\n注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人或子客员工经办人场景外,此参数必填`",
|
1699
1699
|
"example": "无",
|
1700
1700
|
"member": "string",
|
1701
1701
|
"name": "Mobile",
|
@@ -1749,7 +1749,7 @@
|
|
1749
1749
|
},
|
1750
1750
|
{
|
1751
1751
|
"disabled": false,
|
1752
|
-
"document": "
|
1752
|
+
"document": "SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份,此参数必填。\n\n注:\n<ul>\n<li>请确认该名称与企业营业执照中注册的名称一致。</li>\n<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>\n<li>请确保此企业已完成腾讯电子签企业认证。</li>\n<li>**若为子客企业员工,请使用OpenId,OrganizationOpenId参数,此参数留空即可**</li>\n</ul>",
|
1753
1753
|
"example": "无",
|
1754
1754
|
"member": "string",
|
1755
1755
|
"name": "OrganizationName",
|
@@ -1773,6 +1773,24 @@
|
|
1773
1773
|
"name": "FlowBatchUrlInfo",
|
1774
1774
|
"required": false,
|
1775
1775
|
"type": "object"
|
1776
|
+
},
|
1777
|
+
{
|
1778
|
+
"disabled": false,
|
1779
|
+
"document": "第三方平台子客企业员工的标识OpenId,批签合同经办人为子客员工的情况下为必填。\n\n注:\n<ul>\n<li>传入的OpenId对应员工在此子客企业下必须已经实名</li>\n<li>传递了此参数可以无需传递Name,Mobile,IdCardNumber,IdCardType参数。系统会根据员工OpenId自动拉取实名信息。</li>\n</ul>",
|
1780
|
+
"example": "无",
|
1781
|
+
"member": "string",
|
1782
|
+
"name": "OpenId",
|
1783
|
+
"required": false,
|
1784
|
+
"type": "string"
|
1785
|
+
},
|
1786
|
+
{
|
1787
|
+
"disabled": false,
|
1788
|
+
"document": "第三方平台子客企业的企业的标识, 即OrganizationOpenId,批签合同经办人为子客企业员工是为必填。",
|
1789
|
+
"example": "无",
|
1790
|
+
"member": "string",
|
1791
|
+
"name": "OrganizationOpenId",
|
1792
|
+
"required": false,
|
1793
|
+
"type": "string"
|
1776
1794
|
}
|
1777
1795
|
],
|
1778
1796
|
"type": "object"
|
@@ -6803,7 +6821,7 @@
|
|
6803
6821
|
},
|
6804
6822
|
{
|
6805
6823
|
"disabled": false,
|
6806
|
-
"document": "电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li></ul>注:
|
6824
|
+
"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>公章, 重复创建会报错",
|
6807
6825
|
"example": "OFFICIAL",
|
6808
6826
|
"member": "string",
|
6809
6827
|
"name": "SealType",
|
@@ -122,10 +122,10 @@
|
|
122
122
|
"title": "生成个人小程序批量签署链接"
|
123
123
|
},
|
124
124
|
{
|
125
|
-
"document": "
|
125
|
+
"document": "按照合同发起时候填入的信息生成saas企业经办人批量签署链接,并通过FlowIds参数对用户可以批签的合同进行限制",
|
126
126
|
"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}",
|
127
127
|
"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}",
|
128
|
-
"title": "
|
128
|
+
"title": "生成saas企业经办人小程序批量签署链接"
|
129
129
|
},
|
130
130
|
{
|
131
131
|
"document": "合同(yDR1AUUgygja******uO4zjEB8zAkJEFN)中的参与方为:【姓名:张三 ,手机号:18888888888】,发起的时候并未填入证件号且18888888888手机号并未在腾讯电子签注册实名。 \n\n此时,如果使用 【姓名:张三,手机号:17777777777】生成批量签署链接,且FlowIds参数传入(yDR1AUUgygja******uO4zjEB8zAkJEFN)时,会报错,提示签署方信息不存在。\n\n因为手机号不同,无法定位到签署方。 此时,除了将手机号修改成 18888888888 之外来解决问题,也可以在发起合同和生成链接的时候传入证件信息,保证姓名和证件一致的情况下,手机号可以不相同。",
|
@@ -138,6 +138,12 @@
|
|
138
138
|
"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}",
|
139
139
|
"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}",
|
140
140
|
"title": "生成动态签署人批量领取链接"
|
141
|
+
},
|
142
|
+
{
|
143
|
+
"document": "按照合同发起时候填入的信息生成子客企业经办人批量签署链接,并通过FlowIds参数对用户可以批签的合同进行限制",
|
144
|
+
"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}",
|
145
|
+
"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}",
|
146
|
+
"title": "生成子客经办人小程序批量签署链接"
|
141
147
|
}
|
142
148
|
],
|
143
149
|
"ChannelCreateBoundFlows": [
|
@@ -4837,7 +4837,7 @@
|
|
4837
4837
|
"members": [
|
4838
4838
|
{
|
4839
4839
|
"disabled": false,
|
4840
|
-
"document": "可用区列表排序的依据字段。取值范围:\n<li>ZONE
|
4840
|
+
"document": "可用区列表排序的依据字段。取值范围:\n<li>ZONE:依据可用区排序。</li>\n<li>INSTANCE_DISPLAY_LABEL:依据可用区展示标签排序,可用区展示标签包括:HIDDEN(隐藏)、NORMAL(普通)、SELECTED(默认选中),默认采用的升序排列为:['HIDDEN', 'NORMAL', 'SELECTED']。\n默认按可用区排序。</li>",
|
4841
4841
|
"example": "\"ZONE\"",
|
4842
4842
|
"member": "string",
|
4843
4843
|
"name": "OrderField",
|
@@ -4846,7 +4846,7 @@
|
|
4846
4846
|
},
|
4847
4847
|
{
|
4848
4848
|
"disabled": false,
|
4849
|
-
"document": "输出可用区列表的排列顺序。取值范围:\n<li>ASC:升序排列。
|
4849
|
+
"document": "输出可用区列表的排列顺序。取值范围:\n<li>ASC:升序排列。 </li>\n<li>DESC:降序排列。</li>\n默认按升序排列。",
|
4850
4850
|
"example": "\"DESC\"",
|
4851
4851
|
"member": "string",
|
4852
4852
|
"name": "Order",
|
@@ -4865,7 +4865,7 @@
|
|
4865
4865
|
"example": "1",
|
4866
4866
|
"member": "int64",
|
4867
4867
|
"name": "TotalCount",
|
4868
|
-
"
|
4868
|
+
"output_required": true,
|
4869
4869
|
"type": "int",
|
4870
4870
|
"value_allowed_null": false
|
4871
4871
|
},
|
@@ -4875,7 +4875,7 @@
|
|
4875
4875
|
"example": "无",
|
4876
4876
|
"member": "ZoneInfo",
|
4877
4877
|
"name": "ZoneInfoSet",
|
4878
|
-
"
|
4878
|
+
"output_required": true,
|
4879
4879
|
"type": "list",
|
4880
4880
|
"value_allowed_null": false
|
4881
4881
|
},
|
@@ -921,7 +921,7 @@
|
|
921
921
|
},
|
922
922
|
{
|
923
923
|
"disabled": false,
|
924
|
-
"document": "-
|
924
|
+
"document": "- 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
|
925
925
|
"example": "2",
|
926
926
|
"member": "uint64",
|
927
927
|
"name": "NodeNum",
|
@@ -1166,7 +1166,7 @@
|
|
1166
1166
|
"members": [
|
1167
1167
|
{
|
1168
1168
|
"disabled": false,
|
1169
|
-
"document": "-
|
1169
|
+
"document": "- 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
|
1170
1170
|
"example": "3",
|
1171
1171
|
"member": "uint64",
|
1172
1172
|
"name": "NodeNum",
|
@@ -869,7 +869,7 @@
|
|
869
869
|
"status": "online"
|
870
870
|
},
|
871
871
|
"ModifyPrometheusConfig": {
|
872
|
-
"document": "修改prometheus
|
872
|
+
"document": "修改prometheus采集配置",
|
873
873
|
"input": "ModifyPrometheusConfigRequest",
|
874
874
|
"name": "修改prometheus配置",
|
875
875
|
"output": "ModifyPrometheusConfigResponse",
|
@@ -4372,7 +4372,7 @@
|
|
4372
4372
|
{
|
4373
4373
|
"disabled": false,
|
4374
4374
|
"document": "实例ID",
|
4375
|
-
"example": "prom-
|
4375
|
+
"example": "prom-oejhr",
|
4376
4376
|
"member": "string",
|
4377
4377
|
"name": "InstanceId",
|
4378
4378
|
"required": true,
|
@@ -4917,7 +4917,7 @@
|
|
4917
4917
|
},
|
4918
4918
|
{
|
4919
4919
|
"disabled": false,
|
4920
|
-
"document": "服务发现配置信息,YAML
|
4920
|
+
"document": "服务发现配置信息,YAML 格式,[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)",
|
4921
4921
|
"example": "yaml",
|
4922
4922
|
"member": "string",
|
4923
4923
|
"name": "Yaml",
|
@@ -5426,7 +5426,7 @@
|
|
5426
5426
|
{
|
5427
5427
|
"disabled": false,
|
5428
5428
|
"document": "agent列表",
|
5429
|
-
"example": "
|
5429
|
+
"example": "{\"ClusterType\":\"cls-kehr\",\"ClusterId\":\"tke\",\"Describe\":\"test-des\"}",
|
5430
5430
|
"member": "PrometheusAgentInfo",
|
5431
5431
|
"name": "Agents",
|
5432
5432
|
"required": true,
|
@@ -5435,7 +5435,7 @@
|
|
5435
5435
|
{
|
5436
5436
|
"disabled": false,
|
5437
5437
|
"document": "实例id",
|
5438
|
-
"example": "
|
5438
|
+
"example": "prom-kehf",
|
5439
5439
|
"member": "string",
|
5440
5440
|
"name": "InstanceId",
|
5441
5441
|
"required": true,
|
@@ -5489,7 +5489,7 @@
|
|
5489
5489
|
{
|
5490
5490
|
"disabled": false,
|
5491
5491
|
"document": "要删除的ServiceMonitor名字列表",
|
5492
|
-
"example": "
|
5492
|
+
"example": "[\"test-sm\"]",
|
5493
5493
|
"member": "string",
|
5494
5494
|
"name": "ServiceMonitors",
|
5495
5495
|
"required": false,
|
@@ -5498,7 +5498,7 @@
|
|
5498
5498
|
{
|
5499
5499
|
"disabled": false,
|
5500
5500
|
"document": "要删除的PodMonitor名字列表",
|
5501
|
-
"example": "
|
5501
|
+
"example": "[\"test-pm\"]",
|
5502
5502
|
"member": "string",
|
5503
5503
|
"name": "PodMonitors",
|
5504
5504
|
"required": false,
|
@@ -5507,7 +5507,7 @@
|
|
5507
5507
|
{
|
5508
5508
|
"disabled": false,
|
5509
5509
|
"document": "要删除的RawJobs名字列表",
|
5510
|
-
"example": "
|
5510
|
+
"example": "[\"test-rj\"]",
|
5511
5511
|
"member": "string",
|
5512
5512
|
"name": "RawJobs",
|
5513
5513
|
"required": false,
|
@@ -5534,7 +5534,7 @@
|
|
5534
5534
|
{
|
5535
5535
|
"disabled": false,
|
5536
5536
|
"document": "实例id",
|
5537
|
-
"example": "
|
5537
|
+
"example": "prom-wjheg",
|
5538
5538
|
"member": "string",
|
5539
5539
|
"name": "InstanceId",
|
5540
5540
|
"required": true,
|
@@ -5543,7 +5543,7 @@
|
|
5543
5543
|
{
|
5544
5544
|
"disabled": false,
|
5545
5545
|
"document": "聚合规则列表",
|
5546
|
-
"example": "
|
5546
|
+
"example": "[\"test-rule\"]",
|
5547
5547
|
"member": "string",
|
5548
5548
|
"name": "Names",
|
5549
5549
|
"required": true,
|
@@ -5785,7 +5785,7 @@
|
|
5785
5785
|
},
|
5786
5786
|
{
|
5787
5787
|
"disabled": false,
|
5788
|
-
"document": "服务发现配置信息,YAML
|
5788
|
+
"document": "服务发现配置信息,YAML 格式,[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)",
|
5789
5789
|
"example": "yaml",
|
5790
5790
|
"member": "string",
|
5791
5791
|
"name": "Yaml",
|
@@ -11163,7 +11163,7 @@
|
|
11163
11163
|
{
|
11164
11164
|
"disabled": false,
|
11165
11165
|
"document": "集群id\n可以是tke, eks, edge的集群id",
|
11166
|
-
"example": "cls-
|
11166
|
+
"example": "cls-dkrb",
|
11167
11167
|
"member": "string",
|
11168
11168
|
"name": "ClusterId",
|
11169
11169
|
"required": true,
|
@@ -11178,7 +11178,7 @@
|
|
11178
11178
|
{
|
11179
11179
|
"disabled": false,
|
11180
11180
|
"document": "关联该集群的实例列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
11181
|
-
"example": "prom-
|
11181
|
+
"example": "[\"prom-oebnrfg\"]",
|
11182
11182
|
"member": "string",
|
11183
11183
|
"name": "Instances",
|
11184
11184
|
"output_required": true,
|
@@ -11448,7 +11448,7 @@
|
|
11448
11448
|
},
|
11449
11449
|
{
|
11450
11450
|
"disabled": false,
|
11451
|
-
"document": "
|
11451
|
+
"document": "偏移量,默认为0。",
|
11452
11452
|
"example": "1",
|
11453
11453
|
"member": "uint64",
|
11454
11454
|
"name": "Offset",
|
@@ -11457,7 +11457,7 @@
|
|
11457
11457
|
},
|
11458
11458
|
{
|
11459
11459
|
"disabled": false,
|
11460
|
-
"document": "
|
11460
|
+
"document": "返回数量,默认为20,最大值为100。",
|
11461
11461
|
"example": "1",
|
11462
11462
|
"member": "uint64",
|
11463
11463
|
"name": "Limit",
|
@@ -11937,7 +11937,7 @@
|
|
11937
11937
|
{
|
11938
11938
|
"disabled": false,
|
11939
11939
|
"document": "实例ID",
|
11940
|
-
"example": "prom-
|
11940
|
+
"example": "prom-asdfghjk",
|
11941
11941
|
"member": "string",
|
11942
11942
|
"name": "InstanceId",
|
11943
11943
|
"required": true,
|
@@ -11962,7 +11962,7 @@
|
|
11962
11962
|
{
|
11963
11963
|
"disabled": false,
|
11964
11964
|
"document": "初始化任务步骤\n注意:此字段可能返回 null,表示取不到有效值。",
|
11965
|
-
"example": "
|
11965
|
+
"example": "无",
|
11966
11966
|
"member": "TaskStepInfo",
|
11967
11967
|
"name": "Steps",
|
11968
11968
|
"output_required": true,
|
@@ -11972,7 +11972,7 @@
|
|
11972
11972
|
{
|
11973
11973
|
"disabled": false,
|
11974
11974
|
"document": "实例eks集群ID\n注意:此字段可能返回 null,表示取不到有效值。",
|
11975
|
-
"example": "cls-
|
11975
|
+
"example": "cls-asdf1234",
|
11976
11976
|
"member": "string",
|
11977
11977
|
"name": "EksClusterId",
|
11978
11978
|
"output_required": true,
|
@@ -11982,7 +11982,7 @@
|
|
11982
11982
|
{
|
11983
11983
|
"disabled": false,
|
11984
11984
|
"document": "eks集群内pod的安全组\n注意:此字段可能返回 null,表示取不到有效值。",
|
11985
|
-
"example": "sg-
|
11985
|
+
"example": "sg-asdf1234",
|
11986
11986
|
"member": "string",
|
11987
11987
|
"name": "SecurityGroupId",
|
11988
11988
|
"output_required": false,
|
@@ -12058,7 +12058,7 @@
|
|
12058
12058
|
"members": [
|
12059
12059
|
{
|
12060
12060
|
"disabled": false,
|
12061
|
-
"document": "
|
12061
|
+
"document": "分页偏移量,默认为0",
|
12062
12062
|
"example": "1",
|
12063
12063
|
"member": "uint64",
|
12064
12064
|
"name": "Offset",
|
@@ -12067,7 +12067,7 @@
|
|
12067
12067
|
},
|
12068
12068
|
{
|
12069
12069
|
"disabled": false,
|
12070
|
-
"document": "
|
12070
|
+
"document": "返回数量,默认为20,最大值为100",
|
12071
12071
|
"example": "20",
|
12072
12072
|
"member": "uint64",
|
12073
12073
|
"name": "Limit",
|
@@ -12077,7 +12077,7 @@
|
|
12077
12077
|
{
|
12078
12078
|
"disabled": false,
|
12079
12079
|
"document": "过滤实例,目前支持:\nID: 通过实例ID来过滤 \nName: 通过实例名称来过滤",
|
12080
|
-
"example": "
|
12080
|
+
"example": "[{\"Name\": \"Name\",\"Values\": [\"test\"]}]",
|
12081
12081
|
"member": "Filter",
|
12082
12082
|
"name": "Filters",
|
12083
12083
|
"required": false,
|
@@ -12535,7 +12535,7 @@
|
|
12535
12535
|
},
|
12536
12536
|
{
|
12537
12537
|
"disabled": false,
|
12538
|
-
"document": "targets
|
12538
|
+
"document": "targets分页偏移量,默认为0",
|
12539
12539
|
"example": "0",
|
12540
12540
|
"member": "uint64",
|
12541
12541
|
"name": "Offset",
|
@@ -12560,7 +12560,7 @@
|
|
12560
12560
|
{
|
12561
12561
|
"disabled": false,
|
12562
12562
|
"document": "所有Job的targets信息",
|
12563
|
-
"example": "{
|
12563
|
+
"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\"}",
|
12564
12564
|
"member": "PrometheusJobTargets",
|
12565
12565
|
"name": "Jobs",
|
12566
12566
|
"output_required": true,
|
@@ -12590,7 +12590,7 @@
|
|
12590
12590
|
},
|
12591
12591
|
{
|
12592
12592
|
"disabled": false,
|
12593
|
-
"document": "
|
12593
|
+
"document": "分页偏移量,默认为0",
|
12594
12594
|
"example": "0",
|
12595
12595
|
"member": "uint64",
|
12596
12596
|
"name": "Offset",
|
@@ -14389,7 +14389,7 @@
|
|
14389
14389
|
{
|
14390
14390
|
"disabled": false,
|
14391
14391
|
"document": "map表中的Name",
|
14392
|
-
"example": "
|
14392
|
+
"example": "label-name",
|
14393
14393
|
"member": "string",
|
14394
14394
|
"name": "Name",
|
14395
14395
|
"output_required": true,
|
@@ -14400,7 +14400,7 @@
|
|
14400
14400
|
{
|
14401
14401
|
"disabled": false,
|
14402
14402
|
"document": "map表中的Value",
|
14403
|
-
"example": "
|
14403
|
+
"example": "label-value",
|
14404
14404
|
"member": "string",
|
14405
14405
|
"name": "Value",
|
14406
14406
|
"output_required": true,
|
@@ -15719,7 +15719,7 @@
|
|
15719
15719
|
{
|
15720
15720
|
"disabled": false,
|
15721
15721
|
"document": "新的external_labels",
|
15722
|
-
"example": "Name
|
15722
|
+
"example": "{\"Name\":\"label-name\",\"Value\":\"label-value\"}",
|
15723
15723
|
"member": "Label",
|
15724
15724
|
"name": "ExternalLabels",
|
15725
15725
|
"required": true,
|
@@ -15836,7 +15836,7 @@
|
|
15836
15836
|
{
|
15837
15837
|
"disabled": false,
|
15838
15838
|
"document": "0: 更新实例组件镜像版本;\n1: 不更新实例组件镜像版本",
|
15839
|
-
"example": "0
|
15839
|
+
"example": "0",
|
15840
15840
|
"member": "int64",
|
15841
15841
|
"name": "UpdateImage",
|
15842
15842
|
"required": false,
|
@@ -19257,7 +19257,7 @@
|
|
19257
19257
|
{
|
19258
19258
|
"disabled": false,
|
19259
19259
|
"document": "实例ID",
|
19260
|
-
"example": "prom-
|
19260
|
+
"example": "prom-asdfghjk",
|
19261
19261
|
"member": "string",
|
19262
19262
|
"name": "InstanceId",
|
19263
19263
|
"required": true,
|
@@ -19266,7 +19266,7 @@
|
|
19266
19266
|
{
|
19267
19267
|
"disabled": false,
|
19268
19268
|
"document": "子网ID,默认使用实例所用子网初始化,也可通过该参数传递新的子网ID初始化",
|
19269
|
-
"example": "
|
19269
|
+
"example": "subnet-asdfghjk",
|
19270
19270
|
"member": "string",
|
19271
19271
|
"name": "SubnetId",
|
19272
19272
|
"required": false,
|
@@ -20637,8 +20637,8 @@
|
|
20637
20637
|
"members": [
|
20638
20638
|
{
|
20639
20639
|
"disabled": false,
|
20640
|
-
"document": "Prometheus 实例 ID
|
20641
|
-
"example": "
|
20640
|
+
"document": "Prometheus 实例 ID",
|
20641
|
+
"example": "prom-abcd1234",
|
20642
20642
|
"member": "string",
|
20643
20643
|
"name": "InstanceId",
|
20644
20644
|
"required": true,
|
@@ -20646,8 +20646,8 @@
|
|
20646
20646
|
},
|
20647
20647
|
{
|
20648
20648
|
"disabled": false,
|
20649
|
-
"document": "Agent ID 列表,例如:agent-abcd1234,可在控制台 Agent
|
20650
|
-
"example": "[\"
|
20649
|
+
"document": "Agent ID 列表,例如:agent-abcd1234,可在控制台 Agent 管理中获取",
|
20650
|
+
"example": "[\"agent-abcd1234\"]",
|
20651
20651
|
"member": "string",
|
20652
20652
|
"name": "AgentIds",
|
20653
20653
|
"required": true,
|
@@ -21044,7 +21044,7 @@
|
|
21044
21044
|
},
|
21045
21045
|
{
|
21046
21046
|
"disabled": false,
|
21047
|
-
"document": "服务发现配置信息,YAML
|
21047
|
+
"document": "服务发现配置信息,YAML 格式,[具体YAML参数内容请参考](https://cloud.tencent.com/document/product/1416/55995#service-monitor)",
|
21048
21048
|
"example": "yaml",
|
21049
21049
|
"member": "string",
|
21050
21050
|
"name": "Yaml",
|