tccli-intl-en 3.1.13.1__py2.py3-none-any.whl → 3.1.14.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -365,7 +365,7 @@
365
365
  "status": "online"
366
366
  },
367
367
  "DescribeDBInstances": {
368
- "document": "This API (DescribeDBInstances) is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances). It supports filtering instances by project ID, instance ID, access address, and instance status.",
368
+ "document": "This API is used to query the list of TencentDB for MySQL instances. It supports filtering instances by conditions such as project ID, instance ID, access address, and instance status. It also supports querying the list of information about primary instances, disaster recovery instances, and read-only instances.\nThis API is used to return the availability zone (AZ) status during purchase, which does not change along with the proactive HA switch. If you want to know the AZ status in real time, query through the [DescribeDBInstanceConfig](https://www.tencentcloud.comom/document/product/236/17491?from_cn_redirect=1) API.",
369
369
  "input": "DescribeDBInstancesRequest",
370
370
  "name": "Queries the list of instances",
371
371
  "output": "DescribeDBInstancesResponse",
@@ -1404,6 +1404,92 @@
1404
1404
  ],
1405
1405
  "usage": "in"
1406
1406
  },
1407
+ "AnalysisNodeInfo": {
1408
+ "document": "Analysis engine node information.",
1409
+ "members": [
1410
+ {
1411
+ "disabled": false,
1412
+ "document": "Node ID.",
1413
+ "example": "libradbn-0",
1414
+ "member": "string",
1415
+ "name": "NodeId",
1416
+ "output_required": true,
1417
+ "type": "string",
1418
+ "value_allowed_null": false
1419
+ },
1420
+ {
1421
+ "disabled": false,
1422
+ "document": "Node status.",
1423
+ "example": "例如:\"applying\"、\"normal\"、\"deleting\"",
1424
+ "member": "string",
1425
+ "name": "Status",
1426
+ "output_required": false,
1427
+ "type": "string",
1428
+ "value_allowed_null": false
1429
+ },
1430
+ {
1431
+ "disabled": false,
1432
+ "document": "Data loading status.",
1433
+ "example": "例如:\"Created\"、\"Running\"、\"Paused\"、\"Stopped\"、\"Removed\"、\"Error\"",
1434
+ "member": "string",
1435
+ "name": "DataStatus",
1436
+ "output_required": false,
1437
+ "type": "string",
1438
+ "value_allowed_null": false
1439
+ },
1440
+ {
1441
+ "disabled": false,
1442
+ "document": "Number of CPU cores, in cores.",
1443
+ "example": "4",
1444
+ "member": "uint64",
1445
+ "name": "Cpu",
1446
+ "output_required": false,
1447
+ "type": "int",
1448
+ "value_allowed_null": false
1449
+ },
1450
+ {
1451
+ "disabled": false,
1452
+ "document": "Memory size, in MB.",
1453
+ "example": "16",
1454
+ "member": "uint64",
1455
+ "name": "Memory",
1456
+ "output_required": false,
1457
+ "type": "int",
1458
+ "value_allowed_null": false
1459
+ },
1460
+ {
1461
+ "disabled": false,
1462
+ "document": "Disk size, in GB.",
1463
+ "example": "100",
1464
+ "member": "uint64",
1465
+ "name": "Storage",
1466
+ "output_required": false,
1467
+ "type": "int",
1468
+ "value_allowed_null": false
1469
+ },
1470
+ {
1471
+ "disabled": false,
1472
+ "document": "Node AZ.",
1473
+ "example": "ap-guangzhou-7",
1474
+ "member": "string",
1475
+ "name": "Zone",
1476
+ "output_required": false,
1477
+ "type": "string",
1478
+ "value_allowed_null": false
1479
+ },
1480
+ {
1481
+ "disabled": false,
1482
+ "document": "Data synchronization error message.",
1483
+ "example": "Paused by Command",
1484
+ "member": "string",
1485
+ "name": "Message",
1486
+ "output_required": false,
1487
+ "type": "string",
1488
+ "value_allowed_null": false
1489
+ }
1490
+ ],
1491
+ "usage": "out"
1492
+ },
1407
1493
  "AnalyzeAuditLogsRequest": {
1408
1494
  "document": "AnalyzeAuditLogs request structure.",
1409
1495
  "members": [
@@ -3518,6 +3604,45 @@
3518
3604
  ],
3519
3605
  "type": "object"
3520
3606
  },
3607
+ "ClusterInfo": {
3608
+ "document": "Cluster Edition node information.",
3609
+ "members": [
3610
+ {
3611
+ "disabled": false,
3612
+ "document": "Node ID.",
3613
+ "example": "\"dbn-ipffzoum\"",
3614
+ "member": "string",
3615
+ "name": "NodeId",
3616
+ "output_required": false,
3617
+ "required": false,
3618
+ "type": "string",
3619
+ "value_allowed_null": false
3620
+ },
3621
+ {
3622
+ "disabled": false,
3623
+ "document": "Node type: primary node and secondary node.",
3624
+ "example": "\"master\"",
3625
+ "member": "string",
3626
+ "name": "Role",
3627
+ "output_required": false,
3628
+ "required": false,
3629
+ "type": "string",
3630
+ "value_allowed_null": false
3631
+ },
3632
+ {
3633
+ "disabled": false,
3634
+ "document": "Region.",
3635
+ "example": "\"ap-guangzhou\"",
3636
+ "member": "string",
3637
+ "name": "Zone",
3638
+ "output_required": false,
3639
+ "required": false,
3640
+ "type": "string",
3641
+ "value_allowed_null": false
3642
+ }
3643
+ ],
3644
+ "usage": "both"
3645
+ },
3521
3646
  "ColumnPrivilege": {
3522
3647
  "document": "Column permission information",
3523
3648
  "members": [
@@ -7744,7 +7869,7 @@
7744
7869
  {
7745
7870
  "disabled": false,
7746
7871
  "document": "Instance type. Value range: 1 (primary), 2 (disaster recovery), 3 (read-only).",
7747
- "example": "1",
7872
+ "example": "[1]",
7748
7873
  "member": "uint64",
7749
7874
  "name": "InstanceTypes",
7750
7875
  "required": false,
@@ -7753,7 +7878,7 @@
7753
7878
  {
7754
7879
  "disabled": false,
7755
7880
  "document": "Private IP address of the instance.",
7756
- "example": "\"\"",
7881
+ "example": "[\"172.1.1.1\"]",
7757
7882
  "member": "string",
7758
7883
  "name": "Vips",
7759
7884
  "required": false,
@@ -7762,7 +7887,7 @@
7762
7887
  {
7763
7888
  "disabled": false,
7764
7889
  "document": "Instance status. Valid values: <br>`0` (creating) <br>`1` (running) <br>`4` (isolating) <br>`5` (isolated; the instance can be restored and started in the recycle bin)",
7765
- "example": "1",
7890
+ "example": "[1]",
7766
7891
  "member": "uint64",
7767
7892
  "name": "Status",
7768
7893
  "required": false,
@@ -7789,7 +7914,7 @@
7789
7914
  {
7790
7915
  "disabled": false,
7791
7916
  "document": "Security group ID. When it is used as a filter, the `WithSecurityGroup` parameter should be set to 1.",
7792
- "example": "\"\"",
7917
+ "example": "sg-ajr1jzgj",
7793
7918
  "member": "string",
7794
7919
  "name": "SecurityGroupId",
7795
7920
  "required": false,
@@ -7797,8 +7922,8 @@
7797
7922
  },
7798
7923
  {
7799
7924
  "disabled": false,
7800
- "document": "Billing method. Value range: 0 (monthly subscribed), 1 (hourly).",
7801
- "example": "1",
7925
+ "document": "Payment type. Valid values: 0 - yearly/monthly subscription; 1 - bill by hour.",
7926
+ "example": "[1]",
7802
7927
  "member": "uint64",
7803
7928
  "name": "PayTypes",
7804
7929
  "required": false,
@@ -7807,7 +7932,7 @@
7807
7932
  {
7808
7933
  "disabled": false,
7809
7934
  "document": "Instance name.",
7810
- "example": "\"\"",
7935
+ "example": "[\"cdb27418\"]",
7811
7936
  "member": "string",
7812
7937
  "name": "InstanceNames",
7813
7938
  "required": false,
@@ -7815,8 +7940,8 @@
7815
7940
  },
7816
7941
  {
7817
7942
  "disabled": false,
7818
- "document": "Instance task status. Valid values: <br>0 - no task <br>1 - upgrading <br>2 - importing data <br>3 - enabling secondary instance access <br>4 - enabling public network access <br>5 - batch operation in progress <br>6 - rolling back <br>7 - disabling public network access <br>8 - modifying password <br>9 - renaming instance <br>10 - restarting <br>12 - migrating self-built database <br>13 - dropping tables <br>14 - Disaster recovery instance creating sync task <br>15 - waiting for switch <br>16 - switching <br>17 - upgrade and switch completed <br>19 - parameter settings to be executed",
7819
- "example": "0",
7943
+ "document": "Instance task status. Valid values:<br>0 - no task;<br>1 - upgrading;<br>2 - importing data;<br>3 - enabling secondary nodes;<br>4 - enabling public network access;<br>5 - executing batch operations;<br>6 - rolling back;<br>7 - disabling public network access;<br>8 - changing the password;<br>9 - renaming the instance;<br>10 - restarting;<br>12 - migrating self-built databases;<br>13 - deleting databases and tables;<br>14 - synchronizing the creation of disaster recovery instances;<br>15 - pending upgrade switch;<br>16 - under upgrade switch;<br>17 - upgrade switch completed;<br>19 - parameter settings pending execution;<br>34 - in-place upgrade pending execution.",
7944
+ "example": "[0]",
7820
7945
  "member": "uint64",
7821
7946
  "name": "TaskStatus",
7822
7947
  "required": false,
@@ -7825,7 +7950,7 @@
7825
7950
  {
7826
7951
  "disabled": false,
7827
7952
  "document": "Version of the instance database engine. Value range: 5.1, 5.5, 5.6, 5.7.",
7828
- "example": "\"5.6\"",
7953
+ "example": "[\"5.7\",\"8.0\"]",
7829
7954
  "member": "string",
7830
7955
  "name": "EngineVersions",
7831
7956
  "required": false,
@@ -7834,7 +7959,7 @@
7834
7959
  {
7835
7960
  "disabled": false,
7836
7961
  "document": "VPC ID.",
7837
- "example": "0",
7962
+ "example": "[0]",
7838
7963
  "member": "uint64",
7839
7964
  "name": "VpcIds",
7840
7965
  "required": false,
@@ -7843,7 +7968,7 @@
7843
7968
  {
7844
7969
  "disabled": false,
7845
7970
  "document": "AZ ID.",
7846
- "example": "720001",
7971
+ "example": "[720001]",
7847
7972
  "member": "uint64",
7848
7973
  "name": "ZoneIds",
7849
7974
  "required": false,
@@ -7852,7 +7977,7 @@
7852
7977
  {
7853
7978
  "disabled": false,
7854
7979
  "document": "Subnet ID.",
7855
- "example": "0",
7980
+ "example": "[0]",
7856
7981
  "member": "uint64",
7857
7982
  "name": "SubnetIds",
7858
7983
  "required": false,
@@ -7861,7 +7986,7 @@
7861
7986
  {
7862
7987
  "disabled": false,
7863
7988
  "document": "Whether to lock disk write. Valid values: `0`(unlock), `1`(lock). Default value: 0.",
7864
- "example": "0",
7989
+ "example": "[0]",
7865
7990
  "member": "int64",
7866
7991
  "name": "CdbErrors",
7867
7992
  "required": false,
@@ -7869,8 +7994,8 @@
7869
7994
  },
7870
7995
  {
7871
7996
  "disabled": false,
7872
- "document": "Sort by field of the returned result set. Currently, supported values include \"InstanceId\", \"InstanceName\", \"CreateTime\", and \"DeadlineTime\".",
7873
- "example": "\"\"",
7997
+ "document": "Sorting field of the query results. Valid values: \"instanceId\", \"instanceName\", \"createTime\", and \"deadlineTime\".",
7998
+ "example": "instanceId",
7874
7999
  "member": "string",
7875
8000
  "name": "OrderBy",
7876
8001
  "required": false,
@@ -7878,7 +8003,7 @@
7878
8003
  },
7879
8004
  {
7880
8005
  "disabled": false,
7881
- "document": "Sorting method of the returned result set. Currently, \"ASC\" or \"DESC\" is supported.",
8006
+ "document": "Sorting method of the returned result set. Valid values: \"ASC\" - ascending order; \"DESC\" - descending order. The default value is \"DESC\".",
7882
8007
  "example": "\"DESC\"",
7883
8008
  "member": "string",
7884
8009
  "name": "OrderDirection",
@@ -7887,7 +8012,7 @@
7887
8012
  },
7888
8013
  {
7889
8014
  "disabled": false,
7890
- "document": "Whether security group ID is used as a filter",
8015
+ "document": "Whether to use the security group ID as the filter condition.\nNote: 0 indicates no; 1 indicates yes.",
7891
8016
  "example": "0",
7892
8017
  "member": "int64",
7893
8018
  "name": "WithSecurityGroup",
@@ -7906,7 +8031,7 @@
7906
8031
  {
7907
8032
  "disabled": false,
7908
8033
  "document": "Exclusive cluster ID.",
7909
- "example": "\"\"",
8034
+ "example": "cdb-g2ql0j11",
7910
8035
  "member": "string",
7911
8036
  "name": "ExClusterId",
7912
8037
  "required": false,
@@ -7915,7 +8040,7 @@
7915
8040
  {
7916
8041
  "disabled": false,
7917
8042
  "document": "Instance ID.",
7918
- "example": "[\"cdb-70zdmgg1\\r\\n\"]",
8043
+ "example": "[\"cdb-70zdmgg1\"]",
7919
8044
  "member": "string",
7920
8045
  "name": "InstanceIds",
7921
8046
  "required": false,
@@ -7960,7 +8085,7 @@
7960
8085
  {
7961
8086
  "disabled": false,
7962
8087
  "document": "Placement group ID list.",
7963
- "example": "\"\"",
8088
+ "example": "[\"ps-7t11vrwf\"]",
7964
8089
  "member": "string",
7965
8090
  "name": "DeployGroupIds",
7966
8091
  "required": false,
@@ -7969,7 +8094,7 @@
7969
8094
  {
7970
8095
  "disabled": false,
7971
8096
  "document": "Whether to use the tag key as a filter condition",
7972
- "example": "[\"\"]",
8097
+ "example": "[\"tagKey\"]",
7973
8098
  "member": "string",
7974
8099
  "name": "TagKeysForSearch",
7975
8100
  "required": false,
@@ -7978,7 +8103,7 @@
7978
8103
  {
7979
8104
  "disabled": false,
7980
8105
  "document": "Financial cage IDs.",
7981
- "example": "[\"cage-test\"]",
8106
+ "example": "[\"cage-dhges\"]",
7982
8107
  "member": "string",
7983
8108
  "name": "CageIds",
7984
8109
  "required": false,
@@ -8013,7 +8138,7 @@
8013
8138
  },
8014
8139
  {
8015
8140
  "disabled": false,
8016
- "document": "Tag key value",
8141
+ "document": "Tag key value.\nNote that tags cannot be queried for instances being created.",
8017
8142
  "example": "无",
8018
8143
  "member": "Tag",
8019
8144
  "name": "Tags",
@@ -8040,12 +8165,21 @@
8040
8165
  },
8041
8166
  {
8042
8167
  "disabled": false,
8043
- "document": "Database engine type",
8168
+ "document": "Database engine type. Valid values: InnoDB; RocksDB.",
8044
8169
  "example": "[\"InnoDB\"]",
8045
8170
  "member": "string",
8046
8171
  "name": "EngineTypes",
8047
8172
  "required": false,
8048
8173
  "type": "list"
8174
+ },
8175
+ {
8176
+ "disabled": false,
8177
+ "document": "Whether to obtain the Cluster Edition instance node information. Valid values: true or false. The default value is false.",
8178
+ "example": "false",
8179
+ "member": "bool",
8180
+ "name": "QueryClusterInfo",
8181
+ "required": false,
8182
+ "type": "bool"
8049
8183
  }
8050
8184
  ],
8051
8185
  "type": "object"
@@ -10661,7 +10795,7 @@
10661
10795
  "example": "1",
10662
10796
  "member": "int64",
10663
10797
  "name": "Status",
10664
- "required": true,
10798
+ "output_required": true,
10665
10799
  "type": "int",
10666
10800
  "value_allowed_null": false
10667
10801
  },
@@ -10671,7 +10805,7 @@
10671
10805
  "example": "ap-beijing-3",
10672
10806
  "member": "string",
10673
10807
  "name": "Zone",
10674
- "required": true,
10808
+ "output_required": true,
10675
10809
  "type": "string",
10676
10810
  "value_allowed_null": false
10677
10811
  },
@@ -10681,7 +10815,7 @@
10681
10815
  "example": "cdb-***",
10682
10816
  "member": "string",
10683
10817
  "name": "InstanceId",
10684
- "required": true,
10818
+ "output_required": true,
10685
10819
  "type": "string",
10686
10820
  "value_allowed_null": false
10687
10821
  },
@@ -10691,7 +10825,7 @@
10691
10825
  "example": "ap-beijing",
10692
10826
  "member": "string",
10693
10827
  "name": "Region",
10694
- "required": true,
10828
+ "output_required": true,
10695
10829
  "type": "string",
10696
10830
  "value_allowed_null": false
10697
10831
  },
@@ -10701,7 +10835,7 @@
10701
10835
  "example": "2",
10702
10836
  "member": "int64",
10703
10837
  "name": "SyncStatus",
10704
- "required": true,
10838
+ "output_required": true,
10705
10839
  "type": "int",
10706
10840
  "value_allowed_null": false
10707
10841
  },
@@ -10711,7 +10845,7 @@
10711
10845
  "example": "******",
10712
10846
  "member": "string",
10713
10847
  "name": "InstanceName",
10714
- "required": true,
10848
+ "output_required": true,
10715
10849
  "type": "string",
10716
10850
  "value_allowed_null": false
10717
10851
  },
@@ -10721,7 +10855,7 @@
10721
10855
  "example": "2",
10722
10856
  "member": "int64",
10723
10857
  "name": "InstanceType",
10724
- "required": true,
10858
+ "output_required": true,
10725
10859
  "type": "int",
10726
10860
  "value_allowed_null": false
10727
10861
  }
@@ -10992,7 +11126,7 @@
10992
11126
  {
10993
11127
  "disabled": false,
10994
11128
  "document": "Public network access status. Value range: 0 (not enabled), 1 (enabled), 2 (disabled)",
10995
- "example": "0",
11129
+ "example": "2",
10996
11130
  "member": "int64",
10997
11131
  "name": "WanStatus",
10998
11132
  "output_required": true,
@@ -11021,13 +11155,13 @@
11021
11155
  },
11022
11156
  {
11023
11157
  "disabled": false,
11024
- "document": "VIP information of a read-only instance. This field is exclusive to read-only instances where read-only access is enabled separately\nNote: This field may return null, indicating that no valid values can be obtained.",
11025
- "example": "{}",
11158
+ "document": "Read-only VIP information. This field is available only for read-only instances with dedicated access enabled.",
11159
+ "example": "",
11026
11160
  "member": "RoVipInfo",
11027
11161
  "name": "RoVipInfo",
11028
11162
  "output_required": true,
11029
11163
  "type": "object",
11030
- "value_allowed_null": true
11164
+ "value_allowed_null": false
11031
11165
  },
11032
11166
  {
11033
11167
  "disabled": false,
@@ -11061,13 +11195,13 @@
11061
11195
  },
11062
11196
  {
11063
11197
  "disabled": false,
11064
- "document": "Information of a secondary server\nNote: This field may return null, indicating that no valid values can be obtained.",
11065
- "example": "{}",
11198
+ "document": "Secondary server information.",
11199
+ "example": "",
11066
11200
  "member": "SlaveInfo",
11067
11201
  "name": "SlaveInfo",
11068
11202
  "output_required": true,
11069
11203
  "type": "object",
11070
- "value_allowed_null": true
11204
+ "value_allowed_null": false
11071
11205
  },
11072
11206
  {
11073
11207
  "disabled": false,
@@ -11102,7 +11236,7 @@
11102
11236
  {
11103
11237
  "disabled": false,
11104
11238
  "document": "Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync)",
11105
- "example": "0",
11239
+ "example": "1",
11106
11240
  "member": "int64",
11107
11241
  "name": "ProtectMode",
11108
11242
  "output_required": true,
@@ -11111,13 +11245,13 @@
11111
11245
  },
11112
11246
  {
11113
11247
  "disabled": false,
11114
- "document": "Details of a read-only group\nNote: This field may return null, indicating that no valid values can be obtained.",
11115
- "example": "[]",
11248
+ "document": "Detailed information about the read-only group.",
11249
+ "example": "",
11116
11250
  "member": "RoGroup",
11117
11251
  "name": "RoGroups",
11118
11252
  "output_required": true,
11119
11253
  "type": "list",
11120
- "value_allowed_null": true
11254
+ "value_allowed_null": false
11121
11255
  },
11122
11256
  {
11123
11257
  "disabled": false,
@@ -11142,7 +11276,7 @@
11142
11276
  {
11143
11277
  "disabled": false,
11144
11278
  "document": "Project ID",
11145
- "example": "0",
11279
+ "example": "12451",
11146
11280
  "member": "int64",
11147
11281
  "name": "ProjectId",
11148
11282
  "output_required": true,
@@ -11172,7 +11306,7 @@
11172
11306
  {
11173
11307
  "disabled": false,
11174
11308
  "document": "AZ deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ)",
11175
- "example": "0",
11309
+ "example": "1",
11176
11310
  "member": "int64",
11177
11311
  "name": "DeployMode",
11178
11312
  "output_required": true,
@@ -11182,7 +11316,7 @@
11182
11316
  {
11183
11317
  "disabled": false,
11184
11318
  "document": "Instance task status. 0 - no task; 1 - upgrading; 2 - importing data; 3 - activating secondary; 4 - enabling public network access; 5 - batch operation in progress; 6 - rolling back; 7 - disabling public network access; 8 - changing password; 9 - renaming instance; 10 - restarting; 12 - migrating self-built instance; 13 - dropping table; 14 - creating and syncing disaster recovery instance; 15 - pending upgrade and switch; 16 - upgrade and switch in progress; 17 - upgrade and switch completed",
11185
- "example": "0",
11319
+ "example": "1",
11186
11320
  "member": "int64",
11187
11321
  "name": "TaskStatus",
11188
11322
  "output_required": true,
@@ -11191,13 +11325,13 @@
11191
11325
  },
11192
11326
  {
11193
11327
  "disabled": false,
11194
- "document": "Details of a primary instance\nNote: This field may return null, indicating that no valid values can be obtained.",
11195
- "example": "{}",
11328
+ "document": "Detailed information about the primary instance.",
11329
+ "example": "",
11196
11330
  "member": "MasterInfo",
11197
11331
  "name": "MasterInfo",
11198
11332
  "output_required": true,
11199
11333
  "type": "object",
11200
- "value_allowed_null": true
11334
+ "value_allowed_null": false
11201
11335
  },
11202
11336
  {
11203
11337
  "disabled": false,
@@ -11231,18 +11365,18 @@
11231
11365
  },
11232
11366
  {
11233
11367
  "disabled": false,
11234
- "document": "Details of a disaster recovery instance\nNote: This field may return null, indicating that no valid values can be obtained.",
11235
- "example": "[]",
11368
+ "document": "Detailed information about the disaster recovery instance.",
11369
+ "example": "",
11236
11370
  "member": "DrInfo",
11237
11371
  "name": "DrInfo",
11238
11372
  "output_required": true,
11239
11373
  "type": "list",
11240
- "value_allowed_null": true
11374
+ "value_allowed_null": false
11241
11375
  },
11242
11376
  {
11243
11377
  "disabled": false,
11244
11378
  "document": "Public domain name",
11245
- "example": "''",
11379
+ "example": "gz-cdb-******.sql.tencentcdb.com",
11246
11380
  "member": "string",
11247
11381
  "name": "WanDomain",
11248
11382
  "output_required": true,
@@ -11252,7 +11386,7 @@
11252
11386
  {
11253
11387
  "disabled": false,
11254
11388
  "document": "Public network port number",
11255
- "example": "0",
11389
+ "example": "25640",
11256
11390
  "member": "int64",
11257
11391
  "name": "WanPort",
11258
11392
  "output_required": true,
@@ -11332,7 +11466,7 @@
11332
11466
  {
11333
11467
  "disabled": false,
11334
11468
  "document": "Physical ID",
11335
- "example": "''",
11469
+ "example": "phyxxx",
11336
11470
  "member": "string",
11337
11471
  "name": "PhysicalId",
11338
11472
  "output_required": true,
@@ -11371,33 +11505,33 @@
11371
11505
  },
11372
11506
  {
11373
11507
  "disabled": false,
11374
- "document": "Physical machine model\nNote: This field may return null, indicating that no valid values can be obtained.",
11375
- "example": "‘’",
11508
+ "document": "Physical server model.",
11509
+ "example": "VSWEQ",
11376
11510
  "member": "string",
11377
11511
  "name": "DeviceClass",
11378
11512
  "output_required": true,
11379
11513
  "type": "string",
11380
- "value_allowed_null": true
11514
+ "value_allowed_null": false
11381
11515
  },
11382
11516
  {
11383
11517
  "disabled": false,
11384
- "document": "Placement group ID\nNote: this field may return null, indicating that no valid values can be obtained.",
11385
- "example": "‘’",
11518
+ "document": "Placement group ID.",
11519
+ "example": "andy",
11386
11520
  "member": "string",
11387
11521
  "name": "DeployGroupId",
11388
11522
  "output_required": true,
11389
11523
  "type": "string",
11390
- "value_allowed_null": true
11524
+ "value_allowed_null": false
11391
11525
  },
11392
11526
  {
11393
11527
  "disabled": false,
11394
- "document": "AZ ID\nNote: this field may return null, indicating that no valid values can be obtained.",
11528
+ "document": "AZ ID.",
11395
11529
  "example": "800003",
11396
11530
  "member": "int64",
11397
11531
  "name": "ZoneId",
11398
11532
  "output_required": true,
11399
11533
  "type": "int",
11400
- "value_allowed_null": true
11534
+ "value_allowed_null": false
11401
11535
  },
11402
11536
  {
11403
11537
  "disabled": false,
@@ -11411,43 +11545,93 @@
11411
11545
  },
11412
11546
  {
11413
11547
  "disabled": false,
11414
- "document": "List of tags\nNote: this field may return `null`, indicating that no valid values can be obtained.",
11415
- "example": "[]",
11548
+ "document": "Tag list.",
11549
+ "example": "",
11416
11550
  "member": "TagInfoItem",
11417
11551
  "name": "TagList",
11418
11552
  "output_required": true,
11419
11553
  "type": "list",
11420
- "value_allowed_null": true
11554
+ "value_allowed_null": false
11421
11555
  },
11422
11556
  {
11423
11557
  "disabled": false,
11424
- "document": "Engine type\nNote: This field may return null, indicating that no valid values can be obtained.",
11558
+ "document": "Engine type.",
11425
11559
  "example": "InnoDB",
11426
11560
  "member": "string",
11427
11561
  "name": "EngineType",
11428
11562
  "output_required": true,
11429
11563
  "type": "string",
11430
- "value_allowed_null": true
11564
+ "value_allowed_null": false
11431
11565
  },
11432
11566
  {
11433
11567
  "disabled": false,
11434
- "document": "Maximum delay threshold\nNote: This field may return null, indicating that no valid values can be obtained.",
11568
+ "document": "Maximum delay threshold.",
11435
11569
  "example": "1",
11436
11570
  "member": "int64",
11437
11571
  "name": "MaxDelayTime",
11438
11572
  "output_required": true,
11439
11573
  "type": "int",
11440
- "value_allowed_null": true
11574
+ "value_allowed_null": false
11441
11575
  },
11442
11576
  {
11443
11577
  "disabled": false,
11444
- "document": "Instance disk type, which is returned only for the instances of cloud disk edition. Valid values: `CLOUD_SSD` (SSD), `CLOUD_HSSD` (Enhanced SSD).",
11578
+ "document": "Instance disk type. Valid values are returned only for Cluster Edition and single-node (cloud disk) instances.\nNote:\n1. If \"DiskType\": \"CLOUD_HSSD\" is returned, it indicates that the instance disk type is Enhanced SSD.\n2. If \"DiskType\": \"CLOUD_SSD\" is returned, it indicates that the instance disk type is Cloud SSD.\n3. If \"DiskType\": \"\" is returned and the DeviceType parameter value is UNIVERSAL or EXCLUSIVE, it indicates that the instance uses a local SSD.",
11445
11579
  "example": "CLOUD_SSD",
11446
11580
  "member": "string",
11447
11581
  "name": "DiskType",
11448
11582
  "output_required": true,
11449
11583
  "type": "string",
11450
11584
  "value_allowed_null": false
11585
+ },
11586
+ {
11587
+ "disabled": false,
11588
+ "document": "Current number of CPU cores for scale-out.",
11589
+ "example": "2",
11590
+ "member": "int64",
11591
+ "name": "ExpandCpu",
11592
+ "output_required": false,
11593
+ "type": "int",
11594
+ "value_allowed_null": false
11595
+ },
11596
+ {
11597
+ "disabled": false,
11598
+ "document": "Cluster Edition instance node information.",
11599
+ "example": "无",
11600
+ "member": "ClusterInfo",
11601
+ "name": "ClusterInfo",
11602
+ "output_required": false,
11603
+ "type": "list",
11604
+ "value_allowed_null": false
11605
+ },
11606
+ {
11607
+ "disabled": false,
11608
+ "document": "Analysis engine node list.",
11609
+ "example": "无",
11610
+ "member": "AnalysisNodeInfo",
11611
+ "name": "AnalysisNodeInfos",
11612
+ "output_required": false,
11613
+ "type": "list",
11614
+ "value_allowed_null": false
11615
+ },
11616
+ {
11617
+ "disabled": false,
11618
+ "document": "Device bandwidth, in GB. This parameter is valid when DeviceClass is specified. For example, 25 means the current device bandwidth is 25 GB; 10 means the current device bandwidth is 10 GB.",
11619
+ "example": "25",
11620
+ "member": "uint64",
11621
+ "name": "DeviceBandwidth",
11622
+ "output_required": false,
11623
+ "type": "int",
11624
+ "value_allowed_null": false
11625
+ },
11626
+ {
11627
+ "disabled": false,
11628
+ "document": "Instance termination protection status. on indicates enabled; otherwise, the protection is disabled.",
11629
+ "example": "on",
11630
+ "member": "string",
11631
+ "name": "DestroyProtect",
11632
+ "output_required": false,
11633
+ "type": "string",
11634
+ "value_allowed_null": false
11451
11635
  }
11452
11636
  ],
11453
11637
  "usage": "out"
@@ -11700,7 +11884,7 @@
11700
11884
  "example": "ap-guangzhou",
11701
11885
  "member": "string",
11702
11886
  "name": "Region",
11703
- "required": true,
11887
+ "output_required": true,
11704
11888
  "type": "string",
11705
11889
  "value_allowed_null": false
11706
11890
  },
@@ -11710,7 +11894,7 @@
11710
11894
  "example": "1",
11711
11895
  "member": "int64",
11712
11896
  "name": "RegionId",
11713
- "required": true,
11897
+ "output_required": true,
11714
11898
  "type": "int",
11715
11899
  "value_allowed_null": false
11716
11900
  },
@@ -11720,7 +11904,7 @@
11720
11904
  "example": "100003",
11721
11905
  "member": "int64",
11722
11906
  "name": "ZoneId",
11723
- "required": true,
11907
+ "output_required": true,
11724
11908
  "type": "int",
11725
11909
  "value_allowed_null": false
11726
11910
  },
@@ -11730,7 +11914,7 @@
11730
11914
  "example": "ap-guangzhou-3",
11731
11915
  "member": "string",
11732
11916
  "name": "Zone",
11733
- "required": true,
11917
+ "output_required": true,
11734
11918
  "type": "string",
11735
11919
  "value_allowed_null": false
11736
11920
  },
@@ -11740,17 +11924,17 @@
11740
11924
  "example": "cdb-***",
11741
11925
  "member": "string",
11742
11926
  "name": "InstanceId",
11743
- "required": true,
11927
+ "output_required": true,
11744
11928
  "type": "string",
11745
11929
  "value_allowed_null": false
11746
11930
  },
11747
11931
  {
11748
11932
  "disabled": false,
11749
11933
  "document": "Long instance ID",
11750
- "example": "''",
11934
+ "example": "1241asdd-qwed1-213-dad",
11751
11935
  "member": "string",
11752
11936
  "name": "ResourceId",
11753
- "required": true,
11937
+ "output_required": true,
11754
11938
  "type": "string",
11755
11939
  "value_allowed_null": false
11756
11940
  },
@@ -11760,7 +11944,7 @@
11760
11944
  "example": "1",
11761
11945
  "member": "int64",
11762
11946
  "name": "Status",
11763
- "required": true,
11947
+ "output_required": true,
11764
11948
  "type": "int",
11765
11949
  "value_allowed_null": false
11766
11950
  },
@@ -11770,7 +11954,7 @@
11770
11954
  "example": "***",
11771
11955
  "member": "string",
11772
11956
  "name": "InstanceName",
11773
- "required": true,
11957
+ "output_required": true,
11774
11958
  "type": "string",
11775
11959
  "value_allowed_null": false
11776
11960
  },
@@ -11780,7 +11964,7 @@
11780
11964
  "example": "1",
11781
11965
  "member": "int64",
11782
11966
  "name": "InstanceType",
11783
- "required": true,
11967
+ "output_required": true,
11784
11968
  "type": "int",
11785
11969
  "value_allowed_null": false
11786
11970
  },
@@ -11790,7 +11974,7 @@
11790
11974
  "example": "0",
11791
11975
  "member": "int64",
11792
11976
  "name": "TaskStatus",
11793
- "required": true,
11977
+ "output_required": true,
11794
11978
  "type": "int",
11795
11979
  "value_allowed_null": false
11796
11980
  },
@@ -11800,7 +11984,7 @@
11800
11984
  "example": "1000",
11801
11985
  "member": "int64",
11802
11986
  "name": "Memory",
11803
- "required": true,
11987
+ "output_required": true,
11804
11988
  "type": "int",
11805
11989
  "value_allowed_null": false
11806
11990
  },
@@ -11810,7 +11994,7 @@
11810
11994
  "example": "50",
11811
11995
  "member": "int64",
11812
11996
  "name": "Volume",
11813
- "required": true,
11997
+ "output_required": true,
11814
11998
  "type": "int",
11815
11999
  "value_allowed_null": false
11816
12000
  },
@@ -11820,7 +12004,7 @@
11820
12004
  "example": "UNIVERSAL",
11821
12005
  "member": "string",
11822
12006
  "name": "DeviceType",
11823
- "required": true,
12007
+ "output_required": true,
11824
12008
  "type": "string",
11825
12009
  "value_allowed_null": false
11826
12010
  },
@@ -11830,7 +12014,7 @@
11830
12014
  "example": "1000",
11831
12015
  "member": "int64",
11832
12016
  "name": "Qps",
11833
- "required": true,
12017
+ "output_required": true,
11834
12018
  "type": "int",
11835
12019
  "value_allowed_null": false
11836
12020
  },
@@ -11840,7 +12024,7 @@
11840
12024
  "example": "1533",
11841
12025
  "member": "int64",
11842
12026
  "name": "VpcId",
11843
- "required": true,
12027
+ "output_required": true,
11844
12028
  "type": "int",
11845
12029
  "value_allowed_null": false
11846
12030
  },
@@ -11850,27 +12034,27 @@
11850
12034
  "example": "12364",
11851
12035
  "member": "int64",
11852
12036
  "name": "SubnetId",
11853
- "required": true,
12037
+ "output_required": true,
11854
12038
  "type": "int",
11855
12039
  "value_allowed_null": false
11856
12040
  },
11857
12041
  {
11858
12042
  "disabled": false,
11859
12043
  "document": "Dedicated cluster ID",
11860
- "example": "''",
12044
+ "example": "andy",
11861
12045
  "member": "string",
11862
12046
  "name": "ExClusterId",
11863
- "required": true,
12047
+ "output_required": true,
11864
12048
  "type": "string",
11865
12049
  "value_allowed_null": false
11866
12050
  },
11867
12051
  {
11868
12052
  "disabled": false,
11869
12053
  "document": "Dedicated cluster name",
11870
- "example": "''",
12054
+ "example": "andy",
11871
12055
  "member": "string",
11872
12056
  "name": "ExClusterName",
11873
- "required": true,
12057
+ "output_required": true,
11874
12058
  "type": "string",
11875
12059
  "value_allowed_null": false
11876
12060
  }
@@ -14890,7 +15074,7 @@
14890
15074
  },
14891
15075
  {
14892
15076
  "disabled": false,
14893
- "document": "Read-only group ID.",
15077
+ "document": "Read-only group ID.\nNote: If the data structure is used during instance purchase, this item is required only when the read-only group mode is set to join.",
14894
15078
  "example": "cdbrg-92zkeaq2",
14895
15079
  "member": "string",
14896
15080
  "name": "RoGroupId",
@@ -14923,7 +15107,7 @@
14923
15107
  },
14924
15108
  {
14925
15109
  "disabled": false,
14926
- "document": "Latency threshold",
15110
+ "document": "Delay threshold, in seconds. Value range: 1–10000. The value is an integer.",
14927
15111
  "example": "1",
14928
15112
  "member": "int64",
14929
15113
  "name": "RoMaxDelayTime",
@@ -14968,7 +15152,7 @@
14968
15152
  {
14969
15153
  "disabled": false,
14970
15154
  "document": "Details of read-only instances in read-only group",
14971
- "example": "[]",
15155
+ "example": "",
14972
15156
  "member": "RoInstanceInfo",
14973
15157
  "name": "RoInstances",
14974
15158
  "output_required": true,
@@ -15000,58 +15184,58 @@
15000
15184
  },
15001
15185
  {
15002
15186
  "disabled": false,
15003
- "document": "VPC ID.\nNote: this field may return null, indicating that no valid values can be obtained.",
15187
+ "document": "Virtual Private Cloud (VPC) ID.",
15004
15188
  "example": "vpc-ja6ts123",
15005
15189
  "member": "string",
15006
15190
  "name": "UniqVpcId",
15007
15191
  "output_required": true,
15008
15192
  "required": false,
15009
15193
  "type": "string",
15010
- "value_allowed_null": true
15194
+ "value_allowed_null": false
15011
15195
  },
15012
15196
  {
15013
15197
  "disabled": false,
15014
- "document": "Subnet ID.\nNote: this field may return null, indicating that no valid values can be obtained.",
15198
+ "document": "Subnet ID.",
15015
15199
  "example": "subnet-njh2bc99",
15016
15200
  "member": "string",
15017
15201
  "name": "UniqSubnetId",
15018
15202
  "output_required": true,
15019
15203
  "required": false,
15020
15204
  "type": "string",
15021
- "value_allowed_null": true
15205
+ "value_allowed_null": false
15022
15206
  },
15023
15207
  {
15024
15208
  "disabled": false,
15025
- "document": "Read-only group region.\nNote: this field may return null, indicating that no valid values can be obtained.",
15209
+ "document": "Region of the read-only group.",
15026
15210
  "example": "ap-beijing",
15027
15211
  "member": "string",
15028
15212
  "name": "RoGroupRegion",
15029
15213
  "output_required": true,
15030
15214
  "required": false,
15031
15215
  "type": "string",
15032
- "value_allowed_null": true
15216
+ "value_allowed_null": false
15033
15217
  },
15034
15218
  {
15035
15219
  "disabled": false,
15036
- "document": "Read-only group AZ.\nNote: this field may return null, indicating that no valid values can be obtained.",
15220
+ "document": "AZ of the read-only group.",
15037
15221
  "example": "ap-beijing-3",
15038
15222
  "member": "string",
15039
15223
  "name": "RoGroupZone",
15040
15224
  "output_required": true,
15041
15225
  "required": false,
15042
15226
  "type": "string",
15043
- "value_allowed_null": true
15227
+ "value_allowed_null": false
15044
15228
  },
15045
15229
  {
15046
15230
  "disabled": false,
15047
- "document": "Replication delay.\nNote: this field may return `null`, indicating that no valid values can be obtained.",
15231
+ "document": "Replication delay time, in seconds. Value range: 1–259200. The value is an integer.",
15048
15232
  "example": "1000",
15049
15233
  "member": "int64",
15050
15234
  "name": "DelayReplicationTime",
15051
15235
  "output_required": true,
15052
15236
  "required": false,
15053
15237
  "type": "int",
15054
- "value_allowed_null": true
15238
+ "value_allowed_null": false
15055
15239
  }
15056
15240
  ],
15057
15241
  "usage": "both"
@@ -15237,7 +15421,7 @@
15237
15421
  },
15238
15422
  {
15239
15423
  "disabled": false,
15240
- "document": "Pay-as-you-go billing status. Value range: 1 (normal), 2 (in arrears)",
15424
+ "document": "Pay-as-you-go status. Valid values: 1 - normal; 2 - in arrears.",
15241
15425
  "example": "1",
15242
15426
  "member": "int64",
15243
15427
  "name": "HourFeeStatus",
@@ -15359,7 +15543,7 @@
15359
15543
  {
15360
15544
  "disabled": false,
15361
15545
  "document": "RO instance expiration time in the format of yyyy-mm-dd hh:mm:ss. If it is a pay-as-you-go instance, the value of this field is 0000-00-00 00:00:00",
15362
- "example": "‘’",
15546
+ "example": "2024-09-09 16:40:30",
15363
15547
  "member": "string",
15364
15548
  "name": "DeadlineTime",
15365
15549
  "output_required": true,
@@ -15369,7 +15553,7 @@
15369
15553
  },
15370
15554
  {
15371
15555
  "disabled": false,
15372
- "document": "RO instance billing method. Value range: 0 (monthly subscribed), 1 (pay-as-you-go), 2 (monthly postpaid)",
15556
+ "document": "Billing type of the RO instance. Valid values: 0 - yearly/monthly subscription; 1 - pay-as-you-go; 2-postpaid by month.",
15373
15557
  "example": "0",
15374
15558
  "member": "int64",
15375
15559
  "name": "PayType",
@@ -15377,6 +15561,17 @@
15377
15561
  "required": false,
15378
15562
  "type": "int",
15379
15563
  "value_allowed_null": false
15564
+ },
15565
+ {
15566
+ "disabled": false,
15567
+ "document": "RO replication delay status.",
15568
+ "example": "RUNNING",
15569
+ "member": "string",
15570
+ "name": "ReplicationStatus",
15571
+ "output_required": true,
15572
+ "required": false,
15573
+ "type": "string",
15574
+ "value_allowed_null": false
15380
15575
  }
15381
15576
  ],
15382
15577
  "usage": "both"
@@ -15387,47 +15582,52 @@
15387
15582
  {
15388
15583
  "disabled": false,
15389
15584
  "document": "VIP status of the read-only instance",
15390
- "example": "",
15585
+ "example": "2",
15391
15586
  "member": "int64",
15392
15587
  "name": "RoVipStatus",
15393
- "required": true,
15394
- "type": "int"
15588
+ "output_required": true,
15589
+ "type": "int",
15590
+ "value_allowed_null": false
15395
15591
  },
15396
15592
  {
15397
15593
  "disabled": false,
15398
15594
  "document": "VPC subnet of the read-only instance",
15399
- "example": "",
15595
+ "example": "2132421",
15400
15596
  "member": "int64",
15401
15597
  "name": "RoSubnetId",
15402
- "required": true,
15403
- "type": "int"
15598
+ "output_required": true,
15599
+ "type": "int",
15600
+ "value_allowed_null": false
15404
15601
  },
15405
15602
  {
15406
15603
  "disabled": false,
15407
15604
  "document": "VPC of the read-only instance",
15408
- "example": "",
15605
+ "example": "13421234",
15409
15606
  "member": "int64",
15410
15607
  "name": "RoVpcId",
15411
- "required": true,
15412
- "type": "int"
15608
+ "output_required": true,
15609
+ "type": "int",
15610
+ "value_allowed_null": false
15413
15611
  },
15414
15612
  {
15415
15613
  "disabled": false,
15416
15614
  "document": "VIP port number of the read-only instance",
15417
- "example": "",
15615
+ "example": "3306",
15418
15616
  "member": "int64",
15419
15617
  "name": "RoVport",
15420
- "required": true,
15421
- "type": "int"
15618
+ "output_required": true,
15619
+ "type": "int",
15620
+ "value_allowed_null": false
15422
15621
  },
15423
15622
  {
15424
15623
  "disabled": false,
15425
15624
  "document": "VIP of the read-only instance",
15426
- "example": "",
15625
+ "example": "10.1.1.1",
15427
15626
  "member": "string",
15428
15627
  "name": "RoVip",
15429
- "required": true,
15430
- "type": "string"
15628
+ "output_required": true,
15629
+ "type": "string",
15630
+ "value_allowed_null": false
15431
15631
  }
15432
15632
  ],
15433
15633
  "usage": "out"
@@ -15843,22 +16043,22 @@
15843
16043
  {
15844
16044
  "disabled": false,
15845
16045
  "document": "Information of secondary server 1",
15846
- "example": "",
16046
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.1.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
15847
16047
  "member": "SlaveInstanceInfo",
15848
16048
  "name": "First",
15849
- "required": true,
16049
+ "output_required": true,
15850
16050
  "type": "object",
15851
16051
  "value_allowed_null": false
15852
16052
  },
15853
16053
  {
15854
16054
  "disabled": false,
15855
- "document": "Information of secondary server 2\nNote: This field may return null, indicating that no valid values can be obtained.",
15856
- "example": "",
16055
+ "document": "Second secondary server information.",
16056
+ "example": "{\"Vport\": 3306,\"Vip\": \"10.1.0.1\",\"Region\": \"ap-guangzhou\",\"Zone\": \"ap-guangzhou-1\"}",
15857
16057
  "member": "SlaveInstanceInfo",
15858
16058
  "name": "Second",
15859
- "required": false,
16059
+ "output_required": true,
15860
16060
  "type": "object",
15861
- "value_allowed_null": true
16061
+ "value_allowed_null": false
15862
16062
  }
15863
16063
  ],
15864
16064
  "usage": "out"
@@ -16689,25 +16889,25 @@
16689
16889
  "members": [
16690
16890
  {
16691
16891
  "disabled": false,
16692
- "document": "Tag key\nNote: this field may return `null`, indicating that no valid values can be obtained.",
16892
+ "document": "Tag key.",
16693
16893
  "example": "‘’",
16694
16894
  "member": "string",
16695
16895
  "name": "TagKey",
16696
16896
  "output_required": true,
16697
16897
  "required": true,
16698
16898
  "type": "string",
16699
- "value_allowed_null": true
16899
+ "value_allowed_null": false
16700
16900
  },
16701
16901
  {
16702
16902
  "disabled": false,
16703
- "document": "Tag value\nNote: this field may return `null`, indicating that no valid values can be obtained.",
16903
+ "document": "Tag value.",
16704
16904
  "example": "‘’",
16705
16905
  "member": "string",
16706
16906
  "name": "TagValue",
16707
16907
  "output_required": true,
16708
16908
  "required": true,
16709
16909
  "type": "string",
16710
- "value_allowed_null": true
16910
+ "value_allowed_null": false
16711
16911
  }
16712
16912
  ],
16713
16913
  "usage": "both"