tccli 3.0.1120.1__py2.py3-none-any.whl → 3.0.1122.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/__init__.py +3 -0
- tccli/services/antiddos/v20200309/api.json +19 -0
- tccli/services/cdb/v20170320/api.json +127 -26
- tccli/services/cdb/v20170320/examples.json +2 -2
- tccli/services/domain/v20180808/api.json +18 -0
- tccli/services/ess/ess_client.py +53 -0
- tccli/services/ess/v20201111/api.json +127 -1
- tccli/services/ess/v20201111/examples.json +20 -0
- tccli/services/faceid/v20180301/api.json +2 -2
- tccli/services/iotexplorer/v20190423/api.json +2 -2
- tccli/services/lighthouse/v20200324/api.json +72 -64
- tccli/services/lighthouse/v20200324/examples.json +1 -1
- tccli/services/redis/v20180412/api.json +25 -25
- tccli/services/tcb/v20180608/api.json +5 -5
- tccli/services/tcr/v20190924/api.json +1 -1
- tccli/services/tcr/v20190924/examples.json +1 -1
- tccli/services/trocket/trocket_client.py +53 -0
- tccli/services/trocket/v20230308/api.json +393 -0
- tccli/services/trocket/v20230308/examples.json +8 -0
- tccli/services/trtc/v20190722/api.json +74 -18
- tccli/services/tse/v20201207/api.json +22 -0
- tccli/services/tsf/v20180326/api.json +77 -16
- tccli/services/vdb/__init__.py +4 -0
- tccli/services/vdb/v20230616/api.json +505 -0
- tccli/services/vdb/v20230616/examples.json +13 -0
- tccli/services/vdb/vdb_client.py +195 -0
- tccli/services/waf/v20180125/api.json +124 -0
- tccli/services/waf/v20180125/examples.json +8 -0
- tccli/services/waf/waf_client.py +53 -0
- tccli/services/wedata/v20210820/api.json +9 -0
- {tccli-3.0.1120.1.dist-info → tccli-3.0.1122.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1120.1.dist-info → tccli-3.0.1122.1.dist-info}/RECORD +36 -32
- {tccli-3.0.1120.1.dist-info → tccli-3.0.1122.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1120.1.dist-info → tccli-3.0.1122.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1120.1.dist-info → tccli-3.0.1122.1.dist-info}/license_files/LICENSE +0 -0
@@ -126,6 +126,13 @@
|
|
126
126
|
"output": "DescribeConsumerGroupListResponse",
|
127
127
|
"status": "online"
|
128
128
|
},
|
129
|
+
"DescribeFusionInstanceList": {
|
130
|
+
"document": "获取实例列表,Filters参数使用说明如下:\n1. InstanceName, 名称模糊查询\n2. InstanceId,实例ID查询\n3. InstanceType, 实例类型查询,支持多选\n4. Version,实例版本查询\n当使用TagFilters查询时,Filters参数失效。",
|
131
|
+
"input": "DescribeFusionInstanceListRequest",
|
132
|
+
"name": "获取4.x和5.0版本的实例列表",
|
133
|
+
"output": "DescribeFusionInstanceListResponse",
|
134
|
+
"status": "online"
|
135
|
+
},
|
129
136
|
"DescribeInstance": {
|
130
137
|
"document": "查询实例信息",
|
131
138
|
"input": "DescribeInstanceRequest",
|
@@ -1600,6 +1607,80 @@
|
|
1600
1607
|
],
|
1601
1608
|
"type": "object"
|
1602
1609
|
},
|
1610
|
+
"DescribeFusionInstanceListRequest": {
|
1611
|
+
"document": "DescribeFusionInstanceList请求参数结构体",
|
1612
|
+
"members": [
|
1613
|
+
{
|
1614
|
+
"disabled": false,
|
1615
|
+
"document": "查询起始位置",
|
1616
|
+
"example": "0",
|
1617
|
+
"member": "int64",
|
1618
|
+
"name": "Offset",
|
1619
|
+
"required": true,
|
1620
|
+
"type": "int"
|
1621
|
+
},
|
1622
|
+
{
|
1623
|
+
"disabled": false,
|
1624
|
+
"document": "查询结果限制数量",
|
1625
|
+
"example": "10",
|
1626
|
+
"member": "int64",
|
1627
|
+
"name": "Limit",
|
1628
|
+
"required": true,
|
1629
|
+
"type": "int"
|
1630
|
+
},
|
1631
|
+
{
|
1632
|
+
"disabled": false,
|
1633
|
+
"document": "查询条件列表",
|
1634
|
+
"example": "无",
|
1635
|
+
"member": "Filter",
|
1636
|
+
"name": "Filters",
|
1637
|
+
"required": false,
|
1638
|
+
"type": "list"
|
1639
|
+
},
|
1640
|
+
{
|
1641
|
+
"disabled": false,
|
1642
|
+
"document": "标签过滤器",
|
1643
|
+
"example": "无",
|
1644
|
+
"member": "TagFilter",
|
1645
|
+
"name": "TagFilters",
|
1646
|
+
"required": false,
|
1647
|
+
"type": "list"
|
1648
|
+
}
|
1649
|
+
],
|
1650
|
+
"type": "object"
|
1651
|
+
},
|
1652
|
+
"DescribeFusionInstanceListResponse": {
|
1653
|
+
"document": "DescribeFusionInstanceList返回参数结构体",
|
1654
|
+
"members": [
|
1655
|
+
{
|
1656
|
+
"disabled": false,
|
1657
|
+
"document": "查询总数\n注意:此字段可能返回 null,表示取不到有效值。",
|
1658
|
+
"example": "10",
|
1659
|
+
"member": "int64",
|
1660
|
+
"name": "TotalCount",
|
1661
|
+
"output_required": false,
|
1662
|
+
"type": "int",
|
1663
|
+
"value_allowed_null": true
|
1664
|
+
},
|
1665
|
+
{
|
1666
|
+
"disabled": false,
|
1667
|
+
"document": "实例列表",
|
1668
|
+
"example": "无",
|
1669
|
+
"member": "FusionInstanceItem",
|
1670
|
+
"name": "Data",
|
1671
|
+
"output_required": true,
|
1672
|
+
"type": "list",
|
1673
|
+
"value_allowed_null": false
|
1674
|
+
},
|
1675
|
+
{
|
1676
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
1677
|
+
"member": "string",
|
1678
|
+
"name": "RequestId",
|
1679
|
+
"type": "string"
|
1680
|
+
}
|
1681
|
+
],
|
1682
|
+
"type": "object"
|
1683
|
+
},
|
1603
1684
|
"DescribeInstanceListRequest": {
|
1604
1685
|
"document": "DescribeInstanceList请求参数结构体",
|
1605
1686
|
"members": [
|
@@ -3422,6 +3503,222 @@
|
|
3422
3503
|
],
|
3423
3504
|
"usage": "in"
|
3424
3505
|
},
|
3506
|
+
"FusionInstanceItem": {
|
3507
|
+
"document": "实例列表页中的实例信息",
|
3508
|
+
"members": [
|
3509
|
+
{
|
3510
|
+
"disabled": false,
|
3511
|
+
"document": "实例ID",
|
3512
|
+
"example": "rmq-xxxx",
|
3513
|
+
"member": "string",
|
3514
|
+
"name": "InstanceId",
|
3515
|
+
"output_required": true,
|
3516
|
+
"type": "string",
|
3517
|
+
"value_allowed_null": false
|
3518
|
+
},
|
3519
|
+
{
|
3520
|
+
"disabled": false,
|
3521
|
+
"document": "实例名称",
|
3522
|
+
"example": "test",
|
3523
|
+
"member": "string",
|
3524
|
+
"name": "InstanceName",
|
3525
|
+
"output_required": true,
|
3526
|
+
"type": "string",
|
3527
|
+
"value_allowed_null": false
|
3528
|
+
},
|
3529
|
+
{
|
3530
|
+
"disabled": false,
|
3531
|
+
"document": "实例版本",
|
3532
|
+
"example": "5.0",
|
3533
|
+
"member": "string",
|
3534
|
+
"name": "Version",
|
3535
|
+
"output_required": true,
|
3536
|
+
"type": "string",
|
3537
|
+
"value_allowed_null": false
|
3538
|
+
},
|
3539
|
+
{
|
3540
|
+
"disabled": false,
|
3541
|
+
"document": "实例类型,\nEXPERIMENT,体验版\nBASIC,基础版\nPRO,专业版\nPLATINUM,铂金版",
|
3542
|
+
"example": "无",
|
3543
|
+
"member": "string",
|
3544
|
+
"name": "InstanceType",
|
3545
|
+
"output_required": true,
|
3546
|
+
"type": "string",
|
3547
|
+
"value_allowed_null": false
|
3548
|
+
},
|
3549
|
+
{
|
3550
|
+
"disabled": false,
|
3551
|
+
"document": "实例状态,\nRUNNING, 运行中\nMAINTAINING,维护中\nABNORMAL,异常\nOVERDUE,欠费\nDESTROYED,已删除\nCREATING,创建中\nMODIFYING,变配中\nCREATE_FAILURE,创建失败\nMODIFY_FAILURE,变配失败\nDELETING,删除中",
|
3552
|
+
"example": "无",
|
3553
|
+
"member": "string",
|
3554
|
+
"name": "InstanceStatus",
|
3555
|
+
"output_required": true,
|
3556
|
+
"type": "string",
|
3557
|
+
"value_allowed_null": false
|
3558
|
+
},
|
3559
|
+
{
|
3560
|
+
"disabled": false,
|
3561
|
+
"document": "实例主题数上限",
|
3562
|
+
"example": "100",
|
3563
|
+
"member": "int64",
|
3564
|
+
"name": "TopicNumLimit",
|
3565
|
+
"output_required": true,
|
3566
|
+
"type": "int",
|
3567
|
+
"value_allowed_null": false
|
3568
|
+
},
|
3569
|
+
{
|
3570
|
+
"disabled": false,
|
3571
|
+
"document": "实例消费组数量上限",
|
3572
|
+
"example": "100",
|
3573
|
+
"member": "int64",
|
3574
|
+
"name": "GroupNumLimit",
|
3575
|
+
"output_required": true,
|
3576
|
+
"type": "int",
|
3577
|
+
"value_allowed_null": false
|
3578
|
+
},
|
3579
|
+
{
|
3580
|
+
"disabled": false,
|
3581
|
+
"document": "计费模式,\nPOSTPAID,按量计费\nPREPAID,包年包月",
|
3582
|
+
"example": "0",
|
3583
|
+
"member": "string",
|
3584
|
+
"name": "PayMode",
|
3585
|
+
"output_required": true,
|
3586
|
+
"type": "string",
|
3587
|
+
"value_allowed_null": false
|
3588
|
+
},
|
3589
|
+
{
|
3590
|
+
"disabled": false,
|
3591
|
+
"document": "到期时间,秒为单位\n注意:此字段可能返回 null,表示取不到有效值。",
|
3592
|
+
"example": "100000",
|
3593
|
+
"member": "int64",
|
3594
|
+
"name": "ExpiryTime",
|
3595
|
+
"output_required": true,
|
3596
|
+
"type": "int",
|
3597
|
+
"value_allowed_null": true
|
3598
|
+
},
|
3599
|
+
{
|
3600
|
+
"disabled": false,
|
3601
|
+
"document": "备注信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
3602
|
+
"example": "test",
|
3603
|
+
"member": "string",
|
3604
|
+
"name": "Remark",
|
3605
|
+
"output_required": true,
|
3606
|
+
"type": "string",
|
3607
|
+
"value_allowed_null": true
|
3608
|
+
},
|
3609
|
+
{
|
3610
|
+
"disabled": false,
|
3611
|
+
"document": "主题数量",
|
3612
|
+
"example": "无",
|
3613
|
+
"member": "int64",
|
3614
|
+
"name": "TopicNum",
|
3615
|
+
"output_required": true,
|
3616
|
+
"type": "int",
|
3617
|
+
"value_allowed_null": false
|
3618
|
+
},
|
3619
|
+
{
|
3620
|
+
"disabled": false,
|
3621
|
+
"document": "消费组数量",
|
3622
|
+
"example": "无",
|
3623
|
+
"member": "int64",
|
3624
|
+
"name": "GroupNum",
|
3625
|
+
"output_required": true,
|
3626
|
+
"type": "int",
|
3627
|
+
"value_allowed_null": false
|
3628
|
+
},
|
3629
|
+
{
|
3630
|
+
"disabled": false,
|
3631
|
+
"document": "标签列表\n注意:此字段可能返回 null,表示取不到有效值。",
|
3632
|
+
"example": "无",
|
3633
|
+
"member": "Tag",
|
3634
|
+
"name": "TagList",
|
3635
|
+
"output_required": true,
|
3636
|
+
"type": "list",
|
3637
|
+
"value_allowed_null": true
|
3638
|
+
},
|
3639
|
+
{
|
3640
|
+
"disabled": false,
|
3641
|
+
"document": "商品规格",
|
3642
|
+
"example": "basic_1k",
|
3643
|
+
"member": "string",
|
3644
|
+
"name": "SkuCode",
|
3645
|
+
"output_required": true,
|
3646
|
+
"type": "string",
|
3647
|
+
"value_allowed_null": false
|
3648
|
+
},
|
3649
|
+
{
|
3650
|
+
"disabled": false,
|
3651
|
+
"document": "TPS限流值\n注意:此字段可能返回 null,表示取不到有效值。",
|
3652
|
+
"example": "无",
|
3653
|
+
"member": "int64",
|
3654
|
+
"name": "TpsLimit",
|
3655
|
+
"output_required": true,
|
3656
|
+
"type": "int",
|
3657
|
+
"value_allowed_null": true
|
3658
|
+
},
|
3659
|
+
{
|
3660
|
+
"disabled": false,
|
3661
|
+
"document": "弹性TPS限流值\n注意:此字段可能返回 null,表示取不到有效值。",
|
3662
|
+
"example": "无",
|
3663
|
+
"member": "int64",
|
3664
|
+
"name": "ScaledTpsLimit",
|
3665
|
+
"output_required": true,
|
3666
|
+
"type": "int",
|
3667
|
+
"value_allowed_null": true
|
3668
|
+
},
|
3669
|
+
{
|
3670
|
+
"disabled": false,
|
3671
|
+
"document": "消息保留时间,小时为单位\n注意:此字段可能返回 null,表示取不到有效值。",
|
3672
|
+
"example": "无",
|
3673
|
+
"member": "int64",
|
3674
|
+
"name": "MessageRetention",
|
3675
|
+
"output_required": true,
|
3676
|
+
"type": "int",
|
3677
|
+
"value_allowed_null": true
|
3678
|
+
},
|
3679
|
+
{
|
3680
|
+
"disabled": false,
|
3681
|
+
"document": "延迟消息最大时长,小时为单位\n注意:此字段可能返回 null,表示取不到有效值。",
|
3682
|
+
"example": "无",
|
3683
|
+
"member": "int64",
|
3684
|
+
"name": "MaxMessageDelay",
|
3685
|
+
"output_required": true,
|
3686
|
+
"type": "int",
|
3687
|
+
"value_allowed_null": true
|
3688
|
+
},
|
3689
|
+
{
|
3690
|
+
"disabled": false,
|
3691
|
+
"document": "是否自动续费\n注意:此字段可能返回 null,表示取不到有效值。",
|
3692
|
+
"example": "无",
|
3693
|
+
"member": "int64",
|
3694
|
+
"name": "RenewFlag",
|
3695
|
+
"output_required": false,
|
3696
|
+
"type": "int",
|
3697
|
+
"value_allowed_null": true
|
3698
|
+
},
|
3699
|
+
{
|
3700
|
+
"disabled": false,
|
3701
|
+
"document": "4.x独有数据\n注意:此字段可能返回 null,表示取不到有效值。",
|
3702
|
+
"example": "无",
|
3703
|
+
"member": "InstanceItemExtraInfo",
|
3704
|
+
"name": "InstanceItemExtraInfo",
|
3705
|
+
"output_required": false,
|
3706
|
+
"type": "object",
|
3707
|
+
"value_allowed_null": true
|
3708
|
+
},
|
3709
|
+
{
|
3710
|
+
"disabled": false,
|
3711
|
+
"document": "预销毁时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
3712
|
+
"example": "无",
|
3713
|
+
"member": "int64",
|
3714
|
+
"name": "DestroyTime",
|
3715
|
+
"output_required": false,
|
3716
|
+
"type": "int",
|
3717
|
+
"value_allowed_null": true
|
3718
|
+
}
|
3719
|
+
],
|
3720
|
+
"usage": "out"
|
3721
|
+
},
|
3425
3722
|
"ImportSourceClusterConsumerGroupsRequest": {
|
3426
3723
|
"document": "ImportSourceClusterConsumerGroups请求参数结构体",
|
3427
3724
|
"members": [
|
@@ -3680,6 +3977,102 @@
|
|
3680
3977
|
],
|
3681
3978
|
"usage": "out"
|
3682
3979
|
},
|
3980
|
+
"InstanceItemExtraInfo": {
|
3981
|
+
"document": "4.x集群和5.0集群列表统一显示 4.x特殊数据承载接口",
|
3982
|
+
"members": [
|
3983
|
+
{
|
3984
|
+
"disabled": false,
|
3985
|
+
"document": "是否vip\n注意:此字段可能返回 null,表示取不到有效值。",
|
3986
|
+
"example": "无",
|
3987
|
+
"member": "bool",
|
3988
|
+
"name": "IsVip",
|
3989
|
+
"output_required": false,
|
3990
|
+
"type": "bool",
|
3991
|
+
"value_allowed_null": true
|
3992
|
+
},
|
3993
|
+
{
|
3994
|
+
"disabled": false,
|
3995
|
+
"document": "4.x专享集群状态\n注意:此字段可能返回 null,表示取不到有效值。",
|
3996
|
+
"example": "无",
|
3997
|
+
"member": "int64",
|
3998
|
+
"name": "VipInstanceStatus",
|
3999
|
+
"output_required": false,
|
4000
|
+
"type": "int",
|
4001
|
+
"value_allowed_null": true
|
4002
|
+
},
|
4003
|
+
{
|
4004
|
+
"disabled": false,
|
4005
|
+
"document": "专享集群峰值带宽\n注意:此字段可能返回 null,表示取不到有效值。",
|
4006
|
+
"example": "无",
|
4007
|
+
"member": "int64",
|
4008
|
+
"name": "MaxBandWidth",
|
4009
|
+
"output_required": false,
|
4010
|
+
"type": "int",
|
4011
|
+
"value_allowed_null": true
|
4012
|
+
},
|
4013
|
+
{
|
4014
|
+
"disabled": false,
|
4015
|
+
"document": "专享集群规格\n注意:此字段可能返回 null,表示取不到有效值。",
|
4016
|
+
"example": "无",
|
4017
|
+
"member": "string",
|
4018
|
+
"name": "SpecName",
|
4019
|
+
"output_required": false,
|
4020
|
+
"type": "string",
|
4021
|
+
"value_allowed_null": true
|
4022
|
+
},
|
4023
|
+
{
|
4024
|
+
"disabled": false,
|
4025
|
+
"document": "专享集群节点数量\n注意:此字段可能返回 null,表示取不到有效值。",
|
4026
|
+
"example": "无",
|
4027
|
+
"member": "int64",
|
4028
|
+
"name": "NodeCount",
|
4029
|
+
"output_required": false,
|
4030
|
+
"type": "int",
|
4031
|
+
"value_allowed_null": true
|
4032
|
+
},
|
4033
|
+
{
|
4034
|
+
"disabled": false,
|
4035
|
+
"document": "专享集群最大存储\n注意:此字段可能返回 null,表示取不到有效值。",
|
4036
|
+
"example": "无",
|
4037
|
+
"member": "int64",
|
4038
|
+
"name": "MaxStorage",
|
4039
|
+
"output_required": false,
|
4040
|
+
"type": "int",
|
4041
|
+
"value_allowed_null": true
|
4042
|
+
},
|
4043
|
+
{
|
4044
|
+
"disabled": false,
|
4045
|
+
"document": "专享集群最大保留时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
4046
|
+
"example": "无",
|
4047
|
+
"member": "int64",
|
4048
|
+
"name": "MaxRetention",
|
4049
|
+
"output_required": false,
|
4050
|
+
"type": "int",
|
4051
|
+
"value_allowed_null": true
|
4052
|
+
},
|
4053
|
+
{
|
4054
|
+
"disabled": false,
|
4055
|
+
"document": "专项集群最大保留时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
4056
|
+
"example": "无",
|
4057
|
+
"member": "int64",
|
4058
|
+
"name": "MinRetention",
|
4059
|
+
"output_required": false,
|
4060
|
+
"type": "int",
|
4061
|
+
"value_allowed_null": true
|
4062
|
+
},
|
4063
|
+
{
|
4064
|
+
"disabled": false,
|
4065
|
+
"document": "4.0共享集群\n注意:此字段可能返回 null,表示取不到有效值。",
|
4066
|
+
"example": "无",
|
4067
|
+
"member": "int64",
|
4068
|
+
"name": "InstanceStatus",
|
4069
|
+
"output_required": false,
|
4070
|
+
"type": "int",
|
4071
|
+
"value_allowed_null": true
|
4072
|
+
}
|
4073
|
+
],
|
4074
|
+
"usage": "out"
|
4075
|
+
},
|
3683
4076
|
"IpRule": {
|
3684
4077
|
"document": "IP规则",
|
3685
4078
|
"members": [
|
@@ -150,6 +150,14 @@
|
|
150
150
|
"title": "获取消费组列表"
|
151
151
|
}
|
152
152
|
],
|
153
|
+
"DescribeFusionInstanceList": [
|
154
|
+
{
|
155
|
+
"document": "",
|
156
|
+
"input": "POST / HTTP/1.1\nHost: trocket.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeFusionInstanceList\n<公共请求参数>\n\n{\n \"Filters\": [\n {\n \"Name\": \"abc\",\n \"Values\": [\n \"abc\"\n ]\n }\n ],\n \"TagFilters\": [\n {\n \"TagKey\": \"abc\",\n \"TagValues\": [\n \"abc\"\n ]\n }\n ],\n \"Offset\": 0,\n \"Limit\": 0\n}",
|
157
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"Data\": [\n {\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"Version\": \"abc\",\n \"InstanceType\": \"abc\",\n \"InstanceStatus\": \"abc\",\n \"TopicNumLimit\": 0,\n \"GroupNumLimit\": 0,\n \"PayMode\": \"abc\",\n \"ExpiryTime\": 0,\n \"Remark\": \"abc\",\n \"TopicNum\": 0,\n \"GroupNum\": 0,\n \"TagList\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"SkuCode\": \"abc\",\n \"TpsLimit\": 0,\n \"ScaledTpsLimit\": 0,\n \"MessageRetention\": 0,\n \"MaxMessageDelay\": 0,\n \"RenewFlag\": 0,\n \"InstanceItemExtraInfo\": {\n \"IsVip\": true,\n \"VipInstanceStatus\": 0,\n \"MaxBandWidth\": 0,\n \"SpecName\": \"abc\",\n \"NodeCount\": 0,\n \"MaxStorage\": 0,\n \"MaxRetention\": 0,\n \"MinRetention\": 0,\n \"InstanceStatus\": 0\n },\n \"DestroyTime\": 0\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
158
|
+
"title": "示例"
|
159
|
+
}
|
160
|
+
],
|
153
161
|
"DescribeInstance": [
|
154
162
|
{
|
155
163
|
"document": "查询实例",
|
@@ -29,9 +29,9 @@
|
|
29
29
|
"status": "online"
|
30
30
|
},
|
31
31
|
"DescribeAITranscription": {
|
32
|
-
"document": "查询AI
|
32
|
+
"document": "查询AI转录任务状态。",
|
33
33
|
"input": "DescribeAITranscriptionRequest",
|
34
|
-
"name": "查询AI
|
34
|
+
"name": "查询AI转录任务状态",
|
35
35
|
"output": "DescribeAITranscriptionResponse",
|
36
36
|
"status": "online"
|
37
37
|
},
|
@@ -253,9 +253,9 @@
|
|
253
253
|
"status": "online"
|
254
254
|
},
|
255
255
|
"StartAITranscription": {
|
256
|
-
"document": "
|
256
|
+
"document": "这个接口调用后,后台会启动转录机器人,实时进行语音识别并下发字幕和转录消息。\n转录机器人支持两种拉流方式,通过TranscriptionMode字段控制:\n- 拉取全房间的流。\n- 拉取特定用户的流。\n\n服务端实时下发字幕和会议记录有两种方式,通过IMAdminUserId和IMAdminUserSig字段控制:\n- 如果填写IMAdminUserId和IMAdminUserSig,服务端会调用IM的[发送群组消息](https://cloud.tencent.com/document/product/269/1629)API来向端上实时下发消息。客户端只需监听群组消息的回调即可,比如[web端回调](https://cloud.tencent.com/document/product/269/75319)。\n- 如果不填写IMAdminUserId和IMAdminUserSig,服务端使用TRTC自定义消息通道下发消息,CmdId固定是1。客户端只需监听自定义消息的回调即可,比如[c++回调](https://cloud.tencent.com/document/product/647/79637#4cd82f4edb24992a15a25187089e1565)。\n\n服务端实时下发的消息是JSON字符串,实时字幕具体格式如下:\n`{\n \"type\": \"subtitle\",\n \"userid\": \"xxx\",\n \"text\": \"xxx\",\n \"translation_text\": \"xxx\",\n \"start_time\": \"00:00:02\",\n \"end_time\": \"00:00:05\"\n}`\n字段作用如下:\n- type是subtitle,表示这是实时字幕消息。\n- userid表示是哪个用户说的话。\n- text是语音识别出的文本。\n- translation_text是text翻译后的文本,如果不启用翻译,则是空字符串。\n- start_time和end_time表示该字幕消息从任务开启后的开始和结束时间。\n\n转录消息具体格式如下:\n`{\n \"type\": \"transcription\",\n \"userid\": \"xxx\",\n \"text\": \"xxx\",\n \"translation_text\": \"xx\",\n \"start_time\": \"00:00:02\",\n \"end_time\": \"00:00:05\"\n}`\n字段作用如下:\n- type是transcription,表示这是转录消息。\n- 其余字段同实时字幕消息。\n\n转录消息和实时字幕消息的区别是,转录消息是完整的一句话,实时字幕消息则是这一句话的中间阶段。\n假如有一句完整的话,“今天天气怎么样?”,那么服务的下发消息的顺序可能是这样:\n- 字幕消息,“今天”\n- 字幕消息,“今天天气”\n- 字幕消息,“今天天气怎么样”\n- 转录消息,“今天天气怎么样?”",
|
257
257
|
"input": "StartAITranscriptionRequest",
|
258
|
-
"name": "开始AI
|
258
|
+
"name": "开始AI转录任务",
|
259
259
|
"output": "StartAITranscriptionResponse",
|
260
260
|
"status": "online"
|
261
261
|
},
|
@@ -295,9 +295,9 @@
|
|
295
295
|
"status": "online"
|
296
296
|
},
|
297
297
|
"StopAITranscription": {
|
298
|
-
"document": "停止AI
|
298
|
+
"document": "停止AI转录任务。",
|
299
299
|
"input": "StopAITranscriptionRequest",
|
300
|
-
"name": "停止AI
|
300
|
+
"name": "停止AI转录任务",
|
301
301
|
"output": "StopAITranscriptionResponse",
|
302
302
|
"status": "online"
|
303
303
|
},
|
@@ -337,7 +337,7 @@
|
|
337
337
|
"status": "online"
|
338
338
|
},
|
339
339
|
"SummarizeTranscription": {
|
340
|
-
"document": "
|
340
|
+
"document": "对转录的文本进行总结。",
|
341
341
|
"input": "SummarizeTranscriptionRequest",
|
342
342
|
"name": "总结转录文本",
|
343
343
|
"output": "SummarizeTranscriptionResponse",
|
@@ -977,12 +977,30 @@
|
|
977
977
|
"members": [
|
978
978
|
{
|
979
979
|
"disabled": false,
|
980
|
-
"document": "
|
980
|
+
"document": "查询任务状态,不使用时传入空字符串。\n有两种查询方式:\n1、只填写TaskId,这种方式使用TaskId来查询任务\n2、TaskId为空字符串,填写SdkAppId和SessionId,这种方式不需要使用TaskId查询任务",
|
981
981
|
"example": "无",
|
982
982
|
"member": "string",
|
983
983
|
"name": "TaskId",
|
984
984
|
"required": true,
|
985
985
|
"type": "string"
|
986
|
+
},
|
987
|
+
{
|
988
|
+
"disabled": false,
|
989
|
+
"document": "TRTC的SdkAppId,和SessionId配合使用。",
|
990
|
+
"example": "无",
|
991
|
+
"member": "int64",
|
992
|
+
"name": "SdkAppId",
|
993
|
+
"required": false,
|
994
|
+
"type": "int"
|
995
|
+
},
|
996
|
+
{
|
997
|
+
"disabled": false,
|
998
|
+
"document": "开启转录任务时传入的SessionId,和SdkAppId配合使用。",
|
999
|
+
"example": "无",
|
1000
|
+
"member": "string",
|
1001
|
+
"name": "SessionId",
|
1002
|
+
"required": false,
|
1003
|
+
"type": "string"
|
986
1004
|
}
|
987
1005
|
],
|
988
1006
|
"type": "object"
|
@@ -992,7 +1010,7 @@
|
|
992
1010
|
"members": [
|
993
1011
|
{
|
994
1012
|
"disabled": false,
|
995
|
-
"document": "
|
1013
|
+
"document": "任务开始时间。",
|
996
1014
|
"example": "无",
|
997
1015
|
"member": "string",
|
998
1016
|
"name": "StartTime",
|
@@ -1002,7 +1020,7 @@
|
|
1002
1020
|
},
|
1003
1021
|
{
|
1004
1022
|
"disabled": false,
|
1005
|
-
"document": "
|
1023
|
+
"document": "转录任务状态。\n有4个值:\n1、Idle表示任务未开始\n2、Preparing表示任务准备中\n3、InProgress表示任务正在运行\n4、Stopped表示任务已停止,正在清理资源中",
|
1006
1024
|
"example": "无",
|
1007
1025
|
"member": "string",
|
1008
1026
|
"name": "Status",
|
@@ -1010,6 +1028,26 @@
|
|
1010
1028
|
"type": "string",
|
1011
1029
|
"value_allowed_null": false
|
1012
1030
|
},
|
1031
|
+
{
|
1032
|
+
"disabled": false,
|
1033
|
+
"document": "唯一标识一次任务。",
|
1034
|
+
"example": "无",
|
1035
|
+
"member": "string",
|
1036
|
+
"name": "TaskId",
|
1037
|
+
"output_required": false,
|
1038
|
+
"type": "string",
|
1039
|
+
"value_allowed_null": false
|
1040
|
+
},
|
1041
|
+
{
|
1042
|
+
"disabled": false,
|
1043
|
+
"document": "开启转录任务时填写的SessionId,如果没写则不返回。",
|
1044
|
+
"example": "无",
|
1045
|
+
"member": "string",
|
1046
|
+
"name": "SessionId",
|
1047
|
+
"output_required": false,
|
1048
|
+
"type": "string",
|
1049
|
+
"value_allowed_null": false
|
1050
|
+
},
|
1013
1051
|
{
|
1014
1052
|
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
1015
1053
|
"member": "string",
|
@@ -4688,8 +4726,8 @@
|
|
4688
4726
|
"members": [
|
4689
4727
|
{
|
4690
4728
|
"disabled": false,
|
4691
|
-
"document": "
|
4692
|
-
"example": "
|
4729
|
+
"document": "语音识别支持的语言,默认是\"zh\"。目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes):\nChinese = \"zh\"\nChinese_TW = \"zh-TW\" \nEnglish = \"en\"\nVietnamese = \"vi\"\nJapanese = \"ja\"\nKorean = \"ko\"\nIndonesia = \"id\"\nThai = \"th\"\nPortuguese = \"pt\"\nTurkish = \"tr\"\nArabic = \"ar\"\nSpanish = \"es\"\nHindi = \"hi\"\nFrench = \"fr\"\nMalay = \"ms\"\nFilipino = \"fil\"\nGerman = \"de\"\nItalian = \"it\"\nRussian = \"ru\"\n\n注意:\n如果缺少满足您需求的语言,请联系我们技术人员。\ntencent asr不支持\"it\"和\"ru\",google asr全都支持。",
|
4730
|
+
"example": "zh",
|
4693
4731
|
"member": "string",
|
4694
4732
|
"name": "Language",
|
4695
4733
|
"required": false,
|
@@ -4697,8 +4735,17 @@
|
|
4697
4735
|
},
|
4698
4736
|
{
|
4699
4737
|
"disabled": false,
|
4700
|
-
"document": "
|
4701
|
-
"example": "
|
4738
|
+
"document": "使用的模型,目前支持tencent和google,默认是tencent。",
|
4739
|
+
"example": "tencent",
|
4740
|
+
"member": "string",
|
4741
|
+
"name": "Model",
|
4742
|
+
"required": false,
|
4743
|
+
"type": "string"
|
4744
|
+
},
|
4745
|
+
{
|
4746
|
+
"disabled": false,
|
4747
|
+
"document": "翻译功能支持的语言,如果填写,则会启用翻译,不填则只会使用语音识别。\n目前全量支持的语言如下,等号左面是语言英文名,右面是Language字段需要填写的值,该值遵循[ISO639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes):\nChinese = \"zh\"\nChinese_TW = \"zh-TW\" \nEnglish = \"en\"\nVietnamese = \"vi\"\nJapanese = \"ja\"\nKorean = \"ko\"\nIndonesia = \"id\"\nThai = \"th\"\nPortuguese = \"pt\"\nTurkish = \"tr\"\nArabic = \"ar\"\nSpanish = \"es\"\nHindi = \"hi\"\nFrench = \"fr\"\nMalay = \"ms\"\nFilipino = \"fil\"\nGerman = \"de\"\nItalian = \"it\"\nRussian = \"ru\"\n\n注意:\n如果缺少满足您需求的语言,请联系我们技术人员。\ngoogle支持上述语言两两之间翻译,tencent只支持部分语言之间翻译。\n\ntencnet目标语言,各源语言的目标语言支持列表如下,冒号左侧是目标语言,右侧是源语言:\n- zh(简体中文):zh-TW(繁体中文)、en(英语)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)\n- zh-TW(繁体中文):zh(简体中文)、en(英语)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)\n- en(英语):zh(中文)、zh-TW(繁体中文)、ja(日语)、ko(韩语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)、vi(越南语)、id(印尼语)、th(泰语)、ms(马来语)、ar(阿拉伯语)、hi(印地语)\n- ja(日语):zh(中文)、zh-TW(繁体中文)、en(英语)、ko(韩语)\n- ko(韩语):zh(中文)、zh-TW(繁体中文)、en(英语)、ja(日语)\n- fr(法语):zh(中文)、zh-TW(繁体中文)、en(英语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)\n- es(西班牙语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)\n- it(意大利语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、de(德语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)\n- de(德语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、tr(土耳其语)、ru(俄语)、pt(葡萄牙语)\n- tr(土耳其语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、ru(俄语)、pt(葡萄牙语)\n- ru(俄语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、pt(葡萄牙语)\n- pt(葡萄牙语):zh(中文)、zh-TW(繁体中文)、en(英语)、fr(法语)、es(西班牙语)、it(意大利语)、de(德语)、tr(土耳其语)、ru(俄语)\n- vi(越南语):zh(中文)、zh-TW(繁体中文)、en(英语)\n- id(印尼语):zh(中文)、zh-TW(繁体中文)、en(英语)\n- th(泰语):zh(中文)、zh-TW(繁体中文)、en(英语)\n- ms(马来语):zh(中文)、zh-TW(繁体中文)、en(英语)\n- ar(阿拉伯语):en(英语)\n- hi(印地语):en(英语)",
|
4748
|
+
"example": "en",
|
4702
4749
|
"member": "string",
|
4703
4750
|
"name": "TranslationLanguage",
|
4704
4751
|
"required": false,
|
@@ -5300,7 +5347,7 @@
|
|
5300
5347
|
"members": [
|
5301
5348
|
{
|
5302
5349
|
"disabled": false,
|
5303
|
-
"document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)
|
5350
|
+
"document": "TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。",
|
5304
5351
|
"example": "无",
|
5305
5352
|
"member": "uint64",
|
5306
5353
|
"name": "SdkAppId",
|
@@ -5309,7 +5356,7 @@
|
|
5309
5356
|
},
|
5310
5357
|
{
|
5311
5358
|
"disabled": false,
|
5312
|
-
"document": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)
|
5359
|
+
"document": "TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启转录任务的房间号。",
|
5313
5360
|
"example": "无",
|
5314
5361
|
"member": "string",
|
5315
5362
|
"name": "RoomId",
|
@@ -5318,13 +5365,22 @@
|
|
5318
5365
|
},
|
5319
5366
|
{
|
5320
5367
|
"disabled": false,
|
5321
|
-
"document": "
|
5368
|
+
"document": "转录机器人的参数。",
|
5322
5369
|
"example": "无",
|
5323
5370
|
"member": "TranscriptionParams",
|
5324
5371
|
"name": "TranscriptionParams",
|
5325
5372
|
"required": true,
|
5326
5373
|
"type": "object"
|
5327
5374
|
},
|
5375
|
+
{
|
5376
|
+
"disabled": false,
|
5377
|
+
"document": "调用方传入的唯一Id,服务端用来去重。\n注意:\n如果传入该参数,服务端优先使用该参数来去重。\n如果不传该参数,服务端的去重策略如下:\n- 如果TranscriptionMode字段是0,则一个房间只能开启一个任务\n- 如果TranscriptionMode字段是1,则一个TargetUserId只能开启一个任务",
|
5378
|
+
"example": "无",
|
5379
|
+
"member": "string",
|
5380
|
+
"name": "SessionId",
|
5381
|
+
"required": false,
|
5382
|
+
"type": "string"
|
5383
|
+
},
|
5328
5384
|
{
|
5329
5385
|
"disabled": false,
|
5330
5386
|
"document": "TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。",
|
@@ -5336,7 +5392,7 @@
|
|
5336
5392
|
},
|
5337
5393
|
{
|
5338
5394
|
"disabled": false,
|
5339
|
-
"document": "
|
5395
|
+
"document": "语音识别配置。",
|
5340
5396
|
"example": "无",
|
5341
5397
|
"member": "RecognizeConfig",
|
5342
5398
|
"name": "RecognizeConfig",
|