tencentcloud-sdk-nodejs-tcb 4.1.199 → 4.1.202

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.
@@ -199,198 +199,14 @@ export interface DescribeCloudBaseRunServerVersionRequest {
199
199
  VersionName: string;
200
200
  }
201
201
  /**
202
- * DescribeCloudBaseRunServerVersion返回参数结构体
202
+ * CreateVmInstance返回参数结构体
203
203
  */
204
- export interface DescribeCloudBaseRunServerVersionResponse {
205
- /**
206
- * 版本名称
207
- */
208
- VersionName?: string;
209
- /**
210
- * 备注
211
- */
212
- Remark?: string;
213
- /**
214
- * Dockerfile的路径
215
- */
216
- DockerfilePath?: string;
217
- /**
218
- * DockerBuild的目录
219
- */
220
- BuildDir?: string;
221
- /**
222
- * 请使用CPUSize
223
- */
224
- Cpu?: number;
225
- /**
226
- * 请使用MemSize
227
- */
228
- Mem?: number;
229
- /**
230
- * 副本最小值
231
- */
232
- MinNum?: number;
233
- /**
234
- * 副本最大值
235
- */
236
- MaxNum?: number;
237
- /**
238
- * 策略类型
239
- */
240
- PolicyType?: string;
241
- /**
242
- * 策略阈值
243
- */
244
- PolicyThreshold?: number;
245
- /**
246
- * 环境变量
247
- */
248
- EnvParams?: string;
249
- /**
250
- * 创建时间
251
- */
252
- CreatedTime?: string;
253
- /**
254
- * 更新时间
255
- */
256
- UpdatedTime?: string;
257
- /**
258
- * 版本的IP
259
- */
260
- VersionIP?: string;
261
- /**
262
- * 版本的端口号
263
- */
264
- VersionPort?: number;
265
- /**
266
- * 版本状态
267
- */
268
- Status?: string;
269
- /**
270
- * 代码包的名字
271
- */
272
- PackageName?: string;
273
- /**
274
- * 代码版本的名字
275
- */
276
- PackageVersion?: string;
277
- /**
278
- * 枚举(package/repository/image)
279
- */
280
- UploadType?: string;
281
- /**
282
- * Repo的类型(gitlab/github/coding)
283
- */
284
- RepoType?: string;
285
- /**
286
- * 地址
287
- */
288
- Repo?: string;
289
- /**
290
- * 分支
291
- */
292
- Branch?: string;
293
- /**
294
- * 服务名字
295
- */
296
- ServerName?: string;
297
- /**
298
- * 是否对于外网开放
299
- */
300
- IsPublic?: boolean;
301
- /**
302
- * vpc id
303
- */
304
- VpcId?: string;
305
- /**
306
- * 子网实例id
307
- 注意:此字段可能返回 null,表示取不到有效值。
308
- */
309
- SubnetIds?: Array<string>;
310
- /**
311
- * 日志采集路径
312
- */
313
- CustomLogs?: string;
314
- /**
315
- * 监听端口
316
- */
317
- ContainerPort?: number;
318
- /**
319
- * 延迟多长时间开始健康检查(单位s)
320
- */
321
- InitialDelaySeconds?: number;
322
- /**
323
- * 镜像地址
324
- */
325
- ImageUrl?: string;
326
- /**
327
- * CPU 大小
328
- */
329
- CpuSize?: number;
330
- /**
331
- * MEM 大小
332
- */
333
- MemSize?: number;
334
- /**
335
- * 是否有Dockerfile:0-default has, 1-has, 2-has not
336
- */
337
- HasDockerfile?: number;
338
- /**
339
- * 基础镜像
340
- */
341
- BaseImage?: string;
342
- /**
343
- * 容器启动入口命令
344
- */
345
- EntryPoint?: string;
346
- /**
347
- * 仓库语言
348
- */
349
- RepoLanguage?: string;
350
- /**
351
- * 自动扩缩容策略组
352
- 注意:此字段可能返回 null,表示取不到有效值。
353
- */
354
- PolicyDetail?: Array<HpaPolicy>;
355
- /**
356
- * Tke集群信息
357
- 注意:此字段可能返回 null,表示取不到有效值。
358
- */
359
- TkeClusterInfo?: TkeClusterInfo;
360
- /**
361
- * 版本工作负载类型;deployment/deamonset
362
- */
363
- TkeWorkloadType?: string;
204
+ export interface CreateVmInstanceResponse {
364
205
  /**
365
206
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
366
207
  */
367
208
  RequestId?: string;
368
209
  }
369
- /**
370
- * BindCloudBaseAccessDomain请求参数结构体
371
- */
372
- export interface BindCloudBaseAccessDomainRequest {
373
- /**
374
- * 服务Id,目前是指环境Id
375
- */
376
- ServiceId: string;
377
- /**
378
- * 自定义域名
379
- */
380
- Domain: string;
381
- /**
382
- * 腾讯云证书Id
383
- */
384
- CertId?: string;
385
- /**
386
- * 默认1,1 绑定默认Cdn,2 绑定TcbIngress(不经过cdn),4 绑定自定义cdn
387
- */
388
- BindFlag?: number;
389
- /**
390
- * 自定义cdn cname域名
391
- */
392
- CustomCname?: string;
393
- }
394
210
  /**
395
211
  * ModifyEnvPlan请求参数结构体
396
212
  */
@@ -596,6 +412,72 @@ export interface DescribeMySQLClusterDetailResponse {
596
412
  */
597
413
  RequestId?: string;
598
414
  }
415
+ /**
416
+ * HTTP访问服务路径重写配置
417
+ */
418
+ export interface HTTPServicePathRewrite {
419
+ /**
420
+ * 路径前缀重写。StaticStorePrefix、Prefix只能填一个
421
+ */
422
+ Prefix?: string;
423
+ }
424
+ /**
425
+ * CreateVmInstance请求参数结构体
426
+ */
427
+ export interface CreateVmInstanceRequest {
428
+ /**
429
+ * 环境ID
430
+ */
431
+ EnvId: string;
432
+ /**
433
+ * 服务器类型:
434
+ LightHouse = 轻量云服务器
435
+ CVM = 云服务器
436
+ */
437
+ Type: string;
438
+ /**
439
+ * 轻量云服务器套餐ID。 当Type=LightHouse时必传
440
+ */
441
+ LightHouseBundleId?: string;
442
+ /**
443
+ * 轻量云服务器镜像ID。当Type=LightHouse时必传
444
+ */
445
+ LightHouseBlueprintId?: string;
446
+ /**
447
+ * 服务器别名
448
+ */
449
+ InstanceName?: string;
450
+ /**
451
+ * 登录方式
452
+ */
453
+ LoginConfiguration?: VMLoginConfiguration;
454
+ }
455
+ /**
456
+ * DescribeEnvs请求参数结构体
457
+ */
458
+ export interface DescribeEnvsRequest {
459
+ /**
460
+ * 环境ID,如果传了这个参数则只返回该环境的相关信息
461
+ */
462
+ EnvId?: string;
463
+ /**
464
+ * 指定Channels字段为可见渠道列表或不可见渠道列表
465
+ 如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]
466
+ */
467
+ IsVisible?: boolean;
468
+ /**
469
+ * 渠道列表,代表可见或不可见渠道由IsVisible参数指定
470
+ */
471
+ Channels?: Array<string>;
472
+ /**
473
+ * 分页参数,单页限制个数
474
+ */
475
+ Limit?: number;
476
+ /**
477
+ * 分页参数,偏移量
478
+ */
479
+ Offset?: number;
480
+ }
599
481
  /**
600
482
  * 删除tcb用户返回值
601
483
  */
@@ -650,6 +532,55 @@ export interface DescribeCloudBaseBuildServiceResponse {
650
532
  */
651
533
  RequestId?: string;
652
534
  }
535
+ /**
536
+ * 查询HTTP访问服务输出路由信息
537
+ */
538
+ export interface HTTPServiceRoute {
539
+ /**
540
+ * 路径
541
+ */
542
+ Path?: string;
543
+ /**
544
+ * 路径重写
545
+ */
546
+ PathRewrite?: HTTPServicePathRewrite;
547
+ /**
548
+ * 上游服务类型。SCF: 云函数,CBR: 云托管,STATIC_STORE: 静态托管,WEB_SCF: WEB云函数,LH: Lighthouse
549
+ */
550
+ UpstreamResourceType?: string;
551
+ /**
552
+ * 上游服务名
553
+ */
554
+ UpstreamResourceName?: string;
555
+ /**
556
+ * 是否开启安全域名
557
+ */
558
+ EnableSafeDomain?: boolean;
559
+ /**
560
+ * 是否开启身份认证
561
+ */
562
+ EnableAuth?: boolean;
563
+ /**
564
+ * 是否开启路径透传
565
+ */
566
+ EnablePathTransmission?: boolean;
567
+ /**
568
+ * QPS限频策略
569
+ */
570
+ QPSPolicy?: HTTPServiceRouteQPSPolicy;
571
+ /**
572
+ * 是否开启路由
573
+ */
574
+ Enable?: boolean;
575
+ /**
576
+ * 路由创建时间
577
+ */
578
+ CreateTime?: string;
579
+ /**
580
+ * 路由更新时间
581
+ */
582
+ UpdateTime?: string;
583
+ }
653
584
  /**
654
585
  * DescribeMySQLTaskStatus请求参数结构体
655
586
  */
@@ -668,13 +599,25 @@ export interface DescribeMySQLTaskStatusRequest {
668
599
  TaskName?: string;
669
600
  }
670
601
  /**
671
- * 本类型用于UpdateTable接口中描述待删除索引信息
602
+ * 封禁配置
672
603
  */
673
- export interface DropIndex {
604
+ export interface BanConfig {
605
+ /**
606
+ * ip白名单,支持ipv4、ipv6,支持CIDR
607
+ */
608
+ IpWhiteList?: Array<string>;
674
609
  /**
675
- * 索引名称
610
+ * ip黑名单,支持ipv4、ipv6,支持CIDR
676
611
  */
677
- IndexName?: string;
612
+ IpBlackList?: Array<string>;
613
+ /**
614
+ * 地域白名单(国家英文名)
615
+ */
616
+ CountryWhiteList?: Array<string>;
617
+ /**
618
+ * 地域黑名单(国家英文名)
619
+ */
620
+ CountryBlackList?: Array<string>;
678
621
  }
679
622
  /**
680
623
  * ModifyUser返回参数结构体
@@ -721,18 +664,17 @@ export interface ModifyEnvResponse {
721
664
  RequestId?: string;
722
665
  }
723
666
  /**
724
- * BindCloudBaseAccessDomain返回参数结构体
667
+ * 索引的key值
725
668
  */
726
- export interface BindCloudBaseAccessDomainResponse {
669
+ export interface Indexkey {
727
670
  /**
728
- * 服务Id,目前是指环境Id
729
- 注意:此字段可能返回 null,表示取不到有效值。
671
+ * 键名
730
672
  */
731
- ServiceId?: string;
673
+ Name?: string;
732
674
  /**
733
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
675
+ * 方向:specify 1 for ascending or -1 for descending
734
676
  */
735
- RequestId?: string;
677
+ Direction?: string;
736
678
  }
737
679
  /**
738
680
  * 邮箱smtp配置
@@ -763,6 +705,40 @@ export interface EmailSmtpConfig {
763
705
  */
764
706
  SecurityMode?: string;
765
707
  }
708
+ /**
709
+ * DescribeHTTPServiceRoute请求参数结构体
710
+ */
711
+ export interface DescribeHTTPServiceRouteRequest {
712
+ /**
713
+ * 环境ID
714
+ */
715
+ EnvId: string;
716
+ /**
717
+ * 过滤条件。Key的含义参考对应字段,Value精确匹配。可过滤: Domain、Path、DomainType、UpstreamResourceType。可过滤的Values单条不超过100
718
+ */
719
+ Filters?: Array<Filter>;
720
+ /**
721
+ * 分页偏移量。默认 0
722
+ */
723
+ Offset?: number;
724
+ /**
725
+ * 分页限制。默认20,最大值1000
726
+ */
727
+ Limit?: number;
728
+ }
729
+ /**
730
+ * MongoDB连接器配置
731
+ */
732
+ export interface MongoConnector {
733
+ /**
734
+ * 连接器实例ID
735
+ */
736
+ InstanceId?: string;
737
+ /**
738
+ * MongoDB数据库名
739
+ */
740
+ DatabaseName?: string;
741
+ }
766
742
  /**
767
743
  * DescribeCurveData返回参数结构体
768
744
  */
@@ -868,6 +844,51 @@ export interface ClsInfo {
868
844
  */
869
845
  CreateTime: string;
870
846
  }
847
+ /**
848
+ * 网关版本详情
849
+ */
850
+ export interface GatewayVersionItem {
851
+ /**
852
+ * 版本名
853
+ */
854
+ VersionName: string;
855
+ /**
856
+ * 版本流量权重
857
+ */
858
+ Weight: number;
859
+ /**
860
+ * 创建状态
861
+ */
862
+ Status?: string;
863
+ /**
864
+ * 创建时间
865
+ */
866
+ CreatedTime?: string;
867
+ /**
868
+ * 更新时间
869
+ */
870
+ UpdatedTime?: string;
871
+ /**
872
+ * 构建ID
873
+ */
874
+ BuildId?: number;
875
+ /**
876
+ * 备注
877
+ */
878
+ Remark?: string;
879
+ /**
880
+ * 优先级
881
+ */
882
+ Priority?: number;
883
+ /**
884
+ * 是否默认版本
885
+ */
886
+ IsDefault?: boolean;
887
+ /**
888
+ * 网关版本自定义配置
889
+ */
890
+ CustomConfig?: WxGatewayCustomConfig;
891
+ }
871
892
  /**
872
893
  * DescribeAuthDomains返回参数结构体
873
894
  */
@@ -882,21 +903,21 @@ export interface DescribeAuthDomainsResponse {
882
903
  RequestId?: string;
883
904
  }
884
905
  /**
885
- * ModifyCloudBaseGWAPI请求参数结构体
906
+ * 云主机实例
886
907
  */
887
- export interface ModifyCloudBaseGWAPIRequest {
908
+ export interface VmInstance {
888
909
  /**
889
- * Service ID
910
+ * 实例id
890
911
  */
891
- ServiceId: string;
912
+ InstanceId?: string;
892
913
  /**
893
- * API ID
914
+ * 实例状态
894
915
  */
895
- APIId: string;
916
+ Status?: string;
896
917
  /**
897
- * 选项列表,key取值:domain, path。
918
+ * 实例地域
898
919
  */
899
- Options: Array<CloudBaseOption>;
920
+ Region?: string;
900
921
  }
901
922
  /**
902
923
  * ModifyClsTopic请求参数结构体
@@ -920,6 +941,19 @@ export interface DescribeLoginConfigRequest {
920
941
  */
921
942
  EnvId: string;
922
943
  }
944
+ /**
945
+ * CreateHTTPServiceRoute请求参数结构体
946
+ */
947
+ export interface CreateHTTPServiceRouteRequest {
948
+ /**
949
+ * 环境ID
950
+ */
951
+ EnvId: string;
952
+ /**
953
+ * 域名路由信息
954
+ */
955
+ Domain: HTTPServiceDomainParam;
956
+ }
923
957
  /**
924
958
  * CreateHostingDomain请求参数结构体
925
959
  */
@@ -1013,57 +1047,193 @@ export interface ModifyDatabaseACLRequest {
1013
1047
  AclTag: string;
1014
1048
  }
1015
1049
  /**
1016
- * DestroyStaticStore请求参数结构体
1050
+ * DescribeCloudBaseRunServerVersion返回参数结构体
1017
1051
  */
1018
- export interface DestroyStaticStoreRequest {
1052
+ export interface DescribeCloudBaseRunServerVersionResponse {
1019
1053
  /**
1020
- * 环境ID
1054
+ * 版本名称
1021
1055
  */
1022
- EnvId: string;
1056
+ VersionName?: string;
1023
1057
  /**
1024
- * cdn域名
1058
+ * 备注
1025
1059
  */
1026
- CdnDomain?: string;
1027
- }
1028
- /**
1029
- * TDSQL-C网络信息类型
1030
- */
1031
- export interface MySQLNetDetail {
1060
+ Remark?: string;
1032
1061
  /**
1033
- * 内网地址
1062
+ * Dockerfile的路径
1063
+ */
1064
+ DockerfilePath?: string;
1065
+ /**
1066
+ * DockerBuild的目录
1067
+ */
1068
+ BuildDir?: string;
1069
+ /**
1070
+ * 请使用CPUSize
1071
+ */
1072
+ Cpu?: number;
1073
+ /**
1074
+ * 请使用MemSize
1075
+ */
1076
+ Mem?: number;
1077
+ /**
1078
+ * 副本最小值
1079
+ */
1080
+ MinNum?: number;
1081
+ /**
1082
+ * 副本最大值
1083
+ */
1084
+ MaxNum?: number;
1085
+ /**
1086
+ * 策略类型
1087
+ */
1088
+ PolicyType?: string;
1089
+ /**
1090
+ * 策略阈值
1091
+ */
1092
+ PolicyThreshold?: number;
1093
+ /**
1094
+ * 环境变量
1095
+ */
1096
+ EnvParams?: string;
1097
+ /**
1098
+ * 创建时间
1099
+ */
1100
+ CreatedTime?: string;
1101
+ /**
1102
+ * 更新时间
1103
+ */
1104
+ UpdatedTime?: string;
1105
+ /**
1106
+ * 版本的IP
1107
+ */
1108
+ VersionIP?: string;
1109
+ /**
1110
+ * 版本的端口号
1111
+ */
1112
+ VersionPort?: number;
1113
+ /**
1114
+ * 版本状态
1115
+ */
1116
+ Status?: string;
1117
+ /**
1118
+ * 代码包的名字
1119
+ */
1120
+ PackageName?: string;
1121
+ /**
1122
+ * 代码版本的名字
1123
+ */
1124
+ PackageVersion?: string;
1125
+ /**
1126
+ * 枚举(package/repository/image)
1127
+ */
1128
+ UploadType?: string;
1129
+ /**
1130
+ * Repo的类型(gitlab/github/coding)
1131
+ */
1132
+ RepoType?: string;
1133
+ /**
1134
+ * 地址
1135
+ */
1136
+ Repo?: string;
1137
+ /**
1138
+ * 分支
1139
+ */
1140
+ Branch?: string;
1141
+ /**
1142
+ * 服务名字
1143
+ */
1144
+ ServerName?: string;
1145
+ /**
1146
+ * 是否对于外网开放
1147
+ */
1148
+ IsPublic?: boolean;
1149
+ /**
1150
+ * vpc id
1151
+ */
1152
+ VpcId?: string;
1153
+ /**
1154
+ * 子网实例id
1034
1155
  注意:此字段可能返回 null,表示取不到有效值。
1035
1156
  */
1036
- PrivateNetAddress?: string;
1157
+ SubnetIds?: Array<string>;
1037
1158
  /**
1038
- * 外网地址
1159
+ * 日志采集路径
1160
+ */
1161
+ CustomLogs?: string;
1162
+ /**
1163
+ * 监听端口
1164
+ */
1165
+ ContainerPort?: number;
1166
+ /**
1167
+ * 延迟多长时间开始健康检查(单位s)
1168
+ */
1169
+ InitialDelaySeconds?: number;
1170
+ /**
1171
+ * 镜像地址
1172
+ */
1173
+ ImageUrl?: string;
1174
+ /**
1175
+ * CPU 大小
1176
+ */
1177
+ CpuSize?: number;
1178
+ /**
1179
+ * MEM 大小
1180
+ */
1181
+ MemSize?: number;
1182
+ /**
1183
+ * 是否有Dockerfile:0-default has, 1-has, 2-has not
1184
+ */
1185
+ HasDockerfile?: number;
1186
+ /**
1187
+ * 基础镜像
1188
+ */
1189
+ BaseImage?: string;
1190
+ /**
1191
+ * 容器启动入口命令
1192
+ */
1193
+ EntryPoint?: string;
1194
+ /**
1195
+ * 仓库语言
1196
+ */
1197
+ RepoLanguage?: string;
1198
+ /**
1199
+ * 自动扩缩容策略组
1039
1200
  注意:此字段可能返回 null,表示取不到有效值。
1040
1201
  */
1041
- PubNetAddress?: string;
1202
+ PolicyDetail?: Array<HpaPolicy>;
1042
1203
  /**
1043
- * 网络信息(VPCID/SubnetID)
1204
+ * Tke集群信息
1044
1205
  注意:此字段可能返回 null,表示取不到有效值。
1045
1206
  */
1046
- Net?: string;
1207
+ TkeClusterInfo?: TkeClusterInfo;
1047
1208
  /**
1048
- * 是否开通公网
1209
+ * 版本工作负载类型;deployment/deamonset
1049
1210
  */
1050
- PubNetAccessEnabled?: boolean;
1211
+ TkeWorkloadType?: string;
1212
+ /**
1213
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1214
+ */
1215
+ RequestId?: string;
1216
+ }
1217
+ /**
1218
+ * DescribeGatewayVersions返回参数结构体
1219
+ */
1220
+ export interface DescribeGatewayVersionsResponse {
1051
1221
  /**
1052
- * vpc id
1222
+ * 网关id
1053
1223
  */
1054
- VpcId?: string;
1224
+ GatewayId?: string;
1055
1225
  /**
1056
- * vpc name
1226
+ * 版本总数
1057
1227
  */
1058
- VpcName?: string;
1228
+ TotalCount?: number;
1059
1229
  /**
1060
- * 子网ID
1230
+ * 版本信息详情
1061
1231
  */
1062
- SubnetId?: string;
1232
+ GatewayVersionItems?: Array<GatewayVersionItem>;
1063
1233
  /**
1064
- * 子网名
1234
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1065
1235
  */
1066
- SubnetName?: string;
1236
+ RequestId?: string;
1067
1237
  }
1068
1238
  /**
1069
1239
  * CreateEnvResource请求参数结构体
@@ -1079,21 +1249,17 @@ export interface CreateEnvResourceRequest {
1079
1249
  Resources: Array<string>;
1080
1250
  }
1081
1251
  /**
1082
- * 本类型用于接口中描述待创建索引结构
1252
+ * DescribeVmInstances请求参数结构体
1083
1253
  */
1084
- export interface MgoKeySchema {
1085
- /**
1086
- * 索引字段
1087
- */
1088
- MgoIndexKeys?: Array<MgoIndexKeys>;
1254
+ export interface DescribeVmInstancesRequest {
1089
1255
  /**
1090
- * 是否唯一索引
1256
+ * 环境ID
1091
1257
  */
1092
- MgoIsUnique?: boolean;
1258
+ EnvId: string;
1093
1259
  /**
1094
- * 是否稀疏索引
1260
+ * 服务器类型: LightHouse = 轻量云服务器 CVM = 云服务器
1095
1261
  */
1096
- MgoIsSparse?: boolean;
1262
+ Type: string;
1097
1263
  }
1098
1264
  /**
1099
1265
  * DescribeHostingDomainTask请求参数结构体
@@ -1174,6 +1340,19 @@ export interface BaasPackageInfo {
1174
1340
  */
1175
1341
  IsExternal?: boolean;
1176
1342
  }
1343
+ /**
1344
+ * ModifyHTTPServiceRoute请求参数结构体
1345
+ */
1346
+ export interface ModifyHTTPServiceRouteRequest {
1347
+ /**
1348
+ * 环境ID
1349
+ */
1350
+ EnvId: string;
1351
+ /**
1352
+ * 域名路由信息
1353
+ */
1354
+ Domain: HTTPServiceDomainParam;
1355
+ }
1177
1356
  /**
1178
1357
  * DescribeQuotaData返回参数结构体
1179
1358
  */
@@ -1227,17 +1406,104 @@ export interface CreateMySQLResult {
1227
1406
  TaskId?: string;
1228
1407
  }
1229
1408
  /**
1230
- * http访问服务客户端限频
1409
+ * DescribeHTTPServiceRoute返回参数结构体
1231
1410
  */
1232
- export interface CloudBaseClientQPSPolicy {
1411
+ export interface DescribeHTTPServiceRouteResponse {
1233
1412
  /**
1234
- * UserID 或 ClientIP 或 None,如果为 None 代表不限制
1413
+ * 域名路由信息列表
1235
1414
  */
1236
- LimitBy?: string;
1415
+ Domains?: Array<HTTPServiceDomain>;
1237
1416
  /**
1238
- * 限制值
1417
+ * 自定义接入的源站域名(HTTPService接入层域名)
1239
1418
  */
1240
- LimitValue?: number;
1419
+ OriginDomain?: string;
1420
+ /**
1421
+ * 域名总数,分页查询使用总数判断是否已经拉取到所有数据
1422
+ */
1423
+ TotalCount?: number;
1424
+ /**
1425
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1426
+ */
1427
+ RequestId?: string;
1428
+ }
1429
+ /**
1430
+ * 身份认证源协议连接配置。包含 OAuth 2.0 / OIDC 协议端点(授权端点、令牌端点、用户信息端点、JWKS 端点等)、客户端凭证(ClientId、ClientSecret)、SAML 元数据、请求与响应参数的字段映射等配置信息。OIDC 类型的认证源字段定义参考 https://openid.net/specs/openid-connect-discovery-1_0.html 规范。
1431
+ */
1432
+ export interface ProviderConfig {
1433
+ /**
1434
+ * 身份提供方的唯一标识符(Issuer URL),用于验证 ID Token 中的 iss 字段。仅当 ProviderType 为 OIDC 时需要填写,值通常为第三方 OIDC 服务的根地址,例如:https://accounts.google.com。填写后平台将自动通过 /.well-known/openid-configuration 发现并填充 AuthorizationEndpoint、TokenEndpoint、UserinfoEndpoint、JwksUri 等端点地址。详情参考 OpenID Connect Discovery 标准。
1435
+ 注意:此字段可能返回 null,表示取不到有效值。
1436
+ */
1437
+ Issuer?: string;
1438
+ /**
1439
+ * 第三方身份提供方的 JSON Web Key Set 地址,用于获取公钥以验证 ID Token 签名。仅当 ProviderType 为 OIDC 时需要填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OpenID Connect Discovery 标准。
1440
+ 注意:此字段可能返回 null,表示取不到有效值。
1441
+ */
1442
+ JwksUri?: string;
1443
+ /**
1444
+ * 在第三方身份提供方注册的应用客户端 ID,用于标识当前接入应用。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,可在对应平台的开发者控制台中获取。详情参考 OAuth 2.0 标准。
1445
+ 注意:此字段可能返回 null,表示取不到有效值。
1446
+ */
1447
+ ClientId?: string;
1448
+ /**
1449
+ * 在第三方身份提供方注册的应用客户端密钥,与 ClientId 配合使用,用于在 Token 端点进行身份验证。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,请妥善保管,避免泄露。详情参考 OAuth 2.0 标准。
1450
+ 注意:此字段可能返回 null,表示取不到有效值。
1451
+ */
1452
+ ClientSecret?: string;
1453
+ /**
1454
+ * OAuth 授权完成后第三方平台回调的地址,需与在第三方平台注册的回调地址完全一致,否则授权将失败。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,并需在对应平台的开发者控制台中配置该地址为合法回调地址。详情参考 OAuth 2.0 标准。
1455
+ 注意:此字段可能返回 null,表示取不到有效值。
1456
+ */
1457
+ RedirectUri?: string;
1458
+ /**
1459
+ * 向第三方身份提供方申请的权限范围,多个 scope 之间用空格分隔。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,OIDC 场景下通常至少包含 openid,如需获取用户邮箱或手机号可追加 email、phone 等。若已填写 Issuer 且未指定 Scope,将自动使用 OpenID Connect Discovery 返回的 scopes_supported。详情参考 OAuth 2.0 标准。
1460
+ 注意:此字段可能返回 null,表示取不到有效值。
1461
+ */
1462
+ Scope?: string;
1463
+ /**
1464
+ * 第三方身份提供方的授权端点地址,用于发起 OAuth/OIDC 授权请求,引导用户跳转至第三方登录页面。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
1465
+ 注意:此字段可能返回 null,表示取不到有效值。
1466
+ */
1467
+ AuthorizationEndpoint?: string;
1468
+ /**
1469
+ * 第三方身份提供方的 Token 端点地址,用于通过授权码(code)换取 Access Token 和 ID Token。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
1470
+ 注意:此字段可能返回 null,表示取不到有效值。
1471
+ */
1472
+ TokenEndpoint?: string;
1473
+ /**
1474
+ * 第三方身份提供方的用户信息端点地址,用于通过 Access Token 获取用户的基本信息(如昵称、头像、邮箱等)。当 ProviderType 为 OIDC 或 OAUTH 且需要获取用户详细信息时填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OIDC 标准。
1475
+ 注意:此字段可能返回 null,表示取不到有效值。
1476
+ */
1477
+ UserinfoEndpoint?: string;
1478
+ /**
1479
+ * OAuth/OIDC 授权请求的响应类型,决定授权端点返回的内容。可选值:code(授权码模式,推荐)、token(隐式模式,直接返回 Access Token)、id_token(直接返回 ID Token)。当 ProviderType 为 OIDC 时默认使用 id_token,其他类型默认使用 code。当 ProviderType 为 OIDC 或 OAUTH 时可选填写。详情参考 OAuth 2.0 / OIDC 标准。
1480
+ 注意:此字段可能返回 null,表示取不到有效值。
1481
+ */
1482
+ ResponseType?: string;
1483
+ /**
1484
+ * 第三方身份提供方的单点退出端点地址。配置后,用户退出当前应用时将被跳转至该地址,使第三方 IDP 的登录态也一并失效,实现单点退出(SLO)。适用于 OIDC、OAUTH、SAML 等所有支持单点退出的身份源类型。不填则退出时仅清除本平台登录态。
1485
+ 注意:此字段可能返回 null,表示取不到有效值。
1486
+ */
1487
+ SignoutEndpoint?: string;
1488
+ /**
1489
+ * Token 端点的客户端身份验证方式,决定请求 Token 时如何传递 ClientId 和 ClientSecret。可选值:CLIENT_SECRET_POST(将凭证放在请求 Body 中传递)、CLIENT_SECRET_BASIC(将凭证通过 HTTP Basic Auth Header 传递)。当 ProviderType 为 OIDC 或 OAUTH 时可选填写,默认使用 CLIENT_SECRET_POST。详情参考 OIDC 标准。
1490
+ 注意:此字段可能返回 null,表示取不到有效值。
1491
+ */
1492
+ TokenEndpointAuthMethod?: string;
1493
+ /**
1494
+ * SAML 身份提供方的 Metadata XML 内容,包含 IDP 的实体 ID、SSO 端点地址、签名证书等关键信息,平台将据此完成 SAML 协议的对接配置。仅当 ProviderType 为 SAML 时可填写,通常可从第三方 IDP 的管理控制台中下载获取。详情参考 SAML 2.0 标准。
1495
+ */
1496
+ SamlMetadata?: string;
1497
+ /**
1498
+ * 请求参数映射配置,用于处理非标准 OAuth 协议的参数转换。默认情况下平台严格遵循 OAuth 2.0 标准进行参数传递,若对接的第三方平台(如微信、企业微信等)使用了非标准的参数名称或传参方式,可通过该字段配置自定义的参数映射规则,以确保请求参数与第三方平台的要求一致。
1499
+ 注意:此字段可能返回 null,表示取不到有效值。
1500
+ */
1501
+ RequestParametersMap?: ProviderRequestParametersMap;
1502
+ /**
1503
+ * 响应参数映射配置,用于处理非标准 OAuth 协议的响应参数转换。默认情况下平台严格遵循 OAuth 2.0 标准解析响应参数,若对接的第三方平台(如微信、企业微信等)返回了非标准的字段名称或数据结构,可通过该字段配置自定义的响应参数映射规则,将第三方返回的字段映射为平台标准字段。
1504
+ 注意:此字段可能返回 null,表示取不到有效值。
1505
+ */
1506
+ ResponseParametersMap?: ProviderResponseParametersMap;
1241
1507
  }
1242
1508
  /**
1243
1509
  * ModifySafeRule请求参数结构体
@@ -1357,6 +1623,23 @@ export interface StaticStoreInfo {
1357
1623
  */
1358
1624
  Region?: string;
1359
1625
  }
1626
+ /**
1627
+ * DescribeApiKeyList返回参数结构体
1628
+ */
1629
+ export interface DescribeApiKeyListResponse {
1630
+ /**
1631
+ * API Key列表
1632
+ */
1633
+ Data?: Array<ApiKeyToken>;
1634
+ /**
1635
+ * 总数
1636
+ */
1637
+ Total?: number;
1638
+ /**
1639
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1640
+ */
1641
+ RequestId?: string;
1642
+ }
1360
1643
  /**
1361
1644
  * RunSql返回参数结构体
1362
1645
  */
@@ -1457,6 +1740,96 @@ export interface DescribeEnvAccountCircleRequest {
1457
1740
  */
1458
1741
  EnvId: string;
1459
1742
  }
1743
+ /**
1744
+ * CreateBillDeal请求参数结构体
1745
+ */
1746
+ export interface CreateBillDealRequest {
1747
+ /**
1748
+ * 当前下单的操作类型,可取[purchase,renew,modify]三种值,分别代表新购,续费,变配。
1749
+ */
1750
+ DealType: string;
1751
+ /**
1752
+ * 购买的产品类型,可取[tcb-baas,tcb-promotion,tcb-package], 分别代表baas套餐、大促包、资源包
1753
+ */
1754
+ ProductType: string;
1755
+ /**
1756
+ * 目标下单产品/套餐Id。
1757
+ 对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName
1758
+ */
1759
+ PackageId: string;
1760
+ /**
1761
+ * 默认只下单不支付,为ture则下单并支付。
1762
+ 如果需要下单并支付,请确保账户下有足够的余额,否则会导致下单失败。
1763
+ */
1764
+ CreateAndPay?: boolean;
1765
+ /**
1766
+ * 购买时长,与TimeUnit字段搭配使用。
1767
+ */
1768
+ TimeSpan?: number;
1769
+ /**
1770
+ * 购买时长单位,按各产品规则可选d(天),m(月),y(年),p(一次性)。
1771
+ 对于 云开发环境的 新购和续费,目前仅支持 按月购买(即 TimeUnit=m)。
1772
+ */
1773
+ TimeUnit?: string;
1774
+ /**
1775
+ * 资源唯一标识。
1776
+ 在云开发环境 续费和变配 场景下必传,取值为环境ID。
1777
+ */
1778
+ ResourceId?: string;
1779
+ /**
1780
+ * 来源可选[qcloud,miniapp],默认qcloud。
1781
+ miniapp表示微信云开发,主要适用于[小程序云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/billing/price.html)。
1782
+
1783
+ */
1784
+ Source?: string;
1785
+ /**
1786
+ * 环境别名,用于新购云开发环境时,给云开发环境起别名。
1787
+ 仅当 新购云开发环境(DealType=purchase 并且 ProductType=tcb-baas )时有效。
1788
+
1789
+ ### 格式要求
1790
+ - 可选字符: 小写字母(a~z)、数字、减号(-)
1791
+ - 不能以 减号(-) 开头或结尾
1792
+ - 不能有连个连续的 减号(-)
1793
+ - 长度不超过20位
1794
+ */
1795
+ Alias?: string;
1796
+ /**
1797
+ * 环境id,当购买资源包和大促包时(ProductType取值为tcb-promotion 或 tcb-package)必传,表示资源包在哪个环境下生效。
1798
+ */
1799
+ EnvId?: string;
1800
+ /**
1801
+ * 开启超限按量。
1802
+ 开启后,当 套餐内的资源点 和 资源包 都用尽后,会自动按量计费。
1803
+ 详见 [计费说明](https://cloud.tencent.com/document/product/876/127357)。
1804
+ */
1805
+ EnableExcess?: boolean;
1806
+ /**
1807
+ * 变配目标套餐id,对于云开发环境变配场景下必传。
1808
+ 对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName
1809
+ */
1810
+ ModifyPackageId?: string;
1811
+ /**
1812
+ * jsonstr附加信息
1813
+ */
1814
+ Extension?: string;
1815
+ /**
1816
+ * 是否自动选择代金券支付。
1817
+ */
1818
+ AutoVoucher?: boolean;
1819
+ /**
1820
+ * 资源类型。
1821
+ 代表新购环境(DealType=purchase 并且 ProductType=tcb-baas )时需要发货哪些资源。
1822
+ 可取值:flexdb, cos, cdn, scf
1823
+
1824
+ */
1825
+ ResourceTypes?: Array<string>;
1826
+ /**
1827
+ * 环境标签。
1828
+ 代表新购环境(DealType=purchase 并且 ProductType=tcb-baas )时需要打的标签。
1829
+
1830
+ */
1831
+ EnvTags?: Array<Tag>;
1832
+ }
1460
1833
  /**
1461
1834
  * RenewEnv返回参数结构体
1462
1835
  */
@@ -1487,6 +1860,10 @@ export interface CreateStaticStoreRequest {
1487
1860
  * 是否启用统一域名
1488
1861
  */
1489
1862
  EnableUnion?: boolean;
1863
+ /**
1864
+ * 外部存储源。
1865
+ */
1866
+ ExternalStorage?: ExternalStorage;
1490
1867
  }
1491
1868
  /**
1492
1869
  * DescribeBillingInfo返回参数结构体
@@ -1495,59 +1872,42 @@ export interface DescribeBillingInfoResponse {
1495
1872
  /**
1496
1873
  * 环境计费信息列表
1497
1874
  */
1498
- EnvBillingInfoList?: Array<EnvBillingInfoItem>;
1499
- /**
1500
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1501
- */
1502
- RequestId?: string;
1503
- }
1504
- /**
1505
- * CreateAuthDomain返回参数结构体
1506
- */
1507
- export interface CreateAuthDomainResponse {
1508
- /**
1509
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1510
- */
1511
- RequestId?: string;
1512
- }
1513
- /**
1514
- * DescribeEnvs请求参数结构体
1515
- */
1516
- export interface DescribeEnvsRequest {
1517
- /**
1518
- * 环境ID,如果传了这个参数则只返回该环境的相关信息
1519
- */
1520
- EnvId?: string;
1521
- /**
1522
- * 指定Channels字段为可见渠道列表或不可见渠道列表
1523
- 如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]
1524
- */
1525
- IsVisible?: boolean;
1875
+ EnvBillingInfoList?: Array<EnvBillingInfoItem>;
1526
1876
  /**
1527
- * 渠道列表,代表可见或不可见渠道由IsVisible参数指定
1877
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1528
1878
  */
1529
- Channels?: Array<string>;
1879
+ RequestId?: string;
1880
+ }
1881
+ /**
1882
+ * CreateAuthDomain返回参数结构体
1883
+ */
1884
+ export interface CreateAuthDomainResponse {
1530
1885
  /**
1531
- * 分页参数,单页限制个数
1886
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1532
1887
  */
1533
- Limit?: number;
1888
+ RequestId?: string;
1889
+ }
1890
+ /**
1891
+ * DeleteApiKey返回参数结构体
1892
+ */
1893
+ export interface DeleteApiKeyResponse {
1534
1894
  /**
1535
- * 分页参数,偏移量
1895
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1536
1896
  */
1537
- Offset?: number;
1897
+ RequestId?: string;
1538
1898
  }
1539
1899
  /**
1540
- * 标签键值对
1900
+ * DestroyStaticStore请求参数结构体
1541
1901
  */
1542
- export interface Tag {
1902
+ export interface DestroyStaticStoreRequest {
1543
1903
  /**
1544
- * 标签键
1904
+ * 环境ID
1545
1905
  */
1546
- Key: string;
1906
+ EnvId: string;
1547
1907
  /**
1548
- * 标签值
1908
+ * cdn域名
1549
1909
  */
1550
- Value: string;
1910
+ CdnDomain?: string;
1551
1911
  }
1552
1912
  /**
1553
1913
  * ModifyClient返回参数结构体
@@ -1567,6 +1927,27 @@ export interface EditAuthConfigResponse {
1567
1927
  */
1568
1928
  RequestId?: string;
1569
1929
  }
1930
+ /**
1931
+ * 云服务器登录方式
1932
+ */
1933
+ export interface VMLoginConfiguration {
1934
+ /**
1935
+ * 登录方式。扫码登录时指定为 SCAN_LOGIN
1936
+ */
1937
+ LoginType?: string;
1938
+ /**
1939
+ * 是否自动生成密码
1940
+ */
1941
+ AutoGeneratePassword?: string;
1942
+ /**
1943
+ * 指定密码登录
1944
+ */
1945
+ Password?: string;
1946
+ /**
1947
+ * 绑定密钥ID
1948
+ */
1949
+ KeyIds?: Array<string>;
1950
+ }
1570
1951
  /**
1571
1952
  * RenewEnv请求参数结构体
1572
1953
  */
@@ -1623,6 +2004,72 @@ export interface DescribeClientResponse {
1623
2004
  */
1624
2005
  RequestId?: string;
1625
2006
  }
2007
+ /**
2008
+ * DeleteHTTPServiceRoute返回参数结构体
2009
+ */
2010
+ export interface DeleteHTTPServiceRouteResponse {
2011
+ /**
2012
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2013
+ */
2014
+ RequestId?: string;
2015
+ }
2016
+ /**
2017
+ * TDSQL-C网络信息类型
2018
+ */
2019
+ export interface MySQLNetDetail {
2020
+ /**
2021
+ * 内网地址
2022
+ 注意:此字段可能返回 null,表示取不到有效值。
2023
+ */
2024
+ PrivateNetAddress?: string;
2025
+ /**
2026
+ * 外网地址
2027
+ 注意:此字段可能返回 null,表示取不到有效值。
2028
+ */
2029
+ PubNetAddress?: string;
2030
+ /**
2031
+ * 网络信息(VPCID/SubnetID)
2032
+ 注意:此字段可能返回 null,表示取不到有效值。
2033
+ */
2034
+ Net?: string;
2035
+ /**
2036
+ * 是否开通公网
2037
+ */
2038
+ PubNetAccessEnabled?: boolean;
2039
+ /**
2040
+ * vpc id
2041
+ */
2042
+ VpcId?: string;
2043
+ /**
2044
+ * vpc name
2045
+ */
2046
+ VpcName?: string;
2047
+ /**
2048
+ * 子网ID
2049
+ */
2050
+ SubnetId?: string;
2051
+ /**
2052
+ * 子网名
2053
+ */
2054
+ SubnetName?: string;
2055
+ }
2056
+ /**
2057
+ * 本类型用于接口中描述待创建索引结构
2058
+ */
2059
+ export interface MgoKeySchema {
2060
+ /**
2061
+ * 索引字段
2062
+ */
2063
+ MgoIndexKeys?: Array<MgoIndexKeys>;
2064
+ /**
2065
+ * 是否唯一索引
2066
+ */
2067
+ MgoIsUnique?: boolean;
2068
+ /**
2069
+ * 是否稀疏索引
2070
+ */
2071
+ MgoIsSparse?: boolean;
2072
+ }
1626
2073
  /**
1627
2074
  * UpdateTable返回参数结构体
1628
2075
  */
@@ -1697,6 +2144,19 @@ export interface HpaPolicy {
1697
2144
  */
1698
2145
  PolicyThreshold?: number;
1699
2146
  }
2147
+ /**
2148
+ * 云开发路由限频策略
2149
+ */
2150
+ export interface HTTPServiceRouteQPSPolicy {
2151
+ /**
2152
+ * QPS值,每秒请求次数
2153
+ */
2154
+ QPSTotal?: number;
2155
+ /**
2156
+ * 客户端限频配置
2157
+ */
2158
+ QPSPerClient?: HTTPServiceQPSPerClient;
2159
+ }
1700
2160
  /**
1701
2161
  * CLS日志单条信息
1702
2162
  */
@@ -1740,17 +2200,17 @@ export interface DestroyStaticStoreResponse {
1740
2200
  RequestId?: string;
1741
2201
  }
1742
2202
  /**
1743
- * DeleteUsers返回参数结构体
2203
+ * DeleteVmInstance请求参数结构体
1744
2204
  */
1745
- export interface DeleteUsersResponse {
2205
+ export interface DeleteVmInstanceRequest {
1746
2206
  /**
1747
- * 删除用户结果
2207
+ * 服务器实例id
1748
2208
  */
1749
- Data?: DeleteUsersResp;
2209
+ InstanceId: string;
1750
2210
  /**
1751
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2211
+ * 环境id
1752
2212
  */
1753
- RequestId?: string;
2213
+ EnvId: string;
1754
2214
  }
1755
2215
  /**
1756
2216
  * DescribeUserList返回参数结构体
@@ -1816,6 +2276,19 @@ export interface DeleteAuthDomainResponse {
1816
2276
  */
1817
2277
  RequestId?: string;
1818
2278
  }
2279
+ /**
2280
+ * DeleteApiKey请求参数结构体
2281
+ */
2282
+ export interface DeleteApiKeyRequest {
2283
+ /**
2284
+ * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离
2285
+ */
2286
+ EnvId: string;
2287
+ /**
2288
+ * 密钥的唯一标识符,用于精确定位指定的 API 密钥。可通过查询密钥列表接口获取
2289
+ */
2290
+ KeyId: string;
2291
+ }
1819
2292
  /**
1820
2293
  * ModifyProvider请求参数结构体
1821
2294
  */
@@ -1913,69 +2386,115 @@ export interface DeleteTableRequest {
1913
2386
  MongoConnector?: MongoConnector;
1914
2387
  }
1915
2388
  /**
1916
- * CreateCloudBaseGWAPI请求参数结构体
2389
+ * 环境信息
1917
2390
  */
1918
- export interface CreateCloudBaseGWAPIRequest {
2391
+ export interface EnvInfo {
1919
2392
  /**
1920
- * Service ID
2393
+ * 账户下该环境唯一标识
1921
2394
  */
1922
- ServiceId: string;
2395
+ EnvId?: string;
1923
2396
  /**
1924
- * API Path
2397
+ * 环境来源。包含以下取值:
2398
+ <li>miniapp:微信小程序</li>
2399
+ <li>qcloud :腾讯云</li>
1925
2400
  */
1926
- Path: string;
2401
+ Source?: string;
1927
2402
  /**
1928
- * API类型(1表示云函数,2表示容器)
2403
+ * 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
1929
2404
  */
1930
- Type: number;
2405
+ Alias?: string;
1931
2406
  /**
1932
- * API Name
2407
+ * 创建时间
1933
2408
  */
1934
- Name: string;
2409
+ CreateTime?: string;
1935
2410
  /**
1936
- * APIId,如果非空,表示修改绑定Path
2411
+ * 最后修改时间
1937
2412
  */
1938
- APIId?: string;
2413
+ UpdateTime?: string;
1939
2414
  /**
1940
- * 自定义值通用字段(当Type为容器时必填)
2415
+ * 环境状态。包含以下取值:
2416
+ <li>NORMAL:正常可用</li>
2417
+ <li>UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中</li>
1941
2418
  */
1942
- Custom?: string;
2419
+ Status?: string;
1943
2420
  /**
1944
- * 认证开关 1为开启 2为关闭
2421
+ * 数据库列表
1945
2422
  */
1946
- AuthSwitch?: number;
2423
+ Databases?: Array<DatabasesInfo>;
1947
2424
  /**
1948
- * 是否开启多地域
2425
+ * 存储列表
1949
2426
  */
1950
- EnableRegion?: boolean;
2427
+ Storages?: Array<StorageInfo>;
1951
2428
  /**
1952
- * 是否启用统一域名
2429
+ * 函数列表
1953
2430
  */
1954
- EnableUnion?: boolean;
2431
+ Functions?: Array<FunctionInfo>;
1955
2432
  /**
1956
- * 域名
2433
+ * tcb产品套餐ID,参考DescribePackages接口的返回值。
1957
2434
  */
1958
- Domain?: string;
2435
+ PackageId?: string;
2436
+ /**
2437
+ * 套餐中文名称,参考DescribePackages接口的返回值。
2438
+ */
2439
+ PackageName?: string;
2440
+ /**
2441
+ * 云日志服务列表
2442
+ */
2443
+ LogServices?: Array<LogServiceInfo>;
2444
+ /**
2445
+ * 静态资源信息
2446
+ */
2447
+ StaticStorages?: Array<StaticStorageInfo>;
2448
+ /**
2449
+ * 是否到期自动降为免费版
2450
+ */
2451
+ IsAutoDegrade?: boolean;
2452
+ /**
2453
+ * 环境渠道
2454
+ */
2455
+ EnvChannel?: string;
2456
+ /**
2457
+ * 支付方式。包含以下取值:
2458
+ <li> prepayment:预付费</li>
2459
+ <li> postpaid:后付费</li>
2460
+ */
2461
+ PayMode?: string;
2462
+ /**
2463
+ * 是否为默认环境
2464
+ */
2465
+ IsDefault?: boolean;
2466
+ /**
2467
+ * 环境所属地域
2468
+ */
2469
+ Region?: string;
2470
+ /**
2471
+ * 环境标签列表
2472
+ */
2473
+ Tags?: Array<Tag>;
2474
+ /**
2475
+ * 自定义日志服务
2476
+ */
2477
+ CustomLogServices?: Array<ClsInfo>;
1959
2478
  /**
1960
- * 访问类型:"OA", "PUBLIC", "MINIAPP", "VPC" (不传默认PUBLIC+MINIAPP+VPC)
2479
+ * 环境类型:baas, run, hoting, weda
1961
2480
  */
1962
- AccessTypes?: Array<string>;
2481
+ EnvType?: string;
1963
2482
  /**
1964
- * 是否开启路径透传,默认true表示短路径,即不开启路径透传(已弃用)
2483
+ * 是否是dau新套餐
1965
2484
  */
1966
- IsShortPath?: boolean;
2485
+ IsDauPackage?: boolean;
1967
2486
  /**
1968
- * 路径透传,默认0关闭,1开启,2关闭
2487
+ * 套餐类型:空\baas\tcbr
1969
2488
  */
1970
- PathTransmission?: number;
2489
+ PackageType?: string;
1971
2490
  /**
1972
- * 跨域校验,默认0开启,1开启,2关闭
2491
+ * 架构类型
1973
2492
  */
1974
- EnableCheckAcrossDomain?: number;
2493
+ ArchitectureType?: string;
1975
2494
  /**
1976
- * 静态托管资源目录
2495
+ * 回收标志,默认为空
1977
2496
  */
1978
- StaticFileDirectory?: string;
2497
+ Recycle?: string;
1979
2498
  }
1980
2499
  /**
1981
2500
  * DestroyEnv请求参数结构体
@@ -2197,72 +2716,25 @@ export interface MySQLTaskStatus {
2197
2716
  /**
2198
2717
  * 状态描述
2199
2718
  */
2200
- StatusDesc?: string;
2201
- }
2202
- /**
2203
- * 查询开通Mysql结果
2204
- */
2205
- export interface DescribeCreateMySQLResult {
2206
- /**
2207
- * 状态 notexist | init | doing | success | fail
2208
- */
2209
- Status?: string;
2210
- /**
2211
- * 失败原因
2212
- 注意:此字段可能返回 null,表示取不到有效值。
2213
- */
2214
- FailReason?: string;
2215
- /**
2216
- * 是否已被冻结(只在 Status=success时有效)
2217
- */
2218
- FreezeStatus?: boolean;
2219
- }
2220
- /**
2221
- * DeleteCloudBaseGWAPI请求参数结构体
2222
- */
2223
- export interface DeleteCloudBaseGWAPIRequest {
2224
- /**
2225
- * 服务ID
2226
- */
2227
- ServiceId: string;
2228
- /**
2229
- * API Path
2230
- */
2231
- Path?: string;
2232
- /**
2233
- * API ID
2234
- */
2235
- APIId?: string;
2236
- /**
2237
- * API类型
2238
- */
2239
- Type?: number;
2240
- /**
2241
- * API Name
2242
- */
2243
- Name?: string;
2244
- /**
2245
- * 自定义值字段(Type为2时,传递容器服务名表示需要删除JNSGW)
2246
- */
2247
- Custom?: string;
2248
- /**
2249
- * 域名
2250
- */
2251
- Domain?: string;
2719
+ StatusDesc?: string;
2252
2720
  }
2253
2721
  /**
2254
- * CreateCloudBaseGWAPI返回参数结构体
2722
+ * 查询开通Mysql结果
2255
2723
  */
2256
- export interface CreateCloudBaseGWAPIResponse {
2724
+ export interface DescribeCreateMySQLResult {
2725
+ /**
2726
+ * 状态 notexist | init | doing | success | fail
2727
+ */
2728
+ Status?: string;
2257
2729
  /**
2258
- * API ID
2730
+ * 失败原因
2259
2731
  注意:此字段可能返回 null,表示取不到有效值。
2260
2732
  */
2261
- APIId: string;
2733
+ FailReason?: string;
2262
2734
  /**
2263
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2735
+ * 是否已被冻结(只在 Status=success时有效)
2264
2736
  */
2265
- RequestId?: string;
2737
+ FreezeStatus?: boolean;
2266
2738
  }
2267
2739
  /**
2268
2740
  * DescribeCreateMySQLResult返回参数结构体
@@ -2405,6 +2877,79 @@ export interface Provider {
2405
2877
  */
2406
2878
  AutoSignInWhenPhoneNumberMatch?: string;
2407
2879
  }
2880
+ /**
2881
+ * DescribeSafeRule返回参数结构体
2882
+ */
2883
+ export interface DescribeSafeRuleResponse {
2884
+ /**
2885
+ * 规则内容
2886
+ 注意:此字段可能返回 null,表示取不到有效值。
2887
+ */
2888
+ Rule?: string;
2889
+ /**
2890
+ * 权限标签。包含以下取值:
2891
+ <li> READONLY:所有用户可读,仅创建者和管理员可写</li>
2892
+ <li> PRIVATE:仅创建者及管理员可读写</li>
2893
+ <li> ADMINWRITE:所有用户可读,仅管理员可写</li>
2894
+ <li> ADMINONLY:仅管理员可读写</li>
2895
+ <li> CUSTOM:自定义安全规则</li>
2896
+ */
2897
+ AclTag?: string;
2898
+ /**
2899
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2900
+ */
2901
+ RequestId?: string;
2902
+ }
2903
+ /**
2904
+ * 安全网关自定义日志配置
2905
+ */
2906
+ export interface CustomLogConfig {
2907
+ /**
2908
+ * 是否需要请求体
2909
+ */
2910
+ NeedReqBodyLog?: boolean;
2911
+ /**
2912
+ * 是否需要请求头
2913
+ */
2914
+ NeedReqHeaderLog?: boolean;
2915
+ /**
2916
+ * 是否需要回包体
2917
+ */
2918
+ NeedRspBodyLog?: boolean;
2919
+ /**
2920
+ * 是否需要回包头部信息
2921
+ */
2922
+ NeedRspHeaderLog?: boolean;
2923
+ /**
2924
+ * cls set信息
2925
+ */
2926
+ LogSetId?: string;
2927
+ /**
2928
+ * cls topicId
2929
+ */
2930
+ LogTopicId?: string;
2931
+ }
2932
+ /**
2933
+ * DescribeApiKeyList请求参数结构体
2934
+ */
2935
+ export interface DescribeApiKeyListRequest {
2936
+ /**
2937
+ * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离
2938
+ */
2939
+ EnvId: string;
2940
+ /**
2941
+ * 分页查询的页码,从 1 开始。与 PageSize 配合使用,不传则默认返回第 1 页
2942
+ */
2943
+ PageNumber?: number;
2944
+ /**
2945
+ * 分页查询每页返回的记录条数。与 PageNumber 配合使用,不传则使用系统默认值
2946
+ */
2947
+ PageSize?: number;
2948
+ /**
2949
+ * 密钥类型过滤条件。可选值:api_key(服务端调用使用的 API 密钥,具有完整权限)、publish_key(客户端使用的公开密钥,权限受限)密钥类型过滤条件。不传默认值为api_key
2950
+ */
2951
+ KeyType?: string;
2952
+ }
2408
2953
  /**
2409
2954
  * 本类型用于UpdateTable接口中描述待创建索引信息
2410
2955
  */
@@ -2428,32 +2973,26 @@ export interface DescribeStaticStoreRequest {
2428
2973
  EnvId: string;
2429
2974
  }
2430
2975
  /**
2431
- * ModifyCloudBaseGWAPI返回参数结构体
2976
+ * http访问服务客户端限频
2432
2977
  */
2433
- export interface ModifyCloudBaseGWAPIResponse {
2978
+ export interface HTTPServiceQPSPerClient {
2434
2979
  /**
2435
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2980
+ * 客户端维度限频标识。限制当前资源被单个客户端调用的频率,客户端标识支持 用户ID(UserID) 客户端 IP(ClientIP)。UserID 包括 云开发用户 ID 或 微信 openid,如果请求无 UserID 信息,则不会限制。
2436
2981
  */
2437
- RequestId?: string;
2982
+ LimitBy?: string;
2983
+ /**
2984
+ * 限制QPS值,每秒请求次数
2985
+ */
2986
+ LimitValue?: number;
2438
2987
  }
2439
2988
  /**
2440
- * DescribeSafeRule返回参数结构体
2989
+ * DeleteUsers返回参数结构体
2441
2990
  */
2442
- export interface DescribeSafeRuleResponse {
2443
- /**
2444
- * 规则内容
2445
- 注意:此字段可能返回 null,表示取不到有效值。
2446
- */
2447
- Rule?: string;
2991
+ export interface DeleteUsersResponse {
2448
2992
  /**
2449
- * 权限标签。包含以下取值:
2450
- <li> READONLY:所有用户可读,仅创建者和管理员可写</li>
2451
- <li> PRIVATE:仅创建者及管理员可读写</li>
2452
- <li> ADMINWRITE:所有用户可读,仅管理员可写</li>
2453
- <li> ADMINONLY:仅管理员可读写</li>
2454
- <li> CUSTOM:自定义安全规则</li>
2993
+ * 删除用户结果
2455
2994
  */
2456
- AclTag?: string;
2995
+ Data?: DeleteUsersResp;
2457
2996
  /**
2458
2997
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2459
2998
  */
@@ -2608,260 +3147,103 @@ export interface VMSpec {
2608
3147
  /**
2609
3148
  * ModifyDatabaseACL返回参数结构体
2610
3149
  */
2611
- export interface ModifyDatabaseACLResponse {
2612
- /**
2613
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2614
- */
2615
- RequestId?: string;
2616
- }
2617
- /**
2618
- * 静态CDN资源信息
2619
- */
2620
- export interface StaticStorageInfo {
2621
- /**
2622
- * 静态CDN域名
2623
- */
2624
- StaticDomain?: string;
2625
- /**
2626
- * 静态CDN默认文件夹,当前为根目录
2627
- */
2628
- DefaultDirName?: string;
2629
- /**
2630
- * 资源状态(process/online/offline/init)
2631
- */
2632
- Status?: string;
2633
- /**
2634
- * cos所属区域
2635
- */
2636
- Region?: string;
2637
- /**
2638
- * bucket信息
2639
- */
2640
- Bucket?: string;
2641
- }
2642
- /**
2643
- * CreateTable返回参数结构体
2644
- */
2645
- export interface CreateTableResponse {
2646
- /**
2647
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2648
- */
2649
- RequestId?: string;
2650
- }
2651
- /**
2652
- * 用户信息
2653
- */
2654
- export interface User {
2655
- /**
2656
- * 用户ID
2657
- */
2658
- Uid?: string;
2659
- /**
2660
- * 用户名
2661
- */
2662
- Name?: string;
2663
- /**
2664
- * 用户类型:internalUser-内部用户、externalUser-外部用户
2665
- */
2666
- Type?: string;
2667
- /**
2668
- * 用户状态:ACTIVE(激活)、BLOCKED(冻结)
2669
- */
2670
- UserStatus?: string;
2671
- /**
2672
- * 用户昵称
2673
- */
2674
- NickName?: string;
2675
- /**
2676
- * 手机号
2677
- */
2678
- Phone?: string;
2679
- /**
2680
- * 邮箱
2681
- */
2682
- Email?: string;
2683
- /**
2684
- * 头像链接
2685
- */
2686
- AvatarUrl?: string;
2687
- /**
2688
- * 用户描述
2689
- */
2690
- Description?: string;
2691
- }
2692
- /**
2693
- * 销毁 Mysql 结果
2694
- */
2695
- export interface DestroyMySQLResult {
2696
- /**
2697
- * 是否成功
2698
- */
2699
- IsSuccess?: boolean;
2700
- /**
2701
- * 任务ID
2702
- */
2703
- TaskId?: string;
2704
- /**
2705
- * 任务名
2706
- */
2707
- TaskName?: string;
2708
- }
2709
- /**
2710
- * DescribeCloudBaseGWAPI返回参数结构体
2711
- */
2712
- export interface DescribeCloudBaseGWAPIResponse {
2713
- /**
2714
- * API列表
2715
- 注意:此字段可能返回 null,表示取不到有效值。
2716
- */
2717
- APISet?: Array<CloudBaseGWAPI>;
2718
- /**
2719
- * 是否开启http调用
2720
- */
2721
- EnableService?: boolean;
2722
- /**
2723
- * 查询结果的数据总量
2724
- 注意:此字段可能返回 null,表示取不到有效值。
2725
- */
2726
- Total?: number;
2727
- /**
2728
- * 查询的分页参数
2729
- 注意:此字段可能返回 null,表示取不到有效值。
2730
- */
2731
- Offset?: number;
2732
- /**
2733
- * 查询的分页参数
2734
- 注意:此字段可能返回 null,表示取不到有效值。
2735
- */
2736
- Limit?: number;
2737
- /**
2738
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2739
- */
2740
- RequestId?: string;
2741
- }
2742
- /**
2743
- * 身份认证源协议连接配置。包含 OAuth 2.0 / OIDC 协议端点(授权端点、令牌端点、用户信息端点、JWKS 端点等)、客户端凭证(ClientId、ClientSecret)、SAML 元数据、请求与响应参数的字段映射等配置信息。OIDC 类型的认证源字段定义参考 https://openid.net/specs/openid-connect-discovery-1_0.html 规范。
2744
- */
2745
- export interface ProviderConfig {
2746
- /**
2747
- * 身份提供方的唯一标识符(Issuer URL),用于验证 ID Token 中的 iss 字段。仅当 ProviderType 为 OIDC 时需要填写,值通常为第三方 OIDC 服务的根地址,例如:https://accounts.google.com。填写后平台将自动通过 /.well-known/openid-configuration 发现并填充 AuthorizationEndpoint、TokenEndpoint、UserinfoEndpoint、JwksUri 等端点地址。详情参考 OpenID Connect Discovery 标准。
2748
- 注意:此字段可能返回 null,表示取不到有效值。
2749
- */
2750
- Issuer?: string;
2751
- /**
2752
- * 第三方身份提供方的 JSON Web Key Set 地址,用于获取公钥以验证 ID Token 签名。仅当 ProviderType 为 OIDC 时需要填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OpenID Connect Discovery 标准。
2753
- 注意:此字段可能返回 null,表示取不到有效值。
2754
- */
2755
- JwksUri?: string;
2756
- /**
2757
- * 在第三方身份提供方注册的应用客户端 ID,用于标识当前接入应用。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,可在对应平台的开发者控制台中获取。详情参考 OAuth 2.0 标准。
2758
- 注意:此字段可能返回 null,表示取不到有效值。
2759
- */
2760
- ClientId?: string;
2761
- /**
2762
- * 在第三方身份提供方注册的应用客户端密钥,与 ClientId 配合使用,用于在 Token 端点进行身份验证。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,请妥善保管,避免泄露。详情参考 OAuth 2.0 标准。
2763
- 注意:此字段可能返回 null,表示取不到有效值。
2764
- */
2765
- ClientSecret?: string;
2766
- /**
2767
- * OAuth 授权完成后第三方平台回调的地址,需与在第三方平台注册的回调地址完全一致,否则授权将失败。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,并需在对应平台的开发者控制台中配置该地址为合法回调地址。详情参考 OAuth 2.0 标准。
2768
- 注意:此字段可能返回 null,表示取不到有效值。
2769
- */
2770
- RedirectUri?: string;
2771
- /**
2772
- * 向第三方身份提供方申请的权限范围,多个 scope 之间用空格分隔。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,OIDC 场景下通常至少包含 openid,如需获取用户邮箱或手机号可追加 email、phone 等。若已填写 Issuer 且未指定 Scope,将自动使用 OpenID Connect Discovery 返回的 scopes_supported。详情参考 OAuth 2.0 标准。
2773
- 注意:此字段可能返回 null,表示取不到有效值。
2774
- */
2775
- Scope?: string;
2776
- /**
2777
- * 第三方身份提供方的授权端点地址,用于发起 OAuth/OIDC 授权请求,引导用户跳转至第三方登录页面。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
2778
- 注意:此字段可能返回 null,表示取不到有效值。
2779
- */
2780
- AuthorizationEndpoint?: string;
2781
- /**
2782
- * 第三方身份提供方的 Token 端点地址,用于通过授权码(code)换取 Access Token 和 ID Token。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
2783
- 注意:此字段可能返回 null,表示取不到有效值。
2784
- */
2785
- TokenEndpoint?: string;
3150
+ export interface ModifyDatabaseACLResponse {
2786
3151
  /**
2787
- * 第三方身份提供方的用户信息端点地址,用于通过 Access Token 获取用户的基本信息(如昵称、头像、邮箱等)。当 ProviderType 为 OIDC 或 OAUTH 且需要获取用户详细信息时填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OIDC 标准。
2788
- 注意:此字段可能返回 null,表示取不到有效值。
3152
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2789
3153
  */
2790
- UserinfoEndpoint?: string;
3154
+ RequestId?: string;
3155
+ }
3156
+ /**
3157
+ * 静态CDN资源信息
3158
+ */
3159
+ export interface StaticStorageInfo {
2791
3160
  /**
2792
- * OAuth/OIDC 授权请求的响应类型,决定授权端点返回的内容。可选值:code(授权码模式,推荐)、token(隐式模式,直接返回 Access Token)、id_token(直接返回 ID Token)。当 ProviderType 为 OIDC 时默认使用 id_token,其他类型默认使用 code。当 ProviderType 为 OIDC 或 OAUTH 时可选填写。详情参考 OAuth 2.0 / OIDC 标准。
2793
- 注意:此字段可能返回 null,表示取不到有效值。
3161
+ * 静态CDN域名
2794
3162
  */
2795
- ResponseType?: string;
3163
+ StaticDomain?: string;
2796
3164
  /**
2797
- * 第三方身份提供方的单点退出端点地址。配置后,用户退出当前应用时将被跳转至该地址,使第三方 IDP 的登录态也一并失效,实现单点退出(SLO)。适用于 OIDC、OAUTH、SAML 等所有支持单点退出的身份源类型。不填则退出时仅清除本平台登录态。
2798
- 注意:此字段可能返回 null,表示取不到有效值。
3165
+ * 静态CDN默认文件夹,当前为根目录
2799
3166
  */
2800
- SignoutEndpoint?: string;
3167
+ DefaultDirName?: string;
2801
3168
  /**
2802
- * Token 端点的客户端身份验证方式,决定请求 Token 时如何传递 ClientId 和 ClientSecret。可选值:CLIENT_SECRET_POST(将凭证放在请求 Body 中传递)、CLIENT_SECRET_BASIC(将凭证通过 HTTP Basic Auth Header 传递)。当 ProviderType 为 OIDC 或 OAUTH 时可选填写,默认使用 CLIENT_SECRET_POST。详情参考 OIDC 标准。
2803
- 注意:此字段可能返回 null,表示取不到有效值。
3169
+ * 资源状态(process/online/offline/init)
2804
3170
  */
2805
- TokenEndpointAuthMethod?: string;
3171
+ Status?: string;
2806
3172
  /**
2807
- * SAML 身份提供方的 Metadata XML 内容,包含 IDP 的实体 ID、SSO 端点地址、签名证书等关键信息,平台将据此完成 SAML 协议的对接配置。仅当 ProviderType 为 SAML 时可填写,通常可从第三方 IDP 的管理控制台中下载获取。详情参考 SAML 2.0 标准。
3173
+ * cos所属区域
2808
3174
  */
2809
- SamlMetadata?: string;
3175
+ Region?: string;
2810
3176
  /**
2811
- * 请求参数映射配置,用于处理非标准 OAuth 协议的参数转换。默认情况下平台严格遵循 OAuth 2.0 标准进行参数传递,若对接的第三方平台(如微信、企业微信等)使用了非标准的参数名称或传参方式,可通过该字段配置自定义的参数映射规则,以确保请求参数与第三方平台的要求一致。
2812
- 注意:此字段可能返回 null,表示取不到有效值。
3177
+ * bucket信息
2813
3178
  */
2814
- RequestParametersMap?: ProviderRequestParametersMap;
3179
+ Bucket?: string;
3180
+ }
3181
+ /**
3182
+ * CreateTable返回参数结构体
3183
+ */
3184
+ export interface CreateTableResponse {
2815
3185
  /**
2816
- * 响应参数映射配置,用于处理非标准 OAuth 协议的响应参数转换。默认情况下平台严格遵循 OAuth 2.0 标准解析响应参数,若对接的第三方平台(如微信、企业微信等)返回了非标准的字段名称或数据结构,可通过该字段配置自定义的响应参数映射规则,将第三方返回的字段映射为平台标准字段。
2817
- 注意:此字段可能返回 null,表示取不到有效值。
3186
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2818
3187
  */
2819
- ResponseParametersMap?: ProviderResponseParametersMap;
3188
+ RequestId?: string;
2820
3189
  }
2821
3190
  /**
2822
- * DescribeCloudBaseGWAPI请求参数结构体
3191
+ * 用户信息
2823
3192
  */
2824
- export interface DescribeCloudBaseGWAPIRequest {
3193
+ export interface User {
2825
3194
  /**
2826
- * 服务ID
3195
+ * 用户ID
2827
3196
  */
2828
- ServiceId?: string;
3197
+ Uid?: string;
2829
3198
  /**
2830
- * API域名
3199
+ * 用户名
2831
3200
  */
2832
- Domain?: string;
3201
+ Name?: string;
2833
3202
  /**
2834
- * API Path
3203
+ * 用户类型:internalUser-内部用户、externalUser-外部用户
2835
3204
  */
2836
- Path?: string;
3205
+ Type?: string;
2837
3206
  /**
2838
- * API ID
3207
+ * 用户状态:ACTIVE(激活)、BLOCKED(冻结)
2839
3208
  */
2840
- APIId?: string;
3209
+ UserStatus?: string;
2841
3210
  /**
2842
- * API类型,1为云函数,2为容器
3211
+ * 用户昵称
2843
3212
  */
2844
- Type?: number;
3213
+ NickName?: string;
2845
3214
  /**
2846
- * API名,Type为1时为云函数名,Type为2时为容器服务名
3215
+ * 手机号
2847
3216
  */
2848
- Name?: string;
3217
+ Phone?: string;
2849
3218
  /**
2850
- * 查询的分页参数,用于设置查询的偏移位置,0表示从头开始
3219
+ * 邮箱
2851
3220
  */
2852
- Offset?: number;
3221
+ Email?: string;
2853
3222
  /**
2854
- * 查询的分页参数,用于表示每次查询的最大返回数据量
3223
+ * 头像链接
2855
3224
  */
2856
- Limit?: number;
3225
+ AvatarUrl?: string;
2857
3226
  /**
2858
- * 是否启用多地域
3227
+ * 用户描述
2859
3228
  */
2860
- EnableRegion?: boolean;
3229
+ Description?: string;
3230
+ }
3231
+ /**
3232
+ * 销毁 Mysql 结果
3233
+ */
3234
+ export interface DestroyMySQLResult {
2861
3235
  /**
2862
- * 是否使用统一域名
3236
+ * 是否成功
2863
3237
  */
2864
- EnableUnion?: boolean;
3238
+ IsSuccess?: boolean;
3239
+ /**
3240
+ * 任务ID
3241
+ */
3242
+ TaskId?: string;
3243
+ /**
3244
+ * 任务名
3245
+ */
3246
+ TaskName?: string;
2865
3247
  }
2866
3248
  /**
2867
3249
  * CreateMySQL请求参数结构体
@@ -2919,79 +3301,83 @@ export interface DatabasesInfo {
2919
3301
  UpdateTime?: string;
2920
3302
  }
2921
3303
  /**
2922
- * 虚拟主机价格
3304
+ * 查询HTTP访问服务输出的域名信息,每个域名内包含所有路由信息
2923
3305
  */
2924
- export interface VMPrice {
3306
+ export interface HTTPServiceDomain {
2925
3307
  /**
2926
- * 价格货币单位。取值范围CNY:人民币。USD:美元。
3308
+ * 域名
2927
3309
  */
2928
- Currency?: string;
3310
+ Domain?: string;
2929
3311
  /**
2930
- * 原始价格
3312
+ * 域名类型。 HTTPSERVICE: HTTP访问服务,CBR: 云托管服务,ANYSERVICE: 任意服务,AI_AGENT: AI agent,VM: 主机,INTEGRATION_CALLBACK: 集成回调
2931
3313
  */
2932
- OriginalPrice?: number;
3314
+ DomainType?: string;
2933
3315
  /**
2934
- * 折扣率
3316
+ * 绑定类型。默认DIRECT。DIRECT: 直连到HTTP访问服务, CDN: 接入云开发CDN,CUSTOM: 自定义接入类型(其他CDN或者WAF)
2935
3317
  */
2936
- Discount?: number;
3318
+ AccessType?: string;
2937
3319
  /**
2938
- * 折扣后的价格
3320
+ * 证书ID。当前账户下SSL平台的证书ID
2939
3321
  */
2940
- DiscountPrice?: number;
3322
+ CertId?: string;
2941
3323
  /**
2942
- * 折扣前每天资源点
3324
+ * 协议类型。默认HTTP_AND_HTTPS。HTTP_AND_HTTPS: 同时开启http和https,HTTP_TO_HTTPS: http重定向成https,HTTPS_TO_HTTP: https重定向成http。如果未配置证书无法访问https或者进行重定向
2943
3325
  */
2944
- OriginalCredits?: number;
3326
+ Protocol?: string;
2945
3327
  /**
2946
- * 折扣后每天所需资源点
3328
+ * 配置DNS解析的CNAME。根据AccessType返回不同的CNAME值。
2947
3329
  */
2948
- DiscountCredits?: number;
2949
- }
2950
- /**
2951
- * DescribeCloudBaseGWService返回参数结构体
2952
- */
2953
- export interface DescribeCloudBaseGWServiceResponse {
3330
+ Cname?: string;
2954
3331
  /**
2955
- * 服务列表
2956
- 注意:此字段可能返回 null,表示取不到有效值。
3332
+ * 是否是默认域名
2957
3333
  */
2958
- ServiceSet?: Array<CloudBaseGWService>;
3334
+ IsDefault?: boolean;
2959
3335
  /**
2960
- * 是否开启服务
3336
+ * 域名开启状态
2961
3337
  */
2962
- EnableService?: boolean;
3338
+ Enable?: boolean;
2963
3339
  /**
2964
- * 默认域名信息
2965
- 注意:此字段可能返回 null,表示取不到有效值。
3340
+ * 状态。PROCESSING、FAIL,SUCCESS。
2966
3341
  */
2967
- DefaultDomain?: string;
3342
+ Status?: string;
2968
3343
  /**
2969
- * 是否开启CDN迁移
2970
- 注意:此字段可能返回 null,表示取不到有效值。
3344
+ * DNS解析状态。OK: 解析正常,INVALID:解析不正确,域名未解析到当前Cname域名。
2971
3345
  */
2972
- EnableUnion?: boolean;
3346
+ DNSStatus?: string;
2973
3347
  /**
2974
- * 是否开启跨域校验,默认开启 true
2975
- 注意:此字段可能返回 null,表示取不到有效值。
3348
+ * HTTP访问服务路由信息
2976
3349
  */
2977
- EnableCheckAcrossDomain?: boolean;
3350
+ Routes?: Array<HTTPServiceRoute>;
2978
3351
  /**
2979
- * 自定义路由规则
2980
- 注意:此字段可能返回 null,表示取不到有效值。
3352
+ * 域名创建时间
2981
3353
  */
2982
- CustomRoutingRules?: string;
3354
+ CreateTime?: string;
2983
3355
  /**
2984
- * 默认域名绑定类型,1绑定TCB-CDN,2绑定tcbingres(不经过cdn)
3356
+ * 域名更新时间
2985
3357
  */
2986
- AccessFlag?: number;
3358
+ UpdateTime?: string;
3359
+ }
3360
+ /**
3361
+ * 描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
3362
+ */
3363
+ export interface Filter {
2987
3364
  /**
2988
- * 云接入源站域名
3365
+ * 需要过滤的字段。过滤条件数量限制为10。
2989
3366
  */
2990
- OriginDomain?: string;
3367
+ Name?: string;
2991
3368
  /**
2992
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3369
+ * 字段的过滤值。
2993
3370
  */
2994
- RequestId?: string;
3371
+ Values?: Array<string>;
3372
+ }
3373
+ /**
3374
+ * 本类型用于UpdateTable接口中描述待删除索引信息
3375
+ */
3376
+ export interface DropIndex {
3377
+ /**
3378
+ * 索引名称
3379
+ */
3380
+ IndexName?: string;
2995
3381
  }
2996
3382
  /**
2997
3383
  * 登录配置中密码更新配置策略,用于管理使用用户名密码登录方式时,密码的过期策略和更新策略。例如,首次登录需要更新密码、定期过期密码等策略。
@@ -3044,6 +3430,38 @@ export interface DescribeDatabaseACLRequest {
3044
3430
  */
3045
3431
  CollectionName: string;
3046
3432
  }
3433
+ /**
3434
+ * CreateApiKey返回参数结构体
3435
+ */
3436
+ export interface CreateApiKeyResponse {
3437
+ /**
3438
+ * API Key 的唯一标识符,由系统基于 JWT Access Token Hash 自动生成。后续对该 API Key 进行查询、修改名称或删除操作时,均需使用该值作为定位参数
3439
+ */
3440
+ KeyId?: string;
3441
+ /**
3442
+ * API Key 的名称,即创建时传入的 KeyName 参数值。对于 publish_key 类型,该值固定为 publish_key
3443
+ */
3444
+ Name?: string;
3445
+ /**
3446
+ * API Key 的令牌值(JWT 格式),用于服务端接口调用时的身份认证。出于安全考虑,仅在创建时返回一次完整明文;后续通过列表查询接口获取时,api_key 类型将进行脱敏处理;publish_key 类型始终返回完整明文。请在创建后妥善保存
3447
+ 注意:此字段可能返回 null,表示取不到有效值。
3448
+ */
3449
+ ApiKey?: string;
3450
+ /**
3451
+ * API Key 的过期时间。对于 api_key 类型:若创建时未指定有效期,则该字段不返回,表示永不过期;若指定了有效期,则返回具体的过期时间。对于 publish_key 类型:始终返回,固定为 2099 年
3452
+ 注意:此字段可能返回 null,表示取不到有效值。
3453
+ */
3454
+ ExpireAt?: string;
3455
+ /**
3456
+ * API Key 的创建时间。对于 api_key 类型:为实际创建该 Key 时的时间。对于 publish_key 类型:若环境下已存在 publish_key,则返回首次创建的时间而非本次调用时间
3457
+ 注意:此字段可能返回 null,表示取不到有效值。
3458
+ */
3459
+ CreateAt?: string;
3460
+ /**
3461
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3462
+ */
3463
+ RequestId?: string;
3464
+ }
3047
3465
  /**
3048
3466
  * vm规格
3049
3467
  */
@@ -3140,17 +3558,21 @@ export interface DescribeLoginConfigResponse {
3140
3558
  RequestId?: string;
3141
3559
  }
3142
3560
  /**
3143
- * DeleteCloudBaseGWDomain请求参数结构体
3561
+ * DescribeGatewayVersions请求参数结构体
3144
3562
  */
3145
- export interface DeleteCloudBaseGWDomainRequest {
3563
+ export interface DescribeGatewayVersionsRequest {
3564
+ /**
3565
+ * 环境id
3566
+ */
3567
+ EnvId: string;
3146
3568
  /**
3147
- * 服务ID
3569
+ * 网关id
3148
3570
  */
3149
- ServiceId: string;
3571
+ GatewayId: string;
3150
3572
  /**
3151
- * 服务域名
3573
+ * 版本名
3152
3574
  */
3153
- Domain: string;
3575
+ VersionName?: string;
3154
3576
  }
3155
3577
  /**
3156
3578
  * CreateEnvResource返回参数结构体
@@ -3353,6 +3775,15 @@ export interface DescribeStaticStoreResponse {
3353
3775
  */
3354
3776
  RequestId?: string;
3355
3777
  }
3778
+ /**
3779
+ * ModifyHTTPServiceRoute返回参数结构体
3780
+ */
3781
+ export interface ModifyHTTPServiceRouteResponse {
3782
+ /**
3783
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3784
+ */
3785
+ RequestId?: string;
3786
+ }
3356
3787
  /**
3357
3788
  * GetProviders返回参数结构体
3358
3789
  */
@@ -3455,198 +3886,163 @@ export interface EditAuthConfigRequest {
3455
3886
  UsernameLogin?: string;
3456
3887
  }
3457
3888
  /**
3458
- * 索引的key值
3459
- */
3460
- export interface Indexkey {
3461
- /**
3462
- * 键名
3463
- */
3464
- Name?: string;
3465
- /**
3466
- * 方向:specify 1 for ascending or -1 for descending
3467
- */
3468
- Direction?: string;
3469
- }
3470
- /**
3471
- * StorageInfo 资源信息
3472
- */
3473
- export interface StorageInfo {
3474
- /**
3475
- * 资源所属地域。
3476
- 当前支持ap-shanghai
3477
- */
3478
- Region?: string;
3479
- /**
3480
- * 桶名,存储资源的唯一标识
3481
- */
3482
- Bucket?: string;
3483
- /**
3484
- * cdn 域名
3485
- */
3486
- CdnDomain?: string;
3487
- /**
3488
- * 资源所属用户的腾讯云appId
3489
- */
3490
- AppId?: string;
3491
- }
3492
- /**
3493
- * 修改用户返回值
3889
+ * DescribeVmInstances返回参数结构体
3494
3890
  */
3495
- export interface ModifyUserResp {
3891
+ export interface DescribeVmInstancesResponse {
3496
3892
  /**
3497
- * 是否成功
3893
+ * 主机实例列表
3498
3894
  */
3499
- Success?: boolean;
3500
- }
3501
- /**
3502
- * ModifySafeRule返回参数结构体
3503
- */
3504
- export interface ModifySafeRuleResponse {
3895
+ InstanceList?: Array<VmInstance>;
3505
3896
  /**
3506
3897
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3507
3898
  */
3508
3899
  RequestId?: string;
3509
3900
  }
3510
3901
  /**
3511
- * BindCloudBaseGWDomain返回参数结构体
3902
+ * API Key 访问凭证信息。描述云开发环境下 API Key 的完整信息,包括标识符、名称、令牌值、创建时间和过期时间。支持两种类型:api_key(服务端管理员访问凭证,用于服务端接口调用的身份认证,可设置有效期,单个环境最多 5 个)和 publish_key(前端匿名访问凭证,固定有效期,每个环境仅保留一个)。注意:令牌值(ApiKey 字段)仅在创建时返回完整明文,列表查询时将进行脱敏处理。
3512
3903
  */
3513
- export interface BindCloudBaseGWDomainResponse {
3904
+ export interface ApiKeyToken {
3514
3905
  /**
3515
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3906
+ * API Key 的唯一标识符,由系统基于 UUID 自动生成的 Base64 URL 编码字符串。后续对该 API Key 进行删除、修改名称或精确查询操作时,均需使用该值作为定位参数
3516
3907
  */
3517
- RequestId?: string;
3518
- }
3519
- /**
3520
- * DescribeTable请求参数结构体
3521
- */
3522
- export interface DescribeTableRequest {
3908
+ KeyId?: string;
3523
3909
  /**
3524
- * 表名
3910
+ * API Key 的名称,即创建时传入的 KeyName 参数值。对于 publish_key 类型,该值固定为 publish_key
3525
3911
  */
3526
- TableName: string;
3912
+ Name?: string;
3527
3913
  /**
3528
- * FlecDB实例ID
3914
+ * API Key 的令牌值(JWT 格式),用于服务端接口调用时的身份认证。出于安全考虑,仅在创建时返回一次完整明文;后续通过列表查询接口获取时,api_key 类型将进行脱敏处理;publish_key 类型始终返回完整明文。请在创建后妥善保存
3915
+ 注意:此字段可能返回 null,表示取不到有效值。
3529
3916
  */
3530
- Tag?: string;
3917
+ ApiKey?: string;
3531
3918
  /**
3532
- * 云开发环境ID
3919
+ * API Key 的过期时间,格式遵循 ISO 8601 标准。对于 api_key 类型:若创建时未指定有效期(ExpireIn),则该字段不返回,表示永不过期;若指定了有效期,则返回具体的过期时间。对于 publish_key 类型:始终返回,固定为约 2099 年
3920
+ 注意:此字段可能返回 null,表示取不到有效值。
3533
3921
  */
3534
- EnvId?: string;
3922
+ ExpireAt?: string;
3535
3923
  /**
3536
- * MongoDB连接器配置
3924
+ * API Key 的创建时间,格式遵循 ISO 8601 标准。对于 api_key 类型:为该 Key 实际创建时的时间。对于 publish_key 类型:若环境下已存在 publish_key 记录,则返回首次创建的时间而非本次调用时间
3925
+ 注意:此字段可能返回 null,表示取不到有效值。
3537
3926
  */
3538
- MongoConnector?: MongoConnector;
3927
+ CreateAt?: string;
3539
3928
  }
3540
3929
  /**
3541
- * 环境信息
3930
+ * StorageInfo 资源信息
3542
3931
  */
3543
- export interface EnvInfo {
3544
- /**
3545
- * 账户下该环境唯一标识
3546
- */
3547
- EnvId?: string;
3548
- /**
3549
- * 环境来源。包含以下取值:
3550
- <li>miniapp:微信小程序</li>
3551
- <li>qcloud :腾讯云</li>
3552
- */
3553
- Source?: string;
3554
- /**
3555
- * 环境别名,要以a-z开头,不能包含 a-zA-z0-9- 以外的字符
3556
- */
3557
- Alias?: string;
3558
- /**
3559
- * 创建时间
3560
- */
3561
- CreateTime?: string;
3562
- /**
3563
- * 最后修改时间
3564
- */
3565
- UpdateTime?: string;
3932
+ export interface StorageInfo {
3566
3933
  /**
3567
- * 环境状态。包含以下取值:
3568
- <li>NORMAL:正常可用</li>
3569
- <li>UNAVAILABLE:服务不可用,可能是尚未初始化或者初始化过程中</li>
3934
+ * 资源所属地域。
3935
+ 当前支持ap-shanghai
3570
3936
  */
3571
- Status?: string;
3937
+ Region?: string;
3572
3938
  /**
3573
- * 数据库列表
3939
+ * 桶名,存储资源的唯一标识
3574
3940
  */
3575
- Databases?: Array<DatabasesInfo>;
3941
+ Bucket?: string;
3576
3942
  /**
3577
- * 存储列表
3943
+ * cdn 域名
3578
3944
  */
3579
- Storages?: Array<StorageInfo>;
3945
+ CdnDomain?: string;
3580
3946
  /**
3581
- * 函数列表
3947
+ * 资源所属用户的腾讯云appId
3582
3948
  */
3583
- Functions?: Array<FunctionInfo>;
3949
+ AppId?: string;
3950
+ }
3951
+ /**
3952
+ * 修改用户返回值
3953
+ */
3954
+ export interface ModifyUserResp {
3584
3955
  /**
3585
- * tcb产品套餐ID,参考DescribePackages接口的返回值。
3956
+ * 是否成功
3586
3957
  */
3587
- PackageId?: string;
3958
+ Success?: boolean;
3959
+ }
3960
+ /**
3961
+ * ModifySafeRule返回参数结构体
3962
+ */
3963
+ export interface ModifySafeRuleResponse {
3588
3964
  /**
3589
- * 套餐中文名称,参考DescribePackages接口的返回值。
3965
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3590
3966
  */
3591
- PackageName?: string;
3967
+ RequestId?: string;
3968
+ }
3969
+ /**
3970
+ * DescribeTable请求参数结构体
3971
+ */
3972
+ export interface DescribeTableRequest {
3592
3973
  /**
3593
- * 云日志服务列表
3974
+ * 表名
3594
3975
  */
3595
- LogServices?: Array<LogServiceInfo>;
3976
+ TableName: string;
3596
3977
  /**
3597
- * 静态资源信息
3978
+ * FlecDB实例ID
3598
3979
  */
3599
- StaticStorages?: Array<StaticStorageInfo>;
3980
+ Tag?: string;
3600
3981
  /**
3601
- * 是否到期自动降为免费版
3982
+ * 云开发环境ID
3602
3983
  */
3603
- IsAutoDegrade?: boolean;
3984
+ EnvId?: string;
3604
3985
  /**
3605
- * 环境渠道
3986
+ * MongoDB连接器配置
3606
3987
  */
3607
- EnvChannel?: string;
3988
+ MongoConnector?: MongoConnector;
3989
+ }
3990
+ /**
3991
+ * UpdateTable请求参数结构体
3992
+ */
3993
+ export interface UpdateTableRequest {
3608
3994
  /**
3609
- * 支付方式。包含以下取值:
3610
- <li> prepayment:预付费</li>
3611
- <li> postpaid:后付费</li>
3995
+ * 表名
3612
3996
  */
3613
- PayMode?: string;
3997
+ TableName: string;
3614
3998
  /**
3615
- * 是否为默认环境
3999
+ * FlexDB实例ID
3616
4000
  */
3617
- IsDefault?: boolean;
4001
+ Tag?: string;
3618
4002
  /**
3619
- * 环境所属地域
4003
+ * 待删除索引信息
3620
4004
  */
3621
- Region?: string;
4005
+ DropIndexes?: Array<DropIndex>;
3622
4006
  /**
3623
- * 环境标签列表
4007
+ * 待创建索引信息
3624
4008
  */
3625
- Tags?: Array<Tag>;
4009
+ CreateIndexes?: Array<CreateIndex>;
3626
4010
  /**
3627
- * 自定义日志服务
4011
+ * 云开发环境ID
3628
4012
  */
3629
- CustomLogServices?: Array<ClsInfo>;
4013
+ EnvId?: string;
3630
4014
  /**
3631
- * 环境类型:baas, run, hoting, weda
4015
+ * MongoDB连接器配置
3632
4016
  */
3633
- EnvType?: string;
4017
+ MongoConnector?: MongoConnector;
4018
+ }
4019
+ /**
4020
+ * 外部存储。
4021
+ 标识该存储介质,并非由云开发CloudBase创建,而是绑定的其他存储介质。
4022
+ 目前仅支持 [腾讯云-对象存储](https://cloud.tencent.com/document/product/436)。
4023
+ */
4024
+ export interface ExternalStorage {
3634
4025
  /**
3635
- * 是否是dau新套餐
4026
+ * 桶名。
4027
+ 当 Provider=cos 时,表示腾讯云对象存储桶。
3636
4028
  */
3637
- IsDauPackage?: boolean;
4029
+ BucketName: string;
3638
4030
  /**
3639
- * 套餐类型:空\baas\tcbr
4031
+ * Bucket所属地域。
4032
+ 当 Provider=cos 时,表示腾讯云对象存储桶的所属地域。
3640
4033
  */
3641
- PackageType?: string;
4034
+ Region: string;
3642
4035
  /**
3643
- * 架构类型
4036
+ * 基础路径。
4037
+ 绑定之后,用户访问云存储内的文件,后台会自动以BasePath作为前缀,拼接到所访问的文件中。
4038
+ 例如:
4039
+ BasePath=my-cloudbase-path , 当用户访问云存储内的 /tencentcloud.png 时,实际访问的完整路径是:/my-cloudbase-path/tencentcloud.png
3644
4040
  */
3645
- ArchitectureType?: string;
4041
+ BasePath: string;
3646
4042
  /**
3647
- * 回收标志,默认为空
4043
+ * 是否启用外部存储
3648
4044
  */
3649
- Recycle?: string;
4045
+ Enabled?: boolean;
3650
4046
  }
3651
4047
  /**
3652
4048
  * 合法域名
@@ -3681,19 +4077,6 @@ export interface AuthDomain {
3681
4077
  */
3682
4078
  UpdateTime?: string;
3683
4079
  }
3684
- /**
3685
- * http访问服务路由qps策略
3686
- */
3687
- export interface CloudBaseGWAPIQPSPolicy {
3688
- /**
3689
- * qps限额总量
3690
- */
3691
- QPSTotal?: number;
3692
- /**
3693
- * 客户端限频,如果不限制,LimitBy=None
3694
- */
3695
- QPSPerClient?: CloudBaseClientQPSPolicy;
3696
- }
3697
4080
  /**
3698
4081
  * 云日志服务相关信息
3699
4082
  */
@@ -3763,107 +4146,13 @@ export interface DeleteAuthDomainRequest {
3763
4146
  DomainIds: Array<string>;
3764
4147
  }
3765
4148
  /**
3766
- * CreateBillDeal请求参数结构体
3767
- */
3768
- export interface CreateBillDealRequest {
3769
- /**
3770
- * 当前下单的操作类型,可取[purchase,renew,modify]三种值,分别代表新购,续费,变配。
3771
- */
3772
- DealType: string;
3773
- /**
3774
- * 购买的产品类型,可取[tcb-baas,tcb-promotion,tcb-package], 分别代表baas套餐、大促包、资源包
3775
- */
3776
- ProductType: string;
3777
- /**
3778
- * 目标下单产品/套餐Id。
3779
- 对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName
3780
- */
3781
- PackageId: string;
3782
- /**
3783
- * 默认只下单不支付,为ture则下单并支付。
3784
- 如果需要下单并支付,请确保账户下有足够的余额,否则会导致下单失败。
3785
- */
3786
- CreateAndPay?: boolean;
3787
- /**
3788
- * 购买时长,与TimeUnit字段搭配使用。
3789
- */
3790
- TimeSpan?: number;
3791
- /**
3792
- * 购买时长单位,按各产品规则可选d(天),m(月),y(年),p(一次性)。
3793
- 对于 云开发环境的 新购和续费,目前仅支持 按月购买(即 TimeUnit=m)。
3794
- */
3795
- TimeUnit?: string;
3796
- /**
3797
- * 资源唯一标识。
3798
- 在云开发环境 续费和变配 场景下必传,取值为环境ID。
3799
- */
3800
- ResourceId?: string;
3801
- /**
3802
- * 来源可选[qcloud,miniapp],默认qcloud。
3803
- miniapp表示微信云开发,主要适用于[小程序云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloudservice/wxcloud/billing/price.html)。
3804
-
3805
- */
3806
- Source?: string;
3807
- /**
3808
- * 环境别名,用于新购云开发环境时,给云开发环境起别名。
3809
- 仅当 新购云开发环境(DealType=purchase 并且 ProductType=tcb-baas )时有效。
3810
-
3811
- ### 格式要求
3812
- - 可选字符: 小写字母(a~z)、数字、减号(-)
3813
- - 不能以 减号(-) 开头或结尾
3814
- - 不能有连个连续的 减号(-)
3815
- - 长度不超过20位
3816
- */
3817
- Alias?: string;
3818
- /**
3819
- * 环境id,当购买资源包和大促包时(ProductType取值为tcb-promotion 或 tcb-package)必传,表示资源包在哪个环境下生效。
3820
- */
3821
- EnvId?: string;
3822
- /**
3823
- * 开启超限按量。
3824
- 开启后,当 套餐内的资源点 和 资源包 都用尽后,会自动按量计费。
3825
- 详见 [计费说明](https://cloud.tencent.com/document/product/876/127357)。
3826
- */
3827
- EnableExcess?: boolean;
3828
- /**
3829
- * 变配目标套餐id,对于云开发环境变配场景下必传。
3830
- 对于云开发环境套餐,可通过 DescribeBaasPackageList 接口获取,对应其出参的PackageName
3831
- */
3832
- ModifyPackageId?: string;
3833
- /**
3834
- * jsonstr附加信息
3835
- */
3836
- Extension?: string;
3837
- /**
3838
- * 是否自动选择代金券支付。
3839
- */
3840
- AutoVoucher?: boolean;
3841
- /**
3842
- * 资源类型。
3843
- 代表新购环境(DealType=purchase 并且 ProductType=tcb-baas )时需要发货哪些资源。
3844
- 可取值:flexdb, cos, cdn, scf
3845
-
3846
- */
3847
- ResourceTypes?: Array<string>;
3848
- /**
3849
- * 环境标签。
3850
- 代表新购环境(DealType=purchase 并且 ProductType=tcb-baas )时需要打的标签。
3851
-
3852
- */
3853
- EnvTags?: Array<Tag>;
3854
- }
3855
- /**
3856
- * http service选项
4149
+ * CreateHTTPServiceRoute返回参数结构体
3857
4150
  */
3858
- export interface CloudBaseOption {
3859
- /**
3860
- * 键
3861
- */
3862
- Key: string;
4151
+ export interface CreateHTTPServiceRouteResponse {
3863
4152
  /**
3864
- *
4153
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3865
4154
  */
3866
- Value: string;
4155
+ RequestId?: string;
3867
4156
  }
3868
4157
  /**
3869
4158
  * 索引信息
@@ -3920,27 +4209,6 @@ export interface ModifyClientRequest {
3920
4209
  */
3921
4210
  AccessTokenExpiresIn?: number;
3922
4211
  }
3923
- /**
3924
- * DescribeCloudBaseGWService请求参数结构体
3925
- */
3926
- export interface DescribeCloudBaseGWServiceRequest {
3927
- /**
3928
- * 服务ID
3929
- */
3930
- ServiceId?: string;
3931
- /**
3932
- * 服务域名
3933
- */
3934
- Domain?: string;
3935
- /**
3936
- * 是否启用多地域
3937
- */
3938
- EnableRegion?: boolean;
3939
- /**
3940
- * 是否启用统一域名
3941
- */
3942
- EnableUnion?: boolean;
3943
- }
3944
4212
  /**
3945
4213
  * 三方认证出参映射。如果您的对接方不标准,则可以使用这个参数。默认情况下,该参数可以为空。比如:microsoft, github,google,apple 接入,这些参数为空,但是国内的腾讯,新浪等则需要配置该参数。原因主要是:腾讯等公司在实现oauth时,未能完全遵循oauth标准。
3946
4214
  */
@@ -4027,39 +4295,79 @@ export interface SearchClsLogRequest {
4027
4295
  */
4028
4296
  QueryString: string;
4029
4297
  /**
4030
- * 单次要返回的日志条数,单次返回的最大条数为100
4298
+ * 单次要返回的日志条数,单次返回的最大条数为100
4299
+ */
4300
+ Limit: number;
4301
+ /**
4302
+ * 加载更多使用,透传上次返回的 context 值,获取后续的日志内容,通过游标最多可获取10000条,请尽可能缩小时间范围
4303
+ */
4304
+ Context?: string;
4305
+ /**
4306
+ * 按时间排序 asc(升序)或者 desc(降序),默认为 desc
4307
+ */
4308
+ Sort?: string;
4309
+ /**
4310
+ * 是否使用Lucene语法,默认为false
4311
+ */
4312
+ UseLucene?: boolean;
4313
+ }
4314
+ /**
4315
+ * InquireVmPrice请求参数结构体
4316
+ */
4317
+ export interface InquireVmPriceRequest {
4318
+ /**
4319
+ * 服务器类型:
4320
+ LightHouse = 轻量云服务器
4321
+ CVM = 云服务器
4322
+ */
4323
+ Type: string;
4324
+ /**
4325
+ * 轻量云服务器套餐ID。
4326
+ 当Type=LightHouse时必传
4327
+ */
4328
+ LightHouseBundleId?: string;
4329
+ /**
4330
+ * 轻量云服务器镜像ID。当Type=LightHouse时必传
4331
+ */
4332
+ LightHouseBlueprintId?: string;
4333
+ }
4334
+ /**
4335
+ * CheckTcbService请求参数结构体
4336
+ */
4337
+ export type CheckTcbServiceRequest = null;
4338
+ /**
4339
+ * 创建或修改HTTP访问服务输入的域名信息,修改HTTP访问服务域名时对应字段不传参数表示不需要修改。
4340
+ */
4341
+ export interface HTTPServiceDomainParam {
4342
+ /**
4343
+ * 域名。全局唯一。如果域名在其他环境下占用或者腾讯云CDN占用,可能会导致创建失败
4344
+ */
4345
+ Domain: string;
4346
+ /**
4347
+ * 绑定类型。默认DIRECT。DIRECT: 直连到HTTP访问服务, CDN: 接入云开发CDN,CUSTOM: 自定义接入类型(其他CDN或者WAF)
4031
4348
  */
4032
- Limit: number;
4349
+ AccessType?: string;
4033
4350
  /**
4034
- * 加载更多使用,透传上次返回的 context 值,获取后续的日志内容,通过游标最多可获取10000条,请尽可能缩小时间范围
4351
+ * 证书ID。当前账户下SSL平台的证书ID
4035
4352
  */
4036
- Context?: string;
4353
+ CertId?: string;
4037
4354
  /**
4038
- * 按时间排序 asc(升序)或者 desc(降序),默认为 desc
4355
+ * 协议类型。默认HTTP_AND_HTTPS。HTTP_AND_HTTPS: 同时开启http和https,HTTP_TO_HTTPS: http重定向成https,HTTPS_TO_HTTP: https重定向成http。如果未配置证书无法访问https或者进行重定向
4039
4356
  */
4040
- Sort?: string;
4357
+ Protocol?: string;
4041
4358
  /**
4042
- * 是否使用Lucene语法,默认为false
4359
+ * 自定义CNAME。对应AccessType: Custom
4043
4360
  */
4044
- UseLucene?: boolean;
4045
- }
4046
- /**
4047
- * MongoDB连接器配置
4048
- */
4049
- export interface MongoConnector {
4361
+ CustomCname?: string;
4050
4362
  /**
4051
- * 连接器实例ID
4363
+ * 域名开启状态,不传默认开启
4052
4364
  */
4053
- InstanceId?: string;
4365
+ Enable?: boolean;
4054
4366
  /**
4055
- * MongoDB数据库名
4367
+ * 创建/修改的HTTP访问服务路由列表。如果不传,仅创建或修改域名信息。列表最大支持传入20个
4056
4368
  */
4057
- DatabaseName?: string;
4369
+ Routes?: Array<HTTPServiceRouteParam>;
4058
4370
  }
4059
- /**
4060
- * CheckTcbService请求参数结构体
4061
- */
4062
- export type CheckTcbServiceRequest = null;
4063
4371
  /**
4064
4372
  * FlexDB数据库权限信息
4065
4373
  */
@@ -4102,18 +4410,27 @@ export interface Pager {
4102
4410
  Total?: number;
4103
4411
  }
4104
4412
  /**
4105
- * DeleteCloudBaseGWAPI返回参数结构体
4413
+ * DeleteVmInstance返回参数结构体
4106
4414
  */
4107
- export interface DeleteCloudBaseGWAPIResponse {
4108
- /**
4109
- * 最终删除API个数
4110
- */
4111
- Count?: number;
4415
+ export interface DeleteVmInstanceResponse {
4112
4416
  /**
4113
4417
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4114
4418
  */
4115
4419
  RequestId?: string;
4116
4420
  }
4421
+ /**
4422
+ * 标签键值对
4423
+ */
4424
+ export interface Tag {
4425
+ /**
4426
+ * 标签键
4427
+ */
4428
+ Key: string;
4429
+ /**
4430
+ * 标签值
4431
+ */
4432
+ Value: string;
4433
+ }
4117
4434
  /**
4118
4435
  * CreateEnv请求参数结构体
4119
4436
  */
@@ -4169,6 +4486,23 @@ export interface CreateEnvRequest {
4169
4486
  */
4170
4487
  RenewFlag?: string;
4171
4488
  }
4489
+ /**
4490
+ * DeleteHTTPServiceRoute请求参数结构体
4491
+ */
4492
+ export interface DeleteHTTPServiceRouteRequest {
4493
+ /**
4494
+ * 环境ID
4495
+ */
4496
+ EnvId: string;
4497
+ /**
4498
+ * 域名
4499
+ */
4500
+ Domain: string;
4501
+ /**
4502
+ * 路径列表。为空则表示删除此域名和所有路由
4503
+ */
4504
+ Paths?: Array<string>;
4505
+ }
4172
4506
  /**
4173
4507
  * RunCommands请求参数结构体
4174
4508
  */
@@ -4257,6 +4591,31 @@ export interface MessageLocalized {
4257
4591
  */
4258
4592
  Locale: string;
4259
4593
  }
4594
+ /**
4595
+ * 安全网关自定义配置
4596
+ */
4597
+ export interface WxGatewayCustomConfig {
4598
+ /**
4599
+ * 是否开启x-real-ip
4600
+ */
4601
+ IsOpenXRealIp?: boolean;
4602
+ /**
4603
+ * 封禁配置
4604
+ */
4605
+ BanConfig?: BanConfig;
4606
+ /**
4607
+ * 获取源ip方式,PPV1(Proxy Protocol V1)、PPV2(Proxy Protocol V2)、TOA(tcp option address)
4608
+ */
4609
+ SourceIpType?: string;
4610
+ /**
4611
+ * 日志信息
4612
+ */
4613
+ LogConfig?: CustomLogConfig;
4614
+ /**
4615
+ * 是否开启http1.0
4616
+ */
4617
+ IsAcceptHttpOne?: boolean;
4618
+ }
4260
4619
  /**
4261
4620
  * CreateUser请求参数结构体
4262
4621
  */
@@ -4324,63 +4683,50 @@ export interface DescribeTableResponse {
4324
4683
  RequestId?: string;
4325
4684
  }
4326
4685
  /**
4327
- * UpdateTable请求参数结构体
4686
+ * DescribeDatabaseACL返回参数结构体
4328
4687
  */
4329
- export interface UpdateTableRequest {
4330
- /**
4331
- * 表名
4332
- */
4333
- TableName: string;
4334
- /**
4335
- * FlexDB实例ID
4336
- */
4337
- Tag?: string;
4688
+ export interface DescribeDatabaseACLResponse {
4338
4689
  /**
4339
- * 待删除索引信息
4690
+ * 权限标签。包含以下取值:
4691
+ <li> READONLY:所有用户可读,仅创建者和管理员可写</li>
4692
+ <li> PRIVATE:仅创建者及管理员可读写</li>
4693
+ <li> ADMINWRITE:所有用户可读,仅管理员可写</li>
4694
+ <li> ADMINONLY:仅管理员可读写</li>
4340
4695
  */
4341
- DropIndexes?: Array<DropIndex>;
4696
+ AclTag?: string;
4342
4697
  /**
4343
- * 待创建索引信息
4698
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4344
4699
  */
4345
- CreateIndexes?: Array<CreateIndex>;
4700
+ RequestId?: string;
4701
+ }
4702
+ /**
4703
+ * 虚拟主机价格
4704
+ */
4705
+ export interface VMPrice {
4346
4706
  /**
4347
- * 云开发环境ID
4707
+ * 价格货币单位。取值范围CNY:人民币。USD:美元。
4348
4708
  */
4349
- EnvId?: string;
4709
+ Currency?: string;
4350
4710
  /**
4351
- * MongoDB连接器配置
4711
+ * 原始价格
4352
4712
  */
4353
- MongoConnector?: MongoConnector;
4354
- }
4355
- /**
4356
- * DeleteCloudBaseGWDomain返回参数结构体
4357
- */
4358
- export interface DeleteCloudBaseGWDomainResponse {
4713
+ OriginalPrice?: number;
4359
4714
  /**
4360
- * 删除个数
4715
+ * 折扣率
4361
4716
  */
4362
- Count?: number;
4717
+ Discount?: number;
4363
4718
  /**
4364
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4719
+ * 折扣后的价格
4365
4720
  */
4366
- RequestId?: string;
4367
- }
4368
- /**
4369
- * DescribeDatabaseACL返回参数结构体
4370
- */
4371
- export interface DescribeDatabaseACLResponse {
4721
+ DiscountPrice?: number;
4372
4722
  /**
4373
- * 权限标签。包含以下取值:
4374
- <li> READONLY:所有用户可读,仅创建者和管理员可写</li>
4375
- <li> PRIVATE:仅创建者及管理员可读写</li>
4376
- <li> ADMINWRITE:所有用户可读,仅管理员可写</li>
4377
- <li> ADMINONLY:仅管理员可读写</li>
4723
+ * 折扣前每天资源点
4378
4724
  */
4379
- AclTag?: string;
4725
+ OriginalCredits?: number;
4380
4726
  /**
4381
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4727
+ * 折扣后每天所需资源点
4382
4728
  */
4383
- RequestId?: string;
4729
+ DiscountCredits?: number;
4384
4730
  }
4385
4731
  /**
4386
4732
  * DeleteProvider请求参数结构体
@@ -4424,85 +4770,6 @@ export interface ModifyProviderResponse {
4424
4770
  */
4425
4771
  RequestId?: string;
4426
4772
  }
4427
- /**
4428
- * 网关服务
4429
- */
4430
- export interface CloudBaseGWService {
4431
- /**
4432
- * 服务ID
4433
- */
4434
- ServiceId?: string;
4435
- /**
4436
- * 服务域名
4437
- */
4438
- Domain?: string;
4439
- /**
4440
- * 开启时间
4441
- */
4442
- OpenTime?: number;
4443
- /**
4444
- * 绑定状态,1 绑定中;2绑定失败;3绑定成功
4445
- 注意:此字段可能返回 null,表示取不到有效值。
4446
- */
4447
- Status?: number;
4448
- /**
4449
- * 是否被抢占, 被抢占表示域名被其他环境绑定了,需要解绑或者重新绑定。
4450
- 注意:此字段可能返回 null,表示取不到有效值。
4451
- */
4452
- IsPreempted?: boolean;
4453
- /**
4454
- * 是否开启多地域
4455
- 注意:此字段可能返回 null,表示取不到有效值。
4456
- */
4457
- EnableRegion?: boolean;
4458
- /**
4459
- * cdn CName地址
4460
- 注意:此字段可能返回 null,表示取不到有效值。
4461
- */
4462
- Cname?: string;
4463
- /**
4464
- * 统一域名状态
4465
- 注意:此字段可能返回 null,表示取不到有效值。
4466
- */
4467
- UnionStatus?: number;
4468
- /**
4469
- * CName状态
4470
- 注意:此字段可能返回 null,表示取不到有效值。
4471
- */
4472
- CnameStatus?: number;
4473
- /**
4474
- * 证书Id
4475
- 注意:此字段可能返回 null,表示取不到有效值。
4476
- */
4477
- CertId?: string;
4478
- /**
4479
- * 是否强制https
4480
- 注意:此字段可能返回 null,表示取不到有效值。
4481
- */
4482
- ForceHttps?: boolean;
4483
- /**
4484
- * icp黑名单封禁状态,0-未封禁,1-封禁
4485
- 注意:此字段可能返回 null,表示取不到有效值。
4486
- */
4487
- IcpForbidStatus?: number;
4488
- /**
4489
- * 自定义路由规则
4490
- 注意:此字段可能返回 null,表示取不到有效值。
4491
- */
4492
- CustomRoutingRules?: string;
4493
- /**
4494
- * 绑定类型,1绑定cdn,2源站,4自定义
4495
- */
4496
- BindFlag?: number;
4497
- /**
4498
- * TcbIngress源站cname
4499
- */
4500
- OriginCname?: string;
4501
- /**
4502
- * 自定义cname
4503
- */
4504
- CustomCname?: string;
4505
- }
4506
4773
  /**
4507
4774
  * ModifyEnv请求参数结构体
4508
4775
  */
@@ -4566,128 +4833,87 @@ export interface ModifyUserRequest {
4566
4833
  Description?: string;
4567
4834
  }
4568
4835
  /**
4569
- * BindCloudBaseGWDomain请求参数结构体
4570
- */
4571
- export interface BindCloudBaseGWDomainRequest {
4572
- /**
4573
- * 服务ID
4574
- */
4575
- ServiceId: string;
4576
- /**
4577
- * 服务域名
4578
- */
4579
- Domain: string;
4580
- /**
4581
- * 证书ID
4582
- */
4583
- CertId?: string;
4584
- /**
4585
- * 是否启用多地域
4586
- */
4587
- EnableRegion?: boolean;
4588
- }
4589
- /**
4590
- * 创建用户返回结果
4591
- */
4592
- export interface CreateUserResp {
4593
- /**
4594
- * 用户ID
4595
- */
4596
- Uid?: string;
4597
- }
4598
- /**
4599
- * tcb 网关API
4836
+ * 创建或修改HTTP访问服务输入的路由信息,修改HTTP访问服务路由信息时对应字段不传参数表示不用修改。
4600
4837
  */
4601
- export interface CloudBaseGWAPI {
4602
- /**
4603
- * 服务ID
4604
- */
4605
- ServiceId?: string;
4838
+ export interface HTTPServiceRouteParam {
4606
4839
  /**
4607
- * API ID
4840
+ * 路径
4608
4841
  */
4609
- APIId?: string;
4610
- /**
4611
- * API Path
4612
- */
4613
- Path?: string;
4842
+ Path: string;
4614
4843
  /**
4615
- * API 类型
4844
+ * 上游服务类型。创建时必填,修改时可选填。SCF: 云函数,CBR: 云托管,STATIC_STORE: 静态托管,WEB_SCF: WEB云函数,LH: Lighthouse
4616
4845
  */
4617
- Type?: number;
4846
+ UpstreamResourceType?: string;
4618
4847
  /**
4619
- * API 名
4848
+ * 上游服务名。创建时必填,修改时可选填
4620
4849
  */
4621
- Name?: string;
4850
+ UpstreamResourceName?: string;
4622
4851
  /**
4623
- * API创建时间
4852
+ * 路径重写
4624
4853
  */
4625
- CreateTime?: number;
4854
+ PathRewrite?: HTTPServicePathRewrite;
4626
4855
  /**
4627
- * 自定义值通用字段:
4628
- Type为1时,该值为空。
4629
- Type为2时,该值为容器的代理IP:PORT数组。
4856
+ * 是否开启安全域名。默认开启
4630
4857
  */
4631
- Custom?: string;
4858
+ EnableSafeDomain?: boolean;
4632
4859
  /**
4633
- * 表示是否开启认证
4634
- 注意:此字段可能返回 null,表示取不到有效值。
4860
+ * 是否开启身份认证。默认关闭
4635
4861
  */
4636
4862
  EnableAuth?: boolean;
4637
4863
  /**
4638
- * 云开发环境ID
4639
- 注意:此字段可能返回 null,表示取不到有效值。
4864
+ * 是否开启路径透传。默认关闭
4640
4865
  */
4641
- EnvId?: string;
4866
+ EnablePathTransmission?: boolean;
4642
4867
  /**
4643
- * 访问类型(该参数暂不对外暴露)
4644
- 注意:此字段可能返回 null,表示取不到有效值。
4868
+ * QPS限频策略
4645
4869
  */
4646
- AccessType?: number;
4870
+ QPSPolicy?: HTTPServiceRouteQPSPolicy;
4647
4871
  /**
4648
- * 统一发布状态
4649
- 注意:此字段可能返回 null,表示取不到有效值。
4872
+ * 是否开启路由
4650
4873
  */
4651
- UnionStatus?: number;
4874
+ Enable?: boolean;
4875
+ }
4876
+ /**
4877
+ * InquireVmPrice返回参数结构体
4878
+ */
4879
+ export interface InquireVmPriceResponse {
4652
4880
  /**
4653
- * 域名(*表示所有域名)
4654
- 注意:此字段可能返回 null,表示取不到有效值。
4881
+ * 价格货币单位。取值范围CNY:人民币。USD:美元。
4655
4882
  */
4656
- Domain?: string;
4883
+ Currency?: string;
4657
4884
  /**
4658
- * 是否有路径冲突
4659
- 注意:此字段可能返回 null,表示取不到有效值。
4885
+ * 原价(主机原始每月价格)
4660
4886
  */
4661
- ConflictFlag?: boolean;
4887
+ OriginalPrice?: number;
4662
4888
  /**
4663
- * 域名状态
4664
- 注意:此字段可能返回 null,表示取不到有效值。
4889
+ * 折扣率
4665
4890
  */
4666
- DomainStatus?: number;
4891
+ Discount?: number;
4667
4892
  /**
4668
- * 是否开启路径透传,默认true表示短路径,即不开启(已弃用)
4669
- 注意:此字段可能返回 null,表示取不到有效值。
4893
+ * 折扣后每月价格
4670
4894
  */
4671
- IsShortPath?: boolean;
4895
+ DiscountPrice?: number;
4672
4896
  /**
4673
- * 路径透传,默认0关闭,1开启,2关闭
4674
- 注意:此字段可能返回 null,表示取不到有效值。
4897
+ * 折扣前每天资源点
4675
4898
  */
4676
- PathTransmission?: number;
4899
+ OriginalCredits?: number;
4677
4900
  /**
4678
- * 跨域校验,默认0开启,1开启,2关闭
4679
- 注意:此字段可能返回 null,表示取不到有效值。
4901
+ * 折扣后每天资源点
4680
4902
  */
4681
- EnableCheckAcrossDomain?: number;
4903
+ DiscountCredits?: number;
4682
4904
  /**
4683
- * 静态托管文件目录
4684
- 注意:此字段可能返回 null,表示取不到有效值。
4905
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4685
4906
  */
4686
- StaticFileDirectory?: string;
4907
+ RequestId?: string;
4908
+ }
4909
+ /**
4910
+ * 创建用户返回结果
4911
+ */
4912
+ export interface CreateUserResp {
4687
4913
  /**
4688
- * QPS策略
4914
+ * 用户ID
4689
4915
  */
4690
- QPSPolicy?: CloudBaseGWAPIQPSPolicy;
4916
+ Uid?: string;
4691
4917
  }
4692
4918
  /**
4693
4919
  * ModifyLoginConfig返回参数结构体
@@ -4698,3 +4924,24 @@ export interface ModifyLoginConfigResponse {
4698
4924
  */
4699
4925
  RequestId?: string;
4700
4926
  }
4927
+ /**
4928
+ * CreateApiKey请求参数结构体
4929
+ */
4930
+ export interface CreateApiKeyRequest {
4931
+ /**
4932
+ * 环境 ID,用于标识该密钥归属的云开发环境,不同环境之间的数据相互隔离
4933
+ */
4934
+ EnvId: string;
4935
+ /**
4936
+ * 密钥类型。可选值:api_key(服务端调用使用的 API 密钥,具有完整权限,请勿暴露在客户端)、publish_key(客户端使用的公开密钥,权限受限,可安全用于前端或移动端)。
4937
+ */
4938
+ KeyType: string;
4939
+ /**
4940
+ * 密钥的自定义名称,用于在管理列表中标识和区分不同的密钥,建议填写能体现用途或归属的描述性名称,例如:server-prod、mobile-test
4941
+ */
4942
+ KeyName?: string;
4943
+ /**
4944
+ * 密钥的有效期,单位为秒,最短不得低于 7200 秒。超过有效期后密钥将自动失效。不设置或设置为 0 则表示永不过期,建议根据安全需求合理设置有效期
4945
+ */
4946
+ ExpireIn?: number;
4947
+ }