tccli 3.0.1124.1__py2.py3-none-any.whl → 3.0.1126.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/cls/v20201016/api.json +1 -1
  3. tccli/services/cynosdb/v20190107/api.json +13 -10
  4. tccli/services/cynosdb/v20190107/examples.json +5 -5
  5. tccli/services/dlc/dlc_client.py +602 -72
  6. tccli/services/dlc/v20210125/api.json +856 -25
  7. tccli/services/dlc/v20210125/examples.json +86 -0
  8. tccli/services/domain/v20180808/api.json +702 -40
  9. tccli/services/domain/v20180808/examples.json +13 -13
  10. tccli/services/dts/v20180330/api.json +62 -37
  11. tccli/services/dts/v20180330/examples.json +1 -1
  12. tccli/services/eb/v20210416/api.json +63 -45
  13. tccli/services/eb/v20210416/examples.json +3 -9
  14. tccli/services/emr/v20190103/api.json +20 -0
  15. tccli/services/ess/v20201111/api.json +1 -1
  16. tccli/services/essbasic/v20210526/api.json +1 -1
  17. tccli/services/iotexplorer/v20190423/api.json +10 -10
  18. tccli/services/iotexplorer/v20190423/examples.json +1 -1
  19. tccli/services/mongodb/v20190725/api.json +18 -13
  20. tccli/services/monitor/v20180724/api.json +3 -2
  21. tccli/services/monitor/v20180724/examples.json +2 -2
  22. tccli/services/ocr/v20181119/api.json +4 -4
  23. tccli/services/ocr/v20181119/examples.json +1 -1
  24. tccli/services/postgres/postgres_client.py +57 -4
  25. tccli/services/postgres/v20170312/api.json +415 -284
  26. tccli/services/postgres/v20170312/examples.json +29 -15
  27. tccli/services/redis/redis_client.py +53 -0
  28. tccli/services/redis/v20180412/api.json +151 -0
  29. tccli/services/redis/v20180412/examples.json +8 -0
  30. tccli/services/rum/v20210622/examples.json +2 -2
  31. tccli/services/smh/v20210712/api.json +2 -2
  32. tccli/services/teo/teo_client.py +216 -4
  33. tccli/services/teo/v20220901/api.json +380 -5
  34. tccli/services/teo/v20220901/examples.json +32 -0
  35. tccli/services/tione/v20211111/api.json +70 -3
  36. tccli/services/tione/v20211111/examples.json +1 -1
  37. tccli/services/tse/tse_client.py +53 -0
  38. tccli/services/tse/v20201207/api.json +43 -0
  39. tccli/services/tse/v20201207/examples.json +8 -0
  40. tccli/services/vtc/v20240223/api.json +20 -0
  41. tccli/services/wedata/v20210820/api.json +20 -0
  42. {tccli-3.0.1124.1.dist-info → tccli-3.0.1126.1.dist-info}/METADATA +2 -2
  43. {tccli-3.0.1124.1.dist-info → tccli-3.0.1126.1.dist-info}/RECORD +46 -46
  44. {tccli-3.0.1124.1.dist-info → tccli-3.0.1126.1.dist-info}/WHEEL +0 -0
  45. {tccli-3.0.1124.1.dist-info → tccli-3.0.1126.1.dist-info}/entry_points.txt +0 -0
  46. {tccli-3.0.1124.1.dist-info → tccli-3.0.1126.1.dist-info}/license_files/LICENSE +0 -0
@@ -50,7 +50,7 @@
50
50
  "status": "online"
51
51
  },
52
52
  "CreateInstances": {
53
- "document": "本接口 (CreateInstances) 用于创建一个或者多个PostgreSQL实例,通过此接口创建的实例无需进行初始化,可直接使用。\n<li>实例创建成功后将自动开机启动,实例状态变为“运行中”。\n<li>预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。",
53
+ "document": "本接口 (CreateInstances) 用于创建一个或者多个PostgreSQL实例,通过此接口创建的实例无需进行初始化,可直接使用。\n<li>实例创建成功后将自动开机启动,实例状态变为“运行中”。</li>\n<li>预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。</li>",
54
54
  "input": "CreateInstancesRequest",
55
55
  "name": "创建实例",
56
56
  "output": "CreateInstancesResponse",
@@ -595,6 +595,13 @@
595
595
  "output": "RestartDBInstanceResponse",
596
596
  "status": "online"
597
597
  },
598
+ "RestoreDBInstanceObjects": {
599
+ "document": "根据备份集或恢复目标时间,在原实例上恢复数据库相关对象,例如数据库、表。",
600
+ "input": "RestoreDBInstanceObjectsRequest",
601
+ "name": "恢复数据库对象",
602
+ "output": "RestoreDBInstanceObjectsResponse",
603
+ "status": "online"
604
+ },
598
605
  "SetAutoRenewFlag": {
599
606
  "document": "本接口(SetAutoRenewFlag)用于设置自动续费。",
600
607
  "input": "SetAutoRenewFlagRequest",
@@ -892,7 +899,7 @@
892
899
  {
893
900
  "disabled": false,
894
901
  "document": "备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。",
895
- "example": "",
902
+ "example": "NONE",
896
903
  "member": "string",
897
904
  "name": "RestrictionType",
898
905
  "required": false,
@@ -901,7 +908,7 @@
901
908
  {
902
909
  "disabled": false,
903
910
  "document": "vpc限制效力,ALLOW 允许;DENY 拒绝。",
904
- "example": "",
911
+ "example": "ALLOW",
905
912
  "member": "string",
906
913
  "name": "VpcRestrictionEffect",
907
914
  "required": false,
@@ -910,7 +917,7 @@
910
917
  {
911
918
  "disabled": false,
912
919
  "document": "允许或拒绝下载备份文件的vpcId列表。",
913
- "example": "",
920
+ "example": "[ \"vpc-15ld6dhr\" ]",
914
921
  "member": "string",
915
922
  "name": "VpcIdSet",
916
923
  "required": false,
@@ -919,7 +926,7 @@
919
926
  {
920
927
  "disabled": false,
921
928
  "document": "ip限制效力,ALLOW 允许;DENY 拒绝。",
922
- "example": "",
929
+ "example": "ALLOW",
923
930
  "member": "string",
924
931
  "name": "IpRestrictionEffect",
925
932
  "required": false,
@@ -928,7 +935,7 @@
928
935
  {
929
936
  "disabled": false,
930
937
  "document": "允许或拒绝下载备份文件的ip列表。",
931
- "example": "",
938
+ "example": "[ \"10.10.10.220\" ]",
932
939
  "member": "string",
933
940
  "name": "IpSet",
934
941
  "required": false,
@@ -1191,60 +1198,60 @@
1191
1198
  {
1192
1199
  "disabled": false,
1193
1200
  "document": "规格ID",
1194
- "example": "",
1201
+ "example": "pg.it.2xlarge16",
1195
1202
  "member": "string",
1196
1203
  "name": "SpecCode",
1197
- "required": true,
1204
+ "output_required": true,
1198
1205
  "type": "string",
1199
1206
  "value_allowed_null": false
1200
1207
  },
1201
1208
  {
1202
1209
  "disabled": false,
1203
1210
  "document": "CPU核数",
1204
- "example": "",
1211
+ "example": "16",
1205
1212
  "member": "uint64",
1206
1213
  "name": "CPU",
1207
- "required": true,
1214
+ "output_required": true,
1208
1215
  "type": "int",
1209
1216
  "value_allowed_null": false
1210
1217
  },
1211
1218
  {
1212
1219
  "disabled": false,
1213
1220
  "document": "内存大小,单位:MB",
1214
- "example": "",
1221
+ "example": "131072",
1215
1222
  "member": "uint64",
1216
1223
  "name": "Memory",
1217
- "required": true,
1224
+ "output_required": true,
1218
1225
  "type": "int",
1219
1226
  "value_allowed_null": false
1220
1227
  },
1221
1228
  {
1222
1229
  "disabled": false,
1223
1230
  "document": "该规格所支持最大存储容量,单位:GB",
1224
- "example": "",
1231
+ "example": "3000",
1225
1232
  "member": "uint64",
1226
1233
  "name": "MaxStorage",
1227
- "required": true,
1234
+ "output_required": true,
1228
1235
  "type": "int",
1229
1236
  "value_allowed_null": false
1230
1237
  },
1231
1238
  {
1232
1239
  "disabled": false,
1233
1240
  "document": "该规格所支持最小存储容量,单位:GB",
1234
- "example": "",
1241
+ "example": "1000",
1235
1242
  "member": "uint64",
1236
1243
  "name": "MinStorage",
1237
- "required": true,
1244
+ "output_required": true,
1238
1245
  "type": "int",
1239
1246
  "value_allowed_null": false
1240
1247
  },
1241
1248
  {
1242
1249
  "disabled": false,
1243
1250
  "document": "该规格的预估QPS",
1244
- "example": "",
1251
+ "example": "79000",
1245
1252
  "member": "uint64",
1246
1253
  "name": "QPS",
1247
- "required": true,
1254
+ "output_required": true,
1248
1255
  "type": "int",
1249
1256
  "value_allowed_null": false
1250
1257
  }
@@ -1266,7 +1273,7 @@
1266
1273
  {
1267
1274
  "disabled": false,
1268
1275
  "document": "售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。",
1269
- "example": "",
1276
+ "example": "pg.it.2xlarge16",
1270
1277
  "member": "string",
1271
1278
  "name": "SpecCode",
1272
1279
  "required": true,
@@ -1283,7 +1290,7 @@
1283
1290
  },
1284
1291
  {
1285
1292
  "disabled": false,
1286
- "document": "购买时长,单位:月。\n<li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36\n<li>后付费:只支持1",
1293
+ "document": "购买时长,单位:月。\n\n- 预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36\n- 后付费:只支持1\n",
1287
1294
  "example": "1",
1288
1295
  "member": "int64",
1289
1296
  "name": "Period",
@@ -1292,7 +1299,7 @@
1292
1299
  },
1293
1300
  {
1294
1301
  "disabled": false,
1295
- "document": "续费标记:\n<li>0:手动续费\n<li>1:自动续费\n默认值:0",
1302
+ "document": "续费标记:\n\n- 0:手动续费\n- 1:自动续费\n\n默认值:0",
1296
1303
  "example": "1",
1297
1304
  "member": "int64",
1298
1305
  "name": "AutoRenewFlag",
@@ -1302,7 +1309,7 @@
1302
1309
  {
1303
1310
  "disabled": false,
1304
1311
  "document": "私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。",
1305
- "example": "",
1312
+ "example": "vpc-2ot3acw1",
1306
1313
  "member": "string",
1307
1314
  "name": "VpcId",
1308
1315
  "required": true,
@@ -1311,7 +1318,7 @@
1311
1318
  {
1312
1319
  "disabled": false,
1313
1320
  "document": "私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。",
1314
- "example": "",
1321
+ "example": "subnet-ppv9iw34",
1315
1322
  "member": "string",
1316
1323
  "name": "SubnetId",
1317
1324
  "required": true,
@@ -1328,7 +1335,7 @@
1328
1335
  },
1329
1336
  {
1330
1337
  "disabled": false,
1331
- "document": "实例计费类型,目前支持:\n<li>PREPAID:预付费,即包年包月\n<li>POSTPAID_BY_HOUR:后付费,即按量计费\n默认值:PREPAID",
1338
+ "document": "实例计费类型,目前支持:\n\n- PREPAID:预付费,即包年包月\n- POSTPAID_BY_HOUR:后付费,即按量计费\n\n默认值:PREPAID",
1332
1339
  "example": "PREPAID",
1333
1340
  "member": "string",
1334
1341
  "name": "InstanceChargeType",
@@ -1338,7 +1345,7 @@
1338
1345
  {
1339
1346
  "disabled": false,
1340
1347
  "document": "实例所属安全组,该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。\n",
1341
- "example": "",
1348
+ "example": "[ { \"SecurityGroupId\": \"sg-05bb4upy\", \"SecurityGroupName\": \"TestGroup\", \"SecurityGroupDesc\": \"test-group-desc\", \"ProjectId\": \"0\", \"IsDefault\": true, \"CreatedTime\": \"2017-04-18 21:02:30\", \"UpdateTime\": \"\", \"TagSet\": [] } ]",
1342
1349
  "member": "string",
1343
1350
  "name": "SecurityGroupIds",
1344
1351
  "required": false,
@@ -1347,7 +1354,7 @@
1347
1354
  {
1348
1355
  "disabled": false,
1349
1356
  "document": "项目ID。",
1350
- "example": "",
1357
+ "example": "0",
1351
1358
  "member": "int64",
1352
1359
  "name": "ProjectId",
1353
1360
  "required": false,
@@ -1356,7 +1363,7 @@
1356
1363
  {
1357
1364
  "disabled": false,
1358
1365
  "document": "实例需要绑定的Tag信息,默认为空;可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。",
1359
- "example": "",
1366
+ "example": "[ { \"TagKey\": \"abc\", \"TagValue\": \"123\", \"CanDelete\": 1 } ]",
1360
1367
  "member": "Tag",
1361
1368
  "name": "TagList",
1362
1369
  "required": false,
@@ -1365,7 +1372,7 @@
1365
1372
  {
1366
1373
  "disabled": false,
1367
1374
  "document": "实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。\n可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。",
1368
- "example": "",
1375
+ "example": "[ { \"Role\": \"Standby\", \"Zone\": \"ap-guangzhou-3\" }, { \"Role\": \"Primary\", \"Zone\": \"ap-guangzhou-3\" } ]",
1369
1376
  "member": "DBNode",
1370
1377
  "name": "DBNodeSet",
1371
1378
  "required": false,
@@ -1373,8 +1380,8 @@
1373
1380
  },
1374
1381
  {
1375
1382
  "disabled": false,
1376
- "document": "是否自动使用代金券:\n<li>0:否\n<li>1:是\n默认值:0",
1377
- "example": "",
1383
+ "document": "是否自动使用代金券:\n\n- 0:否\n- 1:是\n\n默认值:0",
1384
+ "example": "0",
1378
1385
  "member": "int64",
1379
1386
  "name": "AutoVoucher",
1380
1387
  "required": false,
@@ -1383,7 +1390,7 @@
1383
1390
  {
1384
1391
  "disabled": false,
1385
1392
  "document": "代金券ID列表。",
1386
- "example": "",
1393
+ "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]",
1387
1394
  "member": "string",
1388
1395
  "name": "VoucherIds",
1389
1396
  "required": false,
@@ -1392,7 +1399,7 @@
1392
1399
  {
1393
1400
  "disabled": false,
1394
1401
  "document": "活动ID。",
1395
- "example": "",
1402
+ "example": "123",
1396
1403
  "member": "int64",
1397
1404
  "name": "ActivityId",
1398
1405
  "required": false,
@@ -1401,7 +1408,7 @@
1401
1408
  {
1402
1409
  "disabled": false,
1403
1410
  "document": "基础备份集ID。",
1404
- "example": "",
1411
+ "example": "f6yecd1a-087c-5c66-cdas-95c835d7ec24",
1405
1412
  "member": "string",
1406
1413
  "name": "BackupSetId",
1407
1414
  "required": false,
@@ -1410,7 +1417,7 @@
1410
1417
  {
1411
1418
  "disabled": false,
1412
1419
  "document": "恢复时间点。",
1413
- "example": "",
1420
+ "example": "2021/12/25 1:27:35",
1414
1421
  "member": "string",
1415
1422
  "name": "RecoveryTargetTime",
1416
1423
  "required": false,
@@ -1418,7 +1425,7 @@
1418
1425
  },
1419
1426
  {
1420
1427
  "disabled": false,
1421
- "document": "主从同步方式,支持: \n<li>Semi-sync:半同步\n<li>Async:异步\n主实例默认值:Semi-sync\n只读实例默认值:Async",
1428
+ "document": "主从同步方式,支持: \n<li>Semi-sync:半同步</li>\n<li>Async:异步</li>\n主实例默认值:Semi-sync\n只读实例默认值:Async",
1422
1429
  "example": "Async",
1423
1430
  "member": "string",
1424
1431
  "name": "SyncMode",
@@ -1434,7 +1441,7 @@
1434
1441
  {
1435
1442
  "disabled": false,
1436
1443
  "document": "订单号。\n注意:此字段可能返回 null,表示取不到有效值。",
1437
- "example": "",
1444
+ "example": "20211225711000768276461",
1438
1445
  "member": "string",
1439
1446
  "name": "DealName",
1440
1447
  "output_required": true,
@@ -1444,7 +1451,7 @@
1444
1451
  {
1445
1452
  "disabled": false,
1446
1453
  "document": "订单流水号。\n注意:此字段可能返回 null,表示取不到有效值。",
1447
- "example": "",
1454
+ "example": "20211225711000768276471",
1448
1455
  "member": "string",
1449
1456
  "name": "BillId",
1450
1457
  "output_required": true,
@@ -1454,7 +1461,7 @@
1454
1461
  {
1455
1462
  "disabled": false,
1456
1463
  "document": "克隆出的新实例ID,当前只支持后付费返回该值。\n注意:此字段可能返回 null,表示取不到有效值。",
1457
- "example": "",
1464
+ "example": "postgres-2uepfuz1",
1458
1465
  "member": "string",
1459
1466
  "name": "DBInstanceId",
1460
1467
  "output_required": true,
@@ -1630,7 +1637,7 @@
1630
1637
  {
1631
1638
  "disabled": false,
1632
1639
  "document": "目标VIP地址。",
1633
- "example": "",
1640
+ "example": "10.10.10.220",
1634
1641
  "member": "string",
1635
1642
  "name": "Vip",
1636
1643
  "required": false,
@@ -1648,6 +1655,7 @@
1648
1655
  "example": "1234",
1649
1656
  "member": "int64",
1650
1657
  "name": "FlowId",
1658
+ "output_required": true,
1651
1659
  "type": "int",
1652
1660
  "value_allowed_null": true
1653
1661
  },
@@ -1666,7 +1674,7 @@
1666
1674
  {
1667
1675
  "disabled": false,
1668
1676
  "document": "售卖规格ID。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。",
1669
- "example": "",
1677
+ "example": "pg.it.2xlarge16",
1670
1678
  "member": "string",
1671
1679
  "name": "SpecCode",
1672
1680
  "required": true,
@@ -1675,7 +1683,7 @@
1675
1683
  {
1676
1684
  "disabled": false,
1677
1685
  "document": "实例容量大小,单位:GB。",
1678
- "example": "",
1686
+ "example": "64",
1679
1687
  "member": "uint64",
1680
1688
  "name": "Storage",
1681
1689
  "required": true,
@@ -1684,7 +1692,7 @@
1684
1692
  {
1685
1693
  "disabled": false,
1686
1694
  "document": "一次性购买的实例数量。取值1-100",
1687
- "example": "",
1695
+ "example": "1",
1688
1696
  "member": "uint64",
1689
1697
  "name": "InstanceCount",
1690
1698
  "required": true,
@@ -1693,7 +1701,7 @@
1693
1701
  {
1694
1702
  "disabled": false,
1695
1703
  "document": "购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。",
1696
- "example": "",
1704
+ "example": "12",
1697
1705
  "member": "uint64",
1698
1706
  "name": "Period",
1699
1707
  "required": true,
@@ -1702,7 +1710,7 @@
1702
1710
  {
1703
1711
  "disabled": false,
1704
1712
  "document": "可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。",
1705
- "example": "",
1713
+ "example": "ap-guangzhou-6",
1706
1714
  "member": "string",
1707
1715
  "name": "Zone",
1708
1716
  "required": true,
@@ -1711,7 +1719,7 @@
1711
1719
  {
1712
1720
  "disabled": false,
1713
1721
  "document": "项目ID。",
1714
- "example": "",
1722
+ "example": "0",
1715
1723
  "member": "int64",
1716
1724
  "name": "ProjectId",
1717
1725
  "required": false,
@@ -1729,7 +1737,7 @@
1729
1737
  {
1730
1738
  "disabled": false,
1731
1739
  "document": "实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。默认值:PREPAID。",
1732
- "example": "",
1740
+ "example": "POSTPAID_BY_HOUR",
1733
1741
  "member": "string",
1734
1742
  "name": "InstanceChargeType",
1735
1743
  "required": false,
@@ -1738,7 +1746,7 @@
1738
1746
  {
1739
1747
  "disabled": false,
1740
1748
  "document": "是否自动使用代金券。1(是),0(否),默认不使用。",
1741
- "example": "",
1749
+ "example": "0",
1742
1750
  "member": "uint64",
1743
1751
  "name": "AutoVoucher",
1744
1752
  "required": false,
@@ -1747,7 +1755,7 @@
1747
1755
  {
1748
1756
  "disabled": false,
1749
1757
  "document": "代金券ID列表,目前仅支持指定一张代金券。",
1750
- "example": "",
1758
+ "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]",
1751
1759
  "member": "string",
1752
1760
  "name": "VoucherIds",
1753
1761
  "required": false,
@@ -1756,7 +1764,7 @@
1756
1764
  {
1757
1765
  "disabled": false,
1758
1766
  "document": "私有网络ID。",
1759
- "example": "",
1767
+ "example": "vpc-8e0ypm3z",
1760
1768
  "member": "string",
1761
1769
  "name": "VpcId",
1762
1770
  "required": false,
@@ -1765,7 +1773,7 @@
1765
1773
  {
1766
1774
  "disabled": false,
1767
1775
  "document": "私有网络子网ID。",
1768
- "example": "",
1776
+ "example": "subnet-bthucmmy",
1769
1777
  "member": "string",
1770
1778
  "name": "SubnetId",
1771
1779
  "required": false,
@@ -1774,7 +1782,7 @@
1774
1782
  {
1775
1783
  "disabled": false,
1776
1784
  "document": "续费标记:0-正常续费(默认);1-自动续费;",
1777
- "example": "",
1785
+ "example": "0",
1778
1786
  "member": "int64",
1779
1787
  "name": "AutoRenewFlag",
1780
1788
  "required": false,
@@ -1783,7 +1791,7 @@
1783
1791
  {
1784
1792
  "disabled": false,
1785
1793
  "document": "活动ID",
1786
- "example": "",
1794
+ "example": "123",
1787
1795
  "member": "int64",
1788
1796
  "name": "ActivityId",
1789
1797
  "required": false,
@@ -1792,7 +1800,7 @@
1792
1800
  {
1793
1801
  "disabled": false,
1794
1802
  "document": "实例名(后续支持)",
1795
- "example": "",
1803
+ "example": "pg-instance-1",
1796
1804
  "member": "string",
1797
1805
  "name": "Name",
1798
1806
  "required": false,
@@ -1801,7 +1809,7 @@
1801
1809
  {
1802
1810
  "disabled": false,
1803
1811
  "document": "是否需要支持Ipv6,1:是,0:否",
1804
- "example": "",
1812
+ "example": "0",
1805
1813
  "member": "uint64",
1806
1814
  "name": "NeedSupportIpv6",
1807
1815
  "required": false,
@@ -1810,7 +1818,7 @@
1810
1818
  {
1811
1819
  "disabled": false,
1812
1820
  "document": "实例需要绑定的Tag信息,默认为空",
1813
- "example": "",
1821
+ "example": "[ { \"TagKey\": \"abc\", \"TagValue\": \"123\", \"CanDelete\": 1 } ]",
1814
1822
  "member": "Tag",
1815
1823
  "name": "TagList",
1816
1824
  "required": false,
@@ -1819,7 +1827,7 @@
1819
1827
  {
1820
1828
  "disabled": false,
1821
1829
  "document": "安全组id",
1822
- "example": "",
1830
+ "example": "[ { \"SecurityGroupId\": \"sg-05bb4upy\", \"SecurityGroupName\": \"TestGroup\", \"SecurityGroupDesc\": \"test-group-desc\", \"ProjectId\": \"0\", \"IsDefault\": true, \"CreatedTime\": \"2017-04-18 21:02:30\", \"UpdateTime\": \"\", \"TagSet\": [] } ]",
1823
1831
  "member": "string",
1824
1832
  "name": "SecurityGroupIds",
1825
1833
  "required": false,
@@ -1852,7 +1860,7 @@
1852
1860
  {
1853
1861
  "disabled": false,
1854
1862
  "document": "订单号列表。每个实例对应一个订单号。",
1855
- "example": "",
1863
+ "example": "[ \"20180119110001\" ]",
1856
1864
  "member": "string",
1857
1865
  "name": "DealNames",
1858
1866
  "output_required": true,
@@ -1862,7 +1870,7 @@
1862
1870
  {
1863
1871
  "disabled": false,
1864
1872
  "document": "冻结流水号",
1865
- "example": "",
1873
+ "example": "20181225711000768276471",
1866
1874
  "member": "string",
1867
1875
  "name": "BillId",
1868
1876
  "output_required": true,
@@ -1872,7 +1880,7 @@
1872
1880
  {
1873
1881
  "disabled": false,
1874
1882
  "document": "创建成功的实例ID集合,只在后付费情景下有返回值",
1875
- "example": "",
1883
+ "example": "[ \"postgres-jdlmoll9\" ]",
1876
1884
  "member": "string",
1877
1885
  "name": "DBInstanceIdSet",
1878
1886
  "output_required": true,
@@ -1894,7 +1902,7 @@
1894
1902
  {
1895
1903
  "disabled": false,
1896
1904
  "document": "实例所属主可用区, 如:ap-guangzhou-3;若需要支持多可用区,在DBNodeSet.N字段中进行添加主可用区和备可用区信息;\n可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。",
1897
- "example": "",
1905
+ "example": "ap-guangzhou-6",
1898
1906
  "member": "string",
1899
1907
  "name": "Zone",
1900
1908
  "required": true,
@@ -1903,7 +1911,7 @@
1903
1911
  {
1904
1912
  "disabled": false,
1905
1913
  "document": "售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。",
1906
- "example": "",
1914
+ "example": "pg.it.2xlarge16",
1907
1915
  "member": "string",
1908
1916
  "name": "SpecCode",
1909
1917
  "required": true,
@@ -1912,7 +1920,7 @@
1912
1920
  {
1913
1921
  "disabled": false,
1914
1922
  "document": "实例容量大小,单位:GB。",
1915
- "example": "",
1923
+ "example": "64",
1916
1924
  "member": "uint64",
1917
1925
  "name": "Storage",
1918
1926
  "required": true,
@@ -1921,7 +1929,7 @@
1921
1929
  {
1922
1930
  "disabled": false,
1923
1931
  "document": "购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。",
1924
- "example": "",
1932
+ "example": "1",
1925
1933
  "member": "uint64",
1926
1934
  "name": "InstanceCount",
1927
1935
  "required": true,
@@ -1929,8 +1937,8 @@
1929
1937
  },
1930
1938
  {
1931
1939
  "disabled": false,
1932
- "document": "购买时长,单位:月。\n<li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36\n<li>后付费:只支持1",
1933
- "example": "",
1940
+ "document": "购买时长,单位:月。\n<li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>\n<li>后付费:只支持1</li>",
1941
+ "example": "12",
1934
1942
  "member": "uint64",
1935
1943
  "name": "Period",
1936
1944
  "required": true,
@@ -1938,7 +1946,7 @@
1938
1946
  },
1939
1947
  {
1940
1948
  "disabled": false,
1941
- "document": "实例字符集,目前只支持:\n<li> UTF8\n<li> LATIN1",
1949
+ "document": "实例字符集,目前只支持:\n<li> UTF8</li>\n<li> LATIN1</li>",
1942
1950
  "example": "UTF8",
1943
1951
  "member": "string",
1944
1952
  "name": "Charset",
@@ -1947,8 +1955,8 @@
1947
1955
  },
1948
1956
  {
1949
1957
  "disabled": false,
1950
- "document": "实例根账号用户名,具体规范如下:\n<li>用户名需要1-16个字符,只能由字母、数字或下划线组成\n<li>不能为postgres\n<li>不能由数字和pg_开头\n<li>所有规则均不区分大小写",
1951
- "example": "",
1958
+ "document": "实例根账号用户名,具体规范如下:\n<li>用户名需要1-16个字符,只能由字母、数字或下划线组成</li>\n<li>不能为postgres</li>\n<li>不能由数字和pg_开头</li>\n<li>所有规则均不区分大小写</li>",
1959
+ "example": "pgadmin1",
1952
1960
  "member": "string",
1953
1961
  "name": "AdminName",
1954
1962
  "required": true,
@@ -1956,8 +1964,8 @@
1956
1964
  },
1957
1965
  {
1958
1966
  "disabled": false,
1959
- "document": "实例根账号用户名对应的密码,长度8 ~ 32位,推荐使用12位以上的密码;不能以\" / \"开头;\n必须包含以下四项,字符种类:\n<li>小写字母: [a ~ z]\n<li>大写字母:[A ~ Z]\n<li>数字:0 - 9\n<li>特殊字符:()`~!@#$%^&*-+=_|{}[]:;'<>,.?/",
1960
- "example": "",
1967
+ "document": "实例根账号用户名对应的密码,长度8 ~ 32位,推荐使用12位以上的密码;不能以\" / \"开头;\n必须包含以下四项,字符种类:\n<li>小写字母: [a ~ z]</li>\n<li>大写字母:[A ~ Z]</li>\n<li>数字:0 - 9</li>\n<li>特殊字符:()`~!@#$%^&*-+=_|{}[]:;'<>,.?/</li>",
1968
+ "example": "A8b!C2d#E4f&",
1961
1969
  "member": "string",
1962
1970
  "name": "AdminPassword",
1963
1971
  "required": true,
@@ -1992,8 +2000,8 @@
1992
2000
  },
1993
2001
  {
1994
2002
  "disabled": false,
1995
- "document": "实例计费类型,目前支持:\n<li>PREPAID:预付费,即包年包月\n<li>POSTPAID_BY_HOUR:后付费,即按量计费\n默认值:PREPAID",
1996
- "example": "",
2003
+ "document": "实例计费类型,目前支持:\n<li>PREPAID:预付费,即包年包月</li>\n<li>POSTPAID_BY_HOUR:后付费,即按量计费</li>\n默认值:PREPAID",
2004
+ "example": "POSTPAID_BY_HOUR",
1997
2005
  "member": "string",
1998
2006
  "name": "InstanceChargeType",
1999
2007
  "required": false,
@@ -2002,7 +2010,7 @@
2002
2010
  {
2003
2011
  "disabled": false,
2004
2012
  "document": "私有网络ID,形如vpc-xxxxxxxx(该参数当前必传)。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。",
2005
- "example": "",
2013
+ "example": "vpc-8e0ypm3z",
2006
2014
  "member": "string",
2007
2015
  "name": "VpcId",
2008
2016
  "required": false,
@@ -2011,7 +2019,7 @@
2011
2019
  {
2012
2020
  "disabled": false,
2013
2021
  "document": "私有网络子网ID,形如subnet-xxxxxxxx(该参数当前必传)。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。",
2014
- "example": "",
2022
+ "example": "subnet-bthucmmy",
2015
2023
  "member": "string",
2016
2024
  "name": "SubnetId",
2017
2025
  "required": false,
@@ -2020,7 +2028,7 @@
2020
2028
  {
2021
2029
  "disabled": false,
2022
2030
  "document": "实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。\n可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。",
2023
- "example": "",
2031
+ "example": "[ { \"Zone\": \"ap-guangzhou-6\", \"ZoneName\": \"广州六区\", \"ZoneId\": 100006, \"ZoneState\": \"AVAILABLE\", \"ZoneSupportIpv6\": 0, \"StandbyZoneSet\": [ \"ap-guangzhou-6\", \"ap-guangzhou-7\" ] } ]",
2024
2032
  "member": "DBNode",
2025
2033
  "name": "DBNodeSet",
2026
2034
  "required": false,
@@ -2028,8 +2036,8 @@
2028
2036
  },
2029
2037
  {
2030
2038
  "disabled": false,
2031
- "document": "续费标记:\n<li>0:手动续费\n<li>1:自动续费\n默认值:0",
2032
- "example": "",
2039
+ "document": "续费标记:\n<li>0:手动续费</li>\n<li>1:自动续费</li>\n默认值:0",
2040
+ "example": "0",
2033
2041
  "member": "int64",
2034
2042
  "name": "AutoRenewFlag",
2035
2043
  "required": false,
@@ -2037,8 +2045,8 @@
2037
2045
  },
2038
2046
  {
2039
2047
  "disabled": false,
2040
- "document": "是否自动使用代金券:\n<li>0:否\n<li>1:是\n默认值:0",
2041
- "example": "",
2048
+ "document": "是否自动使用代金券:\n<li>0:否</li>\n<li>1:是</li>\n默认值:0",
2049
+ "example": "0",
2042
2050
  "member": "uint64",
2043
2051
  "name": "AutoVoucher",
2044
2052
  "required": false,
@@ -2047,7 +2055,7 @@
2047
2055
  {
2048
2056
  "disabled": false,
2049
2057
  "document": "代金券ID列表,目前仅支持指定一张代金券。",
2050
- "example": "",
2058
+ "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]",
2051
2059
  "member": "string",
2052
2060
  "name": "VoucherIds",
2053
2061
  "required": false,
@@ -2056,7 +2064,7 @@
2056
2064
  {
2057
2065
  "disabled": false,
2058
2066
  "document": "项目ID。",
2059
- "example": "",
2067
+ "example": "0",
2060
2068
  "member": "int64",
2061
2069
  "name": "ProjectId",
2062
2070
  "required": false,
@@ -2065,7 +2073,7 @@
2065
2073
  {
2066
2074
  "disabled": false,
2067
2075
  "document": "活动ID。",
2068
- "example": "",
2076
+ "example": "123",
2069
2077
  "member": "int64",
2070
2078
  "name": "ActivityId",
2071
2079
  "required": false,
@@ -2074,7 +2082,7 @@
2074
2082
  {
2075
2083
  "disabled": false,
2076
2084
  "document": "实例名称,仅支持长度小于60的中文/英文/数字/\"_\"/\"-\",不指定实例名称则默认显示\"未命名\"。\n",
2077
- "example": "",
2085
+ "example": "pg-instance-1",
2078
2086
  "member": "string",
2079
2087
  "name": "Name",
2080
2088
  "required": false,
@@ -2083,7 +2091,7 @@
2083
2091
  {
2084
2092
  "disabled": false,
2085
2093
  "document": "实例需要绑定的Tag信息,默认为空;可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。",
2086
- "example": "",
2094
+ "example": "[ { \"TagKey\": \"abc\", \"TagValue\": \"123\", \"CanDelete\": 1 } ]",
2087
2095
  "member": "Tag",
2088
2096
  "name": "TagList",
2089
2097
  "required": false,
@@ -2092,7 +2100,7 @@
2092
2100
  {
2093
2101
  "disabled": false,
2094
2102
  "document": "实例所属安全组,该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。\n",
2095
- "example": "",
2103
+ "example": "[ { \"SecurityGroupId\": \"sg-05bb4upy\", \"SecurityGroupName\": \"TestGroup\", \"SecurityGroupDesc\": \"test-group-desc\", \"ProjectId\": \"0\", \"IsDefault\": true, \"CreatedTime\": \"2017-04-18 21:02:30\", \"UpdateTime\": \"\", \"TagSet\": [] } ]",
2096
2104
  "member": "string",
2097
2105
  "name": "SecurityGroupIds",
2098
2106
  "required": false,
@@ -2100,7 +2108,7 @@
2100
2108
  },
2101
2109
  {
2102
2110
  "disabled": false,
2103
- "document": "是否需要支持数据透明加密:\n<li>0:否\n<li>1:是\n默认值:0\n参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)",
2111
+ "document": "是否需要支持数据透明加密:\n<li>0:否</li>\n<li>1:是</li>\n默认值:0\n参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)",
2104
2112
  "example": "1",
2105
2113
  "member": "uint64",
2106
2114
  "name": "NeedSupportTDE",
@@ -2110,7 +2118,7 @@
2110
2118
  {
2111
2119
  "disabled": false,
2112
2120
  "document": "自定义密钥的KeyId,若选择自定义密匙加密,则需要传入自定义密匙的KeyId,KeyId是CMK的唯一标识。\nKeyId创建获取相关参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)",
2113
- "example": "",
2121
+ "example": "7f370325-bb06-11ec-b54a-525400bb1222",
2114
2122
  "member": "string",
2115
2123
  "name": "KMSKeyId",
2116
2124
  "required": false,
@@ -2127,7 +2135,7 @@
2127
2135
  },
2128
2136
  {
2129
2137
  "disabled": false,
2130
- "document": "数据库引擎,支持:\n<li>postgresql:云数据库PostgreSQL\n<li>mssql_compatible:MSSQL兼容-云数据库PostgreSQL\n默认值:postgresql",
2138
+ "document": "数据库引擎,支持:\n<li>postgresql:云数据库PostgreSQL</li>\n<li>mssql_compatible:MSSQL兼容-云数据库PostgreSQL</li>\n默认值:postgresql",
2131
2139
  "example": "postgresql",
2132
2140
  "member": "string",
2133
2141
  "name": "DBEngine",
@@ -2136,8 +2144,8 @@
2136
2144
  },
2137
2145
  {
2138
2146
  "disabled": false,
2139
- "document": "数据库引擎的配置信息,配置格式如下:\n{\"$key1\":\"$value1\", \"$key2\":\"$value2\"}\n各引擎支持如下:\nmssql_compatible引擎:\n<li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。\n<li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:\n\"af_ZA\", \"sq_AL\", \"ar_DZ\", \"ar_BH\", \"ar_EG\", \"ar_IQ\", \"ar_JO\", \"ar_KW\", \"ar_LB\", \"ar_LY\", \"ar_MA\", \"ar_OM\", \"ar_QA\", \"ar_SA\", \"ar_SY\", \"ar_TN\", \"ar_AE\", \"ar_YE\", \"hy_AM\", \"az_Cyrl_AZ\", \"az_Latn_AZ\", \"eu_ES\", \"be_BY\", \"bg_BG\", \"ca_ES\", \"zh_HK\", \"zh_MO\", \"zh_CN\", \"zh_SG\", \"zh_TW\", \"hr_HR\", \"cs_CZ\", \"da_DK\", \"nl_BE\", \"nl_NL\", \"en_AU\", \"en_BZ\", \"en_CA\", \"en_IE\", \"en_JM\", \"en_NZ\", \"en_PH\", \"en_ZA\", \"en_TT\", \"en_GB\", \"en_US\", \"en_ZW\", \"et_EE\", \"fo_FO\", \"fa_IR\", \"fi_FI\", \"fr_BE\", \"fr_CA\", \"fr_FR\", \"fr_LU\", \"fr_MC\", \"fr_CH\", \"mk_MK\", \"ka_GE\", \"de_AT\", \"de_DE\", \"de_LI\", \"de_LU\", \"de_CH\", \"el_GR\", \"gu_IN\", \"he_IL\", \"hi_IN\", \"hu_HU\", \"is_IS\", \"id_ID\", \"it_IT\", \"it_CH\", \"ja_JP\", \"kn_IN\", \"kok_IN\", \"ko_KR\", \"ky_KG\", \"lv_LV\", \"lt_LT\", \"ms_BN\", \"ms_MY\", \"mr_IN\", \"mn_MN\", \"nb_NO\", \"nn_NO\", \"pl_PL\", \"pt_BR\", \"pt_PT\", \"pa_IN\", \"ro_RO\", \"ru_RU\", \"sa_IN\", \"sr_Cyrl_RS\", \"sr_Latn_RS\", \"sk_SK\", \"sl_SI\", \"es_AR\", \"es_BO\", \"es_CL\", \"es_CO\", \"es_CR\", \"es_DO\", \"es_EC\", \"es_SV\", \"es_GT\", \"es_HN\", \"es_MX\", \"es_NI\", \"es_PA\", \"es_PY\",\"es_PE\", \"es_PR\", \"es_ES\", \"es_TRADITIONAL\", \"es_UY\", \"es_VE\", \"sw_KE\", \"sv_FI\", \"sv_SE\", \"tt_RU\", \"te_IN\", \"th_TH\", \"tr_TR\", \"uk_UA\", \"ur_IN\", \"ur_PK\", \"uz_Cyrl_UZ\", \"uz_Latn_UZ\", \"vi_VN\"。\n<li>serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:\"bbf_unicode_general_ci_as\", \"bbf_unicode_cp1_ci_as\", \"bbf_unicode_CP1250_ci_as\", \"bbf_unicode_CP1251_ci_as\", \"bbf_unicode_cp1253_ci_as\", \"bbf_unicode_cp1254_ci_as\", \"bbf_unicode_cp1255_ci_as\", \"bbf_unicode_cp1256_ci_as\", \"bbf_unicode_cp1257_ci_as\", \"bbf_unicode_cp1258_ci_as\", \"bbf_unicode_cp874_ci_as\", \"sql_latin1_general_cp1250_ci_as\", \"sql_latin1_general_cp1251_ci_as\", \"sql_latin1_general_cp1_ci_as\", \"sql_latin1_general_cp1253_ci_as\", \"sql_latin1_general_cp1254_ci_as\", \"sql_latin1_general_cp1255_ci_as\",\"sql_latin1_general_cp1256_ci_as\", \"sql_latin1_general_cp1257_ci_as\", \"sql_latin1_general_cp1258_ci_as\", \"chinese_prc_ci_as\", \"cyrillic_general_ci_as\", \"finnish_swedish_ci_as\", \"french_ci_as\", \"japanese_ci_as\", \"korean_wansung_ci_as\", \"latin1_general_ci_as\", \"modern_spanish_ci_as\", \"polish_ci_as\", \"thai_ci_as\", \"traditional_spanish_ci_as\", \"turkish_ci_as\", \"ukrainian_ci_as\", \"vietnamese_ci_as\"",
2140
- "example": "",
2147
+ "document": "数据库引擎的配置信息,配置格式如下:\n{\"$key1\":\"$value1\", \"$key2\":\"$value2\"}\n各引擎支持如下:\nmssql_compatible引擎:\n<li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。</li>\n<li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:\n\"af_ZA\", \"sq_AL\", \"ar_DZ\", \"ar_BH\", \"ar_EG\", \"ar_IQ\", \"ar_JO\", \"ar_KW\", \"ar_LB\", \"ar_LY\", \"ar_MA\", \"ar_OM\", \"ar_QA\", \"ar_SA\", \"ar_SY\", \"ar_TN\", \"ar_AE\", \"ar_YE\", \"hy_AM\", \"az_Cyrl_AZ\", \"az_Latn_AZ\", \"eu_ES\", \"be_BY\", \"bg_BG\", \"ca_ES\", \"zh_HK\", \"zh_MO\", \"zh_CN\", \"zh_SG\", \"zh_TW\", \"hr_HR\", \"cs_CZ\", \"da_DK\", \"nl_BE\", \"nl_NL\", \"en_AU\", \"en_BZ\", \"en_CA\", \"en_IE\", \"en_JM\", \"en_NZ\", \"en_PH\", \"en_ZA\", \"en_TT\", \"en_GB\", \"en_US\", \"en_ZW\", \"et_EE\", \"fo_FO\", \"fa_IR\", \"fi_FI\", \"fr_BE\", \"fr_CA\", \"fr_FR\", \"fr_LU\", \"fr_MC\", \"fr_CH\", \"mk_MK\", \"ka_GE\", \"de_AT\", \"de_DE\", \"de_LI\", \"de_LU\", \"de_CH\", \"el_GR\", \"gu_IN\", \"he_IL\", \"hi_IN\", \"hu_HU\", \"is_IS\", \"id_ID\", \"it_IT\", \"it_CH\", \"ja_JP\", \"kn_IN\", \"kok_IN\", \"ko_KR\", \"ky_KG\", \"lv_LV\", \"lt_LT\", \"ms_BN\", \"ms_MY\", \"mr_IN\", \"mn_MN\", \"nb_NO\", \"nn_NO\", \"pl_PL\", \"pt_BR\", \"pt_PT\", \"pa_IN\", \"ro_RO\", \"ru_RU\", \"sa_IN\", \"sr_Cyrl_RS\", \"sr_Latn_RS\", \"sk_SK\", \"sl_SI\", \"es_AR\", \"es_BO\", \"es_CL\", \"es_CO\", \"es_CR\", \"es_DO\", \"es_EC\", \"es_SV\", \"es_GT\", \"es_HN\", \"es_MX\", \"es_NI\", \"es_PA\", \"es_PY\",\"es_PE\", \"es_PR\", \"es_ES\", \"es_TRADITIONAL\", \"es_UY\", \"es_VE\", \"sw_KE\", \"sv_FI\", \"sv_SE\", \"tt_RU\", \"te_IN\", \"th_TH\", \"tr_TR\", \"uk_UA\", \"ur_IN\", \"ur_PK\", \"uz_Cyrl_UZ\", \"uz_Latn_UZ\", \"vi_VN\"。</li>\n<li>serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:\"bbf_unicode_general_ci_as\", \"bbf_unicode_cp1_ci_as\", \"bbf_unicode_CP1250_ci_as\", \"bbf_unicode_CP1251_ci_as\", \"bbf_unicode_cp1253_ci_as\", \"bbf_unicode_cp1254_ci_as\", \"bbf_unicode_cp1255_ci_as\", \"bbf_unicode_cp1256_ci_as\", \"bbf_unicode_cp1257_ci_as\", \"bbf_unicode_cp1258_ci_as\", \"bbf_unicode_cp874_ci_as\", \"sql_latin1_general_cp1250_ci_as\", \"sql_latin1_general_cp1251_ci_as\", \"sql_latin1_general_cp1_ci_as\", \"sql_latin1_general_cp1253_ci_as\", \"sql_latin1_general_cp1254_ci_as\", \"sql_latin1_general_cp1255_ci_as\",\"sql_latin1_general_cp1256_ci_as\", \"sql_latin1_general_cp1257_ci_as\", \"sql_latin1_general_cp1258_ci_as\", \"chinese_prc_ci_as\", \"cyrillic_general_ci_as\", \"finnish_swedish_ci_as\", \"french_ci_as\", \"japanese_ci_as\", \"korean_wansung_ci_as\", \"latin1_general_ci_as\", \"modern_spanish_ci_as\", \"polish_ci_as\", \"thai_ci_as\", \"traditional_spanish_ci_as\", \"turkish_ci_as\", \"ukrainian_ci_as\", \"vietnamese_ci_as\"。</li>",
2148
+ "example": "{ \"migrationMode\": \"single-db\", \"defaultLocale\": \"zh_CN\", \"serverCollationName\": \"sql_latin1_general_cp1250_ci_as\" }",
2141
2149
  "member": "string",
2142
2150
  "name": "DBEngineConfig",
2143
2151
  "required": false,
@@ -2145,7 +2153,7 @@
2145
2153
  },
2146
2154
  {
2147
2155
  "disabled": false,
2148
- "document": "主从同步方式,支持: \n<li>Semi-sync:半同步\n<li>Async:异步\n主实例默认值:Semi-sync\n只读实例默认值:Async",
2156
+ "document": "主从同步方式,支持: \n<li>Semi-sync:半同步</li>\n<li>Async:异步</li>\n主实例默认值:Semi-sync\n只读实例默认值:Async",
2149
2157
  "example": "Async",
2150
2158
  "member": "string",
2151
2159
  "name": "SyncMode",
@@ -2154,8 +2162,8 @@
2154
2162
  },
2155
2163
  {
2156
2164
  "disabled": false,
2157
- "document": "是否需要支持Ipv6:\n<li>0:否\n<li>1:是\n默认值:0",
2158
- "example": "",
2165
+ "document": "是否需要支持Ipv6:\n<li>0:否</li>\n<li>1:是</li>\n默认值:0",
2166
+ "example": "0",
2159
2167
  "member": "uint64",
2160
2168
  "name": "NeedSupportIpv6",
2161
2169
  "required": false,
@@ -2170,7 +2178,7 @@
2170
2178
  {
2171
2179
  "disabled": false,
2172
2180
  "document": "订单号列表。每个实例对应一个订单号。",
2173
- "example": "",
2181
+ "example": "[ \"20180119110001\" ]",
2174
2182
  "member": "string",
2175
2183
  "name": "DealNames",
2176
2184
  "output_required": true,
@@ -2180,7 +2188,7 @@
2180
2188
  {
2181
2189
  "disabled": false,
2182
2190
  "document": "冻结流水号。",
2183
- "example": "",
2191
+ "example": "20181225711000768276471",
2184
2192
  "member": "string",
2185
2193
  "name": "BillId",
2186
2194
  "output_required": true,
@@ -2190,7 +2198,7 @@
2190
2198
  {
2191
2199
  "disabled": false,
2192
2200
  "document": "创建成功的实例ID集合,只在后付费情景下有返回值。",
2193
- "example": "",
2201
+ "example": "[ \"postgres-2uepfuz1\" ]",
2194
2202
  "member": "string",
2195
2203
  "name": "DBInstanceIdSet",
2196
2204
  "output_required": true,
@@ -2540,7 +2548,7 @@
2540
2548
  {
2541
2549
  "disabled": false,
2542
2550
  "document": "目标VIP地址。",
2543
- "example": "",
2551
+ "example": "10.10.10.220",
2544
2552
  "member": "string",
2545
2553
  "name": "Vip",
2546
2554
  "required": false,
@@ -2558,6 +2566,7 @@
2558
2566
  "example": "1234",
2559
2567
  "member": "int64",
2560
2568
  "name": "FlowId",
2569
+ "output_required": true,
2561
2570
  "type": "int",
2562
2571
  "value_allowed_null": true
2563
2572
  },
@@ -2776,7 +2785,7 @@
2776
2785
  {
2777
2786
  "disabled": false,
2778
2787
  "document": "实例需要绑定的标签数组信息",
2779
- "example": "",
2788
+ "example": "[ { \"TagKey\": \"abc\", \"TagValue\": \"123\", \"CanDelete\": 1 } ]",
2780
2789
  "member": "Tag",
2781
2790
  "name": "TagList",
2782
2791
  "required": false,
@@ -2794,7 +2803,7 @@
2794
2803
  "example": "postgres-xxxxx",
2795
2804
  "member": "string",
2796
2805
  "name": "DBInstanceId",
2797
- "required": true,
2806
+ "output_required": true,
2798
2807
  "type": "string",
2799
2808
  "value_allowed_null": false
2800
2809
  },
@@ -2813,120 +2822,120 @@
2813
2822
  {
2814
2823
  "disabled": false,
2815
2824
  "document": "备份文件唯一标识",
2816
- "example": "",
2825
+ "example": "450",
2817
2826
  "member": "int64",
2818
2827
  "name": "Id",
2819
- "required": true,
2828
+ "output_required": true,
2820
2829
  "type": "int",
2821
2830
  "value_allowed_null": false
2822
2831
  },
2823
2832
  {
2824
2833
  "disabled": false,
2825
2834
  "document": "文件生成的开始时间",
2826
- "example": "",
2835
+ "example": "2018-06-21 01:55:04.199169",
2827
2836
  "member": "string",
2828
2837
  "name": "StartTime",
2829
- "required": true,
2838
+ "output_required": true,
2830
2839
  "type": "string",
2831
2840
  "value_allowed_null": false
2832
2841
  },
2833
2842
  {
2834
2843
  "disabled": false,
2835
2844
  "document": "文件生成的结束时间",
2836
- "example": "",
2845
+ "example": "2018-06-21 01:55:58.477232",
2837
2846
  "member": "string",
2838
2847
  "name": "EndTime",
2839
- "required": true,
2848
+ "output_required": true,
2840
2849
  "type": "string",
2841
2850
  "value_allowed_null": false
2842
2851
  },
2843
2852
  {
2844
2853
  "disabled": false,
2845
2854
  "document": "文件大小(K)",
2846
- "example": "",
2855
+ "example": "3654991",
2847
2856
  "member": "int64",
2848
2857
  "name": "Size",
2849
- "required": true,
2858
+ "output_required": true,
2850
2859
  "type": "int",
2851
2860
  "value_allowed_null": false
2852
2861
  },
2853
2862
  {
2854
2863
  "disabled": false,
2855
2864
  "document": "策略(0-实例备份;1-多库备份)",
2856
- "example": "",
2865
+ "example": "1",
2857
2866
  "member": "int64",
2858
2867
  "name": "Strategy",
2859
- "required": true,
2868
+ "output_required": true,
2860
2869
  "type": "int",
2861
2870
  "value_allowed_null": false
2862
2871
  },
2863
2872
  {
2864
2873
  "disabled": false,
2865
2874
  "document": "类型(0-定时)",
2866
- "example": "",
2875
+ "example": "1",
2867
2876
  "member": "int64",
2868
2877
  "name": "Way",
2869
- "required": true,
2878
+ "output_required": true,
2870
2879
  "type": "int",
2871
2880
  "value_allowed_null": false
2872
2881
  },
2873
2882
  {
2874
2883
  "disabled": false,
2875
2884
  "document": "备份方式(1-完整)",
2876
- "example": "",
2885
+ "example": "1",
2877
2886
  "member": "int64",
2878
2887
  "name": "Type",
2879
- "required": true,
2888
+ "output_required": true,
2880
2889
  "type": "int",
2881
2890
  "value_allowed_null": false
2882
2891
  },
2883
2892
  {
2884
2893
  "disabled": false,
2885
2894
  "document": "状态(1-创建中;2-成功;3-失败)",
2886
- "example": "",
2895
+ "example": "2",
2887
2896
  "member": "int64",
2888
2897
  "name": "Status",
2889
- "required": true,
2898
+ "output_required": true,
2890
2899
  "type": "int",
2891
2900
  "value_allowed_null": false
2892
2901
  },
2893
2902
  {
2894
2903
  "disabled": false,
2895
2904
  "document": "DB列表",
2896
- "example": "",
2905
+ "example": "[ \"db2\" ]",
2897
2906
  "member": "string",
2898
2907
  "name": "DbList",
2899
- "required": true,
2908
+ "output_required": true,
2900
2909
  "type": "list",
2901
2910
  "value_allowed_null": false
2902
2911
  },
2903
2912
  {
2904
2913
  "disabled": false,
2905
2914
  "document": "内网下载地址",
2906
- "example": "",
2915
+ "example": "http://172.16.16.30:8366/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=",
2907
2916
  "member": "string",
2908
2917
  "name": "InternalAddr",
2909
- "required": true,
2918
+ "output_required": true,
2910
2919
  "type": "string",
2911
2920
  "value_allowed_null": false
2912
2921
  },
2913
2922
  {
2914
2923
  "disabled": false,
2915
2924
  "document": "外网下载地址",
2916
- "example": "",
2925
+ "example": "https://gz-dl-postgres.cloud.tencent.com/download/20180621015515.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIse2MDEI7vd/CuyMUMMyDXAd4ld69sCMdEKwkpFWIVcfE+PZ0+MYTbsBHzW84KtSGw8=",
2917
2926
  "member": "string",
2918
2927
  "name": "ExternalAddr",
2919
- "required": true,
2928
+ "output_required": true,
2920
2929
  "type": "string",
2921
2930
  "value_allowed_null": false
2922
2931
  },
2923
2932
  {
2924
2933
  "disabled": false,
2925
2934
  "document": "备份集ID\n注意:此字段可能返回 null,表示取不到有效值。",
2926
- "example": "",
2935
+ "example": "f6yecd1a-087c-5c66-cdas-95c835d7ec24",
2927
2936
  "member": "string",
2928
2937
  "name": "SetId",
2929
- "required": true,
2938
+ "output_required": true,
2930
2939
  "type": "string",
2931
2940
  "value_allowed_null": true
2932
2941
  }
@@ -2958,8 +2967,8 @@
2958
2967
  },
2959
2968
  {
2960
2969
  "disabled": false,
2961
- "document": "私有网络ID,形如vpc-xxxxxxxx。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ,从接口返回中的unVpcId字段获取。",
2962
- "example": "vpc-xxxxxxxx",
2970
+ "document": "私有网络ID,形如vpc-e6w23k31。有效的VpcId可通过登录控制台查询;也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/api/215/15778) ,从接口返回中的unVpcId字段获取。",
2971
+ "example": "vpc-e6w23k31",
2963
2972
  "member": "string",
2964
2973
  "name": "VpcId",
2965
2974
  "output_required": true,
@@ -2968,8 +2977,8 @@
2968
2977
  },
2969
2978
  {
2970
2979
  "disabled": false,
2971
- "document": "私有网络子网ID,形如subnet-xxxxxxxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。",
2972
- "example": "subnet-xxxxxxxx",
2980
+ "document": "私有网络子网ID,形如subnet-51lcif9y。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784),从接口返回中的unSubnetId字段获取。",
2981
+ "example": "subnet-51lcif9y",
2973
2982
  "member": "string",
2974
2983
  "name": "SubnetId",
2975
2984
  "output_required": true,
@@ -2979,7 +2988,7 @@
2979
2988
  {
2980
2989
  "disabled": false,
2981
2990
  "document": "实例ID。",
2982
- "example": "postgres-xxxxxxxx",
2991
+ "example": "postgres-7lzldndx",
2983
2992
  "member": "string",
2984
2993
  "name": "DBInstanceId",
2985
2994
  "output_required": true,
@@ -2989,7 +2998,7 @@
2989
2998
  {
2990
2999
  "disabled": false,
2991
3000
  "document": "实例名称。",
2992
- "example": "xxxx",
3001
+ "example": "数据库名称",
2993
3002
  "member": "string",
2994
3003
  "name": "DBInstanceName",
2995
3004
  "output_required": true,
@@ -2998,7 +3007,7 @@
2998
3007
  },
2999
3008
  {
3000
3009
  "disabled": false,
3001
- "document": "实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolating(隔离中)、isolated(已隔离)、recycling(回收中)、recycled(已回收)、job running(任务执行中)、offline(下线)、migrating(迁移中)、expanding(扩容中)、waitSwitch(等待切换)、switching(切换中)、readonly(只读)、restarting(重启中)、network changing(网络变更中)、upgrading(内核版本升级中)、audit-switching(审计状态变更中)、primary-switching(主备切换中)",
3010
+ "document": "实例状态,分别为:applying(申请中)、init(待初始化)、initing(初始化中)、running(运行中)、limited run(受限运行)、isolating(隔离中)、isolated(已隔离)、disisolating(解隔离中)、recycling(回收中)、recycled(已回收)、job running(任务执行中)、offline(下线)、migrating(迁移中)、expanding(扩容中)、waitSwitch(等待切换)、switching(切换中)、readonly(只读)、restarting(重启中)、network changing(网络变更中)、upgrading(内核版本升级中)、audit-switching(审计状态变更中)、primary-switching(主备切换中)",
3002
3011
  "example": "applying",
3003
3012
  "member": "string",
3004
3013
  "name": "DBInstanceStatus",
@@ -3078,7 +3087,7 @@
3078
3087
  },
3079
3088
  {
3080
3089
  "disabled": false,
3081
- "document": "实例类型,类型有:\n<li>primary:主实例\n<li>readonly:只读实例\n<li>guard:灾备实例\n<li>temp:临时实例",
3090
+ "document": "实例类型,类型有:\n<li>primary:主实例</li>\n<li>readonly:只读实例</li>\n<li>guard:灾备实例</li>\n<li>temp:临时实例</li>",
3082
3091
  "example": "primary",
3083
3092
  "member": "string",
3084
3093
  "name": "DBInstanceType",
@@ -3098,7 +3107,7 @@
3098
3107
  },
3099
3108
  {
3100
3109
  "disabled": false,
3101
- "document": "实例字符集,目前只支持:\n<li> UTF8\n<li> LATIN1",
3110
+ "document": "实例字符集,目前只支持:\n<li> UTF8</li>\n<li> LATIN1</li>",
3102
3111
  "example": "utf-8",
3103
3112
  "member": "string",
3104
3113
  "name": "DBCharset",
@@ -3148,7 +3157,7 @@
3148
3157
  },
3149
3158
  {
3150
3159
  "disabled": false,
3151
- "document": "计费模式:\n<li>prepaid:包年包月,预付费\n<li>postpaid:按量计费,后付费",
3160
+ "document": "计费模式:\n<li>prepaid:包年包月,预付费</li>\n<li>postpaid:按量计费,后付费</li>",
3152
3161
  "example": "prepaid",
3153
3162
  "member": "string",
3154
3163
  "name": "PayType",
@@ -3158,7 +3167,7 @@
3158
3167
  },
3159
3168
  {
3160
3169
  "disabled": false,
3161
- "document": "是否自动续费:\n<li>0:手动续费\n<li>1:自动续费\n默认值:0",
3170
+ "document": "是否自动续费:\n<li>0:手动续费</li>\n<li>1:自动续费</li>\n默认值:0",
3162
3171
  "example": "1",
3163
3172
  "member": "uint64",
3164
3173
  "name": "AutoRenew",
@@ -3169,7 +3178,7 @@
3169
3178
  {
3170
3179
  "disabled": false,
3171
3180
  "document": "实例网络连接信息。",
3172
- "example": "",
3181
+ "example": "[ { \"Address\": \"\", \"Ip\": \"10.10.10.220\", \"Port\": 5432, \"Status\": \"opened\", \"NetType\": \"private\", \"VpcId\": \"vpc-xxxxxxxx\", \"SubnetId\": \"subnet-xxxxxxxx\" }, { \"Address\": \"\", \"Ip\": \"\", \"Port\": 0, \"Status\": \"\", \"NetType\": \"public\", \"VpcId\": \"\", \"SubnetId\": \"\" } ]",
3173
3182
  "member": "DBInstanceNetInfo",
3174
3183
  "name": "DBInstanceNetInfo",
3175
3184
  "output_required": true,
@@ -3219,7 +3228,7 @@
3219
3228
  {
3220
3229
  "disabled": false,
3221
3230
  "document": "实例绑定的标签信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3222
- "example": "",
3231
+ "example": "[ { \"TagKey\": \"tag1\", \"TagValue\": \"v1\" } ]",
3223
3232
  "member": "Tag",
3224
3233
  "name": "TagList",
3225
3234
  "output_required": true,
@@ -3229,7 +3238,7 @@
3229
3238
  {
3230
3239
  "disabled": false,
3231
3240
  "document": "主实例信息,仅在实例为只读实例时返回。\n注意:此字段可能返回 null,表示取不到有效值。",
3232
- "example": "postgres-xxxxxxxx",
3241
+ "example": "postgres-7lzldndx",
3233
3242
  "member": "string",
3234
3243
  "name": "MasterDBInstanceId",
3235
3244
  "output_required": true,
@@ -3269,7 +3278,7 @@
3269
3278
  {
3270
3279
  "disabled": false,
3271
3280
  "document": "实例的节点信息。\n注意:此字段可能返回 null,表示取不到有效值。",
3272
- "example": "",
3281
+ "example": "[ { \"Role\": \"Primary\", \"Zone\": \"ap-guangzhou-2\" } ]",
3273
3282
  "member": "DBNode",
3274
3283
  "name": "DBNodeSet",
3275
3284
  "output_required": true,
@@ -3278,7 +3287,7 @@
3278
3287
  },
3279
3288
  {
3280
3289
  "disabled": false,
3281
- "document": "实例是否支持TDE数据加密:\n<li>0:不支持\n<li>1:支持\n默认值:0\nTDE数据加密可参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)\n注意:此字段可能返回 null,表示取不到有效值。",
3290
+ "document": "实例是否支持TDE数据加密:\n<li>0:不支持</li>\n<li>1:支持</li>\n默认值:0\nTDE数据加密可参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)\n注意:此字段可能返回 null,表示取不到有效值。",
3282
3291
  "example": "1",
3283
3292
  "member": "int64",
3284
3293
  "name": "IsSupportTDE",
@@ -3288,7 +3297,7 @@
3288
3297
  },
3289
3298
  {
3290
3299
  "disabled": false,
3291
- "document": "数据库引擎,支持:\n<li>postgresql:云数据库PostgreSQL\n<li>mssql_compatible:MSSQL兼容-云数据库PostgreSQL\n默认值:postgresql\n注意:此字段可能返回 null,表示取不到有效值。",
3300
+ "document": "数据库引擎,支持:\n<li>postgresql:云数据库PostgreSQL</li>\n<li>mssql_compatible:MSSQL兼容-云数据库PostgreSQL</li>\n默认值:postgresql\n注意:此字段可能返回 null,表示取不到有效值。",
3292
3301
  "example": "postgresql",
3293
3302
  "member": "string",
3294
3303
  "name": "DBEngine",
@@ -3298,8 +3307,8 @@
3298
3307
  },
3299
3308
  {
3300
3309
  "disabled": false,
3301
- "document": "数据库引擎的配置信息,配置格式如下:\n{\"$key1\":\"$value1\", \"$key2\":\"$value2\"}\n各引擎支持如下:\nmssql_compatible引擎:\n<li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。\n<li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:\n\"af_ZA\", \"sq_AL\", \"ar_DZ\", \"ar_BH\", \"ar_EG\", \"ar_IQ\", \"ar_JO\", \"ar_KW\", \"ar_LB\", \"ar_LY\", \"ar_MA\", \"ar_OM\", \"ar_QA\", \"ar_SA\", \"ar_SY\", \"ar_TN\", \"ar_AE\", \"ar_YE\", \"hy_AM\", \"az_Cyrl_AZ\", \"az_Latn_AZ\", \"eu_ES\", \"be_BY\", \"bg_BG\", \"ca_ES\", \"zh_HK\", \"zh_MO\", \"zh_CN\", \"zh_SG\", \"zh_TW\", \"hr_HR\", \"cs_CZ\", \"da_DK\", \"nl_BE\", \"nl_NL\", \"en_AU\", \"en_BZ\", \"en_CA\", \"en_IE\", \"en_JM\", \"en_NZ\", \"en_PH\", \"en_ZA\", \"en_TT\", \"en_GB\", \"en_US\", \"en_ZW\", \"et_EE\", \"fo_FO\", \"fa_IR\", \"fi_FI\", \"fr_BE\", \"fr_CA\", \"fr_FR\", \"fr_LU\", \"fr_MC\", \"fr_CH\", \"mk_MK\", \"ka_GE\", \"de_AT\", \"de_DE\", \"de_LI\", \"de_LU\", \"de_CH\", \"el_GR\", \"gu_IN\", \"he_IL\", \"hi_IN\", \"hu_HU\", \"is_IS\", \"id_ID\", \"it_IT\", \"it_CH\", \"ja_JP\", \"kn_IN\", \"kok_IN\", \"ko_KR\", \"ky_KG\", \"lv_LV\", \"lt_LT\", \"ms_BN\", \"ms_MY\", \"mr_IN\", \"mn_MN\", \"nb_NO\", \"nn_NO\", \"pl_PL\", \"pt_BR\", \"pt_PT\", \"pa_IN\", \"ro_RO\", \"ru_RU\", \"sa_IN\", \"sr_Cyrl_RS\", \"sr_Latn_RS\", \"sk_SK\", \"sl_SI\", \"es_AR\", \"es_BO\", \"es_CL\", \"es_CO\", \"es_CR\", \"es_DO\", \"es_EC\", \"es_SV\", \"es_GT\", \"es_HN\", \"es_MX\", \"es_NI\", \"es_PA\", \"es_PY\",\"es_PE\", \"es_PR\", \"es_ES\", \"es_TRADITIONAL\", \"es_UY\", \"es_VE\", \"sw_KE\", \"sv_FI\", \"sv_SE\", \"tt_RU\", \"te_IN\", \"th_TH\", \"tr_TR\", \"uk_UA\", \"ur_IN\", \"ur_PK\", \"uz_Cyrl_UZ\", \"uz_Latn_UZ\", \"vi_VN\"。\n<li>serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:\"bbf_unicode_general_ci_as\", \"bbf_unicode_cp1_ci_as\", \"bbf_unicode_CP1250_ci_as\", \"bbf_unicode_CP1251_ci_as\", \"bbf_unicode_cp1253_ci_as\", \"bbf_unicode_cp1254_ci_as\", \"bbf_unicode_cp1255_ci_as\", \"bbf_unicode_cp1256_ci_as\", \"bbf_unicode_cp1257_ci_as\", \"bbf_unicode_cp1258_ci_as\", \"bbf_unicode_cp874_ci_as\", \"sql_latin1_general_cp1250_ci_as\", \"sql_latin1_general_cp1251_ci_as\", \"sql_latin1_general_cp1_ci_as\", \"sql_latin1_general_cp1253_ci_as\", \"sql_latin1_general_cp1254_ci_as\", \"sql_latin1_general_cp1255_ci_as\",\"sql_latin1_general_cp1256_ci_as\", \"sql_latin1_general_cp1257_ci_as\", \"sql_latin1_general_cp1258_ci_as\", \"chinese_prc_ci_as\", \"cyrillic_general_ci_as\", \"finnish_swedish_ci_as\", \"french_ci_as\", \"japanese_ci_as\", \"korean_wansung_ci_as\", \"latin1_general_ci_as\", \"modern_spanish_ci_as\", \"polish_ci_as\", \"thai_ci_as\", \"traditional_spanish_ci_as\", \"turkish_ci_as\", \"ukrainian_ci_as\", \"vietnamese_ci_as\"。\n注意:此字段可能返回 null,表示取不到有效值。",
3302
- "example": "",
3310
+ "document": "数据库引擎的配置信息,配置格式如下:\n{\"$key1\":\"$value1\", \"$key2\":\"$value2\"}\n各引擎支持如下:\nmssql_compatible引擎:\n<li>migrationMode:数据库模式,可选参数,可取值:single-db(单数据库模式),multi-db(多数据库模式)。默认为single-db。</li>\n<li>defaultLocale:排序区域规则,可选参数,在初始化后不可修改,默认为en_US,可选值如下:\n\"af_ZA\", \"sq_AL\", \"ar_DZ\", \"ar_BH\", \"ar_EG\", \"ar_IQ\", \"ar_JO\", \"ar_KW\", \"ar_LB\", \"ar_LY\", \"ar_MA\", \"ar_OM\", \"ar_QA\", \"ar_SA\", \"ar_SY\", \"ar_TN\", \"ar_AE\", \"ar_YE\", \"hy_AM\", \"az_Cyrl_AZ\", \"az_Latn_AZ\", \"eu_ES\", \"be_BY\", \"bg_BG\", \"ca_ES\", \"zh_HK\", \"zh_MO\", \"zh_CN\", \"zh_SG\", \"zh_TW\", \"hr_HR\", \"cs_CZ\", \"da_DK\", \"nl_BE\", \"nl_NL\", \"en_AU\", \"en_BZ\", \"en_CA\", \"en_IE\", \"en_JM\", \"en_NZ\", \"en_PH\", \"en_ZA\", \"en_TT\", \"en_GB\", \"en_US\", \"en_ZW\", \"et_EE\", \"fo_FO\", \"fa_IR\", \"fi_FI\", \"fr_BE\", \"fr_CA\", \"fr_FR\", \"fr_LU\", \"fr_MC\", \"fr_CH\", \"mk_MK\", \"ka_GE\", \"de_AT\", \"de_DE\", \"de_LI\", \"de_LU\", \"de_CH\", \"el_GR\", \"gu_IN\", \"he_IL\", \"hi_IN\", \"hu_HU\", \"is_IS\", \"id_ID\", \"it_IT\", \"it_CH\", \"ja_JP\", \"kn_IN\", \"kok_IN\", \"ko_KR\", \"ky_KG\", \"lv_LV\", \"lt_LT\", \"ms_BN\", \"ms_MY\", \"mr_IN\", \"mn_MN\", \"nb_NO\", \"nn_NO\", \"pl_PL\", \"pt_BR\", \"pt_PT\", \"pa_IN\", \"ro_RO\", \"ru_RU\", \"sa_IN\", \"sr_Cyrl_RS\", \"sr_Latn_RS\", \"sk_SK\", \"sl_SI\", \"es_AR\", \"es_BO\", \"es_CL\", \"es_CO\", \"es_CR\", \"es_DO\", \"es_EC\", \"es_SV\", \"es_GT\", \"es_HN\", \"es_MX\", \"es_NI\", \"es_PA\", \"es_PY\",\"es_PE\", \"es_PR\", \"es_ES\", \"es_TRADITIONAL\", \"es_UY\", \"es_VE\", \"sw_KE\", \"sv_FI\", \"sv_SE\", \"tt_RU\", \"te_IN\", \"th_TH\", \"tr_TR\", \"uk_UA\", \"ur_IN\", \"ur_PK\", \"uz_Cyrl_UZ\", \"uz_Latn_UZ\", \"vi_VN\"。</li>\n<li>serverCollationName:排序规则名称,可选参数,在初始化后不可修改,默认为sql_latin1_general_cp1_ci_as,可选值如下:\"bbf_unicode_general_ci_as\", \"bbf_unicode_cp1_ci_as\", \"bbf_unicode_CP1250_ci_as\", \"bbf_unicode_CP1251_ci_as\", \"bbf_unicode_cp1253_ci_as\", \"bbf_unicode_cp1254_ci_as\", \"bbf_unicode_cp1255_ci_as\", \"bbf_unicode_cp1256_ci_as\", \"bbf_unicode_cp1257_ci_as\", \"bbf_unicode_cp1258_ci_as\", \"bbf_unicode_cp874_ci_as\", \"sql_latin1_general_cp1250_ci_as\", \"sql_latin1_general_cp1251_ci_as\", \"sql_latin1_general_cp1_ci_as\", \"sql_latin1_general_cp1253_ci_as\", \"sql_latin1_general_cp1254_ci_as\", \"sql_latin1_general_cp1255_ci_as\",\"sql_latin1_general_cp1256_ci_as\", \"sql_latin1_general_cp1257_ci_as\", \"sql_latin1_general_cp1258_ci_as\", \"chinese_prc_ci_as\", \"cyrillic_general_ci_as\", \"finnish_swedish_ci_as\", \"french_ci_as\", \"japanese_ci_as\", \"korean_wansung_ci_as\", \"latin1_general_ci_as\", \"modern_spanish_ci_as\", \"polish_ci_as\", \"thai_ci_as\", \"traditional_spanish_ci_as\", \"turkish_ci_as\", \"ukrainian_ci_as\", \"vietnamese_ci_as\"。</li>\n注意:此字段可能返回 null,表示取不到有效值。",
3311
+ "example": "{ \"migrationMode\": \"single-db\", \"defaultLocale\": \"zh_CN\", \"serverCollationName\": \"sql_latin1_general_cp1250_ci_as\" }",
3303
3312
  "member": "string",
3304
3313
  "name": "DBEngineConfig",
3305
3314
  "output_required": true,
@@ -3309,7 +3318,7 @@
3309
3318
  {
3310
3319
  "disabled": false,
3311
3320
  "document": "实例网络信息列表(此字段已废弃)\n注意:此字段可能返回 null,表示取不到有效值。",
3312
- "example": "",
3321
+ "example": "[]",
3313
3322
  "member": "NetworkAccess",
3314
3323
  "name": "NetworkAccessList",
3315
3324
  "output_required": true,
@@ -3318,7 +3327,7 @@
3318
3327
  },
3319
3328
  {
3320
3329
  "disabled": false,
3321
- "document": "实例是否支持Ipv6:\n<li>0:否\n<li>1:是\n默认值:0",
3330
+ "document": "实例是否支持Ipv6:\n<li>0:否</li>\n<li>1:是</li>\n默认值:0",
3322
3331
  "example": "1",
3323
3332
  "member": "uint64",
3324
3333
  "name": "SupportIpv6",
@@ -3510,7 +3519,7 @@
3510
3519
  {
3511
3520
  "disabled": false,
3512
3521
  "document": "目标VIP地址。",
3513
- "example": "",
3522
+ "example": "10.10.10.220",
3514
3523
  "member": "string",
3515
3524
  "name": "Vip",
3516
3525
  "required": true,
@@ -3528,7 +3537,7 @@
3528
3537
  "example": "1234",
3529
3538
  "member": "int64",
3530
3539
  "name": "FlowId",
3531
- "required": true,
3540
+ "output_required": true,
3532
3541
  "type": "int",
3533
3542
  "value_allowed_null": true
3534
3543
  },
@@ -3637,7 +3646,7 @@
3637
3646
  {
3638
3647
  "disabled": false,
3639
3648
  "document": "目标VIP地址。",
3640
- "example": "",
3649
+ "example": "10.10.10.220",
3641
3650
  "member": "string",
3642
3651
  "name": "Vip",
3643
3652
  "required": true,
@@ -3655,7 +3664,7 @@
3655
3664
  "example": "1234",
3656
3665
  "member": "int64",
3657
3666
  "name": "FlowId",
3658
- "required": true,
3667
+ "output_required": true,
3659
3668
  "type": "int",
3660
3669
  "value_allowed_null": true
3661
3670
  },
@@ -3885,42 +3894,47 @@
3885
3894
  "example": "NONE",
3886
3895
  "member": "string",
3887
3896
  "name": "RestrictionType",
3897
+ "output_required": true,
3888
3898
  "type": "string",
3889
3899
  "value_allowed_null": false
3890
3900
  },
3891
3901
  {
3892
3902
  "disabled": false,
3893
3903
  "document": "vpc限制效力,ALLOW 允许;DENY 拒绝。\n注意:此字段可能返回 null,表示取不到有效值。",
3894
- "example": "",
3904
+ "example": "Allow",
3895
3905
  "member": "string",
3896
3906
  "name": "VpcRestrictionEffect",
3907
+ "output_required": true,
3897
3908
  "type": "string",
3898
3909
  "value_allowed_null": true
3899
3910
  },
3900
3911
  {
3901
3912
  "disabled": false,
3902
3913
  "document": "允许或拒绝下载备份文件的vpcId列表。\n注意:此字段可能返回 null,表示取不到有效值。",
3903
- "example": "",
3914
+ "example": "[ \"vpc-15ld6dhr\" ]",
3904
3915
  "member": "string",
3905
3916
  "name": "VpcIdSet",
3917
+ "output_required": true,
3906
3918
  "type": "list",
3907
3919
  "value_allowed_null": true
3908
3920
  },
3909
3921
  {
3910
3922
  "disabled": false,
3911
3923
  "document": "ip限制效力,ALLOW 允许;DENY 拒绝。\n注意:此字段可能返回 null,表示取不到有效值。",
3912
- "example": "",
3924
+ "example": "Allow",
3913
3925
  "member": "string",
3914
3926
  "name": "IpRestrictionEffect",
3927
+ "output_required": true,
3915
3928
  "type": "string",
3916
3929
  "value_allowed_null": true
3917
3930
  },
3918
3931
  {
3919
3932
  "disabled": false,
3920
3933
  "document": "允许或拒绝下载备份文件的ip列表。\n注意:此字段可能返回 null,表示取不到有效值。",
3921
- "example": "",
3934
+ "example": "[ \"10.10.10.220\" ]",
3922
3935
  "member": "string",
3923
3936
  "name": "IpSet",
3937
+ "output_required": true,
3924
3938
  "type": "list",
3925
3939
  "value_allowed_null": true
3926
3940
  },
@@ -3975,7 +3989,7 @@
3975
3989
  {
3976
3990
  "disabled": false,
3977
3991
  "document": "备份下载限制",
3978
- "example": "",
3992
+ "example": "{ \"RestrictionType\": \"NONE\", \"VpcRestrictionEffect\": \"ALLOW\", \"VpcIdSet\": [ \"vpc-15ld6dhr\" ], \"IpRestrictionEffect\": \"ALLOW\", \"IpSet\": [ \"10.10.10.220\" ] }",
3979
3993
  "member": "BackupDownloadRestriction",
3980
3994
  "name": "BackupDownloadRestriction",
3981
3995
  "required": false,
@@ -3990,9 +4004,10 @@
3990
4004
  {
3991
4005
  "disabled": false,
3992
4006
  "document": "备份的下载地址。",
3993
- "example": "",
4007
+ "example": "https://postgres-backup-gz-xxxx.cos.ap-guangzhou.myqcloud.com/pgsql/xxxx",
3994
4008
  "member": "string",
3995
4009
  "name": "BackupDownloadURL",
4010
+ "output_required": true,
3996
4011
  "type": "string",
3997
4012
  "value_allowed_null": false
3998
4013
  },
@@ -4133,10 +4148,10 @@
4133
4148
  {
4134
4149
  "disabled": false,
4135
4150
  "document": "实例的备份计划集",
4136
- "example": "",
4151
+ "example": "[ { \"BackupPeriod\": \"[\\\"monday\\\",\\\"thursday\\\",\\\"friday\\\"]\", \"BaseBackupRetentionPeriod\": 3, \"MaxBackupStartTime\": \"10:00:00\", \"MinBackupStartTime\": \"08:00:00\" } ]",
4137
4152
  "member": "BackupPlan",
4138
4153
  "name": "Plans",
4139
- "required": true,
4154
+ "output_required": true,
4140
4155
  "type": "list",
4141
4156
  "value_allowed_null": false
4142
4157
  },
@@ -4173,7 +4188,7 @@
4173
4188
  {
4174
4189
  "disabled": false,
4175
4190
  "document": "按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:\ndb-instance-id:按照实例ID过滤,类型为string。\ndb-instance-name:按照实例名过滤,类型为string。\ndb-instance-ip:按照实例私有网络IP地址过滤,类型为string。",
4176
- "example": "",
4191
+ "example": "[ { \"Values\": [ \"postgres-2uepfuz1\" ], \"Name\": \"db-instance-id\" } ]",
4177
4192
  "member": "Filter",
4178
4193
  "name": "Filters",
4179
4194
  "required": false,
@@ -4206,10 +4221,10 @@
4206
4221
  {
4207
4222
  "disabled": false,
4208
4223
  "document": "备份统计信息列表。",
4209
- "example": "",
4224
+ "example": "[ { \"AutoBaseBackupCount\": 3, \"AutoBaseBackupSize\": 3535342436352, \"DBInstanceId\": \"postgres-lsw5y0bp\", \"LogBackupCount\": 2, \"LogBackupSize\": 167792640, \"ManualBaseBackupCount\": 1, \"ManualBaseBackupSize\": 1178447478784, \"TotalBackupCount\": 6, \"TotalBackupSize\": 4713957707776 } ]",
4210
4225
  "member": "BackupSummary",
4211
4226
  "name": "BackupSummarySet",
4212
- "required": true,
4227
+ "output_required": true,
4213
4228
  "type": "list",
4214
4229
  "value_allowed_null": false
4215
4230
  },
@@ -4219,7 +4234,7 @@
4219
4234
  "example": "10",
4220
4235
  "member": "uint64",
4221
4236
  "name": "TotalCount",
4222
- "required": true,
4237
+ "output_required": true,
4223
4238
  "type": "int",
4224
4239
  "value_allowed_null": false
4225
4240
  },
@@ -4256,7 +4271,7 @@
4256
4271
  {
4257
4272
  "disabled": false,
4258
4273
  "document": "按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:\ndb-instance-id:按照实例ID过滤,类型为string。\ndb-instance-name:按照实例名过滤,类型为string。\ndb-instance-ip:按照实例私有网络IP地址过滤,类型为string。\nbase-backup-id:按照备份集ID过滤,类型为string。",
4259
- "example": "",
4274
+ "example": "[ { \"Values\": [ \"postgres-jdlmoll9\" ], \"Name\": \"db-instance-id\" } ]",
4260
4275
  "member": "Filter",
4261
4276
  "name": "Filters",
4262
4277
  "required": false,
@@ -4317,7 +4332,7 @@
4317
4332
  {
4318
4333
  "disabled": false,
4319
4334
  "document": "数据备份详细信息列表。",
4320
- "example": "",
4335
+ "example": "[ { \"BackupMethod\": \"physical\", \"BackupMode\": \"manual\", \"DBInstanceId\": \"postgres-9n26zs6n\", \"ExpireTime\": \"2023-02-18 23:59:59\", \"FinishTime\": \"2023-02-15 19:09:36\", \"Id\": \"88d3a71e-b822-5728-9d41-d8cfc0d0556e\", \"Name\": \"manual-20230215190924.tar.gz\", \"Size\": 39845888, \"StartTime\": \"2023-02-15 19:09:24\", \"State\": \"finished\" } ]",
4321
4336
  "member": "BaseBackup",
4322
4337
  "name": "BaseBackupSet",
4323
4338
  "output_required": true,
@@ -4372,9 +4387,10 @@
4372
4387
  {
4373
4388
  "disabled": false,
4374
4389
  "document": "数据库规格列表",
4375
- "example": "",
4390
+ "example": "[ { \"CPU\": 16, \"MaxStorage\": 3000, \"Memory\": 131072, \"MinStorage\": 1000, \"QPS\": 79000, \"SpecCode\": \"pg.it.2xlarge16\" }, { \"CPU\": 48, \"MaxStorage\": 6000, \"Memory\": 491520, \"MinStorage\": 1000, \"QPS\": 238000, \"SpecCode\": \"pg.it.2xlarge16\" } ]",
4376
4391
  "member": "ClassInfo",
4377
4392
  "name": "ClassInfoSet",
4393
+ "output_required": true,
4378
4394
  "type": "list",
4379
4395
  "value_allowed_null": false
4380
4396
  },
@@ -4426,9 +4442,10 @@
4426
4442
  {
4427
4443
  "disabled": false,
4428
4444
  "document": "可购买的最小规格码。",
4429
- "example": "",
4445
+ "example": "pg.it.2xlarge16",
4430
4446
  "member": "string",
4431
4447
  "name": "MinSpecCode",
4448
+ "output_required": true,
4432
4449
  "type": "string",
4433
4450
  "value_allowed_null": false
4434
4451
  },
@@ -4438,6 +4455,7 @@
4438
4455
  "example": "1000",
4439
4456
  "member": "int64",
4440
4457
  "name": "MinStorage",
4458
+ "output_required": true,
4441
4459
  "type": "int",
4442
4460
  "value_allowed_null": false
4443
4461
  },
@@ -4519,15 +4537,17 @@
4519
4537
  "example": "2",
4520
4538
  "member": "int64",
4521
4539
  "name": "TotalCount",
4540
+ "output_required": true,
4522
4541
  "type": "int",
4523
4542
  "value_allowed_null": false
4524
4543
  },
4525
4544
  {
4526
4545
  "disabled": false,
4527
4546
  "document": "备份列表",
4528
- "example": "",
4547
+ "example": "[ { \"SetId\": \"f77ecd1a-087c-5c66-8c35-95c835d7ec24\", \"Status\": 2, \"InternalAddr\": \"http://172.16.16.30:8366/download/20180622015612.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIsdfgfJdfs+89qfhuYQ5wC0ooTcDIdUwB4iJlL1by8xfKkcMAv8nr8g67P6hhg5YOnk=\", \"StartTime\": \"2018-06-22 01:56:01.181971\", \"ExternalAddr\": \"https://gz-dl-postgres.cloud.tencent.com/download/20180622015612.tar.gz?giz7Z4LlMjascFkshSSB4+B1gaI0F3HAQIZcFPDbIsdfgfJdfs+89qfhuYQ5wC0ooTcDIdUwB4iJlL1by8xfKkcMAv8nr8g67P6hhg5YOnk=\", \"Strategy\": 1, \"DbList\": [ \"db1\" ], \"Way\": 1, \"EndTime\": \"2018-06-22 01:56:55.071181\", \"Type\": 1, \"Id\": 450, \"Size\": 3654968 } ]",
4529
4548
  "member": "DBBackup",
4530
4549
  "name": "BackupList",
4550
+ "output_required": true,
4531
4551
  "type": "list",
4532
4552
  "value_allowed_null": false
4533
4553
  },
@@ -4618,15 +4638,17 @@
4618
4638
  "example": "10",
4619
4639
  "member": "int64",
4620
4640
  "name": "TotalCount",
4641
+ "output_required": true,
4621
4642
  "type": "int",
4622
4643
  "value_allowed_null": false
4623
4644
  },
4624
4645
  {
4625
4646
  "disabled": false,
4626
4647
  "document": "错误日志详细信息集合。",
4627
- "example": "",
4648
+ "example": "[ { \"UserName\": \"postgres\", \"ErrTime\": \"2018-06-22 15:22:52\", \"ErrMsg\": \"WARNING: there is no transaction in progress \", \"Database\": \"dee\" }, { \"UserName\": \"postgres\", \"ErrTime\": \"2018-06-22 15:22:52\", \"ErrMsg\": \"WARNING: there is no transaction in progress \", \"Database\": \"dee\" }, { \"UserName\": \"postgres\", \"ErrTime\": \"2018-06-22 15:23:09\", \"ErrMsg\": \"WARNING: there is no transaction in progress \", \"Database\": \"dee\" } ]",
4628
4649
  "member": "ErrLogDetail",
4629
4650
  "name": "Details",
4651
+ "output_required": true,
4630
4652
  "type": "list",
4631
4653
  "value_allowed_null": false
4632
4654
  },
@@ -4660,10 +4682,10 @@
4660
4682
  {
4661
4683
  "disabled": false,
4662
4684
  "document": "实例详细信息。",
4663
- "example": "",
4685
+ "example": "{ \"Region\": \"ap-guangzhou\", \"Zone\": \"ap-guangzhou-2\", \"AppId\": 100000000, \"Uid\": 1000001, \"ProjectId\": 0, \"VpcId\": \"vpc-xxxxxxxx\", \"SubnetId\": \"subnet-xxxxxxxx\", \"DBInstanceId\": \"postgres-xxxxxxxx\", \"MasterDBInstanceId\": \"postgres-xxxxxxxx\", \"Type\": 1, \"DBInstanceName\": \"未命名\", \"DBInstanceStatus\": \"running\", \"DBInstanceMemory\": 4, \"DBInstanceStorage\": 20, \"DBInstanceCpu\": 2, \"DBInstanceClass\": \"cdb.pg.z1.4g\", \"DBInstanceType\": \"primary\", \"DBInstanceVersion\": \"standard\", \"DBInstanceNetInfo\": [ { \"Address\": \"\", \"Ip\": \"10.10.10.220\", \"Port\": 5432, \"Status\": \"opened\", \"NetType\": \"private\", \"VpcId\": \"vpc-xxxxxxxx\", \"SubnetId\": \"subnet-xxxxxxxx\" }, { \"Address\": \"\", \"Ip\": \"\", \"Port\": 0, \"Status\": \"initing\", \"NetType\": \"public\", \"VpcId\": \"\", \"SubnetId\": \"\" } ], \"DBCharset\": \"UTF8\", \"IsSupportTDE\": 0, \"DBVersion\": \"10.4\", \"DBMajorVersion\": \"10\", \"DBKernelVersion\": \"v10.4_r1.0\", \"CreateTime\": \"2017-12-28 19:23:19\", \"UpdateTime\": \"2018-01-18 15:54:32\", \"ExpireTime\": \"2018-01-28 19:23:23\", \"IsolatedTime\": \"0000-00-00 00:00:00\", \"OfflineTime\": \"2019-12-28 19:23:19\", \"PayType\": \"prepaid\", \"AutoRenew\": 1, \"ReadOnlyInstanceNum\": 1, \"StatusInReadonlyGroup\": \"running\", \"SupportIpv6\": 0, \"TagList\": [ { \"TagKey\": \"tag1\", \"TagValue\": \"v1\" } ], \"NetworkAccessList\": [], \"DBNodeSet\": [ { \"Role\": \"Primary\", \"Zone\": \"ap-guangzhou-2\" }, { \"Role\": \"Standby\", \"Zone\": \"ap-guangzhou-3\" } ] }",
4664
4686
  "member": "DBInstance",
4665
4687
  "name": "DBInstance",
4666
- "required": true,
4688
+ "output_required": true,
4667
4689
  "type": "object",
4668
4690
  "value_allowed_null": false
4669
4691
  },
@@ -4786,15 +4808,17 @@
4786
4808
  "example": "1",
4787
4809
  "member": "int64",
4788
4810
  "name": "TotalCount",
4811
+ "output_required": true,
4789
4812
  "type": "int",
4790
4813
  "value_allowed_null": false
4791
4814
  },
4792
4815
  {
4793
4816
  "disabled": false,
4794
4817
  "document": "参数列表返回详情",
4795
- "example": "",
4818
+ "example": "[ { \"Advanced\": false, \"ClassificationCN\": \"连接和认证\", \"ClassificationEN\": \"Connections and Authentication\", \"CurrentValue\": \"2048\", \"DefaultValue\": \"2048\", \"EnumValue\": null, \"ID\": 15124, \"LastModifyTime\": \"\", \"Max\": 2048, \"Min\": 100, \"Name\": \"max_connections\", \"NeedReboot\": true, \"ParamDescriptionCH\": \"实例最大连接数\", \"ParamDescriptionEN\": \"Sets the maximum number of concurrent connections.\", \"ParamValueType\": \"integer\", \"SpecRelated\": true, \"SpecRelationSet\": null, \"StandbyRelated\": 0, \"Unit\": \"\", \"VersionRelationSet\": null } ]",
4796
4819
  "member": "ParamInfo",
4797
4820
  "name": "Detail",
4821
+ "output_required": true,
4798
4822
  "type": "list",
4799
4823
  "value_allowed_null": false
4800
4824
  },
@@ -4837,9 +4861,10 @@
4837
4861
  {
4838
4862
  "disabled": false,
4839
4863
  "document": "安全组信息数组",
4840
- "example": "",
4864
+ "example": "[ { \"CreateTime\": \"2022-10-20 21:38:20\", \"Inbound\": [ { \"Action\": \"ACCEPT\", \"CidrIp\": \"0.0.0.0/0\", \"Description\": \"放通Ping服务\", \"IpProtocol\": \"icmp\", \"PortRange\": \"ALL\" }, { \"Action\": \"ACCEPT\", \"CidrIp\": \"::/0\", \"Description\": \"放通Ping服务\", \"IpProtocol\": \"icmpv6\", \"PortRange\": \"ALL\" } ], \"Outbound\": [ { \"Action\": \"ACCEPT\", \"CidrIp\": \"0.0.0.0/0\", \"Description\": \"\", \"IpProtocol\": \"ALL\", \"PortRange\": \"ALL\" }, { \"Action\": \"ACCEPT\", \"CidrIp\": \"\", \"Description\": \"\", \"IpProtocol\": \"ALL\", \"PortRange\": \"ALL\" } ], \"ProjectId\": 0, \"SecurityGroupDescription\": \"自定义模板\", \"SecurityGroupId\": \"sg-91jbmkp1\", \"SecurityGroupName\": \"自定义模板-20221020213819279\" } ]",
4841
4865
  "member": "SecurityGroup",
4842
4866
  "name": "SecurityGroupSet",
4867
+ "output_required": true,
4843
4868
  "type": "list",
4844
4869
  "value_allowed_null": false
4845
4870
  },
@@ -4857,8 +4882,8 @@
4857
4882
  "members": [
4858
4883
  {
4859
4884
  "disabled": false,
4860
- "document": "按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:\ndb-instance-id:按照实例ID过滤,类型为string\ndb-instance-name:按照实例名过滤,类型为string\ndb-project-id:按照项目ID过滤,类型为integer\ndb-pay-mode:按照付费模式过滤,类型为string\ndb-tag-key:按照标签键过滤,类型为string",
4861
- "example": "",
4885
+ "document": "按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:\ndb-instance-id:按照实例ID过滤,类型为string\ndb-instance-name:按照实例名过滤,类型为string\ndb-project-id:按照项目ID过滤,类型为integer\ndb-pay-mode:按照实例付费模式过滤,类型为string\ndb-tag-key:按照标签键过滤,类型为string\ndb-private-ip: 按照实例私有网络IP过滤,类型为string\ndb-public-address: 按照实例外网地址过滤,类型为string",
4886
+ "example": "[ { \"Values\": [ \"postgres-xxxxxxxx\" ], \"Name\": \"db-instance-id\" } ]",
4862
4887
  "member": "Filter",
4863
4888
  "name": "Filters",
4864
4889
  "required": false,
@@ -4912,17 +4937,17 @@
4912
4937
  "example": "1",
4913
4938
  "member": "uint64",
4914
4939
  "name": "TotalCount",
4915
- "required": true,
4940
+ "output_required": true,
4916
4941
  "type": "int",
4917
4942
  "value_allowed_null": false
4918
4943
  },
4919
4944
  {
4920
4945
  "disabled": false,
4921
4946
  "document": "实例详细信息集合。",
4922
- "example": "",
4947
+ "example": "[ { \"DBInstanceId\": \"postgres-xxxxxxxx\", \"DBInstanceName\": \"xxx\", \"DBInstanceStatus\": \"running\", \"Region\": \"ap-guangzhou\", \"Zone\": \"ap-guangzhou-3\", \"ProjectId\": 0, \"VpcId\": \"vpc-xxxxxxxx\", \"SubnetId\": \"subnet-xxxxxxxx\", \"DBCharset\": \"UTF8\", \"DBVersion\": \"10\", \"DBKernelVersion\": \"v10.4_r1.0\", \"CreateTime\": \"2020-03-20 12:19:14\", \"DBInstanceNetInfo\": [ { \"Address\": \"\", \"Ip\": \"10.10.10.111\", \"Port\": 5432, \"Status\": \"opened\", \"NetType\": \"private\" }, { \"Address\": \"\", \"Ip\": \"\", \"Port\": 0, \"Status\": \"initing\", \"NetType\": \"public\" } ], \"DBAccountSet\": [], \"DBDatabaseList\": null } ]",
4923
4948
  "member": "DBInstance",
4924
4949
  "name": "DBInstanceSet",
4925
- "required": true,
4950
+ "output_required": true,
4926
4951
  "type": "list",
4927
4952
  "value_allowed_null": false
4928
4953
  },
@@ -5022,15 +5047,17 @@
5022
5047
  "example": "0",
5023
5048
  "member": "int64",
5024
5049
  "name": "TotalCount",
5050
+ "output_required": true,
5025
5051
  "type": "int",
5026
5052
  "value_allowed_null": false
5027
5053
  },
5028
5054
  {
5029
5055
  "disabled": false,
5030
5056
  "document": "慢查询日志详情",
5031
- "example": "",
5057
+ "example": "[ { \"Advanced\": false, \"ClassificationCN\": \"连接和认证\", \"ClassificationEN\": \"Connections and Authentication\", \"CurrentValue\": \"2048\", \"DefaultValue\": \"2048\", \"EnumValue\": null, \"ID\": 15124, \"LastModifyTime\": \"\", \"Max\": 2048, \"Min\": 100, \"Name\": \"max_connections\", \"NeedReboot\": true, \"ParamDescriptionCH\": \"实例最大连接数\", \"ParamDescriptionEN\": \"Sets the maximum number of concurrent connections.\", \"ParamValueType\": \"integer\", \"SpecRelated\": true, \"SpecRelationSet\": null, \"StandbyRelated\": 0, \"Unit\": \"\", \"VersionRelationSet\": null } ]",
5032
5058
  "member": "SlowlogDetail",
5033
5059
  "name": "Detail",
5060
+ "output_required": true,
5034
5061
  "type": "object",
5035
5062
  "value_allowed_null": false
5036
5063
  },
@@ -5054,9 +5081,10 @@
5054
5081
  {
5055
5082
  "disabled": false,
5056
5083
  "document": "数据库版本号信息列表",
5057
- "example": "",
5084
+ "example": "[ { \"AvailableUpgradeTarget\": [], \"DBEngine\": \"mssql_compatible\", \"DBKernelVersion\": \"v14.3_r1.3\", \"DBMajorVersion\": \"14\", \"DBVersion\": \"14.3\", \"Status\": \"AVAILABLE\", \"SupportedFeatureNames\": [] }, { \"AvailableUpgradeTarget\": [ \"v14.3_r1.3\" ], \"DBEngine\": \"postgresql\", \"DBKernelVersion\": \"v14.2_r1.1\", \"DBMajorVersion\": \"14\", \"DBVersion\": \"14.2\", \"Status\": \"AVAILABLE\", \"SupportedFeatureNames\": [ \"TDE\" ] } ]",
5058
5085
  "member": "Version",
5059
5086
  "name": "VersionSet",
5087
+ "output_required": true,
5060
5088
  "type": "list",
5061
5089
  "value_allowed_null": false
5062
5090
  },
@@ -5129,15 +5157,17 @@
5129
5157
  "example": "6",
5130
5158
  "member": "int64",
5131
5159
  "name": "TotalCount",
5160
+ "output_required": true,
5132
5161
  "type": "int",
5133
5162
  "value_allowed_null": false
5134
5163
  },
5135
5164
  {
5136
5165
  "disabled": false,
5137
5166
  "document": "Xlog列表",
5138
- "example": "",
5167
+ "example": "[ { \"StartTime\": \"2018-06-22 01:56:46\", \"InternalAddr\": \"http://172.16.16.30:8366/download/20180622015646_20180622015653.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EagZ/IhOQeSGyXm+Qr3D3I2GL1G4RV69vLVylUaeIJ+zH+CEG5Ast0GoDmpzjJ5Jaw==\", \"EndTime\": \"2018-06-22 01:56:53\", \"ExternalAddr\": \"https://gz-dl-postgres.cloud.tencent.com/download/20180622015646_20180622015653.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3EagZ/IhOQeSGyXm+Qr3D3I2GL1G4RV69vLVylUaeIJ+zH+CEG5Ast0GoDmpzjJ5Jaw==\", \"Id\": 450, \"Size\": 247967 }, { \"StartTime\": \"2018-06-22 01:56:17\", \"InternalAddr\": \"http://172.16.16.30:8366/download/20180622015617_20180622015645.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3Eamxg5sq4mNUSXLgasiI8P5xiJVUBOrLUPKLYacTxFWP8y56/f36byxdYH5+PGMzOA==\", \"EndTime\": \"2018-06-22 01:56:45\", \"ExternalAddr\": \"https://gz-dl-postgres.cloud.tencent.com/download/20180622015617_20180622015645.tar.gz?giz7Z4LlMjal0S0oJY6+5JbQ1MfhjybTALKlriBmLUrmJMxzi1C3Eamxg5sq4mNUSXLgasiI8P5xiJVUBOrLUPKLYacTxFWP8y56/f36byxdYH5+PGMzOA==\", \"Id\": 450, \"Size\": 899618 } ]",
5139
5168
  "member": "Xlog",
5140
5169
  "name": "XlogList",
5170
+ "output_required": true,
5141
5171
  "type": "list",
5142
5172
  "value_allowed_null": false
5143
5173
  },
@@ -5161,6 +5191,33 @@
5161
5191
  "name": "DBInstanceId",
5162
5192
  "required": true,
5163
5193
  "type": "string"
5194
+ },
5195
+ {
5196
+ "disabled": false,
5197
+ "document": "按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:database-name:按照数据库名称过滤,类型为string。此处使用模糊匹配搜索符合条件的数据库。",
5198
+ "example": "[{\"Name\":\"database-name\",\"Values\":[\"postgres\"]}]",
5199
+ "member": "Filter",
5200
+ "name": "Filters",
5201
+ "required": false,
5202
+ "type": "list"
5203
+ },
5204
+ {
5205
+ "disabled": false,
5206
+ "document": "数据偏移量,从0开始。\t",
5207
+ "example": "0",
5208
+ "member": "uint64",
5209
+ "name": "Offset",
5210
+ "required": false,
5211
+ "type": "int"
5212
+ },
5213
+ {
5214
+ "disabled": false,
5215
+ "document": "单次显示数量",
5216
+ "example": "20",
5217
+ "member": "uint64",
5218
+ "name": "Limit",
5219
+ "required": false,
5220
+ "type": "int"
5164
5221
  }
5165
5222
  ],
5166
5223
  "type": "object"
@@ -5178,6 +5235,16 @@
5178
5235
  "type": "list",
5179
5236
  "value_allowed_null": false
5180
5237
  },
5238
+ {
5239
+ "disabled": false,
5240
+ "document": "数据库总数",
5241
+ "example": "2",
5242
+ "member": "uint64",
5243
+ "name": "TotalCount",
5244
+ "output_required": true,
5245
+ "type": "int",
5246
+ "value_allowed_null": false
5247
+ },
5181
5248
  {
5182
5249
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
5183
5250
  "member": "string",
@@ -5220,17 +5287,17 @@
5220
5287
  "example": "2",
5221
5288
  "member": "int64",
5222
5289
  "name": "TotalCount",
5223
- "required": true,
5290
+ "output_required": true,
5224
5291
  "type": "int",
5225
5292
  "value_allowed_null": false
5226
5293
  },
5227
5294
  {
5228
5295
  "disabled": false,
5229
5296
  "document": "参数信息\n注意:此字段可能返回 null,表示取不到有效值。",
5230
- "example": "",
5297
+ "example": "[ { \"Advanced\": false, \"ClassificationCN\": \"AUTOVACUUM\", \"ClassificationEN\": \"Autovacuum\", \"CurrentValue\": \"\", \"DefaultValue\": \"-1\", \"EnumValue\": null, \"ID\": 1409, \"LastModifyTime\": \"\", \"Max\": 10000, \"Min\": -1, \"Name\": \"autovacuum_vacuum_cost_limit\", \"NeedReboot\": false, \"ParamDescriptionCH\": \"指定用于AUTOVACUUM操作中的代价限制值。如果指定-1(默认值),则使用vacuum_cost_limit值\", \"ParamDescriptionEN\": \"Vacuum cost amount available before napping, for autovacuum.\", \"ParamValueType\": \"integer\", \"SpecRelated\": false, \"StandbyRelated\": 0, \"Unit\": \"\" } ]",
5231
5298
  "member": "ParamInfo",
5232
5299
  "name": "ParamInfoSet",
5233
- "required": true,
5300
+ "output_required": true,
5234
5301
  "type": "list",
5235
5302
  "value_allowed_null": true
5236
5303
  },
@@ -5264,9 +5331,10 @@
5264
5331
  {
5265
5332
  "disabled": false,
5266
5333
  "document": "实例密钥信息列表。\n注意:此字段可能返回 null,表示取不到有效值。",
5267
- "example": "",
5334
+ "example": "[ { \"CreateTime\": \"2022-03-24 10:39:14\", \"DEKCipherTextBlob\": \"xxxxxxxxxxx\", \"IsEnabled\": 1, \"KeyAlias\": \"PGSQL-KMS\", \"KeyId\": \" f4d88aa7-ae72-11ec-9fcc-5254007ffd46\", \"KeyRegion\": \"ap-guangzhou\" } ]",
5268
5335
  "member": "EncryptionKey",
5269
5336
  "name": "EncryptionKeys",
5337
+ "output_required": true,
5270
5338
  "type": "list",
5271
5339
  "value_allowed_null": true
5272
5340
  },
@@ -5303,7 +5371,7 @@
5303
5371
  {
5304
5372
  "disabled": false,
5305
5373
  "document": "按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:\ndb-instance-id:按照实例ID过滤,类型为string。\ndb-instance-name:按照实例名过滤,类型为string。\ndb-instance-ip:按照实例私有网络IP地址过滤,类型为string。",
5306
- "example": "",
5374
+ "example": "[ { \"Values\": [ \"postgres-xxxxxxxx\" ], \"Name\": \"db-instance-id\" } ]",
5307
5375
  "member": "Filter",
5308
5376
  "name": "Filters",
5309
5377
  "required": false,
@@ -5357,15 +5425,17 @@
5357
5425
  "example": "10",
5358
5426
  "member": "uint64",
5359
5427
  "name": "TotalCount",
5428
+ "output_required": true,
5360
5429
  "type": "int",
5361
5430
  "value_allowed_null": false
5362
5431
  },
5363
5432
  {
5364
5433
  "disabled": false,
5365
5434
  "document": "日志备份详细信息列表。",
5366
- "example": "",
5435
+ "example": "[ { \"BackupMethod\": \"physical\", \"BackupMode\": \"automatic\", \"DBInstanceId\": \"postgres-jdlmoll9\", \"ExpireTime\": \"2023-02-22 21:10:52\", \"FinishTime\": \"2023-02-15 21:10:52\", \"Id\": \"2628bcde-ce13-554a-b47d-2b15187a02ec\", \"Name\": \"******.tar.gz\", \"Size\": 16783360, \"StartTime\": \"2023-02-15 21:10:52\", \"State\": \"finished\" } ]",
5367
5436
  "member": "LogBackup",
5368
5437
  "name": "LogBackupSet",
5438
+ "output_required": true,
5369
5439
  "type": "list",
5370
5440
  "value_allowed_null": false
5371
5441
  },
@@ -5402,15 +5472,17 @@
5402
5472
  "example": "1",
5403
5473
  "member": "int64",
5404
5474
  "name": "TotalCount",
5475
+ "output_required": true,
5405
5476
  "type": "int",
5406
5477
  "value_allowed_null": false
5407
5478
  },
5408
5479
  {
5409
5480
  "disabled": false,
5410
5481
  "document": "订单数组",
5411
- "example": "",
5482
+ "example": "[ { \"Count\": 1, \"OwnerUin\": \"909619400\", \"DBInstanceIdSet\": [ \"postgres-2uepfuz1\" ], \"PayMode\": 1, \"FlowId\": 36, \"DealName\": \"20180615110033\" } ]",
5412
5483
  "member": "PgDeal",
5413
5484
  "name": "Deals",
5485
+ "output_required": true,
5414
5486
  "type": "list",
5415
5487
  "value_allowed_null": false
5416
5488
  },
@@ -5447,7 +5519,7 @@
5447
5519
  "example": "423984bb-97fe-5693-a74f-63cc8dfb6c5d",
5448
5520
  "member": "string",
5449
5521
  "name": "TemplateId",
5450
- "required": true,
5522
+ "output_required": true,
5451
5523
  "type": "string",
5452
5524
  "value_allowed_null": true
5453
5525
  },
@@ -5457,17 +5529,17 @@
5457
5529
  "example": "1",
5458
5530
  "member": "int64",
5459
5531
  "name": "TotalCount",
5460
- "required": true,
5532
+ "output_required": true,
5461
5533
  "type": "int",
5462
5534
  "value_allowed_null": true
5463
5535
  },
5464
5536
  {
5465
5537
  "disabled": false,
5466
5538
  "document": "参数模板包含的参数信息\n注意:此字段可能返回 null,表示取不到有效值。",
5467
- "example": "",
5539
+ "example": "[ { \"Advanced\": false, \"ClassificationCN\": \"WAL\", \"ClassificationEN\": \"Write-Ahead Log\", \"CurrentValue\": \"logical\", \"DefaultValue\": \"replica\", \"EnumValue\": [ \"replica\", \"logical\" ], \"ID\": 854, \"LastModifyTime\": \"\", \"Max\": 0, \"Min\": 0, \"Name\": \"wal_level\", \"NeedReboot\": true, \"ParamDescriptionCH\": \"此参数决定记录到日志的信息,不允许设置为minimal\", \"ParamDescriptionEN\": \"Set the level of information written to the WAL.\", \"ParamValueType\": \"enum\", \"SpecRelated\": false, \"StandbyRelated\": 0, \"Unit\": \"\" } ]",
5468
5540
  "member": "ParamInfo",
5469
5541
  "name": "ParamInfoSet",
5470
- "required": true,
5542
+ "output_required": true,
5471
5543
  "type": "list",
5472
5544
  "value_allowed_null": true
5473
5545
  },
@@ -5477,7 +5549,7 @@
5477
5549
  "example": "test",
5478
5550
  "member": "string",
5479
5551
  "name": "TemplateName",
5480
- "required": true,
5552
+ "output_required": true,
5481
5553
  "type": "string",
5482
5554
  "value_allowed_null": true
5483
5555
  },
@@ -5487,7 +5559,7 @@
5487
5559
  "example": "13",
5488
5560
  "member": "string",
5489
5561
  "name": "DBMajorVersion",
5490
- "required": true,
5562
+ "output_required": true,
5491
5563
  "type": "string",
5492
5564
  "value_allowed_null": true
5493
5565
  },
@@ -5497,7 +5569,7 @@
5497
5569
  "example": "postgresql",
5498
5570
  "member": "string",
5499
5571
  "name": "DBEngine",
5500
- "required": true,
5572
+ "output_required": true,
5501
5573
  "type": "string",
5502
5574
  "value_allowed_null": true
5503
5575
  },
@@ -5507,7 +5579,7 @@
5507
5579
  "example": "use to test",
5508
5580
  "member": "string",
5509
5581
  "name": "TemplateDescription",
5510
- "required": true,
5582
+ "output_required": true,
5511
5583
  "type": "string",
5512
5584
  "value_allowed_null": true
5513
5585
  },
@@ -5526,7 +5598,7 @@
5526
5598
  {
5527
5599
  "disabled": false,
5528
5600
  "document": "过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine",
5529
- "example": "",
5601
+ "example": "[ { \"Values\": [ \"postgres-jdlmoll9\" ], \"Name\": \"db-instance-id\" } ]",
5530
5602
  "member": "Filter",
5531
5603
  "name": "Filters",
5532
5604
  "required": false,
@@ -5580,17 +5652,17 @@
5580
5652
  "example": "20",
5581
5653
  "member": "int64",
5582
5654
  "name": "TotalCount",
5583
- "required": true,
5655
+ "output_required": true,
5584
5656
  "type": "int",
5585
5657
  "value_allowed_null": false
5586
5658
  },
5587
5659
  {
5588
5660
  "disabled": false,
5589
5661
  "document": "参数模板列表",
5590
- "example": "",
5662
+ "example": "[ { \"DBEngine\": \"postgresql\", \"DBMajorVersion\": \"13\", \"TemplateDescription\": \"test1\", \"TemplateId\": \"674538e8-4a03-5103-896c-9785c960bf02\", \"TemplateName\": \"test1\" }, { \"DBEngine\": \"postgresql\", \"DBMajorVersion\": \"13\", \"TemplateDescription\": \"test2\", \"TemplateId\": \"423984bb-97fe-5693-a74f-63cc8dfb6c5d\", \"TemplateName\": \"test2\" } ]",
5591
5663
  "member": "ParameterTemplate",
5592
5664
  "name": "ParameterTemplateSet",
5593
- "required": true,
5665
+ "output_required": true,
5594
5666
  "type": "list",
5595
5667
  "value_allowed_null": false
5596
5668
  },
@@ -5627,15 +5699,17 @@
5627
5699
  "example": "1",
5628
5700
  "member": "int64",
5629
5701
  "name": "TotalCount",
5702
+ "output_required": true,
5630
5703
  "type": "int",
5631
5704
  "value_allowed_null": false
5632
5705
  },
5633
5706
  {
5634
5707
  "disabled": false,
5635
5708
  "document": "实例参数修改事件详情",
5636
- "example": "",
5709
+ "example": "[ { \"EventCount\": 1, \"EventDetail\": [ { \"EffectiveTime\": \"0001-01-01 00:00:00\", \"EventLog\": \"\", \"ModifyTime\": \"2021-08-11 21:51:12\", \"NewValue\": \"off\", \"OldValue\": \"on\", \"Operator\": \"100130115276\", \"ParamName\": \"array_nulls\", \"State\": \"success\" } ], \"ParamName\": \"array_nulls\" } ]",
5637
5710
  "member": "EventItem",
5638
5711
  "name": "EventItems",
5712
+ "output_required": true,
5639
5713
  "type": "list",
5640
5714
  "value_allowed_null": false
5641
5715
  },
@@ -5678,9 +5752,10 @@
5678
5752
  {
5679
5753
  "disabled": false,
5680
5754
  "document": "售卖规格列表。",
5681
- "example": "",
5755
+ "example": "[ { \"Region\": \"ap-guangzhou\", \"Zone\": \"ap-guangzhou-2\", \"SupportKMSRegions\": [ \"ap-guangzhou\" ], \"SpecItemInfoList\": [ { \"SpecCode\": \"pg.it.2xlarge16\", \"Version\": \"10.4\", \"VersionName\": \"PostgreSQL 10\", \"Cpu\": 1, \"Memory\": 2048, \"MaxStorage\": 1000, \"MinStorage\": 10, \"Qps\": 2100, \"Pid\": 11004, \"Type\": \"TS85\", \"KernelVersion\": \"v10.4_r1.0\", \"MajorVersion\": \"10\", \"IsSupportTDE\": 1 } ] } ]",
5682
5756
  "member": "SpecInfo",
5683
5757
  "name": "SpecInfoList",
5758
+ "output_required": true,
5684
5759
  "type": "list",
5685
5760
  "value_allowed_null": false
5686
5761
  },
@@ -5779,17 +5854,17 @@
5779
5854
  "example": "7",
5780
5855
  "member": "int64",
5781
5856
  "name": "TotalCount",
5782
- "required": true,
5857
+ "output_required": true,
5783
5858
  "type": "int",
5784
5859
  "value_allowed_null": false
5785
5860
  },
5786
5861
  {
5787
5862
  "disabled": false,
5788
5863
  "document": "地域信息集合。",
5789
- "example": "",
5864
+ "example": "[ { \"Region\": \"ap-guangzhou\", \"RegionName\": \"华南地区(广州)\", \"RegionId\": 1, \"SupportInternational\": 0, \"RegionState\": \"AVAILABLE\" }, { \"Region\": \"ap-chengdu\", \"RegionName\": \"西南地区(成都)\", \"RegionId\": 16, \"SupportInternational\": 0, \"RegionState\": \"AVAILABLE\" }, { \"Region\": \"na-siliconvalley\", \"RegionName\": \"美国西部(硅谷)\", \"RegionId\": 15, \"SupportInternational\": 1, \"RegionState\": \"AVAILABLE\" } ]",
5790
5865
  "member": "RegionInfo",
5791
5866
  "name": "RegionSet",
5792
- "required": true,
5867
+ "output_required": true,
5793
5868
  "type": "list",
5794
5869
  "value_allowed_null": false
5795
5870
  },
@@ -5807,8 +5882,8 @@
5807
5882
  "members": [
5808
5883
  {
5809
5884
  "disabled": false,
5810
- "document": "查询条件",
5811
- "example": "",
5885
+ "document": "查询条件。按照一个或者多个过滤条件进行查询,目前支持的过滤条件类型(name字段指定)有: \n\n- db-instance-id:按照实例ID过滤,类型为string\n- db-instance-name:按照实例名过滤,类型为string\n- db-tag-key:按照实例的tag过滤,类型为string\n\nvalue字段指定该类型过滤条件下具体要过滤的实例ID/实例名/实例tag-key。",
5886
+ "example": "[ { \"Values\": [ \"postgres-2uepfuz1\" ], \"Name\": \"db-instance-id\" } ]",
5812
5887
  "member": "Filter",
5813
5888
  "name": "Filter",
5814
5889
  "required": false,
@@ -5835,7 +5910,7 @@
5835
5910
  {
5836
5911
  "disabled": false,
5837
5912
  "document": "排序指标,目前支持实例创建时间CreateTime",
5838
- "example": "",
5913
+ "example": "CreateTime",
5839
5914
  "member": "string",
5840
5915
  "name": "OrderBy",
5841
5916
  "required": false,
@@ -5844,7 +5919,7 @@
5844
5919
  {
5845
5920
  "disabled": false,
5846
5921
  "document": "排序方式,包括升序、降序",
5847
- "example": "",
5922
+ "example": "desc",
5848
5923
  "member": "string",
5849
5924
  "name": "OrderByType",
5850
5925
  "required": false,
@@ -5862,17 +5937,17 @@
5862
5937
  "example": "1",
5863
5938
  "member": "int64",
5864
5939
  "name": "TotalCount",
5865
- "required": true,
5940
+ "output_required": true,
5866
5941
  "type": "int",
5867
5942
  "value_allowed_null": false
5868
5943
  },
5869
5944
  {
5870
5945
  "disabled": false,
5871
5946
  "document": "查询结果\n注意:此字段可能返回 null,表示取不到有效值。",
5872
- "example": "",
5947
+ "example": "[ { \"DBInstanceId\": \"postgres-xxxxxxxx\", \"DBInstanceName\": \"xxx\", \"DBInstanceStatus\": \"running\", \"Region\": \"ap-guangzhou\", \"Zone\": \"ap-guangzhou-3\", \"ProjectId\": 0, \"VpcId\": \"vpc-xxxxxxxx\", \"SubnetId\": \"subnet-xxxxxxxx\", \"DBCharset\": \"UTF8\", \"DBVersion\": \"10\", \"DBKernelVersion\": \"v10.4_r1.0\", \"CreateTime\": \"2020-03-20 12:19:14\", \"DBInstanceNetInfo\": [ { \"Address\": \"\", \"Ip\": \"10.10.10.111\", \"Port\": 5432, \"Status\": \"opened\", \"NetType\": \"private\" }, { \"Address\": \"\", \"Ip\": \"\", \"Port\": 0, \"Status\": \"initing\", \"NetType\": \"public\" } ], \"DBAccountSet\": [], \"DBDatabaseList\": null } ]",
5873
5948
  "member": "ServerlessDBInstance",
5874
5949
  "name": "DBInstanceSet",
5875
- "required": true,
5950
+ "output_required": true,
5876
5951
  "type": "list",
5877
5952
  "value_allowed_null": true
5878
5953
  },
@@ -5899,7 +5974,7 @@
5899
5974
  },
5900
5975
  {
5901
5976
  "disabled": false,
5902
- "document": "查询起始时间戳,格式 “YYYY-MM-DD HH:mm:ss” ,日志保留时间默认为7天,起始时间不能超出保留时间范围。",
5977
+ "document": "查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。",
5903
5978
  "example": "2020-02-01 01:02:03",
5904
5979
  "member": "string",
5905
5980
  "name": "StartTime",
@@ -5908,7 +5983,7 @@
5908
5983
  },
5909
5984
  {
5910
5985
  "disabled": false,
5911
- "document": "查询结束时间戳,格式 “YYYY-MM-DD HH:mm:ss”。",
5986
+ "document": "查询结束时间,形如2018-01-01 00:00:00。",
5912
5987
  "example": "2020-02-01 01:02:03",
5913
5988
  "member": "string",
5914
5989
  "name": "EndTime",
@@ -5917,7 +5992,7 @@
5917
5992
  },
5918
5993
  {
5919
5994
  "disabled": false,
5920
- "document": "根据数据库名进行筛选,可以为空。",
5995
+ "document": "数据库名字。\t",
5921
5996
  "example": "postgres",
5922
5997
  "member": "string",
5923
5998
  "name": "DatabaseName",
@@ -5926,7 +6001,7 @@
5926
6001
  },
5927
6002
  {
5928
6003
  "disabled": false,
5929
- "document": "排序维度。 可选参数,取值范围[CallNum,CostTime,AvgCostTime]。默认CallNum。",
6004
+ "document": "排序字段,取值范围[CallNum,CostTime,AvgCostTime]。默认值为CallNum。",
5930
6005
  "example": "CallNum",
5931
6006
  "member": "string",
5932
6007
  "name": "OrderBy",
@@ -5935,7 +6010,7 @@
5935
6010
  },
5936
6011
  {
5937
6012
  "disabled": false,
5938
- "document": "排序类型。升序asc、降序desc。默认desc。",
6013
+ "document": "排序方式,包括升序:asc 降序:desc。默认值为desc。",
5939
6014
  "example": "desc",
5940
6015
  "member": "string",
5941
6016
  "name": "OrderByType",
@@ -5944,7 +6019,7 @@
5944
6019
  },
5945
6020
  {
5946
6021
  "disabled": false,
5947
- "document": "分页大小。取值范围[1,100]。默认50",
6022
+ "document": "每页显示数量,取值范围为1-100。默认值为50。\t",
5948
6023
  "example": "20",
5949
6024
  "member": "int64",
5950
6025
  "name": "Limit",
@@ -5953,7 +6028,7 @@
5953
6028
  },
5954
6029
  {
5955
6030
  "disabled": false,
5956
- "document": "分页偏移。取值范围[0,INF)。默认0。",
6031
+ "document": "数据偏移量,从0开始。默认值为0。",
5957
6032
  "example": "0",
5958
6033
  "member": "int64",
5959
6034
  "name": "Offset",
@@ -5968,21 +6043,21 @@
5968
6043
  "members": [
5969
6044
  {
5970
6045
  "disabled": false,
5971
- "document": "查询总条数。",
6046
+ "document": "查询到的总条数,最大值为10000条。",
5972
6047
  "example": "5",
5973
6048
  "member": "int64",
5974
6049
  "name": "TotalCount",
5975
- "required": true,
6050
+ "output_required": true,
5976
6051
  "type": "int",
5977
6052
  "value_allowed_null": false
5978
6053
  },
5979
6054
  {
5980
6055
  "disabled": false,
5981
- "document": "SQL统计分析接口返回详情。",
5982
- "example": "",
6056
+ "document": "查询到的慢SQL统计分析详细信息集合。",
6057
+ "example": "[ { \"Advanced\": false, \"ClassificationCN\": \"连接和认证\", \"ClassificationEN\": \"Connections and Authentication\", \"CurrentValue\": \"2048\", \"DefaultValue\": \"2048\", \"EnumValue\": null, \"ID\": 15124, \"LastModifyTime\": \"\", \"Max\": 2048, \"Min\": 100, \"Name\": \"max_connections\", \"NeedReboot\": true, \"ParamDescriptionCH\": \"实例最大连接数\", \"ParamDescriptionEN\": \"Sets the maximum number of concurrent connections.\", \"ParamValueType\": \"integer\", \"SpecRelated\": true, \"SpecRelationSet\": null, \"StandbyRelated\": 0, \"Unit\": \"\", \"VersionRelationSet\": null } ]",
5983
6058
  "member": "Detail",
5984
6059
  "name": "Detail",
5985
- "required": true,
6060
+ "output_required": true,
5986
6061
  "type": "object",
5987
6062
  "value_allowed_null": false
5988
6063
  },
@@ -6009,7 +6084,7 @@
6009
6084
  },
6010
6085
  {
6011
6086
  "disabled": false,
6012
- "document": "查询起始时间戳,格式 “YYYY-MM-DD HH:mm:ss” ,日志保留时间默认为7天,起始时间不能超出保留时间范围。",
6087
+ "document": "查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。",
6013
6088
  "example": "2020-01-01 02:03:04",
6014
6089
  "member": "string",
6015
6090
  "name": "StartTime",
@@ -6018,7 +6093,7 @@
6018
6093
  },
6019
6094
  {
6020
6095
  "disabled": false,
6021
- "document": "查询结束时间戳,格式 “YYYY-MM-DD HH:mm:ss”。",
6096
+ "document": "查询结束时间,形如2018-01-01 00:00:00。\t",
6022
6097
  "example": "2020-01-01 02:03:04",
6023
6098
  "member": "string",
6024
6099
  "name": "EndTime",
@@ -6027,7 +6102,7 @@
6027
6102
  },
6028
6103
  {
6029
6104
  "disabled": false,
6030
- "document": "根据数据库名进行筛选,可以为空。",
6105
+ "document": "数据库名字。\t",
6031
6106
  "example": "postgres",
6032
6107
  "member": "string",
6033
6108
  "name": "DatabaseName",
@@ -6036,7 +6111,7 @@
6036
6111
  },
6037
6112
  {
6038
6113
  "disabled": false,
6039
- "document": "排序类型。升序asc、降序desc。默认为desc",
6114
+ "document": "排序方式,包括升序:asc 降序:desc。默认值为desc。\t",
6040
6115
  "example": "desc",
6041
6116
  "member": "string",
6042
6117
  "name": "OrderByType",
@@ -6045,7 +6120,7 @@
6045
6120
  },
6046
6121
  {
6047
6122
  "disabled": false,
6048
- "document": "排序维度。 可选参数,取值范围[SessionStartTime,Duration],默认为SessionStartTime。",
6123
+ "document": "排序字段,取值范围[SessionStartTime,Duration]。默认值为SessionStartTime。",
6049
6124
  "example": "SessionStartTime",
6050
6125
  "member": "string",
6051
6126
  "name": "OrderBy",
@@ -6054,7 +6129,7 @@
6054
6129
  },
6055
6130
  {
6056
6131
  "disabled": false,
6057
- "document": "分页大小。取值范围[1,100],默认为20。",
6132
+ "document": "每页显示数量,取值范围为1-100。默认值为50。\t",
6058
6133
  "example": "10",
6059
6134
  "member": "int64",
6060
6135
  "name": "Limit",
@@ -6063,7 +6138,7 @@
6063
6138
  },
6064
6139
  {
6065
6140
  "disabled": false,
6066
- "document": "分页偏移。取值范围[0,INF),默认为0",
6141
+ "document": "数据偏移量,从0开始。默认值为0。\t",
6067
6142
  "example": "0",
6068
6143
  "member": "int64",
6069
6144
  "name": "Offset",
@@ -6078,31 +6153,31 @@
6078
6153
  "members": [
6079
6154
  {
6080
6155
  "disabled": false,
6081
- "document": "选定时间范围内慢SQL总条数。",
6156
+ "document": "查询到的慢日志数量,最大值为10000条。\t",
6082
6157
  "example": "6",
6083
6158
  "member": "int64",
6084
6159
  "name": "TotalCount",
6085
- "required": true,
6160
+ "output_required": true,
6086
6161
  "type": "int",
6087
6162
  "value_allowed_null": false
6088
6163
  },
6089
6164
  {
6090
6165
  "disabled": false,
6091
- "document": "指定时间范围内,慢SQL耗时分段分析。\n注意:此字段可能返回 null,表示取不到有效值。",
6092
- "example": "",
6166
+ "document": "查询到的慢日志耗时分段分析结果。\n注意:此字段可能返回 null,表示取不到有效值。",
6167
+ "example": "[ { \"Count\": 0, \"TimeSegment\": \"10-20s\" }, { \"Count\": 0, \"TimeSegment\": \"40-50s\" } ]",
6093
6168
  "member": "DurationAnalysis",
6094
6169
  "name": "DurationAnalysis",
6095
- "required": true,
6170
+ "output_required": true,
6096
6171
  "type": "list",
6097
6172
  "value_allowed_null": true
6098
6173
  },
6099
6174
  {
6100
6175
  "disabled": false,
6101
- "document": "指定时间范围内 慢SQL流水。\n注意:此字段可能返回 null,表示取不到有效值。",
6102
- "example": "",
6176
+ "document": "查询到的慢日志详细信息集合。\n注意:此字段可能返回 null,表示取不到有效值。",
6177
+ "example": "[ { \"ClientAddr\": \"[local]\", \"DatabaseName\": \"postgres\", \"Duration\": 101.013, \"RawQuery\": \"select 1 from information_schema.tables where table_schema = 'pg_catalog' and table_name = 'pg_file_settings'\", \"SessionStartTime\": \"2021-07-27 03:12:01 CST\", \"UserName\": \"postgres\" }, { \"ClientAddr\": \"::1:34301\", \"DatabaseName\": \"postgres\", \"Duration\": 155.283, \"RawQuery\": \"select count(*)::text as value from pg_stat_activity where now()-backend_start < '5 second';\", \"SessionStartTime\": \"2021-07-25 02:25:09 CST\", \"UserName\": \"postgres\" } ]",
6103
6178
  "member": "RawSlowQuery",
6104
6179
  "name": "RawSlowQueryList",
6105
- "required": true,
6180
+ "output_required": true,
6106
6181
  "type": "list",
6107
6182
  "value_allowed_null": true
6108
6183
  },
@@ -6129,17 +6204,17 @@
6129
6204
  "example": "3",
6130
6205
  "member": "int64",
6131
6206
  "name": "TotalCount",
6132
- "required": true,
6207
+ "output_required": true,
6133
6208
  "type": "int",
6134
6209
  "value_allowed_null": false
6135
6210
  },
6136
6211
  {
6137
6212
  "disabled": false,
6138
6213
  "document": "可用区信息集合。",
6139
- "example": "",
6214
+ "example": "[ { \"Zone\": \"ap-guangzhou-2\", \"ZoneName\": \"广州二区\", \"ZoneId\": 100002, \"ZoneState\": \"AVAILABLE\", \"ZoneSupportIpv6\": 0, \"StandbyZoneSet\": [ \"ap-guangzhou-2\", \"ap-guangzhou-3\" ] }, { \"Zone\": \"ap-guangzhou-3\", \"ZoneName\": \"广州三区\", \"ZoneId\": 100003, \"ZoneState\": \"AVAILABLE\", \"ZoneSupportIpv6\": 0, \"StandbyZoneSet\": [ \"ap-guangzhou-2\", \"ap-guangzhou-3\" ] } ]",
6140
6215
  "member": "ZoneInfo",
6141
6216
  "name": "ZoneSet",
6142
- "required": true,
6217
+ "output_required": true,
6143
6218
  "type": "list",
6144
6219
  "value_allowed_null": false
6145
6220
  },
@@ -6188,7 +6263,7 @@
6188
6263
  "example": "0.1",
6189
6264
  "member": "float",
6190
6265
  "name": "TotalTime",
6191
- "required": true,
6266
+ "output_required": true,
6192
6267
  "type": "float",
6193
6268
  "value_allowed_null": false
6194
6269
  },
@@ -6198,17 +6273,17 @@
6198
6273
  "example": "0",
6199
6274
  "member": "uint64",
6200
6275
  "name": "TotalCallNum",
6201
- "required": true,
6276
+ "output_required": true,
6202
6277
  "type": "int",
6203
6278
  "value_allowed_null": false
6204
6279
  },
6205
6280
  {
6206
6281
  "disabled": false,
6207
6282
  "document": "慢SQL统计分析列表\n注意:此字段可能返回 null,表示取不到有效值。",
6208
- "example": "",
6283
+ "example": "[ { \"AvgCostTime\": 101.01300048828125, \"ClientAddr\": \"\", \"CostPercent\": 11.703700311890035, \"CostTime\": 101.01300048828125, \"DatabaseName\": \"postgres\", \"FirstTime\": \"2021-07-27 03:12:01\", \"LastTime\": \"2021-07-27 03:12:01\", \"MaxCostTime\": 101.01300048828125, \"MinCostTime\": 101.01300048828125, \"NormalQuery\": \"select $1 from information_schema.tables where table_schema = $2 and table_name = $3\", \"UserName\": \"postgres\" } ]",
6209
6284
  "member": "AnalysisItems",
6210
6285
  "name": "AnalysisItems",
6211
- "required": true,
6286
+ "output_required": true,
6212
6287
  "type": "list",
6213
6288
  "value_allowed_null": true
6214
6289
  }
@@ -7094,7 +7169,7 @@
7094
7169
  {
7095
7170
  "disabled": false,
7096
7171
  "document": "vpc限制效力,ALLOW 允许;DENY 拒绝。",
7097
- "example": "",
7172
+ "example": "ALLOW",
7098
7173
  "member": "string",
7099
7174
  "name": "VpcRestrictionEffect",
7100
7175
  "required": false,
@@ -7103,7 +7178,7 @@
7103
7178
  {
7104
7179
  "disabled": false,
7105
7180
  "document": "允许或拒绝下载备份文件的vpcId列表。",
7106
- "example": "",
7181
+ "example": "[ \"vpc-15ld6dhr\" ]",
7107
7182
  "member": "string",
7108
7183
  "name": "VpcIdSet",
7109
7184
  "required": false,
@@ -7112,7 +7187,7 @@
7112
7187
  {
7113
7188
  "disabled": false,
7114
7189
  "document": "ip限制效力,ALLOW 允许;DENY 拒绝。",
7115
- "example": "",
7190
+ "example": "ALLOW",
7116
7191
  "member": "string",
7117
7192
  "name": "IpRestrictionEffect",
7118
7193
  "required": false,
@@ -7121,7 +7196,7 @@
7121
7196
  {
7122
7197
  "disabled": false,
7123
7198
  "document": "允许或拒绝下载备份文件的ip列表。",
7124
- "example": "",
7199
+ "example": "[ \"10.10.10.220\" ]",
7125
7200
  "member": "string",
7126
7201
  "name": "IpSet",
7127
7202
  "required": false,
@@ -7347,7 +7422,7 @@
7347
7422
  {
7348
7423
  "disabled": false,
7349
7424
  "document": "实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。\n可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。",
7350
- "example": "",
7425
+ "example": "[ { \"Zone\": \"ap-guangzhou-6\", \"ZoneName\": \"广州六区\", \"ZoneId\": 100006, \"ZoneState\": \"AVAILABLE\", \"ZoneSupportIpv6\": 0, \"StandbyZoneSet\": [ \"ap-guangzhou-6\", \"ap-guangzhou-7\" ] } ]",
7351
7426
  "member": "DBNode",
7352
7427
  "name": "DBNodeSet",
7353
7428
  "required": true,
@@ -7355,7 +7430,7 @@
7355
7430
  },
7356
7431
  {
7357
7432
  "disabled": false,
7358
- "document": "指定实例配置完成变更后的切换时间。\n<li>0:立即切换 \n<li>1:指定时间切换\n<li>2:维护时间窗口内切换\n默认值:0 ",
7433
+ "document": "指定实例配置完成变更后的切换时间。\n<li>0:立即切换 </li>\n<li>1:指定时间切换</li>\n<li>2:维护时间窗口内切换</li>\n默认值:0 ",
7359
7434
  "example": "1",
7360
7435
  "member": "int64",
7361
7436
  "name": "SwitchTag",
@@ -7508,8 +7583,8 @@
7508
7583
  "members": [
7509
7584
  {
7510
7585
  "disabled": false,
7511
- "document": "实例ID",
7512
- "example": "postgres-xx",
7586
+ "document": "实例ID",
7587
+ "example": "postgres-q12ghoq1",
7513
7588
  "member": "string",
7514
7589
  "name": "DBInstanceId",
7515
7590
  "required": true,
@@ -7517,8 +7592,8 @@
7517
7592
  },
7518
7593
  {
7519
7594
  "disabled": false,
7520
- "document": "待修改参数及期望值",
7521
- "example": "",
7595
+ "document": "待修改参数及期望值。",
7596
+ "example": "[ { \"Name\": \"max_replication_slots\", \"ExpectedValue\": \"20\" } ]",
7522
7597
  "member": "ParamEntry",
7523
7598
  "name": "ParamList",
7524
7599
  "required": true,
@@ -7681,7 +7756,7 @@
7681
7756
  {
7682
7757
  "disabled": false,
7683
7758
  "document": "代金券ID列表,目前仅支持指定一张代金券。",
7684
- "example": "",
7759
+ "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]",
7685
7760
  "member": "string",
7686
7761
  "name": "VoucherIds",
7687
7762
  "required": false,
@@ -7845,7 +7920,7 @@
7845
7920
  {
7846
7921
  "disabled": false,
7847
7922
  "document": "需要修改或添加的参数集合,注:同一参数不能同时出现在修改添加集合和删除集合中",
7848
- "example": "",
7923
+ "example": "[ { \"Name\": \"max_wal_senders\", \"ExpectedValue\": \"360\" }, { \"Name\": \"max_logical_replication_workers\", \"ExpectedValue\": \"360\" } ]",
7849
7924
  "member": "ParamEntry",
7850
7925
  "name": "ModifyParamEntrySet",
7851
7926
  "required": false,
@@ -8536,7 +8611,7 @@
8536
8611
  {
8537
8612
  "disabled": false,
8538
8613
  "document": "参数版本关联信息,内容为相应内核版本下的参数详细信息\n注意:此字段可能返回 null,表示取不到有效值。",
8539
- "example": "",
8614
+ "example": "null",
8540
8615
  "member": "ParamVersionRelation",
8541
8616
  "name": "VersionRelationSet",
8542
8617
  "output_required": true,
@@ -8546,7 +8621,7 @@
8546
8621
  {
8547
8622
  "disabled": false,
8548
8623
  "document": "参数规格关联信息,内容为相应规格下的参数详细信息\n注意:此字段可能返回 null,表示取不到有效值。",
8549
- "example": "",
8624
+ "example": "null",
8550
8625
  "member": "ParamSpecRelation",
8551
8626
  "name": "SpecRelationSet",
8552
8627
  "output_required": true,
@@ -9413,6 +9488,60 @@
9413
9488
  ],
9414
9489
  "type": "object"
9415
9490
  },
9491
+ "RestoreDBInstanceObjectsRequest": {
9492
+ "document": "RestoreDBInstanceObjects请求参数结构体",
9493
+ "members": [
9494
+ {
9495
+ "disabled": false,
9496
+ "document": "实例ID。",
9497
+ "example": "postgres-abcd1234",
9498
+ "member": "string",
9499
+ "name": "DBInstanceId",
9500
+ "required": true,
9501
+ "type": "string"
9502
+ },
9503
+ {
9504
+ "disabled": false,
9505
+ "document": "需要恢复的对象列表。假设需要恢复的对象名为test,则恢复后的名称为test_bak_${LinuxTime}。${LinuxTime}无法指定,由系统根据任务发起的linux时间设定。",
9506
+ "example": "[\"test\"]",
9507
+ "member": "string",
9508
+ "name": "RestoreObjects",
9509
+ "required": true,
9510
+ "type": "list"
9511
+ },
9512
+ {
9513
+ "disabled": false,
9514
+ "document": "恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。",
9515
+ "example": "db468966-a8d8-5831-8596-763a7833e380",
9516
+ "member": "string",
9517
+ "name": "BackupSetId",
9518
+ "required": false,
9519
+ "type": "string"
9520
+ },
9521
+ {
9522
+ "disabled": false,
9523
+ "document": "恢复目标时间,北京时间。BackupSetId与RestoreTargetTime有且只能传一个。",
9524
+ "example": "2024-04-30 00:20:27",
9525
+ "member": "string",
9526
+ "name": "RestoreTargetTime",
9527
+ "required": false,
9528
+ "type": "string"
9529
+ }
9530
+ ],
9531
+ "type": "object"
9532
+ },
9533
+ "RestoreDBInstanceObjectsResponse": {
9534
+ "document": "RestoreDBInstanceObjects返回参数结构体",
9535
+ "members": [
9536
+ {
9537
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
9538
+ "member": "string",
9539
+ "name": "RequestId",
9540
+ "type": "string"
9541
+ }
9542
+ ],
9543
+ "type": "object"
9544
+ },
9416
9545
  "SecurityGroup": {
9417
9546
  "document": "安全组信息",
9418
9547
  "members": [
@@ -9422,7 +9551,7 @@
9422
9551
  "example": "0",
9423
9552
  "member": "int64",
9424
9553
  "name": "ProjectId",
9425
- "required": true,
9554
+ "output_required": true,
9426
9555
  "type": "int",
9427
9556
  "value_allowed_null": false
9428
9557
  },
@@ -9432,27 +9561,27 @@
9432
9561
  "example": "2022-10-20 21:38:20",
9433
9562
  "member": "string",
9434
9563
  "name": "CreateTime",
9435
- "required": true,
9564
+ "output_required": true,
9436
9565
  "type": "string",
9437
9566
  "value_allowed_null": false
9438
9567
  },
9439
9568
  {
9440
9569
  "disabled": false,
9441
9570
  "document": "入站规则",
9442
- "example": "",
9571
+ "example": "[ { \"Action\": \"ACCEPT\", \"CidrIp\": \"0.0.0.0/0\", \"Description\": \"放通Ping服务\", \"IpProtocol\": \"icmp\", \"PortRange\": \"ALL\" }, { \"Action\": \"ACCEPT\", \"CidrIp\": \"::/0\", \"Description\": \"放通Ping服务\", \"IpProtocol\": \"icmpv6\", \"PortRange\": \"ALL\" } ]",
9443
9572
  "member": "PolicyRule",
9444
9573
  "name": "Inbound",
9445
- "required": true,
9574
+ "output_required": true,
9446
9575
  "type": "list",
9447
9576
  "value_allowed_null": false
9448
9577
  },
9449
9578
  {
9450
9579
  "disabled": false,
9451
9580
  "document": "出站规则",
9452
- "example": "",
9581
+ "example": "[ { \"Action\": \"ACCEPT\", \"CidrIp\": \"0.0.0.0/0\", \"Description\": \"\", \"IpProtocol\": \"ALL\", \"PortRange\": \"ALL\" }, { \"Action\": \"ACCEPT\", \"CidrIp\": \"\", \"Description\": \"\", \"IpProtocol\": \"ALL\", \"PortRange\": \"ALL\" } ]",
9453
9582
  "member": "PolicyRule",
9454
9583
  "name": "Outbound",
9455
- "required": true,
9584
+ "output_required": true,
9456
9585
  "type": "list",
9457
9586
  "value_allowed_null": false
9458
9587
  },
@@ -9462,7 +9591,7 @@
9462
9591
  "example": "sg-mpkb1net",
9463
9592
  "member": "string",
9464
9593
  "name": "SecurityGroupId",
9465
- "required": true,
9594
+ "output_required": true,
9466
9595
  "type": "string",
9467
9596
  "value_allowed_null": false
9468
9597
  },
@@ -9472,7 +9601,7 @@
9472
9601
  "example": "securitygroup",
9473
9602
  "member": "string",
9474
9603
  "name": "SecurityGroupName",
9475
- "required": true,
9604
+ "output_required": true,
9476
9605
  "type": "string",
9477
9606
  "value_allowed_null": false
9478
9607
  },
@@ -9482,7 +9611,7 @@
9482
9611
  "example": "安全组",
9483
9612
  "member": "string",
9484
9613
  "name": "SecurityGroupDescription",
9485
- "required": true,
9614
+ "output_required": true,
9486
9615
  "type": "string",
9487
9616
  "value_allowed_null": false
9488
9617
  }
@@ -10197,7 +10326,7 @@
10197
10326
  {
10198
10327
  "disabled": false,
10199
10328
  "document": "目标内核版本号,可以通过API DescribeDBVersions获取可以升级的目标内核版本号。",
10200
- "example": "",
10329
+ "example": "v15.1_r1.6",
10201
10330
  "member": "string",
10202
10331
  "name": "TargetDBKernelVersion",
10203
10332
  "required": true,
@@ -10206,7 +10335,7 @@
10206
10335
  {
10207
10336
  "disabled": false,
10208
10337
  "document": "是否为校验模式,若UpgradeCheck为True,表示仅进行内核版本兼容性检查,不会进行实质性的升级操作,对原实例无影响。检查结果可以通过升级日志查看。",
10209
- "example": "",
10338
+ "example": "FALSE",
10210
10339
  "member": "bool",
10211
10340
  "name": "UpgradeCheck",
10212
10341
  "required": false,
@@ -10215,7 +10344,7 @@
10215
10344
  {
10216
10345
  "disabled": false,
10217
10346
  "document": "升级前备份选项。True,表示升级前需要创建全量备份,False,表示升级前不需要创建全量备份。当实例已有备份集可以恢复到升级前的状态时,可选择False,否则需要指定为True。UpgradeCheck为True时,此参数无效。",
10218
- "example": "",
10347
+ "example": "TRUE",
10219
10348
  "member": "bool",
10220
10349
  "name": "BackupBeforeUpgrade",
10221
10350
  "required": false,
@@ -10224,7 +10353,7 @@
10224
10353
  {
10225
10354
  "disabled": false,
10226
10355
  "document": "统计信息收集选项,对主例运行 ANALYZE 以在升级后更新系统统计信息。可选值包括,\n0:不需要收集统计信息;\n1:实例恢复写之前收集统计信息;\n3:实例恢复写之后收集统计信息。\nUpgradeCheck为True时,此参数无效。",
10227
- "example": "",
10356
+ "example": "0",
10228
10357
  "member": "int64",
10229
10358
  "name": "StatisticsRefreshOption",
10230
10359
  "required": false,
@@ -10233,7 +10362,7 @@
10233
10362
  {
10234
10363
  "disabled": false,
10235
10364
  "document": "插件升级选项,pg_upgrade不会升级任何插件,需要在升级完成后在创建过插件的库上执行\"ALTER EXTENSION UPDATE\"。发起升级实例大版本时可以指定在实例恢复写前/后是否需要升级任务自动升级插件版本。可选值包括:\n0:不需要自动升级插件;\n1:恢复写之前升级插件;\n2:恢复写之后升级插件。\nUpgradeCheck为True时,此参数无效。",
10236
- "example": "",
10365
+ "example": "0",
10237
10366
  "member": "int64",
10238
10367
  "name": "ExtensionUpgradeOption",
10239
10368
  "required": false,
@@ -10242,7 +10371,7 @@
10242
10371
  {
10243
10372
  "disabled": false,
10244
10373
  "document": "升级时间选项,升级过程中会有一段时间实例只读,并会有一次秒级闪断,发起升级时需要选择这段影响的时间窗。可选值包括:\n0:自动执行,不需要指定时间窗;\n1:指定本次升级任务的时间窗,通过参数UpgradeTimeBegin和UpgradeTimeEnd设置;\n2:在实例运维时间窗内执行。\nUpgradeCheck为True时,此参数无效。",
10245
- "example": "",
10374
+ "example": "1",
10246
10375
  "member": "int64",
10247
10376
  "name": "UpgradeTimeOption",
10248
10377
  "required": false,
@@ -10251,7 +10380,7 @@
10251
10380
  {
10252
10381
  "disabled": false,
10253
10382
  "document": "升级时间窗开始时间,时间格式:HH:MM:SS,例如:01:00:00。当UpgradeTimeOption为1时,该参数有效。\nUpgradeCheck为True时,此参数无效。",
10254
- "example": "",
10383
+ "example": "01:00:00",
10255
10384
  "member": "string",
10256
10385
  "name": "UpgradeTimeBegin",
10257
10386
  "required": false,
@@ -10260,7 +10389,7 @@
10260
10389
  {
10261
10390
  "disabled": false,
10262
10391
  "document": "升级时间窗截止时间,时间格式:HH:MM:SS,例如:02:00:00。当UpgradeTimeOption为1时,该参数有效。\nUpgradeCheck为True时,此参数无效。",
10263
- "example": "",
10392
+ "example": "02:00:00",
10264
10393
  "member": "string",
10265
10394
  "name": "UpgradeTimeEnd",
10266
10395
  "required": false,
@@ -10323,7 +10452,7 @@
10323
10452
  {
10324
10453
  "disabled": false,
10325
10454
  "document": "代金券ID列表,目前仅支持指定一张代金券",
10326
- "example": "",
10455
+ "example": "[ \"OZRCGNAV8D9BMI9KMG1FIQ\" ]",
10327
10456
  "member": "string",
10328
10457
  "name": "VoucherIds",
10329
10458
  "required": false,
@@ -10332,7 +10461,7 @@
10332
10461
  {
10333
10462
  "disabled": false,
10334
10463
  "document": "活动ID",
10335
- "example": "",
10464
+ "example": "123",
10336
10465
  "member": "int64",
10337
10466
  "name": "ActivityId",
10338
10467
  "required": false,
@@ -10377,6 +10506,7 @@
10377
10506
  "example": "201806127634",
10378
10507
  "member": "string",
10379
10508
  "name": "DealName",
10509
+ "output_required": true,
10380
10510
  "type": "string",
10381
10511
  "value_allowed_null": false
10382
10512
  },
@@ -10386,6 +10516,7 @@
10386
10516
  "example": "123",
10387
10517
  "member": "string",
10388
10518
  "name": "BillId",
10519
+ "output_required": true,
10389
10520
  "type": "string",
10390
10521
  "value_allowed_null": false
10391
10522
  },
@@ -10407,7 +10538,7 @@
10407
10538
  "example": "postgresql",
10408
10539
  "member": "string",
10409
10540
  "name": "DBEngine",
10410
- "required": true,
10541
+ "output_required": true,
10411
10542
  "type": "string",
10412
10543
  "value_allowed_null": false
10413
10544
  },
@@ -10417,7 +10548,7 @@
10417
10548
  "example": "12.4",
10418
10549
  "member": "string",
10419
10550
  "name": "DBVersion",
10420
- "required": true,
10551
+ "output_required": true,
10421
10552
  "type": "string",
10422
10553
  "value_allowed_null": false
10423
10554
  },
@@ -10427,7 +10558,7 @@
10427
10558
  "example": "12",
10428
10559
  "member": "string",
10429
10560
  "name": "DBMajorVersion",
10430
- "required": true,
10561
+ "output_required": true,
10431
10562
  "type": "string",
10432
10563
  "value_allowed_null": false
10433
10564
  },
@@ -10437,7 +10568,7 @@
10437
10568
  "example": "v12.4_r1.3",
10438
10569
  "member": "string",
10439
10570
  "name": "DBKernelVersion",
10440
- "required": true,
10571
+ "output_required": true,
10441
10572
  "type": "string",
10442
10573
  "value_allowed_null": false
10443
10574
  },
@@ -10447,7 +10578,7 @@
10447
10578
  "example": "[\"TDE\"]",
10448
10579
  "member": "string",
10449
10580
  "name": "SupportedFeatureNames",
10450
- "required": true,
10581
+ "output_required": true,
10451
10582
  "type": "list",
10452
10583
  "value_allowed_null": false
10453
10584
  },
@@ -10457,17 +10588,17 @@
10457
10588
  "example": "AVAILABLE",
10458
10589
  "member": "string",
10459
10590
  "name": "Status",
10460
- "required": true,
10591
+ "output_required": true,
10461
10592
  "type": "string",
10462
10593
  "value_allowed_null": false
10463
10594
  },
10464
10595
  {
10465
10596
  "disabled": false,
10466
- "document": "该数据库版本(DBKernelVersion)可以升级到的版本号列表。",
10597
+ "document": "该数据库版本(DBKernelVersion)可以升级到的版本号列表。其中包含可升级的小版本号和可升级的大版本号(完整内核版本格式示例:v15.1_v1.6)。",
10467
10598
  "example": "[\"v12.4_r1.4\"]",
10468
10599
  "member": "string",
10469
10600
  "name": "AvailableUpgradeTarget",
10470
- "required": true,
10601
+ "output_required": true,
10471
10602
  "type": "list",
10472
10603
  "value_allowed_null": false
10473
10604
  }