tccli 3.0.1232.1__py2.py3-none-any.whl → 3.0.1234.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/clb/v20180317/api.json +1 -1
- tccli/services/ess/v20201111/api.json +1 -1
- tccli/services/essbasic/v20210526/api.json +29 -11
- tccli/services/essbasic/v20210526/examples.json +2 -2
- tccli/services/iotexplorer/v20190423/api.json +4 -4
- tccli/services/ivld/v20210903/api.json +1 -1
- tccli/services/lighthouse/v20200324/api.json +69 -69
- tccli/services/lighthouse/v20200324/examples.json +6 -6
- tccli/services/lke/v20231130/api.json +2 -2
- tccli/services/memcached/v20190318/api.json +6 -6
- tccli/services/monitor/monitor_client.py +107 -54
- tccli/services/monitor/v20180724/api.json +206 -0
- tccli/services/monitor/v20180724/examples.json +14 -0
- tccli/services/mqtt/v20240516/api.json +22 -22
- tccli/services/mqtt/v20240516/examples.json +8 -2
- tccli/services/redis/v20180412/api.json +2 -2
- tccli/services/redis/v20180412/examples.json +8 -8
- tccli/services/ssl/v20191205/examples.json +2 -2
- tccli/services/vpc/v20170312/api.json +19 -1
- tccli/services/wedata/v20210820/api.json +11 -0
- {tccli-3.0.1232.1.dist-info → tccli-3.0.1234.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1232.1.dist-info → tccli-3.0.1234.1.dist-info}/RECORD +26 -26
- {tccli-3.0.1232.1.dist-info → tccli-3.0.1234.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1232.1.dist-info → tccli-3.0.1234.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1232.1.dist-info → tccli-3.0.1234.1.dist-info}/license_files/LICENSE +0 -0
@@ -42,6 +42,13 @@
|
|
42
42
|
"output": "CreateAlarmPolicyResponse",
|
43
43
|
"status": "online"
|
44
44
|
},
|
45
|
+
"CreateAlarmShield": {
|
46
|
+
"document": "创建告警屏蔽规则",
|
47
|
+
"input": "CreateAlarmShieldRequest",
|
48
|
+
"name": "创建告警屏蔽规则",
|
49
|
+
"output": "CreateAlarmShieldResponse",
|
50
|
+
"status": "online"
|
51
|
+
},
|
45
52
|
"CreateAlertRule": {
|
46
53
|
"document": "创建 Prometheus 告警规则。\n\n请注意,**告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description**,,请参考 [Prometheus Rule更多配置请参考](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)。",
|
47
54
|
"input": "CreateAlertRuleRequest",
|
@@ -3494,6 +3501,205 @@
|
|
3494
3501
|
],
|
3495
3502
|
"type": "object"
|
3496
3503
|
},
|
3504
|
+
"CreateAlarmShieldRequest": {
|
3505
|
+
"document": "CreateAlarmShield请求参数结构体",
|
3506
|
+
"members": [
|
3507
|
+
{
|
3508
|
+
"disabled": false,
|
3509
|
+
"document": "模块名,这里填“monitor”",
|
3510
|
+
"example": "monitor",
|
3511
|
+
"member": "string",
|
3512
|
+
"name": "Module",
|
3513
|
+
"required": true,
|
3514
|
+
"type": "string"
|
3515
|
+
},
|
3516
|
+
{
|
3517
|
+
"disabled": false,
|
3518
|
+
"document": "屏蔽策略名称",
|
3519
|
+
"example": "测试屏蔽",
|
3520
|
+
"member": "string",
|
3521
|
+
"name": "Name",
|
3522
|
+
"required": true,
|
3523
|
+
"type": "string"
|
3524
|
+
},
|
3525
|
+
{
|
3526
|
+
"disabled": false,
|
3527
|
+
"document": "监控类型",
|
3528
|
+
"example": "MT_QCE",
|
3529
|
+
"member": "string",
|
3530
|
+
"name": "MonitorType",
|
3531
|
+
"required": true,
|
3532
|
+
"type": "string"
|
3533
|
+
},
|
3534
|
+
{
|
3535
|
+
"disabled": false,
|
3536
|
+
"document": "命名空间即策略类型",
|
3537
|
+
"example": "CKAFKA-CONSUMERGROUP-TOPIC",
|
3538
|
+
"member": "string",
|
3539
|
+
"name": "NameSpace",
|
3540
|
+
"required": true,
|
3541
|
+
"type": "string"
|
3542
|
+
},
|
3543
|
+
{
|
3544
|
+
"disabled": false,
|
3545
|
+
"document": "屏蔽时间类型 FOREVER_SHIELD:永久屏蔽 PERIOD_SHIELD:绝对时间范围屏蔽 LOOP_SHIELD:相对时间范围屏蔽",
|
3546
|
+
"example": "LOOP_SHIELD",
|
3547
|
+
"member": "string",
|
3548
|
+
"name": "ShieldTimeType",
|
3549
|
+
"required": true,
|
3550
|
+
"type": "string"
|
3551
|
+
},
|
3552
|
+
{
|
3553
|
+
"disabled": false,
|
3554
|
+
"document": "屏蔽对象",
|
3555
|
+
"example": "[\"cafka-xxx\", \"cafka-xxx\"]",
|
3556
|
+
"member": "string",
|
3557
|
+
"name": "ShieldObject",
|
3558
|
+
"required": false,
|
3559
|
+
"type": "list"
|
3560
|
+
},
|
3561
|
+
{
|
3562
|
+
"disabled": false,
|
3563
|
+
"document": "屏蔽指标 为空则为全部指标",
|
3564
|
+
"example": "[\"UnconsumeTopic\", \"MaxOffsetTopic\"]",
|
3565
|
+
"member": "string",
|
3566
|
+
"name": "ShieldMetric",
|
3567
|
+
"required": false,
|
3568
|
+
"type": "list"
|
3569
|
+
},
|
3570
|
+
{
|
3571
|
+
"disabled": false,
|
3572
|
+
"document": "开始时间 相对时间范围:36000 绝对时间范围:1648742400 缺省:0",
|
3573
|
+
"example": "36000",
|
3574
|
+
"member": "uint64",
|
3575
|
+
"name": "StartTime",
|
3576
|
+
"required": false,
|
3577
|
+
"type": "int"
|
3578
|
+
},
|
3579
|
+
{
|
3580
|
+
"disabled": false,
|
3581
|
+
"document": "结束时间 相对时间范围:72000 绝对时间范围:1649088000 缺省:0",
|
3582
|
+
"example": "72000",
|
3583
|
+
"member": "uint64",
|
3584
|
+
"name": "EndTime",
|
3585
|
+
"required": false,
|
3586
|
+
"type": "int"
|
3587
|
+
},
|
3588
|
+
{
|
3589
|
+
"disabled": false,
|
3590
|
+
"document": "循环开始日期 2022/04/01 缺省:0",
|
3591
|
+
"example": "1648742400",
|
3592
|
+
"member": "uint64",
|
3593
|
+
"name": "LoopStartDate",
|
3594
|
+
"required": false,
|
3595
|
+
"type": "int"
|
3596
|
+
},
|
3597
|
+
{
|
3598
|
+
"disabled": false,
|
3599
|
+
"document": "循环结束日期 2022/04/05 缺省:0",
|
3600
|
+
"example": "1649088000",
|
3601
|
+
"member": "uint64",
|
3602
|
+
"name": "LoopEndDate",
|
3603
|
+
"required": false,
|
3604
|
+
"type": "int"
|
3605
|
+
},
|
3606
|
+
{
|
3607
|
+
"disabled": false,
|
3608
|
+
"document": "需要屏蔽的策略ID",
|
3609
|
+
"example": "policy-1111",
|
3610
|
+
"member": "string",
|
3611
|
+
"name": "ShieldPolicyId",
|
3612
|
+
"required": false,
|
3613
|
+
"type": "string"
|
3614
|
+
},
|
3615
|
+
{
|
3616
|
+
"disabled": false,
|
3617
|
+
"document": "需要屏蔽的告警等级,取值范围Warn,Remind,Serious",
|
3618
|
+
"example": "Warn",
|
3619
|
+
"member": "string",
|
3620
|
+
"name": "ShieldAlarmLevel",
|
3621
|
+
"required": false,
|
3622
|
+
"type": "list"
|
3623
|
+
},
|
3624
|
+
{
|
3625
|
+
"disabled": false,
|
3626
|
+
"document": "屏蔽类型,为OBJNAME是老版本实例名屏蔽,为POLICY是新版本维度匹配",
|
3627
|
+
"example": "OBJNAME",
|
3628
|
+
"member": "string",
|
3629
|
+
"name": "VersionTag",
|
3630
|
+
"required": false,
|
3631
|
+
"type": "string"
|
3632
|
+
},
|
3633
|
+
{
|
3634
|
+
"disabled": false,
|
3635
|
+
"document": "屏蔽规则的描述",
|
3636
|
+
"example": "描述",
|
3637
|
+
"member": "string",
|
3638
|
+
"name": "Description",
|
3639
|
+
"required": false,
|
3640
|
+
"type": "string"
|
3641
|
+
},
|
3642
|
+
{
|
3643
|
+
"disabled": false,
|
3644
|
+
"document": " 时区,东八区+8,西八区减8,以此类推\n",
|
3645
|
+
"example": "5.5",
|
3646
|
+
"member": "float",
|
3647
|
+
"name": "TimeZone",
|
3648
|
+
"required": false,
|
3649
|
+
"type": "float"
|
3650
|
+
},
|
3651
|
+
{
|
3652
|
+
"disabled": false,
|
3653
|
+
"document": "屏蔽事件 为空则为全部指标",
|
3654
|
+
"example": "[\"cpm:ErrorEvent:SsdTempe\"]",
|
3655
|
+
"member": "string",
|
3656
|
+
"name": "ShieldEvent",
|
3657
|
+
"required": false,
|
3658
|
+
"type": "list"
|
3659
|
+
},
|
3660
|
+
{
|
3661
|
+
"disabled": false,
|
3662
|
+
"document": "是否对指标屏蔽 1=是 0=否",
|
3663
|
+
"example": "1",
|
3664
|
+
"member": "int64",
|
3665
|
+
"name": "ShieldMetricFlag",
|
3666
|
+
"required": false,
|
3667
|
+
"type": "int"
|
3668
|
+
},
|
3669
|
+
{
|
3670
|
+
"disabled": false,
|
3671
|
+
"document": "是否对事件屏蔽 1=是 0=否",
|
3672
|
+
"example": "1",
|
3673
|
+
"member": "int64",
|
3674
|
+
"name": "ShieldEventFlag",
|
3675
|
+
"required": false,
|
3676
|
+
"type": "int"
|
3677
|
+
}
|
3678
|
+
],
|
3679
|
+
"type": "object"
|
3680
|
+
},
|
3681
|
+
"CreateAlarmShieldResponse": {
|
3682
|
+
"document": "CreateAlarmShield返回参数结构体",
|
3683
|
+
"members": [
|
3684
|
+
{
|
3685
|
+
"disabled": false,
|
3686
|
+
"document": "屏蔽规则的Id",
|
3687
|
+
"example": "Shield-xxxx",
|
3688
|
+
"member": "string",
|
3689
|
+
"name": "ShieldId",
|
3690
|
+
"output_required": true,
|
3691
|
+
"type": "string",
|
3692
|
+
"value_allowed_null": false
|
3693
|
+
},
|
3694
|
+
{
|
3695
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
3696
|
+
"member": "string",
|
3697
|
+
"name": "RequestId",
|
3698
|
+
"type": "string"
|
3699
|
+
}
|
3700
|
+
],
|
3701
|
+
"type": "object"
|
3702
|
+
},
|
3497
3703
|
"CreateAlertRuleRequest": {
|
3498
3704
|
"document": "CreateAlertRule请求参数结构体",
|
3499
3705
|
"members": [
|
@@ -48,6 +48,20 @@
|
|
48
48
|
"title": "创建告警策略"
|
49
49
|
}
|
50
50
|
],
|
51
|
+
"CreateAlarmShield": [
|
52
|
+
{
|
53
|
+
"document": "",
|
54
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAlarmShield\n<公共请求参数>\n\n{\n \"LoopStartDate\": \"1648742400\",\n \"StartTime\": \"36000\",\n \"NameSpace\": \"cvm_device\",\n \"Module\": \"monitor\",\n \"ShieldMetric\": [\n \"CpuUsage\"\n ],\n \"LoopEndDate\": \"1649088000\",\n \"ShieldTimeType\": \"LOOP_SHIELD\",\n \"MonitorType\": \"MT_QCE\",\n \"EndTime\": \"72000\",\n \"ShieldObject\": [\n \"cafka-xxx\"\n ],\n \"Name\": \"1311\"\n}",
|
55
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"f4f51ecc-c3fa-4e0a-a9b5-093b1a58013e\",\n \"ShieldId\": \"Shield-wixc9u804z\"\n }\n}",
|
56
|
+
"title": "CreateAlarmShield示例1"
|
57
|
+
},
|
58
|
+
{
|
59
|
+
"document": "",
|
60
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateAlarmShield\n<公共请求参数>\n\n{\n \"Module\": \"monitor\",\n \"Name\": \"测试屏蔽\",\n \"MonitorType\": \"MT_QCE\",\n \"NameSpace\": \"cvm_device\",\n \"ShieldObject\": [\n \"cafka-xxx\",\n \"cafka-xxx1\"\n ],\n \"ShieldMetric\": [\n \"CpuUsage\",\n \"BaseCpuUsage\"\n ],\n \"ShieldTimeType\": \"LOOP_SHIELD\",\n \"StartTime\": \"36000\",\n \"EndTime\": \"72000\",\n \"LoopStartDate\": \"1648742400\",\n \"LoopEndDate\": \"1649088000\"\n}",
|
61
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"29ghj2hh-45-266627r66hheh-23\",\n \"ShieldId\": \"shield-xxxx\"\n }\n}",
|
62
|
+
"title": "创建告警屏蔽规则"
|
63
|
+
}
|
64
|
+
],
|
51
65
|
"CreateAlertRule": [
|
52
66
|
{
|
53
67
|
"document": "",
|
@@ -554,7 +554,7 @@
|
|
554
554
|
{
|
555
555
|
"disabled": false,
|
556
556
|
"document": "实例ID",
|
557
|
-
"example": "
|
557
|
+
"example": "mqtt-xxxx",
|
558
558
|
"member": "string",
|
559
559
|
"name": "InstanceId",
|
560
560
|
"required": true,
|
@@ -607,7 +607,7 @@
|
|
607
607
|
},
|
608
608
|
{
|
609
609
|
"disabled": false,
|
610
|
-
"document": "设备连接时传递jwt的key
|
610
|
+
"document": "设备连接时传递jwt的key;\nusername-使用用户名字段传递;\npassword-使用密码字段传递",
|
611
611
|
"example": "username",
|
612
612
|
"member": "string",
|
613
613
|
"name": "From",
|
@@ -790,7 +790,7 @@
|
|
790
790
|
{
|
791
791
|
"disabled": false,
|
792
792
|
"document": "设备证书序列号",
|
793
|
-
"example": "
|
793
|
+
"example": "37593",
|
794
794
|
"member": "string",
|
795
795
|
"name": "DeviceCertificateSn",
|
796
796
|
"required": true,
|
@@ -825,7 +825,7 @@
|
|
825
825
|
},
|
826
826
|
{
|
827
827
|
"disabled": false,
|
828
|
-
"document": "
|
828
|
+
"document": "认证器类型:\nJWT:JWT认证器\nJWKS:JWKS认证器\nBYOC:一端一证认证器",
|
829
829
|
"example": "JWKS",
|
830
830
|
"member": "string",
|
831
831
|
"name": "Type",
|
@@ -898,7 +898,7 @@
|
|
898
898
|
{
|
899
899
|
"disabled": false,
|
900
900
|
"document": "设备证书序列号",
|
901
|
-
"example": "
|
901
|
+
"example": "37593",
|
902
902
|
"member": "string",
|
903
903
|
"name": "DeviceCertificateSn",
|
904
904
|
"required": true,
|
@@ -969,7 +969,7 @@
|
|
969
969
|
},
|
970
970
|
{
|
971
971
|
"disabled": false,
|
972
|
-
"document": "
|
972
|
+
"document": "认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器",
|
973
973
|
"example": "JWKS",
|
974
974
|
"member": "string",
|
975
975
|
"name": "Type",
|
@@ -1127,8 +1127,8 @@
|
|
1127
1127
|
},
|
1128
1128
|
{
|
1129
1129
|
"disabled": false,
|
1130
|
-
"document": "证书序列号",
|
1131
|
-
"example": "
|
1130
|
+
"document": "Ca证书序列号",
|
1131
|
+
"example": "1b1e3bf3702110125887a3a721a7e66f05522513",
|
1132
1132
|
"member": "string",
|
1133
1133
|
"name": "CaSn",
|
1134
1134
|
"output_required": false,
|
@@ -1137,8 +1137,8 @@
|
|
1137
1137
|
},
|
1138
1138
|
{
|
1139
1139
|
"disabled": false,
|
1140
|
-
"document": "
|
1141
|
-
"example": "
|
1140
|
+
"document": "设备证书序列号",
|
1141
|
+
"example": "0eef68a582b94254296e54ce754f94d707a59911",
|
1142
1142
|
"member": "string",
|
1143
1143
|
"name": "DeviceCertificateSn",
|
1144
1144
|
"output_required": false,
|
@@ -1147,8 +1147,8 @@
|
|
1147
1147
|
},
|
1148
1148
|
{
|
1149
1149
|
"disabled": false,
|
1150
|
-
"document": "
|
1151
|
-
"example": "
|
1150
|
+
"document": "设备证书内容",
|
1151
|
+
"example": "-----BEGIN CERTIFICATE-----\\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n",
|
1152
1152
|
"member": "string",
|
1153
1153
|
"name": "DeviceCertificate",
|
1154
1154
|
"output_required": false,
|
@@ -1157,8 +1157,8 @@
|
|
1157
1157
|
},
|
1158
1158
|
{
|
1159
1159
|
"disabled": false,
|
1160
|
-
"document": "设备证书
|
1161
|
-
"example": "
|
1160
|
+
"document": "设备证书common name",
|
1161
|
+
"example": "mqtt-test.xxx.tencent.com",
|
1162
1162
|
"member": "string",
|
1163
1163
|
"name": "DeviceCertificateCn",
|
1164
1164
|
"output_required": false,
|
@@ -1229,7 +1229,7 @@
|
|
1229
1229
|
{
|
1230
1230
|
"disabled": false,
|
1231
1231
|
"document": "过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索",
|
1232
|
-
"example": "[]",
|
1232
|
+
"example": "[{\"Name\":\"DeviceCertificateSn\",\"Values\":[\"mqtt\"]}]",
|
1233
1233
|
"member": "Filter",
|
1234
1234
|
"name": "Filters",
|
1235
1235
|
"required": false,
|
@@ -1281,7 +1281,7 @@
|
|
1281
1281
|
{
|
1282
1282
|
"disabled": false,
|
1283
1283
|
"document": "设备证书",
|
1284
|
-
"example": "
|
1284
|
+
"example": "[ { \"ClientId\": \"mqtt_495bf0d1\", \"DeviceCertificateSn\": \"sn\", \"DeviceCertificateCn\": \"*.mqtt.tencenttdmq.com\", \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIDtzCCAp+gAwIBAgIUDAmlFLEYRYrhNkFH+uRaU/0TZCswDQYJKoZIhvcNAQEL\\r\\n\\n-----END CERTIFICATE-----\\r\\n\", \"CaSn\": \"51e61225de8146bea80e793197d7cc3e7680d978\", \"Format\": \"PEM\", \"Status\": \"ACTIVE\", \"CertificateSource\": \"API\", \"LastActivationTime\": 1728893405812, \"LastInactivationTime\": 0, \"CreatedTime\": 1728893406000, \"UpdateTime\": 1728893850000, \"NotBeforeTime\": 1728893395000, \"NotAfterTime\": 1772093395000 }, { \"ClientId\": \"mqtt_495bf0d1\", \"DeviceCertificateSn\": \"sn\", \"DeviceCertificateCn\": \"client-test\", \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIDrDCCApSgAwIBAgIUDAmlFLEYRYrhNkFH+uRaU/0TZCowDQYJKoZIhvcNAQEL\\r\\n-----END CERTIFICATE-----\\r\\n\", \"CaSn\": \"51e61225de8146bea80e793197d7cc3e7680d978\", \"Format\": \"PEM\", \"Status\": \"ACTIVE\", \"CertificateSource\": \"API\", \"LastActivationTime\": 1728892994189, \"LastInactivationTime\": 0, \"CreatedTime\": 1728892994000, \"UpdateTime\": 1728893891000, \"NotBeforeTime\": 1728892979000, \"NotAfterTime\": 1772092979000 }, { \"ClientId\": \" \", \"DeviceCertificateSn\": \"sn\", \"DeviceCertificateCn\": \"*.mqtt.tencenttdmq.com\", \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIDrzCCApegAwIBAgIUV23UtXK/m8jslmJsfVgfxsECUNcwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n\", \"CaSn\": \"5c443401cd63e4840bb6839fc1e404ee7b719876\", \"Format\": \"PEM\", \"Status\": \"ACTIVE\", \"CertificateSource\": \"API\", \"LastActivationTime\": 1728725044431, \"LastInactivationTime\": 1728725012888, \"CreatedTime\": 1728725044000, \"UpdateTime\": 1728725048000, \"NotBeforeTime\": 1726115615000, \"NotAfterTime\": 1769315615000 } ]",
|
1285
1285
|
"member": "DeviceCertificateItem",
|
1286
1286
|
"name": "Data",
|
1287
1287
|
"output_required": true,
|
@@ -1377,7 +1377,7 @@
|
|
1377
1377
|
{
|
1378
1378
|
"disabled": false,
|
1379
1379
|
"document": "实例ID",
|
1380
|
-
"example": "
|
1380
|
+
"example": "mqtt-xxxx",
|
1381
1381
|
"member": "string",
|
1382
1382
|
"name": "InstanceId",
|
1383
1383
|
"required": true,
|
@@ -1391,7 +1391,7 @@
|
|
1391
1391
|
"members": [
|
1392
1392
|
{
|
1393
1393
|
"disabled": false,
|
1394
|
-
"document": "
|
1394
|
+
"document": "实例类型\nBASIC 基础版\nPRO 专业版",
|
1395
1395
|
"example": "BASIC",
|
1396
1396
|
"member": "string",
|
1397
1397
|
"name": "InstanceType",
|
@@ -1521,7 +1521,7 @@
|
|
1521
1521
|
},
|
1522
1522
|
{
|
1523
1523
|
"disabled": false,
|
1524
|
-
"document": "
|
1524
|
+
"document": "客户端证书注册方式:\nJITP:自动注册\nAPI:通过API手动注册",
|
1525
1525
|
"example": "API",
|
1526
1526
|
"member": "string",
|
1527
1527
|
"name": "DeviceCertificateProvisionType",
|
@@ -1581,7 +1581,7 @@
|
|
1581
1581
|
},
|
1582
1582
|
{
|
1583
1583
|
"disabled": false,
|
1584
|
-
"document": "
|
1584
|
+
"document": "TLS,单向认证 mTLS,双向认证 BYOC;一机一证",
|
1585
1585
|
"example": "TLS",
|
1586
1586
|
"member": "string",
|
1587
1587
|
"name": "X509Mode",
|
@@ -2684,7 +2684,7 @@
|
|
2684
2684
|
{
|
2685
2685
|
"disabled": false,
|
2686
2686
|
"document": "设备证书序列号",
|
2687
|
-
"example": "
|
2687
|
+
"example": "eef68a582b94254296e54ce754f94d707a59912",
|
2688
2688
|
"member": "string",
|
2689
2689
|
"name": "DeviceCertificateSn",
|
2690
2690
|
"required": true,
|
@@ -2744,7 +2744,7 @@
|
|
2744
2744
|
{
|
2745
2745
|
"disabled": false,
|
2746
2746
|
"document": "策略ID和优先级",
|
2747
|
-
"example": "[]",
|
2747
|
+
"example": "[ \t\t{ \t\t\t\"Id\": 1, \t\t\t\"Priority\": 3 \t\t}, \t\t{ \t\t\t\"Id\": 6, \t\t\t\"Priority\": 1 \t\t}, \t\t{ \t\t\t\"Id\": 7, \t\t\t\"Priority\": 2 \t\t} \t]",
|
2748
2748
|
"member": "AuthorizationPolicyPriority",
|
2749
2749
|
"name": "Priorities",
|
2750
2750
|
"required": false,
|
@@ -86,6 +86,12 @@
|
|
86
86
|
"input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMQTTAuthenticator\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-2vnk55xv\",\n \"Type\": \"JWKS\"\n}",
|
87
87
|
"output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Authenticators\": [\n {\n \"Config\": \"{\\\"endpoint\\\":\\\"1.2.3.4\\\",\\\"refreshInterval\\\":10}\",\n \"Status\": \"open\",\n \"Type\": \"JWKS\"\n }\n ],\n \"RequestId\": \"83d4a381-b448-45c8-adcf-b563bd18f4fb\"\n }\n}",
|
88
88
|
"title": "示例"
|
89
|
+
},
|
90
|
+
{
|
91
|
+
"document": "HTTP示例",
|
92
|
+
"input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeAuthenticator\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-dmzeoj58\",\n \"Type\": \"HTTP\"\n}",
|
93
|
+
"output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"Authenticators\": [\n {\n \"Config\": \"{\\\"headers\\\":[{\\\"key\\\":\\\"user\\\",\\\"value\\\":\\\"${username}\\\"}],\\\"endpoint\\\":\\\"127.0.0.1\\\",\\\"method\\\":\\\"Post\\\",\\\"readTimeout\\\":1,\\\"connectTimeout\\\":1,\\\"body\\\":[{\\\"key\\\":\\\"user\\\",\\\"value\\\":\\\"${username}\\\"}],\\\"concurrency\\\":1}\",\n \"CreateTime\": 1731036362,\n \"Remark\": \"this is remark\",\n \"Status\": \"open\",\n \"Type\": \"HTTP\"\n }\n ],\n \"RequestId\": \"756b8ee7-00e8-48ea-94f2-02eead2a5067\"\n }\n}",
|
94
|
+
"title": "HTTP示例"
|
89
95
|
}
|
90
96
|
],
|
91
97
|
"DescribeAuthorizationPolicies": [
|
@@ -100,7 +106,7 @@
|
|
100
106
|
{
|
101
107
|
"document": "示例",
|
102
108
|
"input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDeviceCertificate\n<公共请求参数>\n\n{\n \"DeviceCertificateSn\": \"0eef68a582b94254296e54ce754f94d707a59911\",\n \"InstanceId\": \"mqtt-jbgwp4ae\"\n}",
|
103
|
-
"output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"CertificateSource\": \"API\",\n \"ClientId\": \"111\",\n \"CreatedTime\": 1724050379000,\n \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\\
|
109
|
+
"output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"CaSn\": \"1b1e3bf3702110125887a3a721a7e66f05522513\",\n \"CertificateSource\": \"API\",\n \"ClientId\": \"111\",\n \"CreatedTime\": 1724050379000,\n \"DeviceCertificate\": \"-----BEGIN CERTIFICATE-----\\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\\n-----END CERTIFICATE-----\\n\",\n \"DeviceCertificateCn\": \"mqtt-test.xxx.tencent.com\",\n \"DeviceCertificateSn\": \"0eef68a582b94254296e54ce754f94d707a59911\",\n \"Format\": \"PEM\",\n \"LastActivationTime\": 1724050378987,\n \"LastInactivationTime\": 0,\n \"NotAfterTime\": 1758185683000,\n \"NotBeforeTime\": 1714985683000,\n \"RequestId\": \"1b5fc3fa-4bbf-421a-aad1-c45d49119a2c\",\n \"Status\": \"ACTIVE\",\n \"UpdateTime\": 1724050379000\n }\n}",
|
104
110
|
"title": "示例"
|
105
111
|
}
|
106
112
|
],
|
@@ -155,7 +161,7 @@
|
|
155
161
|
"ModifyJWKSAuthenticator": [
|
156
162
|
{
|
157
163
|
"document": "示例",
|
158
|
-
"input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMQTTJWKSAuthenticator\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-3w7vz9ko\",\n \"Endpoint\": \"https://
|
164
|
+
"input": "POST / HTTP/1.1\nHost: mqtt.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyMQTTJWKSAuthenticator\n<公共请求参数>\n\n{\n \"InstanceId\": \"mqtt-3w7vz9ko\",\n \"Endpoint\": \"https://127.0.0.1\",\n \"RefreshInterval\": 222,\n \"Remark\": \"ramark\"\n}",
|
159
165
|
"output": "{\n \"Error\": null,\n \"RequestId\": null,\n \"Response\": {\n \"RequestId\": \"2614e8ba-273a-4f1e-a910-6ed6ed97b7f8\"\n }\n}",
|
160
166
|
"title": "示例"
|
161
167
|
}
|
@@ -3031,7 +3031,7 @@
|
|
3031
3031
|
{
|
3032
3032
|
"disabled": false,
|
3033
3033
|
"document": "vpc网络ID信息列表",
|
3034
|
-
"example": "
|
3034
|
+
"example": "[1120,1121]",
|
3035
3035
|
"member": "int64",
|
3036
3036
|
"name": "VpcIds",
|
3037
3037
|
"required": false,
|
@@ -3058,7 +3058,7 @@
|
|
3058
3058
|
{
|
3059
3059
|
"disabled": false,
|
3060
3060
|
"document": "实例ID过滤信息列表,数组最大长度限制为100",
|
3061
|
-
"example": "[\"crs-
|
3061
|
+
"example": "[\"crs-xjhsdj****\\n\"]",
|
3062
3062
|
"member": "string",
|
3063
3063
|
"name": "InstanceIds",
|
3064
3064
|
"required": false,
|
@@ -129,7 +129,7 @@
|
|
129
129
|
"DeleteInstanceAccount": [
|
130
130
|
{
|
131
131
|
"document": "",
|
132
|
-
"input": "https://redis.tencentcloudapi.com/?Action=DeleteInstanceAccount\n&InstanceId=crs-5a4py64p\n&AccountName=
|
132
|
+
"input": "https://redis.tencentcloudapi.com/?Action=DeleteInstanceAccount\n&InstanceId=crs-5a4py64p\n&AccountName=example_account\n&<公共请求参数>",
|
133
133
|
"output": "{\n \"Response\": {\n \"TaskId\": 123456,\n \"RequestId\": \"0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db\"\n }\n}",
|
134
134
|
"title": "请求示例"
|
135
135
|
}
|
@@ -193,8 +193,8 @@
|
|
193
193
|
"DescribeCommonDBInstances": [
|
194
194
|
{
|
195
195
|
"document": "废弃接口",
|
196
|
-
"input": "https://redis.tencentcloudapi.com/?Action=DescribeCommonDBInstances\n&PayMode=0\n&InstanceIds.0=crs-
|
197
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceDetails\": [\n {\n \"
|
196
|
+
"input": "https://redis.tencentcloudapi.com/?Action=DescribeCommonDBInstances\n&PayMode=0\n&InstanceIds.0=crs-xjhsdj****\n&<公共请求参数>",
|
197
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstanceDetails\": [\n {\n \"AppId\": 1251111111,\n \"Createtime\": \"2022-06-13 21:41:40\",\n \"InstanceId\": \"crs-xjhsdj****\",\n \"InstanceName\": \"dba-stag\",\n \"NetType\": 1,\n \"PayMode\": 1,\n \"ProjectId\": 0,\n \"Region\": \"ap-beijing\",\n \"Status\": \"2\",\n \"SubnetId\": \"unknown-unSubnetId\",\n \"Vips\": [\n \"10.76.128.10\"\n ],\n \"VpcId\": \"unknown-unVpcId\",\n \"Vport\": 6379,\n \"Zone\": \"ap-beijing-1\"\n }\n ],\n \"RequestId\": \"fc4a37f4-b27d-4aaf-9661-8212c9dabmclnvXXX\"\n }\n}",
|
198
198
|
"title": "请求示例"
|
199
199
|
}
|
200
200
|
],
|
@@ -266,7 +266,7 @@
|
|
266
266
|
{
|
267
267
|
"document": "请求示例",
|
268
268
|
"input": "POST / HTTP/1.1\nHost: redis.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceMonitorBigKey\n<公共请求参数>\n\n{\n \"InstanceId\": \"crs-5a4py64p\",\n \"Date\": \"20191101\",\n \"ReqType\": \"1\"\n}",
|
269
|
-
"output": "{\n \"Response\": {\n \"Data\": [\n {\n \"DB\": 0,\n \"Key\": \"
|
269
|
+
"output": "{\n \"Response\": {\n \"Data\": [\n {\n \"DB\": 0,\n \"Key\": \"exapmle_key\",\n \"Type\": \"exapmle_type\",\n \"Size\": 0,\n \"Updatetime\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
270
270
|
"title": "请求示例"
|
271
271
|
}
|
272
272
|
],
|
@@ -410,7 +410,7 @@
|
|
410
410
|
{
|
411
411
|
"document": "查询指定参数模板ID的模板信息",
|
412
412
|
"input": "POST / HTTP/1.1\nHost: redis.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeParamTemplateInfo\n<公共请求参数>\n\n{\n \"TemplateId\": \"crs-cfg-7mgt****\"\n}",
|
413
|
-
"output": "{\n \"Response\": {\n \"Description\": \"MyCustomParamTemplate\",\n \"Items\": [\n {\n \"CurrentValue\": \"\",\n \"Default\": \"
|
413
|
+
"output": "{\n \"Response\": {\n \"Description\": \"MyCustomParamTemplate\",\n \"Items\": [\n {\n \"CurrentValue\": \"flushall\",\n \"Default\": \"param_default_value\",\n \"Description\": \"commands in such config will not be allowed to run in this instance,you can config multi commands like this 'flushdb,keys'\",\n \"EnumValue\": [\n \"flushall\",\n \"flushdb\",\n \"keys\",\n \"hgetall\",\n \"eval\",\n \"evalsha\",\n \"script\"\n ],\n \"Max\": \"\",\n \"Min\": \"\",\n \"Name\": \"disable-command-list\",\n \"NeedReboot\": 0,\n \"ParamType\": \"multi\"\n },\n {\n \"CurrentValue\": \"512\",\n \"Default\": \"512\",\n \"Description\": \"Hashes are encoded using a memory efficient data structure when they have a small number of entries\",\n \"EnumValue\": null,\n \"Max\": \"10000\",\n \"Min\": \"1\",\n \"Name\": \"hash-max-ziplist-entries\",\n \"NeedReboot\": 0,\n \"ParamType\": \"integer\"\n },\n {\n \"CurrentValue\": \"64\",\n \"Default\": \"64\",\n \"Description\": \"Hashes are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold\",\n \"EnumValue\": null,\n \"Max\": \"10000\",\n \"Min\": \"1\",\n \"Name\": \"hash-max-ziplist-value\",\n \"NeedReboot\": 0,\n \"ParamType\": \"integer\"\n },\n {\n \"CurrentValue\": \"10\",\n \"Default\": \"10\",\n \"Description\": \"The frequency at which Redis background tasks are performed. A higher value results in higher CPU consumption but smaller latency. We recommend that you do not specify a value larger than 100.\",\n \"EnumValue\": null,\n \"Max\": \"500\",\n \"Min\": \"1\",\n \"Name\": \"hz\",\n \"NeedReboot\": 0,\n \"ParamType\": \"integer\"\n }\n ],\n \"Name\": \"redis_automation_is_awesome_1\",\n \"ProductType\": 2,\n \"RequestId\": \"72881d6c-c2a0-42af-862a-a5de09de104d\",\n \"TemplateId\": \"crs-cfg-7mgt****\",\n \"TotalCount\": 14\n }\n}",
|
414
414
|
"title": "查询参数模板信息"
|
415
415
|
}
|
416
416
|
],
|
@@ -482,7 +482,7 @@
|
|
482
482
|
{
|
483
483
|
"document": "查询实例对应的复制组信息",
|
484
484
|
"input": "POST / HTTP/1.1\nHost: redis.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeReplicationGroupInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"crs-a7oxxxxx\"\n}",
|
485
|
-
"output": "{\n \"Response\": {\n \"AppId\": 251237400,\n \"GroupId\": \"crs-rpl-oxsincth\",\n \"GroupName\": \"
|
485
|
+
"output": "{\n \"Response\": {\n \"AppId\": 251237400,\n \"GroupId\": \"crs-rpl-oxsincth\",\n \"GroupName\": \"group_name\",\n \"InstanceRole\": \"rw\",\n \"RegionId\": 1,\n \"RequestId\": \"02ef9326-3db7-47ab-8f65-c6d1a772f71c\"\n }\n}",
|
486
486
|
"title": "查询复制组信息"
|
487
487
|
}
|
488
488
|
],
|
@@ -601,7 +601,7 @@
|
|
601
601
|
"ManualBackupInstance": [
|
602
602
|
{
|
603
603
|
"document": "手动备份",
|
604
|
-
"input": "https://redis.tencentcloudapi.com/?Action=ManualBackupInstance\n&InstanceId=crs-5a4p****\n&Remark=
|
604
|
+
"input": "https://redis.tencentcloudapi.com/?Action=ManualBackupInstance\n&InstanceId=crs-5a4p****\n&Remark=note_message\n&<公共请求参数>",
|
605
605
|
"output": "{\n \"Response\": {\n \"TaskId\": \"6954227\",\n \"RequestId\": \"4daddc97-0005-45d8-b5b8-38514ec1e97c\"\n }\n}",
|
606
606
|
"title": "请求示例"
|
607
607
|
}
|
@@ -657,7 +657,7 @@
|
|
657
657
|
"ModifyInstanceAccount": [
|
658
658
|
{
|
659
659
|
"document": "",
|
660
|
-
"input": "https://redis.tencentcloudapi.com/?Action=ModifyInstanceAccount\n&InstanceId=crs-5a4py64p\n&AccountName=
|
660
|
+
"input": "https://redis.tencentcloudapi.com/?Action=ModifyInstanceAccount\n&InstanceId=crs-5a4py64p\n&AccountName=test_account\n&<公共请求参数>",
|
661
661
|
"output": "{\n \"Response\": {\n \"TaskId\": 123456,\n \"RequestId\": \"0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db\"\n }\n}",
|
662
662
|
"title": "请求示例"
|
663
663
|
}
|
@@ -213,8 +213,8 @@
|
|
213
213
|
"DescribeDeployedResources": [
|
214
214
|
{
|
215
215
|
"document": "证书查询关联资源",
|
216
|
-
"input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDeployedResources\n<公共请求参数>\n\n{\n \"ResourceType\": \"
|
217
|
-
"output": "{\n \"Response\": {\n \"DeployedResources\": [\n {\n \"CertificateId\": \"
|
216
|
+
"input": "POST / HTTP/1.1\nHost: ssl.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDeployedResources\n<公共请求参数>\n\n{\n \"ResourceType\": \"teo\",\n \"CertificateIds\": [\n \"Tjs***jjs\"\n ]\n}",
|
217
|
+
"output": "{\n \"Response\": {\n \"DeployedResources\": [\n {\n \"CertificateId\": \"Tjs***jjs\",\n \"ResourceIds\": [\n \"ins-******\"\n ],\n \"Resources\": [\n \"inx-******\"\n ],\n \"Type\": \"teo\",\n \"Count\": 1\n }\n ],\n \"RequestId\": \"14727a68-3b90-4408-99c9-dea6d7de9456\"\n }\n}",
|
218
218
|
"title": "证书查询关联资源"
|
219
219
|
}
|
220
220
|
],
|
@@ -3730,6 +3730,15 @@
|
|
3730
3730
|
"required": false,
|
3731
3731
|
"type": "string"
|
3732
3732
|
},
|
3733
|
+
{
|
3734
|
+
"disabled": false,
|
3735
|
+
"document": "是否使用独占资源池,默认值:True\n- True:表示使用独占资源池\n- False:表示使用共享资源池\n\n说明:如需使用独占资源池,请 提交工单(https://console.cloud.tencent.com/workorder/category) 咨询,具体费用请咨询商务经理。",
|
3736
|
+
"example": "False",
|
3737
|
+
"member": "bool",
|
3738
|
+
"name": "IsDedicatedAddressPool",
|
3739
|
+
"required": false,
|
3740
|
+
"type": "bool"
|
3741
|
+
},
|
3733
3742
|
{
|
3734
3743
|
"disabled": false,
|
3735
3744
|
"document": "网络出口,当前仅支持精品BGP、静态单线,这2种IP 地址类型的指定出口传入,默认值:center_egress1,其它可选值:center_egress2、center_egress3",
|
@@ -9711,6 +9720,15 @@
|
|
9711
9720
|
"name": "SnapshotPolicies",
|
9712
9721
|
"required": true,
|
9713
9722
|
"type": "list"
|
9723
|
+
},
|
9724
|
+
{
|
9725
|
+
"disabled": false,
|
9726
|
+
"document": "指定绑定的标签列表,例如:[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。",
|
9727
|
+
"example": "无",
|
9728
|
+
"member": "Tag",
|
9729
|
+
"name": "Tags",
|
9730
|
+
"required": false,
|
9731
|
+
"type": "list"
|
9714
9732
|
}
|
9715
9733
|
],
|
9716
9734
|
"type": "object"
|
@@ -9724,7 +9742,7 @@
|
|
9724
9742
|
"example": "无",
|
9725
9743
|
"member": "SnapshotPolicy",
|
9726
9744
|
"name": "SnapshotPolicies",
|
9727
|
-
"
|
9745
|
+
"output_required": true,
|
9728
9746
|
"type": "list",
|
9729
9747
|
"value_allowed_null": false
|
9730
9748
|
},
|
@@ -32471,6 +32471,17 @@
|
|
32471
32471
|
"required": true,
|
32472
32472
|
"type": "string",
|
32473
32473
|
"value_allowed_null": false
|
32474
|
+
},
|
32475
|
+
{
|
32476
|
+
"disabled": false,
|
32477
|
+
"document": " 唯一标识\n注意:此字段可能返回 null,表示取不到有效值。",
|
32478
|
+
"example": "id",
|
32479
|
+
"member": "string",
|
32480
|
+
"name": "Id",
|
32481
|
+
"output_required": false,
|
32482
|
+
"required": false,
|
32483
|
+
"type": "string",
|
32484
|
+
"value_allowed_null": true
|
32474
32485
|
}
|
32475
32486
|
],
|
32476
32487
|
"usage": "both"
|