tccli 3.0.827.1__py2.py3-none-any.whl → 3.0.829.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 (46) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/autoscaling/v20180419/api.json +14 -14
  3. tccli/services/cam/v20190116/api.json +16 -9
  4. tccli/services/cam/v20190116/examples.json +2 -2
  5. tccli/services/cdn/v20180606/api.json +6 -6
  6. tccli/services/cdn/v20180606/examples.json +4 -4
  7. tccli/services/cloudstudio/cloudstudio_client.py +53 -0
  8. tccli/services/cloudstudio/v20210524/api.json +89 -0
  9. tccli/services/cloudstudio/v20210524/examples.json +8 -0
  10. tccli/services/cvm/v20170312/api.json +1 -1
  11. tccli/services/ess/v20201111/api.json +9 -0
  12. tccli/services/ess/v20201111/examples.json +1 -1
  13. tccli/services/essbasic/v20210526/api.json +134 -383
  14. tccli/services/essbasic/v20210526/examples.json +89 -95
  15. tccli/services/faceid/v20180301/api.json +19 -33
  16. tccli/services/ic/v20190307/api.json +1 -1
  17. tccli/services/ims/ims_client.py +53 -0
  18. tccli/services/ims/v20200713/api.json +3 -23
  19. tccli/services/ims/v20200713/examples.json +2 -2
  20. tccli/services/ims/v20201229/api.json +107 -2
  21. tccli/services/ims/v20201229/examples.json +10 -2
  22. tccli/services/live/v20180801/api.json +2 -6
  23. tccli/services/live/v20180801/examples.json +1 -1
  24. tccli/services/mongodb/v20190725/api.json +50 -51
  25. tccli/services/mongodb/v20190725/examples.json +1 -1
  26. tccli/services/mrs/v20200910/api.json +8130 -2302
  27. tccli/services/mrs/v20200910/examples.json +1 -1
  28. tccli/services/ocr/v20181119/api.json +32 -134
  29. tccli/services/ocr/v20181119/examples.json +15 -15
  30. tccli/services/pts/v20210728/api.json +27 -78
  31. tccli/services/sqlserver/v20180328/api.json +5 -5
  32. tccli/services/sslpod/v20190605/api.json +1 -1
  33. tccli/services/tem/v20210701/api.json +1 -1
  34. tccli/services/tione/v20191022/api.json +1 -1
  35. tccli/services/tione/v20211111/api.json +1 -1
  36. tccli/services/tke/v20180525/api.json +26 -32
  37. tccli/services/tke/v20180525/examples.json +9 -9
  38. tccli/services/trtc/v20190722/api.json +3 -25
  39. tccli/services/vpc/v20170312/api.json +60 -51
  40. tccli/services/vpc/v20170312/examples.json +17 -17
  41. {tccli-3.0.827.1.dist-info → tccli-3.0.829.1.dist-info}/METADATA +2 -2
  42. {tccli-3.0.827.1.dist-info → tccli-3.0.829.1.dist-info}/RECORD +46 -46
  43. {tccli-3.0.827.1.dist-info → tccli-3.0.829.1.dist-info}/LICENSE +0 -0
  44. {tccli-3.0.827.1.dist-info → tccli-3.0.829.1.dist-info}/WHEEL +0 -0
  45. {tccli-3.0.827.1.dist-info → tccli-3.0.829.1.dist-info}/entry_points.txt +0 -0
  46. {tccli-3.0.827.1.dist-info → tccli-3.0.829.1.dist-info}/top_level.txt +0 -0
@@ -165,7 +165,7 @@
165
165
  "metadata": {
166
166
  "apiVersion": "2019-10-22",
167
167
  "api_brief": "介绍如何使用API对腾讯云 TI 平台 TI-ONE 进行操作,包括存储库、Notebook、任务训练等。",
168
- "serviceNameCN": "腾讯云 TI 平台 TI-ONE",
168
+ "serviceNameCN": "TI-ONE 训练平台",
169
169
  "serviceShortName": "tione"
170
170
  },
171
171
  "objects": {
@@ -389,7 +389,7 @@
389
389
  "metadata": {
390
390
  "apiVersion": "2021-11-11",
391
391
  "api_brief": "介绍如何使用API对腾讯云 TI 平台 TI-ONE 进行操作,包括存储库、Notebook、任务训练等。",
392
- "serviceNameCN": "腾讯云 TI 平台 TI-ONE",
392
+ "serviceNameCN": "TI-ONE 训练平台",
393
393
  "serviceShortName": "tione"
394
394
  },
395
395
  "objects": {
@@ -687,7 +687,7 @@
687
687
  "status": "online"
688
688
  },
689
689
  "DescribeEdgeLogSwitches": {
690
- "document": "获取事件、审计和日志的状态接口",
690
+ "document": "获取事件、审计和日志的状态",
691
691
  "input": "DescribeEdgeLogSwitchesRequest",
692
692
  "name": "查询边缘集群日志开关列表",
693
693
  "output": "DescribeEdgeLogSwitchesResponse",
@@ -5260,24 +5260,24 @@
5260
5260
  "document": "CreateEdgeLogConfig请求参数结构体",
5261
5261
  "members": [
5262
5262
  {
5263
- "default": "",
5264
5263
  "document": "集群ID",
5264
+ "example": "cls-1234abcd",
5265
5265
  "member": "string",
5266
5266
  "name": "ClusterId",
5267
5267
  "required": true,
5268
5268
  "type": "string"
5269
5269
  },
5270
5270
  {
5271
- "default": "",
5272
5271
  "document": "日志采集配置的json表达",
5272
+ "example": "{\"apiVersion\":\"cls.cloud.tencent.com/v1\",\"kind\":\"LogConfig\",\"metadata\":{\"name\":\"test\"}...}",
5273
5273
  "member": "string",
5274
5274
  "name": "LogConfig",
5275
5275
  "required": true,
5276
5276
  "type": "string"
5277
5277
  },
5278
5278
  {
5279
- "default": "",
5280
5279
  "document": "CLS日志集ID",
5280
+ "example": "24804f51-0686-4e9f-a95b-2cc47ba5728b",
5281
5281
  "member": "string",
5282
5282
  "name": "LogsetId",
5283
5283
  "required": false,
@@ -6643,16 +6643,16 @@
6643
6643
  "document": "DeleteEdgeCVMInstances请求参数结构体",
6644
6644
  "members": [
6645
6645
  {
6646
- "default": "",
6647
6646
  "document": "集群ID",
6647
+ "example": "cls-1234abcd",
6648
6648
  "member": "string",
6649
6649
  "name": "ClusterID",
6650
6650
  "required": true,
6651
6651
  "type": "string"
6652
6652
  },
6653
6653
  {
6654
- "default": "",
6655
6654
  "document": "cvm id集合",
6655
+ "example": "[\"cvm-1234abcd\"]",
6656
6656
  "member": "string",
6657
6657
  "name": "CvmIdSet",
6658
6658
  "required": true,
@@ -6677,16 +6677,16 @@
6677
6677
  "document": "DeleteEdgeClusterInstances请求参数结构体",
6678
6678
  "members": [
6679
6679
  {
6680
- "default": "",
6681
6680
  "document": "集群ID",
6681
+ "example": "cls-1234abcd",
6682
6682
  "member": "string",
6683
6683
  "name": "ClusterId",
6684
6684
  "required": true,
6685
6685
  "type": "string"
6686
6686
  },
6687
6687
  {
6688
- "default": "",
6689
6688
  "document": "待删除实例ID数组",
6689
+ "example": "[\"cvm-445sgw23\"]",
6690
6690
  "member": "string",
6691
6691
  "name": "InstanceIds",
6692
6692
  "required": true,
@@ -9347,7 +9347,6 @@
9347
9347
  "document": "DescribeEdgeLogSwitches请求参数结构体",
9348
9348
  "members": [
9349
9349
  {
9350
- "default": "",
9351
9350
  "document": "集群ID列表",
9352
9351
  "example": "[\"cls-xxx1\",\"cls-xxx2\"]",
9353
9352
  "member": "string",
@@ -9366,7 +9365,6 @@
9366
9365
  "example": "[{\"ClusterId\":\"cls-xxx1\",\"Audit\":{\"Enable\":true,\"TopicSet\":\"xxxx",
9367
9366
  "member": "string",
9368
9367
  "name": "SwitchSet",
9369
- "required": true,
9370
9368
  "type": "list",
9371
9369
  "value_allowed_null": true
9372
9370
  },
@@ -11107,7 +11105,6 @@
11107
11105
  "document": "DescribeTKEEdgeClusterCredential请求参数结构体",
11108
11106
  "members": [
11109
11107
  {
11110
- "default": "",
11111
11108
  "document": "集群Id",
11112
11109
  "example": "cls-xxxxxx",
11113
11110
  "member": "string",
@@ -11126,7 +11123,6 @@
11126
11123
  "example": "无",
11127
11124
  "member": "IPAddress",
11128
11125
  "name": "Addresses",
11129
- "required": true,
11130
11126
  "type": "list",
11131
11127
  "value_allowed_null": true
11132
11128
  },
@@ -11135,7 +11131,6 @@
11135
11131
  "example": "无",
11136
11132
  "member": "ClusterCredential",
11137
11133
  "name": "Credential",
11138
- "required": true,
11139
11134
  "type": "object",
11140
11135
  "value_allowed_null": false
11141
11136
  },
@@ -11144,7 +11139,6 @@
11144
11139
  "example": "无",
11145
11140
  "member": "EdgeClusterPublicLB",
11146
11141
  "name": "PublicLB",
11147
- "required": true,
11148
11142
  "type": "object",
11149
11143
  "value_allowed_null": false
11150
11144
  },
@@ -11153,7 +11147,6 @@
11153
11147
  "example": "无",
11154
11148
  "member": "EdgeClusterInternalLB",
11155
11149
  "name": "InternalLB",
11156
- "required": true,
11157
11150
  "type": "object",
11158
11151
  "value_allowed_null": false
11159
11152
  },
@@ -11162,7 +11155,6 @@
11162
11155
  "example": "yes",
11163
11156
  "member": "string",
11164
11157
  "name": "CoreDns",
11165
- "required": true,
11166
11158
  "type": "string",
11167
11159
  "value_allowed_null": false
11168
11160
  },
@@ -11171,7 +11163,6 @@
11171
11163
  "example": "yes",
11172
11164
  "member": "string",
11173
11165
  "name": "HealthRegion",
11174
- "required": true,
11175
11166
  "type": "string",
11176
11167
  "value_allowed_null": false
11177
11168
  },
@@ -11180,7 +11171,6 @@
11180
11171
  "example": "yes",
11181
11172
  "member": "string",
11182
11173
  "name": "Health",
11183
- "required": true,
11184
11174
  "type": "string",
11185
11175
  "value_allowed_null": false
11186
11176
  },
@@ -11189,7 +11179,6 @@
11189
11179
  "example": "yes",
11190
11180
  "member": "string",
11191
11181
  "name": "GridDaemon",
11192
- "required": true,
11193
11182
  "type": "string",
11194
11183
  "value_allowed_null": false
11195
11184
  },
@@ -11941,7 +11930,6 @@
11941
11930
  "document": "边缘计算集群信息",
11942
11931
  "members": [
11943
11932
  {
11944
- "default": "",
11945
11933
  "document": "集群Id",
11946
11934
  "example": "cls-xxxxxxxx",
11947
11935
  "member": "string",
@@ -11951,7 +11939,6 @@
11951
11939
  "value_allowed_null": false
11952
11940
  },
11953
11941
  {
11954
- "default": "",
11955
11942
  "document": "集群名称",
11956
11943
  "example": "test",
11957
11944
  "member": "string",
@@ -11961,7 +11948,6 @@
11961
11948
  "value_allowed_null": false
11962
11949
  },
11963
11950
  {
11964
- "default": "",
11965
11951
  "document": "Vpc Id",
11966
11952
  "example": "vpc-xxxxxxxx",
11967
11953
  "member": "string",
@@ -11971,7 +11957,6 @@
11971
11957
  "value_allowed_null": false
11972
11958
  },
11973
11959
  {
11974
- "default": "",
11975
11960
  "document": "集群pod cidr",
11976
11961
  "example": "10.0.0.1/16",
11977
11962
  "member": "string",
@@ -11981,7 +11966,6 @@
11981
11966
  "value_allowed_null": false
11982
11967
  },
11983
11968
  {
11984
- "default": "",
11985
11969
  "document": "集群 service cidr",
11986
11970
  "example": "10.1.1.1/16",
11987
11971
  "member": "string",
@@ -11991,7 +11975,6 @@
11991
11975
  "value_allowed_null": false
11992
11976
  },
11993
11977
  {
11994
- "default": "",
11995
11978
  "document": "k8s 版本号",
11996
11979
  "example": "1.20.6",
11997
11980
  "member": "string",
@@ -12001,7 +11984,6 @@
12001
11984
  "value_allowed_null": false
12002
11985
  },
12003
11986
  {
12004
- "default": "",
12005
11987
  "document": "集群状态",
12006
11988
  "example": "Running",
12007
11989
  "member": "string",
@@ -12011,7 +11993,6 @@
12011
11993
  "value_allowed_null": false
12012
11994
  },
12013
11995
  {
12014
- "default": "",
12015
11996
  "document": "集群描述信息",
12016
11997
  "example": "test",
12017
11998
  "member": "string",
@@ -12021,7 +12002,6 @@
12021
12002
  "value_allowed_null": false
12022
12003
  },
12023
12004
  {
12024
- "default": "",
12025
12005
  "document": "集群创建时间",
12026
12006
  "example": "2022-08-09 16:54:33",
12027
12007
  "member": "string",
@@ -12031,7 +12011,6 @@
12031
12011
  "value_allowed_null": false
12032
12012
  },
12033
12013
  {
12034
- "default": "",
12035
12014
  "document": "边缘集群版本",
12036
12015
  "example": "2.2",
12037
12016
  "member": "string",
@@ -12041,7 +12020,6 @@
12041
12020
  "value_allowed_null": false
12042
12021
  },
12043
12022
  {
12044
- "default": "",
12045
12023
  "document": "节点最大Pod数\n注意:此字段可能返回 null,表示取不到有效值。",
12046
12024
  "example": "61",
12047
12025
  "member": "int64",
@@ -12051,7 +12029,6 @@
12051
12029
  "value_allowed_null": true
12052
12030
  },
12053
12031
  {
12054
- "default": "",
12055
12032
  "document": "集群高级设置\n注意:此字段可能返回 null,表示取不到有效值。",
12056
12033
  "example": "ClusterAdvancedSettings",
12057
12034
  "member": "EdgeClusterAdvancedSettings",
@@ -12061,7 +12038,6 @@
12061
12038
  "value_allowed_null": true
12062
12039
  },
12063
12040
  {
12064
- "default": "",
12065
12041
  "document": "边缘容器集群级别\n注意:此字段可能返回 null,表示取不到有效值。",
12066
12042
  "example": "L5",
12067
12043
  "member": "string",
@@ -12069,6 +12045,24 @@
12069
12045
  "required": false,
12070
12046
  "type": "string",
12071
12047
  "value_allowed_null": true
12048
+ },
12049
+ {
12050
+ "document": "是否支持自动提升集群配置\n注意:此字段可能返回 null,表示取不到有效值。",
12051
+ "example": "true",
12052
+ "member": "bool",
12053
+ "name": "AutoUpgradeClusterLevel",
12054
+ "required": false,
12055
+ "type": "bool",
12056
+ "value_allowed_null": true
12057
+ },
12058
+ {
12059
+ "document": "集群付费模式,支持POSTPAID_BY_HOUR或者PREPAID\n注意:此字段可能返回 null,表示取不到有效值。",
12060
+ "example": "POSTPAID_BY_HOUR",
12061
+ "member": "string",
12062
+ "name": "ChargeType",
12063
+ "required": false,
12064
+ "type": "string",
12065
+ "value_allowed_null": true
12072
12066
  }
12073
12067
  ],
12074
12068
  "usage": "both"
@@ -190,8 +190,8 @@
190
190
  ],
191
191
  "CreateEdgeLogConfig": [
192
192
  {
193
- "document": "",
194
- "input": "https://tke.tencentcloudapi.com/?Action=CreateEdgeLogConfig\n&LogConfig=xxxxxx\n&ClusterId=xxxxx\n&<公共请求参数>",
193
+ "document": "创建边缘集群日志采集规则",
194
+ "input": "https://tke.tencentcloudapi.com/?Action=CreateEdgeLogConfig\n&LogConfig={\"apiVersion\":\"cls.cloud.tencent.com/v1\",\"kind\":\"LogConfig\"... }\n&ClusterId=cls-1234abcd\n&<公共请求参数>",
195
195
  "output": "{\n \"Response\": {\n \"RequestId\": \"f12a6e20-f950-4af9-8f8b-b6329a4961c2\"\n }\n}",
196
196
  "title": "创建日志采集规则"
197
197
  }
@@ -403,15 +403,15 @@
403
403
  "DeleteEdgeCVMInstances": [
404
404
  {
405
405
  "document": "删除边缘容器CVM实例",
406
- "input": "https://tke.tencentcloudapi.com/?Action=DeleteEdgeCVMInstances\n&ClusterID=cls-xxxxx\n&CvmIdSet.0=ecm-xxxxx\n&<公共请求参数>",
406
+ "input": "https://tke.tencentcloudapi.com/?Action=DeleteEdgeCVMInstances\n&ClusterID=cls-1234abcd\n&CvmIdSet.0=cvm-gdf53454\n&<公共请求参数>",
407
407
  "output": "{\n \"Response\": {\n \"RequestId\": \"187c16d5-1f53-4e88-b684-077f0c7369b2\"\n }\n}",
408
408
  "title": "删除边缘容器CVM实例"
409
409
  }
410
410
  ],
411
411
  "DeleteEdgeClusterInstances": [
412
412
  {
413
- "document": "",
414
- "input": "https://tke.tencentcloudapi.com/?Action=DeleteEdgeClusterInstances\r\n&ClusterId=cls-xxxxx\r\n&InstanceIds.0=xxxx\r\n&<公共请求参数>",
413
+ "document": "删除边缘集群计算节点",
414
+ "input": "https://tke.tencentcloudapi.com/?Action=DeleteEdgeClusterInstances\n&ClusterId=cls-1234abcd\n&InstanceIds.0=cvm-xgj3ca32\n&<公共请求参数>",
415
415
  "output": "{\n \"Response\": {\n \"RequestId\": \"187c16d5-1f53-4e88-b684-077f0c7369b2\"\n }\n}",
416
416
  "title": "删除边缘计算实例"
417
417
  }
@@ -810,9 +810,9 @@
810
810
  ],
811
811
  "DescribeEdgeLogSwitches": [
812
812
  {
813
- "document": "",
813
+ "document": "边缘集群日志开关",
814
814
  "input": "POST / HTTP/1.1\nHost: tke.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeEdgeLogSwitches\n<公共请求参数>\n\n{\n \"ClusterIds\": [\n \"cls-xxx1\",\n \"cls-xxx2\"\n ]\n}",
815
- "output": "{\r\n \"Response\":{\r\n \"SwitchSet\":[\r\n {\r\n \"ClusterId\":\"cls-xxx1\",\r\n \"Audit\":{\r\n \"Enable\": true,\r\n \"TopicSet\": \"xxxxx\",\r\n \"TopicId\": \"xxxxx\"\r\n },\r\n \"Event\":{\r\n \"Enable\": true,\r\n \"TopicSet\": \"xxxxx\",\r\n \"TopicId\": \"xxxxx\"\r\n },\r\n \"Log\":{\r\n \"Enable\": true,\r\n \"TopicSet\": \"xxxxx\",\r\n \"TopicId\": \"xxxxx\"\r\n }\r\n },\r\n {\r\n \"ClusterId\":\"cls-xxx2\",\r\n \"Audit\":{\r\n \"Enable\": true,\r\n \"TopicSet\": \"xxxxx\",\r\n \"TopicId\": \"xxxxx\"\r\n },\r\n \"Event\":{\r\n \"Enable\": true,\r\n \"TopicSet\": \"xxxxx\",\r\n \"TopicId\": \"xxxxx\"\r\n },\r\n \"Log\":{\r\n \"Enable\": true,\r\n \"TopicSet\": \"xxxxx\",\r\n \"TopicId\": \"xxxxx\"\r\n }\r\n }\r\n ],\r\n \"RequestId\":\"eac6b301-a322-493a-8e36-83b295459397\"\r\n }\r\n}",
815
+ "output": "{\n \"Response\":{\n \"SwitchSet\":[\n {\n \"ClusterId\":\"cls-xxx2\",\n \"Audit\":{\n \"Enable\": true,\n \"TopicSet\": \"a0cd4067-c9a1-a895-907d-03b4025e4f2c\",\n \"TopicId\": \"sadfssfasdf-c9a1-a895-907d-03b4025e4f2c\"\n },\n \"Event\":{\n \"Enable\": true,\n \"TopicSet\": \"sadfssfasdf-564f-a895-907d-03b4025e4f2c\",\n \"TopicId\": \"sadfssfasdf-564f-a895-907d-5465tdtewrt\"\n },\n \"Log\":{\n \"Enable\": true,\n \"TopicSet\": \"3465345-564f-a895-907d-03b4025e4f2c\",\n \"TopicId\": \"6750000-564f-a895-907d-03b4025e4f2c\"\n }\n }\n ],\n \"RequestId\":\"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}",
816
816
  "title": "查询开关列表接口示例"
817
817
  }
818
818
  ],
@@ -1048,8 +1048,8 @@
1048
1048
  ],
1049
1049
  "DescribeTKEEdgeClusterCredential": [
1050
1050
  {
1051
- "document": "",
1052
- "input": "https://tke.tencentcloudapi.com/?Action=DescribeTKEEdgeClusterCredential\n&ClusterId=cls-xxxxxx\n&<公共请求参数>",
1051
+ "document": "获取边缘集群的认证信息,其中包含kubeconfig文件",
1052
+ "input": "https://tke.tencentcloudapi.com/?Action=DescribeTKEEdgeClusterCredential\n&ClusterId=cls-1234abcd\n&<公共请求参数>",
1053
1053
  "output": "{\n \"Response\": {\n \"Addresses\": [\n {\n \"Type\": \"advertise\",\n \"Ip\": \"169.254.128.200\",\n \"Port\": 60002\n },\n {\n \"Type\": \"public\",\n \"Ip\": \"100.98.109.15\",\n \"Port\": 11126\n }\n ],\n \"Credential\": {\n \"CACert\": \"LS0tLS1CRUdJTiBDRVJUSUZJQ0FULQo=\",\n \"Token\": \"WBnCe69iqui0HuEZJ0Yac2hvwxQ1jG0j\"\n },\n \"CoreDns\": \"yes\",\n \"HealthRegion\": \"yes\",\n \"Health\": \"yes\",\n \"GridDaemon\": \"yes\",\n \"PublicLB\": {\n \"Enabled\": true,\n \"AllowFromCidrs\": [\n \"xx\"\n ]\n },\n \"InternalLB\": {\n \"SubnetId\": [\n \"xx\"\n ],\n \"Enabled\": true\n },\n \"RequestId\": \"eac6b301-a322-493a-8e36-83b295459397\"\n }\n}",
1054
1054
  "title": "获取边缘计算集群的接入认证信息"
1055
1055
  }
@@ -3134,7 +3134,6 @@
3134
3134
  "document": "用户自定义混流布局参数列表。",
3135
3135
  "members": [
3136
3136
  {
3137
- "default": "",
3138
3137
  "document": "画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。",
3139
3138
  "example": "100",
3140
3139
  "member": "uint64",
@@ -3144,7 +3143,6 @@
3144
3143
  "value_allowed_null": false
3145
3144
  },
3146
3145
  {
3147
- "default": "",
3148
3146
  "document": "画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。",
3149
3147
  "example": "100",
3150
3148
  "member": "uint64",
@@ -3154,7 +3152,6 @@
3154
3152
  "value_allowed_null": false
3155
3153
  },
3156
3154
  {
3157
- "default": "",
3158
3155
  "document": "画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。",
3159
3156
  "example": "100",
3160
3157
  "member": "uint64",
@@ -3164,7 +3161,6 @@
3164
3161
  "value_allowed_null": false
3165
3162
  },
3166
3163
  {
3167
- "default": "",
3168
3164
  "document": "画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。",
3169
3165
  "example": "100",
3170
3166
  "member": "uint64",
@@ -3174,7 +3170,6 @@
3174
3170
  "value_allowed_null": false
3175
3171
  },
3176
3172
  {
3177
- "default": "",
3178
3173
  "document": "字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。",
3179
3174
  "example": "123",
3180
3175
  "member": "string",
@@ -3184,7 +3179,6 @@
3184
3179
  "value_allowed_null": false
3185
3180
  },
3186
3181
  {
3187
- "default": "",
3188
3182
  "document": "画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。",
3189
3183
  "example": "100",
3190
3184
  "member": "uint64",
@@ -3194,7 +3188,6 @@
3194
3188
  "value_allowed_null": false
3195
3189
  },
3196
3190
  {
3197
- "default": "",
3198
3191
  "document": "0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变;\n\n1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁;\n\n2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景;\n\n3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%;",
3199
3192
  "example": "1",
3200
3193
  "member": "uint64",
@@ -3204,7 +3197,6 @@
3204
3197
  "value_allowed_null": false
3205
3198
  },
3206
3199
  {
3207
- "default": "",
3208
3200
  "document": "对应订阅流的主辅路标识:\n0:主流(默认);\n1:辅流;",
3209
3201
  "example": "1",
3210
3202
  "member": "uint64",
@@ -3214,7 +3206,6 @@
3214
3206
  "value_allowed_null": false
3215
3207
  },
3216
3208
  {
3217
- "default": "",
3218
3209
  "document": "该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。",
3219
3210
  "example": "2",
3220
3211
  "member": "uint64",
@@ -3224,8 +3215,7 @@
3224
3215
  "value_allowed_null": false
3225
3216
  },
3226
3217
  {
3227
- "default": "",
3228
- "document": "下载的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。",
3218
+ "document": "图片的url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。",
3229
3219
  "example": "https://xxxx",
3230
3220
  "member": "string",
3231
3221
  "name": "SubBackgroundImage",
@@ -3237,10 +3227,9 @@
3237
3227
  "usage": "in"
3238
3228
  },
3239
3229
  "MixLayoutParams": {
3240
- "document": "录制的混流布局参数。\n",
3230
+ "document": "录制的混流布局参数。",
3241
3231
  "members": [
3242
3232
  {
3243
- "default": "",
3244
3233
  "document": "布局模式:\n1:悬浮布局;\n2:屏幕分享布局;\n3:九宫格布局(默认);\n4:自定义布局;\n\n悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。\n\n屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。\n\n九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。\n\n自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。",
3245
3234
  "example": "3",
3246
3235
  "member": "uint64",
@@ -3250,7 +3239,6 @@
3250
3239
  "value_allowed_null": false
3251
3240
  },
3252
3241
  {
3253
- "default": "",
3254
3242
  "document": "如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。",
3255
3243
  "example": "无",
3256
3244
  "member": "MixLayout",
@@ -3260,7 +3248,6 @@
3260
3248
  "value_allowed_null": false
3261
3249
  },
3262
3250
  {
3263
- "default": "",
3264
3251
  "document": "录制背景颜色,RGB的颜色表的16进制表示,每个颜色通过8bit长度标识,默认为黑色。比如橙色对应的RGB为 R:255 G:165 B:0, 那么对应的字符串描述为#FFA500,格式规范:‘#‘开头,后面跟固定RGB的颜色值",
3265
3252
  "example": "123",
3266
3253
  "member": "string",
@@ -3270,7 +3257,6 @@
3270
3257
  "value_allowed_null": false
3271
3258
  },
3272
3259
  {
3273
- "default": "",
3274
3260
  "document": "在布局模式为1:悬浮布局和 2:屏幕分享布局时,设定为显示大视频画面的UserId。不填的话:悬浮布局默认是第一个进房间的主播,屏幕分享布局默认是背景色",
3275
3261
  "example": "123",
3276
3262
  "member": "string",
@@ -3280,7 +3266,6 @@
3280
3266
  "value_allowed_null": false
3281
3267
  },
3282
3268
  {
3283
- "default": "",
3284
3269
  "document": "主辅路标识,\n0:主流(默认);\n1:辅流(屏幕分享);\n这个位置的MediaId代表的是对应MaxResolutionUserId的主辅路,MixLayoutList内代表的是自定义用户的主辅路。",
3285
3270
  "example": "0",
3286
3271
  "member": "uint64",
@@ -3290,8 +3275,7 @@
3290
3275
  "value_allowed_null": false
3291
3276
  },
3292
3277
  {
3293
- "default": "",
3294
- "document": "下载的url地址, 只支持jpg, png,大小限制不超过5M。",
3278
+ "document": "图片的url地址, 只支持jpg, png,大小限制不超过5M,url不可包含中文。",
3295
3279
  "example": "https://xxxx",
3296
3280
  "member": "string",
3297
3281
  "name": "BackgroundImageUrl",
@@ -3300,7 +3284,6 @@
3300
3284
  "value_allowed_null": false
3301
3285
  },
3302
3286
  {
3303
- "default": "",
3304
3287
  "document": "设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。",
3305
3288
  "example": "0",
3306
3289
  "member": "uint64",
@@ -3310,7 +3293,6 @@
3310
3293
  "value_allowed_null": false
3311
3294
  },
3312
3295
  {
3313
- "default": "",
3314
3296
  "document": "背景画面宽高比不一致的时候处理方案,与MixLayoufList定义的RenderMode一致。",
3315
3297
  "example": "1",
3316
3298
  "member": "uint64",
@@ -3320,7 +3302,6 @@
3320
3302
  "value_allowed_null": false
3321
3303
  },
3322
3304
  {
3323
- "default": "",
3324
3305
  "document": "子画面占位图url地址, 只支持jpg, png,大小限制不超过5M,宽高比不一致的处理方案同 RenderMode。",
3325
3306
  "example": "https://xxxx",
3326
3307
  "member": "string",
@@ -3330,7 +3311,6 @@
3330
3311
  "value_allowed_null": false
3331
3312
  },
3332
3313
  {
3333
- "default": "",
3334
3314
  "document": "水印布局参数, 最多支持25个。",
3335
3315
  "example": "无",
3336
3316
  "member": "WaterMark",
@@ -3340,7 +3320,6 @@
3340
3320
  "value_allowed_null": false
3341
3321
  },
3342
3322
  {
3343
- "default": "",
3344
3323
  "document": "模板布局下,背景画面宽高比不一致的时候处理方案。自定义布局不生效,与MixLayoufList定义的RenderMode一致。",
3345
3324
  "example": "1",
3346
3325
  "member": "uint64",
@@ -3350,7 +3329,6 @@
3350
3329
  "value_allowed_null": false
3351
3330
  },
3352
3331
  {
3353
- "default": "",
3354
3332
  "document": "屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。",
3355
3333
  "example": "0",
3356
3334
  "member": "uint64",