From 007dffd756e7110f3e05f21c80ada2be31043a93 Mon Sep 17 00:00:00 2001 From: luhuayi Date: Fri, 6 Mar 2026 08:01:27 +0000 Subject: [PATCH] DWS API 8.5.1_20260108 version Reviewed-by: Pruthi, Vineet Co-authored-by: luhuayi Co-committed-by: luhuayi --- docs/dws/api-ref/ALL_META.TXT.json | 2930 +++++++++++++++-- docs/dws/api-ref/AddQueueUserList.html | 244 ++ docs/dws/api-ref/AddWorkloadPlanStage.html | 407 +++ docs/dws/api-ref/AddWorkloadQueue.html | 291 ++ docs/dws/api-ref/AddWorkloadRule.html | 342 ++ docs/dws/api-ref/AssociateEip.html | 134 + docs/dws/api-ref/AssociateElb.html | 158 + docs/dws/api-ref/BatchCreateClusterCn.html | 180 + docs/dws/api-ref/BatchCreateResourceTag.html | 186 ++ docs/dws/api-ref/BatchDeleteClusterCn.html | 180 + docs/dws/api-ref/BatchDeleteResourceTag.html | 193 ++ docs/dws/api-ref/CLASS.TXT.json | 1387 +++++++- docs/dws/api-ref/CancelReadonlyCluster.html | 123 + docs/dws/api-ref/ChangeSecurityGroup.html | 147 + docs/dws/api-ref/CheckCluster.html | 696 ++++ docs/dws/api-ref/CheckClusterShrink.html | 196 ++ docs/dws/api-ref/CheckGrowCluster.html | 460 +++ docs/dws/api-ref/CheckTableRestore.html | 295 ++ docs/dws/api-ref/ConvertToLogicalCluster.html | 165 + docs/dws/api-ref/CopySnapshot.html | 185 ++ docs/dws/api-ref/CreateAlarmSub.html | 344 ++ docs/dws/api-ref/CreateCluster.html | 537 +++ docs/dws/api-ref/CreateClusterDns.html | 175 + docs/dws/api-ref/CreateClusterV2.html | 706 ++++ docs/dws/api-ref/CreateClusterWorkload.html | 230 ++ docs/dws/api-ref/CreateEventSub.html | 440 +++ docs/dws/api-ref/CreateLogicalCluster.html | 391 +++ docs/dws/api-ref/CreateSnapshot.html | 238 ++ docs/dws/api-ref/CreateSnapshotPolicy.html | 281 ++ docs/dws/api-ref/CreateWorkloadPlan.html | 204 ++ docs/dws/api-ref/DeleteAlarmSub.html | 252 ++ docs/dws/api-ref/DeleteCluster.html | 154 + docs/dws/api-ref/DeleteClusterDns.html | 148 + docs/dws/api-ref/DeleteClusterNodes.html | 205 ++ docs/dws/api-ref/DeleteDwsCluster.html | 166 + docs/dws/api-ref/DeleteEventSub.html | 296 ++ docs/dws/api-ref/DeleteLogicalCluster.html | 167 + docs/dws/api-ref/DeleteQueueUserList.html | 244 ++ docs/dws/api-ref/DeleteSnapshot.html | 118 + docs/dws/api-ref/DeleteSnapshotPolicy.html | 134 + docs/dws/api-ref/DeleteWorkloadPlan.html | 170 + docs/dws/api-ref/DeleteWorkloadPlanStage.html | 185 ++ docs/dws/api-ref/DeleteWorkloadQueue.html | 199 ++ docs/dws/api-ref/DeleteWorkloadRule.html | 242 ++ docs/dws/api-ref/DisableLtsLogs.html | 118 + docs/dws/api-ref/DisassociateEip.html | 134 + docs/dws/api-ref/DisassociateElb.html | 156 + docs/dws/api-ref/EnableLogicalCluster.html | 189 ++ docs/dws/api-ref/EnableLtsLogs.html | 118 + .../api-ref/ExecuteRedistributionCluster.html | 177 + docs/dws/api-ref/ExpandInstanceStorage.html | 149 + docs/dws/api-ref/ListAlarmConfigs.html | 295 ++ docs/dws/api-ref/ListAlarmDetail.html | 322 ++ docs/dws/api-ref/ListAlarmStatistic.html | 260 ++ docs/dws/api-ref/ListAlarmSubs.html | 317 ++ docs/dws/api-ref/ListAuditLog.html | 264 ++ docs/dws/api-ref/ListAvailabilityZones.html | 196 ++ docs/dws/api-ref/ListClusterActions.html | 323 ++ docs/dws/api-ref/ListClusterCn.html | 211 ++ docs/dws/api-ref/ListClusterDetails.html | 1094 ++++++ docs/dws/api-ref/ListClusterEndpoints.html | 504 +++ docs/dws/api-ref/ListClusterNodes.html | 438 +++ .../api-ref/ListClusterScaleInNumbers.html | 143 + docs/dws/api-ref/ListClusterSnapshots.html | 651 ++++ docs/dws/api-ref/ListClusterTags.html | 177 + docs/dws/api-ref/ListClusterWorkload.html | 209 ++ docs/dws/api-ref/ListClusters.html | 810 +++++ docs/dws/api-ref/ListDssPools.html | 247 ++ docs/dws/api-ref/ListElbs.html | 275 ++ docs/dws/api-ref/ListEventSpecs.html | 375 +++ docs/dws/api-ref/ListEventSubs.html | 361 ++ docs/dws/api-ref/ListEvents.html | 361 ++ docs/dws/api-ref/ListJobDetails.html | 219 ++ docs/dws/api-ref/ListLogicalClusterRings.html | 324 ++ docs/dws/api-ref/ListLogicalClusterTasks.html | 361 ++ .../api-ref/ListLogicalClusterVolumes.html | 257 ++ docs/dws/api-ref/ListLogicalClusters.html | 604 ++++ docs/dws/api-ref/ListLtsLogs.html | 278 ++ docs/dws/api-ref/ListNodeTypes.html | 542 +++ docs/dws/api-ref/ListPlanExecLogs.html | 292 ++ .../dws/api-ref/ListRedistributionSchema.html | 289 ++ docs/dws/api-ref/ListSchemas.html | 387 +++ docs/dws/api-ref/ListSnapshotDetails.html | 517 +++ docs/dws/api-ref/ListSnapshotFlavorInfo.html | 582 ++++ docs/dws/api-ref/ListSnapshotPolicy.html | 341 ++ docs/dws/api-ref/ListSnapshotStatistics.html | 198 ++ docs/dws/api-ref/ListSnapshots.html | 262 ++ docs/dws/api-ref/ListTags.html | 161 + docs/dws/api-ref/ListTagsForResource.html | 249 ++ docs/dws/api-ref/ListTargetFlavors.html | 256 ++ docs/dws/api-ref/ListTopoRings.html | 369 +++ docs/dws/api-ref/ListWorkloadPlans.html | 550 ++++ docs/dws/api-ref/ListWorkloadQueue.html | 193 ++ docs/dws/api-ref/ListWorkloadQueueUsers.html | 358 ++ docs/dws/api-ref/ListWorkloadRules.html | 315 ++ docs/dws/api-ref/ModifyClusterName.html | 193 ++ docs/dws/api-ref/ModifyClusterTimezone.html | 199 ++ docs/dws/api-ref/ResetPassword.html | 165 + docs/dws/api-ref/ResizeCluster.html | 258 ++ .../ResizeClusterWithExistedNodes.html | 343 ++ docs/dws/api-ref/RestartCluster.html | 154 + docs/dws/api-ref/RestartLogicalCluster.html | 170 + docs/dws/api-ref/RestoreCluster.html | 382 +++ docs/dws/api-ref/RestoreRedistribution.html | 121 + docs/dws/api-ref/RestoreTable.html | 249 ++ .../api-ref/SaveClusterDescriptionInfo.html | 213 ++ .../api-ref/SetRedistributionPriority.html | 254 ++ docs/dws/api-ref/ShowClusterFlavor.html | 392 +++ .../api-ref/ShowClusterRedistribution.html | 942 ++++++ .../ShowClusterStorageExpandRange.html | 178 + docs/dws/api-ref/ShowClusterVolume.html | 229 ++ docs/dws/api-ref/ShowClusters.html | 778 +++++ docs/dws/api-ref/ShowInstance.html | 754 +++++ docs/dws/api-ref/ShowResourceStatistics.html | 201 ++ docs/dws/api-ref/ShowWorkloadPlan.html | 511 +++ docs/dws/api-ref/ShowWorkloadPlanStage.html | 425 +++ docs/dws/api-ref/ShowWorkloadQueue.html | 360 ++ docs/dws/api-ref/ShrinkCluster.html | 276 ++ docs/dws/api-ref/ShrinkLogicalCluster.html | 391 +++ docs/dws/api-ref/StartCluster.html | 145 + docs/dws/api-ref/StartWorkloadPlan.html | 170 + docs/dws/api-ref/StopCluster.html | 145 + docs/dws/api-ref/StopRedistribution.html | 122 + docs/dws/api-ref/StopWorkloadPlan.html | 170 + docs/dws/api-ref/SwitchOverCluster.html | 124 + docs/dws/api-ref/SwitchPlanStage.html | 198 ++ docs/dws/api-ref/UpdateAlarmSub.html | 347 ++ docs/dws/api-ref/UpdateClusterDns.html | 174 + docs/dws/api-ref/UpdateEventSub.html | 443 +++ docs/dws/api-ref/UpdateLogicalCluster.html | 399 +++ docs/dws/api-ref/UpdateQueueResources.html | 372 +++ .../UpdateRedistributionConfigurations.html | 174 + docs/dws/api-ref/UpdateSchemas.html | 208 ++ docs/dws/api-ref/UpdateWorkloadPlanStage.html | 705 ++++ docs/dws/api-ref/UpdateWorkloadRule.html | 272 ++ docs/dws/api-ref/dws_02_00068.html | 67 +- docs/dws/api-ref/dws_02_0011.html | 18 +- docs/dws/api-ref/dws_02_0017.html | 57 +- docs/dws/api-ref/dws_02_0018.html | 536 --- docs/dws/api-ref/dws_02_0019.html | 717 ---- docs/dws/api-ref/dws_02_0020.html | 378 --- docs/dws/api-ref/dws_02_0021.html | 126 - docs/dws/api-ref/dws_02_0022.html | 425 --- docs/dws/api-ref/dws_02_0023.html | 34 +- docs/dws/api-ref/dws_02_0024.html | 219 -- docs/dws/api-ref/dws_02_0025.html | 404 --- docs/dws/api-ref/dws_02_0026.html | 245 +- docs/dws/api-ref/dws_02_0027.html | 100 - docs/dws/api-ref/dws_02_0030.html | 1086 +++--- docs/dws/api-ref/dws_02_0031.html | 180 +- docs/dws/api-ref/dws_02_0032.html | 297 -- docs/dws/api-ref/dws_02_0034.html | 259 +- docs/dws/api-ref/dws_02_0036.html | 118 +- docs/dws/api-ref/dws_02_0037.html | 28 +- docs/dws/api-ref/dws_02_0038.html | 280 +- docs/dws/api-ref/dws_02_0040.html | 10 +- docs/dws/api-ref/dws_02_0045.html | 24 - docs/dws/api-ref/dws_02_0047.html | 184 -- docs/dws/api-ref/dws_02_0048.html | 191 -- docs/dws/api-ref/dws_02_0049.html | 175 - docs/dws/api-ref/dws_02_0050.html | 159 - docs/dws/api-ref/dws_02_0052.html | 126 - docs/dws/api-ref/dws_02_0053.html | 152 - docs/dws/api-ref/dws_02_0054.html | 128 - docs/dws/api-ref/dws_02_0055.html | 14 - docs/dws/api-ref/dws_02_0056.html | 284 -- docs/dws/api-ref/dws_02_0057.html | 28 +- docs/dws/api-ref/dws_02_0061.html | 307 ++ docs/dws/api-ref/dws_02_0062.html | 2 +- docs/dws/api-ref/dws_02_0063.html | 210 +- docs/dws/api-ref/dws_02_0064.html | 39 +- docs/dws/api-ref/dws_02_0065.html | 60 +- docs/dws/api-ref/dws_02_0066.html | 8 +- docs/dws/api-ref/dws_02_0067.html | 8 +- docs/dws/api-ref/dws_02_0525.html | 26 + docs/dws/api-ref/dws_02_0536.html | 16 + docs/dws/api-ref/dws_02_0538.html | 70 + docs/dws/api-ref/dws_02_0544.html | 28 + docs/dws/api-ref/dws_02_0552.html | 16 + docs/dws/api-ref/dws_02_0554.html | 32 + docs/dws/api-ref/dws_02_0563.html | 22 + docs/dws/api-ref/dws_02_0604.html | 18 + docs/dws/api-ref/dws_02_0605.html | 36 + docs/dws/api-ref/dws_02_0799.html | 20 + .../figure/en-us_image_0000001185833158.png | Bin 29579 -> 0 bytes .../figure/en-us_image_0000001231472779.png | Bin 33776 -> 0 bytes .../figure/en-us_image_0000002138022226.png | Bin 70063 -> 0 bytes .../figure/en-us_image_0000002500014136.png | Bin 0 -> 70667 bytes .../figure/en-us_image_0000002531894007.png | Bin 0 -> 27740 bytes .../figure/en-us_image_0000002531894009.png | Bin 0 -> 18806 bytes ...8.jpg => en-us_image_0000002531894011.jpg} | Bin 191 files changed, 45863 insertions(+), 6313 deletions(-) create mode 100644 docs/dws/api-ref/AddQueueUserList.html create mode 100644 docs/dws/api-ref/AddWorkloadPlanStage.html create mode 100644 docs/dws/api-ref/AddWorkloadQueue.html create mode 100644 docs/dws/api-ref/AddWorkloadRule.html create mode 100644 docs/dws/api-ref/AssociateEip.html create mode 100644 docs/dws/api-ref/AssociateElb.html create mode 100644 docs/dws/api-ref/BatchCreateClusterCn.html create mode 100644 docs/dws/api-ref/BatchCreateResourceTag.html create mode 100644 docs/dws/api-ref/BatchDeleteClusterCn.html create mode 100644 docs/dws/api-ref/BatchDeleteResourceTag.html create mode 100644 docs/dws/api-ref/CancelReadonlyCluster.html create mode 100644 docs/dws/api-ref/ChangeSecurityGroup.html create mode 100644 docs/dws/api-ref/CheckCluster.html create mode 100644 docs/dws/api-ref/CheckClusterShrink.html create mode 100644 docs/dws/api-ref/CheckGrowCluster.html create mode 100644 docs/dws/api-ref/CheckTableRestore.html create mode 100644 docs/dws/api-ref/ConvertToLogicalCluster.html create mode 100644 docs/dws/api-ref/CopySnapshot.html create mode 100644 docs/dws/api-ref/CreateAlarmSub.html create mode 100644 docs/dws/api-ref/CreateCluster.html create mode 100644 docs/dws/api-ref/CreateClusterDns.html create mode 100644 docs/dws/api-ref/CreateClusterV2.html create mode 100644 docs/dws/api-ref/CreateClusterWorkload.html create mode 100644 docs/dws/api-ref/CreateEventSub.html create mode 100644 docs/dws/api-ref/CreateLogicalCluster.html create mode 100644 docs/dws/api-ref/CreateSnapshot.html create mode 100644 docs/dws/api-ref/CreateSnapshotPolicy.html create mode 100644 docs/dws/api-ref/CreateWorkloadPlan.html create mode 100644 docs/dws/api-ref/DeleteAlarmSub.html create mode 100644 docs/dws/api-ref/DeleteCluster.html create mode 100644 docs/dws/api-ref/DeleteClusterDns.html create mode 100644 docs/dws/api-ref/DeleteClusterNodes.html create mode 100644 docs/dws/api-ref/DeleteDwsCluster.html create mode 100644 docs/dws/api-ref/DeleteEventSub.html create mode 100644 docs/dws/api-ref/DeleteLogicalCluster.html create mode 100644 docs/dws/api-ref/DeleteQueueUserList.html create mode 100644 docs/dws/api-ref/DeleteSnapshot.html create mode 100644 docs/dws/api-ref/DeleteSnapshotPolicy.html create mode 100644 docs/dws/api-ref/DeleteWorkloadPlan.html create mode 100644 docs/dws/api-ref/DeleteWorkloadPlanStage.html create mode 100644 docs/dws/api-ref/DeleteWorkloadQueue.html create mode 100644 docs/dws/api-ref/DeleteWorkloadRule.html create mode 100644 docs/dws/api-ref/DisableLtsLogs.html create mode 100644 docs/dws/api-ref/DisassociateEip.html create mode 100644 docs/dws/api-ref/DisassociateElb.html create mode 100644 docs/dws/api-ref/EnableLogicalCluster.html create mode 100644 docs/dws/api-ref/EnableLtsLogs.html create mode 100644 docs/dws/api-ref/ExecuteRedistributionCluster.html create mode 100644 docs/dws/api-ref/ExpandInstanceStorage.html create mode 100644 docs/dws/api-ref/ListAlarmConfigs.html create mode 100644 docs/dws/api-ref/ListAlarmDetail.html create mode 100644 docs/dws/api-ref/ListAlarmStatistic.html create mode 100644 docs/dws/api-ref/ListAlarmSubs.html create mode 100644 docs/dws/api-ref/ListAuditLog.html create mode 100644 docs/dws/api-ref/ListAvailabilityZones.html create mode 100644 docs/dws/api-ref/ListClusterActions.html create mode 100644 docs/dws/api-ref/ListClusterCn.html create mode 100644 docs/dws/api-ref/ListClusterDetails.html create mode 100644 docs/dws/api-ref/ListClusterEndpoints.html create mode 100644 docs/dws/api-ref/ListClusterNodes.html create mode 100644 docs/dws/api-ref/ListClusterScaleInNumbers.html create mode 100644 docs/dws/api-ref/ListClusterSnapshots.html create mode 100644 docs/dws/api-ref/ListClusterTags.html create mode 100644 docs/dws/api-ref/ListClusterWorkload.html create mode 100644 docs/dws/api-ref/ListClusters.html create mode 100644 docs/dws/api-ref/ListDssPools.html create mode 100644 docs/dws/api-ref/ListElbs.html create mode 100644 docs/dws/api-ref/ListEventSpecs.html create mode 100644 docs/dws/api-ref/ListEventSubs.html create mode 100644 docs/dws/api-ref/ListEvents.html create mode 100644 docs/dws/api-ref/ListJobDetails.html create mode 100644 docs/dws/api-ref/ListLogicalClusterRings.html create mode 100644 docs/dws/api-ref/ListLogicalClusterTasks.html create mode 100644 docs/dws/api-ref/ListLogicalClusterVolumes.html create mode 100644 docs/dws/api-ref/ListLogicalClusters.html create mode 100644 docs/dws/api-ref/ListLtsLogs.html create mode 100644 docs/dws/api-ref/ListNodeTypes.html create mode 100644 docs/dws/api-ref/ListPlanExecLogs.html create mode 100644 docs/dws/api-ref/ListRedistributionSchema.html create mode 100644 docs/dws/api-ref/ListSchemas.html create mode 100644 docs/dws/api-ref/ListSnapshotDetails.html create mode 100644 docs/dws/api-ref/ListSnapshotFlavorInfo.html create mode 100644 docs/dws/api-ref/ListSnapshotPolicy.html create mode 100644 docs/dws/api-ref/ListSnapshotStatistics.html create mode 100644 docs/dws/api-ref/ListSnapshots.html create mode 100644 docs/dws/api-ref/ListTags.html create mode 100644 docs/dws/api-ref/ListTagsForResource.html create mode 100644 docs/dws/api-ref/ListTargetFlavors.html create mode 100644 docs/dws/api-ref/ListTopoRings.html create mode 100644 docs/dws/api-ref/ListWorkloadPlans.html create mode 100644 docs/dws/api-ref/ListWorkloadQueue.html create mode 100644 docs/dws/api-ref/ListWorkloadQueueUsers.html create mode 100644 docs/dws/api-ref/ListWorkloadRules.html create mode 100644 docs/dws/api-ref/ModifyClusterName.html create mode 100644 docs/dws/api-ref/ModifyClusterTimezone.html create mode 100644 docs/dws/api-ref/ResetPassword.html create mode 100644 docs/dws/api-ref/ResizeCluster.html create mode 100644 docs/dws/api-ref/ResizeClusterWithExistedNodes.html create mode 100644 docs/dws/api-ref/RestartCluster.html create mode 100644 docs/dws/api-ref/RestartLogicalCluster.html create mode 100644 docs/dws/api-ref/RestoreCluster.html create mode 100644 docs/dws/api-ref/RestoreRedistribution.html create mode 100644 docs/dws/api-ref/RestoreTable.html create mode 100644 docs/dws/api-ref/SaveClusterDescriptionInfo.html create mode 100644 docs/dws/api-ref/SetRedistributionPriority.html create mode 100644 docs/dws/api-ref/ShowClusterFlavor.html create mode 100644 docs/dws/api-ref/ShowClusterRedistribution.html create mode 100644 docs/dws/api-ref/ShowClusterStorageExpandRange.html create mode 100644 docs/dws/api-ref/ShowClusterVolume.html create mode 100644 docs/dws/api-ref/ShowClusters.html create mode 100644 docs/dws/api-ref/ShowInstance.html create mode 100644 docs/dws/api-ref/ShowResourceStatistics.html create mode 100644 docs/dws/api-ref/ShowWorkloadPlan.html create mode 100644 docs/dws/api-ref/ShowWorkloadPlanStage.html create mode 100644 docs/dws/api-ref/ShowWorkloadQueue.html create mode 100644 docs/dws/api-ref/ShrinkCluster.html create mode 100644 docs/dws/api-ref/ShrinkLogicalCluster.html create mode 100644 docs/dws/api-ref/StartCluster.html create mode 100644 docs/dws/api-ref/StartWorkloadPlan.html create mode 100644 docs/dws/api-ref/StopCluster.html create mode 100644 docs/dws/api-ref/StopRedistribution.html create mode 100644 docs/dws/api-ref/StopWorkloadPlan.html create mode 100644 docs/dws/api-ref/SwitchOverCluster.html create mode 100644 docs/dws/api-ref/SwitchPlanStage.html create mode 100644 docs/dws/api-ref/UpdateAlarmSub.html create mode 100644 docs/dws/api-ref/UpdateClusterDns.html create mode 100644 docs/dws/api-ref/UpdateEventSub.html create mode 100644 docs/dws/api-ref/UpdateLogicalCluster.html create mode 100644 docs/dws/api-ref/UpdateQueueResources.html create mode 100644 docs/dws/api-ref/UpdateRedistributionConfigurations.html create mode 100644 docs/dws/api-ref/UpdateSchemas.html create mode 100644 docs/dws/api-ref/UpdateWorkloadPlanStage.html create mode 100644 docs/dws/api-ref/UpdateWorkloadRule.html delete mode 100644 docs/dws/api-ref/dws_02_0018.html delete mode 100644 docs/dws/api-ref/dws_02_0019.html delete mode 100644 docs/dws/api-ref/dws_02_0020.html delete mode 100644 docs/dws/api-ref/dws_02_0021.html delete mode 100644 docs/dws/api-ref/dws_02_0022.html delete mode 100644 docs/dws/api-ref/dws_02_0024.html delete mode 100644 docs/dws/api-ref/dws_02_0025.html delete mode 100644 docs/dws/api-ref/dws_02_0027.html delete mode 100644 docs/dws/api-ref/dws_02_0032.html delete mode 100644 docs/dws/api-ref/dws_02_0045.html delete mode 100644 docs/dws/api-ref/dws_02_0047.html delete mode 100644 docs/dws/api-ref/dws_02_0048.html delete mode 100644 docs/dws/api-ref/dws_02_0049.html delete mode 100644 docs/dws/api-ref/dws_02_0050.html delete mode 100644 docs/dws/api-ref/dws_02_0052.html delete mode 100644 docs/dws/api-ref/dws_02_0053.html delete mode 100644 docs/dws/api-ref/dws_02_0054.html delete mode 100644 docs/dws/api-ref/dws_02_0055.html delete mode 100644 docs/dws/api-ref/dws_02_0056.html create mode 100644 docs/dws/api-ref/dws_02_0061.html create mode 100644 docs/dws/api-ref/dws_02_0525.html create mode 100644 docs/dws/api-ref/dws_02_0536.html create mode 100644 docs/dws/api-ref/dws_02_0538.html create mode 100644 docs/dws/api-ref/dws_02_0544.html create mode 100644 docs/dws/api-ref/dws_02_0552.html create mode 100644 docs/dws/api-ref/dws_02_0554.html create mode 100644 docs/dws/api-ref/dws_02_0563.html create mode 100644 docs/dws/api-ref/dws_02_0604.html create mode 100644 docs/dws/api-ref/dws_02_0605.html create mode 100644 docs/dws/api-ref/dws_02_0799.html delete mode 100644 docs/dws/api-ref/figure/en-us_image_0000001185833158.png delete mode 100644 docs/dws/api-ref/figure/en-us_image_0000001231472779.png delete mode 100644 docs/dws/api-ref/figure/en-us_image_0000002138022226.png create mode 100644 docs/dws/api-ref/figure/en-us_image_0000002500014136.png create mode 100644 docs/dws/api-ref/figure/en-us_image_0000002531894007.png create mode 100644 docs/dws/api-ref/figure/en-us_image_0000002531894009.png rename docs/dws/api-ref/figure/{en-us_image_0000001186151638.jpg => en-us_image_0000002531894011.jpg} (100%) diff --git a/docs/dws/api-ref/ALL_META.TXT.json b/docs/dws/api-ref/ALL_META.TXT.json index a01b2c923..467054adf 100644 --- a/docs/dws/api-ref/ALL_META.TXT.json +++ b/docs/dws/api-ref/ALL_META.TXT.json @@ -4,10 +4,10 @@ }, { "uri":"dws_02_0057.html", - "node_id":"en-us_topic_0000001231391265.xml", + "node_id":"en-us_topic_0000002500014116.xml", "product_code":"dws", "code":"1", - "des":"Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and ", + "des":"Welcome to DWS. DWS is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and supports online cl", "doc_type":"api", "kw":"Before You Start,API Reference", "search_title":"", @@ -23,10 +23,10 @@ }, { "uri":"dws_02_0034.html", - "node_id":"en-us_topic_0000001231631313.xml", + "node_id":"en-us_topic_0000002500013986.xml", "product_code":"dws", "code":"2", - "des":"You can use the following GaussDB(DWS) functions with the APIs.", + "des":"DWS provides in-house APIs. The following table lists the key functions of DWS APIs. For details about other APIs, see the corresponding sections.", "doc_type":"api", "kw":"API Overview,API Reference", "search_title":"", @@ -42,7 +42,7 @@ }, { "uri":"dws_02_0062.html", - "node_id":"en-us_topic_0000001186151620.xml", + "node_id":"en-us_topic_0000002531893913.xml", "product_code":"dws", "code":"3", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -52,7 +52,8 @@ "metedata":[ { "documenttype":"api", - "prodname":"dws" + "prodname":"dws", + "opensource":"true" } ], "title":"Calling APIs", @@ -60,10 +61,10 @@ }, { "uri":"dws_02_0063.html", - "node_id":"en-us_topic_0000001185673174.xml", + "node_id":"en-us_topic_0000002532013929.xml", "product_code":"dws", "code":"4", - "des":"This section describes the structure of a REST API request, and describes how to call an API by obtaining a user token of the IAM service. The obtained token can then be ", + "des":"This section describes the structure of a RESTful API request, and uses the IAM API for creating an IAM user as an example to describe how to call an API.A request URI is", "doc_type":"api", "kw":"Making an API Request,Calling APIs,API Reference", "search_title":"", @@ -79,10 +80,10 @@ }, { "uri":"dws_02_0064.html", - "node_id":"en-us_topic_0000001231391263.xml", + "node_id":"en-us_topic_0000002500174024.xml", "product_code":"dws", "code":"5", - "des":"Calling an API can be authenticated using tokens.A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added", + "des":"You can use either of the following authentication methods when calling APIs:AK/SK authentication: Requests are encrypted using an AK/SK.Token authentication: Requests ar", "doc_type":"api", "kw":"Authentication,Calling APIs,API Reference", "search_title":"", @@ -98,10 +99,10 @@ }, { "uri":"dws_02_0065.html", - "node_id":"en-us_topic_0000001185833138.xml", + "node_id":"en-us_topic_0000002532013977.xml", "product_code":"dws", "code":"6", - "des":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", + "des":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", "doc_type":"api", "kw":"Response,Calling APIs,API Reference", "search_title":"", @@ -117,10 +118,10 @@ }, { "uri":"dws_02_0036.html", - "node_id":"en-us_topic_0000001231272819.xml", + "node_id":"en-us_topic_0000002532014021.xml", "product_code":"dws", "code":"7", - "des":"This section describes how to use GaussDB(DWS) APIs to manage clusters. The procedure of the management clusters is as follows:Call the API in Authentication to obtain th", + "des":"This section describes how to use DWS APIs to manage clusters. The procedure of the management clusters is as follows:Call the API in Authentication to obtain the user to", "doc_type":"api", "kw":"Getting Started,API Reference", "search_title":"", @@ -136,7 +137,7 @@ }, { "uri":"dws_02_0037.html", - "node_id":"en-us_topic_0000001231631319.xml", + "node_id":"en-us_topic_0000002500174050.xml", "product_code":"dws", "code":"8", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -154,295 +155,2690 @@ "githuburl":"" }, { - "uri":"dws_02_0017.html", - "node_id":"en-us_topic_0000001231472771.xml", - "product_code":"dws", + "uri":"dws_02_0552.html", + "node_id":"en-us_topic_0000002500174006.xml", + "product_code":"DWS", "code":"9", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", + "kw":"AZ Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"AZ Management", + "githuburl":"" + }, + { + "uri":"ListAvailabilityZones.html", + "node_id":"en-us_topic_0000002500174076.xml", + "product_code":"DWS", + "code":"10", + "des":"This API is used to query the ID of the AZ, which you will need to create an instance.For details, see Calling APIs.GET /v1.0/{project_id}/availability-zonesNoneStatus co", + "doc_type":"api", + "kw":"Querying the AZ List,AZ Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListAvailabilityZones" + } + ], + "title":"Querying the AZ List", + "githuburl":"" + }, + { + "uri":"dws_02_0017.html", + "node_id":"en-us_topic_0000002531893867.xml", + "product_code":"DWS", + "code":"11", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", "kw":"Cluster Management", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS" } ], "title":"Cluster Management", "githuburl":"" }, { - "uri":"dws_02_0020.html", - "node_id":"en-us_topic_0000001231272825.xml", - "product_code":"dws", - "code":"10", - "des":"This API is used to create clusters.The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.This API is an as", + "uri":"ListNodeTypes.html", + "node_id":"en-us_topic_0000002500174000.xml", + "product_code":"DWS", + "code":"12", + "des":"This API is used to query flavors supported by GaussDB(DWS).For details, see Calling APIs.GET /v2/{project_id}/node-typesNoneStatus code: 200Query flavor information.Stat", "doc_type":"api", - "kw":"Creating a Cluster,Cluster Management,API Reference", + "kw":"Querying Flavor Information,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ListNodeTypes" } ], - "title":"Creating a Cluster", + "title":"Querying Flavor Information", "githuburl":"" }, { - "uri":"dws_02_0018.html", - "node_id":"en-us_topic_0000001185833140.xml", - "product_code":"dws", - "code":"11", - "des":"This API is used to query and display the cluster list.None", + "uri":"ShowClusters.html", + "node_id":"en-us_topic_0000002532013987.xml", + "product_code":"DWS", + "code":"13", + "des":"This API is used to query and display the cluster list.For details, see Calling APIs.GET /v2/{project_id}/clustersNoneStatus code: 200Query the cluster list.Status code: ", + "doc_type":"api", + "kw":"Querying the Cluster List (V2),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowClusters" + } + ], + "title":"Querying the Cluster List (V2)", + "githuburl":"" + }, + { + "uri":"ListTagsForResource.html", + "node_id":"en-us_topic_0000002531893971.xml", + "product_code":"DWS", + "code":"14", + "des":"This API is used to query the enterprise project information of a specified cluster.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/enterprise-pr", + "doc_type":"api", + "kw":"Querying the Enterprise Project Information of a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListTagsForResource" + } + ], + "title":"Querying the Enterprise Project Information of a Cluster", + "githuburl":"" + }, + { + "uri":"ListClusters.html", + "node_id":"en-us_topic_0000002532013917.xml", + "product_code":"DWS", + "code":"15", + "des":"This API is used to query the cluster list.For details, see Calling APIs.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the cluster list.Status code: 200Cluster", "doc_type":"api", "kw":"Querying the Cluster List,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ListClusters" } ], "title":"Querying the Cluster List", "githuburl":"" }, { - "uri":"dws_02_0019.html", - "node_id":"en-us_topic_0000001185991702.xml", - "product_code":"dws", - "code":"12", - "des":"This API is used to query cluster details.None", + "uri":"ListClusterDetails.html", + "node_id":"en-us_topic_0000002532013945.xml", + "product_code":"DWS", + "code":"16", + "des":"This API is used to query cluster details.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200Query cluster details.Status code:", "doc_type":"api", "kw":"Querying Cluster Details,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ListClusterDetails" } ], "title":"Querying Cluster Details", "githuburl":"" }, { - "uri":"dws_02_0022.html", - "node_id":"en-us_topic_0000001231472761.xml", - "product_code":"dws", - "code":"13", - "des":"This API is used to query the node types supported by GaussDB(DWS).None", + "uri":"CreateCluster.html", + "node_id":"en-us_topic_0000002500174070.xml", + "product_code":"DWS", + "code":"17", + "des":"This API is used to create a cluster.The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.This API is an a", "doc_type":"api", - "kw":"Querying the Supported Node Types,Cluster Management,API Reference", + "kw":"Creating a Cluster,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"CreateCluster" } ], - "title":"Querying the Supported Node Types", + "title":"Creating a Cluster", "githuburl":"" }, { - "uri":"dws_02_0021.html", - "node_id":"en-us_topic_0000001185991698.xml", - "product_code":"dws", - "code":"14", - "des":"This API is used to delete clusters. All resources of the deleted cluster, including customer data, will be released. For data security, create a snapshot for the cluster", + "uri":"CheckCluster.html", + "node_id":"en-us_topic_0000002532013923.xml", + "product_code":"DWS", + "code":"18", + "des":"This API is used to perform a pre-check before cluster creation. It can identify problems such as insufficient subnets and quotas in advance, preventing cluster creation ", "doc_type":"api", - "kw":"Deleting a Cluster,Cluster Management,API Reference", + "kw":"Performing a Check Before Cluster Creation,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"CheckCluster" } ], - "title":"Deleting a Cluster", + "title":"Performing a Check Before Cluster Creation", "githuburl":"" }, { - "uri":"dws_02_0052.html", - "node_id":"en-us_topic_0000001231272815.xml", - "product_code":"dws", - "code":"15", - "des":"This API is used to restart clusters.NoneNone", + "uri":"CreateClusterV2.html", + "node_id":"en-us_topic_0000002531893893.xml", + "product_code":"DWS", + "code":"19", + "des":"This API is used to create a cluster.The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.This API is an a", + "doc_type":"api", + "kw":"Creating a Cluster (V2),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateClusterV2" + } + ], + "title":"Creating a Cluster (V2)", + "githuburl":"" + }, + { + "uri":"RestartCluster.html", + "node_id":"en-us_topic_0000002532013939.xml", + "product_code":"DWS", + "code":"20", + "des":"This API is used to restart a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/restartStatus code: 200The request for restarting the cl", "doc_type":"api", "kw":"Restarting a Cluster,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"RestartCluster" } ], "title":"Restarting a Cluster", "githuburl":"" }, { - "uri":"dws_02_0053.html", - "node_id":"en-us_topic_0000001231472767.xml", - "product_code":"dws", - "code":"16", - "des":"This API is used to scale out a cluster.NoneAn example of the scale_out API is as follows:POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-", - "doc_type":"api", - "kw":"Scaling Out a Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"dws", - "opensource":"true" - } - ], - "title":"Scaling Out a Cluster", - "githuburl":"" - }, - { - "uri":"dws_02_0054.html", - "node_id":"en-us_topic_0000001186151628.xml", - "product_code":"dws", - "code":"17", - "des":"This API is used to reset the password of cluster administrator.None", + "uri":"ResetPassword.html", + "node_id":"en-us_topic_0000002531893873.xml", + "product_code":"DWS", + "code":"21", + "des":"This API is used to reset the administrator password of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/reset-passwordStatus code: 2", "doc_type":"api", "kw":"Resetting a Password,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ResetPassword" } ], "title":"Resetting a Password", "githuburl":"" }, { - "uri":"dws_02_0023.html", - "node_id":"en-us_topic_0000001231631321.xml", - "product_code":"dws", - "code":"18", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "uri":"ChangeSecurityGroup.html", + "node_id":"en-us_topic_0000002532013937.xml", + "product_code":"DWS", + "code":"22", + "des":"This API is used to modify the security group of a cluster.For details, see Calling APIs.PUT /v1/{project_id}/clusters/{cluster_id}/security-groupStatus code: 200Cluster ", "doc_type":"api", - "kw":"Snapshot Management APIs", + "kw":"Modifying the Security Group of a Cluster,Cluster Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ChangeSecurityGroup" } ], - "title":"Snapshot Management APIs", + "title":"Modifying the Security Group of a Cluster", + "githuburl":"" + }, + { + "uri":"SwitchOverCluster.html", + "node_id":"en-us_topic_0000002532013961.xml", + "product_code":"DWS", + "code":"23", + "des":"In the Unbalanced state, the number of primary instances on some nodes increases. As a result, the load pressure is high. In this case, the cluster is normal, but the ove", + "doc_type":"api", + "kw":"Performing a Switchback,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"SwitchOverCluster" + } + ], + "title":"Performing a Switchback", + "githuburl":"" + }, + { + "uri":"CancelReadonlyCluster.html", + "node_id":"en-us_topic_0000002532013913.xml", + "product_code":"DWS", + "code":"24", + "des":"This API is used to cancel the read-only status on the management console. When a cluster is in the read-only state, you cannot perform any database operations. The read-", + "doc_type":"api", + "kw":"Canceling Read-only Status of a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CancelReadonlyCluster" + } + ], + "title":"Canceling Read-only Status of a Cluster", + "githuburl":"" + }, + { + "uri":"ListTopoRings.html", + "node_id":"en-us_topic_0000002531893875.xml", + "product_code":"DWS", + "code":"25", + "des":"This API is used to query ring node information in the cluster topology.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/topo/ringsNoneStatus code", + "doc_type":"api", + "kw":"Querying Ring Node Information in the Cluster Topology,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListTopoRings" + } + ], + "title":"Querying Ring Node Information in the Cluster Topology", + "githuburl":"" + }, + { + "uri":"StopCluster.html", + "node_id":"en-us_topic_0000002532013941.xml", + "product_code":"DWS", + "code":"26", + "des":"This API is used to stop a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/stopNoneStatus code: 200Stop a cluster.Status code: 200The re", + "doc_type":"api", + "kw":"Stopping a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"StopCluster" + } + ], + "title":"Stopping a Cluster", + "githuburl":"" + }, + { + "uri":"StartCluster.html", + "node_id":"en-us_topic_0000002532013947.xml", + "product_code":"DWS", + "code":"27", + "des":"This API is used to start a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/startNoneStatus code: 200Start a cluster.Status code: 200Req", + "doc_type":"api", + "kw":"Starting a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"StartCluster" + } + ], + "title":"Starting a Cluster", + "githuburl":"" + }, + { + "uri":"ModifyClusterTimezone.html", + "node_id":"en-us_topic_0000002500173994.xml", + "product_code":"DWS", + "code":"28", + "des":"This API is used to change the time zone of a cluster. This operation will change the time zone of the OS as well as the database.ConstraintsTo change the time zone of a ", + "doc_type":"api", + "kw":"Changing Cluster Time Zone,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ModifyClusterTimezone" + } + ], + "title":"Changing Cluster Time Zone", + "githuburl":"" + }, + { + "uri":"DeleteCluster.html", + "node_id":"en-us_topic_0000002500173970.xml", + "product_code":"DWS", + "code":"29", + "des":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot fo", + "doc_type":"api", + "kw":"Deleting a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteCluster" + } + ], + "title":"Deleting a Cluster", + "githuburl":"" + }, + { + "uri":"DeleteDwsCluster.html", + "node_id":"en-us_topic_0000002500174064.xml", + "product_code":"DWS", + "code":"30", + "des":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot fo", + "doc_type":"api", + "kw":"Deleting a Cluster (V2),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteDwsCluster" + } + ], + "title":"Deleting a Cluster (V2)", + "githuburl":"" + }, + { + "uri":"ListDssPools.html", + "node_id":"en-us_topic_0000002500014050.xml", + "product_code":"DWS", + "code":"31", + "des":"This API is used to query the list of DSS storage pools. Only SSD dedicated resource pools that you enabled can be queried.For details, see Calling APIs.GET /v1.0/{projec", + "doc_type":"api", + "kw":"Querying the DSS Storage Pool List,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListDssPools" + } + ], + "title":"Querying the DSS Storage Pool List", + "githuburl":"" + }, + { + "uri":"ShowClusterFlavor.html", + "node_id":"en-us_topic_0000002500174090.xml", + "product_code":"DWS", + "code":"32", + "des":"This API is used to query flavor details of a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/flavorNoneStatus code: 200Query the cluster", + "doc_type":"api", + "kw":"Querying Flavor Details of a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowClusterFlavor" + } + ], + "title":"Querying Flavor Details of a Cluster", + "githuburl":"" + }, + { + "uri":"SaveClusterDescriptionInfo.html", + "node_id":"en-us_topic_0000002532014019.xml", + "product_code":"DWS", + "code":"33", + "des":"This API is used to modify the cluster description.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/descriptionStatus code: 200Modify the cluster", + "doc_type":"api", + "kw":"Modifying Cluster Description,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"SaveClusterDescriptionInfo" + } + ], + "title":"Modifying Cluster Description", + "githuburl":"" + }, + { + "uri":"ShowInstance.html", + "node_id":"en-us_topic_0000002500014048.xml", + "product_code":"DWS", + "code":"34", + "des":"This API is used to query details about a single instance.For details, see Calling APIs.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Query information ", + "doc_type":"api", + "kw":"Querying an Instance,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowInstance" + } + ], + "title":"Querying an Instance", + "githuburl":"" + }, + { + "uri":"ShowResourceStatistics.html", + "node_id":"en-us_topic_0000002531893953.xml", + "product_code":"DWS", + "code":"35", + "des":"This API is used to query resource statistics.For details, see Calling APIs.GET /v1/{project_id}/resource-statisticsNoneStatus code: 200Query resource statistics.Status c", + "doc_type":"api", + "kw":"Querying Resource Statistics,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowResourceStatistics" + } + ], + "title":"Querying Resource Statistics", + "githuburl":"" + }, + { + "uri":"ShowClusterVolume.html", + "node_id":"en-us_topic_0000002531893949.xml", + "product_code":"DWS", + "code":"36", + "des":"This API is used to query the disk usage of a tenant management node.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/volumeNoneStatus code: 200Qu", + "doc_type":"api", + "kw":"Querying Disk Usage,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowClusterVolume" + } + ], + "title":"Querying Disk Usage", + "githuburl":"" + }, + { + "uri":"ModifyClusterName.html", + "node_id":"en-us_topic_0000002532014013.xml", + "product_code":"DWS", + "code":"37", + "des":"This API is used to change a cluster name.ConstraintsThis parameter is available only for GuestAgent 8.3.1 or later.For details, see Calling APIs.PUT /v1/{project_id}/clu", + "doc_type":"api", + "kw":"Changing a Cluster Name,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ModifyClusterName" + } + ], + "title":"Changing a Cluster Name", "githuburl":"" }, { "uri":"dws_02_0026.html", - "node_id":"en-us_topic_0000001185673172.xml", - "product_code":"dws", - "code":"19", - "des":"This API is used to create snapshots for a specified cluster.", + "node_id":"en-us_topic_0000002532013965.xml", + "product_code":"DWS", + "code":"38", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Creating a Snapshot,Snapshot Management APIs,API Reference", + "kw":"Node Change", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS" + } + ], + "title":"Node Change", + "githuburl":"" + }, + { + "uri":"ExpandInstanceStorage.html", + "node_id":"en-us_topic_0000002500014126.xml", + "product_code":"DWS", + "code":"39", + "des":"Disk capacity is more likely to become the bottleneck of storage as workloads develop. When other resources are sufficient, disk capacity expansion can help you quickly b", + "doc_type":"api", + "kw":"Expanding Disk Capacity,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ExpandInstanceStorage" + } + ], + "title":"Expanding Disk Capacity", + "githuburl":"" + }, + { + "uri":"ShowClusterStorageExpandRange.html", + "node_id":"en-us_topic_0000002531893935.xml", + "product_code":"DWS", + "code":"40", + "des":"This API is used to query capacity range that a disk can be expanded to.ConstraintsDisk capacity expansion can be performed only for cloud data warehouses using SSD or hy", + "doc_type":"api", + "kw":"Querying the Disk Capacity Expansion Range,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowClusterStorageExpandRange" + } + ], + "title":"Querying the Disk Capacity Expansion Range", + "githuburl":"" + }, + { + "uri":"ListTargetFlavors.html", + "node_id":"en-us_topic_0000002531893899.xml", + "product_code":"DWS", + "code":"41", + "des":"This API is used to query the list of flavors that a cluster can be changed to. A maximum of 20 flavors can be returned.ConstraintsIf cluster_id is not specified, all fla", + "doc_type":"api", + "kw":"Querying the List of Target Flavors That a Cluster Can Be Changed To,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListTargetFlavors" + } + ], + "title":"Querying the List of Target Flavors That a Cluster Can Be Changed To", + "githuburl":"" + }, + { + "uri":"ListClusterCn.html", + "node_id":"en-us_topic_0000002531893895.xml", + "product_code":"DWS", + "code":"42", + "des":"This API is used to query the CN node list of a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/cnsNoneStatus code: 200Query CN node li", + "doc_type":"api", + "kw":"Querying CN Nodes of a Cluster,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListClusterCn" + } + ], + "title":"Querying CN Nodes of a Cluster", + "githuburl":"" + }, + { + "uri":"BatchCreateClusterCn.html", + "node_id":"en-us_topic_0000002500174030.xml", + "product_code":"DWS", + "code":"43", + "des":"After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.Other O&M operations cannot be performed durin", + "doc_type":"api", + "kw":"Adding CN Nodes in Batches,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"BatchCreateClusterCn" + } + ], + "title":"Adding CN Nodes in Batches", + "githuburl":"" + }, + { + "uri":"BatchDeleteClusterCn.html", + "node_id":"en-us_topic_0000002531893885.xml", + "product_code":"DWS", + "code":"44", + "des":"After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.Other O&M operations cannot be performed durin", + "doc_type":"api", + "kw":"Deleting CN Nodes in Batches,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"BatchDeleteClusterCn" + } + ], + "title":"Deleting CN Nodes in Batches", + "githuburl":"" + }, + { + "uri":"ResizeCluster.html", + "node_id":"en-us_topic_0000002531893977.xml", + "product_code":"DWS", + "code":"45", + "des":"This API is used to scale out a cluster or add idle nodes. By default, scale-out is performed.You can configure create_node_only to determine whether the current operatio", + "doc_type":"api", + "kw":"Scaling Out a Cluster,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ResizeCluster" + } + ], + "title":"Scaling Out a Cluster", + "githuburl":"" + }, + { + "uri":"CheckGrowCluster.html", + "node_id":"en-us_topic_0000002532013891.xml", + "product_code":"DWS", + "code":"46", + "des":"This API is used to conduct a precheck for cluster scale-out to identify failures caused by insufficient subnets or permissions.For details, see Calling APIs.POST /v2/{pr", + "doc_type":"api", + "kw":"Performing a Scale-Out Check,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CheckGrowCluster" + } + ], + "title":"Performing a Scale-Out Check", + "githuburl":"" + }, + { + "uri":"ResizeClusterWithExistedNodes.html", + "node_id":"en-us_topic_0000002531893991.xml", + "product_code":"DWS", + "code":"47", + "des":"This API is used to scale out a cluster with idle nodes.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/resize-with-existed-nodesStatus code: 20", + "doc_type":"api", + "kw":"Scaling Out a Cluster with Idle Nodes,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ResizeClusterWithExistedNodes" + } + ], + "title":"Scaling Out a Cluster with Idle Nodes", + "githuburl":"" + }, + { + "uri":"ListClusterNodes.html", + "node_id":"en-us_topic_0000002500174018.xml", + "product_code":"DWS", + "code":"48", + "des":"This API is used to query the node list.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/nodesNoneStatus code: 200Query the node list.GET https://", + "doc_type":"api", + "kw":"Querying the Node List,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListClusterNodes" + } + ], + "title":"Querying the Node List", + "githuburl":"" + }, + { + "uri":"DeleteClusterNodes.html", + "node_id":"en-us_topic_0000002500014074.xml", + "product_code":"DWS", + "code":"49", + "des":"This API is used to delete idle nodes.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/nodes/deleteStatus code: 202Delete idle nodes.Status code:", + "doc_type":"api", + "kw":"Deleting Idle Nodes,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteClusterNodes" + } + ], + "title":"Deleting Idle Nodes", + "githuburl":"" + }, + { + "uri":"ExecuteRedistributionCluster.html", + "node_id":"en-us_topic_0000002531893879.xml", + "product_code":"DWS", + "code":"50", + "des":"This API is used to evenly distribute data from old nodes to new nodes after cluster scale-out. After data redistribution, the service response speed is greatly improved.", + "doc_type":"api", + "kw":"Performing a Redistribution Task,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ExecuteRedistributionCluster" + } + ], + "title":"Performing a Redistribution Task", + "githuburl":"" + }, + { + "uri":"ShowClusterRedistribution.html", + "node_id":"en-us_topic_0000002500014102.xml", + "product_code":"DWS", + "code":"51", + "des":"This API is used to query the monitoring information about a cluster, such as the redistribution mode, redistribution progress, and redistribution details.The redistribut", + "doc_type":"api", + "kw":"Querying Redistribution Details,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowClusterRedistribution" + } + ], + "title":"Querying Redistribution Details", + "githuburl":"" + }, + { + "uri":"UpdateRedistributionConfigurations.html", + "node_id":"en-us_topic_0000002500014006.xml", + "product_code":"DWS", + "code":"52", + "des":"This API is used to modify redistribution configurations.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/configurationsStatus code", + "doc_type":"api", + "kw":"Modifying Redistribution Configurations,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateRedistributionConfigurations" + } + ], + "title":"Modifying Redistribution Configurations", + "githuburl":"" + }, + { + "uri":"SetRedistributionPriority.html", + "node_id":"en-us_topic_0000002500174088.xml", + "product_code":"DWS", + "code":"53", + "des":"This API is used to change the priority of a redistribution table.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/priorityStatus c", + "doc_type":"api", + "kw":"Changing the Priority of a Redistribution Table,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"SetRedistributionPriority" + } + ], + "title":"Changing the Priority of a Redistribution Table", + "githuburl":"" + }, + { + "uri":"ListRedistributionSchema.html", + "node_id":"en-us_topic_0000002531893937.xml", + "product_code":"DWS", + "code":"54", + "des":"This API is used to query the schema information of the table to be redistributed.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/redistribution/", + "doc_type":"api", + "kw":"Querying the Schema Information of the Table to Be Redistributed,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListRedistributionSchema" + } + ], + "title":"Querying the Schema Information of the Table to Be Redistributed", + "githuburl":"" + }, + { + "uri":"StopRedistribution.html", + "node_id":"en-us_topic_0000002500014010.xml", + "product_code":"DWS", + "code":"55", + "des":"This API is used to suspend redistribution. After suspension, you can set the redistribution priority and change the number of concurrent redistribution tasks.This functi", + "doc_type":"api", + "kw":"Suspending Redistribution,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"StopRedistribution" + } + ], + "title":"Suspending Redistribution", + "githuburl":"" + }, + { + "uri":"ListClusterScaleInNumbers.html", + "node_id":"en-us_topic_0000002532013911.xml", + "product_code":"DWS", + "code":"56", + "des":"This API is used to query the number of nodes to be removed from a cluster for better performance.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_i", + "doc_type":"api", + "kw":"Querying the Number of Nodes to Be Removed from a Cluster for Better Performance,Node Change,API Ref", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListClusterScaleInNumbers" + } + ], + "title":"Querying the Number of Nodes to Be Removed from a Cluster for Better Performance", + "githuburl":"" + }, + { + "uri":"RestoreRedistribution.html", + "node_id":"en-us_topic_0000002500014012.xml", + "product_code":"DWS", + "code":"57", + "des":"This API is used to resume redistribution in the suspended state. It is available only for DWS 2.0.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_i", + "doc_type":"api", + "kw":"Resuming Redistribution,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"RestoreRedistribution" + } + ], + "title":"Resuming Redistribution", + "githuburl":"" + }, + { + "uri":"CheckClusterShrink.html", + "node_id":"en-us_topic_0000002500173988.xml", + "product_code":"DWS", + "code":"58", + "des":"This API is used to perform a re-scale-in check. It can ensure that the requirements are met before and after the scale-in.For details, see Calling APIs.GET /v1/{project_", + "doc_type":"api", + "kw":"Performing a Scale-in Check,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CheckClusterShrink" + } + ], + "title":"Performing a Scale-in Check", + "githuburl":"" + }, + { + "uri":"ShrinkCluster.html", + "node_id":"en-us_topic_0000002500014030.xml", + "product_code":"DWS", + "code":"59", + "des":"This API is used to scale in a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrinkStatus code: 200Scale in three nodes in t", + "doc_type":"api", + "kw":"Scaling In a Cluster,Node Change,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShrinkCluster" + } + ], + "title":"Scaling In a Cluster", + "githuburl":"" + }, + { + "uri":"dws_02_0605.html", + "node_id":"en-us_topic_0000002500173972.xml", + "product_code":"DWS", + "code":"60", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Logical Cluster Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Logical Cluster Management", + "githuburl":"" + }, + { + "uri":"ConvertToLogicalCluster.html", + "node_id":"en-us_topic_0000002532013907.xml", + "product_code":"DWS", + "code":"61", + "des":"This API is used to convert a physical cluster to a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/convert-to-logical-cluster/{", + "doc_type":"api", + "kw":"Converting a Physical Cluster to a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ConvertToLogicalCluster" + } + ], + "title":"Converting a Physical Cluster to a Logical Cluster", + "githuburl":"" + }, + { + "uri":"CreateLogicalCluster.html", + "node_id":"en-us_topic_0000002532014011.xml", + "product_code":"DWS", + "code":"62", + "des":"This API is used to create a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/logical-clustersStatus code: 200Create a logical cl", + "doc_type":"api", + "kw":"Creating a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateLogicalCluster" + } + ], + "title":"Creating a Logical Cluster", + "githuburl":"" + }, + { + "uri":"ShrinkLogicalCluster.html", + "node_id":"en-us_topic_0000002500174034.xml", + "product_code":"DWS", + "code":"63", + "des":"This API is used to scale in a logical cluster in an elastic pool.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_clus", + "doc_type":"api", + "kw":"Scaling In a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShrinkLogicalCluster" + } + ], + "title":"Scaling In a Logical Cluster", + "githuburl":"" + }, + { + "uri":"ListLogicalClusterVolumes.html", + "node_id":"en-us_topic_0000002500014094.xml", + "product_code":"DWS", + "code":"64", + "des":"This API is used to query the disk information of a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/volumesNoneS", + "doc_type":"api", + "kw":"Querying Disk Information of a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListLogicalClusterVolumes" + } + ], + "title":"Querying Disk Information of a Logical Cluster", + "githuburl":"" + }, + { + "uri":"ListLogicalClusterTasks.html", + "node_id":"en-us_topic_0000002500174028.xml", + "product_code":"DWS", + "code":"65", + "des":"This API is used to query task information about a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/tasksNoneStat", + "doc_type":"api", + "kw":"Querying Task Information About a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListLogicalClusterTasks" + } + ], + "title":"Querying Task Information About a Logical Cluster", + "githuburl":"" + }, + { + "uri":"ListLogicalClusters.html", + "node_id":"en-us_topic_0000002532013909.xml", + "product_code":"DWS", + "code":"66", + "des":"This API is used to query the logical cluster list.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clustersNoneStatus code: 200Query the ", + "doc_type":"api", + "kw":"Querying the Logical Cluster List,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListLogicalClusters" + } + ], + "title":"Querying the Logical Cluster List", + "githuburl":"" + }, + { + "uri":"ListLogicalClusterRings.html", + "node_id":"en-us_topic_0000002531893983.xml", + "product_code":"DWS", + "code":"67", + "des":"This API is used to query information about available ring nodes in a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clu", + "doc_type":"api", + "kw":"Querying Information About Available Ring Nodes in a Logical Cluster,Logical Cluster Management,API ", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListLogicalClusterRings" + } + ], + "title":"Querying Information About Available Ring Nodes in a Logical Cluster", + "githuburl":"" + }, + { + "uri":"RestartLogicalCluster.html", + "node_id":"en-us_topic_0000002500174102.xml", + "product_code":"DWS", + "code":"68", + "des":"This API is used to restart a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/restartNoneS", + "doc_type":"api", + "kw":"Restarting a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"RestartLogicalCluster" + } + ], + "title":"Restarting a Logical Cluster", + "githuburl":"" + }, + { + "uri":"DeleteLogicalCluster.html", + "node_id":"en-us_topic_0000002532013969.xml", + "product_code":"DWS", + "code":"69", + "des":"This API is used to delete a logical cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}NoneStatus c", + "doc_type":"api", + "kw":"Deleting a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteLogicalCluster" + } + ], + "title":"Deleting a Logical Cluster", + "githuburl":"" + }, + { + "uri":"UpdateLogicalCluster.html", + "node_id":"en-us_topic_0000002532013959.xml", + "product_code":"DWS", + "code":"70", + "des":"This API is used to edit a logical cluster. The API determines whether to scale out or scale in a logical cluster based on the submitted request body.Scenario 1: The orig", + "doc_type":"api", + "kw":"Editing a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateLogicalCluster" + } + ], + "title":"Editing a Logical Cluster", + "githuburl":"" + }, + { + "uri":"EnableLogicalCluster.html", + "node_id":"en-us_topic_0000002500014108.xml", + "product_code":"DWS", + "code":"71", + "des":"This API is used to control whether the function modules related to a logical cluster are displayed on the page.If the cluster is already a logical cluster, this API has ", + "doc_type":"api", + "kw":"Switching to a Logical Cluster,Logical Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"EnableLogicalCluster" + } + ], + "title":"Switching to a Logical Cluster", + "githuburl":"" + }, + { + "uri":"dws_02_0538.html", + "node_id":"en-us_topic_0000002531893891.xml", + "product_code":"DWS", + "code":"72", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Resource Management", + "githuburl":"" + }, + { + "uri":"ListClusterWorkload.html", + "node_id":"en-us_topic_0000002531894001.xml", + "product_code":"DWS", + "code":"73", + "des":"This API is used to query whether resource management is enabled.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workloadNoneStatus code: 200Quer", + "doc_type":"api", + "kw":"Querying Whether Resource Management Is Enabled,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListClusterWorkload" + } + ], + "title":"Querying Whether Resource Management Is Enabled", + "githuburl":"" + }, + { + "uri":"ListWorkloadPlans.html", + "node_id":"en-us_topic_0000002500014042.xml", + "product_code":"DWS", + "code":"74", + "des":"This API is used to query all resource management plans in a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plansNoneStatus cod", + "doc_type":"api", + "kw":"Querying the Resource Management Plan List,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListWorkloadPlans" + } + ], + "title":"Querying the Resource Management Plan List", + "githuburl":"" + }, + { + "uri":"CreateWorkloadPlan.html", + "node_id":"en-us_topic_0000002500014076.xml", + "product_code":"DWS", + "code":"75", + "des":"This API is used to create a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plansStatus code: 200Create the r", + "doc_type":"api", + "kw":"Creating a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateWorkloadPlan" + } + ], + "title":"Creating a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"ListWorkloadQueue.html", + "node_id":"en-us_topic_0000002500174106.xml", + "product_code":"DWS", + "code":"76", + "des":"This API is used to query resource pools.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queuesNoneStatus code: 200Query resource pools.", + "doc_type":"api", + "kw":"Querying Resource Pools,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListWorkloadQueue" + } + ], + "title":"Querying Resource Pools", + "githuburl":"" + }, + { + "uri":"AddWorkloadQueue.html", + "node_id":"en-us_topic_0000002500013998.xml", + "product_code":"DWS", + "code":"77", + "des":"This API is used to create a resource pool.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/queuesStatus code: 200Create a resource pool ", + "doc_type":"api", + "kw":"Creating a Resource Pool,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"AddWorkloadQueue" + } + ], + "title":"Creating a Resource Pool", + "githuburl":"" + }, + { + "uri":"StopWorkloadPlan.html", + "node_id":"en-us_topic_0000002532013951.xml", + "product_code":"DWS", + "code":"78", + "des":"This API is used to stop a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stopNoneStatus code", + "doc_type":"api", + "kw":"Stopping a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"StopWorkloadPlan" + } + ], + "title":"Stopping a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"ShowWorkloadPlan.html", + "node_id":"en-us_topic_0000002500174002.xml", + "product_code":"DWS", + "code":"79", + "des":"This API is used to query details about a resource management plan.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}NoneSt", + "doc_type":"api", + "kw":"Querying Details About a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowWorkloadPlan" + } + ], + "title":"Querying Details About a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"DeleteWorkloadPlan.html", + "node_id":"en-us_topic_0000002531893933.xml", + "product_code":"DWS", + "code":"80", + "des":"This API is used to delete a resource management plan.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}NoneStatus code:", + "doc_type":"api", + "kw":"Deleting a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteWorkloadPlan" + } + ], + "title":"Deleting a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"StartWorkloadPlan.html", + "node_id":"en-us_topic_0000002500174046.xml", + "product_code":"DWS", + "code":"81", + "des":"This API is used start a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/startNoneStatus code:", + "doc_type":"api", + "kw":"Starting a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"StartWorkloadPlan" + } + ], + "title":"Starting a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"ListWorkloadQueueUsers.html", + "node_id":"en-us_topic_0000002531893959.xml", + "product_code":"DWS", + "code":"82", + "des":"This API is used to query the list of users bound to a resource pool.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}", + "doc_type":"api", + "kw":"Querying the List of Users Bound to a Resource Pool,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListWorkloadQueueUsers" + } + ], + "title":"Querying the List of Users Bound to a Resource Pool", + "githuburl":"" + }, + { + "uri":"ShowWorkloadQueue.html", + "node_id":"en-us_topic_0000002500014062.xml", + "product_code":"DWS", + "code":"83", + "des":"This API is used to query details about a resource pool.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}NoneStatus co", + "doc_type":"api", + "kw":"Querying Resource Pool Details,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowWorkloadQueue" + } + ], + "title":"Querying Resource Pool Details", + "githuburl":"" + }, + { + "uri":"ShowWorkloadPlanStage.html", + "node_id":"en-us_topic_0000002500174026.xml", + "product_code":"DWS", + "code":"84", + "des":"This API is used to query details stage details of resource management plan.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_", + "doc_type":"api", + "kw":"Querying Stage Details About a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ShowWorkloadPlanStage" + } + ], + "title":"Querying Stage Details About a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"DeleteWorkloadPlanStage.html", + "node_id":"en-us_topic_0000002532014015.xml", + "product_code":"DWS", + "code":"85", + "des":"This API is used to delete a stage of a resource management plan.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stag", + "doc_type":"api", + "kw":"Deleting a Stage of Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteWorkloadPlanStage" + } + ], + "title":"Deleting a Stage of Resource Management Plan", + "githuburl":"" + }, + { + "uri":"UpdateWorkloadPlanStage.html", + "node_id":"en-us_topic_0000002500174094.xml", + "product_code":"DWS", + "code":"86", + "des":"This API is used to modify a stage of a resource management plan.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/", + "doc_type":"api", + "kw":"Modifying a Stage of a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateWorkloadPlanStage" + } + ], + "title":"Modifying a Stage of a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"ListPlanExecLogs.html", + "node_id":"en-us_topic_0000002532013897.xml", + "product_code":"DWS", + "code":"87", + "des":"This API is used to query plan execution logs.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/logsNoneStatus code: 200St", + "doc_type":"api", + "kw":"Querying Plan Execution Logs,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListPlanExecLogs" + } + ], + "title":"Querying Plan Execution Logs", + "githuburl":"" + }, + { + "uri":"DeleteQueueUserList.html", + "node_id":"en-us_topic_0000002500174008.xml", + "product_code":"DWS", + "code":"88", + "des":"This API is used to delete a user bound to a resource pool.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/ba", + "doc_type":"api", + "kw":"Deleting a User Bound to a Resource Pool,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteQueueUserList" + } + ], + "title":"Deleting a User Bound to a Resource Pool", + "githuburl":"" + }, + { + "uri":"SwitchPlanStage.html", + "node_id":"en-us_topic_0000002500014002.xml", + "product_code":"DWS", + "code":"89", + "des":"This API is used to switch the stage of a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stag", + "doc_type":"api", + "kw":"Switching the Stage of a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"SwitchPlanStage" + } + ], + "title":"Switching the Stage of a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"AddQueueUserList.html", + "node_id":"en-us_topic_0000002532013901.xml", + "product_code":"DWS", + "code":"90", + "des":"This API is used to associate a user to a resource pool.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/batch", + "doc_type":"api", + "kw":"Associating a User to a Resource Pool,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"AddQueueUserList" + } + ], + "title":"Associating a User to a Resource Pool", + "githuburl":"" + }, + { + "uri":"UpdateQueueResources.html", + "node_id":"en-us_topic_0000002500014084.xml", + "product_code":"DWS", + "code":"91", + "des":"This API is used to modify the resource configurations of a resource pool.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_", + "doc_type":"api", + "kw":"Modifying Resource Configurations of a Resource Pool,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateQueueResources" + } + ], + "title":"Modifying Resource Configurations of a Resource Pool", + "githuburl":"" + }, + { + "uri":"ListSchemas.html", + "node_id":"en-us_topic_0000002531893993.xml", + "product_code":"DWS", + "code":"92", + "des":"This API is used to query schema space information of a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemas", + "doc_type":"api", + "kw":"Querying the Schema Space Information of a Cluster,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListSchemas" + } + ], + "title":"Querying the Schema Space Information of a Cluster", + "githuburl":"" + }, + { + "uri":"UpdateSchemas.html", + "node_id":"en-us_topic_0000002500014078.xml", + "product_code":"DWS", + "code":"93", + "des":"This API is used to edit the space limit of a schema.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemasStatus code", + "doc_type":"api", + "kw":"Editing the Space Limit of a Schema,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateSchemas" + } + ], + "title":"Editing the Space Limit of a Schema", + "githuburl":"" + }, + { + "uri":"AddWorkloadPlanStage.html", + "node_id":"en-us_topic_0000002532013895.xml", + "product_code":"DWS", + "code":"94", + "des":"This API is used to add a resource management plan stage.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stagesStatus c", + "doc_type":"api", + "kw":"Adding a Stage for a Resource Management Plan,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"AddWorkloadPlanStage" + } + ], + "title":"Adding a Stage for a Resource Management Plan", + "githuburl":"" + }, + { + "uri":"DeleteWorkloadQueue.html", + "node_id":"en-us_topic_0000002532014003.xml", + "product_code":"DWS", + "code":"95", + "des":"This API is used to delete a resource pool.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/queuesNoneStatus code: 200Status code: 200", + "doc_type":"api", + "kw":"Deleting a Resource Pool,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteWorkloadQueue" + } + ], + "title":"Deleting a Resource Pool", + "githuburl":"" + }, + { + "uri":"ListWorkloadRules.html", + "node_id":"en-us_topic_0000002532013981.xml", + "product_code":"DWS", + "code":"96", + "des":"This API is used to query the exception rule list of a cluster.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/workload/rulesNoneStatus code: 200", + "doc_type":"api", + "kw":"Querying the Exception Rule List of a Cluster,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListWorkloadRules" + } + ], + "title":"Querying the Exception Rule List of a Cluster", + "githuburl":"" + }, + { + "uri":"AddWorkloadRule.html", + "node_id":"en-us_topic_0000002532013899.xml", + "product_code":"DWS", + "code":"97", + "des":"This API is used to add an exception rule.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/workload/rulesStatus code: 200Create an exception rule", + "doc_type":"api", + "kw":"Adding an Exception Rule,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"AddWorkloadRule" + } + ], + "title":"Adding an Exception Rule", + "githuburl":"" + }, + { + "uri":"DeleteWorkloadRule.html", + "node_id":"en-us_topic_0000002500014100.xml", + "product_code":"DWS", + "code":"98", + "des":"This API is used to delete an exception rule.For details, see Calling APIs.DELETE /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}NoneStatus code: 200Del", + "doc_type":"api", + "kw":"Deleting an Exception Rule,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteWorkloadRule" + } + ], + "title":"Deleting an Exception Rule", + "githuburl":"" + }, + { + "uri":"UpdateWorkloadRule.html", + "node_id":"en-us_topic_0000002500173992.xml", + "product_code":"DWS", + "code":"99", + "des":"This API is used to edit an exception rule.For details, see Calling APIs.PUT /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}Status code: 200Edit an exce", + "doc_type":"api", + "kw":"Editing an Exception Rule,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateWorkloadRule" + } + ], + "title":"Editing an Exception Rule", + "githuburl":"" + }, + { + "uri":"CreateClusterWorkload.html", + "node_id":"en-us_topic_0000002531893883.xml", + "product_code":"DWS", + "code":"100", + "des":"This API is used to enable or disable resource management. The function is enabled by default for new clusters.For details, see Calling APIs.POST /v2/{project_id}/cluster", + "doc_type":"api", + "kw":"Enabling or Disabling Resource Management,Resource Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateClusterWorkload" + } + ], + "title":"Enabling or Disabling Resource Management", + "githuburl":"" + }, + { + "uri":"dws_02_0023.html", + "node_id":"en-us_topic_0000002500014098.xml", + "product_code":"DWS", + "code":"101", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Snapshot Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Snapshot Management", + "githuburl":"" + }, + { + "uri":"ListSnapshotStatistics.html", + "node_id":"en-us_topic_0000002500174068.xml", + "product_code":"DWS", + "code":"102", + "des":"This API is used to query snapshot statistics.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots/statisticsNoneStatus code: 200Status co", + "doc_type":"api", + "kw":"Querying Snapshot Statistics,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListSnapshotStatistics" + } + ], + "title":"Querying Snapshot Statistics", + "githuburl":"" + }, + { + "uri":"CheckTableRestore.html", + "node_id":"en-us_topic_0000002531893931.xml", + "product_code":"DWS", + "code":"103", + "des":"This API is used to check the name of the table to be restored.For details, see Calling APIs.POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore-checkStatus code:", + "doc_type":"api", + "kw":"Checking the Name of the Table to Be Restored,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CheckTableRestore" + } + ], + "title":"Checking the Name of the Table to Be Restored", + "githuburl":"" + }, + { + "uri":"RestoreTable.html", + "node_id":"en-us_topic_0000002500014082.xml", + "product_code":"DWS", + "code":"104", + "des":"This API is used to restore tables.For details, see Calling APIs.POST /v1/{project_id}/snapshots/{snapshot_id}/table-restoreStatus code: 200Status code: 200The table is s", + "doc_type":"api", + "kw":"Restoring a Table,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"RestoreTable" + } + ], + "title":"Restoring a Table", + "githuburl":"" + }, + { + "uri":"CreateSnapshot.html", + "node_id":"en-us_topic_0000002500173974.xml", + "product_code":"DWS", + "code":"105", + "des":"This API is used to create a snapshot for a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/snapshotsStatus code: 200Create a manual snapshot name", + "doc_type":"api", + "kw":"Creating a Snapshot,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateSnapshot" } ], "title":"Creating a Snapshot", "githuburl":"" }, { - "uri":"dws_02_0024.html", - "node_id":"en-us_topic_0000001186151630.xml", - "product_code":"dws", - "code":"20", - "des":"This API is used to query the snapshot list.None", + "uri":"ListSnapshots.html", + "node_id":"en-us_topic_0000002532013953.xml", + "product_code":"DWS", + "code":"106", + "des":"This API is used to query the snapshot list.For details, see Calling APIs.GET /v1.0/{project_id}/snapshotsNoneStatus code: 200Status code: 200Snapshot list queried.", "doc_type":"api", - "kw":"Querying the Snapshot List,Snapshot Management APIs,API Reference", + "kw":"Querying the Snapshot List,Snapshot Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ListSnapshots" } ], "title":"Querying the Snapshot List", "githuburl":"" }, { - "uri":"dws_02_0025.html", - "node_id":"en-us_topic_0000001185833136.xml", - "product_code":"dws", - "code":"21", - "des":"This API is used to query snapshot details by using the snapshot ID.None", + "uri":"ListClusterSnapshots.html", + "node_id":"en-us_topic_0000002532014005.xml", + "product_code":"DWS", + "code":"107", + "des":"This API is used to query the cluster snapshot list.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/snapshotsNoneStatus code: 200Status code: 2", "doc_type":"api", - "kw":"Querying Snapshot Details,Snapshot Management APIs,API Reference", + "kw":"Querying the Cluster Snapshot List,Snapshot Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"ListClusterSnapshots" + } + ], + "title":"Querying the Cluster Snapshot List", + "githuburl":"" + }, + { + "uri":"ListSnapshotPolicy.html", + "node_id":"en-us_topic_0000002532013971.xml", + "product_code":"DWS", + "code":"108", + "des":"This API is used to query a snapshot policy.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/snapshot-policiesNoneStatus code: 200Status code: 200", + "doc_type":"api", + "kw":"Querying a Snapshot Policy,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListSnapshotPolicy" + } + ], + "title":"Querying a Snapshot Policy", + "githuburl":"" + }, + { + "uri":"ListSnapshotDetails.html", + "node_id":"en-us_topic_0000002500014054.xml", + "product_code":"DWS", + "code":"109", + "des":"This API is used to query snapshot details using the snapshot ID.For details, see Calling APIs.GET /v1.0/{project_id}/snapshots/{snapshot_id}NoneStatus code: 200Status co", + "doc_type":"api", + "kw":"Querying Snapshot Details,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListSnapshotDetails" } ], "title":"Querying Snapshot Details", "githuburl":"" }, { - "uri":"dws_02_0027.html", - "node_id":"en-us_topic_0000001231631317.xml", - "product_code":"dws", - "code":"22", - "des":"This API is used to delete a specified manual snapshot.NoneNoneNone", + "uri":"DeleteSnapshotPolicy.html", + "node_id":"en-us_topic_0000002531893919.xml", + "product_code":"DWS", + "code":"110", + "des":"This API is used to delete a snapshot policy.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/snapshot-policies/{id}NoneStatus code: 200The s", "doc_type":"api", - "kw":"Deleting a Manual Snapshot,Snapshot Management APIs,API Reference", + "kw":"Deleting a Snapshot Policy,Snapshot Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"DeleteSnapshotPolicy" } ], - "title":"Deleting a Manual Snapshot", + "title":"Deleting a Snapshot Policy", "githuburl":"" }, { - "uri":"dws_02_0032.html", - "node_id":"en-us_topic_0000001186151624.xml", - "product_code":"dws", - "code":"23", - "des":"This API is used to restore clusters using the snapshot.", + "uri":"DeleteSnapshot.html", + "node_id":"en-us_topic_0000002531893871.xml", + "product_code":"DWS", + "code":"111", + "des":"This API is used to delete a manual snapshot.For details, see Calling APIs.DELETE /v1.0/{project_id}/snapshots/{snapshot_id}NoneStatus code: 202The snapshot is deleted.No", "doc_type":"api", - "kw":"Restoring a Cluster,Snapshot Management APIs,API Reference", + "kw":"Deleting a Snapshot,Snapshot Management,API Reference", "search_title":"", "metedata":[ { + "opensource":"true", "documenttype":"api", - "prodname":"dws", - "opensource":"true" + "prodname":"DWS", + "operation_id":"DeleteSnapshot" + } + ], + "title":"Deleting a Snapshot", + "githuburl":"" + }, + { + "uri":"RestoreCluster.html", + "node_id":"en-us_topic_0000002531893951.xml", + "product_code":"DWS", + "code":"112", + "des":"This API is used to restore a cluster using a snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/snapshots/{snapshot_id}/actionsStatus code: 200Restore the sn", + "doc_type":"api", + "kw":"Restoring a Cluster,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"RestoreCluster" } ], "title":"Restoring a Cluster", "githuburl":"" }, { - "uri":"dws_02_0045.html", - "node_id":"en-us_topic_0000002395330893.xml", + "uri":"ListSnapshotFlavorInfo.html", + "node_id":"en-us_topic_0000002532013973.xml", "product_code":"DWS", - "code":"24", + "code":"113", + "des":"This API is used to query flavors based on the snapshot ID. You can query the flavor of a snapshot or the flavor to which a snapshot can be restored.For details, see Call", + "doc_type":"api", + "kw":"Querying Flavors by Snapshot ID,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListSnapshotFlavorInfo" + } + ], + "title":"Querying Flavors by Snapshot ID", + "githuburl":"" + }, + { + "uri":"CopySnapshot.html", + "node_id":"en-us_topic_0000002532013905.xml", + "product_code":"DWS", + "code":"114", + "des":"This API is used to copy an automated snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/snapshots/{snapshot_id}/linked-copyStatus code: 200Copy an automated ", + "doc_type":"api", + "kw":"Copying a Snapshot,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CopySnapshot" + } + ], + "title":"Copying a Snapshot", + "githuburl":"" + }, + { + "uri":"CreateSnapshotPolicy.html", + "node_id":"en-us_topic_0000002500014020.xml", + "product_code":"DWS", + "code":"115", + "des":"This API is used to configure a snapshot policy.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/snapshot-policiesStatus code: 200Request succeede", + "doc_type":"api", + "kw":"Adding a Snapshot Policy,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateSnapshotPolicy" + } + ], + "title":"Adding a Snapshot Policy", + "githuburl":"" + }, + { + "uri":"dws_02_0554.html", + "node_id":"en-us_topic_0000002500014096.xml", + "product_code":"DWS", + "code":"116", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Connection Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Connection Management", + "githuburl":"" + }, + { + "uri":"ListClusterEndpoints.html", + "node_id":"en-us_topic_0000002532013927.xml", + "product_code":"DWS", + "code":"117", + "des":"This API is used to query connection information, including public and private domain names.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/endpo", + "doc_type":"api", + "kw":"Querying Connection Information,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListClusterEndpoints" + } + ], + "title":"Querying Connection Information", + "githuburl":"" + }, + { + "uri":"CreateClusterDns.html", + "node_id":"en-us_topic_0000002500174004.xml", + "product_code":"DWS", + "code":"118", + "des":"This API is used to apply for a domain name for a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/dnsStatus code: 200The dom", + "doc_type":"api", + "kw":"Applying for a Domain Name,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateClusterDns" + } + ], + "title":"Applying for a Domain Name", + "githuburl":"" + }, + { + "uri":"UpdateClusterDns.html", + "node_id":"en-us_topic_0000002531893905.xml", + "product_code":"DWS", + "code":"119", + "des":"This API is used to change the domain name of a specified cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/dnsStatus code: 200The cluste", + "doc_type":"api", + "kw":"Modifying a Cluster Domain Name,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateClusterDns" + } + ], + "title":"Modifying a Cluster Domain Name", + "githuburl":"" + }, + { + "uri":"DeleteClusterDns.html", + "node_id":"en-us_topic_0000002531893957.xml", + "product_code":"DWS", + "code":"120", + "des":"This API is used to delete the domain name of a specified cluster.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/dnsNoneStatus code: 200The", + "doc_type":"api", + "kw":"Deleting a Cluster Domain Name,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteClusterDns" + } + ], + "title":"Deleting a Cluster Domain Name", + "githuburl":"" + }, + { + "uri":"ListElbs.html", + "node_id":"en-us_topic_0000002500174066.xml", + "product_code":"DWS", + "code":"121", + "des":"This API is used to query the list of ELBs that can be bound to a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/elbsNoneStatus code: 20", + "doc_type":"api", + "kw":"Querying the List of ELBs That Can Be Bound to a Cluster,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListElbs" + } + ], + "title":"Querying the List of ELBs That Can Be Bound to a Cluster", + "githuburl":"" + }, + { + "uri":"AssociateElb.html", + "node_id":"en-us_topic_0000002531893901.xml", + "product_code":"DWS", + "code":"122", + "des":"This API is used to bind an ELB to a cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}NoneStatus code: 200Status code: 200Re", + "doc_type":"api", + "kw":"Binding an ELB to a Cluster,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"AssociateElb" + } + ], + "title":"Binding an ELB to a Cluster", + "githuburl":"" + }, + { + "uri":"DisassociateElb.html", + "node_id":"en-us_topic_0000002500174020.xml", + "product_code":"DWS", + "code":"123", + "des":"This API is used to unbind an ELB from a cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}NoneStatus code: 200Status code:", + "doc_type":"api", + "kw":"Unbinding an ELB from a Cluster,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DisassociateElb" + } + ], + "title":"Unbinding an ELB from a Cluster", + "githuburl":"" + }, + { + "uri":"AssociateEip.html", + "node_id":"en-us_topic_0000002531893963.xml", + "product_code":"DWS", + "code":"124", + "des":"This API is used to bind an EIP to a cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}NoneStatus code: 200The EIP is bound t", + "doc_type":"api", + "kw":"Binding an EIP to a Cluster,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"AssociateEip" + } + ], + "title":"Binding an EIP to a Cluster", + "githuburl":"" + }, + { + "uri":"DisassociateEip.html", + "node_id":"en-us_topic_0000002531893917.xml", + "product_code":"DWS", + "code":"125", + "des":"This API is used to unbind an EIP from a cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}NoneStatus code: 200The EIP is u", + "doc_type":"api", + "kw":"Unbinding an EIP from a Cluster,Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DisassociateEip" + } + ], + "title":"Unbinding an EIP from a Cluster", + "githuburl":"" + }, + { + "uri":"dws_02_0544.html", + "node_id":"en-us_topic_0000002531893969.xml", + "product_code":"DWS", + "code":"126", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Alarm Management", + "githuburl":"" + }, + { + "uri":"ListAlarmConfigs.html", + "node_id":"en-us_topic_0000002500014036.xml", + "product_code":"DWS", + "code":"127", + "des":"This API is used to query alarm configurations.For details, see Calling APIs.GET /v2/{project_id}/alarm-configsNoneStatus code: 200Status code: 200Alarm configurations qu", + "doc_type":"api", + "kw":"Querying Alarm Configurations,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListAlarmConfigs" + } + ], + "title":"Querying Alarm Configurations", + "githuburl":"" + }, + { + "uri":"ListAlarmDetail.html", + "node_id":"en-us_topic_0000002532013993.xml", + "product_code":"DWS", + "code":"128", + "des":"This API is used to query the alarm details list.For details, see Calling APIs.GET /v2/{project_id}/alarmsNoneStatus code: 200Status code: 200Alarm details list queried.", + "doc_type":"api", + "kw":"Querying Alarm Details List,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListAlarmDetail" + } + ], + "title":"Querying Alarm Details List", + "githuburl":"" + }, + { + "uri":"ListAlarmStatistic.html", + "node_id":"en-us_topic_0000002531893909.xml", + "product_code":"DWS", + "code":"129", + "des":"This API is used to query alarm statistics.For details, see Calling APIs.GET /v2/{project_id}/alarm-statisticNoneStatus code: 200Status code: 200Alarm statistics list que", + "doc_type":"api", + "kw":"Querying the Alarm Statistics List,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListAlarmStatistic" + } + ], + "title":"Querying the Alarm Statistics List", + "githuburl":"" + }, + { + "uri":"ListAlarmSubs.html", + "node_id":"en-us_topic_0000002532013999.xml", + "product_code":"DWS", + "code":"130", + "des":"This API is used to query subscribed alarms.For details, see Calling APIs.GET /v2/{project_id}/alarm-subsNoneStatus code: 200Status code: 200Alarm subscription list queri", + "doc_type":"api", + "kw":"Querying the Alarm Subscription List,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListAlarmSubs" + } + ], + "title":"Querying the Alarm Subscription List", + "githuburl":"" + }, + { + "uri":"CreateAlarmSub.html", + "node_id":"en-us_topic_0000002500014044.xml", + "product_code":"DWS", + "code":"131", + "des":"This API is used to create an alarm subscription.For details, see Calling APIs.POST /v2/{project_id}/alarm-subsStatus code: 200Create an alarm subscription (Subscription ", + "doc_type":"api", + "kw":"Creating an Alarm Subscription,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateAlarmSub" + } + ], + "title":"Creating an Alarm Subscription", + "githuburl":"" + }, + { + "uri":"UpdateAlarmSub.html", + "node_id":"en-us_topic_0000002500013994.xml", + "product_code":"DWS", + "code":"132", + "des":"This API is used to modify an alarm subscription.For details, see Calling APIs.PUT /v2/{project_id}/alarm-subs/{alarm_sub_id}Status code: 200Modify the zrf-test-13 alarm ", + "doc_type":"api", + "kw":"Modifying an Alarm Subscription,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateAlarmSub" + } + ], + "title":"Modifying an Alarm Subscription", + "githuburl":"" + }, + { + "uri":"DeleteAlarmSub.html", + "node_id":"en-us_topic_0000002500014008.xml", + "product_code":"DWS", + "code":"133", + "des":"This API is used to delete an alarm subscription.For details, see Calling APIs.DELETE /v2/{project_id}/alarm-subs/{alarm_sub_id}NoneStatus code: 200Status code: 200Alarm ", + "doc_type":"api", + "kw":"Deleting an Alarm Subscription,Alarm Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteAlarmSub" + } + ], + "title":"Deleting an Alarm Subscription", + "githuburl":"" + }, + { + "uri":"dws_02_0525.html", + "node_id":"en-us_topic_0000002532013989.xml", + "product_code":"DWS", + "code":"134", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Event Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Event Management", + "githuburl":"" + }, + { + "uri":"ListEvents.html", + "node_id":"en-us_topic_0000002531893941.xml", + "product_code":"DWS", + "code":"135", + "des":"This API is used to query event list.For details, see Calling APIs.GET /v2/{project_id}/eventsNoneStatus code: 200Status code: 200Event list of the cluster queried.", + "doc_type":"api", + "kw":"Querying Event List,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListEvents" + } + ], + "title":"Querying Event List", + "githuburl":"" + }, + { + "uri":"ListEventSpecs.html", + "node_id":"en-us_topic_0000002500014000.xml", + "product_code":"DWS", + "code":"136", + "des":"This API is used to query event configurations.For details, see Calling APIs.GET /v2/{project_id}/event-specsNoneStatus code: 200Status code: 200Event configurations of a", + "doc_type":"api", + "kw":"Querying Event Configurations,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListEventSpecs" + } + ], + "title":"Querying Event Configurations", + "githuburl":"" + }, + { + "uri":"ListEventSubs.html", + "node_id":"en-us_topic_0000002500173984.xml", + "product_code":"DWS", + "code":"137", + "des":"This API is used to query subscribed events.For details, see Calling APIs.GET /v2/{project_id}/event-subsNoneStatus code: 200Status code: 200Subscribed events queried.", + "doc_type":"api", + "kw":"Querying Subscribed Events,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListEventSubs" + } + ], + "title":"Querying Subscribed Events", + "githuburl":"" + }, + { + "uri":"CreateEventSub.html", + "node_id":"en-us_topic_0000002500014086.xml", + "product_code":"DWS", + "code":"138", + "des":"This API is used to create an event subscription.For details, see Calling APIs.POST /v2/{project_id}/event-subsStatus code: 200Create a subscription (Subscription name zr", + "doc_type":"api", + "kw":"Creating an Event Subscription,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"CreateEventSub" + } + ], + "title":"Creating an Event Subscription", + "githuburl":"" + }, + { + "uri":"UpdateEventSub.html", + "node_id":"en-us_topic_0000002500174048.xml", + "product_code":"DWS", + "code":"139", + "des":"This API is used to modify a subscribed event.For details, see Calling APIs.PUT /v2/{project_id}/event-subs/{event_sub_id}Status code: 200Modify the zrf-test-66 event sub", + "doc_type":"api", + "kw":"Modifying a Subscribed Event,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"UpdateEventSub" + } + ], + "title":"Modifying a Subscribed Event", + "githuburl":"" + }, + { + "uri":"DeleteEventSub.html", + "node_id":"en-us_topic_0000002531893863.xml", + "product_code":"DWS", + "code":"140", + "des":"This API is used to delete a subscribed event.For details, see Calling APIs.DELETE /v2/{project_id}/event-subs/{event_sub_id}NoneStatus code: 200Status code: 200Event sub", + "doc_type":"api", + "kw":"Deleting a Subscribed Event,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DeleteEventSub" + } + ], + "title":"Deleting a Subscribed Event", + "githuburl":"" + }, + { + "uri":"dws_02_0604.html", + "node_id":"en-us_topic_0000002500173996.xml", + "product_code":"DWS", + "code":"141", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Task Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Task Management", + "githuburl":"" + }, + { + "uri":"ListJobDetails.html", + "node_id":"en-us_topic_0000002500013996.xml", + "product_code":"DWS", + "code":"142", + "des":"This API is used to query the task progress.For details, see Calling APIs.GET /v1.0/{project_id}/job/{job_id}NoneStatus code: 200Status code: 200Task progress queried.", + "doc_type":"api", + "kw":"Querying the Task Progress,Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListJobDetails" + } + ], + "title":"Querying the Task Progress", + "githuburl":"" + }, + { + "uri":"ListClusterActions.html", + "node_id":"en-us_topic_0000002500014122.xml", + "product_code":"DWS", + "code":"143", + "des":"This API is used to query cluster task details.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/actions/{action_name}NoneStatus code: 200Query det", + "doc_type":"api", + "kw":"Querying Cluster Task Details,Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListClusterActions" + } + ], + "title":"Querying Cluster Task Details", + "githuburl":"" + }, + { + "uri":"dws_02_0563.html", + "node_id":"en-us_topic_0000002531893999.xml", + "product_code":"DWS", + "code":"144", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Tag Management", @@ -457,31 +2853,13 @@ "githuburl":"" }, { - "uri":"dws_02_0055.html", - "node_id":"en-us_topic_0000001231272809.xml", - "product_code":"dws", - "code":"25", - "des":"A tag is a key-value pair customized by users and used to classify and search for cloud resources.A tag consists of a tag key and a tag value.A tag key can contain multip", - "doc_type":"api", - "kw":"Tagging,Tag Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"dws" - } - ], - "title":"Tagging", - "githuburl":"" - }, - { - "uri":"dws_02_0050.html", - "node_id":"en-us_topic_0000002361650974.xml", + "uri":"ListTags.html", + "node_id":"en-us_topic_0000002500014046.xml", "product_code":"DWS", - "code":"26", - "des":"This API is used to query the tags of a project.NoneStatus code: 200Status code: 200The project tags are queried successfully.", + "code":"145", + "des":"This API is used to query project tag list.For details, see Calling APIs.GET /v1.0/{project_id}/tagsNoneStatus code: 200Status code: 200Project tags queried.", "doc_type":"api", - "kw":"Querying Tags in a Project,Tag Management,API Reference", + "kw":"Querying Project Tags,Tag Management,API Reference", "search_title":"", "metedata":[ { @@ -491,15 +2869,15 @@ "operation_id":"ListTags" } ], - "title":"Querying Tags in a Project", + "title":"Querying Project Tags", "githuburl":"" }, { - "uri":"dws_02_0049.html", - "node_id":"en-us_topic_0000002361491110.xml", + "uri":"ListClusterTags.html", + "node_id":"en-us_topic_0000002500014110.xml", "product_code":"DWS", - "code":"27", - "des":"This API is used to query the tags of a cluster.NoneStatus code: 200Status code: 200The cluster tags are queried successfully.", + "code":"146", + "des":"This API is used to query tag information of a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/tagsNoneStatus code: 200Status code: 200", "doc_type":"api", "kw":"Querying Cluster Tags,Tag Management,API Reference", "search_title":"", @@ -515,11 +2893,11 @@ "githuburl":"" }, { - "uri":"dws_02_0047.html", - "node_id":"en-us_topic_0000002395171013.xml", + "uri":"BatchCreateResourceTag.html", + "node_id":"en-us_topic_0000002532013979.xml", "product_code":"DWS", - "code":"28", - "des":"This API is used to add tags to a cluster in batches.Status code: 200Tags are added in batches.NoneAdd tags whose key is key and value is value in batches.None", + "code":"147", + "des":"This API is used to batch add tags to a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-createStatus code: 200Tag", "doc_type":"api", "kw":"Adding Tags in Batches,Tag Management,API Reference", "search_title":"", @@ -535,13 +2913,13 @@ "githuburl":"" }, { - "uri":"dws_02_0048.html", - "node_id":"en-us_topic_0000002395330901.xml", + "uri":"BatchDeleteResourceTag.html", + "node_id":"en-us_topic_0000002532014017.xml", "product_code":"DWS", - "code":"29", - "des":"This API is used to delete tags from a cluster in batches.Status code: 200Tags are deleted in batches.NoneDelete tags whose key is key and value is value in batches.None", + "code":"148", + "des":"This API is used to delete tags from a specified cluster in batches.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-deleteStatus co", "doc_type":"api", - "kw":"Deleting Tags in Batches,Tag Management,API Reference", + "kw":"Delete Tags in Batches,Tag Management,API Reference", "search_title":"", "metedata":[ { @@ -551,17 +2929,133 @@ "operation_id":"BatchDeleteResourceTag" } ], - "title":"Deleting Tags in Batches", + "title":"Delete Tags in Batches", "githuburl":"" }, { - "uri":"dws_02_0056.html", - "node_id":"en-us_topic_0000001185673170.xml", - "product_code":"dws", - "code":"30", - "des":"This section describes fine-grained permissions management for your GaussDB(DWS) service using IAM. You can skip this section if your cloud account already satisfies your", + "uri":"dws_02_0536.html", + "node_id":"en-us_topic_0000002531893965.xml", + "product_code":"DWS", + "code":"149", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Permissions Policies and Supported Actions,API Reference", + "kw":"Audit Logs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Audit Logs", + "githuburl":"" + }, + { + "uri":"ListAuditLog.html", + "node_id":"en-us_topic_0000002500174104.xml", + "product_code":"DWS", + "code":"150", + "des":"This API is used to query audit logs.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/audit-log-recordsNoneStatus code: 200Status code: 200Query", + "doc_type":"api", + "kw":"Querying Log Records,Audit Logs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListAuditLog" + } + ], + "title":"Querying Log Records", + "githuburl":"" + }, + { + "uri":"dws_02_0799.html", + "node_id":"en-us_topic_0000002500173982.xml", + "product_code":"DWS", + "code":"151", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"DWS" + } + ], + "title":"Log Management", + "githuburl":"" + }, + { + "uri":"ListLtsLogs.html", + "node_id":"en-us_topic_0000002500014040.xml", + "product_code":"DWS", + "code":"152", + "des":"This API is used to query the LTS log list.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/lts-logsNoneStatus code: 200Status code: 200LTS log li", + "doc_type":"api", + "kw":"Obtaining the LTS Log List,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"ListLtsLogs" + } + ], + "title":"Obtaining the LTS Log List", + "githuburl":"" + }, + { + "uri":"DisableLtsLogs.html", + "node_id":"en-us_topic_0000002500014088.xml", + "product_code":"DWS", + "code":"153", + "des":"This API is used to disable LTS for a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/disableNoneStatus code: 200LTS disabled.N", + "doc_type":"api", + "kw":"Disabling LTS,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"DisableLtsLogs" + } + ], + "title":"Disabling LTS", + "githuburl":"" + }, + { + "uri":"EnableLtsLogs.html", + "node_id":"en-us_topic_0000002532013983.xml", + "product_code":"DWS", + "code":"154", + "des":"This API is used to enable LTS for a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/enableNoneStatus code: 200LTS enabled.None", + "doc_type":"api", + "kw":"Enabling LTS,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"DWS", + "operation_id":"EnableLtsLogs" + } + ], + "title":"Enabling LTS", + "githuburl":"" + }, + { + "uri":"dws_02_0061.html", + "node_id":"en-us_topic_0000002532013925.xml", + "product_code":"dws", + "code":"155", + "des":"This section describes fine-grained permissions management for your DWS service using IAM. You can skip this section if your cloud account already satisfies your needs.By", + "doc_type":"api", + "kw":"Permissions and Supported Actions,API Reference", "search_title":"", "metedata":[ { @@ -570,14 +3064,14 @@ "opensource":"true" } ], - "title":"Permissions Policies and Supported Actions", + "title":"Permissions and Supported Actions", "githuburl":"" }, { "uri":"dws_02_0066.html", - "node_id":"en-us_topic_0000001185991712.xml", + "node_id":"en-us_topic_0000002500014056.xml", "product_code":"dws", - "code":"31", + "code":"156", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -585,7 +3079,8 @@ "metedata":[ { "documenttype":"api", - "prodname":"dws" + "prodname":"dws", + "opensource":"true" } ], "title":"Appendix", @@ -593,9 +3088,9 @@ }, { "uri":"dws_02_0038.html", - "node_id":"en-us_topic_0000001231472773.xml", + "node_id":"en-us_topic_0000002531893925.xml", "product_code":"dws", - "code":"32", + "code":"157", "des":"Table 1 describes the status code.", "doc_type":"api", "kw":"Status Code,Appendix,API Reference", @@ -603,7 +3098,8 @@ "metedata":[ { "documenttype":"api", - "prodname":"dws" + "prodname":"dws", + "opensource":"true" } ], "title":"Status Code", @@ -611,9 +3107,9 @@ }, { "uri":"dws_02_0030.html", - "node_id":"en-us_topic_0000001326816266.xml", + "node_id":"en-us_topic_0000002500014024.xml", "product_code":"dws", - "code":"33", + "code":"158", "des":"No data is returned if an API fails to be called. You can locate the cause of error according to the error code of each API. When the calling fails, HTTP status code 4xx ", "doc_type":"api", "kw":"Error Code,Appendix,API Reference", @@ -630,10 +3126,10 @@ }, { "uri":"dws_02_0040.html", - "node_id":"en-us_topic_0000001231631331.xml", + "node_id":"en-us_topic_0000002500174098.xml", "product_code":"dws", - "code":"34", - "des":"Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using GaussDB(DWS).If you have already created a VPC, you do ", + "code":"159", + "des":"Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using DWS.If you have already created a VPC, you do not need ", "doc_type":"api", "kw":"Creating a VPC,Appendix,API Reference", "search_title":"", @@ -649,12 +3145,12 @@ }, { "uri":"dws_02_0011.html", - "node_id":"en-us_topic_0000001231472757.xml", + "node_id":"en-us_topic_0000002500014114.xml", "product_code":"dws", - "code":"35", - "des":"You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://", + "code":"160", + "des":"You can obtain the Project ID by calling the IAM API used to query project information based on the specified criteria.The API used to obtain a Project ID is GET https://", "doc_type":"api", - "kw":"Obtaining a Project ID,Appendix,API Reference", + "kw":"Obtaining Project ID,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -663,17 +3159,17 @@ "opensource":"true" } ], - "title":"Obtaining a Project ID", + "title":"Obtaining Project ID", "githuburl":"" }, { "uri":"dws_02_0067.html", - "node_id":"en-us_topic_0000001231631315.xml", + "node_id":"en-us_topic_0000002532014025.xml", "product_code":"dws", - "code":"36", - "des":"An account ID (domain-id) is required for some URLs when an API is called. To obtain the account ID, do as follows:Log in to the management console.Click the username and", + "code":"161", + "des":"An account ID (domain-id) is required for some URLs when an API is called. To obtain the account ID, perform the following steps:Log in to the management console.Click th", "doc_type":"api", - "kw":"Obtaining an Account,Appendix,API Reference", + "kw":"Obtaining an Account ID,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -682,15 +3178,15 @@ "opensource":"true" } ], - "title":"Obtaining an Account", + "title":"Obtaining an Account ID", "githuburl":"" }, { "uri":"dws_02_00068.html", - "node_id":"en-us_topic_0000001231631323.xml", + "node_id":"en-us_topic_0000002531893987.xml", "product_code":"dws", - "code":"37", - "des":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain a cluster ID, perform the following operations:Log in to the GaussDB(DWS) console.In ", + "code":"162", + "des":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:You can obtain the cluster ID by calling ", "doc_type":"api", "kw":"Obtaining the Cluster ID,Appendix,API Reference", "search_title":"", @@ -706,9 +3202,9 @@ }, { "uri":"dws_02_0031.html", - "node_id":"en-us_topic_0000001185673176.xml", + "node_id":"en-us_topic_0000002500014124.xml", "product_code":"dws", - "code":"38", + "code":"163", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/dws/api-ref/AddQueueUserList.html b/docs/dws/api-ref/AddQueueUserList.html new file mode 100644 index 000000000..cf77863c8 --- /dev/null +++ b/docs/dws/api-ref/AddQueueUserList.html @@ -0,0 +1,244 @@ + + +

Associating a User to a Resource Pool

+

Function

This API is used to associate a user to a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/batch-create

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_list

+

Yes

+

Array of user_list objects

+

Definition

+

List of resource pool users.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 3 user_list

Parameter

+

Mandatory

+

Type

+

Description

+

user_name

+

No

+

String

+

Username

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/resource1/users/batch-create
+
+{
+  "queue_name" : "test11",
+  "user_list" : [ {
+    "user_name" : "user_batch"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

The user is associated to the resource pool.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The user is associated to the resource pool.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/AddWorkloadPlanStage.html b/docs/dws/api-ref/AddWorkloadPlanStage.html new file mode 100644 index 000000000..874765227 --- /dev/null +++ b/docs/dws/api-ref/AddWorkloadPlanStage.html @@ -0,0 +1,407 @@ + + +

Adding a Stage for a Resource Management Plan

+

Function

This API is used to add a resource management plan stage.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

workload_plan_stage

+

No

+

workload_plan_stage object

+

Definition

+

Details of the resource management plan stage

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 workload_plan_stage

Parameter

+

Mandatory

+

Type

+

Description

+

day

+

No

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

month

+

No

+

String

+

Definition

+

Month

+

Range

+

N/A

+

stage_name

+

No

+

String

+

Definition

+

Plan stage

+

Range

+

N/A

+

start_time

+

No

+

String

+

Definition

+

Start time

+

Range

+

N/A

+

end_time

+

No

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

queue_list

+

No

+

Array of QueueResourceItem objects

+

Definition

+

Resource queue

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 QueueResourceItem

Parameter

+

Mandatory

+

Type

+

Description

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

queue_resources

+

Yes

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 WorkloadResourceItem

Parameter

+

Mandatory

+

Type

+

Description

+

resource_name

+

Yes

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Yes

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

No

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

No

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0591129f-4970-44e7-b213-f7bce797de87/stages
+
+

Example Responses

Status code: 200

+

Stage added successfully.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Stage added successfully.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/AddWorkloadQueue.html b/docs/dws/api-ref/AddWorkloadQueue.html new file mode 100644 index 000000000..18d00c294 --- /dev/null +++ b/docs/dws/api-ref/AddWorkloadQueue.html @@ -0,0 +1,291 @@ + + +

Creating a Resource Pool

+

Function

This API is used to create a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/workload/queues

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

workload_queue

+

Yes

+

WorkloadQueue object

+

Definition

+

Resource pool information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 WorkloadQueue

Parameter

+

Mandatory

+

Type

+

Description

+

workload_queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

workload_resource_item_list

+

Yes

+

Array of WorkloadResource objects

+

Definition

+

Resource configuration queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 WorkloadResource

Parameter

+

Mandatory

+

Type

+

Description

+

resource_name

+

Yes

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_value

+

Yes

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

Create a resource pool (Name: test11. CPU share: 12%. Memory resource: 0 (no limit). Storage resource: -1 (no limit). Concurrent: 10).

+
PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/AddWorkloadRule.html b/docs/dws/api-ref/AddWorkloadRule.html new file mode 100644 index 000000000..44edc6459 --- /dev/null +++ b/docs/dws/api-ref/AddWorkloadRule.html @@ -0,0 +1,342 @@ + + +

Adding an Exception Rule

+

Function

This API is used to add an exception rule.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/workload/rules

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

rule_name

+

No

+

String

+

Definition

+

Exception rule name.

+

Constraints

+

It cannot be left blank.

+

Range

+

N/A

+

Default Value

+

N/A

+

except_rules

+

No

+

Array of ExceptRule objects

+

Definition

+

Exception rule configuration items.

+

Constraints

+

It cannot be left blank.

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ExceptRule

Parameter

+

Mandatory

+

Type

+

Description

+

rule_key

+

No

+

String

+

Definition

+

Rule item name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

rule_value

+

No

+

String

+

Definition

+

Rule item value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Error code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Error details.

+

Range

+

N/A

+

items

+

Array of ExceptRuleBo objects

+

Definition

+

Exception rule list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of exception rules.

+

Range

+

Greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 ExceptRuleBo

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Rule name.

+

Range

+

N/A

+

action

+

String

+

Definition

+

Action that triggers an exception rule.

+

Range

+

N/A

+

queues

+

Array of strings

+

Definition

+

Names of resource pools bound to an exception rule.

+

Range

+

N/A

+

except_rules

+

Map<String,String>

+

Definition

+

Exception rule configuration items.

+

Range

+

N/A

+
+
+
+

Example Requests

Create an exception rule.

+
POST https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload/rules
+
+{
+  "rule_name" : "rule910_1",
+  "except_rules" : [ {
+    "rule_key" : "blocktime",
+    "rule_value" : "600"
+  }, {
+    "rule_key" : "elapsedtime",
+    "rule_value" : "300"
+  }, {
+    "rule_key" : "action",
+    "rule_value" : "abort"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : null,
+  "items" : [ {
+    "name" : "default_cpu_percent",
+    "action" : "abort",
+    "queues" : [ ],
+    "except_rules" : {
+      "action" : "abort",
+      "cpuavgpercent" : "50",
+      "elapsedtime" : "900"
+    }
+  } ],
+  "count" : 3
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/AssociateEip.html b/docs/dws/api-ref/AssociateEip.html new file mode 100644 index 000000000..f93d1cf87 --- /dev/null +++ b/docs/dws/api-ref/AssociateEip.html @@ -0,0 +1,134 @@ + + +

Binding an EIP to a Cluster

+

Function

This API is used to bind an EIP to a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

eip_id

+

Yes

+

String

+

Definition

+

ID of the EIP to be bound to the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

The EIP is bound to the cluster.

+

None

+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/clusters/194408fa-9d41-435c-a140-91edcf5fe519/eips/ab60b4ac-10e3-4d83-bccd-9a6a1b0ba983
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The EIP is bound to the cluster.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/AssociateElb.html b/docs/dws/api-ref/AssociateElb.html new file mode 100644 index 000000000..fe17bcd83 --- /dev/null +++ b/docs/dws/api-ref/AssociateElb.html @@ -0,0 +1,158 @@ + + +

Binding an ELB to a Cluster

+

Function

This API is used to bind an ELB to a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

elb_id

+

Yes

+

String

+

Definition

+

ID of the ELB to be bound to the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

Task ID.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/clusters/194408fa-9d41-435c-a140-91edcf5fe519/elbs/1e6e0b66-6223-4523-bfd9-033c88b4ce9f
+
+

Example Responses

Status code: 200

+

Request for binding an ELB to a cluster submitted.

+
{
+  "job_id" : "2c9081838417d8850184196d8282002b"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for binding an ELB to a cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/BatchCreateClusterCn.html b/docs/dws/api-ref/BatchCreateClusterCn.html new file mode 100644 index 000000000..913a0dc3b --- /dev/null +++ b/docs/dws/api-ref/BatchCreateClusterCn.html @@ -0,0 +1,180 @@ + + +

Adding CN Nodes in Batches

+

Function

After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.

+

  • Other O&M operations cannot be performed during CN addition or deletion.

    +

  • Services need to be stopped during CN node addition or deletion. You are advised to perform this operation during off-peak hours or when services are interrupted.

    +

  • If a fault occurs during CN node addition or deletion and the rollback fails, you need to log in to the backend to rectify the fault. For details, see "Cluster Usage" > "Failed to Roll Back CN Addition or Deletion" in Troubleshooting.

    +
+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cns/batch-create

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

num

+

Yes

+

Integer

+

Definition

+

Total number of CN nodes in the cluster after new CN nodes are added in batches. The number of CN nodes supported by a cluster depends on the cluster version and number of nodes. For details, see "Querying CN Nodes in a Cluster", where min_num indicates the minimum number of CN nodes, and max_num indicates the maximum number of CN nodes.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

ID of the task for adding CN nodes in batches.

+

Range

+

N/A

+
+
+
+

Example Requests

Add three CN nodes in batches.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/cns/batch-create
+
+{
+  "num" : 3
+}
+
+

Example Responses

Status code: 200

+

The CN nodes are successfully added in batches.

+
{
+  "job_id" : "2c908185841339ce018414e9944b0020"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The CN nodes are successfully added in batches.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/BatchCreateResourceTag.html b/docs/dws/api-ref/BatchCreateResourceTag.html new file mode 100644 index 000000000..b36435586 --- /dev/null +++ b/docs/dws/api-ref/BatchCreateResourceTag.html @@ -0,0 +1,186 @@ + + +

Adding Tags in Batches

+

Function

This API is used to batch add tags to a specified cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-create

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

tags

+

Yes

+

Array of BatchCreateResourceTag objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 BatchCreateResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Definition

+

Tag key.

+

Range

+

N/A

+

value

+

Yes

+

String

+

Definition

+

Tag value.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

Tags are added in batches.

+

None

+
+

Example Requests

Add tags whose key is key and value is value in batches.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-create
+
+{
+  "tags" : [ {
+    "key" : "key",
+    "value" : "value"
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Tags are added in batches.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dws/api-ref/BatchDeleteClusterCn.html b/docs/dws/api-ref/BatchDeleteClusterCn.html new file mode 100644 index 000000000..36ee49c05 --- /dev/null +++ b/docs/dws/api-ref/BatchDeleteClusterCn.html @@ -0,0 +1,180 @@ + + +

Deleting CN Nodes in Batches

+

Function

After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.

+

  • Other O&M operations cannot be performed during CN addition or deletion.

    +

  • Services need to be stopped during CN node addition or deletion. You are advised to perform this operation during off-peak hours or when services are interrupted.

    +

  • If a fault occurs during CN node addition or deletion and the rollback fails, you need to log in to the backend to rectify the fault. For details, see "Cluster Usage" > "Failed to Roll Back CN Addition or Deletion" in Troubleshooting.

    +
+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cns/batch-delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instances

+

No

+

Array of strings

+

Definition

+

IDs of the CN nodes to be deleted.

+

Constraints

+

N/A

+

Range

+

The value cannot be left blank.

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

Task ID for deleting CN nodes in batches.

+

Range

+

N/A

+
+
+
+

Example Requests

Delete CN nodes whose IDs are " b6ad3dc3-d2de-4d2c-a5df-fdde58eca8f0" in batches.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/cns/batch-delete
+
+{
+  "instances" : [ "b6ad3dc3-d2de-4d2c-a5df-fdde58eca8f0" ]
+}
+
+

Example Responses

Status code: 200

+

The CN nodes are successfully deleted in batches.

+
{
+  "job_id" : "2c908185841339ce018414e9944b0020"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The CN nodes are successfully deleted in batches.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/BatchDeleteResourceTag.html b/docs/dws/api-ref/BatchDeleteResourceTag.html new file mode 100644 index 000000000..6d52dae00 --- /dev/null +++ b/docs/dws/api-ref/BatchDeleteResourceTag.html @@ -0,0 +1,193 @@ + + +

Delete Tags in Batches

+

Function

This API is used to delete tags from a specified cluster in batches.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

tags

+

Yes

+

Array of BatchDeleteResourceTag objects

+

Definition

+

Tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 BatchDeleteResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Definition

+

Tag key.

+

Range

+

N/A

+

value

+

Yes

+

String

+

Definition

+

Tag value.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

Tags are deleted in batches.

+

None

+
+

Example Requests

Delete tags whose key is key and value is value in batches.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-delete
+
+{
+  "tags" : [ {
+    "key" : "key",
+    "value" : "value"
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Tags are deleted in batches.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dws/api-ref/CLASS.TXT.json b/docs/dws/api-ref/CLASS.TXT.json index 1be0a64ea..1ac48e0db 100644 --- a/docs/dws/api-ref/CLASS.TXT.json +++ b/docs/dws/api-ref/CLASS.TXT.json @@ -1,6 +1,6 @@ [ { - "desc":"Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and ", + "desc":"Welcome to DWS. DWS is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and supports online cl", "product_code":"dws", "title":"Before You Start", "uri":"dws_02_0057.html", @@ -9,7 +9,7 @@ "code":"1" }, { - "desc":"You can use the following GaussDB(DWS) functions with the APIs.", + "desc":"DWS provides in-house APIs. The following table lists the key functions of DWS APIs. For details about other APIs, see the corresponding sections.", "product_code":"dws", "title":"API Overview", "uri":"dws_02_0034.html", @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"This section describes the structure of a REST API request, and describes how to call an API by obtaining a user token of the IAM service. The obtained token can then be ", + "desc":"This section describes the structure of a RESTful API request, and uses the IAM API for creating an IAM user as an example to describe how to call an API.A request URI is", "product_code":"dws", "title":"Making an API Request", "uri":"dws_02_0063.html", @@ -36,7 +36,7 @@ "code":"4" }, { - "desc":"Calling an API can be authenticated using tokens.A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added", + "desc":"You can use either of the following authentication methods when calling APIs:AK/SK authentication: Requests are encrypted using an AK/SK.Token authentication: Requests ar", "product_code":"dws", "title":"Authentication", "uri":"dws_02_0064.html", @@ -45,7 +45,7 @@ "code":"5" }, { - "desc":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", + "desc":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", "product_code":"dws", "title":"Response", "uri":"dws_02_0065.html", @@ -54,7 +54,7 @@ "code":"6" }, { - "desc":"This section describes how to use GaussDB(DWS) APIs to manage clusters. The procedure of the management clusters is as follows:Call the API in Authentication to obtain th", + "desc":"This section describes how to use DWS APIs to manage clusters. The procedure of the management clusters is as follows:Call the API in Authentication to obtain the user to", "product_code":"dws", "title":"Getting Started", "uri":"dws_02_0036.html", @@ -73,201 +73,1326 @@ }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Cluster Management", - "uri":"dws_02_0017.html", + "product_code":"DWS", + "title":"AZ Management", + "uri":"dws_02_0552.html", "doc_type":"api", "p_code":"8", "code":"9" }, { - "desc":"This API is used to create clusters.The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.This API is an as", - "product_code":"dws", - "title":"Creating a Cluster", - "uri":"dws_02_0020.html", + "desc":"This API is used to query the ID of the AZ, which you will need to create an instance.For details, see Calling APIs.GET /v1.0/{project_id}/availability-zonesNoneStatus co", + "product_code":"DWS", + "title":"Querying the AZ List", + "uri":"ListAvailabilityZones.html", "doc_type":"api", "p_code":"9", "code":"10" }, { - "desc":"This API is used to query and display the cluster list.None", - "product_code":"dws", - "title":"Querying the Cluster List", - "uri":"dws_02_0018.html", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Cluster Management", + "uri":"dws_02_0017.html", "doc_type":"api", - "p_code":"9", + "p_code":"8", "code":"11" }, { - "desc":"This API is used to query cluster details.None", - "product_code":"dws", - "title":"Querying Cluster Details", - "uri":"dws_02_0019.html", + "desc":"This API is used to query flavors supported by GaussDB(DWS).For details, see Calling APIs.GET /v2/{project_id}/node-typesNoneStatus code: 200Query flavor information.Stat", + "product_code":"DWS", + "title":"Querying Flavor Information", + "uri":"ListNodeTypes.html", "doc_type":"api", - "p_code":"9", + "p_code":"11", "code":"12" }, { - "desc":"This API is used to query the node types supported by GaussDB(DWS).None", - "product_code":"dws", - "title":"Querying the Supported Node Types", - "uri":"dws_02_0022.html", + "desc":"This API is used to query and display the cluster list.For details, see Calling APIs.GET /v2/{project_id}/clustersNoneStatus code: 200Query the cluster list.Status code: ", + "product_code":"DWS", + "title":"Querying the Cluster List (V2)", + "uri":"ShowClusters.html", "doc_type":"api", - "p_code":"9", + "p_code":"11", "code":"13" }, { - "desc":"This API is used to delete clusters. All resources of the deleted cluster, including customer data, will be released. For data security, create a snapshot for the cluster", - "product_code":"dws", - "title":"Deleting a Cluster", - "uri":"dws_02_0021.html", + "desc":"This API is used to query the enterprise project information of a specified cluster.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/enterprise-pr", + "product_code":"DWS", + "title":"Querying the Enterprise Project Information of a Cluster", + "uri":"ListTagsForResource.html", "doc_type":"api", - "p_code":"9", + "p_code":"11", "code":"14" }, { - "desc":"This API is used to restart clusters.NoneNone", - "product_code":"dws", - "title":"Restarting a Cluster", - "uri":"dws_02_0052.html", + "desc":"This API is used to query the cluster list.For details, see Calling APIs.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the cluster list.Status code: 200Cluster", + "product_code":"DWS", + "title":"Querying the Cluster List", + "uri":"ListClusters.html", "doc_type":"api", - "p_code":"9", + "p_code":"11", "code":"15" }, { - "desc":"This API is used to scale out a cluster.NoneAn example of the scale_out API is as follows:POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-", - "product_code":"dws", - "title":"Scaling Out a Cluster", - "uri":"dws_02_0053.html", + "desc":"This API is used to query cluster details.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200Query cluster details.Status code:", + "product_code":"DWS", + "title":"Querying Cluster Details", + "uri":"ListClusterDetails.html", "doc_type":"api", - "p_code":"9", + "p_code":"11", "code":"16" }, { - "desc":"This API is used to reset the password of cluster administrator.None", - "product_code":"dws", - "title":"Resetting a Password", - "uri":"dws_02_0054.html", + "desc":"This API is used to create a cluster.The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.This API is an a", + "product_code":"DWS", + "title":"Creating a Cluster", + "uri":"CreateCluster.html", "doc_type":"api", - "p_code":"9", + "p_code":"11", "code":"17" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Snapshot Management APIs", - "uri":"dws_02_0023.html", + "desc":"This API is used to perform a pre-check before cluster creation. It can identify problems such as insufficient subnets and quotas in advance, preventing cluster creation ", + "product_code":"DWS", + "title":"Performing a Check Before Cluster Creation", + "uri":"CheckCluster.html", "doc_type":"api", - "p_code":"8", + "p_code":"11", "code":"18" }, { - "desc":"This API is used to create snapshots for a specified cluster.", - "product_code":"dws", - "title":"Creating a Snapshot", - "uri":"dws_02_0026.html", + "desc":"This API is used to create a cluster.The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.This API is an a", + "product_code":"DWS", + "title":"Creating a Cluster (V2)", + "uri":"CreateClusterV2.html", "doc_type":"api", - "p_code":"18", + "p_code":"11", "code":"19" }, { - "desc":"This API is used to query the snapshot list.None", - "product_code":"dws", - "title":"Querying the Snapshot List", - "uri":"dws_02_0024.html", + "desc":"This API is used to restart a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/restartStatus code: 200The request for restarting the cl", + "product_code":"DWS", + "title":"Restarting a Cluster", + "uri":"RestartCluster.html", "doc_type":"api", - "p_code":"18", + "p_code":"11", "code":"20" }, { - "desc":"This API is used to query snapshot details by using the snapshot ID.None", - "product_code":"dws", - "title":"Querying Snapshot Details", - "uri":"dws_02_0025.html", + "desc":"This API is used to reset the administrator password of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/reset-passwordStatus code: 2", + "product_code":"DWS", + "title":"Resetting a Password", + "uri":"ResetPassword.html", "doc_type":"api", - "p_code":"18", + "p_code":"11", "code":"21" }, { - "desc":"This API is used to delete a specified manual snapshot.NoneNoneNone", - "product_code":"dws", - "title":"Deleting a Manual Snapshot", - "uri":"dws_02_0027.html", + "desc":"This API is used to modify the security group of a cluster.For details, see Calling APIs.PUT /v1/{project_id}/clusters/{cluster_id}/security-groupStatus code: 200Cluster ", + "product_code":"DWS", + "title":"Modifying the Security Group of a Cluster", + "uri":"ChangeSecurityGroup.html", "doc_type":"api", - "p_code":"18", + "p_code":"11", "code":"22" }, { - "desc":"This API is used to restore clusters using the snapshot.", - "product_code":"dws", - "title":"Restoring a Cluster", - "uri":"dws_02_0032.html", + "desc":"In the Unbalanced state, the number of primary instances on some nodes increases. As a result, the load pressure is high. In this case, the cluster is normal, but the ove", + "product_code":"DWS", + "title":"Performing a Switchback", + "uri":"SwitchOverCluster.html", "doc_type":"api", - "p_code":"18", + "p_code":"11", "code":"23" }, + { + "desc":"This API is used to cancel the read-only status on the management console. When a cluster is in the read-only state, you cannot perform any database operations. The read-", + "product_code":"DWS", + "title":"Canceling Read-only Status of a Cluster", + "uri":"CancelReadonlyCluster.html", + "doc_type":"api", + "p_code":"11", + "code":"24" + }, + { + "desc":"This API is used to query ring node information in the cluster topology.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/topo/ringsNoneStatus code", + "product_code":"DWS", + "title":"Querying Ring Node Information in the Cluster Topology", + "uri":"ListTopoRings.html", + "doc_type":"api", + "p_code":"11", + "code":"25" + }, + { + "desc":"This API is used to stop a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/stopNoneStatus code: 200Stop a cluster.Status code: 200The re", + "product_code":"DWS", + "title":"Stopping a Cluster", + "uri":"StopCluster.html", + "doc_type":"api", + "p_code":"11", + "code":"26" + }, + { + "desc":"This API is used to start a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/startNoneStatus code: 200Start a cluster.Status code: 200Req", + "product_code":"DWS", + "title":"Starting a Cluster", + "uri":"StartCluster.html", + "doc_type":"api", + "p_code":"11", + "code":"27" + }, + { + "desc":"This API is used to change the time zone of a cluster. This operation will change the time zone of the OS as well as the database.ConstraintsTo change the time zone of a ", + "product_code":"DWS", + "title":"Changing Cluster Time Zone", + "uri":"ModifyClusterTimezone.html", + "doc_type":"api", + "p_code":"11", + "code":"28" + }, + { + "desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot fo", + "product_code":"DWS", + "title":"Deleting a Cluster", + "uri":"DeleteCluster.html", + "doc_type":"api", + "p_code":"11", + "code":"29" + }, + { + "desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot fo", + "product_code":"DWS", + "title":"Deleting a Cluster (V2)", + "uri":"DeleteDwsCluster.html", + "doc_type":"api", + "p_code":"11", + "code":"30" + }, + { + "desc":"This API is used to query the list of DSS storage pools. Only SSD dedicated resource pools that you enabled can be queried.For details, see Calling APIs.GET /v1.0/{projec", + "product_code":"DWS", + "title":"Querying the DSS Storage Pool List", + "uri":"ListDssPools.html", + "doc_type":"api", + "p_code":"11", + "code":"31" + }, + { + "desc":"This API is used to query flavor details of a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/flavorNoneStatus code: 200Query the cluster", + "product_code":"DWS", + "title":"Querying Flavor Details of a Cluster", + "uri":"ShowClusterFlavor.html", + "doc_type":"api", + "p_code":"11", + "code":"32" + }, + { + "desc":"This API is used to modify the cluster description.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/descriptionStatus code: 200Modify the cluster", + "product_code":"DWS", + "title":"Modifying Cluster Description", + "uri":"SaveClusterDescriptionInfo.html", + "doc_type":"api", + "p_code":"11", + "code":"33" + }, + { + "desc":"This API is used to query details about a single instance.For details, see Calling APIs.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Query information ", + "product_code":"DWS", + "title":"Querying an Instance", + "uri":"ShowInstance.html", + "doc_type":"api", + "p_code":"11", + "code":"34" + }, + { + "desc":"This API is used to query resource statistics.For details, see Calling APIs.GET /v1/{project_id}/resource-statisticsNoneStatus code: 200Query resource statistics.Status c", + "product_code":"DWS", + "title":"Querying Resource Statistics", + "uri":"ShowResourceStatistics.html", + "doc_type":"api", + "p_code":"11", + "code":"35" + }, + { + "desc":"This API is used to query the disk usage of a tenant management node.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/volumeNoneStatus code: 200Qu", + "product_code":"DWS", + "title":"Querying Disk Usage", + "uri":"ShowClusterVolume.html", + "doc_type":"api", + "p_code":"11", + "code":"36" + }, + { + "desc":"This API is used to change a cluster name.ConstraintsThis parameter is available only for GuestAgent 8.3.1 or later.For details, see Calling APIs.PUT /v1/{project_id}/clu", + "product_code":"DWS", + "title":"Changing a Cluster Name", + "uri":"ModifyClusterName.html", + "doc_type":"api", + "p_code":"11", + "code":"37" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Node Change", + "uri":"dws_02_0026.html", + "doc_type":"api", + "p_code":"8", + "code":"38" + }, + { + "desc":"Disk capacity is more likely to become the bottleneck of storage as workloads develop. When other resources are sufficient, disk capacity expansion can help you quickly b", + "product_code":"DWS", + "title":"Expanding Disk Capacity", + "uri":"ExpandInstanceStorage.html", + "doc_type":"api", + "p_code":"38", + "code":"39" + }, + { + "desc":"This API is used to query capacity range that a disk can be expanded to.ConstraintsDisk capacity expansion can be performed only for cloud data warehouses using SSD or hy", + "product_code":"DWS", + "title":"Querying the Disk Capacity Expansion Range", + "uri":"ShowClusterStorageExpandRange.html", + "doc_type":"api", + "p_code":"38", + "code":"40" + }, + { + "desc":"This API is used to query the list of flavors that a cluster can be changed to. A maximum of 20 flavors can be returned.ConstraintsIf cluster_id is not specified, all fla", + "product_code":"DWS", + "title":"Querying the List of Target Flavors That a Cluster Can Be Changed To", + "uri":"ListTargetFlavors.html", + "doc_type":"api", + "p_code":"38", + "code":"41" + }, + { + "desc":"This API is used to query the CN node list of a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/cnsNoneStatus code: 200Query CN node li", + "product_code":"DWS", + "title":"Querying CN Nodes of a Cluster", + "uri":"ListClusterCn.html", + "doc_type":"api", + "p_code":"38", + "code":"42" + }, + { + "desc":"After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.Other O&M operations cannot be performed durin", + "product_code":"DWS", + "title":"Adding CN Nodes in Batches", + "uri":"BatchCreateClusterCn.html", + "doc_type":"api", + "p_code":"38", + "code":"43" + }, + { + "desc":"After a cluster is created, the number of required CN nodes varies with workloads. You can add or delete CN nodes as needed.Other O&M operations cannot be performed durin", + "product_code":"DWS", + "title":"Deleting CN Nodes in Batches", + "uri":"BatchDeleteClusterCn.html", + "doc_type":"api", + "p_code":"38", + "code":"44" + }, + { + "desc":"This API is used to scale out a cluster or add idle nodes. By default, scale-out is performed.You can configure create_node_only to determine whether the current operatio", + "product_code":"DWS", + "title":"Scaling Out a Cluster", + "uri":"ResizeCluster.html", + "doc_type":"api", + "p_code":"38", + "code":"45" + }, + { + "desc":"This API is used to conduct a precheck for cluster scale-out to identify failures caused by insufficient subnets or permissions.For details, see Calling APIs.POST /v2/{pr", + "product_code":"DWS", + "title":"Performing a Scale-Out Check", + "uri":"CheckGrowCluster.html", + "doc_type":"api", + "p_code":"38", + "code":"46" + }, + { + "desc":"This API is used to scale out a cluster with idle nodes.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/resize-with-existed-nodesStatus code: 20", + "product_code":"DWS", + "title":"Scaling Out a Cluster with Idle Nodes", + "uri":"ResizeClusterWithExistedNodes.html", + "doc_type":"api", + "p_code":"38", + "code":"47" + }, + { + "desc":"This API is used to query the node list.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/nodesNoneStatus code: 200Query the node list.GET https://", + "product_code":"DWS", + "title":"Querying the Node List", + "uri":"ListClusterNodes.html", + "doc_type":"api", + "p_code":"38", + "code":"48" + }, + { + "desc":"This API is used to delete idle nodes.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/nodes/deleteStatus code: 202Delete idle nodes.Status code:", + "product_code":"DWS", + "title":"Deleting Idle Nodes", + "uri":"DeleteClusterNodes.html", + "doc_type":"api", + "p_code":"38", + "code":"49" + }, + { + "desc":"This API is used to evenly distribute data from old nodes to new nodes after cluster scale-out. After data redistribution, the service response speed is greatly improved.", + "product_code":"DWS", + "title":"Performing a Redistribution Task", + "uri":"ExecuteRedistributionCluster.html", + "doc_type":"api", + "p_code":"38", + "code":"50" + }, + { + "desc":"This API is used to query the monitoring information about a cluster, such as the redistribution mode, redistribution progress, and redistribution details.The redistribut", + "product_code":"DWS", + "title":"Querying Redistribution Details", + "uri":"ShowClusterRedistribution.html", + "doc_type":"api", + "p_code":"38", + "code":"51" + }, + { + "desc":"This API is used to modify redistribution configurations.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/configurationsStatus code", + "product_code":"DWS", + "title":"Modifying Redistribution Configurations", + "uri":"UpdateRedistributionConfigurations.html", + "doc_type":"api", + "p_code":"38", + "code":"52" + }, + { + "desc":"This API is used to change the priority of a redistribution table.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/priorityStatus c", + "product_code":"DWS", + "title":"Changing the Priority of a Redistribution Table", + "uri":"SetRedistributionPriority.html", + "doc_type":"api", + "p_code":"38", + "code":"53" + }, + { + "desc":"This API is used to query the schema information of the table to be redistributed.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/redistribution/", + "product_code":"DWS", + "title":"Querying the Schema Information of the Table to Be Redistributed", + "uri":"ListRedistributionSchema.html", + "doc_type":"api", + "p_code":"38", + "code":"54" + }, + { + "desc":"This API is used to suspend redistribution. After suspension, you can set the redistribution priority and change the number of concurrent redistribution tasks.This functi", + "product_code":"DWS", + "title":"Suspending Redistribution", + "uri":"StopRedistribution.html", + "doc_type":"api", + "p_code":"38", + "code":"55" + }, + { + "desc":"This API is used to query the number of nodes to be removed from a cluster for better performance.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_i", + "product_code":"DWS", + "title":"Querying the Number of Nodes to Be Removed from a Cluster for Better Performance", + "uri":"ListClusterScaleInNumbers.html", + "doc_type":"api", + "p_code":"38", + "code":"56" + }, + { + "desc":"This API is used to resume redistribution in the suspended state. It is available only for DWS 2.0.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_i", + "product_code":"DWS", + "title":"Resuming Redistribution", + "uri":"RestoreRedistribution.html", + "doc_type":"api", + "p_code":"38", + "code":"57" + }, + { + "desc":"This API is used to perform a re-scale-in check. It can ensure that the requirements are met before and after the scale-in.For details, see Calling APIs.GET /v1/{project_", + "product_code":"DWS", + "title":"Performing a Scale-in Check", + "uri":"CheckClusterShrink.html", + "doc_type":"api", + "p_code":"38", + "code":"58" + }, + { + "desc":"This API is used to scale in a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrinkStatus code: 200Scale in three nodes in t", + "product_code":"DWS", + "title":"Scaling In a Cluster", + "uri":"ShrinkCluster.html", + "doc_type":"api", + "p_code":"38", + "code":"59" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Logical Cluster Management", + "uri":"dws_02_0605.html", + "doc_type":"api", + "p_code":"8", + "code":"60" + }, + { + "desc":"This API is used to convert a physical cluster to a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/convert-to-logical-cluster/{", + "product_code":"DWS", + "title":"Converting a Physical Cluster to a Logical Cluster", + "uri":"ConvertToLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"61" + }, + { + "desc":"This API is used to create a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/logical-clustersStatus code: 200Create a logical cl", + "product_code":"DWS", + "title":"Creating a Logical Cluster", + "uri":"CreateLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"62" + }, + { + "desc":"This API is used to scale in a logical cluster in an elastic pool.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_clus", + "product_code":"DWS", + "title":"Scaling In a Logical Cluster", + "uri":"ShrinkLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"63" + }, + { + "desc":"This API is used to query the disk information of a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/volumesNoneS", + "product_code":"DWS", + "title":"Querying Disk Information of a Logical Cluster", + "uri":"ListLogicalClusterVolumes.html", + "doc_type":"api", + "p_code":"60", + "code":"64" + }, + { + "desc":"This API is used to query task information about a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/tasksNoneStat", + "product_code":"DWS", + "title":"Querying Task Information About a Logical Cluster", + "uri":"ListLogicalClusterTasks.html", + "doc_type":"api", + "p_code":"60", + "code":"65" + }, + { + "desc":"This API is used to query the logical cluster list.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clustersNoneStatus code: 200Query the ", + "product_code":"DWS", + "title":"Querying the Logical Cluster List", + "uri":"ListLogicalClusters.html", + "doc_type":"api", + "p_code":"60", + "code":"66" + }, + { + "desc":"This API is used to query information about available ring nodes in a logical cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/logical-clu", + "product_code":"DWS", + "title":"Querying Information About Available Ring Nodes in a Logical Cluster", + "uri":"ListLogicalClusterRings.html", + "doc_type":"api", + "p_code":"60", + "code":"67" + }, + { + "desc":"This API is used to restart a logical cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/restartNoneS", + "product_code":"DWS", + "title":"Restarting a Logical Cluster", + "uri":"RestartLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"68" + }, + { + "desc":"This API is used to delete a logical cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}NoneStatus c", + "product_code":"DWS", + "title":"Deleting a Logical Cluster", + "uri":"DeleteLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"69" + }, + { + "desc":"This API is used to edit a logical cluster. The API determines whether to scale out or scale in a logical cluster based on the submitted request body.Scenario 1: The orig", + "product_code":"DWS", + "title":"Editing a Logical Cluster", + "uri":"UpdateLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"70" + }, + { + "desc":"This API is used to control whether the function modules related to a logical cluster are displayed on the page.If the cluster is already a logical cluster, this API has ", + "product_code":"DWS", + "title":"Switching to a Logical Cluster", + "uri":"EnableLogicalCluster.html", + "doc_type":"api", + "p_code":"60", + "code":"71" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Resource Management", + "uri":"dws_02_0538.html", + "doc_type":"api", + "p_code":"8", + "code":"72" + }, + { + "desc":"This API is used to query whether resource management is enabled.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workloadNoneStatus code: 200Quer", + "product_code":"DWS", + "title":"Querying Whether Resource Management Is Enabled", + "uri":"ListClusterWorkload.html", + "doc_type":"api", + "p_code":"72", + "code":"73" + }, + { + "desc":"This API is used to query all resource management plans in a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plansNoneStatus cod", + "product_code":"DWS", + "title":"Querying the Resource Management Plan List", + "uri":"ListWorkloadPlans.html", + "doc_type":"api", + "p_code":"72", + "code":"74" + }, + { + "desc":"This API is used to create a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plansStatus code: 200Create the r", + "product_code":"DWS", + "title":"Creating a Resource Management Plan", + "uri":"CreateWorkloadPlan.html", + "doc_type":"api", + "p_code":"72", + "code":"75" + }, + { + "desc":"This API is used to query resource pools.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queuesNoneStatus code: 200Query resource pools.", + "product_code":"DWS", + "title":"Querying Resource Pools", + "uri":"ListWorkloadQueue.html", + "doc_type":"api", + "p_code":"72", + "code":"76" + }, + { + "desc":"This API is used to create a resource pool.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/queuesStatus code: 200Create a resource pool ", + "product_code":"DWS", + "title":"Creating a Resource Pool", + "uri":"AddWorkloadQueue.html", + "doc_type":"api", + "p_code":"72", + "code":"77" + }, + { + "desc":"This API is used to stop a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stopNoneStatus code", + "product_code":"DWS", + "title":"Stopping a Resource Management Plan", + "uri":"StopWorkloadPlan.html", + "doc_type":"api", + "p_code":"72", + "code":"78" + }, + { + "desc":"This API is used to query details about a resource management plan.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}NoneSt", + "product_code":"DWS", + "title":"Querying Details About a Resource Management Plan", + "uri":"ShowWorkloadPlan.html", + "doc_type":"api", + "p_code":"72", + "code":"79" + }, + { + "desc":"This API is used to delete a resource management plan.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}NoneStatus code:", + "product_code":"DWS", + "title":"Deleting a Resource Management Plan", + "uri":"DeleteWorkloadPlan.html", + "doc_type":"api", + "p_code":"72", + "code":"80" + }, + { + "desc":"This API is used start a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/startNoneStatus code:", + "product_code":"DWS", + "title":"Starting a Resource Management Plan", + "uri":"StartWorkloadPlan.html", + "doc_type":"api", + "p_code":"72", + "code":"81" + }, + { + "desc":"This API is used to query the list of users bound to a resource pool.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}", + "product_code":"DWS", + "title":"Querying the List of Users Bound to a Resource Pool", + "uri":"ListWorkloadQueueUsers.html", + "doc_type":"api", + "p_code":"72", + "code":"82" + }, + { + "desc":"This API is used to query details about a resource pool.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}NoneStatus co", + "product_code":"DWS", + "title":"Querying Resource Pool Details", + "uri":"ShowWorkloadQueue.html", + "doc_type":"api", + "p_code":"72", + "code":"83" + }, + { + "desc":"This API is used to query details stage details of resource management plan.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_", + "product_code":"DWS", + "title":"Querying Stage Details About a Resource Management Plan", + "uri":"ShowWorkloadPlanStage.html", + "doc_type":"api", + "p_code":"72", + "code":"84" + }, + { + "desc":"This API is used to delete a stage of a resource management plan.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stag", + "product_code":"DWS", + "title":"Deleting a Stage of Resource Management Plan", + "uri":"DeleteWorkloadPlanStage.html", + "doc_type":"api", + "p_code":"72", + "code":"85" + }, + { + "desc":"This API is used to modify a stage of a resource management plan.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/", + "product_code":"DWS", + "title":"Modifying a Stage of a Resource Management Plan", + "uri":"UpdateWorkloadPlanStage.html", + "doc_type":"api", + "p_code":"72", + "code":"86" + }, + { + "desc":"This API is used to query plan execution logs.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/logsNoneStatus code: 200St", + "product_code":"DWS", + "title":"Querying Plan Execution Logs", + "uri":"ListPlanExecLogs.html", + "doc_type":"api", + "p_code":"72", + "code":"87" + }, + { + "desc":"This API is used to delete a user bound to a resource pool.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/ba", + "product_code":"DWS", + "title":"Deleting a User Bound to a Resource Pool", + "uri":"DeleteQueueUserList.html", + "doc_type":"api", + "p_code":"72", + "code":"88" + }, + { + "desc":"This API is used to switch the stage of a resource management plan.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stag", + "product_code":"DWS", + "title":"Switching the Stage of a Resource Management Plan", + "uri":"SwitchPlanStage.html", + "doc_type":"api", + "p_code":"72", + "code":"89" + }, + { + "desc":"This API is used to associate a user to a resource pool.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/batch", + "product_code":"DWS", + "title":"Associating a User to a Resource Pool", + "uri":"AddQueueUserList.html", + "doc_type":"api", + "p_code":"72", + "code":"90" + }, + { + "desc":"This API is used to modify the resource configurations of a resource pool.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_", + "product_code":"DWS", + "title":"Modifying Resource Configurations of a Resource Pool", + "uri":"UpdateQueueResources.html", + "doc_type":"api", + "p_code":"72", + "code":"91" + }, + { + "desc":"This API is used to query schema space information of a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemas", + "product_code":"DWS", + "title":"Querying the Schema Space Information of a Cluster", + "uri":"ListSchemas.html", + "doc_type":"api", + "p_code":"72", + "code":"92" + }, + { + "desc":"This API is used to edit the space limit of a schema.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemasStatus code", + "product_code":"DWS", + "title":"Editing the Space Limit of a Schema", + "uri":"UpdateSchemas.html", + "doc_type":"api", + "p_code":"72", + "code":"93" + }, + { + "desc":"This API is used to add a resource management plan stage.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stagesStatus c", + "product_code":"DWS", + "title":"Adding a Stage for a Resource Management Plan", + "uri":"AddWorkloadPlanStage.html", + "doc_type":"api", + "p_code":"72", + "code":"94" + }, + { + "desc":"This API is used to delete a resource pool.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/workload/queuesNoneStatus code: 200Status code: 200", + "product_code":"DWS", + "title":"Deleting a Resource Pool", + "uri":"DeleteWorkloadQueue.html", + "doc_type":"api", + "p_code":"72", + "code":"95" + }, + { + "desc":"This API is used to query the exception rule list of a cluster.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/workload/rulesNoneStatus code: 200", + "product_code":"DWS", + "title":"Querying the Exception Rule List of a Cluster", + "uri":"ListWorkloadRules.html", + "doc_type":"api", + "p_code":"72", + "code":"96" + }, + { + "desc":"This API is used to add an exception rule.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/workload/rulesStatus code: 200Create an exception rule", + "product_code":"DWS", + "title":"Adding an Exception Rule", + "uri":"AddWorkloadRule.html", + "doc_type":"api", + "p_code":"72", + "code":"97" + }, + { + "desc":"This API is used to delete an exception rule.For details, see Calling APIs.DELETE /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}NoneStatus code: 200Del", + "product_code":"DWS", + "title":"Deleting an Exception Rule", + "uri":"DeleteWorkloadRule.html", + "doc_type":"api", + "p_code":"72", + "code":"98" + }, + { + "desc":"This API is used to edit an exception rule.For details, see Calling APIs.PUT /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}Status code: 200Edit an exce", + "product_code":"DWS", + "title":"Editing an Exception Rule", + "uri":"UpdateWorkloadRule.html", + "doc_type":"api", + "p_code":"72", + "code":"99" + }, + { + "desc":"This API is used to enable or disable resource management. The function is enabled by default for new clusters.For details, see Calling APIs.POST /v2/{project_id}/cluster", + "product_code":"DWS", + "title":"Enabling or Disabling Resource Management", + "uri":"CreateClusterWorkload.html", + "doc_type":"api", + "p_code":"72", + "code":"100" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Snapshot Management", + "uri":"dws_02_0023.html", + "doc_type":"api", + "p_code":"8", + "code":"101" + }, + { + "desc":"This API is used to query snapshot statistics.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots/statisticsNoneStatus code: 200Status co", + "product_code":"DWS", + "title":"Querying Snapshot Statistics", + "uri":"ListSnapshotStatistics.html", + "doc_type":"api", + "p_code":"101", + "code":"102" + }, + { + "desc":"This API is used to check the name of the table to be restored.For details, see Calling APIs.POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore-checkStatus code:", + "product_code":"DWS", + "title":"Checking the Name of the Table to Be Restored", + "uri":"CheckTableRestore.html", + "doc_type":"api", + "p_code":"101", + "code":"103" + }, + { + "desc":"This API is used to restore tables.For details, see Calling APIs.POST /v1/{project_id}/snapshots/{snapshot_id}/table-restoreStatus code: 200Status code: 200The table is s", + "product_code":"DWS", + "title":"Restoring a Table", + "uri":"RestoreTable.html", + "doc_type":"api", + "p_code":"101", + "code":"104" + }, + { + "desc":"This API is used to create a snapshot for a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/snapshotsStatus code: 200Create a manual snapshot name", + "product_code":"DWS", + "title":"Creating a Snapshot", + "uri":"CreateSnapshot.html", + "doc_type":"api", + "p_code":"101", + "code":"105" + }, + { + "desc":"This API is used to query the snapshot list.For details, see Calling APIs.GET /v1.0/{project_id}/snapshotsNoneStatus code: 200Status code: 200Snapshot list queried.", + "product_code":"DWS", + "title":"Querying the Snapshot List", + "uri":"ListSnapshots.html", + "doc_type":"api", + "p_code":"101", + "code":"106" + }, + { + "desc":"This API is used to query the cluster snapshot list.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/snapshotsNoneStatus code: 200Status code: 2", + "product_code":"DWS", + "title":"Querying the Cluster Snapshot List", + "uri":"ListClusterSnapshots.html", + "doc_type":"api", + "p_code":"101", + "code":"107" + }, + { + "desc":"This API is used to query a snapshot policy.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/snapshot-policiesNoneStatus code: 200Status code: 200", + "product_code":"DWS", + "title":"Querying a Snapshot Policy", + "uri":"ListSnapshotPolicy.html", + "doc_type":"api", + "p_code":"101", + "code":"108" + }, + { + "desc":"This API is used to query snapshot details using the snapshot ID.For details, see Calling APIs.GET /v1.0/{project_id}/snapshots/{snapshot_id}NoneStatus code: 200Status co", + "product_code":"DWS", + "title":"Querying Snapshot Details", + "uri":"ListSnapshotDetails.html", + "doc_type":"api", + "p_code":"101", + "code":"109" + }, + { + "desc":"This API is used to delete a snapshot policy.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/snapshot-policies/{id}NoneStatus code: 200The s", + "product_code":"DWS", + "title":"Deleting a Snapshot Policy", + "uri":"DeleteSnapshotPolicy.html", + "doc_type":"api", + "p_code":"101", + "code":"110" + }, + { + "desc":"This API is used to delete a manual snapshot.For details, see Calling APIs.DELETE /v1.0/{project_id}/snapshots/{snapshot_id}NoneStatus code: 202The snapshot is deleted.No", + "product_code":"DWS", + "title":"Deleting a Snapshot", + "uri":"DeleteSnapshot.html", + "doc_type":"api", + "p_code":"101", + "code":"111" + }, + { + "desc":"This API is used to restore a cluster using a snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/snapshots/{snapshot_id}/actionsStatus code: 200Restore the sn", + "product_code":"DWS", + "title":"Restoring a Cluster", + "uri":"RestoreCluster.html", + "doc_type":"api", + "p_code":"101", + "code":"112" + }, + { + "desc":"This API is used to query flavors based on the snapshot ID. You can query the flavor of a snapshot or the flavor to which a snapshot can be restored.For details, see Call", + "product_code":"DWS", + "title":"Querying Flavors by Snapshot ID", + "uri":"ListSnapshotFlavorInfo.html", + "doc_type":"api", + "p_code":"101", + "code":"113" + }, + { + "desc":"This API is used to copy an automated snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/snapshots/{snapshot_id}/linked-copyStatus code: 200Copy an automated ", + "product_code":"DWS", + "title":"Copying a Snapshot", + "uri":"CopySnapshot.html", + "doc_type":"api", + "p_code":"101", + "code":"114" + }, + { + "desc":"This API is used to configure a snapshot policy.For details, see Calling APIs.PUT /v2/{project_id}/clusters/{cluster_id}/snapshot-policiesStatus code: 200Request succeede", + "product_code":"DWS", + "title":"Adding a Snapshot Policy", + "uri":"CreateSnapshotPolicy.html", + "doc_type":"api", + "p_code":"101", + "code":"115" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Connection Management", + "uri":"dws_02_0554.html", + "doc_type":"api", + "p_code":"8", + "code":"116" + }, + { + "desc":"This API is used to query connection information, including public and private domain names.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/endpo", + "product_code":"DWS", + "title":"Querying Connection Information", + "uri":"ListClusterEndpoints.html", + "doc_type":"api", + "p_code":"116", + "code":"117" + }, + { + "desc":"This API is used to apply for a domain name for a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/dnsStatus code: 200The dom", + "product_code":"DWS", + "title":"Applying for a Domain Name", + "uri":"CreateClusterDns.html", + "doc_type":"api", + "p_code":"116", + "code":"118" + }, + { + "desc":"This API is used to change the domain name of a specified cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/dnsStatus code: 200The cluste", + "product_code":"DWS", + "title":"Modifying a Cluster Domain Name", + "uri":"UpdateClusterDns.html", + "doc_type":"api", + "p_code":"116", + "code":"119" + }, + { + "desc":"This API is used to delete the domain name of a specified cluster.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/dnsNoneStatus code: 200The", + "product_code":"DWS", + "title":"Deleting a Cluster Domain Name", + "uri":"DeleteClusterDns.html", + "doc_type":"api", + "p_code":"116", + "code":"120" + }, + { + "desc":"This API is used to query the list of ELBs that can be bound to a cluster.For details, see Calling APIs.GET /v2/{project_id}/clusters/{cluster_id}/elbsNoneStatus code: 20", + "product_code":"DWS", + "title":"Querying the List of ELBs That Can Be Bound to a Cluster", + "uri":"ListElbs.html", + "doc_type":"api", + "p_code":"116", + "code":"121" + }, + { + "desc":"This API is used to bind an ELB to a cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}NoneStatus code: 200Status code: 200Re", + "product_code":"DWS", + "title":"Binding an ELB to a Cluster", + "uri":"AssociateElb.html", + "doc_type":"api", + "p_code":"116", + "code":"122" + }, + { + "desc":"This API is used to unbind an ELB from a cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}NoneStatus code: 200Status code:", + "product_code":"DWS", + "title":"Unbinding an ELB from a Cluster", + "uri":"DisassociateElb.html", + "doc_type":"api", + "p_code":"116", + "code":"123" + }, + { + "desc":"This API is used to bind an EIP to a cluster.For details, see Calling APIs.POST /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}NoneStatus code: 200The EIP is bound t", + "product_code":"DWS", + "title":"Binding an EIP to a Cluster", + "uri":"AssociateEip.html", + "doc_type":"api", + "p_code":"116", + "code":"124" + }, + { + "desc":"This API is used to unbind an EIP from a cluster.For details, see Calling APIs.DELETE /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}NoneStatus code: 200The EIP is u", + "product_code":"DWS", + "title":"Unbinding an EIP from a Cluster", + "uri":"DisassociateEip.html", + "doc_type":"api", + "p_code":"116", + "code":"125" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Alarm Management", + "uri":"dws_02_0544.html", + "doc_type":"api", + "p_code":"8", + "code":"126" + }, + { + "desc":"This API is used to query alarm configurations.For details, see Calling APIs.GET /v2/{project_id}/alarm-configsNoneStatus code: 200Status code: 200Alarm configurations qu", + "product_code":"DWS", + "title":"Querying Alarm Configurations", + "uri":"ListAlarmConfigs.html", + "doc_type":"api", + "p_code":"126", + "code":"127" + }, + { + "desc":"This API is used to query the alarm details list.For details, see Calling APIs.GET /v2/{project_id}/alarmsNoneStatus code: 200Status code: 200Alarm details list queried.", + "product_code":"DWS", + "title":"Querying Alarm Details List", + "uri":"ListAlarmDetail.html", + "doc_type":"api", + "p_code":"126", + "code":"128" + }, + { + "desc":"This API is used to query alarm statistics.For details, see Calling APIs.GET /v2/{project_id}/alarm-statisticNoneStatus code: 200Status code: 200Alarm statistics list que", + "product_code":"DWS", + "title":"Querying the Alarm Statistics List", + "uri":"ListAlarmStatistic.html", + "doc_type":"api", + "p_code":"126", + "code":"129" + }, + { + "desc":"This API is used to query subscribed alarms.For details, see Calling APIs.GET /v2/{project_id}/alarm-subsNoneStatus code: 200Status code: 200Alarm subscription list queri", + "product_code":"DWS", + "title":"Querying the Alarm Subscription List", + "uri":"ListAlarmSubs.html", + "doc_type":"api", + "p_code":"126", + "code":"130" + }, + { + "desc":"This API is used to create an alarm subscription.For details, see Calling APIs.POST /v2/{project_id}/alarm-subsStatus code: 200Create an alarm subscription (Subscription ", + "product_code":"DWS", + "title":"Creating an Alarm Subscription", + "uri":"CreateAlarmSub.html", + "doc_type":"api", + "p_code":"126", + "code":"131" + }, + { + "desc":"This API is used to modify an alarm subscription.For details, see Calling APIs.PUT /v2/{project_id}/alarm-subs/{alarm_sub_id}Status code: 200Modify the zrf-test-13 alarm ", + "product_code":"DWS", + "title":"Modifying an Alarm Subscription", + "uri":"UpdateAlarmSub.html", + "doc_type":"api", + "p_code":"126", + "code":"132" + }, + { + "desc":"This API is used to delete an alarm subscription.For details, see Calling APIs.DELETE /v2/{project_id}/alarm-subs/{alarm_sub_id}NoneStatus code: 200Status code: 200Alarm ", + "product_code":"DWS", + "title":"Deleting an Alarm Subscription", + "uri":"DeleteAlarmSub.html", + "doc_type":"api", + "p_code":"126", + "code":"133" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Event Management", + "uri":"dws_02_0525.html", + "doc_type":"api", + "p_code":"8", + "code":"134" + }, + { + "desc":"This API is used to query event list.For details, see Calling APIs.GET /v2/{project_id}/eventsNoneStatus code: 200Status code: 200Event list of the cluster queried.", + "product_code":"DWS", + "title":"Querying Event List", + "uri":"ListEvents.html", + "doc_type":"api", + "p_code":"134", + "code":"135" + }, + { + "desc":"This API is used to query event configurations.For details, see Calling APIs.GET /v2/{project_id}/event-specsNoneStatus code: 200Status code: 200Event configurations of a", + "product_code":"DWS", + "title":"Querying Event Configurations", + "uri":"ListEventSpecs.html", + "doc_type":"api", + "p_code":"134", + "code":"136" + }, + { + "desc":"This API is used to query subscribed events.For details, see Calling APIs.GET /v2/{project_id}/event-subsNoneStatus code: 200Status code: 200Subscribed events queried.", + "product_code":"DWS", + "title":"Querying Subscribed Events", + "uri":"ListEventSubs.html", + "doc_type":"api", + "p_code":"134", + "code":"137" + }, + { + "desc":"This API is used to create an event subscription.For details, see Calling APIs.POST /v2/{project_id}/event-subsStatus code: 200Create a subscription (Subscription name zr", + "product_code":"DWS", + "title":"Creating an Event Subscription", + "uri":"CreateEventSub.html", + "doc_type":"api", + "p_code":"134", + "code":"138" + }, + { + "desc":"This API is used to modify a subscribed event.For details, see Calling APIs.PUT /v2/{project_id}/event-subs/{event_sub_id}Status code: 200Modify the zrf-test-66 event sub", + "product_code":"DWS", + "title":"Modifying a Subscribed Event", + "uri":"UpdateEventSub.html", + "doc_type":"api", + "p_code":"134", + "code":"139" + }, + { + "desc":"This API is used to delete a subscribed event.For details, see Calling APIs.DELETE /v2/{project_id}/event-subs/{event_sub_id}NoneStatus code: 200Status code: 200Event sub", + "product_code":"DWS", + "title":"Deleting a Subscribed Event", + "uri":"DeleteEventSub.html", + "doc_type":"api", + "p_code":"134", + "code":"140" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Task Management", + "uri":"dws_02_0604.html", + "doc_type":"api", + "p_code":"8", + "code":"141" + }, + { + "desc":"This API is used to query the task progress.For details, see Calling APIs.GET /v1.0/{project_id}/job/{job_id}NoneStatus code: 200Status code: 200Task progress queried.", + "product_code":"DWS", + "title":"Querying the Task Progress", + "uri":"ListJobDetails.html", + "doc_type":"api", + "p_code":"141", + "code":"142" + }, + { + "desc":"This API is used to query cluster task details.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/actions/{action_name}NoneStatus code: 200Query det", + "product_code":"DWS", + "title":"Querying Cluster Task Details", + "uri":"ListClusterActions.html", + "doc_type":"api", + "p_code":"141", + "code":"143" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"DWS", "title":"Tag Management", - "uri":"dws_02_0045.html", + "uri":"dws_02_0563.html", "doc_type":"api", "p_code":"8", - "code":"24" + "code":"144" }, { - "desc":"A tag is a key-value pair customized by users and used to classify and search for cloud resources.A tag consists of a tag key and a tag value.A tag key can contain multip", - "product_code":"dws", - "title":"Tagging", - "uri":"dws_02_0055.html", - "doc_type":"api", - "p_code":"24", - "code":"25" - }, - { - "desc":"This API is used to query the tags of a project.NoneStatus code: 200Status code: 200The project tags are queried successfully.", + "desc":"This API is used to query project tag list.For details, see Calling APIs.GET /v1.0/{project_id}/tagsNoneStatus code: 200Status code: 200Project tags queried.", "product_code":"DWS", - "title":"Querying Tags in a Project", - "uri":"dws_02_0050.html", + "title":"Querying Project Tags", + "uri":"ListTags.html", "doc_type":"api", - "p_code":"24", - "code":"26" + "p_code":"144", + "code":"145" }, { - "desc":"This API is used to query the tags of a cluster.NoneStatus code: 200Status code: 200The cluster tags are queried successfully.", + "desc":"This API is used to query tag information of a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/tagsNoneStatus code: 200Status code: 200", "product_code":"DWS", "title":"Querying Cluster Tags", - "uri":"dws_02_0049.html", + "uri":"ListClusterTags.html", "doc_type":"api", - "p_code":"24", - "code":"27" + "p_code":"144", + "code":"146" }, { - "desc":"This API is used to add tags to a cluster in batches.Status code: 200Tags are added in batches.NoneAdd tags whose key is key and value is value in batches.None", + "desc":"This API is used to batch add tags to a specified cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-createStatus code: 200Tag", "product_code":"DWS", "title":"Adding Tags in Batches", - "uri":"dws_02_0047.html", + "uri":"BatchCreateResourceTag.html", "doc_type":"api", - "p_code":"24", - "code":"28" + "p_code":"144", + "code":"147" }, { - "desc":"This API is used to delete tags from a cluster in batches.Status code: 200Tags are deleted in batches.NoneDelete tags whose key is key and value is value in batches.None", + "desc":"This API is used to delete tags from a specified cluster in batches.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-deleteStatus co", "product_code":"DWS", - "title":"Deleting Tags in Batches", - "uri":"dws_02_0048.html", + "title":"Delete Tags in Batches", + "uri":"BatchDeleteResourceTag.html", "doc_type":"api", - "p_code":"24", - "code":"29" + "p_code":"144", + "code":"148" }, { - "desc":"This section describes fine-grained permissions management for your GaussDB(DWS) service using IAM. You can skip this section if your cloud account already satisfies your", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Audit Logs", + "uri":"dws_02_0536.html", + "doc_type":"api", + "p_code":"8", + "code":"149" + }, + { + "desc":"This API is used to query audit logs.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/audit-log-recordsNoneStatus code: 200Status code: 200Query", + "product_code":"DWS", + "title":"Querying Log Records", + "uri":"ListAuditLog.html", + "doc_type":"api", + "p_code":"149", + "code":"150" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"DWS", + "title":"Log Management", + "uri":"dws_02_0799.html", + "doc_type":"api", + "p_code":"8", + "code":"151" + }, + { + "desc":"This API is used to query the LTS log list.For details, see Calling APIs.GET /v1/{project_id}/clusters/{cluster_id}/lts-logsNoneStatus code: 200Status code: 200LTS log li", + "product_code":"DWS", + "title":"Obtaining the LTS Log List", + "uri":"ListLtsLogs.html", + "doc_type":"api", + "p_code":"151", + "code":"152" + }, + { + "desc":"This API is used to disable LTS for a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/disableNoneStatus code: 200LTS disabled.N", + "product_code":"DWS", + "title":"Disabling LTS", + "uri":"DisableLtsLogs.html", + "doc_type":"api", + "p_code":"151", + "code":"153" + }, + { + "desc":"This API is used to enable LTS for a cluster.For details, see Calling APIs.POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/enableNoneStatus code: 200LTS enabled.None", + "product_code":"DWS", + "title":"Enabling LTS", + "uri":"EnableLtsLogs.html", + "doc_type":"api", + "p_code":"151", + "code":"154" + }, + { + "desc":"This section describes fine-grained permissions management for your DWS service using IAM. You can skip this section if your cloud account already satisfies your needs.By", "product_code":"dws", - "title":"Permissions Policies and Supported Actions", - "uri":"dws_02_0056.html", + "title":"Permissions and Supported Actions", + "uri":"dws_02_0061.html", "doc_type":"api", "p_code":"", - "code":"30" + "code":"155" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -276,7 +1401,7 @@ "uri":"dws_02_0066.html", "doc_type":"api", "p_code":"", - "code":"31" + "code":"156" }, { "desc":"Table 1 describes the status code.", @@ -284,8 +1409,8 @@ "title":"Status Code", "uri":"dws_02_0038.html", "doc_type":"api", - "p_code":"31", - "code":"32" + "p_code":"156", + "code":"157" }, { "desc":"No data is returned if an API fails to be called. You can locate the cause of error according to the error code of each API. When the calling fails, HTTP status code 4xx ", @@ -293,44 +1418,44 @@ "title":"Error Code", "uri":"dws_02_0030.html", "doc_type":"api", - "p_code":"31", - "code":"33" + "p_code":"156", + "code":"158" }, { - "desc":"Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using GaussDB(DWS).If you have already created a VPC, you do ", + "desc":"Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using DWS.If you have already created a VPC, you do not need ", "product_code":"dws", "title":"Creating a VPC", "uri":"dws_02_0040.html", "doc_type":"api", - "p_code":"31", - "code":"34" + "p_code":"156", + "code":"159" }, { - "desc":"You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://", + "desc":"You can obtain the Project ID by calling the IAM API used to query project information based on the specified criteria.The API used to obtain a Project ID is GET https://", "product_code":"dws", - "title":"Obtaining a Project ID", + "title":"Obtaining Project ID", "uri":"dws_02_0011.html", "doc_type":"api", - "p_code":"31", - "code":"35" + "p_code":"156", + "code":"160" }, { - "desc":"An account ID (domain-id) is required for some URLs when an API is called. To obtain the account ID, do as follows:Log in to the management console.Click the username and", + "desc":"An account ID (domain-id) is required for some URLs when an API is called. To obtain the account ID, perform the following steps:Log in to the management console.Click th", "product_code":"dws", - "title":"Obtaining an Account", + "title":"Obtaining an Account ID", "uri":"dws_02_0067.html", "doc_type":"api", - "p_code":"31", - "code":"36" + "p_code":"156", + "code":"161" }, { - "desc":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain a cluster ID, perform the following operations:Log in to the GaussDB(DWS) console.In ", + "desc":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:You can obtain the cluster ID by calling ", "product_code":"dws", "title":"Obtaining the Cluster ID", "uri":"dws_02_00068.html", "doc_type":"api", - "p_code":"31", - "code":"37" + "p_code":"156", + "code":"162" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -339,6 +1464,6 @@ "uri":"dws_02_0031.html", "doc_type":"api", "p_code":"", - "code":"38" + "code":"163" } ] \ No newline at end of file diff --git a/docs/dws/api-ref/CancelReadonlyCluster.html b/docs/dws/api-ref/CancelReadonlyCluster.html new file mode 100644 index 000000000..3cf7b5537 --- /dev/null +++ b/docs/dws/api-ref/CancelReadonlyCluster.html @@ -0,0 +1,123 @@ + + +

Canceling Read-only Status of a Cluster

+

Function

This API is used to cancel the read-only status on the management console. When a cluster is in the read-only state, you cannot perform any database operations. The read-only state may be triggered because the disk usage is too high. You need to clear the cluster data or scale out the cluster.

+

Constraints

+

The read-only status can be canceled for clusters of version 1.7.2 or later.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cancel-readonly

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

The read-only state is removed successfully.

+

None

+
+

Example Requests

Cancel read-only status.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/cancel-readonly
+
+

Example Responses

Status code: 200

+

The read-only state is removed successfully.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The read-only state is removed successfully.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ChangeSecurityGroup.html b/docs/dws/api-ref/ChangeSecurityGroup.html new file mode 100644 index 000000000..c058a02c4 --- /dev/null +++ b/docs/dws/api-ref/ChangeSecurityGroup.html @@ -0,0 +1,147 @@ + + +

Modifying the Security Group of a Cluster

+

Function

This API is used to modify the security group of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/{project_id}/clusters/{cluster_id}/security-group

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

security_groups

+

Yes

+

Array of strings

+

Definition

+

Security group ID array.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

Cluster security group modified.

+

None

+
+

Example Requests

Request example for modifying a cluster security group.

+
PUT https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08a/clusters/58031bb5-7c1a-4449-a95f-3fbb6a91dfda/security-group
+
+{
+  "security_groups" : [ "b3c812cb-2d90-4d89-a3df-c5480d915e2e", "0fbe2c34-8123-42b5-955f-242229e9318e" ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster security group modified.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/CheckCluster.html b/docs/dws/api-ref/CheckCluster.html new file mode 100644 index 000000000..b702e3889 --- /dev/null +++ b/docs/dws/api-ref/CheckCluster.html @@ -0,0 +1,696 @@ + + +

Performing a Check Before Cluster Creation

+

Function

This API is used to perform a pre-check before cluster creation. It can identify problems such as insufficient subnets and quotas in advance, preventing cluster creation failures.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/cluster-precheck

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster

+

Yes

+

ClusterCheckBody object

+

Definition

+

Cluster verification object.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 ClusterCheckBody

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

flavor

+

Yes

+

String

+

Definition

+

Cluster flavor name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

availability_zones

+

Yes

+

Array of strings

+

Definition

+

AZ list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

num_node

+

Yes

+

Integer

+

Definition

+

Number of instance nodes.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

security_group_id

+

No

+

String

+

Definition

+

Security group ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

datastore_version

+

Yes

+

String

+

Definition

+

Cluster version.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

vpc_id

+

Yes

+

String

+

Definition

+

VPC ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_id

+

Yes

+

String

+

Definition

+

Subnet ID of the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_ip

+

No

+

OpenPublicIp object

+

Definition

+

EIP object.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

cross_spec_restore

+

No

+

String

+

Definition

+

Cross-specification restoration information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

volume

+

No

+

Volume object

+

Definition

+

Disk information object.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

old_cluster_hostname

+

No

+

String

+

Definition

+

Name of the old host.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

restore_point

+

No

+

RestorePoint object

+

Definition

+

Object about cluster restoration.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

tag_list

+

No

+

Array of Tag objects

+

Definition

+

Tag list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

dss_pool_id

+

No

+

String

+

Definition

+

Storage pool ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

db_port

+

No

+

String

+

Definition

+

Database port.

+

Constraints

+

N/A

+

Range

+

8000 to 30000

+

Default Value

+

8000

+

db_password

+

No

+

String

+

Definition

+

Administrator password.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

db_name

+

No

+

String

+

Definition

+

Administrator account.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

dbadmin

+

num_cn

+

No

+

Integer

+

Definition

+

Number of CN nodes.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

name

+

No

+

String

+

Definition

+

Cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 OpenPublicIp

Parameter

+

Mandatory

+

Type

+

Description

+

public_bind_type

+

No

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

  • auto_assign

    +

  • not_use: not use

    +

  • bind_existing

    +
+

Default Value

+

N/A

+

eip_id

+

No

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Volume

Parameter

+

Mandatory

+

Type

+

Description

+

volume

+

Yes

+

String

+

Definition

+

Disk name.

+

Constraints

+

N/A

+

Range

+

  • SSD: Ultra-high I/O

    +

  • SAS: High I/O

    +

  • SATA: Common I/O

    +
+

Default Value

+

N/A

+

capacity

+

No

+

Integer

+

Definition

+

Disk capacity in GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 RestorePoint

Parameter

+

Mandatory

+

Type

+

Description

+

back_ref

+

No

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

restore_time

+

No

+

Long

+

Definition

+

Restoration time.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

No

+

String

+

Definition

+

Original cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 Tag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

No

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

Pre-check for cluster creation succeeded.

+

None

+
+

Example Requests

Perform a check before cluster creation. For example, check whether the dws.m3.xlarge flavor, three nodes, public IP address, security group, and VPC are available in the AZ eu-de-01.

+
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/cluster-precheck
+
+{
+  "cluster" : {
+    "flavor" : "dws.m3.xlarge",
+    "num_node" : 3,
+    "availability_zones" : [ "eu-de-01" ],
+    "vpc_id" : "c9f1171e-dc90-4ae9-bf22-f9736983ce2d",
+    "subnet_id" : "ad9ef23f-1d03-4e52-af80-69604645e109",
+    "security_group_id" : "f54a4572-d5d2-40b6-823a-79049bd5b71c",
+    "public_ip" : {
+      "public_bind_type" : "bind_existing",
+      "eip_id" : "1923e8b0-cd40-4469-8cb1-64546c7b530c"
+    },
+    "datastore_version" : "8.2.0"
+  }
+}
+
+

Example Responses

Status code: 200

+

Pre-check for cluster creation succeeded.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Pre-check for cluster creation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/CheckClusterShrink.html b/docs/dws/api-ref/CheckClusterShrink.html new file mode 100644 index 000000000..9f0be379d --- /dev/null +++ b/docs/dws/api-ref/CheckClusterShrink.html @@ -0,0 +1,196 @@ + + +

Performing a Scale-in Check

+

Function

This API is used to perform a re-scale-in check. It can ensure that the requirements are met before and after the scale-in.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/shrink-check

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

check_item

+

Yes

+

String

+

Definition

+

Check item. The value can only be one of the following:

+

Constraints

+

N/A

+

Range

+

guc: Check whether the current GUC parameters meet the scale-in requirements.

+

schema: Check whether there are tables that affect scale-in in all schemas.

+

disk: Check whether the disk capacity meets the requirements after scale-in.

+

Default Value

+

N/A

+

shrink_count

+

Yes

+

Integer

+

Definition

+

Number of nodes to be deleted.

+

Constraints

+

N/A

+

Range

+

Minimum value: 3. Maximum value: Total number of nodes - 3.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

is_passed

+

Boolean

+

Definition

+

Whether the check is passed. If the check fails, you need to adjust the number of nodes to be removed and try again, or the current cluster does not meet the pre-scale-in conditions.

+

Range

+

N/A

+
+
+
+

Example Requests

  • Scale in three nodes and set the check item to guc.

    +
    POST https://{Endpoint} /v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-check?check_item=guc&shrink_count=3
    +

  • Scale in three nodes and set the check item to schema.

    +
    POST https://{Endpoint} /v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-check?check_item=schema&shrink_count=3
    +

  • Scale in three nodes and set the check item to disk.

    +
    POST https://{Endpoint} /v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-check?check_item=disk&shrink_count=3
    +
+
+

Example Responses

Status code: 200

+

The pre-scale-in check request is submitted.

+
{
+  "is_passed" : true
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The pre-scale-in check request is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/CheckGrowCluster.html b/docs/dws/api-ref/CheckGrowCluster.html new file mode 100644 index 000000000..f0b60203f --- /dev/null +++ b/docs/dws/api-ref/CheckGrowCluster.html @@ -0,0 +1,460 @@ + + +

Performing a Scale-Out Check

+

Function

This API is used to conduct a precheck for cluster scale-out to identify failures caused by insufficient subnets or permissions.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/grow-check

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

scale_out

+

Yes

+

ScaleOut object

+

Definition

+

Request body for adding an idle node or scaling out a cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

create_node_only

+

No

+

Boolean

+

Definition

+

Whether only idle nodes are added.

+

Constraints

+

N/A

+

Range

+

true: Only nodes are added. If scale-out is required, perform it separately.

+

false: Nodes are added and the cluster is scaled out.

+

Default Value

+

false

+

waiting_for_killing

+

No

+

Integer

+

Definition

+

Time before blocked job termination.

+

Constraints

+

This parameter is available only for GuestAgent 8.2.1 or later.

+

Range

+

30 to 1200

+

Default Value

+

0 (not limited)

+

auto_redistribute

+

No

+

Boolean

+

Definition

+

Whether to automatically start redistribution after scale-out. The default value is true. If this parameter is set to false, redistribution is not performed after scale-out. In this case, the cluster task information displays To be redistributed and other operations cannot be performed.

+

Constraints

+

N/A

+

Range

+

true: Redistribution is performed immediately after scale-out.

+

false: Redistribution is not performed after scale-out. In this case, the cluster task information displays To be redistributed.

+

Default Value

+

true

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ScaleOut

Parameter

+

Mandatory

+

Type

+

Description

+

count

+

Yes

+

Integer

+

Definition

+

Number of nodes to be added.

+

Range

+

Greater than or equal to 3

+

subnet_id

+

No

+

String

+

Definition

+

Subnet ID.

+

Range

+

The value is a valid subnet ID in the same VPC.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

data

+

Array of GrowCheckResult objects

+

Definition

+

Pre-scale-out check information.

+

Range

+

N/A

+

note

+

NoteInfo object

+

Definition

+

Message displayed before the scale-out.

+

Value range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 GrowCheckResult

Parameter

+

Type

+

Description

+

pass

+

Boolean

+

Definition

+

Whether the check is passed. By default, the items that pass the check are not displayed.

+

Range

+

true/false

+

reason

+

String

+

Definition

+

Reason that the check fails.

+

Range

+

N/A

+

required

+

Boolean

+

Definition

+

Whether the check item is mandatory.

+

Range

+

  • true: The check item is mandatory. If the check item fails, the scale-out is not allowed or fails.

    +

  • false: The check item is not mandatory. If the check fails, only a message is displayed indicating the risk and the cluster can be scaled out.

    +
+

desc

+

String

+

Definition

+

Description.

+

Range

+

N/A

+

type

+

String

+

Definition

+

Type.

+

Range

+

Quota, permission, version, and status

+
+
+ +
+ + + + + + + + + +
Table 6 NoteInfo

Parameter

+

Type

+

Description

+

bucket_split_info

+

BucketSplitInfo object

+

Definition

+

Redistribution message.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 BucketSplitInfo

Parameter

+

Type

+

Description

+

current_dn_num

+

Integer

+

Definition

+

Number of current DNs.

+

Range

+

N/A

+

after_scale_out_dn_num

+

Integer

+

Definition

+

Number of DN nodes after scale-out.

+

Range

+

N/A

+

current_bucket_num

+

Integer

+

Definition

+

Number of current buckets.

+

Range

+

N/A

+

after_scale_out_bucket_num

+

Integer

+

Definition

+

Number of buckets after scale-out.

+

Range

+

N/A

+

is_bucket_split

+

Boolean

+

Definition

+

Whether bucket splitting is involved in scale-out.

+

Range

+

N/A

+

bucket_tilt_rate

+

String

+

Definition

+

Bucket tilt rate on DN nodes. It is used to measure the imbalance of buckets on DN nodes.

+

Range

+

N/A

+

after_scale_out_bucket_tilt_rate

+

String

+

Definition

+

Bucket tilt rate on DN nodes after scale-out. It is used to measure the imbalance of buckets on DN nodes after scale-out.

+

Range

+

N/A

+
+
+
+

Example Requests

Check whether the quota or permission is sufficient when three nodes are added to a cluster.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/grow-check
+
+{
+  "scale_out" : {
+    "count" : 3
+  }
+}
+
+

Example Responses

Status code: 200

+

Request submitted.

+
{
+  "note" : {
+    "bucket_split_info" : {
+      "current_dn_num" : 6,
+      "after_scale_out_bucket_num" : 32,
+      "is_bucket_split" : false,
+      "after_scale_out_dn_num" : 9,
+      "bucket_tilt_rate" : "16.67%",
+      "after_scale_out_bucket_tilt_rate" : "25.00%"
+    }
+  },
+  "data" : [ {
+    "pass" : false,
+    "reason" : "Subnet IP address quota exceeded. Required: 3; Used: 249/251",
+    "required" : true,
+    "desc" : "Subnet IP address check",
+    "type" : "Quota"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/CheckTableRestore.html b/docs/dws/api-ref/CheckTableRestore.html new file mode 100644 index 000000000..3a240106f --- /dev/null +++ b/docs/dws/api-ref/CheckTableRestore.html @@ -0,0 +1,295 @@ + + +

Checking the Name of the Table to Be Restored

+

Function

This API is used to check the name of the table to be restored.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore-check

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

case_sensitive

+

Yes

+

Boolean

+

Definition

+

Whether the name is case sensitive.

+

Range

+

N/A

+

database

+

Yes

+

String

+

Definition

+

Database name.

+

Range

+

N/A

+

restore_table_list

+

Yes

+

Array of TableDetail objects

+

Definition

+

Source table information.

+

Range

+

N/A

+

target_table_list

+

Yes

+

Array of TableDetail objects

+

Definition

+

Destination table information.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 TableDetail

Parameter

+

Mandatory

+

Type

+

Description

+

schema_name

+

Yes

+

String

+

Definition

+

Schema name.

+

Range

+

N/A

+

table_name

+

Yes

+

String

+

Definition

+

Table name.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

check_table_name_result

+

CheckTableNameResult object

+

Definition

+

Check result.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 CheckTableNameResult

Parameter

+

Type

+

Description

+

database

+

String

+

Definition

+

Database name.

+

Range

+

N/A

+

restore_table_list

+

Array of strings

+

Definition

+

Information about the source tables in a restoration.

+

Range

+

N/A

+

target_table_list

+

Array of strings

+

Definition

+

Information about the destination tables in a restoration.

+

Range

+

N/A

+
+
+
+

Example Requests

POST https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/snapshots/c719b1a7-c85c-4cb5-a721-7694908c2c11/table-restore-check
+
+{
+  "case_sensitive" : true,
+  "database" : "postgres",
+  "restore_table_list" : [ {
+    "schema_name" : "postgres",
+    "table_name" : "public"
+  } ],
+  "target_table_list" : [ {
+    "schema_name" : "postgres",
+    "table_name" : "public"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

The name of the table to be restored is checked.

+
{
+  "check_table_name_result" : {
+    "database" : "postgres",
+    "restore_table_list" : null,
+    "target_table_list" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The name of the table to be restored is checked.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ConvertToLogicalCluster.html b/docs/dws/api-ref/ConvertToLogicalCluster.html new file mode 100644 index 000000000..4132aa150 --- /dev/null +++ b/docs/dws/api-ref/ConvertToLogicalCluster.html @@ -0,0 +1,165 @@ + + +

Converting a Physical Cluster to a Logical Cluster

+

Function

This API is used to convert a physical cluster to a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/convert-to-logical-cluster/{name}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

name

+

Yes

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Convert a physical cluster to a logical cluster.

+
POST https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/convert-to-logical-cluster/elastic_group
+
+

Example Responses

Status code: 200

+

Request for converting to a logical cluster submitted.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for converting to a logical cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/CopySnapshot.html b/docs/dws/api-ref/CopySnapshot.html new file mode 100644 index 000000000..196f775fd --- /dev/null +++ b/docs/dws/api-ref/CopySnapshot.html @@ -0,0 +1,185 @@ + + +

Copying a Snapshot

+

Function

This API is used to copy an automated snapshot.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/snapshots/{snapshot_id}/linked-copy

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

backup_name

+

Yes

+

String

+

Definition

+

Snapshot name.

+

Range

+

N/A

+

description

+

No

+

String

+

Definition

+

Description.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

snapshot_id

+

String

+

Definition

+

Snapshot ID.

+

Range

+

N/A

+
+
+
+

Example Requests

Copy an automated snapshot. The snapshot name is test1.

+
POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/linked-copy
+
+{
+  "backup_name" : "backup20",
+  "description" : "description"
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "snapshot_id" : "4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba92"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/CreateAlarmSub.html b/docs/dws/api-ref/CreateAlarmSub.html new file mode 100644 index 000000000..e9ee5e5a3 --- /dev/null +++ b/docs/dws/api-ref/CreateAlarmSub.html @@ -0,0 +1,344 @@ + + +

Creating an Alarm Subscription

+

Function

This API is used to create an alarm subscription.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/alarm-subs

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Subscribed alarm name.

+

Range

+

N/A

+

enable

+

No

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

N/A

+

alarm_level

+

No

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

notification_target

+

Yes

+

String

+

Definition

+

Message topic address.

+

Range

+

N/A

+

notification_target_name

+

Yes

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

Yes

+

String

+

Definition

+

Message topic type. Only SMN is supported.

+

Range

+

N/A

+

time_zone

+

Yes

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Alarm subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscribed alarm name.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

N/A

+

alarm_level

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the alarm belongs.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Message topic address.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message topic type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

Create an alarm subscription (Subscription name: zrf-test-12. Alarm m severity: critical,major,minor. SMN topic name: dws-test-nodelete. Topic address: urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).

+
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs
+
+{
+  "alarm_level" : "urgent,important,minor",
+  "enable" : 1,
+  "name" : "zrf-test-12",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Example Responses

Status code: 200

+

Alarm subscription created.

+
{
+  "id" : "273ce506-dad8-411c-92f9-be5004739b40",
+  "name" : "zrf-test-12",
+  "enable" : 1,
+  "language" : "zh-cn",
+  "alarm_level" : "urgent,important,minor",
+  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+  "name_space" : "dws",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm subscription created.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/CreateCluster.html b/docs/dws/api-ref/CreateCluster.html new file mode 100644 index 000000000..304734d34 --- /dev/null +++ b/docs/dws/api-ref/CreateCluster.html @@ -0,0 +1,537 @@ + + +

Creating a Cluster

+

Function

This API is used to create a cluster.

+

The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.

+

This API is an asynchronous API. It takes 10 to 15 minutes to create a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster

+

Yes

+

CreateClusterInfo object

+

Definition

+

Cluster object.

+

Range

+

Non-null object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 CreateClusterInfo

Parameter

+

Mandatory

+

Type

+

Description

+

node_type

+

Yes

+

String

+

Definition

+

Node flavor ID. To obtain the value, call the API for querying flavors and view the id field in the API response.

+

Constraints

+

N/A

+

Range

+

The value must be the flavor ID returned by the API for querying flavors.

+

Default Value

+

N/A

+

number_of_node

+

Yes

+

Integer

+

Definition

+

Number of nodes.

+

Constraints

+

N/A

+

Range

+

For a cluster, the value is from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.

+

Default Value

+

N/A

+

subnet_id

+

Yes

+

String

+

Definition

+

Subnet ID, which is used for configuring the cluster network.

+

Constraints

+

N/A

+

Range

+

The value must be a subnet in the VPC ID.

+

Default Value

+

N/A

+

security_group_id

+

Yes

+

String

+

Definition

+

Security group ID, which is used for configuring the cluster network.

+

Constraints

+

N/A

+

Range

+

If this parameter is not left blank, it must be a valid security group ID. If this parameter is left blank, the system automatically creates a security group.

+

Default Value

+

null

+

vpc_id

+

Yes

+

String

+

Definition

+

VPC ID, which is used for configuring cluster network.

+

Constraints

+

N/A

+

Range

+

The value must be a valid VPC ID.

+

Default Value

+

N/A

+

availability_zone

+

No

+

String

+

Definition

+

AZ of the cluster.

+

Constraints

+

N/A

+

Range

+

The AZ code must be valid at the current region and visible to the current user.

+

Default Value

+

AZ code of the first available AZ.

+

port

+

No

+

Integer

+

Definition

+

Cluster database port.

+

Constraints

+

N/A

+

Range

+

8000 to 30000

+

Default Value

+

8000

+

name

+

Yes

+

String

+

Definition

+

Cluster name.

+

Constraints

+

The value must be unique. It must contain 4 to 64 characters and start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.

+

Range

+

4 to 64 characters

+

Default Value

+

8000

+

user_name

+

Yes

+

String

+

Definition

+

Administrator username for logging in to a GaussDB(DWS) cluster.

+

Constraints

+

  • Only lowercase letters, digits, and underscores (_) are allowed.

    +

  • The value must start with a lowercase letter or an underscore (_).

    +

  • The value can contain 1 to 63 characters.

    +

  • The value cannot be a keyword of the GaussDB(DWS) database.

    +
+

Range

+

1 to 63 characters

+

Default Value

+

dbadmin

+

user_pwd

+

Yes

+

String

+

Definition

+

Administrator password for logging in to a GaussDB(DWS) cluster.

+

Constraints

+

N/A

+

Range

+

The value can contain 12 to 32 characters.

+

The value can contain at least three types of the following characters: uppercase letters, lowercase letters, numbers, and special characters (~!?,.:;_(){}[]/<>@#%^&*+|\=-).

+

The value must be different from the username or the username spelled backwards.

+

Default Value

+

N/A

+

public_ip

+

No

+

PublicIp object

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

number_of_cn

+

No

+

Integer

+

Definition

+

Number of CNs deployed.

+

Constraints

+

N/A

+

Range

+

2 to Number of cluster nodes. The maximum value is 20.

+

Default Value

+

3

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

tags

+

No

+

Tags object

+

Definition

+

Tag. By default, no tags are specified for the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 PublicIp

Parameter

+

Mandatory

+

Type

+

Description

+

public_bind_type

+

No

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

auto_assign

+

not_use

+

bind_existing

+

Default Value

+

null

+

eip_id

+

No

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Tags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

Yes

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

Cluster object

+

Definition

+

Cluster object.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 7 Cluster

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+
+
+
+

Example Requests

Create a data warehouse cluster (AZ: az1.dc1. Node flavor: dws.m1.xlarge.ultrahigh. Nodes: 3. Database port: 8000. The public IP address, the security group ID, subnet ID, and VPC ID are configured.)

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
+
+{
+  "cluster" : {
+    "node_type" : "dws.m1.xlarge.ultrahigh",
+    "number_of_node" : 3,
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "availability_zone" : "az1.dc1",
+    "port" : 8000,
+    "name" : "dws-1",
+    "user_name" : "dbadmin",
+    "user_pwd" : "Passw0rd!",
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : ""
+    },
+    "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada"
+  }
+}
+
+

Example Responses

Status code: 200

+

Request for creating a cluster submitted.

+
{
+  "cluster" : {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for creating a cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/CreateClusterDns.html b/docs/dws/api-ref/CreateClusterDns.html new file mode 100644 index 000000000..29854a0e0 --- /dev/null +++ b/docs/dws/api-ref/CreateClusterDns.html @@ -0,0 +1,175 @@ + + +

Applying for a Domain Name

+

Function

This API is used to apply for a domain name for a specified cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/dns

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Domain name to be created.

+

Range

+

N/A

+

type

+

Yes

+

String

+

Definition

+

Domain name type.

+

Range

+

public

+

private

+

ttl

+

Yes

+

Integer

+

Definition

+

Caching duration of the SOA record set, in seconds. The default value is 300, in seconds.

+

Range

+

300 to 2147483647

+
+
+
+

Response Parameters

Status code: 200

+

The domain name is successfully applied for.

+

None

+
+

Example Requests

Apply for the public domain name demo (SOA cache duration is 300s).

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/dns
+
+{
+  "name" : "demo",
+  "type" : "public",
+  "ttl" : 300
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The domain name is successfully applied for.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/CreateClusterV2.html b/docs/dws/api-ref/CreateClusterV2.html new file mode 100644 index 000000000..660856843 --- /dev/null +++ b/docs/dws/api-ref/CreateClusterV2.html @@ -0,0 +1,706 @@ + + +

Creating a Cluster (V2)

+

Function

This API is used to create a cluster.

+

The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.

+

This API is an asynchronous API. It takes 10 to 15 minutes to create a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster

+

No

+

V2CreateCluster object

+

Definition

+

Request body for creating a cluster (V2).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 V2CreateCluster

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Cluster name, which must be unique.

+

Constraints

+

N/A

+

Range

+

The value must be unique. It must contain 4 to 64 characters and start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.

+

Default Value

+

N/A

+

flavor

+

Yes

+

String

+

Definition

+

Cluster flavor code.

+

Constraints

+

N/A

+

Range

+

See the flavor code returned by the API for querying flavor.

+

Default Value

+

N/A

+

num_cn

+

No

+

Integer

+

Definition

+

Number of CNs in a cluster.

+

Constraints

+

N/A

+

Range

+

2 to The number of cluster nodes. Maximum value: 20. Default value: 3.

+

Default Value

+

N/A

+

num_node

+

Yes

+

Integer

+

Definition

+

Number of nodes in a cluster.

+

Constraints

+

N/A

+

Range

+

For a cluster, the value is from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.

+

Default Value

+

N/A

+

db_name

+

Yes

+

String

+

Definition

+

Administrator username.

+

Constraints

+

N/A

+

Range

+

Contain only lowercase letters, digits, and underscores (). Must start with a lowercase letter or an underscore ().

+

Contain 1 to 63 characters.

+

Cannot be a keyword of the GaussDB(DWS) database.

+

Default Value

+

N/A

+

db_password

+

Yes

+

String

+

Definition

+

Password of the administrator.

+

Constraints

+

N/A

+

Range

+

12 to 32 characters.

+

At least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!?, .:;-_(){}[]/<>@# %^&*+|=).

+

Cannot be the username or the username spelled backwards.

+

Default Value

+

N/A

+

db_port

+

Yes

+

Integer

+

Definition

+

Cluster database port.

+

Constraints

+

N/A

+

Range

+

8000 to 30000

+

Default Value

+

8000

+

dss_pool_id

+

No

+

String

+

Definition

+

Dedicated storage pool ID. Generally, you do not need to specify this parameter.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

availability_zones

+

Yes

+

Array of strings

+

Definition

+

AZ information. When creating a 3-AZ cluster, you need to enter three different AZs.

+

Constraints

+

N/A

+

Range

+

To obtain the value, see Querying AZs.

+

Default Value

+

N/A

+

tags

+

No

+

Array of Tags objects

+

Definition

+

Tag information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

vpc_id

+

Yes

+

String

+

Definition

+

VPC ID, which is used for configuring cluster network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

subnet_id

+

Yes

+

String

+

Definition

+

Subnet ID, which is used for configuring the cluster network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

security_group_id

+

No

+

String

+

Definition

+

Security group ID, which is used for configuring the cluster network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

public_ip

+

No

+

PublicIp object

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

datastore_version

+

Yes

+

String

+

Definition

+

Cluster version.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

master_key_id

+

No

+

String

+

Definition

+

KMS key ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

master_key_name

+

No

+

String

+

Definition

+

KMS key name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

crypt_algorithm

+

No

+

String

+

Definition

+

KMS encryption algorithm.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

volume

+

Yes

+

Volume object

+

Definition

+

Disk information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

ipv6_enable

+

No

+

Boolean

+

Definition

+

Network protocol type. It indicates whether IPv6 is supported. By default, IPv6 is not used. If IPv6 is used, the selected subnet must support IPv6.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Tags

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

Yes

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 PublicIp

Parameter

+

Mandatory

+

Type

+

Description

+

public_bind_type

+

No

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

auto_assign

+

not_use

+

bind_existing

+

Default Value

+

null

+

eip_id

+

No

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Volume

Parameter

+

Mandatory

+

Type

+

Description

+

volume

+

Yes

+

String

+

Definition

+

Disk name.

+

Constraints

+

N/A

+

Range

+

  • SSD: Ultra-high I/O

    +

  • SAS: High I/O

    +

  • SATA: Common I/O

    +
+

Default Value

+

N/A

+

capacity

+

No

+

Integer

+

Definition

+

Disk capacity in GB.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

Cluster object

+

Definition

+

Cluster object.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 8 Cluster

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+
+
+
+

Example Requests

Create a multi-AZ DWS cluster (Cluster version: 8.2.1. AZs: az1 and az2. Node flavor: dws.m1.xlarge.ultrahigh. Nodes: 3. Disk type: SSD disk with 100 GB capacity. Database port: 8000. Public IP address, security Group ID, Subnet ID, VPC ID are configured).

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters
+
+{
+  "cluster" : {
+    "flavor" : "dws.m1.xlarge.ultrahigh",
+    "num_node" : 3,
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "db_port" : 8000,
+    "datastore_version" : "8.2.1",
+    "availability_zones" : [ "az1", "az2" ],
+    "name" : "dws-1",
+    "num_cn" : 3,
+    "db_name" : "dbadmin",
+    "db_password" : "Passw0rd!",
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : ""
+    },
+    "volume" : {
+      "volume" : "SSD",
+      "capacity" : 100
+    },
+    "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada"
+  }
+}
+
+

Example Responses

Status code: 200

+

The request for creating a cluster is submitted.

+
{
+  "cluster" : {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The request for creating a cluster is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/CreateClusterWorkload.html b/docs/dws/api-ref/CreateClusterWorkload.html new file mode 100644 index 000000000..28364d924 --- /dev/null +++ b/docs/dws/api-ref/CreateClusterWorkload.html @@ -0,0 +1,230 @@ + + +

Enabling or Disabling Resource Management

+

Function

This API is used to enable or disable resource management. The function is enabled by default for new clusters.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

workload_status

+

No

+

WorkloadStatus object

+

Definition

+

Request for resource management status

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 WorkloadStatus

Parameter

+

Mandatory

+

Type

+

Description

+

workload_switch

+

Yes

+

String

+

Definition

+

Switch

+

Constraints

+

N/A

+

Range

+

on: enabled

+

off: disabled

+

Default Value

+

N/A

+

max_concurrency_num

+

No

+

Integer

+

Definition

+

Maximum concurrency

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

Enable resource management and set the maximum number of concurrent tasks to 5.

+
POST https://{Endpoint} /v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload
+
+

Example Responses

Status code: 200

+

Resource management configured.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource management configured.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/CreateEventSub.html b/docs/dws/api-ref/CreateEventSub.html new file mode 100644 index 000000000..d2436bfdc --- /dev/null +++ b/docs/dws/api-ref/CreateEventSub.html @@ -0,0 +1,440 @@ + + +

Creating an Event Subscription

+

Function

This API is used to create an event subscription.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/event-subs

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Event subscription name.

+

Range

+

N/A

+

source_type

+

No

+

String

+

Definition

+

Event source type.

+

Range

+

cluster, backup, or disaster-recovery

+

source_id

+

No

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

category

+

No

+

String

+

Definition

+

Event category.

+

Range

+

management, monitor, security, or system alarm.

+

severity

+

No

+

String

+

Definition

+

Event severity.

+

Range

+

The value can be normal or warning.

+

tag

+

No

+

String

+

Definition

+

Event tag.

+

Range

+

N/A

+

enable

+

No

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

1: enabled; 0: disabled.

+

notification_target

+

Yes

+

String

+

Definition

+

Message notification address.

+

Range

+

N/A

+

notification_target_name

+

Yes

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

Yes

+

String

+

Definition

+

The message notification type can only be SMN.

+

Range

+

N/A

+

time_zone

+

No

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscription name.

+

Range

+

N/A

+

source_type

+

String

+

Definition

+

Event source type.

+

Range

+

N/A

+

source_id

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

category

+

String

+

Definition

+

Event category.

+

Range

+

N/A

+

severity

+

String

+

Definition

+

Event severity.

+

Range

+

N/A

+

tag

+

String

+

Definition

+

Event tag.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

1: enabled; 0: disabled.

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Address for the message notification topic.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message notification topic.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message notification type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

Create a subscription (Subscription name zrf-test-66. Event severity: normal,warning. Message topic dws-test-nodelete. Address: urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete)

+
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs
+
+{
+  "severity" : "normal,warning",
+  "source_id" : "",
+  "source_type" : "",
+  "tag" : "",
+  "category" : "",
+  "enable" : 1,
+  "name" : "zrf-test-66",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Example Responses

Status code: 200

+

Event subscription created.

+
{
+  "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b",
+  "name" : "zrf-test-66",
+  "category" : "",
+  "severity" : "normal,warning",
+  "tag" : "",
+  "enable" : 1,
+  "language" : "zh-cn",
+  "source_type" : "",
+  "source_id" : "",
+  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+  "name_space" : "DWS",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Event subscription created.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Event Management
+
+
+ diff --git a/docs/dws/api-ref/CreateLogicalCluster.html b/docs/dws/api-ref/CreateLogicalCluster.html new file mode 100644 index 000000000..3026166cc --- /dev/null +++ b/docs/dws/api-ref/CreateLogicalCluster.html @@ -0,0 +1,391 @@ + + +

Creating a Logical Cluster

+

Function

This API is used to create a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/logical-clusters

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

logical_cluster

+

Yes

+

CreateLogicalClusterInfo object

+

Definition

+

Information required for creating a logical cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 CreateLogicalClusterInfo

Parameter

+

Mandatory

+

Type

+

Description

+

logical_cluster_name

+

Yes

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_rings

+

Yes

+

Array of ClusterRing objects

+

Definition

+

Information of the logical cluster ring.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ClusterRing

Parameter

+

Mandatory

+

Type

+

Description

+

ring_hosts

+

Yes

+

Array of RingHost objects

+

Definition

+

Cluster host information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

un_shrinkable_cluster_ring

+

No

+

Boolean

+

Definition

+

Whether scale-in is supported.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 RingHost

Parameter

+

Mandatory

+

Type

+

Description

+

host_name

+

Yes

+

String

+

Definition

+

Host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

back_ip

+

Yes

+

String

+

Definition

+

Backend IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cpu_cores

+

Yes

+

Integer

+

Definition

+

Number of host CPUs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

memory

+

Yes

+

Double

+

Definition

+

Host memory.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

disk_size

+

Yes

+

Double

+

Definition

+

Disk size of the host.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Create a logical cluster.

+
POST https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters
+
+{
+  "logical_cluster" : {
+    "logical_cluster_name" : "v3_logical",
+    "cluster_rings" : [ {
+      "ring_hosts" : [ {
+        "host_name" : "host-172-16-20-246",
+        "back_ip" : "172.16.73.90",
+        "cpu_cores" : 8,
+        "memory" : 32.0,
+        "disk_size" : 800.0
+      }, {
+        "host_name" : "host-172-16-4-26",
+        "back_ip" : "172.16.123.5",
+        "cpu_cores" : 8,
+        "memory" : 32.0,
+        "disk_size" : 800.0
+      }, {
+        "host_name" : "host-172-16-4-26",
+        "back_ip" : "172.16.123.5",
+        "cpu_cores" : 8,
+        "memory" : 32.0,
+        "disk_size" : 800.0
+      } ]
+    } ]
+  }
+}
+
+

Example Responses

Status code: 200

+

Request for creating a logical cluster submitted.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for creating a logical cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/CreateSnapshot.html b/docs/dws/api-ref/CreateSnapshot.html new file mode 100644 index 000000000..3dfb03e1d --- /dev/null +++ b/docs/dws/api-ref/CreateSnapshot.html @@ -0,0 +1,238 @@ + + +

Creating a Snapshot

+

Function

This API is used to create a snapshot for a specified cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/snapshots

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

snapshot

+

Yes

+

Snapshot object

+

Definition

+

Snapshot object.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Snapshot

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Snapshot name. It must be unique and start with a letter. It consists of 4 to 64 characters. Only letters (case-insensitive), digits, hyphens (-), and underscores (_) are allowed.

+

Range

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

ID of the cluster for which you want to create a snapshot.

+

Range

+

N/A

+

description

+

No

+

String

+

Definition

+

Snapshot description. If no value is specified, the description is empty. The value can contain a maximum of 256 characters. The following special characters are not allowed: !<>'=&"

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

snapshot

+

SnapshotResp object

+

Definition

+

Snapshot object.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 5 SnapshotResp

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Snapshot ID.

+

Range

+

N/A

+
+
+
+

Example Requests

Create a manual snapshot named snapshot-3 for the cluster whose ID is 44b277eb-39be-4921-be31-3d61b43651d7.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
+
+{
+  "snapshot" : {
+    "name" : "snapshot-3",
+    "cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7",
+    "description" : "Snapshot-3 description"
+  }
+}
+
+

Example Responses

Status code: 200

+

The snapshot is created.

+
{
+  "snapshot" : {
+    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The snapshot is created.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/CreateSnapshotPolicy.html b/docs/dws/api-ref/CreateSnapshotPolicy.html new file mode 100644 index 000000000..05cb0f141 --- /dev/null +++ b/docs/dws/api-ref/CreateSnapshotPolicy.html @@ -0,0 +1,281 @@ + + +

Adding a Snapshot Policy

+

Function

This API is used to configure a snapshot policy.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/snapshot-policies

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

keep_day

+

No

+

Integer

+

Definition

+

Retention days.

+

Range

+

1 to 31.

+

backup_strategies

+

No

+

Array of BackupStrategyRequest objects

+

Definition

+

Policy list. This parameter is mandatory when you add a policy.

+

Range

+

N/A

+

device_name

+

No

+

String

+

Definition

+

Backup device. OBS, NBU, and NFS are supported.

+

Range

+

N/A

+

server_port

+

No

+

String

+

Definition

+

Port of the NBU backup media. This parameter is mandatory when the backup medium is NBU.

+

Range

+

N/A

+

backup_param

+

No

+

String

+

Definition

+

NBU backup parameters. This parameter is mandatory when the backup medium is NBU.

+

Range

+

N/A

+

server_ips

+

No

+

Array of strings

+

Definition

+

IP address of the backup media. This parameter is mandatory when the backup medium is NBU or NFS. If the backup medium is NBU, it indicates the address of the NBU server. If the backup medium is NFS, it indicates the address of the NFS server.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BackupStrategyRequest

Parameter

+

Mandatory

+

Type

+

Description

+

policy_id

+

No

+

String

+

Definition

+

Policy ID.

+

Range

+

N/A

+

policy_name

+

No

+

String

+

Definition

+

Policy name. This parameter is mandatory when you add a backup policy. The policy name must be unique, consist of 4 to 92 characters, and start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).

+

Range

+

N/A

+

backup_strategy

+

No

+

String

+

Definition

+

Execution policy. This parameter is mandatory when you add a backup policy. The value must comply with the cron expression format.

+

Range

+

N/A

+

backup_type

+

No

+

String

+

Definition

+

Backup type.

+

Range

+

full: full backup

+

increment: incremental backup

+

backup_level

+

No

+

String

+

Definition

+

Backup level.

+

Range

+

cluster

+
+
+
+

Response Parameters

Status code: 200

+

Request succeeded.

+

None

+
+

Example Requests

Add a cluster-level full snapshot policy named test (A snapshot is created at 03:00 every Monday to Sunday).

+
PUT https://{Endpoint} /v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/snapshot-policies
+
+

Example Responses

Status code: 200

+

Request succeeded.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/CreateWorkloadPlan.html b/docs/dws/api-ref/CreateWorkloadPlan.html new file mode 100644 index 000000000..3978680d1 --- /dev/null +++ b/docs/dws/api-ref/CreateWorkloadPlan.html @@ -0,0 +1,204 @@ + + +

Creating a Resource Management Plan

+

Function

This API is used to create a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

plan_name

+

Yes

+

String

+

Definition

+

Plan name

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

Create the resource management plan test2.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans
+
+{
+  "plan_name" : "planA",
+  "logical_cluster_name" : "v3_logical"
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteAlarmSub.html b/docs/dws/api-ref/DeleteAlarmSub.html new file mode 100644 index 000000000..94978512c --- /dev/null +++ b/docs/dws/api-ref/DeleteAlarmSub.html @@ -0,0 +1,252 @@ + + +

Deleting an Alarm Subscription

+

Function

This API is used to delete an alarm subscription.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/alarm-subs/{alarm_sub_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

alarm_sub_id

+

Yes

+

String

+

Definition

+

Alarm subscription ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Alarm subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscribed alarm name.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

N/A

+

alarm_level

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the alarm belongs.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Message topic address.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message topic type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs/273ce506-dad8-411c-92f9-be5004739b40
+
+

Example Responses

Status code: 200

+

Alarm subscription deleted.

+
{
+  "id" : "273ce506-dad8-411c-92f9-be5004739b40",
+  "name" : "zrf-test-13",
+  "enable" : 1,
+  "language" : "zh-cn",
+  "alarm_level" : "urgent,important,minor",
+  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+  "name_space" : "dws",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm subscription deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteCluster.html b/docs/dws/api-ref/DeleteCluster.html new file mode 100644 index 000000000..623c9dae4 --- /dev/null +++ b/docs/dws/api-ref/DeleteCluster.html @@ -0,0 +1,154 @@ + + +

Deleting a Cluster

+

Function

This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot for a cluster before deleting it.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1.0/{project_id}/clusters/{cluster_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

keep_last_manual_snapshot

+

Yes

+

Integer

+

Definition

+

Number of snapshots to be retained in a cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 202

+

The cluster is deleted successfully.

+

None

+
+

Example Requests

Delete a cluster.

+
DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
+
+{
+  "keep_last_manual_snapshot" : 0
+}
+
+

Example Responses

Status code: 202

+

The cluster is deleted successfully.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

The cluster is deleted successfully.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteClusterDns.html b/docs/dws/api-ref/DeleteClusterDns.html new file mode 100644 index 000000000..dce9327c4 --- /dev/null +++ b/docs/dws/api-ref/DeleteClusterDns.html @@ -0,0 +1,148 @@ + + +

Deleting a Cluster Domain Name

+

Function

This API is used to delete the domain name of a specified cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1.0/{project_id}/clusters/{cluster_id}/dns

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Definition

+

Domain name type. Currently, only public network domain names can be deleted.

+

Constraints

+

N/A

+

Range

+

public

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

The cluster domain name is deleted successfully.

+

None

+
+

Example Requests

DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/dns?type=public
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The cluster domain name is deleted successfully.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteClusterNodes.html b/docs/dws/api-ref/DeleteClusterNodes.html new file mode 100644 index 000000000..df753b84d --- /dev/null +++ b/docs/dws/api-ref/DeleteClusterNodes.html @@ -0,0 +1,205 @@ + + +

Deleting Idle Nodes

+

Function

This API is used to delete idle nodes.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/nodes/delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

node_list

+

Yes

+

Array of strings

+

Definition

+

List of idle node IDs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

operate_type

+

Yes

+

String

+

Definition

+

Operation type. Generally, the value is delete.

+

Constraints

+

N/A

+

Range

+

clear: clearing idle nodes that failed to be created

+

delete: deleting idle nodes

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Delete idle nodes.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/nodes/delete
+
+{
+  "node_list" : [ "16413746-258e-4a3c-bea9-8496fdbefde3" ],
+  "operate_type" : "delete"
+}
+
+

Example Responses

Status code: 202

+

Request for deleting cluster nodes submitted.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

Request for deleting cluster nodes submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/DeleteDwsCluster.html b/docs/dws/api-ref/DeleteDwsCluster.html new file mode 100644 index 000000000..28d97bc95 --- /dev/null +++ b/docs/dws/api-ref/DeleteDwsCluster.html @@ -0,0 +1,166 @@ + + +

Deleting a Cluster (V2)

+

Function

This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot for a cluster before deleting it.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

keep_last_manual_backup

+

No

+

String

+

Definition

+

Number of snapshots to be retained in a cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

release_eip_type

+

No

+

String

+

Definition

+

Whether the EIP is released. The default value is NO_RELEASE, indicating that the bound EIP is not released.

+

Constraints

+

N/A

+

Range

+

NO_RELEASE: The bound EIP is not released.

+

RELEASE_BINDING: The bound EIP is released.

+

Default Value

+

NO_RELEASE

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 202

+

Cluster deleted.

+

None

+
+

Example Requests

Delete a cluster.

+
DELETE https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

Cluster deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteEventSub.html b/docs/dws/api-ref/DeleteEventSub.html new file mode 100644 index 000000000..d3c17ab82 --- /dev/null +++ b/docs/dws/api-ref/DeleteEventSub.html @@ -0,0 +1,296 @@ + + +

Deleting a Subscribed Event

+

Function

This API is used to delete a subscribed event.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/event-subs/{event_sub_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

event_sub_id

+

Yes

+

String

+

Definition

+

Event subscription ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscription name.

+

Range

+

N/A

+

source_type

+

String

+

Definition

+

Event source type.

+

Range

+

N/A

+

source_id

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

category

+

String

+

Definition

+

Event category.

+

Range

+

N/A

+

severity

+

String

+

Definition

+

Event severity.

+

Range

+

N/A

+

tag

+

String

+

Definition

+

Event tag.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

1: enabled; 0: disabled.

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Address for the message notification topic.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message notification topic.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message notification type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs/41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b
+
+

Example Responses

Status code: 200

+

Event subscription deleted.

+
{
+  "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b",
+  "name" : "zrf-test-66",
+  "category" : "",
+  "severity" : "normal,warning",
+  "tag" : "",
+  "enable" : 1,
+  "language" : "zh-cn",
+  "source_type" : "",
+  "source_id" : "",
+  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+  "name_space" : "DWS",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Event subscription deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Event Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteLogicalCluster.html b/docs/dws/api-ref/DeleteLogicalCluster.html new file mode 100644 index 000000000..f5fb0eb07 --- /dev/null +++ b/docs/dws/api-ref/DeleteLogicalCluster.html @@ -0,0 +1,167 @@ + + +

Deleting a Logical Cluster

+

Function

This API is used to delete a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

logical_cluster_id

+

Yes

+

String

+

Definition

+

ID of the logical cluster to be deleted.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Delete a logical cluster.

+
DELETE https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/0b494d0d-8431-4c4f-8a06-2cc42d0d0c7d
+
+

Example Responses

Status code: 200

+

Request for deleting a logical cluster submitted.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for deleting a logical cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteQueueUserList.html b/docs/dws/api-ref/DeleteQueueUserList.html new file mode 100644 index 000000000..a96b49cff --- /dev/null +++ b/docs/dws/api-ref/DeleteQueueUserList.html @@ -0,0 +1,244 @@ + + +

Deleting a User Bound to a Resource Pool

+

Function

This API is used to delete a user bound to a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users/batch-delete

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

user_list

+

Yes

+

Array of user_list objects

+

Definition

+

List of resource pool users.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 3 user_list

Parameter

+

Mandatory

+

Type

+

Description

+

user_name

+

No

+

String

+

Username

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/resource1/users/batch-delete
+
+{
+  "queue_name" : "test11",
+  "user_list" : [ {
+    "user_name" : "user_batch"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

User bound to the resource pool deleted.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

User bound to the resource pool deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteSnapshot.html b/docs/dws/api-ref/DeleteSnapshot.html new file mode 100644 index 000000000..905c9037d --- /dev/null +++ b/docs/dws/api-ref/DeleteSnapshot.html @@ -0,0 +1,118 @@ + + +

Deleting a Snapshot

+

Function

This API is used to delete a manual snapshot.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1.0/{project_id}/snapshots/{snapshot_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 202

+

The snapshot is deleted.

+

None

+
+

Example Requests

DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

The snapshot is deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteSnapshotPolicy.html b/docs/dws/api-ref/DeleteSnapshotPolicy.html new file mode 100644 index 000000000..79c4d89e1 --- /dev/null +++ b/docs/dws/api-ref/DeleteSnapshotPolicy.html @@ -0,0 +1,134 @@ + + +

Deleting a Snapshot Policy

+

Function

This API is used to delete a snapshot policy.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1.0/{project_id}/clusters/{cluster_id}/snapshot-policies/{id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

id

+

Yes

+

String

+

Definition

+

Snapshot policy ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

The snapshot policy is deleted.

+

None

+
+

Example Requests

DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/snapshot-policies/4db196c8-32fc-4bf1-bf57-05980bbda9a4
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The snapshot policy is deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteWorkloadPlan.html b/docs/dws/api-ref/DeleteWorkloadPlan.html new file mode 100644 index 000000000..89af6d1a0 --- /dev/null +++ b/docs/dws/api-ref/DeleteWorkloadPlan.html @@ -0,0 +1,170 @@ + + +

Deleting a Resource Management Plan

+

Function

This API is used to delete a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

Delete a resource management plan.

+
DELETE https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a
+
+

Example Responses

Status code: 200

+

Resource management plan deleted.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : "success deleted workload plan"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource management plan deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteWorkloadPlanStage.html b/docs/dws/api-ref/DeleteWorkloadPlanStage.html new file mode 100644 index 000000000..f1484a782 --- /dev/null +++ b/docs/dws/api-ref/DeleteWorkloadPlanStage.html @@ -0,0 +1,185 @@ + + +

Deleting a Stage of Resource Management Plan

+

Function

This API is used to delete a stage of a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/{stage_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

stage_id

+

Yes

+

String

+

Definition

+

Plan stage ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

DELETE https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/stages/00bc8bc5-c885-42e5-b205-80547d3f94c4
+
+

Example Responses

Status code: 200

+

Stage deleted.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : "success deleted workload plan stage"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Stage deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteWorkloadQueue.html b/docs/dws/api-ref/DeleteWorkloadQueue.html new file mode 100644 index 000000000..f35d2f27f --- /dev/null +++ b/docs/dws/api-ref/DeleteWorkloadQueue.html @@ -0,0 +1,199 @@ + + +

Deleting a Resource Pool

+

Function

This API is used to delete a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/workload/queues

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name. This field is mandatory in logical cluster mode.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

workload_queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

DELETE https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload/queues
+
+

Example Responses

Status code: 200

+

Resource pool deleted.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource pool deleted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/DeleteWorkloadRule.html b/docs/dws/api-ref/DeleteWorkloadRule.html new file mode 100644 index 000000000..11fc59127 --- /dev/null +++ b/docs/dws/api-ref/DeleteWorkloadRule.html @@ -0,0 +1,242 @@ + + +

Deleting an Exception Rule

+

Function

This API is used to delete an exception rule.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

rule_name

+

Yes

+

String

+

Definition

+

Exception rule name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Error code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Error details.

+

Range

+

N/A

+

items

+

Array of ExceptRuleBo objects

+

Definition

+

Exception rule list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of exception rules.

+

Range

+

Greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 ExceptRuleBo

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Rule name.

+

Range

+

N/A

+

action

+

String

+

Definition

+

Action that triggers an exception rule.

+

Range

+

N/A

+

queues

+

Array of strings

+

Definition

+

Names of resource pools bound to an exception rule.

+

Range

+

N/A

+

except_rules

+

Map<String,String>

+

Definition

+

Exception rule configuration items.

+

Range

+

N/A

+
+
+
+

Example Requests

Delete an exception rule.

+
DELETE https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload/rules/rule
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/DisableLtsLogs.html b/docs/dws/api-ref/DisableLtsLogs.html new file mode 100644 index 000000000..04122e61f --- /dev/null +++ b/docs/dws/api-ref/DisableLtsLogs.html @@ -0,0 +1,118 @@ + + +

Disabling LTS

+

Function

This API is used to disable LTS for a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/disable

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

LTS disabled.

+

None

+
+

Example Requests

https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/clusters/a862e17c-2981-4150-9018-f9a40511999c/lts-logs/disable
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

LTS disabled.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

No operation permissions.

+

404

+

No resources found.

+

500

+

Internal service error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dws/api-ref/DisassociateEip.html b/docs/dws/api-ref/DisassociateEip.html new file mode 100644 index 000000000..4076b81b7 --- /dev/null +++ b/docs/dws/api-ref/DisassociateEip.html @@ -0,0 +1,134 @@ + + +

Unbinding an EIP from a Cluster

+

Function

This API is used to unbind an EIP from a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/eips/{eip_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

eip_id

+

Yes

+

String

+

Definition

+

EIP bound to the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

The EIP is unbound from the cluster.

+

None

+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/clusters/194408fa-9d41-435c-a140-91edcf5fe519/eips/ab60b4ac-10e3-4d83-bccd-9a6a1b0ba983
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The EIP is unbound from the cluster.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/DisassociateElb.html b/docs/dws/api-ref/DisassociateElb.html new file mode 100644 index 000000000..fb012d019 --- /dev/null +++ b/docs/dws/api-ref/DisassociateElb.html @@ -0,0 +1,156 @@ + + +

Unbinding an ELB from a Cluster

+

Function

This API is used to unbind an ELB from a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v2/{project_id}/clusters/{cluster_id}/elbs/{elb_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

elb_id

+

Yes

+

String

+

Definition

+

ID of the ELB bound to the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

Task ID.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/clusters/194408fa-9d41-435c-a140-91edcf5fe519/elbs/1e6e0b66-6223-4523-bfd9-033c88b4ce9f
+
+

Example Responses

Status code: 200

+

Request for unbinding an ELB from a cluster submitted.

+
{job_id:"2c9081838417d8850184196d8282002b"}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for unbinding an ELB from a cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/EnableLogicalCluster.html b/docs/dws/api-ref/EnableLogicalCluster.html new file mode 100644 index 000000000..0b797ed94 --- /dev/null +++ b/docs/dws/api-ref/EnableLogicalCluster.html @@ -0,0 +1,189 @@ + + +

Switching to a Logical Cluster

+

Function

This API is used to control whether the function modules related to a logical cluster are displayed on the page.

+

If the cluster is already a logical cluster, this API has no function or impact.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/logical-clusters/enable

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

enable

+

Yes

+

Boolean

+

Definition

+

Request for converting to a logic cluster.

+

Constraints

+

N/A

+

Range

+

true: The Logical Cluster switch is enabled.

+

false: The Logical Cluster switch is disabled.

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Switch to a logical cluster.

+
PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/enable
+
+{
+  "enable" : true
+}
+
+

Example Responses

Status code: 200

+

Cluster switch changed.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster switch changed.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/EnableLtsLogs.html b/docs/dws/api-ref/EnableLtsLogs.html new file mode 100644 index 000000000..1e1982f10 --- /dev/null +++ b/docs/dws/api-ref/EnableLtsLogs.html @@ -0,0 +1,118 @@ + + +

Enabling LTS

+

Function

This API is used to enable LTS for a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/lts-logs/enable

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

LTS enabled.

+

None

+
+

Example Requests

https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/clusters/a862e17c-2981-4150-9018-f9a40511999c/lts-logs/enable
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

LTS enabled.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

No operation permissions.

+

404

+

No resources found.

+

500

+

Internal service error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dws/api-ref/ExecuteRedistributionCluster.html b/docs/dws/api-ref/ExecuteRedistributionCluster.html new file mode 100644 index 000000000..1f01fe02a --- /dev/null +++ b/docs/dws/api-ref/ExecuteRedistributionCluster.html @@ -0,0 +1,177 @@ + + +

Performing a Redistribution Task

+

Function

This API is used to evenly distribute data from old nodes to new nodes after cluster scale-out. After data redistribution, the service response speed is greatly improved.

+

The redistribution function is supported by DWS clusters of version 2.0 8.1.1.200 or later.

+

Offline scheduling is not supported in 8.2.0 or later.

+

This function can be manually enabled only when the cluster task information displays To be redistributed after scale-out.

+

You can also select the redistribution mode when you configure cluster scale-out (see Configure advanced parameters).

+

Redistribution queues are sorted based on the relpage size of tables. To ensure that the relpage size is correct, you are advised to perform the ANALYZE operation on the tables to be redistributed.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/redistribution

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

redis_mode

+

Yes

+

String

+

Definition

+

Redistribution mode.

+

Constraints

+

N/A

+

Range

+

online

+

offline

+

Default Value

+

offline

+

parallel_jobs

+

Yes

+

Integer

+

Definition

+

Redistribution concurrency.

+

Constraints

+

N/A

+

Range

+

4 to 200

+

Default Value

+

4

+
+
+
+

Response Parameters

Status code: 200

+

Redistribution task submitted.

+

None

+
+

Example Requests

Perform offline cluster redistribution task and set the number of concurrent tasks to 100.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/redistribution
+
+{
+  "redis_mode" : "offline",
+  "parallel_jobs" : 100
+}
+
+

Example Responses

Status code: 200

+

Redistribution task submitted.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Redistribution task submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ExpandInstanceStorage.html b/docs/dws/api-ref/ExpandInstanceStorage.html new file mode 100644 index 000000000..e741e87d1 --- /dev/null +++ b/docs/dws/api-ref/ExpandInstanceStorage.html @@ -0,0 +1,149 @@ + + +

Expanding Disk Capacity

+

Function

Disk capacity is more likely to become the bottleneck of storage as workloads develop. When other resources are sufficient, disk capacity expansion can help you quickly break through the bottleneck without interrupting services or wasting CPU and memory resources.

+

Constraints

+

Disk capacity expansion can be performed only for cloud data warehouses using SSD or hybrid data warehouses. Only version 8.1.1.203 and later are supported.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/expand-instance-storage

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

new_size

+

Yes

+

Integer

+

DefinitionAvailable capacity of a single node after disk expansion, in GB. The value must be greater than the existing capacity of a single node and up to the maximum capacity of a single node supported by the cluster specifications. The value must be a multiple of the step supported by the cluster specifications. To query cluster flavors, see Querying Cluster Flavors.ConstraintsN/ARangeN/ADefault ValueN/A

+
+
+
+

Response Parameters

Status code: 200

+

Request for expanding the disk capacity submitted.

+

None

+
+

Example Requests

Expand the cluster disk capacity to 200 GB on a single node.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/expand-instance-storage
+
+{
+  "new_size" : 200
+}
+
+

Example Responses

Status code: 200

+

Request for expanding the disk capacity submitted.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for expanding the disk capacity submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ListAlarmConfigs.html b/docs/dws/api-ref/ListAlarmConfigs.html new file mode 100644 index 000000000..0a1beae8b --- /dev/null +++ b/docs/dws/api-ref/ListAlarmConfigs.html @@ -0,0 +1,295 @@ + + +

Querying Alarm Configurations

+

Function

This API is used to query alarm configurations.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/alarm-configs

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

No limit.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Definition

+

Total number of alarm configurations.

+

Range

+

N/A

+

alarm_configs

+

Array of AlarmConfigResponse objects

+

Definition

+

Alarm configuration list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 AlarmConfigResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Alarm configuration ID.

+

Range

+

N/A

+

alarm_id

+

String

+

Definition

+

Alarm ID.

+

Range

+

N/A

+

alarm_name

+

String

+

Definition

+

Alarm name.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the alarm belongs.

+

Range

+

N/A

+

alarm_level

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

is_user_visible

+

String

+

Definition

+

Whether the alarm is visible to users.

+

Range

+

N/A

+

is_converge

+

String

+

Definition

+

Whether to cover the prior alarm

+

Range

+

N/A

+

converge_time

+

Integer

+

Definition

+

Coverage time.

+

Range

+

N/A

+

is_maintain_visible

+

String

+

Definition

+

Whether the alarm is visible to O&M personnel.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/{project_id}/alarm-configs
+
+

Example Responses

Status code: 200

+

Alarm configurations queried.

+
{
+  "alarm_configs" : [ {
+    "id" : "fd02e440-b4e2-4d2c-8d98-4d80224cf848",
+    "alarm_id" : "DWS_2000000021_1",
+    "alarm_name" : "File Handle Usage Exceeds Threshold",
+    "name_space" : "dws",
+    "alarm_level" : "urgent",
+    "is_user_visible" : "1",
+    "is_converge" : "0",
+    "converge_time" : 0,
+    "is_maintain_visible" : "0"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm configurations queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/ListAlarmDetail.html b/docs/dws/api-ref/ListAlarmDetail.html new file mode 100644 index 000000000..e462bc7f2 --- /dev/null +++ b/docs/dws/api-ref/ListAlarmDetail.html @@ -0,0 +1,322 @@ + + +

Querying Alarm Details List

+

Function

This API is used to query the alarm details list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/alarms

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

time_zone

+

No

+

String

+

Definition

+

Time zone.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

GMT+08:00

+

offset

+

No

+

String

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Definition

+

Total number of alarm details.

+

Range

+

N/A

+

alarm_details

+

Array of AlarmDetailResponse objects

+

Definition

+

Alarm list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 AlarmDetailResponse

Parameter

+

Type

+

Description

+

alarm_id

+

String

+

Definition

+

Alarm definition ID.

+

Range

+

N/A

+

alarm_name

+

String

+

Definition

+

Alarm name.

+

Range

+

N/A

+

alarm_level

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

alarm_source

+

String

+

Definition

+

Alarm source.

+

Range

+

N/A

+

alarm_message

+

String

+

Definition

+

Alarm message.

+

Range

+

N/A

+

alarm_location

+

String

+

Definition

+

Alarm location.

+

Range

+

N/A

+

resource_id

+

String

+

Definition

+

Alarm source ID.

+

Range

+

N/A

+

resource_id_name

+

String

+

Definition

+

Alarm source name.

+

Range

+

N/A

+

alarm_generate_date

+

String

+

Definition

+

Alarm date.

+

Range

+

N/A

+

alarm_status

+

String

+

Definition

+

Alarm status.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarms?time_zone=GMT
+
+

Example Responses

Status code: 200

+

Alarm details list queried.

+
{
+  "alarm_details" : [ {
+    "alarm_id" : "DWS_01010",
+    "alarm_name" : "Cluster Status Fault",
+    "alarm_level" : "1",
+    "alarm_source" : "DWS",
+    "alarm_message" : "CloudService=DWS, resourceId: 5e76e8e2-d0cf-4b64-9d9a-aadbb04b54f7, resourceIdName: evs-09, domain_name=, domain_id=0676610f3a0a4c2c80c50bea7ddf18c1, res_domain_name=op_svc_dws_0676610f3a0a4c2c80c50bea7ddf18c1",
+    "alarm_location" : "cluster_id: 5e76e8e2-d0cf-4b64-9d9a-aadbb04b54f7,cluster_name: evs-09,cluster type: dws,domain_name: ,domain_id: 0676610f3a0a4c2c80c50bea7ddf18c1",
+    "resource_id" : "5e76e8e2-d0cf-4b64-9d9a-aadbb04b54f7",
+    "resource_id_name" : "evs-09",
+    "alarm_generate_date" : "2022-10-27 08:11:29",
+    "alarm_status" : "0"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm details list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/ListAlarmStatistic.html b/docs/dws/api-ref/ListAlarmStatistic.html new file mode 100644 index 000000000..ea4756c4e --- /dev/null +++ b/docs/dws/api-ref/ListAlarmStatistic.html @@ -0,0 +1,260 @@ + + +

Querying the Alarm Statistics List

+

Function

This API is used to query alarm statistics.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/alarm-statistic

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

time_zone

+

No

+

String

+

Definition

+

Time zone.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

GMT+08:00

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

alarm_statistics

+

Array of AlarmStatisticResponse objects

+

Definition

+

Alarm statistics list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 AlarmStatisticResponse

Parameter

+

Type

+

Description

+

date

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

urgent

+

String

+

Definition

+

Urgent.

+

Range

+

N/A

+

important

+

String

+

Definition

+

Important.

+

Range

+

N/A

+

minor

+

String

+

Definition

+

Minor.

+

Range

+

N/A

+

prompt

+

String

+

Definition

+

Prompt.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-statistic?time_zone=GMT
+
+

Example Responses

Status code: 200

+

Alarm statistics list queried.

+
{
+  "alarm_statistics" : [ {
+    "date" : "2022-10-21",
+    "urgent" : 0,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  }, {
+    "date" : "2022-10-22",
+    "urgent" : 0,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  }, {
+    "date" : "2022-10-23",
+    "urgent" : 0,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  }, {
+    "date" : "2022-10-24",
+    "urgent" : 0,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  }, {
+    "date" : "2022-10-25",
+    "urgent" : 0,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  }, {
+    "date" : "2022-10-26",
+    "urgent" : 0,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  }, {
+    "date" : "2022-10-27",
+    "urgent" : 17,
+    "important" : 0,
+    "minor" : 0,
+    "prompt" : 0
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm statistics list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/ListAlarmSubs.html b/docs/dws/api-ref/ListAlarmSubs.html new file mode 100644 index 000000000..e34285ab4 --- /dev/null +++ b/docs/dws/api-ref/ListAlarmSubs.html @@ -0,0 +1,317 @@ + + +

Querying the Alarm Subscription List

+

Function

This API is used to query subscribed alarms.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/alarm-subs

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

1000

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Definition

+

Total number of alarm subscriptions.

+

Range

+

N/A

+

alarm_subscriptions

+

Array of AlarmSubscriptionResponse objects

+

Definition

+

Alarm subscription list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 AlarmSubscriptionResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Alarm subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscribed alarm name.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

N/A

+

alarm_level

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the alarm belongs.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Message topic address.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message topic type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs
+
+

Example Responses

Status code: 200

+

Alarm subscription list queried.

+
{
+  "count" : 1,
+  "alarm_subscriptions" : [ {
+    "id" : "e8d8359f-b8bd-4b80-bc4d-32c86c7c725e",
+    "name" : "00",
+    "enable" : 1,
+    "language" : "zh-cn",
+    "alarm_level" : "urgent,important,minor,prompt",
+    "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+    "name_space" : "DWS",
+    "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:CGS",
+    "notification_target_name" : "CGS",
+    "notification_target_type" : "SMN",
+    "time_zone" : "GMT+08:00"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm subscription list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/ListAuditLog.html b/docs/dws/api-ref/ListAuditLog.html new file mode 100644 index 000000000..82fb0a312 --- /dev/null +++ b/docs/dws/api-ref/ListAuditLog.html @@ -0,0 +1,264 @@ + + +

Querying Log Records

+

Function

This API is used to query audit logs.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/audit-log-records

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

records

+

Array of AuditDumpRecord objects

+

Definition

+

Audit log list.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

It is a 36-digit UUID.

+

count

+

Integer

+

Definition

+

Total number.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 AuditDumpRecord

Parameter

+

Type

+

Description

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

It is a 36-digit UUID.

+

executor_time

+

String

+

Definition

+

Execution time.

+

Range

+

N/A

+

begin_time

+

String

+

Definition

+

Start time.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

bucket_name

+

String

+

Definition

+

Bucket name.

+

Range

+

N/A

+

location_prefix

+

String

+

Definition

+

Prefix.

+

Range

+

N/A

+

result

+

String

+

Definition

+

Results.

+

Range

+

N/A

+

failed_reason

+

String

+

Definition

+

Failure cause.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/audit-log-records
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "records" : [ {
+    "result" : "RUNNING",
+    "cluster_id" : "a07cb2f7-b17e-4d95-923b-a33d0c884d37",
+    "executor_time" : "2022-10-31T09:11:31",
+    "begin_time" : "2022-10-31T09:09:55",
+    "end_time" : "2022-10-31T09:19:55",
+    "bucket_name" : "testbucket",
+    "location_prefix" : "test"
+  } ],
+  "count" : 1,
+  "cluster_id" : "a07cb2f7-b17e-4d95-923b-a33d0c884d37"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Audit Logs
+
+
+ diff --git a/docs/dws/api-ref/ListAvailabilityZones.html b/docs/dws/api-ref/ListAvailabilityZones.html new file mode 100644 index 000000000..b3f502dee --- /dev/null +++ b/docs/dws/api-ref/ListAvailabilityZones.html @@ -0,0 +1,196 @@ + + +

Querying the AZ List

+

Function

This API is used to query the ID of the AZ, which you will need to create an instance.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/availability-zones

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

availability_zones

+

Array of AvailabilityZone objects

+

Definition

+

AZ list.

+

Range

+

Non-empty object list.

+

count

+

Integer

+

Definition

+

Number of AZs.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 AvailabilityZone

Parameter

+

Type

+

Description

+

code

+

String

+

Definition

+

AZ unique code.

+

Range

+

N/A

+

name

+

String

+

Definition

+

AZ name.

+

Range

+

N/A

+

status

+

String

+

Definition

+

AZ status.

+

Range

+

available

+

unavailable

+

public_border_group

+

String

+

Definition

+

AZ group, for example, center.

+

Range

+

N/A

+
+
+
+

Example Requests

Query AZs.

+
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/availability-zones
+
+

Example Responses

Status code: 200

+

AZ list queried.

+
{
+  "availability_zones" : [ {
+    "code" : "az1",
+    "name" : "AZ1",
+    "status" : "available",
+    "public_border_group" : "center"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

AZ list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: AZ Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusterActions.html b/docs/dws/api-ref/ListClusterActions.html new file mode 100644 index 000000000..9e3d1150d --- /dev/null +++ b/docs/dws/api-ref/ListClusterActions.html @@ -0,0 +1,323 @@ + + +

Querying Cluster Task Details

+

Function

This API is used to query cluster task details.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/actions/{action_name}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

action_name

+

Yes

+

String

+

Definition

+

Task name. Only some ongoing tasks can be viewed.

+

Constraints

+

N/A

+

Range

+

GROWING, RESIZE_FAILURE, RESTORING, RESTORING_FAILED, SNAPSHOTTING, SNAPSHOTTING_FAILED, FINE_GRAINED_RESTORING, or FINE_GRAINED_RESTORING_FAILED

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Response body for querying task details.

+

Range

+

Randomly generated UUID.

+

action_name

+

String

+

Definition

+

Task name, which is the same as the input parameter.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Task status.

+

Range

+

N/A

+

cluster_name

+

String

+

Definition

+

Cluster name.

+

Range

+

N/A

+

submit_time

+

String

+

Definition

+

Time when the task is submitted.

+

Range

+

N/A

+

items

+

Array of ActionItemVo objects

+

Definition

+

Task subitems.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 ActionItemVo

Parameter

+

Type

+

Description

+

item_name

+

String

+

Definition

+

First-level menu, which is a task subitem.

+

Range

+

N/A

+

sub_items

+

Array of ActionSubItemVo objects

+

Definition

+

Details of the first-level menu (a task subitem).

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ActionSubItemVo

Parameter

+

Type

+

Description

+

status

+

String

+

Definition

+

Status.

+

Range

+

N/A

+

detail

+

String

+

Definition

+

Extended information.

+

Range

+

N/A

+

sub_item_name

+

String

+

Definition

+

Subitem name, which is returned in Chinese or English based on the x-language field in the request header.

+

Range

+

N/A

+

begin_time

+

String

+

Definition

+

Start time.

+

Range

+

A specific time format or null.

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

A specific time format or null.

+

estimated_time

+

Integer

+

Definition

+

Estimated time.

+

Range

+

An integer.

+
+
+
+

Example Requests

Query details about the failed snapshot task.

+
get https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/9f76c502-fc9c-4a52-8656-65d0da6e3d57/actions/SNAPSHOTTING_FAILED
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "id" : "abb30649-4ab5-448f-a199-f764d2a4271d",
+  "status" : "FAILED",
+  "items" : [ {
+    "item_name" : "Create a snapshot",
+    "sub_items" : [ {
+      "status" : "FAILED",
+      "detail" : "{\"progressInfo\":\"{\\\"actionEndTime\\\":\\\"2025-05-19 09:07:42\\\",\\\"failedStep\\\":\\\"INIT\\\",\\\"partialPassKeys\\\":\\\"N/A\\\",\\\"errorCode\\\":\\\"\\\",\\\"updateTime\\\":\\\"2025-05-19 09:07:43\\\",\\\"errorMsg\\\":\\\"host-172-16-13-211    SUCCESS          host-172-16-47-24     SUCCESS          host-172-16-19-132    SUCCESS          \\\",\\\"backupSize\\\":157661926,\\\"backupRate\\\":{\\\"compressRate\\\":\\\"0MB/s\\\",\\\"consumerRate\\\":\\\"0MB/s\\\",\\\"producerRate\\\":\\\"0MB/s\\\"},\\\"currentStep\\\":\\\"FINISH\\\",\\\"actionType\\\":\\\"Backup\\\",\\\"unrestoreKeys\\\":\\\"N/A\\\",\\\"progress\\\":\\\"100.00%\\\",\\\"actionStartTime\\\":\\\"2025-05-19 09:07:28\\\",\\\"priorKey\\\":\\\"N/A\\\",\\\"key\\\":\\\"20250519_090729\\\"}\"}",
+      "sub_item_name" : "Perform a backup",
+      "begin_time" : "2025-05-19 09:06:18.0",
+      "end_time" : null,
+      "estimated_time" : -1
+    } ]
+  } ],
+  "action_name" : "SNAPSHOTTING_FAILED",
+  "cluster_name" : "cluster_779",
+  "submit_time" : "2025-05-19 09:05:10.0"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Task Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusterCn.html b/docs/dws/api-ref/ListClusterCn.html new file mode 100644 index 000000000..1d650d6d5 --- /dev/null +++ b/docs/dws/api-ref/ListClusterCn.html @@ -0,0 +1,211 @@ + + +

Querying CN Nodes of a Cluster

+

Function

This API is used to query the CN node list of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/cns

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

min_num

+

Integer

+

Definition

+

Minimum number of CN nodes supported by the cluster.

+

Range

+

N/A

+

max_num

+

Integer

+

Definition

+

Maximum number of CN nodes supported by the cluster.

+

Range

+

N/A

+

instances

+

Array of CoordinatorNode objects

+

Definition

+

List of CN details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 3 CoordinatorNode

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Node ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Node name.

+

Range

+

N/A

+

private_ip

+

String

+

Definition

+

Private IP address.

+

Range

+

N/A

+
+
+
+

Example Requests

Query CN node list of a cluster.

+
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/cns
+
+

Example Responses

Status code: 200

+

CN nodes of the cluster queried.

+
{
+  "min_num" : 2,
+  "max_num" : 3,
+  "instances" : [ {
+    "id" : "e07d1bfb-6eac-4827-96e0-d10b8ca29c41",
+    "name" : "demo-dws-cn-cn-1-1",
+    "private_ip" : "172.16.69.106"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

CN nodes of the cluster queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ListClusterDetails.html b/docs/dws/api-ref/ListClusterDetails.html new file mode 100644 index 000000000..066405c58 --- /dev/null +++ b/docs/dws/api-ref/ListClusterDetails.html @@ -0,0 +1,1094 @@ + + +

Querying Cluster Details

+

Function

This API is used to query cluster details.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

ClusterDetail object

+

Definition

+

Cluster details.

+

Range

+

Non-null

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 ClusterDetail

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Cluster name.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Cluster status.

+

Range

+

  • CREATING: The cluster is being created.

    +

  • ACTIVE: The cluster is available.

    +

  • FAILED: The cluster is unavailable.

    +

  • CREATE_FAILED: The cluster failed to be created.

    +

  • DELETING: The cluster is being deleted.

    +

  • DELETE_FAILED: The cluster failed to be deleted.

    +

  • DELETED: The cluster was deleted.

    +
+

version

+

String

+

Definition

+

Data warehouse version.

+

Range

+

N/A

+

updated

+

String

+

Definition

+

Last modification time of a cluster. The format is ISO8601:YYYY-MM-DDThh:mm:ssZ.

+

Range

+

N/A

+

created

+

String

+

Definition

+

Cluster creation time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

+

Range

+

N/A

+

port

+

Integer

+

Definition

+

Cluster service port.

+

Range

+

8000 to 30000

+

endpoints

+

Array of Endpoints objects

+

Definition

+

Private network connection information about the cluster.

+

Range

+

Non-empty object array.

+

nodes

+

Array of Nodes objects

+

Definition

+

Cluster nodes.

+

Range

+

Non-empty object array.

+

tags

+

Array of Tags objects

+

Definition

+

Cluster tags.

+

Range

+

N/A

+

user_name

+

String

+

Definition

+

Administrator username.

+

Range

+

N/A

+

number_of_node

+

Integer

+

Definition

+

Number of nodes.

+

Range

+

N/A

+

recent_event

+

Integer

+

Definition

+

Number of events.

+

Range

+

N/A

+

availability_zone

+

String

+

Definition

+

AZ.

+

Range

+

N/A

+

enterprise_project_id

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

vpc_id

+

String

+

Definition

+

VPC ID.

+

Range

+

N/A

+

subnet_id

+

String

+

Definition

+

Subnet ID.

+

Range

+

N/A

+

public_ip

+

PublicIp object

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

public_endpoints

+

Array of PublicEndpoints objects

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

action_progress

+

Map<String,String>

+

Definition

+

Task information. It consists of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task.

+

Range

+

The key can contain but is not limited to the following values:

+

  • CREATING: The cluster is being created.

    +

  • RESTORING

    +

  • SNAPSHOTTING

    +

  • GROWING

    +

  • REBOOTING

    +

  • SETTING_CONFIGURATION: Security settings are being configured.

    +

  • CONFIGURING_EXT_DATASOURCE: The MRS connection is being configured.

    +

  • ADD_CN_ING: A CN is being added.

    +

  • DEL_CN_ING: A CN is being deleted.

    +

  • REDISTRIBUTING: Redistribution is in progress.

    +

  • ELB_BINDING: An ELB is being bound.

    +

  • ELB_UNBINDING: An ELB is being unbound.

    +

  • ELB_SWITCHING: An ELB is being switched.

    +

  • NETWORK_CONFIGURING: The network is being configured.

    +

  • DISK_EXPANDING: The disk is being expanded.

    +

  • ACTIVE_STANDY_SWITCHOVER: The primary/standby switchover is being performed.

    +

  • FLAVOR_RESIZING: The flavor is being changed.

    +

  • FINE_GRAINED_RESTORING: The fine-grained restoration is in progress.

    +

  • REPAIRING: The cluster is being repaired.

    +
+

sub_status

+

String

+

Definition

+

Sub-status of the available clusters.

+

Range

+

  • NORMAL

    +

  • READONLY

    +

  • REDISTRIBUTING

    +

  • REDISTRIBUTION-FAILURE

    +

  • UNBALANCED

    +

  • UNBALANCED | READONLY: unbalanced, read-only

    +

  • DEGRADED

    +

  • DEGRADED | READONLY

    +

  • DEGRADED | UNBALANCED

    +

  • UNBALANCED | REDISTRIBUTING

    +

  • UNBALANCED | REDISTRIBUTION-FAILURE

    +

  • READONLY | REDISTRIBUTION-FAILURE

    +

  • UNBALANCED | READONLY | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | READONLY

    +
+

task_status

+

String

+

Definition

+

Task for cluster management.

+

Range

+

The value can contain but is not limited to the following values:

+

  • UNFREEZING

    +

  • FREEZING

    +

  • RESTORING

    +

  • SNAPSHOTTING

    +

  • GROWING

    +

  • REBOOTING

    +

  • SETTING_CONFIGURATION: Security settings are being configured.

    +

  • CONFIGURING_EXT_DATASOURCE: The MRS connection is being configured.

    +

  • DELETING_EXT_DATASOURCE: The MRS connection is being deleted.

    +

  • REBOOT_FAILURE: The reboot failed.

    +

  • RESIZE_FAILURE: The scale-out failed.

    +

  • ADD_CN_ING: A CN is being added.

    +

  • DEL_CN_ING: A CN is being deleted.

    +

  • CREATING_NODE: A node is being added.

    +

  • CREATE_NODE_FAILED: The node failed to be added.

    +

  • DELETING_NODE: The node is being deleted.

    +

  • DELETE_NODE_FAILED: The node failed to be deleted.

    +

  • REDISTRIBUTING: Redistribution is in progress.

    +

  • REDISTRIBUTE_FAILURE: Redistribution failed.

    +

  • WAITING_REDISTRIBUTION: Redistribution is waiting.

    +

  • REDISTRIBUTION_PAUSED: Redistribution is paused.

    +

  • ELB_BINDING: An ELB is being bound.

    +

  • ELB_BIND_FAILED: An ELB failed to be bound.

    +

  • ELB_UNBINDING: An ELB is being unbound.

    +

  • ELB_UNBIND_FAILED: An ELB failed to be unbound.

    +

  • ELB_SWITCHING: An ELB is being switched.

    +

  • ELB_SWITCHING_FAILED: An ELB failed to be switched.

    +

  • NETWORK_CONFIGURING: The network is being configured.

    +

  • NETWORK_CONFIG_FAILED: Network configuration failed.

    +

  • DISK_EXPAND_FAILED: Disk capacity expansion failed.

    +

  • DISK_EXPANDING: The disk is being expanded.

    +

  • ACTIVE_STANDY_SWITCHOVER: The primary/standby switchover is being performed.

    +

  • ACTIVE_STANDY_SWITCHOVER_FAILURE: The primary/standby switchover failed.

    +

  • FLAVOR_RESIZING_FAILED: The flavor change failed.

    +

  • FLAVOR_RESIZING: The flavor is being changed.

    +

  • FINE_GRAINED_RESTORING: The fine-grained restoration is in progress.

    +
+

parameter_group

+

ParameterGroup object

+

Definition

+

Information about the parameter template associated with a cluster.

+

Range

+

N/A

+

node_type

+

String

+

Definition

+

Cluster flavors.

+

Range

+

N/A

+

node_type_id

+

String

+

Definition

+

Cluster flavor ID.

+

Range

+

N/A

+

security_group_id

+

String

+

Definition

+

Security group ID.

+

Range

+

N/A

+

order_id

+

String

+

Definition

+

Order ID.

+

Range

+

N/A

+

private_ip

+

Array of strings

+

Definition

+

Private IP addresses.

+

Range

+

N/A

+

maintain_window

+

MaintainWindow object

+

Definition

+

Cluster maintenance window.

+

Range

+

N/A

+

resize_info

+

ResizeInfo object

+

Definition

+

Cluster scale-out details.

+

Range

+

N/A

+

failed_reasons

+

FailedReason object

+

Definition

+

Failure cause. If the parameter is left blank, the cluster is in the normal state.

+

Range

+

N/A

+

elb

+

ElbResp object

+

Definition

+

ELB bound to the cluster.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Endpoints

Parameter

+

Type

+

Description

+

connect_info

+

String

+

Definition

+

Private network connection information.

+

Range

+

N/A

+

jdbc_url

+

String

+

Definition

+

JDBC URL of the private network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

jdbc:postgresql://<connect_info>/<YOUR_DATABASE_NAME>

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Nodes

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster instance ID.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Cluster instance status.

+

Range

+

100: creating

+

199: idle

+

200: available

+

300: unavailable

+

303: creation failed

+

304: deleting

+

305: deletion failed

+

400: deleted

+

name

+

String

+

Definition

+

Instance name.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Tags

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 PublicIp

Parameter

+

Type

+

Description

+

public_bind_type

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

auto_assign

+

not_use

+

bind_existing

+

Default Value

+

null

+

eip_id

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 PublicEndpoints

Parameter

+

Type

+

Description

+

public_connect_info

+

String

+

Definition

+

Public network connection information.

+

Range

+

N/A

+

jdbc_url

+

String

+

Definition

+

JDBC connection string of the public network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

jdbc:postgresql://<public_connect_info>/<YOUR_DATABASE_name>

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 9 ParameterGroup

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Parameter template ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Parameter template name.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Cluster parameter status.

+

Range

+

  • In-Sync

    +

  • Applying

    +

  • Pending-Reboot

    +

  • Sync-Failure

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 MaintainWindow

Parameter

+

Type

+

Description

+

day

+

String

+

Definition

+

Maintenance time in each week in the unit of day.

+

Range

+

  • Mon

    +

  • Tue

    +

  • Wed

    +

  • Thu

    +

  • Fri

    +

  • Sat

    +

  • Sun

    +
+

start_time

+

String

+

Definition

+

Maintenance start time in HH:mm format. The time zone is GMT+0.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

Maintenance end time in HH:mm format. The time zone is GMT+0.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 11 ResizeInfo

Parameter

+

Type

+

Description

+

target_node_num

+

Integer

+

Definition

+

Number of nodes after the scale-out.

+

Range

+

N/A

+

origin_node_num

+

Integer

+

Definition

+

Number of nodes before the scale-out.

+

Range

+

N/A

+

resize_status

+

String

+

Definition

+

Scale-out status.

+

Range

+

  • GROWING: The cluster is being scaled out.

    +

  • RESIZE_FAILURE: The scale-out failed.

    +
+

start_time

+

String

+

Definition

+

Scale-out start time. Format: ISO8601:YYYY-MM-DDThh:mm:ss.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 FailedReason

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 ElbResp

Parameter

+

Type

+

Description

+

public_ip

+

String

+

Definition

+

Public IP address.

+

Range

+

A valid public IPv4 address.

+

private_ip

+

String

+

Definition

+

Private IP address.

+

Range

+

A valid private IPv4 address.

+

private_endpoint

+

String

+

Definition

+

ELB endpoint address.

+

Range

+

N/A

+

name

+

String

+

Definition

+

ELB name.

+

Range

+

N/A

+

id

+

String

+

Definition

+

ELB ID.

+

Range

+

N/A

+

vpc_id

+

String

+

Definition

+

ID of the VPC that the ELB is associated with.

+

Range

+

N/A

+
+
+
+

Example Requests

Query cluster details.

+
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7
+
+

Example Responses

Status code: 200

+

Cluster details queried.

+
{
+  "cluster" : {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15",
+    "name" : "dws-1",
+    "status" : "AVAILABLE",
+    "version" : "1.2.0",
+    "updated" : "2018-02-10T14:28:14Z",
+    "created" : "2018-02-10T14:28:14Z",
+    "port" : 8000,
+    "endpoints" : [ {
+      "connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "nodes" : [ {
+      "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
+      "name" : "dws-1-dws-cn-cn-1-1",
+      "status" : "200"
+    }, {
+      "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
+      "name" : "dws-1-dws-cn-cn-2-1",
+      "status" : "200"
+    }, {
+      "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
+      "name" : "dws-1-dws-cn-cn-3-1",
+      "status" : "200"
+    } ],
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value2"
+    } ],
+    "user_name" : "dbadmin",
+    "number_of_node" : 3,
+    "recent_event" : 6,
+    "availability_zone" : "eu-de-01",
+    "enterprise_project_id" : "0",
+    "node_type" : "dws.m1.xlarge.ultrahigh",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : "85b20d7e-9etypeb2a-98f3-3c8843ea3574"
+    },
+    "public_endpoints" : [ {
+      "public_connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "action_progress" : {
+      "SNAPSHOTTING" : "20%"
+    },
+    "sub_status" : "READONLY",
+    "task_status" : "SNAPSHOTTING",
+    "parameter_group" : {
+      "id" : "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
+      "name" : "Default-Parameter-Group-dws ",
+      "status" : "In-Sync"
+    },
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
+    "order_id" : "",
+    "private_ip" : [ "192.168.0.12", "192.168.0.66" ],
+    "maintain_window" : {
+      "day" : "Wed",
+      "start_time" : "22:00",
+      "end_time" : "02:00"
+    },
+    "resize_info" : {
+      "target_node_num" : "6",
+      "origin_node_num" : "3",
+      "resize_status" : "GROWING",
+      "start_time" : "2018-02-14T14:28:14Z"
+    }
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster details queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusterEndpoints.html b/docs/dws/api-ref/ListClusterEndpoints.html new file mode 100644 index 000000000..5e9db3270 --- /dev/null +++ b/docs/dws/api-ref/ListClusterEndpoints.html @@ -0,0 +1,504 @@ + + +

Querying Connection Information

+

Function

This API is used to query connection information, including public and private domain names.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/endpoints

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

public_endpoints

+

PublicEndpointResponse object

+

Definition

+

Public network connection information, including the public domain name and public IP address. If multiple nodes are bound to public IP addresses, only one of them is displayed.

+

Range

+

N/A

+

private_endpoints

+

PrivateEndpointResponse object

+

Definition

+

Public network connection information.

+

Range

+

N/A

+

public_ip_infos

+

Array of PublicIpInfoResponse objects

+

Definition

+

Public IP address details, including whether each node is bound to a public IP address and the corresponding status.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 PublicEndpointResponse

Parameter

+

Type

+

Description

+

ip

+

String

+

Definition

+

Public IP address information.

+

Range

+

N/A

+

port

+

Integer

+

Definition

+

Port information. If no port is specified when a cluster is created, 8000 is used by default.

+

Range

+

N/A

+

enabled

+

Boolean

+

Definition

+

Whether the current region supports public domain name.

+

Range

+

N/A

+

ip_id

+

String

+

Definition

+

Public IP address ID.

+

Range

+

N/A

+

ip_bandwidth

+

String

+

Definition

+

Bandwidth information of the public IP address.

+

Range

+

N/A

+

domain_name

+

String

+

Definition

+

Subdomain name of the public domain name.

+

Range

+

N/A

+

domain_name_suffix

+

String

+

Definition

+

Suffix of the public domain name.

+

Range

+

N/A

+

zone_name

+

String

+

Definition

+

Suffix of the public domain name.

+

Range

+

N/A

+

domain_name_ttl

+

Integer

+

Definition

+

TTL of the public domain name.

+

Range

+

N/A

+

domain_name_status

+

String

+

Definition

+

Status of the public domain name.

+

Range

+

N/A

+

ip_status

+

String

+

Definition

+

Public IP address status.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PrivateEndpointResponse

Parameter

+

Type

+

Description

+

ip

+

String

+

Definition

+

Private IP address. Multiple IP addresses are separated by commas (,).

+

Range

+

N/A

+

port

+

Integer

+

Definition

+

Port information.

+

Range

+

8000 to 30000

+

domain_name

+

String

+

Definition

+

Subdomain name prefix.

+

Range

+

N/A

+

domain_name_suffix

+

String

+

Definition

+

Subdomain name suffix.

+

Range

+

N/A

+

zone_name

+

String

+

Definition

+

Subdomain name information.

+

Range

+

N/A

+

domain_name_ttl

+

Integer

+

Definition

+

TTL of the private domain name.

+

Range

+

N/A

+

domain_name_status

+

String

+

Definition

+

Private domain name status.

+

Range

+

N/A

+

elb_ip

+

String

+

Definition

+

Private IP address of the ELB.

+

Range

+

N/A

+

bind_manage_ip_status

+

Integer

+

Definition

+

IP address binding status.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PublicIpInfoResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Public IP address ID.

+

Range

+

N/A

+

address

+

String

+

Definition

+

Public IP address.

+

Range

+

The value must be a valid public IPv4 address.

+

status

+

String

+

Definition

+

Public IP address status.

+

Range

+

N/A

+

instance_id

+

String

+

Definition

+

ID of the DWS cluster node to which the public IP address is bound.

+

Range

+

N/A

+

instance_name

+

String

+

Definition

+

Name of the DWS cluster node to which the public IP address is bound.

+

Range

+

N/A

+

bandwidth_size

+

String

+

Definition

+

Public IP bandwidth information.

+

Range

+

N/A

+
+
+
+

Example Requests

Query connection information such as the public domain name and public IP address.

+
https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/cc6588d6-8301-4c9a-b0c0-186bb824e8c0/endpoints
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "public_endpoints" : {
+    "ip" : "100.10.87.101",
+    "port" : 8000,
+    "enabled" : true,
+    "ip_id" : "76d86659-a1d8-421d-969e-da97af4fde34",
+    "ip_bandwidth" : "1",
+    "domain_name" : "dws_cluster751",
+    "domain_name_suffix" : ".dws5.dwscloud.com",
+    "zone_name" : ".dws5.dwscloud.com",
+    "domain_name_ttl" : 300,
+    "domain_name_status" : "ACTIVE",
+    "ip_status" : "ACTIVE"
+  },
+  "private_endpoints" : {
+    "ip" : "192.168.200.145,192.168.200.32,192.168.200.169",
+    "port" : 8000,
+    "domain_name" : "dws_cluster-75",
+    "domain_name_suffix" : ".dws.dwscloud.com",
+    "zone_name" : ".dws.dwscloud.com",
+    "domain_name_ttl" : 300,
+    "domain_name_status" : "ACTIVE",
+    "elb_ip" : "192.168.200.120",
+    "bind_manage_ip_status" : 1
+  },
+  "public_ip_infos" : [ {
+    "id" : "",
+    "address" : "",
+    "status" : null,
+    "instance_id" : "064edaf0-775b-4337-86c5-900d73d0c969",
+    "instance_name" : "dws_cluster_751-dws-cn-cn-2-1",
+    "bandwidth_size" : null
+  }, {
+    "id" : "",
+    "address" : "",
+    "status" : null,
+    "instance_id" : "1ba6fa55-50aa-4c85-a45d-f914c9eff771",
+    "instance_name" : "dws_cluster_751-dws-cn-cn-3-1",
+    "bandwidth_size" : null
+  }, {
+    "id" : "76d86659-a1d8-421d-969e-da97af4fde34",
+    "address" : "100.10.87.101",
+    "status" : "ACTIVE",
+    "instance_id" : "2fb695c4-4b9f-440a-ae69-33bb26516fba",
+    "instance_name" : "dws_cluster_751-dws-cn-cn-1-1",
+    "bandwidth_size" : "1"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusterNodes.html b/docs/dws/api-ref/ListClusterNodes.html new file mode 100644 index 000000000..14a0a1e41 --- /dev/null +++ b/docs/dws/api-ref/ListClusterNodes.html @@ -0,0 +1,438 @@ + + +

Querying the Node List

+

Function

This API is used to query the node list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/nodes

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

node_ids

+

No

+

Array of strings

+

Definition

+

Node ID list.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Number of items displayed on each page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

100

+

filter_by

+

No

+

String

+

Definition

+

Search criteria.

+

Constraints

+

N/A

+

Range

+

instCreateType: The content is filtered by resource status.

+

status: The content is filtered by node status.

+

Default Value

+

null

+

filter

+

No

+

String

+

Definition

+

Content to be searched.

+

Constraints

+

N/A

+

Range

+

When the resource status is used as the search criteria, the values are as follows:

+

  • ALL

    +

  • INST

    +

  • NODE

    +

  • ALL

    +

  • CREATING

    +

  • FREE

    +

  • ACTIVE

    +

  • FAILED

    +

  • UNKNOWN

    +

  • CREATE_FAILED

    +

  • DELETING

    +

  • DELETE_FAILED

    +
+

When the node status is used as the search criteria, the values are as follows:

+

Default Value

+

null

+

order_by

+

No

+

String

+

Definition

+

Sorting field. By default, the results are not sorted.

+

Constraints

+

N/A

+

Range

+

name: filter by name

+

Default Value

+

null

+

order

+

No

+

String

+

Definition

+

Sorting order (ascending or descending)

+

Constraints

+

N/A

+

Range

+

asc

+

desc

+

Default Value

+

null

+

deleted

+

No

+

String

+

Definition

+

Whether the node is deleted. This field has been deprecated.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

node_list

+

Array of ClusterNodeInfo objects

+

Definition

+

Cluster node list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of nodes in a cluster.

+

Range

+

An integer greater than 0

+

failed_count

+

Integer

+

Definition

+

Total number of failed nodes in a logical cluster. Generally, the value is 0.

+

Range

+

An integer greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ClusterNodeInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Node ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Node name.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Node status.

+

Range

+

N/A

+

sub_status

+

String

+

Definition

+

Node sub-status.

+

Range

+

N/A

+

spec

+

String

+

Definition

+

Node flavor.

+

Range

+

N/A

+

inst_create_type

+

String

+

Definition

+

Instance creation type.

+

Range

+

  • INST: node in use

    +

  • NODE: idle node

    +
+

alias_name

+

String

+

Definition

+

Node alias.

+

Range

+

N/A

+

az_code

+

String

+

Definition

+

AZ code.

+

Range

+

N/A

+
+
+
+

Example Requests

  • Query the node list.

    +
    GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes
    +
  • GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes?deleted=false&node_ids&offset=0&limit=10&filter_by=instCreateType&filter=INST
    +
  • GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes?deleted=true&node_ids=0000b3c5-384a-4fa7-ab86-2c44dd97660a&offset=0&limit=10
    +
+
+

Example Responses

Status code: 200

+

Cluster node information queried.

+
{
+  "node_list" : [ {
+    "id" : "16413746-258e-4a3c-bea9-8496fdbefde3",
+    "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-2-1",
+    "status" : "ACTIVE",
+    "sub_status" : "CREATED",
+    "spec" : "dws2.kc1.2xlarge",
+    "inst_create_type" : null,
+    "alias_name" : null,
+    "az_code" : "eu-de-01c"
+  }, {
+    "id" : "46d8754b-3ed3-4b92-85b5-7479ef5b10ac",
+    "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-1-1",
+    "status" : "ACTIVE",
+    "sub_status" : "CREATED",
+    "spec" : "dws2.kc1.2xlarge",
+    "inst_create_type" : null,
+    "alias_name" : null,
+    "az_code" : "eu-de-01c"
+  } ],
+  "count" : 2,
+  "failed_count" : 0
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster node information queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ListClusterScaleInNumbers.html b/docs/dws/api-ref/ListClusterScaleInNumbers.html new file mode 100644 index 000000000..0f415da92 --- /dev/null +++ b/docs/dws/api-ref/ListClusterScaleInNumbers.html @@ -0,0 +1,143 @@ + + +

Querying the Number of Nodes to Be Removed from a Cluster for Better Performance

+

Function

This API is used to query the number of nodes to be removed from a cluster for better performance.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/shrink-numbers

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

shrink_sequence

+

Array of strings

+

Definition

+

Number of nodes to be removed.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the number of nodes to be removed from a cluster for better performance.

+
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink-numbers
+
+

Example Responses

Status code: 200

+

Request succeeded.

+
{
+  "shrink_sequence" : [ 3, 7 ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ListClusterSnapshots.html b/docs/dws/api-ref/ListClusterSnapshots.html new file mode 100644 index 000000000..fc6c022ab --- /dev/null +++ b/docs/dws/api-ref/ListClusterSnapshots.html @@ -0,0 +1,651 @@ + + +

Querying the Cluster Snapshot List

+

Function

This API is used to query the cluster snapshot list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

No limit.

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

sort_key

+

No

+

String

+

Definition

+

Sorting field.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

sort_dir

+

No

+

String

+

Definition

+

Sorting rule.

+

Constraints

+

N/A

+

Range

+

asc

+

desc

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

snapshots

+

Array of ClusterSnapshots objects

+

Definition

+

List of snapshot objects.

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

It is a 36-digit UUID.

+

count

+

Integer

+

Definition

+

Total number of snapshot objects.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ClusterSnapshots

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Snapshot ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Snapshot name.

+

Range

+

N/A

+

description

+

String

+

Definition

+

Snapshot description.

+

Range

+

N/A

+

started

+

String

+

Definition

+

Snapshot creation time. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

+

Range

+

N/A

+

size

+

Double

+

Definition

+

Snapshot size, in GB.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Snapshot status.

+
  • Range
  • CREATING
  • AVAILABLE
  • UNAVAILABLE
  • RESTORING
+

cluster_id

+

String

+

Definition

+

ID of the cluster for which the snapshot is created.

+

Range

+

N/A

+

datastore

+

Datastore object

+

Definition

+

Snapshot version.

+

Range

+

N/A

+

cluster_name

+

String

+

Definition

+

Name of the cluster for which the snapshot is created.

+

Range

+

N/A

+

updated

+

String

+

Definition

+

The time when the snapshot was updated.

+

Range

+

N/A

+

type

+

String

+

Definition

+

Snapshot type.

+

Range

+

MANUAL: manual snapshot.

+

AUTO: automatic snapshot.

+

bak_expected_start_time

+

String

+

Definition

+

Estimated start time of a snapshot.

+

Range

+

N/A

+

bak_keep_day

+

Integer

+

Definition

+

Retention days for a snapshot.

+

Range

+

N/A

+

bak_period

+

String

+

Definition

+

Snapshot policy.

+

Range

+

N/A

+

db_user

+

String

+

Definition

+

Database user.

+

Range

+

N/A

+

progress

+

String

+

Definition

+

Snapshot progress.

+

Range

+

N/A

+

backup_key

+

String

+

Definition

+

Snapshot backup key.

+

Range

+

N/A

+

prior_backup_key

+

String

+

Definition

+

Backup key of the previous snapshot used by the incremental backup.

+

Range

+

N/A

+

base_backup_key

+

String

+

Definition

+

Key of the full snapshot backup.

+

Range

+

N/A

+

backup_device

+

String

+

Definition

+

Backup media.

+

Range

+

N/A

+

total_backup_size

+

Integer

+

Definition

+

Total size of snapshots.

+

Range

+

N/A

+

base_backup_name

+

String

+

Definition

+

Name of the full snapshot.

+

Range

+

N/A

+

support_inplace_restore

+

Boolean

+

Definition

+

Whether in-place restoration is supported.

+

Range

+

N/A

+

fine_grained_backup

+

Boolean

+

Definition

+

Whether fine-grained backup is used.

+

Range

+

N/A

+

backup_level

+

String

+

Definition

+

Backup level.

+

Range

+

N/A

+

fine_grained_backup_detail

+

FineGrainedSnapshotDetail object

+

Definition

+

Fine-grained backup information.

+

Range

+

N/A

+

guest_agent_version

+

String

+

Definition

+

GuestAgent version.

+

Range

+

N/A

+

cluster_status

+

String

+

Definition

+

Cluster status.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 Datastore

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Cluster type.

+

Range

+

N/A

+

version

+

String

+

Definition

+

Cluster version.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 FineGrainedSnapshotDetail

Parameter

+

Type

+

Description

+

database

+

String

+

Definition

+

Database.

+

Range

+

N/A

+

schema_list

+

Array of strings

+

Definition

+

Schema list.

+

Range

+

N/A

+

table_list

+

Array of strings

+

Definition

+

Table set.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshots
+
+

Example Responses

Status code: 200

+

Snapshot list queried.

+
{
+  "project_id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
+  "cluster_id" : "e59d6b86-9072-46eb-a996-13f8b44994c1",
+  "snapshots" : [ {
+    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
+    "name" : "snapshot-1",
+    "description" : "",
+    "size" : 500,
+    "status" : "AVAILABLE",
+    "type" : "MANUAL",
+    "backup_device" : "obs",
+    "backup_key" : "20221027_041552",
+    "bak_expected_start_time" : "1666843740000",
+    "bak_keep_day" : 3,
+    "bak_period" : "0 9 4/8 ? * 2,3,4,5,6,7",
+    "base_backup_key" : "20221025_201556",
+    "base_backup_name" : "dws-test-20221025201427",
+    "cluster_id" : "e59d6b86-9072-46eb-a996-13f8b44994c1",
+    "cluster_name" : "test_1025_02",
+    "datastore" : {
+      "type" : "dws",
+      "version" : "8.2.0"
+    },
+    "db_user" : "dbadmin",
+    "fine_grained_backup" : false,
+    "guest_agent_version" : "8.2.0",
+    "prior_backup_key" : "20221026_201555",
+    "support_inplace_restore" : true,
+    "total_backup_size" : 813475,
+    "updated" : "2022-10-27T04:18:57"
+  } ],
+  "count" : 2
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Snapshot list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusterTags.html b/docs/dws/api-ref/ListClusterTags.html new file mode 100644 index 000000000..510b7a63d --- /dev/null +++ b/docs/dws/api-ref/ListClusterTags.html @@ -0,0 +1,177 @@ + + +

Querying Cluster Tags

+

Function

This API is used to query tag information of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of ResourceTag objects

+

Definition

+

Tag list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Tag key.

+

Range

+

N/A

+

value

+

String

+

Definition

+

Tag value.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags
+
+

Example Responses

Status code: 200

+

Tag information of the cluster queried.

+
{
+  "tags" : [ {
+    "key" : "key",
+    "value" : "value"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Tag information of the cluster queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusterWorkload.html b/docs/dws/api-ref/ListClusterWorkload.html new file mode 100644 index 000000000..9b96045eb --- /dev/null +++ b/docs/dws/api-ref/ListClusterWorkload.html @@ -0,0 +1,209 @@ + + +

Querying Whether Resource Management Is Enabled

+

Function

This API is used to query whether resource management is enabled.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

workload_status

+

WorkloadStatus object

+

Definition

+

Resource management status

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 WorkloadStatus

Parameter

+

Type

+

Description

+

workload_switch

+

String

+

Definition

+

Switch

+

Constraints

+

N/A

+

Range

+

on: enabled

+

off: disabled

+

Default Value

+

N/A

+

max_concurrency_num

+

Integer

+

Definition

+

Maximum concurrency

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Query whether resource management is enabled.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : "Success get workload manager status.",
+  "workload_status" : {
+    "workload_switch" : "on",
+    "max_concurrency_num" : 60
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ListClusters.html b/docs/dws/api-ref/ListClusters.html new file mode 100644 index 000000000..252026ace --- /dev/null +++ b/docs/dws/api-ref/ListClusters.html @@ -0,0 +1,810 @@ + + +

Querying the Cluster List

+

Function

This API is used to query the cluster list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID. If all clusters bound to enterprise projects are queried, the value is all_granted_eps.

+

Constraints

+

N/A

+

Range

+

all_granted_eps: all enterprise projects

+

0: default enterprise project

+

Others: data of the corresponding enterprise project

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

clusters

+

Array of ClusterInfo objects

+

Definition

+

Cluster object list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of clusters.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ClusterInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Cluster name.

+

Range

+

The value must be unique under the same account ID.

+

status

+

String

+

Definition

+

Cluster status. The value is an enumerated string.

+

Range

+

  • CREATING: The cluster is being created.

    +

  • ACTIVE: The cluster is available.

    +

  • FAILED: The cluster is unavailable.

    +

  • CREATE_FAILED: The cluster failed to be created.

    +

  • DELETING: The cluster is being deleted.

    +

  • DELETE_FAILED: The cluster failed to be deleted.

    +
+

version

+

String

+

Definition

+

DWS cluster version.

+

Range

+

The value contains three to four characters separated by decimal points, for example, 9.1.0.200. A larger value indicates a later version.

+

updated

+

String

+

Definition

+

Last modification time of a cluster. The format is ISO8601:YYYY-MM-DDThh:mm:ssZ.

+

Range

+

The value must be an ISO8601 time and later than or equal to the cluster creation time.

+

created

+

String

+

Definition

+

Cluster creation time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

+

Range

+

Time in ISO 8601 format.

+

port

+

Integer

+

Definition

+

Cluster service port. If this parameter is not specified when a cluster is created, the default value 8000 is used.

+

Range

+

8000 to 30000

+

endpoints

+

Array of Endpoints objects

+

Definition

+

Private network connection information about the cluster.

+

Range

+

N/A

+

nodes

+

Array of Nodes objects

+

Definition

+

Cluster nodes.

+

Range

+

The number of rows in the list is the same as the value of the number_of_node field.

+

tags

+

Array of Tags objects

+

Definition

+

Cluster tags.

+

Range

+

The default value is null.

+

user_name

+

String

+

Definition

+

Administrator username.

+

Range

+

The default value is dbadmin.

+

number_of_node

+

Integer

+

Definition

+

Number of nodes. This parameter is specified when a cluster is created.

+

Range

+

N/A

+

recent_event

+

Integer

+

Definition

+

Number of events. Only user operations that affect clusters are recorded. The switch operations of certain buttons are not recorded as cluster events.

+

Range

+

N/A

+

availability_zone

+

String

+

Definition

+

AZ.

+

Range

+

N/A

+

enterprise_project_id

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

node_type

+

String

+

Definition

+

Cluster flavor ID.

+

Range

+

N/A

+

vpc_id

+

String

+

Definition

+

VPC ID.

+

Range

+

N/A

+

subnet_id

+

String

+

Definition

+

Subnet ID.

+

Range

+

N/A

+

public_ip

+

PublicIp object

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

public_endpoints

+

Array of PublicEndpoints objects

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

action_progress

+

Map<String,String>

+

Definition

+

Task information. It consists of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task.

+

Range

+

The key can contain but is not limited to the following values:

+

  • CREATING

    +

  • RESTORING

    +

  • SNAPSHOTTING

    +

  • GROWING

    +

  • REBOOTING

    +

  • SETTING_CONFIGURATION: Security settings are being configured.

    +

  • CONFIGURING_EXT_DATASOURCE: The MRS connection is being configured.

    +

  • ADD_CN_ING: A CN is being added.

    +

  • DEL_CN_ING: A CN is being deleted.

    +

  • REDISTRIBUTING: Redistribution is in progress.

    +

  • ELB_BINDING: An ELB is being bound.

    +

  • ELB_UNBINDING: An ELB is being unbound.

    +

  • ELB_SWITCHING: An ELB is being switched.

    +

  • NETWORK_CONFIGURING: The network is being configured.

    +

  • DISK_EXPANDING: The disk is being expanded.

    +

  • ACTIVE_STANDY_SWITCHOVER: The primary/standby switchover is being performed.

    +

  • FLAVOR_RESIZING: The flavor is being changed.

    +

  • FINE_GRAINED_RESTORING: The fine-grained restoration is in progress.

    +

  • REPAIRING: The cluster is being repaired.

    +
+

sub_status

+

String

+

Definition

+

Sub-status of the available clusters.

+

Range

+

NORMAL

+

  • READONLY

    +

  • REDISTRIBUTING

    +

  • REDISTRIBUTION-FAILURE

    +

  • UNBALANCED

    +

  • UNBALANCED | READONLY

    +

  • DEGRADED

    +

  • DEGRADED | READONLY

    +

  • DEGRADED | UNBALANCED

    +

  • UNBALANCED | REDISTRIBUTING

    +

  • UNBALANCED | REDISTRIBUTION-FAILURE

    +

  • READONLY | REDISTRIBUTION-FAILURE

    +

  • UNBALANCED | READONLY | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | READONLY

    +
+

DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE

+

task_status

+

String

+

Definition

+

Result of an ongoing task or an executed task for cluster management.

+

Range

+

The value can contain but is not limited to the following values:

+

  • UNFREEZING

    +

  • FREEZING

    +

  • RESTORING

    +

  • SNAPSHOTTING

    +

  • GROWING

    +

  • REBOOTING

    +

  • SETTING_CONFIGURATION: Security settings are being configured.

    +

  • CONFIGURING_EXT_DATASOURCE: The MRS connection is being configured.

    +

  • DELETING_EXT_DATASOURCE: The MRS connection is being deleted.

    +

  • REBOOT_FAILURE: The reboot failed.

    +

  • RESIZE_FAILURE: The scale-out failed.

    +

  • ADD_CN_ING: A CN is being added.

    +

  • DEL_CN_ING: A CN is being deleted.

    +

  • CREATING_NODE: A node is being added.

    +

  • CREATE_NODE_FAILED: The node failed to be added.

    +

  • DELETING_NODE: The node is being deleted.

    +

  • DELETE_NODE_FAILED: The node failed to be deleted.

    +

  • REDISTRIBUTING: Redistribution is in progress.

    +

  • REDISTRIBUTE_FAILURE: Redistribution failed.

    +

  • WAITING_REDISTRIBUTION: Redistribution is waiting.

    +

  • REDISTRIBUTION_PAUSED: Redistribution is paused.

    +

  • ELB_BINDING: An ELB is being bound.

    +

  • ELB_BIND_FAILED: An ELB failed to be bound.

    +

  • ELB_UNBINDING: An ELB is being unbound.

    +

  • ELB_UNBIND_FAILED: An ELB failed to be unbound.

    +

  • ELB_SWITCHING: An ELB is being switched.

    +

  • ELB_SWITCHING_FAILED: An ELB failed to be switched.

    +

  • NETWORK_CONFIGURING: The network is being configured.

    +

  • NETWORK_CONFIG_FAILED: Network configuration failed.

    +

  • DISK_EXPAND_FAILED: Disk capacity expansion failed.

    +

  • DISK_EXPANDING: The disk is being expanded.

    +

  • ACTIVE_STANDY_SWITCHOVER: The primary/standby switchover is being performed.

    +

  • ACTIVE_STANDY_SWITCHOVER_FAILURE: The primary/standby switchover failed.

    +

  • FLAVOR_RESIZING_FAILED: The flavor change failed.

    +

  • FLAVOR_RESIZING: The flavor is being changed.

    +

  • FINE_GRAINED_RESTORING: The fine-grained restoration is in progress.

    +
+

security_group_id

+

String

+

Definition

+

Security group ID.

+

Range

+

N/A

+

failed_reasons

+

FailedReason object

+

Definition

+

Failure cause. If the parameter is left blank, the cluster is in the normal state.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 Endpoints

Parameter

+

Type

+

Description

+

connect_info

+

String

+

Definition

+

Private network connection information.

+

Range

+

N/A

+

jdbc_url

+

String

+

Definition

+

JDBC URL of the private network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

jdbc:postgresql://<connect_info>/<YOUR_DATABASE_NAME>

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Nodes

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster instance ID.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Cluster instance status.

+

Range

+

100: creating

+

199: idle

+

200: available

+

300: unavailable

+

303: creation failed

+

304: deleting

+

305: deletion failed

+

400: deleted

+

name

+

String

+

Definition

+

Instance name.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 Tags

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 PublicIp

Parameter

+

Type

+

Description

+

public_bind_type

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

auto_assign

+

not_use

+

bind_existing

+

Default Value

+

null

+

eip_id

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 PublicEndpoints

Parameter

+

Type

+

Description

+

public_connect_info

+

String

+

Definition

+

Public network connection information.

+

Range

+

N/A

+

jdbc_url

+

String

+

Definition

+

JDBC connection string of the public network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

jdbc:postgresql://<public_connect_info>/<YOUR_DATABASE_name>

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 FailedReason

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the cluster list.

+
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters?enterprise_project_id=all_granted_eps
+
+

Example Responses

Status code: 200

+

Cluster list queried.

+
{
+  "clusters" : [ {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15",
+    "name" : "dws-1",
+    "status" : "AVAILABLE",
+    "version" : "1.2.0",
+    "updated" : "2016-02-10T14:28:14Z",
+    "created" : "2016-02-10T14:26:14Z",
+    "port" : 8000,
+    "endpoints" : [ {
+      "connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "nodes" : [ {
+      "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
+      "name" : "dws-1-dws-cn-cn-1-1",
+      "status" : "200"
+    }, {
+      "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
+      "name" : "dws-1-dws-cn-cn-2-1",
+      "status" : "200"
+    }, {
+      "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
+      "name" : "dws-1-dws-cn-cn-3-1",
+      "status" : "200"
+    } ],
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value2"
+    } ],
+    "user_name" : "dbadmin",
+    "number_of_node" : 3,
+    "recent_event" : 6,
+    "availability_zone" : "eu-de-01",
+    "enterprise_project_id" : "0",
+    "node_type" : "dws.d1.xlarge.ultrahigh",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
+    },
+    "public_endpoints" : [ {
+      "public_connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "action_progress" : {
+      "SNAPSHOTTING" : "20%"
+    },
+    "sub_status" : "READONLY",
+    "task_status" : "SNAPSHOTTING",
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListDssPools.html b/docs/dws/api-ref/ListDssPools.html new file mode 100644 index 000000000..f8c386931 --- /dev/null +++ b/docs/dws/api-ref/ListDssPools.html @@ -0,0 +1,247 @@ + + +

Querying the DSS Storage Pool List

+

Function

This API is used to query the list of DSS storage pools. Only SSD dedicated resource pools that you enabled can be queried.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/dss-pools

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

pools

+

Array of DssPool objects

+

Definition

+

Details of the DSS storage pools.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Number of the DSS storage pools.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 DssPool

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

DSS storage pool name.

+

Range

+

N/A

+

name

+

String

+

Definition

+

DSS storage pool ID.

+

Range

+

N/A

+

type

+

String

+

Definition

+

DSS storage pool type.

+

  • SSD: ultra-high I/O storage pool.

    +
+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

availability_zone

+

String

+

Definition

+

AZ where the DSS storage pool is located.

+

Range

+

N/A

+

capacity

+

Integer

+

Definition

+

DSS storage pool capacity, in TB.

+

Range

+

N/A

+

status

+

String

+

Definition

+

DSS storage pool status.

+

Range

+

available: The DSS storage pool is available.

+

deploying: The DSS storage pool is being deployed and cannot be used.

+

extending: The DSS storage pool is being expanded and can be used.

+

created_at

+

String

+

Definition

+

Time when the DSS storage pool was created.

+

Range

+

Time format: UTC YYYY-MM-DDTHH:MM:SS

+
+
+
+

Example Requests

Query the list of dedicated distributed storage pools.

+
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/dss-pools
+
+

Example Responses

Status code: 200

+

DSS storage pool list queried.

+
{
+  "pools" : [ {
+    "id" : "c950ee97-587c-4f24-8a74-3367e3da570f",
+    "name" : "pool-1",
+    "type" : "SSD",
+    "project_id" : "63d910f2705a487ebe4e1c274748d9e1",
+    "capacity" : "1000",
+    "availability_zone" : "AZ1",
+    "status" : "available",
+    "created_at" : "2014-12-18T15:57:56.299000"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

DSS storage pool list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListElbs.html b/docs/dws/api-ref/ListElbs.html new file mode 100644 index 000000000..4318ed96e --- /dev/null +++ b/docs/dws/api-ref/ListElbs.html @@ -0,0 +1,275 @@ + + +

Querying the List of ELBs That Can Be Bound to a Cluster

+

Function

This API is used to query the list of ELBs that can be bound to a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/elbs

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

elbs

+

Array of ClusterElbInfo objects

+

Definition

+

ELB list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 ClusterElbInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

ELB ID.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

It is a 36-digit UUID.

+

name

+

String

+

Definition

+

ELB name.

+

Range

+

N/A

+

description

+

String

+

Definition

+

ELB description.

+

Range

+

N/A

+

vip_address

+

String

+

Definition

+

ELB address.

+

Range

+

N/A

+

vip_subnet_id

+

String

+

Definition

+

Subnet ID.

+

Range

+

N/A

+

tenant_id

+

String

+

Definition

+

Tenant ID.

+

Range

+

N/A

+

type

+

String

+

Definition

+

ELB type.

+

Range

+

Internal: dedicated

+

External: shared

+

admin_state_up

+

Boolean

+

Definition

+

ELB status.

+

Range

+

ACTIVE: in use.

+

PENDING_CREATE: creating.

+

ERROR: The policy has the same rule as another policy added to the same listener.

+

bandwidth

+

Integer

+

Definition

+

Bandwidth information.

+

Range

+

A positive integer greater than or equal to 0

+

vpc_id

+

String

+

Definition

+

VPC ID.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/clusters/194408fa-9d41-435c-a140-91edcf5fe519/elbs
+
+

Example Responses

Status code: 200

+

ELB list queried.

+
{
+  "elbs" : [ {
+    "id" : "1e6e0b66-6223-4523-bfd9-033c88b4ce9f",
+    "name" : "loadbalancer5",
+    "description" : "simple lb",
+    "bandwidth" : 0,
+    "vip_address" : "192.168.0.222",
+    "admin_state_up" : true,
+    "vpc_id" : "c9f1171e-dc90-4ae9-bf22-f9736983ce2d"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

ELB list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/ListEventSpecs.html b/docs/dws/api-ref/ListEventSpecs.html new file mode 100644 index 000000000..688bb3058 --- /dev/null +++ b/docs/dws/api-ref/ListEventSpecs.html @@ -0,0 +1,375 @@ + + +

Querying Event Configurations

+

Function

This API is used to query event configurations.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/event-specs

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

spec_name

+

No

+

String

+

Definition

+

Event configuration name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

category

+

No

+

String

+

Definition

+

Event category.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

severity

+

No

+

String

+

Definition

+

Event severity.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

source_type

+

No

+

String

+

Definition

+

Event source type.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

tag

+

No

+

String

+

Definition

+

Event tag.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

offset

+

No

+

String

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

1000

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Definition

+

Total number of event configurations.

+

Range

+

Greater than or equal to 0

+

event_specs

+

Array of EventSpecResponse objects

+

Definition

+

Event configuration list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 EventSpecResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Event configuration ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Event configuration definition name.

+

Range

+

N/A

+

display_name

+

String

+

Definition

+

Event configuration display name.

+

Range

+

N/A

+

description

+

String

+

Definition

+

Event configuration description.

+

Range

+

N/A

+

subject

+

String

+

Definition

+

Event subject.

+

Range

+

N/A

+

category

+

String

+

Definition

+

Event category.

+

Range

+

N/A

+

severity

+

String

+

Definition

+

Event severity.

+

Range

+

N/A

+

source_type

+

String

+

Definition

+

Event source type.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the event belongs.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/{project_id}/event-specs
+
+

Example Responses

Status code: 200

+

Event configurations of a cluster queried.

+
{
+  "event_specs" : [ {
+    "id" : "fa6e1502-9d08-48c7-900c-26d3b5bd6078",
+    "name" : "configureMRSExtDataSourcesSuccess",
+    "description" : "Succeeded in configuring the MRS data source for the cluster %s",
+    "subject" : "DWS event notification",
+    "category" : "management",
+    "severity" : "normal",
+    "display_name" : "Succeeded in configuring the MRS data source for the cluster",
+    "source_type" : "cluster",
+    "name_space" : "dws"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Event configurations of a cluster queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Event Management
+
+
+ diff --git a/docs/dws/api-ref/ListEventSubs.html b/docs/dws/api-ref/ListEventSubs.html new file mode 100644 index 000000000..ce1c9a444 --- /dev/null +++ b/docs/dws/api-ref/ListEventSubs.html @@ -0,0 +1,361 @@ + + +

Querying Subscribed Events

+

Function

This API is used to query subscribed events.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/event-subs

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

1000

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Definition

+

Total number of event subscriptions.

+

Range

+

N/A

+

event_subscriptions

+

Array of EventSubscriptionResponse objects

+

Definition

+

Event subscription list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 EventSubscriptionResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscription name.

+

Range

+

N/A

+

source_type

+

String

+

Definition

+

Event source type.

+

Range

+

N/A

+

source_id

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

category

+

String

+

Definition

+

Event category.

+

Range

+

N/A

+

severity

+

String

+

Definition

+

Event severity.

+

Range

+

N/A

+

tag

+

String

+

Definition

+

Event tag.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

1: enabled; 0: disabled.

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Address for the message notification topic.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message notification topic.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message notification type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs
+
+

Example Responses

Status code: 200

+

Subscribed events queried.

+
{
+  "event_subscriptions" : [ {
+    "id" : "4d62f33b-b9ee-41d3-b1bc-67e54b2239f9",
+    "name" : "00",
+    "category" : "",
+    "severity" : "",
+    "tag" : "",
+    "enable" : 1,
+    "language" : "zh-cn",
+    "source_type" : "",
+    "source_id" : "",
+    "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+    "name_space" : "DWS",
+    "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:CGS",
+    "notification_target_name" : "CGS",
+    "notification_target_type" : "SMN",
+    "time_zone" : "GMT+08:00"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Subscribed events queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Event Management
+
+
+ diff --git a/docs/dws/api-ref/ListEvents.html b/docs/dws/api-ref/ListEvents.html new file mode 100644 index 000000000..f87c79dbd --- /dev/null +++ b/docs/dws/api-ref/ListEvents.html @@ -0,0 +1,361 @@ + + +

Querying Event List

+

Function

This API is used to query event list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/events

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

1000

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

events

+

Array of EventResponse objects

+

Definition

+

Event details list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of events.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 EventResponse

Parameter

+

Type

+

Description

+

category

+

String

+

Definition

+

Event category.

+

Range

+

N/A

+

description

+

String

+

Definition

+

Incident description.

+

Range

+

N/A

+

event_id

+

String

+

Definition

+

Event ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Definition name of the event.

+

Range

+

N/A

+

display_name

+

String

+

Definition

+

Display name of the event.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the event belongs.

+

Range

+

N/A

+

severity

+

String

+

Definition

+

Event severity.

+

Range

+

N/A

+

source_type

+

String

+

Definition

+

Event source type.

+

Range

+

N/A

+

occur_time

+

Long

+

Definition

+

Time.

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Tenant credential ID.

+

Range

+

N/A

+

source_id

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

source_name

+

String

+

Definition

+

Event source name.

+

Range

+

N/A

+

status

+

Integer

+

Definition

+

Status.

+

Range

+

N/A

+

subject

+

String

+

Definition

+

Event subject.

+

Range

+

N/A

+

context

+

String

+

Definition

+

Event information.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/events
+
+

Example Responses

Status code: 200

+

Event list of the cluster queried.

+
{
+  "events" : [ {
+    "category" : "management",
+    "description" : "Cluster %s deleted",
+    "name" : "deleteClusterSuccess",
+    "severity" : "normal",
+    "status" : 2,
+    "subject" : "DWS event notification",
+    "context" : "The cluster test-ty-820-1006 is deleted",
+    "event_id" : "f63ccf96-e3e0-474a-835a-fd1a779f68bd",
+    "display_name" : "Cluster deleted",
+    "name_space" : "dws",
+    "source_type" : "cluster",
+    "occur_time" : 1664331248330,
+    "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+    "source_id" : "9defa0ce-b11c-47b2-abbc-5cad09ced772",
+    "source_name" : "test-ty-820-1006"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Event list of the cluster queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

No operation permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Event Management
+
+
+ diff --git a/docs/dws/api-ref/ListJobDetails.html b/docs/dws/api-ref/ListJobDetails.html new file mode 100644 index 000000000..562cba0eb --- /dev/null +++ b/docs/dws/api-ref/ListJobDetails.html @@ -0,0 +1,219 @@ + + +

Querying the Task Progress

+

Function

This API is used to query the task progress.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/job/{job_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

job_id

+

Yes

+

String

+

Definition

+

Task ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

Task ID.

+

Range

+

N/A

+

job_name

+

String

+

Definition

+

Task name.

+

Range

+

N/A

+

begin_time

+

String

+

Definition

+

Task start time.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

Task end time.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Current task status.

+

Range

+

N/A

+

failed_code

+

String

+

Definition

+

Error code of a task failure.

+

Range

+

N/A

+

failed_detail

+

String

+

Definition

+

Task failure details.

+

Range

+

N/A

+

progress

+

String

+

Definition

+

Task progress.

+

Range

+

N/A

+
+
+
+

Example Requests

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/job/2c9080e8845b207101845b245e1e0001
+
+

Example Responses

Status code: 200

+

Task progress queried.

+
{
+  "status" : "FAIL",
+  "progress" : "9%",
+  "job_id" : "2c9080e88459fa44018459fbeb600001",
+  "job_name" : "ecfClusterElbCreateJob",
+  "begin_time" : "2022-11-09T20:25:00",
+  "end_time" : "2022-11-09T20:30:00",
+  "failed_code" : "CreateELBTask-fail:DWS.0114",
+  "failed_detail" : "DWS.0114:ELB private IP is not configured."
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Task progress queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Task Management
+
+
+ diff --git a/docs/dws/api-ref/ListLogicalClusterRings.html b/docs/dws/api-ref/ListLogicalClusterRings.html new file mode 100644 index 000000000..3f502104f --- /dev/null +++ b/docs/dws/api-ref/ListLogicalClusterRings.html @@ -0,0 +1,324 @@ + + +

Querying Information About Available Ring Nodes in a Logical Cluster

+

Function

This API is used to query information about available ring nodes in a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/rings

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

cluster_rings

+

Array of LogicalClusterRingInfo objects

+

Definition

+

Cluster ring list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Number of cluster rings.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 4 LogicalClusterRingInfo

Parameter

+

Type

+

Description

+

ring_hosts

+

Array of RingHost objects

+

Definition

+

Cluster instance ring information.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 RingHost

Parameter

+

Type

+

Description

+

host_name

+

String

+

Definition

+

Host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

back_ip

+

String

+

Definition

+

Backend IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cpu_cores

+

Integer

+

Definition

+

Number of host CPUs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

memory

+

Double

+

Definition

+

Host memory.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

disk_size

+

Double

+

Definition

+

Disk size of the host.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Query information about available ring nodes in a logical cluster.

+
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/rings
+
+

Example Responses

Status code: 200

+

Information about available ring nodes in a logical cluster queried.

+
{
+  "cluster_rings" : [ {
+    "ring_hosts" : [ {
+      "host_name" : "host-172-16-20-246",
+      "back_ip" : "172.16.73.90",
+      "cpu_cores" : 8,
+      "memory" : 32.0,
+      "disk_size" : 800.0
+    }, {
+      "host_name" : "host-172-16-4-26",
+      "back_ip" : "172.16.123.5",
+      "cpu_cores" : 8,
+      "memory" : 32.0,
+      "disk_size" : 800.0
+    }, {
+      "host_name" : "host-172-16-43-90",
+      "back_ip" : "172.16.92.175",
+      "cpu_cores" : 8,
+      "memory" : 32.0,
+      "disk_size" : 800.0
+    } ]
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Information about available ring nodes in a logical cluster queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListLogicalClusterTasks.html b/docs/dws/api-ref/ListLogicalClusterTasks.html new file mode 100644 index 000000000..df58e131c --- /dev/null +++ b/docs/dws/api-ref/ListLogicalClusterTasks.html @@ -0,0 +1,361 @@ + + +

Querying Task Information About a Logical Cluster

+

Function

This API is used to query task information about a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/tasks

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+

logical_cluster_name

+

No

+

String

+

Definition

+

Cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

type

+

No

+

String

+

Definition

+

Type.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

order_by

+

No

+

String

+

Definition

+

Sorting field.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

order

+

No

+

String

+

Definition

+

Sorting order (ascending or descending)

+

Constraints

+

N/A

+

Range

+

ASC

+

DESC

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

logical_cluster_tasks

+

Array of LogicalClusterTaskInfo objects

+

Definition

+

Task information of the logical cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

count

+

Long

+

Definition

+

Total number of the logical cluster tasks.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 LogicalClusterTaskInfo

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Task type.

+

Range

+

N/A

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Task start time.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

Task end time.

+

Range

+

N/A

+

result

+

String

+

Definition

+

Task execution result.

+

Range

+

N/A

+

log

+

String

+

Definition

+

Task execution log.

+

Range

+

N/A

+
+
+
+

Example Requests

  • Query task information about a logical cluster.

    +
    GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/tasks
    +
  • GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/tasks?offset=0&limit=10&logical_cluster_name=test_logical&type=Expand&order_by=startTime&order=DESC
    +
+
+

Example Responses

Status code: 200

+

Task information queried.

+
{
+  "logical_cluster_tasks" : [ {
+    "type" : "Grow",
+    "logical_cluster_name" : "elastic_group",
+    "start_time" : "2023-06-05 01:58:43",
+    "end_time" : "2023-06-05 02:11:50",
+    "result" : "success",
+    "log" : "Expand from outside success"
+  }, {
+    "type" : "Create",
+    "logical_cluster_name" : "test_logical",
+    "start_time" : "2023-06-21 08:35:58",
+    "end_time" : "2023-06-21 08:36:14",
+    "result" : "failed",
+    "log" : "list index out of range\\nChecking whether the reentry command is consistent with the previous command."
+  } ],
+  "count" : 2
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Task information queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListLogicalClusterVolumes.html b/docs/dws/api-ref/ListLogicalClusterVolumes.html new file mode 100644 index 000000000..89ca92b2b --- /dev/null +++ b/docs/dws/api-ref/ListLogicalClusterVolumes.html @@ -0,0 +1,257 @@ + + +

Querying Disk Information of a Logical Cluster

+

Function

This API is used to query the disk information of a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters/volumes

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

volumes

+

Array of LogicalClusterVolume objects

+

Definition

+

Disk information list of the logical cluster.

+

Range

+

N/A

+

count

+

Long

+

Definition

+

Total number of disks in the logical cluster.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 LogicalClusterVolume

Parameter

+

Type

+

Description

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

usage

+

String

+

Definition

+

Usage disk space.

+

Range

+

N/A

+

total

+

String

+

Definition

+

Total disk space.

+

Range

+

N/A

+

percent

+

String

+

Definition

+

Disk usage.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the disk information of a logical cluster.

+
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/volumes
+
+

Example Responses

Status code: 200

+

Cluster disk information queried.

+
{
+  "volumes" : [ {
+    "logical_cluster_name" : "v3_logical",
+    "usage" : "1.0G",
+    "total" : "10.0G",
+    "percent" : 0.1
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster disk information queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListLogicalClusters.html b/docs/dws/api-ref/ListLogicalClusters.html new file mode 100644 index 000000000..bca9eaa3d --- /dev/null +++ b/docs/dws/api-ref/ListLogicalClusters.html @@ -0,0 +1,604 @@ + + +

Querying the Logical Cluster List

+

Function

This API is used to query the logical cluster list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/logical-clusters

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

logical_clusters

+

Array of LogicalClusterInfo objects

+

Definition

+

Logical cluster list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of logical clusters.

+

Range

+

N/A

+

add_enable

+

Boolean

+

Definition

+

If other O&M operations are performed in the cluster, the value is false. In this case, a logical cluster cannot be added.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 LogicalClusterInfo

Parameter

+

Type

+

Description

+

logical_cluster_id

+

String

+

Definition

+

Logical cluster ID.

+

Range

+

N/A

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

cluster_rings

+

Array of ClusterRing objects

+

Definition

+

Host information of the logical cluster.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Logical cluster status.

+

Range

+

N/A

+

first_logical_cluster

+

Boolean

+

Definition

+

Whether the logical cluster is the first one. The first logical cluster created or converted in an earlier version cannot be deleted because it contains some system views.

+

Range

+

N/A

+

action_info

+

ActionInfo object

+

Definition

+

Task information of the logical cluster.

+

Range

+

N/A

+

edit_enable

+

Boolean

+

Definition

+

Whether the logical cluster can be edited.

+

Range

+

N/A

+

restart_enable

+

Boolean

+

Definition

+

Whether the logical cluster can be restarted.

+

Range

+

N/A

+

delete_enable

+

Boolean

+

Definition

+

Whether the logical cluster can be deleted.

+

Range

+

N/A

+

add_to_elastic

+

Boolean

+

Definition

+

Whether autoscaling is allowed.

+

Range

+

N/A

+

mode

+

String

+

Definition

+

Logical cluster schema.

+

Range

+

N/A

+

waiting_for_killing

+

Integer

+

Definition

+

Job waiting time.

+

Range

+

N/A

+

cluster_type

+

String

+

Definition

+

Cluster type.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ClusterRing

Parameter

+

Type

+

Description

+

ring_hosts

+

Array of RingHost objects

+

Definition

+

Cluster host information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

un_shrinkable_cluster_ring

+

Boolean

+

Definition

+

Whether scale-in is supported.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 RingHost

Parameter

+

Type

+

Description

+

host_name

+

String

+

Definition

+

Host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

back_ip

+

String

+

Definition

+

Backend IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cpu_cores

+

Integer

+

Definition

+

Number of host CPUs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

memory

+

Double

+

Definition

+

Host memory.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

disk_size

+

Double

+

Definition

+

Disk size of the host.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 ActionInfo

Parameter

+

Type

+

Description

+

action_name

+

String

+

Definition

+

Operation name.

+

Range

+

Create: creating a logical cluster

+

Expand: scaling out a logical cluster

+

Restart: restarting a logical cluster

+

Delete: deleting a logical cluster

+

Shrink: scaling in a logical cluster

+

progress

+

Integer

+

Definition

+

Operation progress. The default value is 10.

+

Range

+

0 to 100

+

completed

+

Boolean

+

Definition

+

Whether the operation is complete.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Start time of the operation.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time of the operation.

+

Range

+

N/A

+

result

+

String

+

Definition

+

Operation result. The value is an empty string by default.

+

Range

+

success

+

failed

+

logs

+

String

+

Definition

+

Information on operation logs.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the logical cluster list.

+
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters
+
+

Example Responses

Status code: 200

+

Cluster list queried.

+
{
+  "logical_clusters" : [ {
+    "logical_cluster_id" : "fa9d69a0-3814-4fb9-98df-d9f4f5ef53ca",
+    "logical_cluster_name" : "elastic_group",
+    "cluster_rings" : [ {
+      "ring_hosts" : [ {
+        "host_name" : "host-172-16-20-246",
+        "back_ip" : "172.16.73.90",
+        "cpu_cores" : 8,
+        "memory" : 32.0,
+        "disk_size" : 800.0
+      }, {
+        "host_name" : "host-172-16-4-26",
+        "back_ip" : "172.16.123.5",
+        "cpu_cores" : 8,
+        "memory" : 32.0,
+        "disk_size" : 800.0
+      }, {
+        "host_name" : "host-172-16-43-90",
+        "back_ip" : "172.16.92.175",
+        "cpu_cores" : 8,
+        "memory" : 32.0,
+        "disk_size" : 800.0
+      } ],
+      "un_shrinkable_cluster_ring" : true
+    } ],
+    "status" : "Normal",
+    "first_logical_cluster" : false,
+    "action_info" : {
+      "progress" : 100,
+      "completed" : true,
+      "result" : "success",
+      "logs" : null,
+      "action_name" : "Grow",
+      "start_time" : "2023-06-05 01:58:43",
+      "end_time" : "2023-06-05 02:11:50"
+    },
+    "edit_enable" : true,
+    "restart_enable" : true,
+    "delete_enable" : false,
+    "add_to_elastic" : true,
+    "mode" : null,
+    "cluster_type" : null
+  } ],
+  "count" : 1,
+  "add_enable" : true
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListLtsLogs.html b/docs/dws/api-ref/ListLtsLogs.html new file mode 100644 index 000000000..35ba5f9f3 --- /dev/null +++ b/docs/dws/api-ref/ListLtsLogs.html @@ -0,0 +1,278 @@ + + +

Obtaining the LTS Log List

+

Function

This API is used to query the LTS log list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/lts-logs

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

No limit.

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

access_status

+

String

+

Definition

+

Whether the log function is enabled.

+

Range

+

N/A

+

lts_access_list

+

Array of LtslogInfo objects

+

Definition

+

LTS log list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number.

+

Range

+

Greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 LtslogInfo

Parameter

+

Type

+

Description

+

status

+

String

+

Definition

+

Configuration status.

+

Range

+

N/A

+

id

+

String

+

Definition

+

Log ID.

+

Range

+

N/A

+

log_type

+

String

+

Definition

+

Log type.

+

Range

+

N/A

+

log_desc

+

String

+

Definition

+

Log description.

+

Range

+

N/A

+

access_url

+

String

+

Definition

+

URL for accessing LTS logs.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/lts-logs
+
+

Example Responses

Status code: 200

+

LTS log list queried.

+
{
+  "access_status" : "OPEN",
+  "lts_access_list" : [ {
+    "status" : "OPEN",
+    "id" : "c0c4e5f2-9b2a-4b47-a649-baf40b33e2e0",
+    "log_type" : "messages",
+    "log_desc" : "operating system messages log",
+    "access_url" : "/lts/?region=eu-de-01&locale=#/cts/logEventsLeftMenu/events?groupId=b6680a92-e14f-4a7d-b669-4f702db806f7&groupName=s-5&topicId=1a9fe6d0-d383-4d58-adb6-2c26d229944e&topicName=messages&epsId=0"
+  } ],
+  "count" : 2
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

LTS log list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dws/api-ref/ListNodeTypes.html b/docs/dws/api-ref/ListNodeTypes.html new file mode 100644 index 000000000..9086415f2 --- /dev/null +++ b/docs/dws/api-ref/ListNodeTypes.html @@ -0,0 +1,542 @@ + + +

Querying Flavor Information

+

Function

This API is used to query flavors supported by GaussDB(DWS).

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/node-types

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

node_types

+

Array of NodeTypes objects

+

Definition

+

Available flavor list.

+

Range

+

Non-empty object list.

+

count

+

Integer

+

Definition

+

Total number of flavors.

+

Range

+

A positive integer greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 NodeTypes

Parameter

+

Type

+

Description

+

spec_name

+

String

+

Definition

+

Flavor name.

+

Range

+

Letters, digits, dots (.), underscores (_), and hyphens (-) are allowed.

+

detail

+

Array of Detail objects

+

Definition

+

Flavor details.

+

Range

+

N/A

+

id

+

String

+

Definition

+

Flavor ID.

+

Range

+

Generally, the value is a UUID.

+

datastore_type

+

String

+

Definition

+

Product type.

+

Range

+

  • dws: cloud data warehouse

    +

  • hybrid: hybrid data warehouse

    +
+

architecture

+

String

+

Definition

+

Architecture type.

+

Range

+

  • x86

    +

  • arm

    +
+

available_zones

+

Array of NodeTypeAvailableZones objects

+

Definition

+

Supported AZs and status information.

+

Range

+

N/A

+

ram

+

Integer

+

Definition

+

Memory size, in GB.

+

Range

+

A positive integer greater than 0

+

vcpus

+

Integer

+

Definition

+

Number of CPUs.

+

Range

+

A positive integer greater than 0

+

datastores

+

Array of NodeTypeDatastores objects

+

Definition

+

Kernel version information.

+

Range

+

N/A

+

volume

+

VolumeResp object

+

Definition

+

Storage of fixed storage specifications.

+

Range

+

For a fixed storage the value is the storage of its typical configuration. For an elastic storage, the value null.

+

elastic_volume_specs

+

Array of NodeTypeElasticVolumeSpecs objects

+

Definition

+

Information of elastic storage specifications.

+

Range

+

For elastic storage specifications, the value is the storage of its typical configuration (including the storage type, minimum capacity, maximum capacity, and step). For fixed storage specifications, the value is null.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 Detail

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Attribute type.

+

Range

+

N/A

+

value

+

String

+

Definition

+

Attribute value.

+

Range

+

N/A

+

unit

+

String

+

Definition

+

Attribute unit.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 NodeTypeAvailableZones

Parameter

+

Type

+

Description

+

code

+

String

+

Definition

+

AZ ID.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Favor status.

+

Range

+

  • normal: available

    +

  • sellout: sold out

    +

  • abandon: unavailable

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 NodeTypeDatastores

Parameter

+

Type

+

Description

+

version

+

String

+

Definition

+

Kernel version.

+

Range

+

The version consists of digits and decimal points, for example, 9.1.0 and 9.1.1.100.

+

attachments

+

attachments object

+

Definition

+

Additional information about the kernel version.

+

Range

+

N/A

+

role

+

String

+

Definition

+

Version type.

+

Range

+

  • STABLE: stable version

    +

  • PREVIEW: preview version

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 7 attachments

Parameter

+

Type

+

Description

+

min_cn

+

Integer

+

Definition

+

Minimum CNs allowed by the kernel version.

+

Range

+

A positive integer greater than 0

+

max_cn

+

Integer

+

Definition

+

Maximum CNs allowed by the kernel version.

+

Range

+

A positive integer greater than 0

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 VolumeResp

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Disk type. Only SSDs are supported.

+

Range

+

Only SSDs are supported.

+

size

+

Integer

+

Definition

+

Available disk capacity.

+

Range

+

Only SSDs are supported.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 NodeTypeElasticVolumeSpecs

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Cloud disk type.

+

Range

+

N/A

+

step

+

Integer

+

Definition

+

Cloud disk size increment.

+

Range

+

N/A

+

min_size

+

Integer

+

Definition

+

Minimum cloud disk size.

+

Range

+

N/A

+

max_size

+

Integer

+

Definition

+

Maximum cloud disk size.

+

Range

+

N/A

+
+
+
+

Example Requests

Query flavor information.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/node-types
+
+

Example Responses

Status code: 200

+

Flavor information queried.

+
{
+  "node_types" : [ {
+    "spec_name" : "dws.d2.xlarge",
+    "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
+    "datastore_type" : "dws",
+    "architecture" : "x86",
+    "available_zones" : [ {
+      "code" : "az1",
+      "status" : "normal"
+    } ],
+    "ram" : 32,
+    "vcpus" : 4,
+    "datastores" : [ {
+      "version" : "8.1.3.200",
+      "attachments" : {
+        "min_cn" : 2,
+        "max_cn" : 20
+      },
+      "role" : "STABLE"
+    } ],
+    "volume" : {
+      "type" : "SSD",
+      "size" : 160
+    },
+    "elastic_volume_specs" : [ {
+      "type" : "SSD",
+      "step" : 100,
+      "min_size" : 100,
+      "max_size" : 32000
+    } ],
+    "detail" : [ {
+      "type" : "vCPU",
+      "value" : "4"
+    }, {
+      "value" : "1675",
+      "type" : "LOCAL_DISK",
+      "unit" : "GB"
+    }, {
+      "type" : "mem",
+      "value" : "32",
+      "unit" : "GB"
+    } ]
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Flavor information queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListPlanExecLogs.html b/docs/dws/api-ref/ListPlanExecLogs.html new file mode 100644 index 000000000..270211987 --- /dev/null +++ b/docs/dws/api-ref/ListPlanExecLogs.html @@ -0,0 +1,292 @@ + + +

Querying Plan Execution Logs

+

Function

This API is used to query plan execution logs.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/logs

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

plan_logs

+

Array of PlanLog objects

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 PlanLog

Parameter

+

Type

+

Description

+

exec_time

+

String

+

Definition

+

Execution time.

+

Range

+

N/A

+

stage_info

+

String

+

Definition

+

Plan execution stage.

+

Range

+

N/A

+

exec_result

+

Integer

+

Definition

+

Execution result.

+

Range

+

N/A

+

exec_log

+

String

+

Definition

+

Execution log.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/logs
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "plan_logs" : [ {
+    "exec_time" : "2023-08-23 13:28:50",
+    "stage_info" : "stage1",
+    "exec_result" : 0,
+    "exec_log" : "2023-08-23 13:28:47.661892+00:00 UTC |INFO| start change stage."
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ListRedistributionSchema.html b/docs/dws/api-ref/ListRedistributionSchema.html new file mode 100644 index 000000000..4b5468143 --- /dev/null +++ b/docs/dws/api-ref/ListRedistributionSchema.html @@ -0,0 +1,289 @@ + + +

Querying the Schema Information of the Table to Be Redistributed

+

Function

This API is used to query the schema information of the table to be redistributed.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/redistribution/schemas

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

db_name

+

Yes

+

String

+

Definition

+

Pagination offset.

+

Constraints

+

N/A

+

Range

+

^[a-zA-Z0-9\u4e00-\u9fa5_.+= :@!#-]{0,255}$

+

Default Value

+

null

+

limit

+

No

+

Integer

+

Definition

+

Number of records on a page.

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 1

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

schema_name

+

No

+

String

+

Definition

+

Schema name.

+

Constraints

+

N/A

+

Range

+

^[a-zA-Z0-9\u4e00-\u9fa5_.+= ,:@!#-]{0,2048}$

+

Default Value

+

null

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

If the request is normal, the value is DWS.0000.

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+

schemas

+

Array of RedisSchema objects

+

Definition

+

List of schemas to be redistributed.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of records.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 RedisSchema

Parameter

+

Type

+

Description

+

schema_name

+

String

+

Definition

+

Schema name.

+

Range

+

N/A

+

redis_order

+

Integer

+

Definition

+

Priority No.

+

Range

+

An integer greater than 0

+
+
+
+

Example Requests

Query the schema of the table to be redistributed in the GaussDB database.

+
GET https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/clusters/bcdfb00c-a5e3-4896-83c7-3c397ed99f28/redistribution/schemas?limit=10&offset=0&db_name=gaussdb
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : "Request processed.",
+  "schemas" : [ {
+    "schema_name" : "scheduler",
+    "redis_order" : 1024
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ListSchemas.html b/docs/dws/api-ref/ListSchemas.html new file mode 100644 index 000000000..6edf07ba7 --- /dev/null +++ b/docs/dws/api-ref/ListSchemas.html @@ -0,0 +1,387 @@ + + +

Querying the Schema Space Information of a Cluster

+

Function

This API is used to query schema space information of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemas

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

database_name

+

Yes

+

String

+

Definition

+

Database name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

sort_key

+

No

+

String

+

Definition

+

Sorting field.

+

Constraints

+

N/A

+

Range

+

schemaName

+

Default Value

+

N/A

+

sort_dir

+

No

+

String

+

Definition

+

Sorting field.

+

Constraints

+

N/A

+

Range

+

ASC

+

DESC

+

Default Value

+

N/A

+

keywords

+

No

+

String

+

Definition

+

Keyword entered for search.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

schemas

+

Array of SchemaInfo objects

+

Definition

+

Schema information list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 SchemaInfo

Parameter

+

Type

+

Description

+

schema_name

+

String

+

Definition

+

Cluster schema name.

+

Range

+

N/A

+

database_name

+

String

+

Definition

+

Database name.

+

Range

+

N/A

+

total_value

+

Integer

+

Definition

+

Total space used by the cluster schema.

+

Range

+

N/A

+

perm_space

+

Integer

+

Definition

+

Space threshold for the cluster schema.

+

Range

+

N/A

+

skew_percent

+

Double

+

Definition

+

Skew ratio.

+

Range

+

N/A

+

min_value

+

Integer

+

Definition

+

Minimum value.

+

Range

+

N/A

+

max_value

+

Integer

+

Definition

+

Maximum value.

+

Range

+

N/A

+

min_dn

+

String

+

Definition

+

Minimum number of DN nodes.

+

Range

+

N/A

+

max_dn

+

String

+

Definition

+

Maximum number of CN nodes.

+

Range

+

N/A

+

dn_num

+

Integer

+

Definition

+

Number of DN nodes.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/databases/gaussdb/schemas
+
+

Example Responses

Status code: 200

+

Shema space information queried.

+
{
+  "schemas" : [ {
+    "schema_name" : "gs_logical_cluster",
+    "database_name" : "gaussdb",
+    "total_value" : 0,
+    "perm_space" : -1,
+    "skew_percent" : 0.0,
+    "min_value" : 0,
+    "max_value" : 0,
+    "min_dn" : "dn_6001_6002",
+    "max_dn" : "",
+    "dn_num" : 3
+  } ],
+  "count" : 2
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Shema space information queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ListSnapshotDetails.html b/docs/dws/api-ref/ListSnapshotDetails.html new file mode 100644 index 000000000..d60997b63 --- /dev/null +++ b/docs/dws/api-ref/ListSnapshotDetails.html @@ -0,0 +1,517 @@ + + +

Querying Snapshot Details

+

Function

This API is used to query snapshot details using the snapshot ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/snapshots/{snapshot_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

snapshot

+

SnapshotDetail object

+

Definition

+

Snapshot details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 SnapshotDetail

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Snapshot ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Snapshot name.

+

Range

+

N/A

+

description

+

String

+

Definition

+

Snapshot description.

+

Range

+

N/A

+

started

+

String

+

Definition

+

Snapshot creation time. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

+

Range

+

N/A

+

finished

+

String

+

Definition

+

Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ.

+

Range

+

N/A

+

size

+

Double

+

Definition

+

Snapshot size, in GB.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Snapshot status.

+
  • Range
  • CREATING
  • AVAILABLE
  • UNAVAILABLE
+

type

+

String

+

Definition

+

Snapshot type.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

ID of the cluster for which the snapshot is created.

+

Range

+

N/A

+

datastore

+

Datastore object

+

Definition

+

Snapshot version.

+

Range

+

N/A

+

cluster_name

+

String

+

Definition

+

Name of the cluster for which the snapshot is created.

+

Range

+

N/A

+

bak_expected_start_time

+

String

+

Definition

+

Estimated start time of a snapshot.

+

Range

+

N/A

+

bak_keep_day

+

Integer

+

Definition

+

Retention days for a snapshot.

+

Range

+

N/A

+

bak_period

+

String

+

Definition

+

Snapshot policy.

+

Range

+

N/A

+

db_user

+

String

+

Definition

+

Database user.

+

Range

+

N/A

+

progress

+

String

+

Definition

+

Snapshot progress.

+

Range

+

N/A

+

backup_key

+

String

+

Definition

+

Snapshot backup key.

+

Range

+

N/A

+

prior_backup_key

+

String

+

Definition

+

Incremental snapshot. The backup key of the previous snapshot is used.

+

Range

+

N/A

+

base_backup_key

+

String

+

Definition

+

Backup key of the full snapshot.

+

Range

+

N/A

+

backup_device

+

String

+

Definition

+

Backup media.

+

Range

+

NBU or OBS

+

total_backup_size

+

Integer

+

Definition

+

Total size of snapshots.

+

Range

+

N/A

+

base_backup_name

+

String

+

Definition

+

Name of the full snapshot.

+

Range

+

N/A

+

support_inplace_restore

+

Boolean

+

Definition

+

Whether in-place restoration is supported.

+

Range

+

N/A

+

fine_grained_backup

+

Boolean

+

Definition

+

Whether fine-grained backup is used.

+

Range

+

N/A

+

backup_level

+

String

+

Definition

+

Backup level.

+

Range

+

N/A

+

fine_grained_backup_detail

+

FineGrainedSnapshotDetail object

+

Definition

+

Fine-grained backup information.

+

Range

+

N/A

+

guest_agent_version

+

String

+

Definition

+

GuestAgent version.

+

Range

+

N/A

+

cluster_status

+

String

+

Definition

+

Cluster status.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Datastore

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Cluster type.

+

Range

+

N/A

+

version

+

String

+

Definition

+

Cluster version.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 FineGrainedSnapshotDetail

Parameter

+

Type

+

Description

+

database

+

String

+

Definition

+

Database.

+

Range

+

N/A

+

schema_list

+

Array of strings

+

Definition

+

Schema list.

+

Range

+

N/A

+

table_list

+

Array of strings

+

Definition

+

Table set.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7
+
+

Example Responses

Status code: 200

+

Snapshot details queried.

+
{
+  "snapshot" : {
+    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
+    "name" : "snapshot-1",
+    "description" : "snapshot description",
+    "started" : "2016-08-23T03:59:23Z",
+    "finished" : "2016-08-23T04:01:40Z",
+    "size" : 500,
+    "status" : "AVAILABLE",
+    "type" : "MANUAL",
+    "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Snapshot details queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ListSnapshotFlavorInfo.html b/docs/dws/api-ref/ListSnapshotFlavorInfo.html new file mode 100644 index 000000000..5240cda87 --- /dev/null +++ b/docs/dws/api-ref/ListSnapshotFlavorInfo.html @@ -0,0 +1,582 @@ + + +

Querying Flavors by Snapshot ID

+

Function

This API is used to query flavors based on the snapshot ID. You can query the flavor of a snapshot or the flavor to which a snapshot can be restored.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/snapshots/{snapshot_id}/flavors

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Definition

+

Flavor type.

+

Constraints

+

N/A

+

Range

+

snapshot: Only the flavor used by the snapshot is queried.

+

restore: Flavor used by the snapshot and flavors that the snapshot can be restored to are queried.

+

Default Value

+

snapshot

+

az_code

+

No

+

String

+

Definition

+

AZ that the snapshot can be restored to. Once the target AZ is selected, you can restore the snapshot to the flavors in the target AZ.

+

When restoring a 3-AZ cluster, you need to specify three AZ codes separated by commas (,).

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

AZ of the original cluster where the snapshot is located.

+

fine_grained_restore

+

No

+

Boolean

+

Definition

+

Whether fine-grained backup restoration is used to filter available flavors during restoration.

+

Constraints

+

N/A

+

Range

+

true|false

+

Default Value

+

false

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

flavors

+

Array of ProductUnitResp objects

+

Definition

+

Response to the snapshot flavor information.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of snapshot flavors.

+

Range

+

A positive integer greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ProductUnitResp

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Flavor ID.

+

Range

+

N/A

+

code

+

String

+

Definition

+

Flavor code.

+

Range

+

N/A

+

default_capacity

+

String

+

Definition

+

Default capacity of the flavor.

+

Range

+

N/A

+

classify

+

String

+

Definition

+

Flavor type.

+

Range

+

N/A

+

scenario

+

String

+

Definition

+

Flavor application scenario.

+

Range

+

N/A

+

version

+

String

+

Definition

+

Flavor version information.

+

Range

+

v1.0: first-generation flavor

+

v2.0: second-generation flavor.

+

status

+

String

+

Definition

+

Flavor status.

+

Range

+

N/A

+

attribute

+

Array of ProductExtendResp objects

+

Definition

+

Extended information.

+

Range

+

N/A

+

duplicate

+

Integer

+

Definition

+

Number of copies used by the flavor.

+

Range

+

N/A

+

default_node

+

Integer

+

Definition

+

Default number of nodes.

+

Range

+

N/A

+

min_node

+

Integer

+

Definition

+

Minimum number of nodes.

+

Range

+

N/A

+

max_node

+

Integer

+

Definition

+

Maximum number of nodes.

+

Range

+

N/A

+

product_version_list

+

Array of ProductVersionResp objects

+

Definition

+

Version information.

+

Range

+

N/A

+

flavor_id

+

String

+

Definition

+

Bottom-layer flavor ID. Different from the id field, this field is not used.

+

Range

+

N/A

+

flavor_code

+

String

+

Definition

+

Bottom-layer flavor code.

+

Range

+

N/A

+

volume_num

+

Integer

+

Definition

+

Number of disks supported by the flavor.

+

Range

+

N/A

+

volume_used

+

ProductVolumeUsedResp object

+

Definition

+

Disk usage of the cluster when a snapshot is created.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ProductExtendResp

Parameter

+

Type

+

Description

+

code

+

String

+

Definition

+

Code of the extended information of the cluster flavor.

+

Range

+

N/A

+

value

+

String

+

Definition

+

Value of the extended information of the cluster flavor.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 ProductVersionResp

Parameter

+

Type

+

Description

+

min_cn

+

Integer

+

Definition

+

Minimum number of CNs supported by the flavor in this version.

+

Range

+

N/A

+

max_cn

+

Integer

+

Definition

+

Maximum number of CNs supported by the flavor in this version.

+

Range

+

N/A

+

version_type

+

String

+

Definition

+

Version type supported by the flavor.

+

Range

+

1: stable version

+

0: latest version

+

datastore_version

+

String

+

Definition

+

Version number supported by the flavor.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 ProductVolumeUsedResp

Parameter

+

Type

+

Description

+

volume_type

+

String

+

Definition

+

Storage type used by a node.

+

Range

+

HIGH: SAS disk

+

ULTRAHIGH: SSD cloud disk

+

COMMON: SATA disk

+

LOCAL_DISK: local disk

+

volume_num

+

Integer

+

Definition

+

Number of disks used by a node.

+

Range

+

N/A

+

capacity

+

Integer

+

Definition

+

Available storage of a single node in the cluster.

+

Range

+

N/A

+

volume_size

+

Integer

+

Definition

+

Physical storage of a single data disk on a cluster node.

+

Range

+

N/A

+
+
+
+

Example Requests

Query flavors by snapshot ID.

+
GET https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/snapshots/46921d1d-3d15-4a6f-8834-520c108c03da/flavors?type=snapshot
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "flavors" : [ {
+    "id" : "908c1620-4cd8-3803-9082-2b29fc966917",
+    "code" : "dws2.km1.xlarge",
+    "classify" : "dws",
+    "scenario" : "non-production",
+    "version" : "v1.0",
+    "status" : "enable",
+    "attribute" : [ {
+      "code" : "maxQueue",
+      "value" : ""
+    }, {
+      "code" : "cpuNum",
+      "value" : "4"
+    }, {
+      "code" : "memSize",
+      "value" : "32"
+    }, {
+      "code" : "ioGbSec",
+      "value" : ""
+    }, {
+      "code" : "diskType",
+      "value" : "SSD"
+    }, {
+      "code" : "localDisk",
+      "value" : "N"
+    } ],
+    "duplicate" : 2,
+    "default_node" : 3,
+    "min_node" : 3,
+    "max_node" : 32,
+    "default_capacity" : "200",
+    "product_version_list" : [ {
+      "min_cn" : 2,
+      "max_cn" : 20,
+      "version_type" : "1",
+      "datastore_version" : "9.1.0.215"
+    } ],
+    "flavor_id" : "e7fe0f10-5ec7-45f5-8558-c8b50ad88b34",
+    "flavor_code" : "rc6.xlarge.4",
+    "volume_num" : 2,
+    "volume_used" : {
+      "volume_type" : "SATA",
+      "volume_num" : 2,
+      "capacity" : 200,
+      "volume_size" : 200
+    }
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ListSnapshotPolicy.html b/docs/dws/api-ref/ListSnapshotPolicy.html new file mode 100644 index 000000000..302c7a0ae --- /dev/null +++ b/docs/dws/api-ref/ListSnapshotPolicy.html @@ -0,0 +1,341 @@ + + +

Querying a Snapshot Policy

+

Function

This API is used to query a snapshot policy.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/snapshot-policies

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

keep_day

+

Integer

+

Definition

+

Retention days.

+

Range

+

Greater than or equal to 0

+

backup_strategies

+

Array of BackupStrategyDetail objects

+

Definition

+

Backup policy list.

+

Range

+

N/A

+

device_name

+

String

+

Definition

+

Backup device, which is OBS in most cases.

+

Range

+

N/A

+

server_ips

+

Array of strings

+

Definition

+

Service IP address.

+

Range

+

N/A

+

server_port

+

String

+

Definition

+

Server port.

+

Range

+

N/A

+

backup_param

+

String

+

Definition

+

Backup parameters.

+

Range

+

N/A

+

auto_backup

+

Boolean

+

Definition

+

Whether automated backup is enabled.

+

Range

+

true: Automated backup is enabled.

+

false: Automated backup is disabled.

+

backup_strategy_cluster_type_limit_num

+

Integer

+

Definition

+

Maximum number of cluster-level snapshots in this policy.

+

Range

+

Greater than or equal to 0

+

backup_strategy_schema_type_limit_num

+

Integer

+

Definition

+

Maximum number of schema-level snapshots in this policy.

+

Range

+

Greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BackupStrategyDetail

Parameter

+

Type

+

Description

+

policy_id

+

String

+

Definition

+

Policy ID.

+

Range

+

N/A

+

policy_name

+

String

+

Definition

+

Policy name.

+

Range

+

N/A

+

backup_strategy

+

String

+

Definition

+

Execution policy. Generally, the value is a crontab expression.

+

Range

+

N/A

+

backup_type

+

String

+

Definition

+

Backup type.

+

Range

+

N/A

+

backup_level

+

String

+

Definition

+

Backup level.

+

Range

+

N/A

+

next_fire_time

+

String

+

Definition

+

Estimated time for the next trigger of the task (it will not execute if the task conflicts with other tasks).

+

Range

+

N/A

+

update_time

+

String

+

Definition

+

Update time.

+

Range

+

N/A

+

time_zone_offset

+

Integer

+

Definition

+

Time zone offset (compared with UTC time).

+

Range

+

0 to 23

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshot-policies
+
+

Example Responses

Status code: 200

+

Snapshot policy queried.

+
{
+  "keep_day" : 3,
+  "backup_strategies" : [ {
+    "policy_id" : "3b5464ad-74a5-42cc-9667-76122839109a",
+    "policy_name" : "apie-default-full-strategy",
+    "backup_strategy" : "0 0 2 ? * 1",
+    "backup_type" : "full",
+    "backup_level" : "cluster",
+    "next_fire_time" : "1747533600000",
+    "update_time" : "2025-05-11T10:06:16",
+    "time_zone_offset" : 0
+  }, {
+    "policy_id" : "ceaeaf07-d600-494c-86d7-caa0fbf0858a",
+    "policy_name" : "apie-default-increment-strategy",
+    "backup_strategy" : "0 7 2/8 ? * 2,3,4,5,6,7",
+    "backup_type" : "increment",
+    "backup_level" : "cluster",
+    "next_fire_time" : "1747015620000",
+    "update_time" : "2025-05-11T10:06:16",
+    "time_zone_offset" : 0
+  } ],
+  "device_name" : "OBS",
+  "server_ips" : null,
+  "server_port" : null,
+  "backup_param" : null,
+  "auto_backup" : true,
+  "backup_strategy_cluster_type_limit_num" : 10,
+  "backup_strategy_schema_type_limit_num" : 50
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Snapshot policy queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ListSnapshotStatistics.html b/docs/dws/api-ref/ListSnapshotStatistics.html new file mode 100644 index 000000000..4426178f6 --- /dev/null +++ b/docs/dws/api-ref/ListSnapshotStatistics.html @@ -0,0 +1,198 @@ + + +

Querying Snapshot Statistics

+

Function

This API is used to query snapshot statistics.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots/statistics

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

statistics

+

Array of SnapshotsStatistic objects

+

Definition

+

Snapshot statistics.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 3 SnapshotsStatistic

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Resource statistics name.

+

Range

+

storage.free: free capacity

+

storage.paid: paid capacity

+

storage.used: used capacity

+

value

+

Number

+

Definition

+

Resource statistics value.

+

Range

+

N/A

+

unit

+

String

+

Definition

+

Resource statistics unit.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/snapshots/statistics
+
+

Example Responses

Status code: 200

+

Snapshot statistics queried.

+
{
+  "statistics" : [ {
+    "name" : "storage.free",
+    "value" : 300.0,
+    "unit" : "GB"
+  }, {
+    "name" : "storage.paid",
+    "value" : 0,
+    "unit" : "GB"
+  }, {
+    "name" : "storage.used",
+    "value" : 128.5,
+    "unit" : "GB"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Snapshot statistics queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ListSnapshots.html b/docs/dws/api-ref/ListSnapshots.html new file mode 100644 index 000000000..a5234ced2 --- /dev/null +++ b/docs/dws/api-ref/ListSnapshots.html @@ -0,0 +1,262 @@ + + +

Querying the Snapshot List

+

Function

This API is used to query the snapshot list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/snapshots

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

snapshots

+

Array of Snapshots objects

+

Definition

+

List of snapshot objects.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of records in the list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Snapshots

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Snapshot ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Snapshot name.

+

Range

+

N/A

+

description

+

String

+

Definition

+

Snapshot description.

+

Range

+

N/A

+

started

+

String

+

Definition

+

Snapshot creation time. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.

+

Range

+

N/A

+

finished

+

String

+

Definition

+

Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ.

+

Range

+

N/A

+

size

+

Double

+

Definition

+

Snapshot size, in GB.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Snapshot status.

+

Range

+

  • CREATING

    +

  • AVAILABLE

    +

  • UNAVAILABLE

    +
+

type

+

String

+

Definition

+

Snapshot type.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

ID of the cluster for which the snapshot is created.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
+
+

Example Responses

Status code: 200

+

Snapshot list queried.

+
{
+  "snapshots" : [ {
+    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
+    "name" : "snapshot-1",
+    "description" : "",
+    "started" : "2016-08-23T03:59:23Z",
+    "finished" : "2016-08-23T04:01:40Z",
+    "size" : 500,
+    "status" : "AVAILABLE",
+    "type" : "MANUAL",
+    "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
+  }, {
+    "id" : "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
+    "name" : "snapshot-2",
+    "description" : "",
+    "started" : "2016-08-23T18:20:00Z",
+    "finished" : "2016-08-23T18:22:12Z",
+    "size" : 500,
+    "status" : "AVAILABLE",
+    "type" : "MANUAL",
+    "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
+  } ],
+  "count" : 2
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Snapshot list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/ListTags.html b/docs/dws/api-ref/ListTags.html new file mode 100644 index 000000000..37722a089 --- /dev/null +++ b/docs/dws/api-ref/ListTags.html @@ -0,0 +1,161 @@ + + +

Querying Project Tags

+

Function

This API is used to query project tag list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/tags

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of ProjectTag objects

+

Definition

+

Tag list objects.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 ProjectTag

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Key.

+

Range

+

N/A

+

values

+

Array of strings

+

Definition

+

Value.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/tags
+
+

Example Responses

Status code: 200

+

Project tags queried.

+
{
+  "tags" : [ {
+    "key" : "key",
+    "values" : [ "value-1", "value-2" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Project tags queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dws/api-ref/ListTagsForResource.html b/docs/dws/api-ref/ListTagsForResource.html new file mode 100644 index 000000000..5e56e369b --- /dev/null +++ b/docs/dws/api-ref/ListTagsForResource.html @@ -0,0 +1,249 @@ + + +

Querying the Enterprise Project Information of a Cluster

+

Function

This API is used to query the enterprise project information of a specified cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/enterprise-projects

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Page size. The default value is 10.

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 1

+

Default Value

+

10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

sys_tags

+

Array of Tag objects

+

Definition

+

Tag list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Number of tags.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Tag

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+
+

Example Requests

Query the enterprise project information of a specified cluster.

+
GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/enterprise-projects
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "sys_tags" : [ {
+    "key" : "key",
+    "value" : "value"
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListTargetFlavors.html b/docs/dws/api-ref/ListTargetFlavors.html new file mode 100644 index 000000000..3ea88464d --- /dev/null +++ b/docs/dws/api-ref/ListTargetFlavors.html @@ -0,0 +1,256 @@ + + +

Querying the List of Target Flavors That a Cluster Can Be Changed To

+

Function

This API is used to query the list of flavors that a cluster can be changed to. A maximum of 20 flavors can be returned.

+

Constraints

+

If cluster_id is not specified, all flavors that a cluster can be changed to are returned. However, some flavors may be sold out and cannot be used due to quota reasons.

+

If cluster_id is specified, the flavors with sufficient quotas in the AZ where the cluster is located are automatically returned.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/flavors/{flavor_id}/target-flavors

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

flavor_id

+

Yes

+

String

+

Definition

+

Current flavor ID of the cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

No

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

If this parameter is not specified, all flavors that a cluster can be changed to are returned. However, some flavors may be sold out and cannot be used due to quota reasons.

+

If cluster_id is specified, the flavors with sufficient quotas in the AZ where the cluster is located are automatically returned.

+

Range

+

N/A

+

Default Value

+

null

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Definition

+

Number of flavors.

+

Range

+

N/A

+

flavors

+

Array of FlavorInfoResponse objects

+

Definition

+

List of flavor details. A maximum of 20 flavors can be returned.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 FlavorInfoResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Flavor ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Flavor code.

+

Range

+

N/A

+

vcpus

+

String

+

Definition

+

CPUs.

+

Range

+

N/A

+

ram

+

String

+

Definition

+

Memory size.

+

Range

+

N/A

+

is_current_flavor

+

Boolean

+

Definition

+

Current flavor.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the list of flavors whose ID is b5c45780-1006-49e3-b2d5-b3229975bbc7.

+
get https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/flavors/b5c45780-1006-49e3-b2d5-b3229975bbc7/target-flavors
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "flavors" : [ {
+    "id" : "4e26f8d5-d64f-458e-80e7-26680b46cd58",
+    "name" : "dwsx2.xlarge",
+    "vcpus" : "4",
+    "ram" : "32",
+    "is_current_flavor" : false
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ListTopoRings.html b/docs/dws/api-ref/ListTopoRings.html new file mode 100644 index 000000000..5d766f463 --- /dev/null +++ b/docs/dws/api-ref/ListTopoRings.html @@ -0,0 +1,369 @@ + + +

Querying Ring Node Information in the Cluster Topology

+

Function

This API is used to query ring node information in the cluster topology.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/topo/rings

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

cluster_rings

+

Array of TopoRingInfo objects

+

Definition

+

Cluster topology ring list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Number of cluster rings.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 4 TopoRingInfo

Parameter

+

Type

+

Description

+

instance_info_lists

+

Array of TopoInstanceInfo objects

+

Definition

+

Cluster instance list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 TopoInstanceInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Instance ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Instance name.

+

Range

+

N/A

+

manage_ip

+

String

+

Definition

+

Instance management IP address.

+

Range

+

N/A

+

traffic_ip

+

String

+

Definition

+

Service IP address.

+

Range

+

N/A

+

internal_ip

+

String

+

Definition

+

Internal communication IP address.

+

Range

+

N/A

+

internal_mgnt_ip

+

String

+

Definition

+

Internal management IP address.

+

Range

+

N/A

+

eip

+

String

+

Definition

+

Public IP address information.

+

Range

+

N/A

+

elb

+

String

+

Definition

+

ELB address.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Instance status.

+

Range

+

N/A

+

az_code

+

String

+

Definition

+

AZ code.

+

Range

+

N/A

+
+
+
+

Example Requests

Query ring node information in the cluster topology.

+
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/rings
+
+

Example Responses

Status code: 200

+

Ring node information of the cluster topology queried.

+
{
+  "cluster_rings" : [ {
+    "instance_info_lists" : [ {
+      "id" : "a57e49db-c04b-45c7-9863-f7b6f3eed1b8",
+      "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-1-1",
+      "manage_ip" : "172.16.26.233",
+      "traffic_ip" : "192.168.0.217",
+      "internal_ip" : "172.16.66.153",
+      "internal_mgnt_ip" : null,
+      "eip" : null,
+      "elb" : null,
+      "status" : 200,
+      "az_code" : "eu-de-01c"
+    }, {
+      "id" : "3a37f794-be37-42d1-a299-a3eb94888ccb",
+      "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-2-1",
+      "manage_ip" : "172.16.34.21",
+      "traffic_ip" : "192.168.0.80",
+      "internal_ip" : "172.16.65.89",
+      "internal_mgnt_ip" : null,
+      "eip" : null,
+      "elb" : null,
+      "status" : 200,
+      "az_code" : "eu-de-01c"
+    }, {
+      "id" : "8763cbf1-5851-44a5-9e71-cbae35201f27",
+      "name" : "ty-default--BGy6PUIN-K-dws-dn-1-1",
+      "manage_ip" : "172.16.9.16",
+      "traffic_ip" : "192.168.0.88",
+      "internal_ip" : "172.16.67.64",
+      "internal_mgnt_ip" : null,
+      "eip" : null,
+      "elb" : null,
+      "status" : 200,
+      "az_code" : "eu-de-01c"
+    } ]
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Ring node information of the cluster topology queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ListWorkloadPlans.html b/docs/dws/api-ref/ListWorkloadPlans.html new file mode 100644 index 000000000..98ca505ab --- /dev/null +++ b/docs/dws/api-ref/ListWorkloadPlans.html @@ -0,0 +1,550 @@ + + +

Querying the Resource Management Plan List

+

Function

This API is used to query all resource management plans in a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

plan_list

+

Array of WorkloadPlanInfo objects

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 WorkloadPlanInfo

Parameter

+

Type

+

Description

+

status

+

Integer

+

Definition

+

Plan status

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

It is a 36-digit UUID.

+

plan_id

+

String

+

Definition

+

Plan ID.

+

Range

+

N/A

+

plan_name

+

String

+

Definition

+

Plan name

+

Range

+

N/A

+

current_stage

+

String

+

Definition

+

Current plan stage.

+

Range

+

N/A

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

stage_list

+

Array of PlanStage objects

+

Definition

+

List of plan stages

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PlanStage

Parameter

+

Type

+

Description

+

month

+

String

+

Definition

+

Month.

+

Range

+

N/A

+

day

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

plan_id

+

String

+

Definition

+

Plan ID.

+

Range

+

N/A

+

stage_id

+

String

+

Definition

+

Plan stage ID.

+

Range

+

N/A

+

stage_name

+

String

+

Definition

+

Plan stage name.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Start time of the plan.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

next_valid_time

+

String

+

Definition

+

Next validation time.

+

Range

+

N/A

+

queue_list

+

Array of QueueResourceItem objects

+

Definition

+

Resource queue list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 QueueResourceItem

Parameter

+

Type

+

Description

+

queue_name

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

queue_resources

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 WorkloadResourceItem

Parameter

+

Type

+

Description

+

resource_name

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Query all resource management plans in a cluster.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "plan_list" : [ {
+    "status" : 0,
+    "cluster_id" : "862201cd-f822-4dbc-ae3b-c7b9d080eea6",
+    "project_id" : "0536cdee2200d5912f7cc00b877980f1",
+    "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
+    "plan_name" : "plan1",
+    "current_stage" : null,
+    "logical_cluster_name" : null,
+    "stage_list" : null
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ListWorkloadQueue.html b/docs/dws/api-ref/ListWorkloadQueue.html new file mode 100644 index 000000000..b88cfbf57 --- /dev/null +++ b/docs/dws/api-ref/ListWorkloadQueue.html @@ -0,0 +1,193 @@ + + +

Querying Resource Pools

+

Function

This API is used to query resource pools.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/queues

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name. This field is mandatory in logical cluster mode.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_queue_name_list

+

Array of strings

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+
+
+
+

Example Requests

Query resource pools.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues
+
+

Example Responses

Status code: 200

+

Resource pools queried.

+
{
+  "workload_queue_name_list" : [ "test1" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource pools queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ListWorkloadQueueUsers.html b/docs/dws/api-ref/ListWorkloadQueueUsers.html new file mode 100644 index 000000000..10dc6b337 --- /dev/null +++ b/docs/dws/api-ref/ListWorkloadQueueUsers.html @@ -0,0 +1,358 @@ + + +

Querying the List of Users Bound to a Resource Pool

+

Function

This API is used to query the list of users bound to a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

Greater than 0

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

queue_name

+

String

+

Definition

+

Queue name.

+

Range

+

N/A

+

user_list

+

Array of WorkloadQueueUser objects

+

Definition

+

List of queue users.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 WorkloadQueueUser

Parameter

+

Type

+

Description

+

user_name

+

String

+

Definition

+

Username.

+

Range

+

N/A

+

occupy_resource_list

+

Array of OccupyResource objects

+

Definition

+

Plan execution stage.

+

Range

+

N/A

+

exec_result

+

Integer

+

Definition

+

Execution result.

+

Range

+

N/A

+

exec_log

+

String

+

Definition

+

Execution log.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 OccupyResource

Parameter

+

Type

+

Description

+

resource_name

+

String

+

Definition

+

Resource item name.

+

Range

+

N/A

+

resource_value

+

Integer

+

Definition

+

Resource attribute value.

+

Range

+

N/A

+

value_unit

+

String

+

Definition

+

Resource attribute unit.

+

Range

+

N/A

+

resource_description

+

String

+

Definition

+

Additional resource description.

+

Range

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/resource1/users
+
+

Example Responses

Status code: 200

+

List of users bound to the resource pool queried.

+
{
+  "queue_name" : "rs1",
+  "user_list" : [ {
+    "user_name" : "user_batch",
+    "occupy_resource_list" : [ {
+      "resource_name" : "memory_used",
+      "resource_value" : 0,
+      "value_unit" : "M",
+      "resource_description" : ""
+    } ]
+  } ],
+  "count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

List of users bound to the resource pool queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ListWorkloadRules.html b/docs/dws/api-ref/ListWorkloadRules.html new file mode 100644 index 000000000..ed8875854 --- /dev/null +++ b/docs/dws/api-ref/ListWorkloadRules.html @@ -0,0 +1,315 @@ + + +

Querying the Exception Rule List of a Cluster

+

Function

This API is used to query the exception rule list of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/workload/rules

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

limit

+

No

+

Integer

+

Definition

+

Size of a single page.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

10

+

rule_name

+

No

+

String

+

Definition

+

Size of a single page.

+

Constraints

+

Exception rule name.

+

Range

+

N/A

+

Default Value

+

N/A

+

queue_name

+

No

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Error code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Error details.

+

Range

+

N/A

+

items

+

Array of ExceptRuleBo objects

+

Definition

+

Exception rule list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of exception rules.

+

Range

+

Greater than or equal to 0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 ExceptRuleBo

Parameter

+

Type

+

Description

+

name

+

String

+

Definition

+

Rule name.

+

Range

+

N/A

+

action

+

String

+

Definition

+

Action that triggers an exception rule.

+

Range

+

N/A

+

queues

+

Array of strings

+

Definition

+

Names of resource pools bound to an exception rule.

+

Range

+

N/A

+

except_rules

+

Map<String,String>

+

Definition

+

Exception rule configuration items.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the exception rule list.

+
GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload/rules
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : null,
+  "items" : [ {
+    "name" : "default_cpu_percent",
+    "action" : "abort",
+    "queues" : [ ],
+    "except_rules" : {
+      "action" : "abort",
+      "cpuavgpercent" : "50",
+      "elapsedtime" : "900"
+    }
+  } ],
+  "count" : 3
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ModifyClusterName.html b/docs/dws/api-ref/ModifyClusterName.html new file mode 100644 index 000000000..1b9b86bff --- /dev/null +++ b/docs/dws/api-ref/ModifyClusterName.html @@ -0,0 +1,193 @@ + + +

Changing a Cluster Name

+

Function

This API is used to change a cluster name.

+

Constraints

+

This parameter is available only for GuestAgent 8.3.1 or later.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/{project_id}/clusters/{cluster_id}/cluster-name

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_name

+

No

+

String

+

Definition

+

Request for changing a cluster name.

+

Constraints

+

This parameter is available only for GuestAgent 8.3.1 or later.

+

Range

+

The value must start with a letter and contain 3 to 64 characters.

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+

job_id

+

String

+

Definition

+

Task ID, which can be used to query the task progress.

+

Range

+

N/A

+
+
+
+

Example Requests

Change the cluster name to dws_cluster.

+
put https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/9f76c502-fc9c-4a52-8656-65d0da6e3d57/cluster-name
+
+{
+  "cluster_name" : "dws_cluster"
+}
+
+

Example Responses

Status code: 200

+

Request submitted.

+
{
+  "job_id" : "g6aa82ba1fc9748389b613e8da13e2fe9"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ModifyClusterTimezone.html b/docs/dws/api-ref/ModifyClusterTimezone.html new file mode 100644 index 000000000..1fee12863 --- /dev/null +++ b/docs/dws/api-ref/ModifyClusterTimezone.html @@ -0,0 +1,199 @@ + + +

Changing Cluster Time Zone

+

Function

This API is used to change the time zone of a cluster. This operation will change the time zone of the OS as well as the database.

+

Constraints

+

To change the time zone of a cluster, you need to ensure that the guestAgent plug-in installed in the cluster is 8.3.0.202 or later.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/timezone

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_timezone

+

No

+

String

+

Definition

+

Time zone. Example value: UTC.

+

Constraints

+

N/A

+

Range ^(Etc/GMT+11|US/Hawaii|Etc/GMT+9|US/Alaska|US/Pacific|Etc/GMT+8|Canada/Mountain|US/Arizona|Canada/Saskatchewan|Etc/GMT+6|US/Central|EST|America/Bogota|Etc/GMT+5|Canada/Atlantic|America/Cuiaba|America/Buenos_Aires|Etc/GMT+3|Canada/Newfoundland|America/Santiago|Etc/GMT+2|Atlantic/Cape_Verde|Europe/London|Africa/Monrovia|UTC|Europe/Belgrade|CET|MET|Europe/Amsterdam|EET|Europe/Athens|Asia/Amman|Asia/Beirut|Europe/Minsk|Africa/Nairobi|Europe/Moscow|Etc/GMT-4|Asia/Tbilisi|Asia/Kabul|Etc/GMT-5|Asia/Calcutta|Etc/GMT-6|Etc/GMT-7|PRC|Asia/Shanghai|Etc/GMT-8|Australia/Perth|Asia/Seoul|Asia/Tokyo|Australia/Darwin|Australia/Adelaide|Australia/Sydney|Australia/Brisbane|Etc/GMT-11|Pacific/Auckland|Etc/GMT-12)$

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+

job_id

+

String

+

Definition

+

Task ID, which can be used to query the task progress.

+

Range

+

N/A

+
+
+
+

Example Requests

Change the time zone of a cluster to UTC.

+
POST https://{endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/97cbaab3-939e-4dbc-9187-0fe240f2b9fd/timezone
+
+{
+  "cluster_timezone" : "UTC"
+}
+
+

Example Responses

Status code: 200

+

Request submitted.

+
{
+  "error_code" : null,
+  "error_msg" : null,
+  "job_id" : "2c9080d08cc99d28018ccd139e942498"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ResetPassword.html b/docs/dws/api-ref/ResetPassword.html new file mode 100644 index 000000000..f69418a1e --- /dev/null +++ b/docs/dws/api-ref/ResetPassword.html @@ -0,0 +1,165 @@ + + +

Resetting a Password

+

Function

This API is used to reset the administrator password of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

new_password

+

Yes

+

String

+

Definition

+

New password of the cluster administrator.

+

Constraints

+

The new password must:

+

  • Contain 12 to 32 characters.

    +

  • Cannot be the username or the username backwards.

    +

  • Contain at least three of the following four types:

    +

    • Lowercase letters

      +

    • Uppercase letters

      +

    • Number

      +

    • Special characters (~!?,.:;-_'"(){}[]/<>@#%^&*+|=)

      +
    +

  • Cannot be the same as previous passwords.

    +

  • Cannot be a weak password.

    +
+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

The password is reset.

+

None

+
+

Example Requests

Reset the password of the cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 to NewPassw0rd!.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/reset-password
+
+{
+  "new_password" : "NewPassw0rd!"
+}
+
+

Example Responses

Status code: 200

+

The password is reset.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The password is reset.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ResizeCluster.html b/docs/dws/api-ref/ResizeCluster.html new file mode 100644 index 000000000..9f2ba4cfb --- /dev/null +++ b/docs/dws/api-ref/ResizeCluster.html @@ -0,0 +1,258 @@ + + +

Scaling Out a Cluster

+

Function

This API is used to scale out a cluster or add idle nodes. By default, scale-out is performed.

+

You can configure create_node_only to determine whether the current operation is to scale out a cluster or add idle nodes.

+

  • true: Add idle nodes.

    +

  • false: Scale out a cluster.

    +
+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/resize

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

scale_out

+

Yes

+

ScaleOut object

+

Definition

+

Request body for adding an idle node or scaling out a cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

create_node_only

+

No

+

Boolean

+

Definition

+

Whether only idle nodes are added.

+

Constraints

+

N/A

+

Range

+

true: Only nodes are added. If scale-out is required, perform it separately.

+

false: Nodes are added and the cluster is scaled out.

+

Default Value

+

false

+

waiting_for_killing

+

No

+

Integer

+

Definition

+

Time before blocked job termination.

+

Constraints

+

This parameter is available only for GuestAgent 8.2.1 or later.

+

Range

+

30 to 1200

+

Default Value

+

0 (not limited)

+

auto_redistribute

+

No

+

Boolean

+

Definition

+

Whether to automatically start redistribution after scale-out. The default value is true. If this parameter is set to false, redistribution is not performed after scale-out. In this case, the cluster task information displays To be redistributed and other operations cannot be performed.

+

Constraints

+

N/A

+

Range

+

true: Redistribution is performed immediately after scale-out.

+

false: Redistribution is not performed after scale-out. In this case, the cluster task information displays To be redistributed.

+

Default Value

+

true

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ScaleOut

Parameter

+

Mandatory

+

Type

+

Description

+

count

+

Yes

+

Integer

+

Definition

+

Number of nodes to be added.

+

Range

+

Greater than or equal to 3

+

subnet_id

+

No

+

String

+

Definition

+

Subnet ID.

+

Range

+

The value is a valid subnet ID in the same VPC.

+
+
+
+

Response Parameters

Status code: 200

+

Request for scaling out a cluster is submitted.

+

None

+
+

Example Requests

  • Add three nodes to a cluster.

    +
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize
+
+{
+  "scale_out" : {
+    "count" : 3
+  }
+}
    +

  • Add three idle nodes to a cluster for the scale-out operation in example 3.

    +
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize
+
+{
+  "scale_out" : {
+    "count" : 3
+  },
+  "create_node_only" : true
+}
    +
+
+

Example Responses

Status code: 200

+

Request for scaling out a cluster is submitted.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for scaling out a cluster is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ResizeClusterWithExistedNodes.html b/docs/dws/api-ref/ResizeClusterWithExistedNodes.html new file mode 100644 index 000000000..3381a98f8 --- /dev/null +++ b/docs/dws/api-ref/ResizeClusterWithExistedNodes.html @@ -0,0 +1,343 @@ + + +

Scaling Out a Cluster with Idle Nodes

+

Function

This API is used to scale out a cluster with idle nodes.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/resize-with-existed-nodes

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

scale_out

+

Yes

+

ScaleOut object

+

Definition

+

Scale-out objects

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

force_backup

+

No

+

Boolean

+

Definition

+

Whether to forcibly back up data.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

mode

+

No

+

String

+

Definition

+

Scale-out mode. If this parameter is not specified, the offline read-only mode is used by default.

+

Constraints

+

The online mode is not supported by most clusters of earlier versions. To use the mode, contact O&M personnel.

+

Range

+

read-only: offline mode

+

insert: online mode

+

Default Value

+

N/A

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

In non-logical cluster mode, this parameter is left blank. In logical cluster mode, the default value is elastic_group.

+

Default Value

+

elastic_group

+

expand_with_existed_node

+

Yes

+

Boolean

+

Definition

+

Whether to use added idle nodes for scale-out.

+

Constraints

+

N/A

+

Range

+

true: Idle nodes are used for scale-out.

+

false: Idle nodes are not used for scale-out.

+

Default Value

+

false

+

auto_redistribute

+

No

+

Boolean

+

Definition

+

Whether to automatically start redistribution after scale-out. The default value is true.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

true

+

redis_conf

+

No

+

RedisConfReq object

+

Definition

+

Redistribution configuration information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ScaleOut

Parameter

+

Mandatory

+

Type

+

Description

+

count

+

Yes

+

Integer

+

Definition

+

Number of nodes to be added.

+

Range

+

Greater than or equal to 3

+

subnet_id

+

No

+

String

+

Definition

+

Subnet ID.

+

Range

+

The value is a valid subnet ID in the same VPC.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 RedisConfReq

Parameter

+

Mandatory

+

Type

+

Description

+

redis_mode

+

Yes

+

String

+

Definition

+

Redistribution mode. The impact on services varies depending on the mode. You are advised to contact O&M personnel for evaluation before changing the mode.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

offline

+

online

+

Default Value

+

offline

+

parallel_jobs

+

Yes

+

Integer

+

Definition

+

Number of concurrent jobs. The default value is 4.

+

Constraints

+

N/A

+

Range

+

1 to 200

+

Default Value

+

4

+
+
+
+

Response Parameters

Status code: 200

+

Request for adding an idle node submitted.

+

None

+
+

Example Requests

Scale out a cluster with idle nodes.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize-with-existed-nodes
+
+{
+  "scale_out" : {
+    "count" : 3
+  },
+  "expand_with_existed_node" : true,
+  "auto_redistribute" : true,
+  "redis_conf" : {
+    "redis_mode" : "offLine",
+    "parallel_jobs" : 4
+  }
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for adding an idle node submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/RestartCluster.html b/docs/dws/api-ref/RestartCluster.html new file mode 100644 index 000000000..c0facc0a2 --- /dev/null +++ b/docs/dws/api-ref/RestartCluster.html @@ -0,0 +1,154 @@ + + +

Restarting a Cluster

+

Function

This API is used to restart a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/restart

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

restart

+

Yes

+

Object

+

Definition

+

Restart flag.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

The request for restarting the cluster is submitted.

+

None

+
+

Example Requests

Restart the cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/restart
+
+{
+  "restart" : { }
+}
+
+

Example Responses

Status code: 200

+

The request for restarting the cluster is submitted.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The request for restarting the cluster is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/RestartLogicalCluster.html b/docs/dws/api-ref/RestartLogicalCluster.html new file mode 100644 index 000000000..fe9b4fe80 --- /dev/null +++ b/docs/dws/api-ref/RestartLogicalCluster.html @@ -0,0 +1,170 @@ + + +

Restarting a Logical Cluster

+

Function

This API is used to restart a logical cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/restart

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

logical_cluster_id

+

Yes

+

String

+

Definition

+

ID of the logical cluster to be restarted.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Restart a logical cluster.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/0b494d0d-8431-4c4f-8a06-2cc42d0d0c7d/restart
+
+

Example Responses

Status code: 200

+

Request for restarting a cluster submitted.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for restarting a cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/RestoreCluster.html b/docs/dws/api-ref/RestoreCluster.html new file mode 100644 index 000000000..225759625 --- /dev/null +++ b/docs/dws/api-ref/RestoreCluster.html @@ -0,0 +1,382 @@ + + +

Restoring a Cluster

+

Function

This API is used to restore a cluster using a snapshot.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

ID of the snapshot to be restored.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

restore

+

Yes

+

Restore object

+

Definition

+

Objects of cluster restoration.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Restore

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Cluster name.

+

Range

+

The value must be unique. It must contain 4 to 64 characters and start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.

+

subnet_id

+

No

+

String

+

Definition

+

Subnet ID, which is used for configuring the cluster network.

+

Range

+

The default value is the same as that of the original cluster.

+

security_group_id

+

No

+

String

+

Definition

+

Security group ID, which is used for configuring the cluster network. The default value is the same as that of the original cluster.

+

Range

+

N/A

+

vpc_id

+

No

+

String

+

Definition

+

VPC ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

+

Range

+

N/A

+

availability_zone

+

No

+

String

+

Definition

+

AZ of the cluster. The default value is the same as that of the original cluster.

+

Range

+

N/A

+

port

+

No

+

Integer

+

Definition

+

Cluster service port.

+

Range

+

N/A

+

public_ip

+

No

+

PublicIp object

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

enterprise_project_id

+

No

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

ipv6_enable

+

No

+

Boolean

+

Definition

+

Network protocol type. It indicates whether IPv6 is supported. By default, IPv6 is not used.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 PublicIp

Parameter

+

Mandatory

+

Type

+

Description

+

public_bind_type

+

No

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

auto_assign

+

not_use

+

bind_existing

+

Default Value

+

null

+

eip_id

+

No

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

Cluster object

+

Definition

+

Cluster object.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + +
Table 6 Cluster

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+
+
+
+

Example Requests

Restore the snapshot to the new cluster dws-1. (AZ: az1.dc1. Database port: 8000. The subnet ID, security group ID, VPC ID, public IP address, and enterprise ID are specified)

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions
+
+{
+  "restore" : {
+    "name" : "dws-1",
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "availability_zone" : "az1.dc1",
+    "port" : 8000,
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : ""
+    },
+    "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada"
+  }
+}
+
+

Example Responses

Status code: 200

+

The request for restoring a cluster is submitted.

+
{
+  "cluster" : {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The request for restoring a cluster is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/RestoreRedistribution.html b/docs/dws/api-ref/RestoreRedistribution.html new file mode 100644 index 000000000..b200d2074 --- /dev/null +++ b/docs/dws/api-ref/RestoreRedistribution.html @@ -0,0 +1,121 @@ + + +

Resuming Redistribution

+

Function

This API is used to resume redistribution in the suspended state. It is available only for DWS 2.0.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/redistribution/recovery

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

Redistribution resumed.

+

None

+
+

Example Requests

Resume redistribution.

+
POST https://{Endpoint}/v2.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/redistribution/recovery
+
+

Example Responses

Status code: 200

+

Redistribution resumed.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Redistribution resumed.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/RestoreTable.html b/docs/dws/api-ref/RestoreTable.html new file mode 100644 index 000000000..d41447772 --- /dev/null +++ b/docs/dws/api-ref/RestoreTable.html @@ -0,0 +1,249 @@ + + +

Restoring a Table

+

Function

This API is used to restore tables.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/snapshots/{snapshot_id}/table-restore

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

snapshot_id

+

Yes

+

String

+

Definition

+

Snapshot ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

case_sensitive

+

Yes

+

Boolean

+

Definition

+

Whether the name is case sensitive.

+

Range

+

N/A

+

database

+

Yes

+

String

+

Definition

+

Database name.

+

Range

+

N/A

+

restore_table_list

+

Yes

+

Array of TableDetail objects

+

Definition

+

Source table information.

+

Range

+

N/A

+

target_table_list

+

Yes

+

Array of TableDetail objects

+

Definition

+

Destination table information.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 TableDetail

Parameter

+

Mandatory

+

Type

+

Description

+

schema_name

+

Yes

+

String

+

Definition

+

Schema name.

+

Range

+

N/A

+

table_name

+

Yes

+

String

+

Definition

+

Table name.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

Task ID.

+

Range

+

N/A

+
+
+
+

Example Requests

POST https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/snapshots/c719b1a7-c85c-4cb5-a721-7694908c2c11/table-restore
+
+{
+  "case_sensitive" : true,
+  "database" : "postgres",
+  "restore_table_list" : [ {
+    "schema_name" : "postgres",
+    "table_name" : "public"
+  } ],
+  "target_table_list" : [ {
+    "schema_name" : "postgres",
+    "table_name" : "public"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

The table is successfully restored.

+
{
+  "job_id" : "2c9081c0894918c301894e503ef21b68"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The table is successfully restored.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Snapshot Management
+
+
+ diff --git a/docs/dws/api-ref/SaveClusterDescriptionInfo.html b/docs/dws/api-ref/SaveClusterDescriptionInfo.html new file mode 100644 index 000000000..fb5bd8382 --- /dev/null +++ b/docs/dws/api-ref/SaveClusterDescriptionInfo.html @@ -0,0 +1,213 @@ + + +

Modifying Cluster Description

+

Function

This API is used to modify the cluster description.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/description

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

No

+

String

+

Definition

+

Namespace.

+

Constraints

+

The value is fixed at DWS. If this parameter is left blank, the value is DWS.

+

Range

+

DWS

+

Default Value

+

DWS

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

description_info

+

Yes

+

String

+

Definition

+

Cluster description.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Modify the cluster description.

+
POST https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/description
+
+{
+  "description_info" : "desc info"
+}
+
+

Example Responses

Status code: 200

+

Cluster description modified.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster description modified.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/SetRedistributionPriority.html b/docs/dws/api-ref/SetRedistributionPriority.html new file mode 100644 index 000000000..eb6284709 --- /dev/null +++ b/docs/dws/api-ref/SetRedistributionPriority.html @@ -0,0 +1,254 @@ + + +

Changing the Priority of a Redistribution Table

+

Function

This API is used to change the priority of a redistribution table.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/priority

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

db_name

+

No

+

String

+

Definition

+

Database name.

+

Constraints

+

N/A

+

Range

+

1 to 1024

+

Default Value

+

N/A

+

priority

+

No

+

Array of RedisPriorityTable objects

+

Definition

+

Priority of the table to be redistributed.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 RedisPriorityTable

Parameter

+

Mandatory

+

Type

+

Description

+

schema_name

+

No

+

String

+

Definition

+

Schema name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

id

+

No

+

Long

+

Definition

+

Table ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

table_name

+

No

+

String

+

Definition

+

Table name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

redis_order

+

No

+

Integer

+

Definition

+

Priority.

+

Constraints

+

N/A

+

Range

+

1 to 1024

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

Operation succeeded.

+

None

+
+

Example Requests

Set the redistribution priority of the test_1 table in the public schema in the GaussDB database to 55.

+
PUT https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/clusters/496c3032-c08f-4cd1-8c66-9b56a89a274d/redistribution/priority
+
+{
+  "db_name" : "gaussdb",
+  "priority" : [ {
+    "id" : 17449,
+    "schema_name" : "public",
+    "table_name" : "test_1",
+    "redis_order" : 55
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ShowClusterFlavor.html b/docs/dws/api-ref/ShowClusterFlavor.html new file mode 100644 index 000000000..dde8ac5a5 --- /dev/null +++ b/docs/dws/api-ref/ShowClusterFlavor.html @@ -0,0 +1,392 @@ + + +

Querying Flavor Details of a Cluster

+

Function

This API is used to query flavor details of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/flavor

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

No

+

String

+

Definition

+

Namespace. Generally, the value can only be DWS.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

flavor

+

ClusterFlavorDetailInfo object

+

Definition

+

Cluster flavor details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ClusterFlavorDetailInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Flavor ID.

+

Range

+

N/A

+

spec_name

+

String

+

Definition

+

Flavor code.

+

Range

+

N/A

+

current_node

+

Integer

+

Definition

+

Number of existing nodes.

+

Range

+

N/A

+

min_node

+

Integer

+

Definition

+

Minimum number of nodes.

+

Range

+

N/A

+

max_node

+

Integer

+

Definition

+

Maximum number of nodes.

+

Range

+

N/A

+

classify

+

String

+

Definition

+

Flavor type.

+

Range

+

N/A

+

datastore_version

+

String

+

Definition

+

Data warehouse version.

+

Range

+

N/A

+

attribute

+

Array of FlavorAttributeInfo objects

+

Definition

+

Extended information.

+

Range

+

N/A

+

volume_node

+

FlavorVolumeNodeInfo object

+

Definition

+

Flavor used by the cluster.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 FlavorAttributeInfo

Parameter

+

Type

+

Description

+

code

+

String

+

Definition

+

Attribute code.

+

Range

+

N/A

+

value

+

String

+

Definition

+

Attribute value.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 FlavorVolumeNodeInfo

Parameter

+

Type

+

Description

+

volume_type

+

String

+

Definition

+

Storage type used by a node.

+

Range

+

N/A

+

volume_num

+

Integer

+

Definition

+

Number of disks used by a node.

+

Range

+

N/A

+

capacity

+

Integer

+

Definition

+

Available capacity of a node after copies are removed.

+

Range

+

N/A

+

volume_size

+

Integer

+

Definition

+

Capacity of a single disk on a node.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the cluster flavor details.

+
GET https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/clusters/c4b7a057-b121-4a80-9855-8d850108f85f/flavor
+
+

Example Responses

Status code: 200

+

Cluster flavors queried.

+
{
+  "flavor" : {
+    "id" : "d60ef487-7aa8-44b7-969a-d543ddc5b96f",
+    "spec_name" : "dwsk2.xlarge",
+    "current_node" : 3,
+    "min_node" : 3,
+    "max_node" : 256,
+    "classify" : "dws",
+    "attribute" : [ {
+      "code" : "cpuNum",
+      "value" : "4"
+    }, {
+      "code" : "diskType",
+      "value" : "SSD"
+    }, {
+      "code" : "ioGbSec",
+      "value" : ""
+    }, {
+      "code" : "localDisk",
+      "value" : "N"
+    }, {
+      "code" : "maxQueue",
+      "value" : ""
+    }, {
+      "code" : "memSize",
+      "value" : "32"
+    } ],
+    "volume_node" : {
+      "volume_type" : "SATA",
+      "volume_num" : 2,
+      "capacity" : 100,
+      "volume_size" : 100
+    },
+    "datastore_version" : "8.3.0.201"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster flavors queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ShowClusterRedistribution.html b/docs/dws/api-ref/ShowClusterRedistribution.html new file mode 100644 index 000000000..e167e28c6 --- /dev/null +++ b/docs/dws/api-ref/ShowClusterRedistribution.html @@ -0,0 +1,942 @@ + + +

Querying Redistribution Details

+

Function

This API is used to query the monitoring information about a cluster, such as the redistribution mode, redistribution progress, and redistribution details.

+

The redistribution function is available only for DWS 2.0 8.1.1.200 or later. The redistribution progress of data tables is available only for DWS 2.0 8.2.1 or later.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/redistribution

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Definition

+

Size of each page to be queried.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

10

+

offset

+

No

+

Integer

+

Definition

+

Page offset, which starts from 0 (page number minus 1).

+

Constraints

+

N/A

+

Range

+

Greater than or equal to 0

+

Default Value

+

0

+

db_name

+

No

+

String

+

Definition

+

Database name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

table_name

+

No

+

String

+

Definition

+

Table name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+

type

+

No

+

String

+

Definition

+

Type. The value comes from the redistributed column in the public.pgxc_redistb table. Use commas (,) to separate multiple values.

+

Constraints

+

N/A

+

Range

+

i: Redistribution is in progress.

+

y: Redistribution is complete.

+

n: Redistribution is not started.

+

Default Value

+

null: no filtering

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

redis_info

+

RdsRedisInfo object

+

Definition

+

Redistribution information.

+

Range

+

N/A

+

schedule_mode

+

Boolean

+

Definition

+

Scheduling mode.

+

Range

+

false: non-scheduling mode; true: scheduling mode.

+

pause_enable

+

Boolean

+

Definition

+

Whether pause is allowed.

+

Range

+

false: Pause is not allowed. true: Pause is allowed.

+

recover_enable

+

Boolean

+

Definition

+

Whether resumption is allowed.

+

Range

+

false: Resumption is not allowed. true: Resumption is allowed.

+

retry_enable

+

Boolean

+

Definition

+

Whether retry is allowed.

+

Range

+

false: Retry is not allowed. true: Retry is allowed.

+

update_enable

+

Boolean

+

Definition

+

Whether update is allowed.

+

Range

+

false: Update is not allowed. true: Update is allowed. This parameter applies only to the scheduling mode.

+

control_enable

+

Boolean

+

Definition

+

Whether control is allowed.

+

Range

+

false: Control is not allowed. true: Control is allowed. This parameter applies only to the scheduling mode.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RdsRedisInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Redistribution information ID.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Start time.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Status.

+

Range

+

PREPARE, RUNNING, WAITING, PAUSE, PAUSING, SUCCESS, or FAIL.

+

redis_conf

+

RedisConf object

+

Definition

+

Redistribution configuration.

+

Range

+

N/A

+

redis_progress

+

RedisProgress object

+

Definition

+

Redistribution progress.

+

Range

+

N/A

+

redis_table_detail

+

RedisTableDetail object

+

Definition

+

Redistribution table information.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 RedisConf

Parameter

+

Type

+

Description

+

redis_mode

+

String

+

Definition

+

Redistribution mode.

+

Range

+

online or offline.

+

schedule_conf

+

ScheduleConf object

+

Definition

+

Scheduling configuration information.

+

Range

+

N/A

+

parallel_jobs

+

Integer

+

Definition

+

Redistribution concurrency.

+

Range

+

1 to 200

+

parallel_job

+

Integer

+

Definition

+

Number of concurrent redistribution tasks. This parameter has been deprecated.

+

Range

+

1 to 200

+

priority_policy

+

String

+

Definition

+

Priority policy.

+

Range

+

large: Larger tables are redistributed first.

+

small: Small tables are redistributed first.

+

default: Tables are distributed in the default sequence.

+

bucket_split_info

+

BucketSplitInfo object

+

Definition

+

Bucket splitting information, which is returned only when the cluster is scaled out to an existing logical cluster.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 ScheduleConf

Parameter

+

Type

+

Description

+

schedule_start

+

String

+

Definition

+

Scheduling start time.

+

Range

+

N/A

+

schedule_end

+

String

+

Definition

+

Scheduling end time.

+

Range

+

N/A

+

schedule_type

+

String

+

Definition

+

Scheduling type.

+

Range

+

N/A

+

schedule_date

+

Array of integers

+

Definition

+

Scheduling date.

+

Range

+

N/A

+

schedule_time

+

Array of strings

+

Definition

+

Scheduling time list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 BucketSplitInfo

Parameter

+

Type

+

Description

+

current_dn_num

+

Integer

+

Definition

+

Number of current DNs.

+

Range

+

N/A

+

after_scale_out_dn_num

+

Integer

+

Definition

+

Number of DN nodes after scale-out.

+

Range

+

N/A

+

current_bucket_num

+

Integer

+

Definition

+

Number of current buckets.

+

Range

+

N/A

+

after_scale_out_bucket_num

+

Integer

+

Definition

+

Number of buckets after scale-out.

+

Range

+

N/A

+

is_bucket_split

+

Boolean

+

Definition

+

Whether bucket splitting is involved in scale-out.

+

Range

+

N/A

+

bucket_tilt_rate

+

String

+

Definition

+

Bucket tilt rate on DN nodes. It is used to measure the imbalance of buckets on DN nodes.

+

Range

+

N/A

+

after_scale_out_bucket_tilt_rate

+

String

+

Definition

+

Bucket tilt rate on DN nodes after scale-out. It is used to measure the imbalance of buckets on DN nodes after scale-out.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 RedisProgress

Parameter

+

Type

+

Description

+

bytes_done

+

Long

+

Definition

+

Number of completed bytes.

+

Range

+

N/A

+

byte_left

+

Long

+

Definition

+

Number of remaining bytes.

+

Range

+

N/A

+

tables_done

+

Integer

+

Definition

+

Completed tables.

+

Range

+

N/A

+

tables_left

+

Integer

+

Definition

+

Remaining tables.

+

Range

+

N/A

+

table_progress

+

Integer

+

Definition

+

Table redistribution progress.

+

Range

+

1 to 100

+

total_progress

+

Integer

+

Definition

+

Total progress.

+

Range

+

1 to 100

+

redis_rate

+

String

+

Definition

+

Redistribution speed.

+

Range

+

N/A

+

estimated_time

+

String

+

Definition

+

Estimated time.

+

Range

+

N/A

+

completed

+

Boolean

+

Definition

+

Whether the operation is complete.

+

Range

+

N/A

+

initialed

+

Boolean

+

Definition

+

Whether the initialization is complete.

+

Range

+

N/A

+

fail_count

+

Integer

+

Definition

+

Number of failures.

+

Range

+

N/A

+

redistributing

+

Boolean

+

Definition

+

Redistribution result queried by cm_ctl.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Status.

+

Range

+

N/A

+

pause_by_user

+

Boolean

+

Definition

+

Whether the operation is paused by the user.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 RedisTableDetail

Parameter

+

Type

+

Description

+

data

+

Array of RedisTable objects

+

Definition

+

Redistribution data.

+

Range

+

N/A

+

total

+

Integer

+

Definition

+

Number of redistributed tables.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 RedisTable

Parameter

+

Type

+

Description

+

table_name

+

String

+

Definition

+

Table name.

+

Range

+

N/A

+

id

+

Integer

+

Definition

+

Unique ID of the table.

+

Range

+

N/A

+

schema_name

+

String

+

Definition

+

Schema name.

+

Range

+

N/A

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

size

+

Long

+

Definition

+

Table size.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Redistribution type.

+

Range

+

i: Redistribution is in progress.

+

y: Redistribution is complete.

+

n: Redistribution is not started.

+
+
+
+

Example Requests

Query redistribution details.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/redistribution
+
+{
+  "redis_mode" : "online",
+  "parallel_jobs" : 3
+}
+
+

Example Responses

Status code: 200

+

Redistribution details queried.

+
{
+  "error_msg" : null,
+  "redis_info" : {
+    "id" : "1e1006ae-5243-4989-9452-c0217ad08776",
+    "cluster_id" : "37e6956b-17dd-4aef-980d-8ebd9c29f887",
+    "start_time" : "2025-05-15 14:04",
+    "end_time" : "",
+    "status" : "PAUSE",
+    "redis_conf" : {
+      "redis_mode" : "online",
+      "schedule_conf" : null,
+      "parallel_jobs" : 4,
+      "priority_policy" : "default",
+      "bucket_split_info" : {
+        "current_dn_num" : 3,
+        "after_scale_out_dn_num" : 6,
+        "current_bucket_num" : 32,
+        "after_scale_out_bucket_num" : 32,
+        "is_bucket_split" : false,
+        "bucket_tilt_rate" : "9.09%",
+        "after_scale_out_bucket_tilt_rate" : "16.67%"
+      }
+    },
+    "redis_progress" : {
+      "bytes_done" : 7219200,
+      "byte_left" : 0,
+      "tables_done" : 95,
+      "tables_left" : 230,
+      "table_progress" : 29,
+      "total_progress" : 31,
+      "redis_rate" : "21 MB/s",
+      "estimated_time" : "00:12:06",
+      "completed" : false,
+      "initialed" : true,
+      "fail_count" : 0,
+      "redistributing" : true,
+      "status" : "FAIL",
+      "pause_by_user" : false
+    },
+    "redis_table_detail" : {
+      "data" : [ {
+        "table_name" : "test_69",
+        "id" : 2147492808,
+        "schema_name" : "public",
+        "logical_cluster_name" : "v3_logical",
+        "size" : 77815808,
+        "status" : "i"
+      }, {
+        "table_name" : "test_171",
+        "id" : 2147493123,
+        "schema_name" : "public",
+        "logical_cluster_name" : "v3_logical",
+        "size" : 77815808,
+        "status" : "i"
+      }, {
+        "table_name" : "test_236",
+        "id" : 2147493327,
+        "schema_name" : "public",
+        "logical_cluster_name" : "v3_logical",
+        "size" : 77815808,
+        "status" : "i"
+      } ],
+      "total" : 3
+    }
+  },
+  "schedule_mode" : false,
+  "pause_enable" : false,
+  "recover_enable" : true,
+  "retry_enable" : false,
+  "update_enable" : false,
+  "control_enable" : false
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Redistribution details queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ShowClusterStorageExpandRange.html b/docs/dws/api-ref/ShowClusterStorageExpandRange.html new file mode 100644 index 000000000..b339ded9c --- /dev/null +++ b/docs/dws/api-ref/ShowClusterStorageExpandRange.html @@ -0,0 +1,178 @@ + + +

Querying the Disk Capacity Expansion Range

+

Function

This API is used to query capacity range that a disk can be expanded to.

+

Constraints

+

Disk capacity expansion can be performed only for cloud data warehouses using SSD or hybrid data warehouses. Only version 8.1.1.203 and later are supported.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/storage-expand-range

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

min_size

+

Integer

+

Definition

+

Minimum disk capacity of a single node after the expansion, in GB.

+

Range

+

N/A

+

max_size

+

Integer

+

Definition

+

Maximum disk capacity of a single node after the expansion, in GB.

+

Range

+

N/A

+

current_size

+

Integer

+

Definition

+

Current disk capacity, in GB.

+

Range

+

N/A

+

step

+

Integer

+

Definition

+

How much the disk capacity is expanded at a time, in GB. For example, if the disk capacity of a single node is 20 GB and this parameter is set to 20, the disk capacity after the expansion is at least 40 GB.

+

Range

+

Greater than or equal to 10

+
+
+
+

Example Requests

Query the disk capacity expansion range of the current cluster.

+
get https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/storage-expand-range
+
+

Example Responses

Status code: 200

+

The request for expanding the disk capacity is submitted.

+
{
+  "min_size" : 20,
+  "max_size" : 2000,
+  "current_size" : 20,
+  "step" : 10
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The request for expanding the disk capacity is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ShowClusterVolume.html b/docs/dws/api-ref/ShowClusterVolume.html new file mode 100644 index 000000000..a2cdf54be --- /dev/null +++ b/docs/dws/api-ref/ShowClusterVolume.html @@ -0,0 +1,229 @@ + + +

Querying Disk Usage

+

Function

This API is used to query the disk usage of a tenant management node.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/clusters/{cluster_id}/volume

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

duplicate

+

Integer

+

Definition

+

Number of disks on a single node.

+

Range

+

N/A

+

disk_info_list

+

Array of DiskInfoResponse objects

+

Definition

+

Node capacity details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 DiskInfoResponse

Parameter

+

Type

+

Description

+

percentage

+

String

+

Definition

+

Disk usage percentage.

+

Range

+

N/A

+

id

+

String

+

Definition

+

Node ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Node name.

+

Range

+

N/A

+

disk_capacity

+

String

+

Definition

+

Total disk capacity.

+

Range

+

N/A

+

disk_used

+

String

+

Definition

+

Used disk capacity.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the disk usage.

+
GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/2c14ab37-ed8f-48fa-8c23-c9e772c7fd5d/volume
+
+

Example Responses

Status code: 200

+

Disk information queried.

+
{
+  "duplicate" : 2,
+  "disk_info_list" : [ {
+    "percentage" : "2.18",
+    "id" : "7240fb6b-c8d9-43da-9177-1540117989b5",
+    "name" : "dws-cluster-7-dws-cn-cn-3-1",
+    "disk_capacity" : "400",
+    "disk_used" : "8.74"
+  }, {
+    "percentage" : "2.19",
+    "id" : "af4c33f3-27bd-4a07-90a4-5a0ad2f50a13",
+    "name" : "dws-cluster-7-dws-cn-cn-2-1",
+    "disk_capacity" : "400",
+    "disk_used" : "8.78"
+  }, {
+    "percentage" : "2.45",
+    "id" : "d197f4f7-774f-4858-b1e3-ce2319bd59bf",
+    "name" : "dws-cluster-7-dws-cn-cn-1-1",
+    "disk_capacity" : "400",
+    "disk_used" : "9.82"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Disk information queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ShowClusters.html b/docs/dws/api-ref/ShowClusters.html new file mode 100644 index 000000000..f3242c169 --- /dev/null +++ b/docs/dws/api-ref/ShowClusters.html @@ -0,0 +1,778 @@ + + +

Querying the Cluster List (V2)

+

Function

This API is used to query and display the cluster list.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

clusters

+

Array of ClusterInfo objects

+

Definition

+

Cluster object list.

+

Range

+

N/A

+

count

+

Integer

+

Definition

+

Total number of clusters.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 ClusterInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Cluster name.

+

Range

+

The value must be unique under the same account ID.

+

status

+

String

+

Definition

+

Cluster status. The value is an enumerated string.

+

Range

+

  • CREATING: The cluster is being created.

    +

  • ACTIVE: The cluster is available.

    +

  • FAILED: The cluster is unavailable.

    +

  • CREATE_FAILED: The cluster failed to be created.

    +

  • DELETING: The cluster is being deleted.

    +

  • DELETE_FAILED: The cluster failed to be deleted.

    +
+

version

+

String

+

Definition

+

DWS cluster version.

+

Range

+

The value contains three to four characters separated by decimal points, for example, 9.1.0.200. A larger value indicates a later version.

+

updated

+

String

+

Definition

+

Last modification time of a cluster. The format is ISO8601:YYYY-MM-DDThh:mm:ssZ.

+

Range

+

The value must be an ISO8601 time and later than or equal to the cluster creation time.

+

created

+

String

+

Definition

+

Cluster creation time in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

+

Range

+

Time in ISO 8601 format.

+

port

+

Integer

+

Definition

+

Cluster service port. If this parameter is not specified when a cluster is created, the default value 8000 is used.

+

Range

+

8000 to 30000

+

endpoints

+

Array of Endpoints objects

+

Definition

+

Private network connection information about the cluster.

+

Range

+

N/A

+

nodes

+

Array of Nodes objects

+

Definition

+

Cluster nodes.

+

Range

+

The number of rows in the list is the same as the value of the number_of_node field.

+

tags

+

Array of Tags objects

+

Definition

+

Cluster tags.

+

Range

+

The default value is null.

+

user_name

+

String

+

Definition

+

Administrator username.

+

Range

+

The default value is dbadmin.

+

number_of_node

+

Integer

+

Definition

+

Number of nodes. This parameter is specified when a cluster is created.

+

Range

+

N/A

+

recent_event

+

Integer

+

Definition

+

Number of events. Only user operations that affect clusters are recorded. The switch operations of certain buttons are not recorded as cluster events.

+

Range

+

N/A

+

availability_zone

+

String

+

Definition

+

AZ.

+

Range

+

N/A

+

enterprise_project_id

+

String

+

Definition

+

Enterprise project ID for a cluster. If this parameter is not specified, the default value 0 (indicating that the ID of the default enterprise project) is used.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

0

+

node_type

+

String

+

Definition

+

Cluster flavor ID.

+

Range

+

N/A

+

vpc_id

+

String

+

Definition

+

VPC ID.

+

Range

+

N/A

+

subnet_id

+

String

+

Definition

+

Subnet ID.

+

Range

+

N/A

+

public_ip

+

PublicIp object

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

public_endpoints

+

Array of PublicEndpoints objects

+

Definition

+

Public IP address. If the parameter is not specified, public connection is not used by default.

+

Range

+

N/A

+

action_progress

+

Map<String,String>

+

Definition

+

Task information. It consists of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task.

+

Range

+

The key can contain but is not limited to the following values:

+

  • CREATING

    +

  • RESTORING

    +

  • SNAPSHOTTING

    +

  • GROWING

    +

  • REBOOTING

    +

  • SETTING_CONFIGURATION: Security settings are being configured.

    +

  • CONFIGURING_EXT_DATASOURCE: The MRS connection is being configured.

    +

  • ADD_CN_ING: A CN is being added.

    +

  • DEL_CN_ING: A CN is being deleted.

    +

  • REDISTRIBUTING: Redistribution is in progress.

    +

  • ELB_BINDING: An ELB is being bound.

    +

  • ELB_UNBINDING: An ELB is being unbound.

    +

  • ELB_SWITCHING: An ELB is being switched.

    +

  • NETWORK_CONFIGURING: The network is being configured.

    +

  • DISK_EXPANDING: The disk is being expanded.

    +

  • ACTIVE_STANDY_SWITCHOVER: The primary/standby switchover is being performed.

    +

  • FLAVOR_RESIZING: The flavor is being changed.

    +

  • FINE_GRAINED_RESTORING: The fine-grained restoration is in progress.

    +

  • REPAIRING: The cluster is being repaired.

    +
+

sub_status

+

String

+

Definition

+

Sub-status of the available clusters.

+

Range

+

NORMAL

+

  • READONLY

    +

  • REDISTRIBUTING

    +

  • REDISTRIBUTION-FAILURE

    +

  • UNBALANCED

    +

  • UNBALANCED | READONLY

    +

  • DEGRADED

    +

  • DEGRADED | READONLY

    +

  • DEGRADED | UNBALANCED

    +

  • UNBALANCED | REDISTRIBUTING

    +

  • UNBALANCED | REDISTRIBUTION-FAILURE

    +

  • READONLY | REDISTRIBUTION-FAILURE

    +

  • UNBALANCED | READONLY | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE

    +

  • DEGRADED | UNBALANCED | READONLY

    +
+

DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE

+

task_status

+

String

+

Definition

+

Result of an ongoing task or an executed task for cluster management.

+

Range

+

The value can contain but is not limited to the following values:

+

  • UNFREEZING

    +

  • FREEZING

    +

  • RESTORING

    +

  • SNAPSHOTTING

    +

  • GROWING

    +

  • REBOOTING

    +

  • SETTING_CONFIGURATION: Security settings are being configured.

    +

  • CONFIGURING_EXT_DATASOURCE: The MRS connection is being configured.

    +

  • DELETING_EXT_DATASOURCE: The MRS connection is being deleted.

    +

  • REBOOT_FAILURE: The reboot failed.

    +

  • RESIZE_FAILURE: The scale-out failed.

    +

  • ADD_CN_ING: A CN is being added.

    +

  • DEL_CN_ING: A CN is being deleted.

    +

  • CREATING_NODE: A node is being added.

    +

  • CREATE_NODE_FAILED: The node failed to be added.

    +

  • DELETING_NODE: The node is being deleted.

    +

  • DELETE_NODE_FAILED: The node failed to be deleted.

    +

  • REDISTRIBUTING: Redistribution is in progress.

    +

  • REDISTRIBUTE_FAILURE: Redistribution failed.

    +

  • WAITING_REDISTRIBUTION: Redistribution is waiting.

    +

  • REDISTRIBUTION_PAUSED: Redistribution is paused.

    +

  • ELB_BINDING: An ELB is being bound.

    +

  • ELB_BIND_FAILED: An ELB failed to be bound.

    +

  • ELB_UNBINDING: An ELB is being unbound.

    +

  • ELB_UNBIND_FAILED: An ELB failed to be unbound.

    +

  • ELB_SWITCHING: An ELB is being switched.

    +

  • ELB_SWITCHING_FAILED: An ELB failed to be switched.

    +

  • NETWORK_CONFIGURING: The network is being configured.

    +

  • NETWORK_CONFIG_FAILED: Network configuration failed.

    +

  • DISK_EXPAND_FAILED: Disk capacity expansion failed.

    +

  • DISK_EXPANDING: The disk is being expanded.

    +

  • ACTIVE_STANDY_SWITCHOVER: The primary/standby switchover is being performed.

    +

  • ACTIVE_STANDY_SWITCHOVER_FAILURE: The primary/standby switchover failed.

    +

  • FLAVOR_RESIZING_FAILED: The flavor change failed.

    +

  • FLAVOR_RESIZING: The flavor is being changed.

    +

  • FINE_GRAINED_RESTORING: The fine-grained restoration is in progress.

    +
+

security_group_id

+

String

+

Definition

+

Security group ID.

+

Range

+

N/A

+

failed_reasons

+

FailedReason object

+

Definition

+

Failure cause. If the parameter is left blank, the cluster is in the normal state.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Endpoints

Parameter

+

Type

+

Description

+

connect_info

+

String

+

Definition

+

Private network connection information.

+

Range

+

N/A

+

jdbc_url

+

String

+

Definition

+

JDBC URL of the private network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

jdbc:postgresql://<connect_info>/<YOUR_DATABASE_NAME>

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Nodes

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Cluster instance ID.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Cluster instance status.

+

Range

+

100: creating

+

199: idle

+

200: available

+

300: unavailable

+

303: creation failed

+

304: deleting

+

305: deletion failed

+

400: deleted

+

name

+

String

+

Definition

+

Instance name.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Tags

Parameter

+

Type

+

Description

+

key

+

String

+

Definition

+

Tag key.

+

Constraints

+

N/A

+

Range

+

  • It can contain a maximum of 128 Unicode characters. It cannot be an empty string, and cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+

value

+

String

+

Definition

+

Tag value.

+

Constraints

+

N/A

+

Range

+

  • The value can contain a maximum of 256 characters and can be an empty string. It cannot start or end with a space.

    +

  • It cannot contain the following characters: =*<>\,|/

    +

  • Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.

    +
+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 PublicIp

Parameter

+

Type

+

Description

+

public_bind_type

+

String

+

Definition

+

EIP binding type.

+

Constraints

+

N/A

+

Range

+

auto_assign

+

not_use

+

bind_existing

+

Default Value

+

null

+

eip_id

+

String

+

Definition

+

EIP ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

null

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 PublicEndpoints

Parameter

+

Type

+

Description

+

public_connect_info

+

String

+

Definition

+

Public network connection information.

+

Range

+

N/A

+

jdbc_url

+

String

+

Definition

+

JDBC connection string of the public network.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

jdbc:postgresql://<public_connect_info>/<YOUR_DATABASE_name>

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 FailedReason

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Query the cluster list.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters
+
+

Example Responses

Status code: 200

+

Cluster list queried.

+
{
+  "clusters" : [ {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15",
+    "name" : "dws-1",
+    "status" : "AVAILABLE",
+    "version" : "1.2.0",
+    "updated" : "2016-02-10T14:28:14Z",
+    "created" : "2016-02-10T14:26:14Z",
+    "port" : 8000,
+    "endpoints" : [ {
+      "connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "nodes" : [ {
+      "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
+      "name" : "dws-1-dws-cn-cn-1-1",
+      "status" : "200"
+    }, {
+      "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
+      "name" : "dws-1-dws-cn-cn-2-1",
+      "status" : "200"
+    }, {
+      "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
+      "name" : "dws-1-dws-cn-cn-3-1",
+      "status" : "200"
+    } ],
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value2"
+    } ],
+    "user_name" : "dbadmin",
+    "number_of_node" : 3,
+    "recent_event" : 6,
+    "availability_zone" : "eu-de-01b",
+    "enterprise_project_id" : "0",
+    "node_type" : "dws.d1.xlarge.ultrahigh",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
+    },
+    "public_endpoints" : [ {
+      "public_connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "action_progress" : {
+      "SNAPSHOTTING" : "20%"
+    },
+    "sub_status" : "READONLY",
+    "task_status" : "SNAPSHOTTING",
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Cluster list queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ShowInstance.html b/docs/dws/api-ref/ShowInstance.html new file mode 100644 index 000000000..34134f6d6 --- /dev/null +++ b/docs/dws/api-ref/ShowInstance.html @@ -0,0 +1,754 @@ + + +

Querying an Instance

+

Function

This API is used to query details about a single instance.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

instance_id

+

Yes

+

String

+

Definition

+

Instance ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

configuration_status

+

String

+

Definition

+

Configuration status.

+

Range

+

N/A

+

params_group_id

+

String

+

Definition

+

Parameter template ID.

+

Range

+

N/A

+

type

+

String

+

Definition

+

Type.

+

Range

+

N/A

+

subnet_id

+

String

+

Definition

+

Subnet ID.

+

Range

+

N/A

+

role

+

String

+

Definition

+

Role.

+

Range

+

N/A

+

internal_subnet_id

+

String

+

Definition

+

Internal subnet ID.

+

Range

+

N/A

+

group

+

String

+

Definition

+

Group information.

+

Range

+

N/A

+

secure_group

+

String

+

Definition

+

Security group.

+

Range

+

N/A

+

vpc

+

String

+

Definition

+

VPC ID.

+

Range

+

N/A

+

azcode

+

String

+

Definition

+

AZ code.

+

Range

+

N/A

+

region

+

String

+

Definition

+

Region code.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

N/A

+

created

+

String

+

Definition

+

Creation time.

+

Range

+

N/A

+

updated

+

String

+

Definition

+

Update time.

+

Range

+

N/A

+

status

+

String

+

Definition

+

Status.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Node name.

+

Range

+

N/A

+

links

+

Array of LinkResp objects

+

Definition

+

Link information.

+

Range

+

N/A

+

id

+

String

+

Definition

+

Node ID.

+

Range

+

N/A

+

flavor

+

ClusterFlavorResp object

+

Definition

+

Flavor information.

+

Range

+

N/A

+

volume

+

CompatibleInstanceVolumeResp object

+

Definition

+

Capacity.

+

Range

+

N/A

+

datastore

+

CompatibleDataStoreResp object

+

Definition

+

Version information.

+

Range

+

N/A

+

fault

+

CompatibleFaultResp object

+

Definition

+

Others.

+

Range

+

N/A

+

configuration

+

CompatibleConfigurationResp object

+

Definition

+

Parameter configurations.

+

Range

+

N/A

+

locality

+

String

+

Definition

+

This parameter has been deprecated and has no actual meaning.

+

Range

+

N/A

+

replicas

+

Array of CompatibleReplicasResp objects

+

Definition

+

This parameter has been deprecated and has no actual meaning.

+

Range

+

N/A

+

db_user

+

String

+

Definition

+

Database user.

+

Range

+

N/A

+

storage_engine

+

String

+

Definition

+

Storage engine.

+

Range

+

N/A

+

pay_model

+

Integer

+

Definition

+

Payment method.

+

Range

+

N/A

+

public_ip

+

String

+

Definition

+

Public IP address.

+

Range

+

N/A

+

traffic_ip

+

String

+

Definition

+

Traffic IP address.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 ClusterFlavorResp

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Flavor ID.

+

Range

+

N/A

+

links

+

Array of LinkResp objects

+

Definition

+

Link information.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 CompatibleInstanceVolumeResp

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Type.

+

Range

+

N/A

+

used

+

Float

+

Definition

+

Used size.

+

Range

+

N/A

+

size

+

Integer

+

Definition

+

Total size.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 CompatibleDataStoreResp

Parameter

+

Type

+

Description

+

type

+

String

+

Definition

+

Database type.

+

Range

+

N/A

+

version

+

String

+

Definition

+

Version.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 CompatibleFaultResp

Parameter

+

Type

+

Description

+

message

+

String

+

Definition

+

Messages.

+

Range

+

N/A

+

created

+

String

+

Definition

+

Creator.

+

Range

+

N/A

+

details

+

String

+

Definition

+

Details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 CompatibleConfigurationResp

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Parameter template ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Parameter template name.

+

Range

+

N/A

+

links

+

Array of LinkResp objects

+

Definition

+

Connection information.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 CompatibleReplicasResp

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Name.

+

Range

+

N/A

+

links

+

Array of LinkResp objects

+

Definition

+

Link.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 LinkResp

Parameter

+

Type

+

Description

+

rel

+

String

+

Definition

+

Associated information.

+

Range

+

N/A

+

href

+

String

+

Definition

+

Link information.

+

Range

+

N/A

+
+
+
+

Example Requests

Query information about a single instance.

+
GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/instances/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "type" : "dws-cn",
+  "role" : "Standalone",
+  "group" : "cn-1",
+  "vpc" : "28e65e71-0b08-4f04-a05f-1603f869cd1f",
+  "azcode" : "eu-de-01a",
+  "region" : "eu-de-01",
+  "created" : "2025-05-11T10:07:06",
+  "updated" : "2025-05-11T10:07:06",
+  "status" : "ACTIVE",
+  "name" : "dws-apie-dws-cn-cn-1-1",
+  "links" : [ {
+    "rel" : "self",
+    "href" : ""
+  }, {
+    "rel" : "bookmark",
+    "href" : ""
+  } ],
+  "id" : "a83ed6f4-8062-427f-81bc-1dd0546acb43",
+  "flavor" : {
+    "id" : "3228254e-81c6-4975-bb45-5d8365ab5f25",
+    "links" : [ {
+      "rel" : "self",
+      "href" : ""
+    }, {
+      "rel" : "bookmark",
+      "href" : ""
+    } ]
+  },
+  "volume" : null,
+  "datastore" : {
+    "type" : "dws",
+    "version" : "9.1.0.215"
+  },
+  "fault" : null,
+  "configuration" : {
+    "id" : "1fd0a140-c487-4b95-bf9a-243fe3d7468a",
+    "name" : null,
+    "links" : [ {
+      "rel" : "self",
+      "href" : ""
+    }, {
+      "rel" : "bookmark",
+      "href" : ""
+    } ]
+  },
+  "locality" : null,
+  "replicas" : null,
+  "configuration_status" : "In-Sync",
+  "params_group_id" : "1fd0a140-c487-4b95-bf9a-243fe3d7468a",
+  "subnet_id" : "b530bb2b-724b-477e-bd55-b4428ae91fdf",
+  "internal_subnet_id" : "b37dceca-dec6-4128-8d57-abd0b6ce0cbe",
+  "secure_group" : "cd15fdcd-c7d5-4660-bb78-30e701e80775",
+  "cluster_id" : "bcdfb00c-a5e3-4896-83c7-3c397ed99f28",
+  "db_user" : "dbadmin",
+  "storage_engine" : null,
+  "pay_model" : 0,
+  "public_ip" : null,
+  "traffic_ip" : "192.200.132.176"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ShowResourceStatistics.html b/docs/dws/api-ref/ShowResourceStatistics.html new file mode 100644 index 000000000..a00fe5535 --- /dev/null +++ b/docs/dws/api-ref/ShowResourceStatistics.html @@ -0,0 +1,201 @@ + + +

Querying Resource Statistics

+

Function

This API is used to query resource statistics.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/{project_id}/resource-statistics

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

No

+

String

+

Definition

+

Namespace.

+

Constraints

+

N/A

+

Range

+

The value can only be dws.

+

Default Value

+

dws

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

cluster_statistics

+

StatusStatistics object

+

Definition

+

Cluster resource statistics.

+

Range

+

N/A

+

node_statistics

+

StatusStatistics object

+

Definition

+

Node resource statistics.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 StatusStatistics

Parameter

+

Type

+

Description

+

active

+

Long

+

Definition

+

Active resources.

+

Range

+

N/A

+

total

+

Long

+

Definition

+

Total resources.

+

Range

+

N/A

+
+
+
+

Example Requests

Query resource statistics.

+
GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/resource-statistics
+
+

Example Responses

Status code: 200

+

Resource statistics queried.

+
{
+  "cluster_statistics" : {
+    "active" : 2,
+    "total" : 2
+  },
+  "node_statistics" : {
+    "active" : 6,
+    "total" : 36
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource statistics queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/ShowWorkloadPlan.html b/docs/dws/api-ref/ShowWorkloadPlan.html new file mode 100644 index 000000000..8a9977c55 --- /dev/null +++ b/docs/dws/api-ref/ShowWorkloadPlan.html @@ -0,0 +1,511 @@ + + +

Querying Details About a Resource Management Plan

+

Function

This API is used to query details about a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

workload_plan

+

WorkloadPlanInfo object

+

Definition

+

Queue details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 WorkloadPlanInfo

Parameter

+

Type

+

Description

+

status

+

Integer

+

Definition

+

Plan status

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

cluster_id

+

String

+

Definition

+

Cluster ID.

+

Range

+

It is a 36-digit UUID.

+

plan_id

+

String

+

Definition

+

Plan ID.

+

Range

+

N/A

+

plan_name

+

String

+

Definition

+

Plan name

+

Range

+

N/A

+

current_stage

+

String

+

Definition

+

Current plan stage.

+

Range

+

N/A

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

stage_list

+

Array of PlanStage objects

+

Definition

+

List of plan stages

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PlanStage

Parameter

+

Type

+

Description

+

month

+

String

+

Definition

+

Month.

+

Range

+

N/A

+

day

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

plan_id

+

String

+

Definition

+

Plan ID.

+

Range

+

N/A

+

stage_id

+

String

+

Definition

+

Plan stage ID.

+

Range

+

N/A

+

stage_name

+

String

+

Definition

+

Plan stage name.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Start time of the plan.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

next_valid_time

+

String

+

Definition

+

Next validation time.

+

Range

+

N/A

+

queue_list

+

Array of QueueResourceItem objects

+

Definition

+

Resource queue list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 QueueResourceItem

Parameter

+

Type

+

Description

+

queue_name

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

queue_resources

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 WorkloadResourceItem

Parameter

+

Type

+

Description

+

resource_name

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

Query details about a resource management plan.

+
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a
+
+

Example Responses

Status code: 200

+

Details about a resource management plan queried.

+
{
+  "workload_plan" : {
+    "status" : 0,
+    "cluster_id" : "862201cd-f822-4dbc-ae3b-c7b9d080eea6",
+    "project_id" : "0536cdee2200d5912f7cc00b877980f1",
+    "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
+    "plan_name" : "plan1",
+    "current_stage" : "",
+    "logical_cluster_name" : "",
+    "stage_list" : [ {
+      "month" : 4,
+      "day" : 4,
+      "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
+      "stage_id" : "00bc8bc5-c885-42e5-b205-80547d3f94c4",
+      "stage_name" : "stage2",
+      "start_time" : "00:00:00",
+      "end_time" : "00:00:00",
+      "next_valid_time" : "2024-04-04 00:00:00",
+      "queue_list" : [ {
+        "queue_name" : "resouce1",
+        "queue_resources" : [ {
+          "resource_name" : "cpu",
+          "resource_value" : 1,
+          "value_unit" : "%",
+          "resource_description" : "Workload Queue Memory Percent"
+        } ]
+      } ]
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Details about a resource management plan queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ShowWorkloadPlanStage.html b/docs/dws/api-ref/ShowWorkloadPlanStage.html new file mode 100644 index 000000000..93193e8b7 --- /dev/null +++ b/docs/dws/api-ref/ShowWorkloadPlanStage.html @@ -0,0 +1,425 @@ + + +

Querying Stage Details About a Resource Management Plan

+

Function

This API is used to query details stage details of resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/{stage_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

stage_id

+

Yes

+

String

+

Definition

+

Plan stage ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

workload_plan_stage

+

PlanStage object

+

Definition

+

Plan stage details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 PlanStage

Parameter

+

Type

+

Description

+

month

+

String

+

Definition

+

Month.

+

Range

+

N/A

+

day

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

plan_id

+

String

+

Definition

+

Plan ID.

+

Range

+

N/A

+

stage_id

+

String

+

Definition

+

Plan stage ID.

+

Range

+

N/A

+

stage_name

+

String

+

Definition

+

Plan stage name.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Start time of the plan.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

next_valid_time

+

String

+

Definition

+

Next validation time.

+

Range

+

N/A

+

queue_list

+

Array of QueueResourceItem objects

+

Definition

+

Resource queue list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 QueueResourceItem

Parameter

+

Type

+

Description

+

queue_name

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

queue_resources

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 WorkloadResourceItem

Parameter

+

Type

+

Description

+

resource_name

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/stages/00bc8bc5-c885-42e5-b205-80547d3f94c4
+
+

Example Responses

Status code: 200

+

Stage details about the resource management plan queried.

+
{
+  "workload_plan_stage" : {
+    "month" : 4,
+    "day" : 4,
+    "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
+    "stage_id" : "00bc8bc5-c885-42e5-b205-80547d3f94c4",
+    "stage_name" : "stage2",
+    "start_time" : "00:00:00",
+    "end_time" : "00:00:00",
+    "next_valid_time" : "2024-04-04 00:00:00",
+    "queue_list" : [ {
+      "queue_name" : "resouce1",
+      "queue_resources" : [ {
+        "resource_name" : "cpu",
+        "resource_value" : 1,
+        "value_unit" : null,
+        "resource_description" : null
+      } ]
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Stage details about the resource management plan queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ShowWorkloadQueue.html b/docs/dws/api-ref/ShowWorkloadQueue.html new file mode 100644 index 000000000..6dca2dee1 --- /dev/null +++ b/docs/dws/api-ref/ShowWorkloadQueue.html @@ -0,0 +1,360 @@ + + +

Querying Resource Pool Details

+

Function

This API is used to query details about a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name. In non-logical cluster mode, this parameter is left blank. In logical cluster mode, you need to set this parameter to a logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

workload_queue

+

WorkloadQueueItem object

+

Definition

+

Resource queue details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 WorkloadQueueItem

Parameter

+

Type

+

Description

+

queue_name

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

logical_cluster_name

+

String

+

Definition

+

Logical cluster name.

+

Range

+

N/A

+

short_query_optimize

+

String

+

Definition

+

Whether to enable short query acceleration for the resource pool

+

Range

+

N/A

+

short_query_concurrency_num

+

Integer

+

Definition

+

Number of concurrent short queries in the resource pool

+

Range

+

N/A

+

resource_item_list

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 WorkloadResourceItem

Parameter

+

Type

+

Description

+

resource_name

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/resource1
+
+

Example Responses

Status code: 200

+

Resource pool details queried.

+
{
+  "workload_queue" : {
+    "queue_name" : "resource1",
+    "logical_cluster_name" : "",
+    "short_query_optimize" : "t",
+    "short_query_concurrency_num" : -1,
+    "resource_item_list" : [ {
+      "resource_name" : "cpu",
+      "resource_value" : 1,
+      "value_unit" : null,
+      "resource_description" : null
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource pool details queried.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/ShrinkCluster.html b/docs/dws/api-ref/ShrinkCluster.html new file mode 100644 index 000000000..81eb9a49b --- /dev/null +++ b/docs/dws/api-ref/ShrinkCluster.html @@ -0,0 +1,276 @@ + + +

Scaling In a Cluster

+

Function

This API is used to scale in a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrink

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

shrink_number

+

No

+

Integer

+

Definition

+

Number of nodes to be scaled in.

+

Constraints

+

This parameter cannot be left blank.

+

Range

+

An integer greater than 0

+

Default Value

+

N/A

+

online

+

No

+

Boolean

+

Definition

+

Whether the scale-in is online.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

false

+

retry

+

No

+

Boolean

+

Definition

+

Whether to retry after a scale-in failure.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

false

+

need_agency

+

No

+

Boolean

+

Definition

+

Whether an agency is required.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

false

+

parallel_jobs

+

No

+

Integer

+

Definition

+

Number of concurrent redistribution tasks.

+

Constraints

+

N/A

+

Range

+

1 to 200

+

Default Value

+

4

+

type

+

No

+

String

+

Definition

+

Type. This field has been deprecated and does not take effect.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

force_backup

+

No

+

Boolean

+

Definition

+

Whether to back up data before the operation. This parameter has been deprecated and does not take effect.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

ID of a scale-in task.

+

Range

+

N/A

+
+
+
+

Example Requests

Scale in three nodes in the standard data warehouse cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 offline and create an agency.

+
POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink
+
+{
+  "shrink_number" : 3,
+  "online" : false,
+  "retry" : false,
+  "need_agency" : true,
+  "parallel_jobs" : 2
+}
+
+

Example Responses

Status code: 200

+

The scale-in request is submitted successfully.

+
{
+  "job_id" : "2c9081c88418ed420184197c8bc80001"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The scale-in request is submitted successfully.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/ShrinkLogicalCluster.html b/docs/dws/api-ref/ShrinkLogicalCluster.html new file mode 100644 index 000000000..80706230c --- /dev/null +++ b/docs/dws/api-ref/ShrinkLogicalCluster.html @@ -0,0 +1,391 @@ + + +

Scaling In a Logical Cluster

+

Function

This API is used to scale in a logical cluster in an elastic pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/shrink

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

logical_cluster_id

+

Yes

+

String

+

Definition

+

Logical cluster ID.

+

Constraints

+

The value must be a valid DWS logical cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_rings

+

Yes

+

Array of ClusterRing objects

+

Definition

+

Host ring scale-in information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

parallel_jobs

+

No

+

Integer

+

Definition

+

Number of concurrent redistribution tasks.

+

Constraints

+

N/A

+

Range

+

1 to 200

+

Default Value

+

4.

+

mode

+

No

+

String

+

Definition

+

Scale-in mode.

+

Constraints

+

N/A

+

Range

+

read-only: offline mode

+

insert: online mode

+

Default Value

+

insert

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ClusterRing

Parameter

+

Mandatory

+

Type

+

Description

+

ring_hosts

+

Yes

+

Array of RingHost objects

+

Definition

+

Cluster host information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

un_shrinkable_cluster_ring

+

No

+

Boolean

+

Definition

+

Whether scale-in is supported.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RingHost

Parameter

+

Mandatory

+

Type

+

Description

+

host_name

+

Yes

+

String

+

Definition

+

Host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

back_ip

+

Yes

+

String

+

Definition

+

Backend IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cpu_cores

+

Yes

+

Integer

+

Definition

+

Number of host CPUs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

memory

+

Yes

+

Double

+

Definition

+

Host memory.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

disk_size

+

Yes

+

Double

+

Definition

+

Disk size of the host.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Scale in a logical cluster.

+
POST https://{Endpoint}/v1/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/d29fd79b-d445-4e90-8fea-2f7d8b216bfflogical-clusters/7dc7a0a9-1f43-4f3c-974e-4a5ee2070836/shrink
+
+{
+  "cluster_rings" : [ {
+    "ring_hosts" : [ {
+      "back_ip" : "192.168.88.41",
+      "cpu_cores" : 4,
+      "disk_size" : 110,
+      "host_name" : "host-192-168-37-200",
+      "memory" : 16
+    }, {
+      "back_ip" : "192.168.72.33",
+      "cpu_cores" : 4,
+      "disk_size" : 110,
+      "host_name" : "host-192-168-6-50",
+      "memory" : 16
+    }, {
+      "back_ip" : "192.168.90.60",
+      "cpu_cores" : 4,
+      "disk_size" : 110,
+      "host_name" : "host-192-168-8-183",
+      "memory" : 16
+    } ]
+  } ]
+}
+
+

Example Responses

Status code: 200

+

The logical cluster scale-in request submitted.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The logical cluster scale-in request submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/StartCluster.html b/docs/dws/api-ref/StartCluster.html new file mode 100644 index 000000000..895f37c1b --- /dev/null +++ b/docs/dws/api-ref/StartCluster.html @@ -0,0 +1,145 @@ + + +

Starting a Cluster

+

Function

This API is used to start a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/start

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

ID of the task for starting a cluster.

+

Range

+

N/A

+
+
+
+

Example Requests

Start a cluster.

+
POST https://{endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/97cbaab3-939e-4dbc-9187-0fe240f2b9fd/start
+
+

Example Responses

Status code: 200

+

Request submitted.

+
{
+  "error_code" : null,
+  "error_msg" : null,
+  "job_id" : "2c9080d08cc99d28018ccd139e942498"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/StartWorkloadPlan.html b/docs/dws/api-ref/StartWorkloadPlan.html new file mode 100644 index 000000000..cd1c579c4 --- /dev/null +++ b/docs/dws/api-ref/StartWorkloadPlan.html @@ -0,0 +1,170 @@ + + +

Starting a Resource Management Plan

+

Function

This API is used start a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/start

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

Start a resource management plan.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/start
+
+

Example Responses

Status code: 200

+

Resource management plan started.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource management plan started.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/StopCluster.html b/docs/dws/api-ref/StopCluster.html new file mode 100644 index 000000000..61f98d075 --- /dev/null +++ b/docs/dws/api-ref/StopCluster.html @@ -0,0 +1,145 @@ + + +

Stopping a Cluster

+

Function

This API is used to stop a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/{project_id}/clusters/{cluster_id}/stop

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Definition

+

ID of the task for stopping a cluster.

+

Range

+

N/A

+
+
+
+

Example Requests

Stop a cluster.

+
POST https://{endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/97cbaab3-939e-4dbc-9187-0fe240f2b9fd/stop
+
+

Example Responses

Status code: 200

+

The request for stopping the cluster is submitted.

+
{
+  "error_code" : null,
+  "error_msg" : null,
+  "job_id" : "2c9080d08cc99d28018ccd139e942498"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The request for stopping the cluster is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/StopRedistribution.html b/docs/dws/api-ref/StopRedistribution.html new file mode 100644 index 000000000..4baaaa3b9 --- /dev/null +++ b/docs/dws/api-ref/StopRedistribution.html @@ -0,0 +1,122 @@ + + +

Suspending Redistribution

+

Function

This API is used to suspend redistribution. After suspension, you can set the redistribution priority and change the number of concurrent redistribution tasks.

+

This function is available only for DWS 2.0 clusters.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/redistribution/suspend

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

Redistribution suspended.

+

None

+
+

Example Requests

Suspend redistribution.

+
POST https://{Endpoint}/v2.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/redistribution/suspend
+
+

Example Responses

Status code: 200

+

Redistribution suspended.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Redistribution suspended.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/StopWorkloadPlan.html b/docs/dws/api-ref/StopWorkloadPlan.html new file mode 100644 index 000000000..7e16db4b5 --- /dev/null +++ b/docs/dws/api-ref/StopWorkloadPlan.html @@ -0,0 +1,170 @@ + + +

Stopping a Resource Management Plan

+

Function

This API is used to stop a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stop

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

Stop a resource management plan.

+
POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/stop
+
+

Example Responses

Status code: 200

+

Resource management plan stopped.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource management plan stopped.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/SwitchOverCluster.html b/docs/dws/api-ref/SwitchOverCluster.html new file mode 100644 index 000000000..3a2153835 --- /dev/null +++ b/docs/dws/api-ref/SwitchOverCluster.html @@ -0,0 +1,124 @@ + + +

Performing a Switchback

+

Function

In the Unbalanced state, the number of primary instances on some nodes increases. As a result, the load pressure is high. In this case, the cluster is normal, but the overall performance is not as good as that in a balanced state. You can perform a primary/standby switchback to change the cluster status to Available.

+

Constraints

+

Only 8.1.1.202 and later versions support primary/standby switchbacks.

+

A switchback interrupts services for a short period of time. The interruption duration depends on the service volume. You are advised to perform this operation during off-peak hours.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/switchover

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+

The request for performing a primary/standby switchback is submitted.

+

None

+
+

Example Requests

Perform a primary/standby switchback.

+
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/switchover
+
+

Example Responses

Status code: 200

+

The request for performing a primary/standby switchback is submitted.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The request for performing a primary/standby switchback is submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/SwitchPlanStage.html b/docs/dws/api-ref/SwitchPlanStage.html new file mode 100644 index 000000000..220e6731f --- /dev/null +++ b/docs/dws/api-ref/SwitchPlanStage.html @@ -0,0 +1,198 @@ + + +

Switching the Stage of a Resource Management Plan

+

Function

This API is used to switch the stage of a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stage-switch

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

stage_id

+

Yes

+

String

+

Definition

+

ID of the resource management plan stage

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0591129f-4970-44e7-b213-f7bce797de87/stage-switch
+
+{
+  "stage_id" : "0c2145ad-4d76-4abe-bd1b-cdbe9128478a"
+}
+
+

Example Responses

Status code: 200

+

Resource management plan stage switched.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource management plan stage switched.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateAlarmSub.html b/docs/dws/api-ref/UpdateAlarmSub.html new file mode 100644 index 000000000..fc76d4e62 --- /dev/null +++ b/docs/dws/api-ref/UpdateAlarmSub.html @@ -0,0 +1,347 @@ + + +

Modifying an Alarm Subscription

+

Function

This API is used to modify an alarm subscription.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/alarm-subs/{alarm_sub_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

alarm_sub_id

+

Yes

+

String

+

Definition

+

Alarm subscription ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Subscribed alarm name.

+

Range

+

N/A

+

enable

+

No

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

N/A

+

alarm_level

+

No

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

notification_target

+

Yes

+

String

+

Definition

+

Message topic address.

+

Range

+

N/A

+

notification_target_name

+

Yes

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

Yes

+

String

+

Definition

+

Message topic type. Only SMN is supported.

+

Range

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Alarm subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscribed alarm name.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

N/A

+

alarm_level

+

String

+

Definition

+

Alarm severity.

+

Range

+

N/A

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service to which the alarm belongs.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Message topic address.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message topic type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

Modify the zrf-test-13 alarm subscription. Change the alarm severity to critical,major,minor, the SMN topic name to dws-test-nodelete, and the address to urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete.

+
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/alarm-subs/273ce506-dad8-411c-92f9-be5004739b40
+
+{
+  "alarm_level" : "urgent,important,minor",
+  "enable" : 1,
+  "name" : "zrf-test-13",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN"
+}
+
+

Example Responses

Status code: 200

+

Alarm subscription modified.

+
{
+  "id" : "273ce506-dad8-411c-92f9-be5004739b40",
+  "name" : "zrf-test-13",
+  "enable" : 1,
+  "language" : "zh-cn",
+  "alarm_level" : "urgent,important,minor",
+  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+  "name_space" : "dws",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm subscription modified.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Alarm Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateClusterDns.html b/docs/dws/api-ref/UpdateClusterDns.html new file mode 100644 index 000000000..efac0c72f --- /dev/null +++ b/docs/dws/api-ref/UpdateClusterDns.html @@ -0,0 +1,174 @@ + + +

Modifying a Cluster Domain Name

+

Function

This API is used to change the domain name of a specified cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/dns

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Domain name to be modified.

+

Range

+

N/A

+

type

+

Yes

+

String

+

Definition

+

Domain name type.

+

Range

+

public

+

private

+

ttl

+

Yes

+

Integer

+

Definition

+

Caching duration of the SOA record set, in seconds. The default value is 300, in seconds.

+

Range

+

300 to 2147483647

+
+
+
+

Response Parameters

Status code: 200

+

The cluster domain name is modified successfully.

+

None

+
+

Example Requests

PUT https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/dns
+
+{
+  "name" : "demo",
+  "type" : "public",
+  "ttl" : 300
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

The cluster domain name is modified successfully.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Connection Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateEventSub.html b/docs/dws/api-ref/UpdateEventSub.html new file mode 100644 index 000000000..93a7d9c50 --- /dev/null +++ b/docs/dws/api-ref/UpdateEventSub.html @@ -0,0 +1,443 @@ + + +

Modifying a Subscribed Event

+

Function

This API is used to modify a subscribed event.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/event-subs/{event_sub_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

event_sub_id

+

Yes

+

String

+

Definition

+

Event subscription ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Definition

+

Event subscription name.

+

Range

+

N/A

+

source_type

+

No

+

String

+

Definition

+

Event source type.

+

Range

+

cluster, backup, or disaster-recovery

+

source_id

+

No

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

category

+

No

+

String

+

Definition

+

Event category.

+

Range

+

management, monitor, security, or system alarm.

+

severity

+

No

+

String

+

Definition

+

Event severity.

+

Range

+

The value can be normal or warning.

+

tag

+

No

+

String

+

Definition

+

Event tag.

+

Range

+

N/A

+

enable

+

No

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

1: enabled; 0: disabled.

+

notification_target

+

Yes

+

String

+

Definition

+

Message notification address.

+

Range

+

N/A

+

notification_target_name

+

Yes

+

String

+

Definition

+

Message topic name.

+

Range

+

N/A

+

notification_target_type

+

Yes

+

String

+

Definition

+

Message notification type. The value can only be SMN.

+

Range

+

SMN

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Definition

+

Subscription ID.

+

Range

+

N/A

+

name

+

String

+

Definition

+

Subscription name.

+

Range

+

N/A

+

source_type

+

String

+

Definition

+

Event source type.

+

Range

+

N/A

+

source_id

+

String

+

Definition

+

Event source ID.

+

Range

+

N/A

+

category

+

String

+

Definition

+

Event category.

+

Range

+

N/A

+

severity

+

String

+

Definition

+

Event severity.

+

Range

+

N/A

+

tag

+

String

+

Definition

+

Event tag.

+

Range

+

N/A

+

enable

+

Integer

+

Definition

+

Whether to enable subscription.

+

Range

+

1: enabled; 0: disabled.

+

project_id

+

String

+

Definition

+

Project ID.

+

Range

+

N/A

+

name_space

+

String

+

Definition

+

Service.

+

Range

+

N/A

+

notification_target

+

String

+

Definition

+

Address for the message notification topic.

+

Range

+

N/A

+

notification_target_name

+

String

+

Definition

+

Message notification topic.

+

Range

+

N/A

+

notification_target_type

+

String

+

Definition

+

Message notification type.

+

Range

+

N/A

+

language

+

String

+

Definition

+

Language.

+

Range

+

N/A

+

time_zone

+

String

+

Definition

+

Time zone.

+

Range

+

N/A

+
+
+
+

Example Requests

Modify the zrf-test-66 event subscription (Change the event type to normal and warning, and change the address of the SMN message topic dws-test-nodelete to urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete).

+
https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs/41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b
+
+{
+  "severity" : "normal,warning",
+  "source_id" : "",
+  "source_type" : "",
+  "tag" : "",
+  "category" : "",
+  "enable" : 1,
+  "name" : "zrf-test-66",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN"
+}
+
+

Example Responses

Status code: 200

+

Event subscription modified.

+
{
+  "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b",
+  "name" : "zrf-test-66",
+  "category" : "",
+  "severity" : "normal,warning",
+  "tag" : "",
+  "enable" : 1,
+  "language" : "zh-cn",
+  "source_type" : "",
+  "source_id" : "",
+  "project_id" : "4cf650fd46704908aa071b4df2453e1e",
+  "name_space" : "DWS",
+  "notification_target" : "urn:smn:eu-de-01:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete",
+  "notification_target_name" : "dws-test-nodelete",
+  "notification_target_type" : "SMN",
+  "time_zone" : "GMT+08:00"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Event subscription modified.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Event Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateLogicalCluster.html b/docs/dws/api-ref/UpdateLogicalCluster.html new file mode 100644 index 000000000..b07a24273 --- /dev/null +++ b/docs/dws/api-ref/UpdateLogicalCluster.html @@ -0,0 +1,399 @@ + + +

Editing a Logical Cluster

+

Function

This API is used to edit a logical cluster. The API determines whether to scale out or scale in a logical cluster based on the submitted request body.

+

Scenario 1: The original logical cluster has six nodes (two rings). If the request body submitted contains only one ring, the logical cluster is scaled in.

+

Scenario 2: The original logical cluster has six nodes (two rings). If the request body submitted contains three rings, the logical cluster is scaled out.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

logical_cluster_id

+

Yes

+

String

+

Definition

+

ID of the logical cluster to be edited.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster_rings

+

Yes

+

Array of ClusterRing objects

+

Definition

+

Information for editing the ring list of the logical cluster.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

mode

+

No

+

String

+

Definition

+

Redistribution mode.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

waiting_for_killing

+

No

+

Integer

+

Definition

+

Time before job termination.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ClusterRing

Parameter

+

Mandatory

+

Type

+

Description

+

ring_hosts

+

Yes

+

Array of RingHost objects

+

Definition

+

Cluster host information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

un_shrinkable_cluster_ring

+

No

+

Boolean

+

Definition

+

Whether scale-in is supported.

+

Constraints

+

N/A

+

Range

+

false or true

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RingHost

Parameter

+

Mandatory

+

Type

+

Description

+

host_name

+

Yes

+

String

+

Definition

+

Host name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

back_ip

+

Yes

+

String

+

Definition

+

Backend IP address.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cpu_cores

+

Yes

+

Integer

+

Definition

+

Number of host CPUs.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

memory

+

Yes

+

Double

+

Definition

+

Host memory.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

disk_size

+

Yes

+

Double

+

Definition

+

Disk size of the host.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Definition

+

Error code.

+

Range

+

N/A

+

error_msg

+

String

+

Definition

+

Error message.

+

Range

+

N/A

+
+
+
+

Example Requests

Submit the request for scaling in the logical cluster. After the request is submitted, the logical cluster has only one ring (three nodes).

+
PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/0b494d0d-8431-4c4f-8a06-2cc42d0d0c7d
+
+{
+  "cluster_rings" : [ {
+    "ring_hosts" : [ {
+      "host_name" : "host-172-16-20-246",
+      "back_ip" : "172.16.73.90",
+      "cpu_cores" : 8,
+      "memory" : 32.0,
+      "disk_size" : 800.0
+    }, {
+      "host_name" : "host-172-16-4-26",
+      "back_ip" : "172.16.123.5",
+      "cpu_cores" : 8,
+      "memory" : 32.0,
+      "disk_size" : 800.0
+    }, {
+      "host_name" : "host-172-16-43-90",
+      "back_ip" : "172.16.92.175",
+      "cpu_cores" : 8,
+      "memory" : 32.0,
+      "disk_size" : 800.0
+    } ]
+  } ],
+  "mode" : null,
+  "waiting_for_killing" : 0
+}
+
+

Example Responses

Status code: 200

+

Request for editing a logical cluster submitted.

+
{
+  "error_code" : "DWS.0000",
+  "error_msg" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Request for editing a logical cluster submitted.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Logical Cluster Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateQueueResources.html b/docs/dws/api-ref/UpdateQueueResources.html new file mode 100644 index 000000000..c7bdc8199 --- /dev/null +++ b/docs/dws/api-ref/UpdateQueueResources.html @@ -0,0 +1,372 @@ + + +

Modifying Resource Configurations of a Resource Pool

+

Function

This API is used to modify the resource configurations of a resource pool.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/resources

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

workload_queue

+

Yes

+

WorkloadQueueInfo object

+

Definition

+

Resource pool information.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 WorkloadQueueInfo

Parameter

+

Mandatory

+

Type

+

Description

+

workload_queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

logical_cluster_name

+

No

+

String

+

Definition

+

Logical cluster name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_item_list

+

Yes

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 WorkloadResourceItem

Parameter

+

Mandatory

+

Type

+

Description

+

resource_name

+

Yes

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Yes

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

No

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

No

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Response information.

+

Range

+

N/A

+
+
+
+

Example Requests

PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/{queue_name}/resources
+
+{
+  "workload_queue" : {
+    "workload_queue_name" : "test11",
+    "resource_item_list" : [ {
+      "resource_name" : "memory",
+      "resource_value" : "0"
+    }, {
+      "resource_name" : "tablespace",
+      "resource_value" : "-1"
+    }, {
+      "resource_name" : "activestatements",
+      "resource_value" : "10"
+    }, {
+      "resource_name" : "cpu_limit",
+      "resource_value" : 0
+    }, {
+      "resource_name" : "cpu_share",
+      "resource_value" : 12
+    } ],
+    "logical_cluster_name" : ""
+  }
+}
+
+

Example Responses

Status code: 200

+

Resource configurations of the resource pool modified.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : ""
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resource configurations of the resource pool modified.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateRedistributionConfigurations.html b/docs/dws/api-ref/UpdateRedistributionConfigurations.html new file mode 100644 index 000000000..94b289bf1 --- /dev/null +++ b/docs/dws/api-ref/UpdateRedistributionConfigurations.html @@ -0,0 +1,174 @@ + + +

Modifying Redistribution Configurations

+

Function

This API is used to modify redistribution configurations.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/redistribution/configurations

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

parallel_jobs

+

Yes

+

Integer

+

Definition

+

Concurrency. The default value is 4.

+

Constraints

+

N/A

+

Range

+

1 to 200

+

Default Value

+

N/A

+

priority_policy

+

Yes

+

String

+

Definition

+

Redistribution priority policy.

+

Constraints

+

N/A

+

Range

+

  • default: default policy

    +

  • small: small tables first

    +

  • large: large tables first

    +
+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+

Operation succeeded.

+

None

+
+

Example Requests

Set the number of concurrent tasks to 4 and the redistribution priority to large tables.

+
PUT https://{Endpoint}/v2/05f2cff45100d5112f4bc00b794ea08e/clusters/496c3032-c08f-4cd1-8c66-9b56a89a274d/redistribution/configurations
+
+{
+  "parallel_jobs" : 4,
+  "priority_policy" : "large"
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Node Change
+
+
+ diff --git a/docs/dws/api-ref/UpdateSchemas.html b/docs/dws/api-ref/UpdateSchemas.html new file mode 100644 index 000000000..d2ff29593 --- /dev/null +++ b/docs/dws/api-ref/UpdateSchemas.html @@ -0,0 +1,208 @@ + + +

Editing the Space Limit of a Schema

+

Function

This API is used to edit the space limit of a schema.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/databases/{database_name}/schemas

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

database_name

+

Yes

+

String

+

Definition

+

Database name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

schema_name

+

Yes

+

String

+

Definition

+

Schema space name

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

perm_space

+

Yes

+

String

+

Definition

+

Schema space threshold

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

ret_code

+

Integer

+

Definition

+

Response code

+

Range

+

N/A

+
+
+
+

Example Requests

PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/databases/gaussdb/schemas
+
+{
+  "schema_name" : "gs_logical_cluster",
+  "perm_space" : 10240
+}
+
+

Example Responses

Status code: 200

+

Schema space limit edited.

+
{
+  "ret_code" : 0
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Schema space limit edited.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateWorkloadPlanStage.html b/docs/dws/api-ref/UpdateWorkloadPlanStage.html new file mode 100644 index 000000000..9c84760d8 --- /dev/null +++ b/docs/dws/api-ref/UpdateWorkloadPlanStage.html @@ -0,0 +1,705 @@ + + +

Modifying a Stage of a Resource Management Plan

+

Function

This API is used to modify a stage of a resource management plan.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/{stage_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

plan_id

+

Yes

+

String

+

Definition

+

Plan ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

stage_id

+

Yes

+

String

+

Definition

+

Plan stage ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

workload_plan_stage

+

No

+

workload_plan_stage object

+

Definition

+

Details of the resource management plan stage

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 workload_plan_stage

Parameter

+

Mandatory

+

Type

+

Description

+

day

+

No

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

month

+

No

+

String

+

Definition

+

Month

+

Range

+

N/A

+

stage_name

+

No

+

String

+

Definition

+

Plan stage

+

Range

+

N/A

+

start_time

+

No

+

String

+

Definition

+

Start time

+

Range

+

N/A

+

end_time

+

No

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

queue_list

+

No

+

Array of QueueResourceItem objects

+

Definition

+

Resource queue

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 QueueResourceItem

Parameter

+

Mandatory

+

Type

+

Description

+

queue_name

+

Yes

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

queue_resources

+

Yes

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 WorkloadResourceItem

Parameter

+

Mandatory

+

Type

+

Description

+

resource_name

+

Yes

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Yes

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

No

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

No

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Result status code.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Result description.

+

Range

+

N/A

+

workload_plan_stage

+

PlanStage object

+

Definition

+

Plan stage details.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 PlanStage

Parameter

+

Type

+

Description

+

month

+

String

+

Definition

+

Month.

+

Range

+

N/A

+

day

+

String

+

Definition

+

Date.

+

Range

+

N/A

+

plan_id

+

String

+

Definition

+

Plan ID.

+

Range

+

N/A

+

stage_id

+

String

+

Definition

+

Plan stage ID.

+

Range

+

N/A

+

stage_name

+

String

+

Definition

+

Plan stage name.

+

Range

+

N/A

+

start_time

+

String

+

Definition

+

Start time of the plan.

+

Range

+

N/A

+

end_time

+

String

+

Definition

+

End time.

+

Range

+

N/A

+

next_valid_time

+

String

+

Definition

+

Next validation time.

+

Range

+

N/A

+

queue_list

+

Array of QueueResourceItem objects

+

Definition

+

Resource queue list.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 QueueResourceItem

Parameter

+

Type

+

Description

+

queue_name

+

String

+

Definition

+

Resource pool name.

+

Range

+

N/A

+

queue_resources

+

Array of WorkloadResourceItem objects

+

Definition

+

Resource configuration queue.

+

Range

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 WorkloadResourceItem

Parameter

+

Type

+

Description

+

resource_name

+

String

+

Definition

+

Resource name.

+

Constraints

+

N/A

+

Range

+

cpu: percentage of CPU time

+

cpu_limit: percentage of CPU cores

+

memory: percentage of available memory resources on each data node

+

concurrency: number of concurrent queries

+

shortQueryConcurrencyNum: number of concurrent simple statements

+

weight: weight for network scheduling

+

Default Value

+

N/A

+

resource_value

+

Integer

+

Definition

+

Resource attribute value.

+

Constraints

+

N/A

+

Range

+

The value range varies according to the value of resource_name.

+

If resource_name is cpu, the value is an integer from 1 to 99.

+

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

+

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

+

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

+

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

+

Default Value

+

N/A

+

value_unit

+

String

+

Definition

+

Resource attribute unit.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

resource_description

+

String

+

Definition

+

Additional resource description.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Example Requests

put https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/stages/00bc8bc5-c885-42e5-b205-80547d3f94c4
+
+{
+  "workload_plan_stage" : {
+    "day" : "1",
+    "month" : "1",
+    "stage_name" : "stage1",
+    "start_time" : "00:00:00",
+    "end_time" : "00:00:00",
+    "queue_list" : [ {
+      "queue_name" : "test_1",
+      "queue_resources" : [ {
+        "resource_name" : "cpu",
+        "resource_value" : 80
+      }, {
+        "resource_name" : "cpu_limit",
+        "resource_value" : 0
+      }, {
+        "resource_name" : "memory",
+        "resource_value" : 0
+      }, {
+        "resource_name" : "concurrency",
+        "resource_value" : 10
+      }, {
+        "resource_name" : "shortQueryConcurrencyNum",
+        "resource_value" : -1
+      }, {
+        "resource_name" : "weight",
+        "resource_value" : -1
+      } ]
+    } ]
+  }
+}
+
+

Example Responses

Status code: 200

+

Stage information of the resource management plan modified.

+
{
+  "workload_plan_stage" : {
+    "day" : "1",
+    "month" : "1",
+    "stage_name" : "stage1",
+    "start_time" : "00:00:00",
+    "end_time" : "00:00:00",
+    "queue_list" : [ {
+      "queue_name" : "test_1",
+      "queue_resources" : [ {
+        "resource_name" : "cpu",
+        "resource_value" : 80
+      }, {
+        "resource_name" : "cpu_limit",
+        "resource_value" : 0
+      }, {
+        "resource_name" : "memory",
+        "resource_value" : 0
+      }, {
+        "resource_name" : "concurrency",
+        "resource_value" : 10
+      }, {
+        "resource_name" : "shortQueryConcurrencyNum",
+        "resource_value" : -1
+      }, {
+        "resource_name" : "weight",
+        "resource_value" : -1
+      } ]
+    } ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Stage information of the resource management plan modified.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/UpdateWorkloadRule.html b/docs/dws/api-ref/UpdateWorkloadRule.html new file mode 100644 index 000000000..9e4ef8881 --- /dev/null +++ b/docs/dws/api-ref/UpdateWorkloadRule.html @@ -0,0 +1,272 @@ + + +

Editing an Exception Rule

+

Function

This API is used to edit an exception rule.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/{project_id}/clusters/{cluster_id}/workload/rules/{rule_name}

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Definition

+

Project ID. To obtain the value, see Obtaining a Project ID.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition

+

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

+

Constraints

+

The value must be a valid DWS cluster ID.

+

Range

+

It is a 36-digit UUID.

+

Default Value

+

N/A

+

rule_name

+

Yes

+

String

+

Definition

+

Exception rule name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

rule_name

+

No

+

String

+

Definition

+

Exception rule name.

+

Constraints

+

It cannot be left blank.

+

Range

+

N/A

+

Default Value

+

N/A

+

except_rules

+

No

+

Array of ExceptRule objects

+

Definition

+

Exception rule configuration items.

+

Constraints

+

It cannot be left blank.

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ExceptRule

Parameter

+

Mandatory

+

Type

+

Description

+

rule_key

+

No

+

String

+

Definition

+

Rule item name.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+

rule_value

+

No

+

String

+

Definition

+

Rule item value.

+

Constraints

+

N/A

+

Range

+

N/A

+

Default Value

+

N/A

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

workload_res_code

+

Integer

+

Definition

+

Error code. The value 0 indicates a success.

+

Range

+

N/A

+

workload_res_str

+

String

+

Definition

+

Error information. If the operation is successful, the value is empty.

+

Range

+

N/A

+
+
+
+

Example Requests

Edit an exception rule.

+
PUT https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload/rules/rule
+
+{
+  "rule_name" : "rule",
+  "except_rules" : [ {
+    "rule_key" : "blocktime",
+    "rule_value" : "20"
+  }, {
+    "rule_key" : "action",
+    "rule_value" : "abort"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "workload_res_code" : 0,
+  "workload_res_str" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions.

+

404

+

No resources found.

+

500

+

Internal server error.

+

503

+

Service unavailable.

+
+
+
+
+
+
+
Parent topic: Resource Management
+
+
+ diff --git a/docs/dws/api-ref/dws_02_00068.html b/docs/dws/api-ref/dws_02_00068.html index 20bd42f9c..a8bec7736 100644 --- a/docs/dws/api-ref/dws_02_00068.html +++ b/docs/dws/api-ref/dws_02_00068.html @@ -1,9 +1,68 @@ - +

Obtaining the Cluster ID

-

A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain a cluster ID, perform the following operations:

-
  1. Log in to the GaussDB(DWS) console.
  2. In the navigation pane on the left, click Clusters.
  3. In the cluster list, find the target cluster and click the cluster name. The Basic Information page is displayed.
  4. View the cluster ID.
    Figure 1 Viewing the cluster ID
    -
+

A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:

+

Obtaining Cluster ID Using APIs

You can obtain the cluster ID by calling the API for creating a cluster.

+

The API used to obtain a cluster ID is GET https://{Endpoint}/v1.0/{project_id}/clusters. Endpoint indicates the IAM endpoint, which can be obtained from the Regions and Endpoints. For details about Project ID, see Obtaining Project ID. For details about interface authentication, see Authentication.

+

The following is an example response. The value of id under the specified clusters is the cluster ID.

+
{
+  "clusters" : [ {
+    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15",
+    "name" : "dws-1",
+    "status" : "AVAILABLE",
+    "version" : "1.2.0",
+    "updated" : "2016-02-10T14:28:14Z",
+    "created" : "2016-02-10T14:26:14Z",
+    "port" : 8000,
+    "endpoints" : [ {
+      "connect_info" : "192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "nodes" : [ {
+      "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
+      "status" : "200"
+    }, {
+      "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
+      "status" : "200"
+    }, {
+      "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
+      "status" : "200"
+    } ],
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value2"
+    } ],
+    "user_name" : "dbadmin",
+    "number_of_node" : 3,
+    "recent_event" : 6,
+    "availability_zone" : "eu-de-01",
+    "enterprise_project_id" : "0",
+    "node_type" : "dws.d1.xlarge.ultrahigh",
+    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
+    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
+    "public_ip" : {
+      "public_bind_type" : "auto_assign",
+      "eip_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
+    },
+    "public_endpoints" : [ {
+      "public_connect_info" :"192.168.0.12:8000",
+      "jdbc_url" : "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+    } ],
+    "action_progress" : {
+      "SNAPSHOTTING" : "20%"
+    },
+    "sub_status" : "READONLY",
+    "task_status" : "SNAPSHOTTING",
+    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
+  } ]
+}
+
+

Obtaining Cluster ID from DWS Console

  1. Log in to the DWS console.
  2. In the navigation pane on the left, click Clusters.
  3. In the cluster list, find the target cluster and click the cluster name. The Cluster Information page is displayed.
  4. In the Basic Information area, view the cluster ID, as shown in the following figure.

    Figure 1 Viewing the cluster ID
    +

+
diff --git a/docs/dws/api-ref/dws_02_0011.html b/docs/dws/api-ref/dws_02_0011.html index f2217e661..f889ab6d2 100644 --- a/docs/dws/api-ref/dws_02_0011.html +++ b/docs/dws/api-ref/dws_02_0011.html @@ -1,10 +1,10 @@ - + -

Obtaining a Project ID

-

Obtaining a Project ID by Calling the API

You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.

-

The API used to obtain a project ID is GET https://{Endpoint}/v3/projects/. {Endpoint} indicates the IAM endpoint and can be obtained from "Regions and Endpoints". For details about API authentication, see Authentication.

-

The following is an example response. The value of id of projects indicates the project ID.

-
{
+
Obtaining Project ID

+
Obtaining the Project ID by Calling the API
You can obtain the Project ID by calling the IAM API used to query project information based on the specified criteria.

+
The API used to obtain a Project ID is GET https://{Endpoint}/v3/projects/. {Endpoint} indicates the IAM endpoint and can be obtained from "Regions and Endpoints". For details about API authentication, see Authentication.

+
The following is an example response. id in projects indicates the Project ID.

+
{
     "projects": [
         {
             "domain_id": "65382450e8f64ac0870cd180d14e684b",
@@ -28,10 +28,10 @@
     }
 }

 

-
Obtaining a Project ID from the Console
A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:

-
  1. Log in to the management console.
  2. Click the username and select My Credential from the drop-down list.
    On the My Credential page, view the project ID in the project list.
    
+
    Obtaining the Project ID from the Console
    A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:
    
+
    1. Log in to the management console.
    2. Click the username and select My Credential from the drop-down list.
      On the My Credential page, view the Project ID in the project list.
      
 
    
-
    Figure 1 Viewing project IDs
    
+
    Figure 1 Viewing project IDs
    
 
    
 

 

diff --git a/docs/dws/api-ref/dws_02_0017.html b/docs/dws/api-ref/dws_02_0017.html
index 7adb8a1ed..7e40903bf 100644
--- a/docs/dws/api-ref/dws_02_0017.html
+++ b/docs/dws/api-ref/dws_02_0017.html
@@ -1,24 +1,61 @@
-
+
 
 
Cluster Management

-

+
    

+

 

 
 
diff --git a/docs/dws/api-ref/dws_02_0018.html b/docs/dws/api-ref/dws_02_0018.html
deleted file mode 100644
index 9bd2a6559..000000000
--- a/docs/dws/api-ref/dws_02_0018.html
+++ /dev/null
@@ -1,536 +0,0 @@
-
-
-
Querying the Cluster List

-
Function
This API is used to query and display the cluster list.

-

-
URI
GET /v1.0/{project_id}/clusters

-
-

-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

-

-

-

-
Request Parameters
None

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Response body parameters
Parameter

-
Type

-
Description

-
clusters

-
Array of ClusterInfo objects

-
List of cluster objects

-
count

-
Integer

-
Total number of cluster objects

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 ClusterInfo
Parameter

-
Type

-
Description

-
id

-
String

-
Cluster ID

-
name

-
String

-
Cluster name

-
status

-
String

-
Cluster status. The value can be one of the following:

-
  • CREATING
  • AVAILABLE
  • UNAVAILABLE
  • CREATION FAILED

-
version

-
String

-
Data warehouse version

-
updated

-
String

-
Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ

-
created

-
String

-
Cluster creation time. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ

-
port

-
Integer

-
Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

-
endpoints

-
Array of Endpoints objects

-
Private network connection information about the cluster.

-
nodes

-
Array of Nodes objects

-
Cluster instance

-
tags

-
Array of Tags object

-
Tags in a cluster

-
user_name

-
String

-
Administrator username

-
number_of_node

-
Integer

-
Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.

-
recent_event

-
Integer

-
Number of events

-
availability_zone

-
String

-
AZ

-
enterprise_project_id

-
String

-
Enterprise project ID. The value 0 indicates the ID of the default enterprise project.

-
node_type

-
String

-
Node type

-
vpc_id

-
String

-
Specifies the VPC ID.

-
subnet_id

-
String

-
Subnet ID

-
public_ip

-
PublicIp object

-
Public IP address. If the parameter is not specified, public connection is not used by default.

-
public_endpoints

-
Array of PublicEndpoints objects

-
Public network connection information about the cluster. If the parameter is not specified, the public network connection information is not used by default.

-
action_progress

-
Map<String,String>

-
Task information, consisting of a key and a value. The key indicates an ongoing task, and the value indicates the progress of the ongoing task.

-
  • Valid key values include:
    • GROWING
    • RESTORING
    • SNAPSHOTTING
    • REPAIRING
    • CREATING
    
-
  • The value indicates the task progress.

-
The following is an example:

-
"action_progress":
-{"SNAPSHOTTING":"16%"}

-
sub_status

-
String

-
Sub-status of clusters in the AVAILABLE state. The value can be one of the following:

-
  • NORMAL
  • READONLY
  • REDISTRIBUTING
  • REDISTRIBUTION-FAILURE
  • UNBALANCED
  • UNBALANCED | READONLY
  • DEGRADED
  • DEGRADED | READONLY
  • DEGRADED | UNBALANCED
  • UNBALANCED | REDISTRIBUTING
  • UNBALANCED | REDISTRIBUTION-FAILURE
  • READONLY | REDISTRIBUTION-FAILURE
  • UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
  • DEGRADED | REDISTRIBUTION-FAILURE
  • DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE
  • DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
  • DEGRADED | UNBALANCED | READONLY

-
task_status

-
String

-
Cluster management task. The value can be one of the following:

-
  • RESTORING
  • SNAPSHOTTING
  • GROWING
  • REBOOTING
  • SETTING_CONFIGURATION
  • CONFIGURING_EXT_DATASOURCE
  • DELETING_EXT_DATASOURCE
  • REBOOT_FAILURE: Restart failed
  • RESIZE_FAILURE

-
security_group_id

-
String

-
Security group ID

-
failed_reasons

-
FailedReason object

-
Cause of failure. If the parameter is left empty, the cluster is in the normal state.

-

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 Endpoints
Parameter

-
Mandatory

-
Type

-
Description

-
connect_info

-
Yes

-
String

-
Private network connection information

-
jdbc_url

-
Yes

-
String

-
JDBC URL on the private network. The following is the default format:

-
jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 Nodes
Parameter

-
Type

-
Description

-
id

-
String

-
Cluster instance ID

-
status

-
String

-
Cluster instance status

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 Tags
Parameter

-
Type

-
Description

-
value

-
String

-
Value. A value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/

-
key

-
String

-
Key. A key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain only letters, digits, hyphens (-), and underscores (_).

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 7 PublicIp
Parameter

-
Mandatory

-
Type

-
Description

-
public_bind_type

-
Yes

-
String

-
Binding type of an EIP. The value can be one of the following:

-
  • auto_assign
  • not_use
  • bind_existing

-
eip_id

-
No

-
String

-
EIP ID

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 8 PublicEndpoints
Parameter

-
Type

-
Description

-
public_connect_info

-
String

-
Public network connection information

-
jdbc_url

-
String

-
JDBC URL of the public network

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 9 FailedReason
Parameter

-
Type

-
Description

-
error_code

-
String

-
Error code

-
error_msg

-
String

-
Error message

-

-

-

-
Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters

-

-
Response example
{
-        "clusters": [
-        {
-        "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
-        "name": "dws-1",
-        "status": "AVAILABLE",
-        "version": "1.2.0",
-        "updated": "2016-02-10T14:28:14Z",
-        "created": "2016-02-10T14:26:14Z", 
-        "port": 8000,
-        "endpoints": [{
-                "connect_info": "192.168.0.12:8000",
-                "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
-            }] , 
-         "nodes" : [ {
-           "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
-           "status" : "200"
-              }, {
-           "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
-           "status" : "200"
-              }, {
-            "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
-           "status" : "200"
-            } ],
-        "tags":[ {            
-                  "key": "key1",              
-                  "value": "value1"           
-                 }, 
-                { 
-                "key": "key2",              
-                "value": "value2"            
-                }], 
-        "user_name": "dbadmin",
-        "number_of_node": 3,
-        "recent_event": 6,
-        "availability_zone": "eu-de-01",
-        "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada", 
-        "node_type":   "dws.d1.xlarge.ultrahigh",
-        "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
-        "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
-        "public_ip": {
-            "public_bind_type": "auto_assign",
-            "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
-         },
-       "public_endpoints": [{
-                "public_connect_info": "10.0.0.8:8000",
-                "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
-            }],
-        "action_progress": {"SNAPSHOTTING": "20%"},
-        "sub_status": "READONLY",
-        "task_status": "SNAPSHOTTING",
-        "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
-        }],
-       "count":"2"
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The cluster list is queried.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Cluster Management

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0019.html b/docs/dws/api-ref/dws_02_0019.html
deleted file mode 100644
index 733765d10..000000000
--- a/docs/dws/api-ref/dws_02_0019.html
+++ /dev/null
@@ -1,717 +0,0 @@
-
-
-
Querying Cluster Details

-
Function
This API is used to query cluster details.

-

-
URI
GET /v1.0/{project_id}/clusters/{cluster_id}

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

-
cluster_id

-
Yes

-
String

-
Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

-

-

-

-
Request Parameters
None

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
Table 2 Response body parameters
Parameter

-
Type

-
Description

-
cluster

-
ClusterDetail object

-
Cluster object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 ClusterDetail
Parameter

-
Type

-
Description

-
id

-
String

-
Cluster ID

-
name

-
String

-
Cluster name

-
status

-
String

-
Cluster status. The value can be one of the following:

-
  • CREATING
  • AVAILABLE
  • UNAVAILABLE
  • CREATION FAILED

-
version

-
String

-
Data warehouse version

-
updated

-
String

-
Last modification time of a cluster. Format: ISO8601:YYYY-MM-DDThh:mm:ssZ

-
created

-
String

-
Cluster creation time. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

-
port

-
Integer

-
Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

-
endpoints

-
Array of Endpoints objects

-
Private network connection information about the cluster.

-
nodes

-
Array of Nodes objects

-
Cluster instance

-
tags

-
Array of Tags objects

-
Cluster label

-
user_name

-
String

-
Username of the administrator

-
number_of_node

-
Integer

-
Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.

-
recent_event

-
Integer

-
Number of events

-
availability_zone

-
String

-
AZ

-
enterprise_project_id

-
String

-
Enterprise project ID. The value 0 indicates the ID of the default enterprise project.

-
node_type

-
String

-
Node type .

-
vpc_id

-
String

-
VPC ID

-
subnet_id

-
String

-
Subnet ID

-
public_ip

-
PublicIp object

-
Public IP address. If the parameter is not specified, public connection is not used by default.

-
public_endpoints

-
Array of PublicEndpoints objects

-
Public network connection information about the cluster. If the parameter is not specified, the public network connection information is not used by default.

-
action_progress

-
Map<String,String>

-
The key indicates an ongoing task. The value can be one of the following:

-
  • GROWING
  • RESTORING
  • SNAPSHOTTING
  • REPAIRING
  • CREATING

-
The value indicates the task progress.

-
sub_status

-
String

-
Sub-status of clusters in the AVAILABLE state. The value can be one of the following:

-
  • NORMAL
  • READONLY
  • REDISTRIBUTING
  • REDISTRIBUTION-FAILURE
  • UNBALANCED
  • UNBALANCED | READONLY
  • DEGRADED
  • DEGRADED | READONLY
  • DEGRADED | UNBALANCED
  • UNBALANCED | REDISTRIBUTING
  • UNBALANCED | REDISTRIBUTION-FAILURE
  • READONLY | REDISTRIBUTION-FAILURE
  • UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
  • DEGRADED | REDISTRIBUTION-FAILURE
  • DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE
  • DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE
  • DEGRADED | UNBALANCED | READONLY

-
task_status

-
String

-
Cluster management task. The value can be one of the following:

-
  • RESTORING
  • SNAPSHOTTING
  • GROWING
  • REBOOTING
  • SETTING_CONFIGURATION
  • CONFIGURING_EXT_DATASOURCE
  • DELETING_EXT_DATASOURCE
  • REBOOT_FAILURE
  • RESIZE_FAILURE

-
parameter_group

-
ParameterGroup object

-
Parameter group details

-
node_type_id

-
String

-
Node type ID

-
security_group_id

-
String

-
Security group ID

-
private_ip

-
Array of strings

-
List of private network IP addresses

-
maintain_window

-
MaintainWindow object

-
Cluster maintenance window

-
resize_info

-
ResizeInfo object

-
Cluster scale-out details

-
failed_reasons

-
FailedReason object

-
Cause of failure. If the parameter is left empty, the cluster is in the normal state.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 Endpoints
Parameter

-
Mandatory

-
Type

-
Description

-
connect_info

-
Yes

-
String

-
Private network connection information

-
jdbc_url

-
Yes

-
String

-
JDBC URL on the private network. The following is the default format:

-
jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 Nodes
Parameter

-
Type

-
Description

-
id

-
String

-
Cluster instance ID

-
status

-
String

-
Cluster instance status

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 Tags
Parameter

-
Type

-
Description

-
key

-
String

-
Key. A key can contain a maximum of 36 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/

-
value

-
String

-
Value. A value can contain a maximum of 43 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It can contain only letters, digits, hyphens (-), and underscores (_).

-

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 7 PublicIp
Parameter

-
Mandatory

-
Type

-
Description

-
public_bind_type

-
Yes

-
String

-
Binding type of an EIP. The value can be one of the following:

-
  • auto_assign
  • not_use
  • bind_existing

-
eip_id

-
No

-
String

-
EIP ID

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 8 PublicEndpoints
Parameter

-
Mandatory

-
Type

-
Description

-
public_connect_info

-
No

-
String

-
Public network connection information

-
jdbc_url

-
No

-
String

-
JDBC URL of the public network. The following is the default format:

-
jdbc:postgresql://< public_connect_info>/<YOUR_DATABASE_name>

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 9 ParameterGroup
Parameter

-
Mandatory

-
Type

-
Description

-
id

-
Yes

-
String

-
Parameter group ID

-
name

-
Yes

-
String

-
Parameter group name

-
status

-
Yes

-
String

-
Cluster parameter status. The value can be one of the following:

-
  • In-Sync: synchronized
  • Applying: in application
  • Pending-Reboot: restart for the modification to take effect
  • Sync-Failure: application failure

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 10 MaintainWindow
Parameter

-
Mandatory

-
Type

-
Description

-
day

-
No

-
String

-
Maintenance time in each week in the unit of day. The value can be one of the following:

-
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
  • Sun

-
start_time

-
No

-
String

-
Maintenance start time in HH:mm format. The time zone is GMT+0.

-
end_time

-
No

-
String

-
Maintenance end time in HH:mm format. The time zone is GMT+0.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 11 ResizeInfo
Parameter

-
Type

-
Description

-
target_node_num

-
Integer

-
Number of nodes after the scale-out

-
origin_node_num

-
Integer

-
Number of nodes before the scale-out

-
resize_status

-
String

-
Scale-out status. The value can be one of the following:

-
  • GROWING
  • RESIZE_FAILURE

-
start_time

-
String

-
Scale-out start time. Format: ISO8601:YYYY-MM-DDThh:mm:ss

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 12 FailedReason
Parameter

-
Type

-
Description

-
error_code

-
String

-
Error code

-
error_msg

-
String

-
Error message

-

-

-

-
Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7

-

-
Response example
{
-    "cluster": {
-        "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
-        "name": "dws-1",
-        "status": "AVAILABLE",
-        "version": "1.2.0",
-        "updated": "2018-02-10T14:28:14Z",
-        "created": "2018-02-10T14:28:14Z",
-        "port": 8000,
-        "endpoints": [{
-                "connect_info": "192.168.0.10:8000",
-                "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
-            }],
-        "nodes" : [ {
-          "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
-          "status" : "200"
-        }, {
-          "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
-          "status" : "200"
-        }, {
-          "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
-          "status" : "200"
-         } ],
-        "tags":[ { 
-                "key": "key1",              
-                "value": "value1"           
-             }, 
-            { 
-                "key": "key2",              
-                "value": "value2"            
-             } ], 
-        "user_name": "dbadmin",
-        "number_of_node": 3,
-        "recent_event": 6, 
-        "availability_zone": "eu-de-01",
-        "enterprise_project_id": "6a6a18fe-417a-4188-9214-75fd08c22065", 
-        "node_type":   "dws.m1.xlarge.ultrahigh",
-        "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
-        "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
-        "public_ip": {
-            "public_bind_type": "auto_assign",
-            "eip_id": "85b20d7e-9etypeb2a-98f3-3c8843ea3574"
-        },     
-        "public_endpoints": [ {
-                "public_connect_info": "10.0.0.8:8000",
-                "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
-            } ],
-        "action_progress": {"SNAPSHOTTING": "20%"},
-        "sub_status": "READONLY",
-        "task_status": "SNAPSHOTTING",
-        "parameter_group": {               
-           "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
-           "name": "Default-Parameter-Group-dws ",               
-           "status": "In-Sync"
-         },
-        "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
-        "private_ip":["192.168.0.12","192.168.0.66"],   
-        "maintain_window": {
-            "day": "Wed",
-            "start_time": "22:00",
-            "end_time": "02:00"
-        },
-        "resize_info" : { 
-            "target_node_num": "6",
-            "origin_node_num": "3",
-            "resize_status": "GROWING",
-            "start_time": "2018-02-14T14:28:14Z"
-           }
-    }
-} 

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
Cluster details have been queried successfully.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Cluster Management

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0020.html b/docs/dws/api-ref/dws_02_0020.html
deleted file mode 100644
index e109b3d70..000000000
--- a/docs/dws/api-ref/dws_02_0020.html
+++ /dev/null
@@ -1,378 +0,0 @@
-
-
-
Creating a Cluster

-
Function
This API is used to create clusters.

-
The cluster must run in a VPC. Before creating a cluster, you need to create a VPC and obtain the VPC and subnet IDs.

-
This API is an asynchronous API. It takes 10 to 15 minutes to create a cluster.

-

-
URI
POST /v1.0/{project_id}/clusters

-

-

-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

-

-

-

-

-
Request Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Request body parameters
Parameter

-
Mandatory

-
Type

-
Description

-
cluster

-
Yes

-
CreateClusterInfo object

-
Cluster object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 CreateClusterInfo
Parameter

-
Mandatory

-
Type

-
Description

-
node_type

-
Yes

-
String

-
Node type 

-
number_of_node

-
Yes

-
Integer

-
Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1.

-
subnet_id

-
Yes

-
String

-
Subnet ID, which is used for configuring cluster network.

-
security_group_id

-
Yes

-
String

-
ID of a security group, which is used for configuring cluster network.

-
vpc_id

-
Yes

-
String

-
VPC ID, which is used for configuring cluster network.

-
availability_zone

-
No

-
String

-
AZ of a cluster 

-
port

-
No

-
Integer

-
Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

-
name

-
Yes

-
String

-
Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
user_name

-
Yes

-
String

-
Administrator username for logging in to a GaussDB(DWS) cluster. The administrator username must:

-
  • Consist of lowercase letters, digits, or underscores.
  • Start with a lowercase letter or an underscore.
  • Contain 1 to 63 characters.
  • Cannot be a keyword of the GaussDB(DWS) database.

-
user_pwd

-
Yes

-
String

-
Administrator password for logging in to a GaussDB(DWS) cluster

-
  • Contains 12 to 32 characters.
  • Contains at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!?, .:;-_(){}[]/<>@# %^&*+|\=).
  • Cannot be the same as the username or the username written in reverse order.

-
public_ip

-
No

-
PublicIp object

-
Public IP address. If the parameter is not specified, public connection is not used by default.

-
number_of_cn

-
No

-
Integer

-
Number of deployed CNs. The value ranges from 2 to the number of cluster nodes. The maximum value is 20 and the default value is 3.

-
tags

-
No

-
Tags object

-
Label.

-
enterprise_project_id

-
No

-
String

-
Enterprise project. The default enterprise project ID is 0.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 PublicIp
Parameter

-
Mandatory

-
Type

-
Description

-
public_bind_type

-
Yes

-
String

-
Binding type of an EIP. The value can be one of the following:

-
  • auto_assign
  • not_use
  • bind_existing

-
eip_id

-
No

-
String

-
EIP ID

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 Tags
Parameter

-
Mandatory

-
Type

-
Description

-
key

-
Yes

-
String

-
Key. A tag key can contain a maximum of 128 Unicode characters, which cannot be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/

-
value

-
Yes

-
String

-
Value. A tag value can contain a maximum of 255 Unicode characters, which can be null. The first and last characters cannot be spaces. Only letters, digits, hyphens (-), and underscores (_) are allowed. It cannot contain the following characters: =*<>\,|/

-

-

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
Table 6 Response body parameters
Parameter

-
Type

-
Description

-
cluster

-
Cluster object

-
Cluster object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
Table 7 Cluster
Parameter

-
Type

-
Description

-
id

-
String

-
Cluster ID

-

-

-

-
Example Request
POST  https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters
-
-{
-"cluster": {
-        "node_type":  "dws.m1.xlarge.ultrahigh",
-        "number_of_node": 3,
-        "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
-        "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
-        "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
-        "availability_zone": "eu-de-01",
-        "port": 8000,
-        "name": "dws-1",
-        "user_name": "dbadmin",
-        "user_pwd": "Password!",
-        "public_ip": {
-            "public_bind_type": "auto_assign",
-            "eip_id": ""
-        }, 
-        "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada"     }
-}

-

-
Example Responses
{
-    "cluster": {
-        "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
-     }
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The cluster has been successfully created.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Cluster Management

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0021.html b/docs/dws/api-ref/dws_02_0021.html
deleted file mode 100644
index 09b9d5e65..000000000
--- a/docs/dws/api-ref/dws_02_0021.html
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-
Deleting a Cluster

-
Function
This API is used to delete clusters. All resources of the deleted cluster, including customer data, will be released. For data security, create a snapshot for the cluster that you want to delete before deleting the cluster.

-

-
URI
DELETE /v1.0/{project_id}/clusters/{cluster_id}

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

-
cluster_id

-
Yes

-
String

-
ID of the cluster to be deleted. For details about how to obtain the ID, see Obtaining the Cluster ID.

-

-

-

-
Request Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Request body parameters
Parameter

-
Mandatory

-
Type

-
Description

-
keep_last_manual_snapshot

-
Yes

-
Integer

-
Keeps the latest manual snapshot.

-

-

-

-
Response Parameters
None

-

-
Example Request
DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90
-
-{
-  "keep_last_manual_snapshot" : 0
-}

-

-
Example Responses
None

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
202

-
The cluster has been terminated.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Cluster Management

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0022.html b/docs/dws/api-ref/dws_02_0022.html
deleted file mode 100644
index 0d4265621..000000000
--- a/docs/dws/api-ref/dws_02_0022.html
+++ /dev/null
@@ -1,425 +0,0 @@
-
-
-
Querying the Supported Node Types

-
Function
This API is used to query the node types supported by GaussDB(DWS).

-

-
URI
GET /v2/{project_id}/node-types

-
-

-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

-

-

-

-
Request Parameters
None

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Response body parameters
Parameter

-
Type

-
Description

-
node_types

-
Array of NodeTypes objects

-
List of node type objects

-
count

-
Integer

-
Total number of node types.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 NodeTypes
Parameter

-
Type

-
Description

-
spec_name

-
String

-
Name of a node type

-
detail

-
Array of Detail objects

-
Node type details

-
id

-
String

-
Node type ID

-
datastore_type

-
String

-
Product type

-
  • dws: standard data warehouse.
    
-
  • hybrid: hybrid data warehouse.
    
-
  • stream: stream data warehouse.
    
-

-
available_zones

-
Array of NodeTypeAvailableZones objects

-
Supported AZs and their statuses

-
ram

-
Integer

-
Memory size

-
vcpus

-
Integer

-
Number of CPUs

-
datastores

-
Array of NodeTypeDatastores objects

-
Kernel version information

-
volume

-
VolumeResp object

-
For a fixed storage flavor, the value is the storage of its typical configuration. For an elastic storage flavor, the value null.

-
elastic_volume_specs

-
Array of NodeTypeElasticVolumeSpecs objects

-
If the specification is elastic, this attribute indicates the typical specification, including the storage type, minimum capacity, maximum capacity, and step. If the specification is fixed, this attribute is null.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 Detail
Parameter

-
Type

-
Description

-
type

-
String

-
Attribute type

-
value

-
String

-
Attribute value

-
unit

-
String

-
Attribute unit

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 NodeTypeAvailableZones
Parameter

-
Type

-
Description

-
code

-
String

-
AZ ID

-
status

-
String

-
Availability status of a node type.

-
  • normal: The node type is available.
    
-
  • sellout: The VM has been sold out.
    
-
  • abandon: The node type is unavailable.
    
-

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 6 NodeTypeDatastores
Parameter

-
Type

-
Description

-
version

-
String

-
OS kernel version

-
attachments

-
Attachments object

-
Additional information about the kernel version

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 7 attachments
Parameter

-
Type

-
Description

-
min_cn

-
String

-
Minimum CNs allowed by the kernel version

-
max_cn

-
String

-
Maximum CNs allowed by the kernel version

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 8 VolumeResp
Parameter

-
Type

-
Description

-
type

-
String

-
Disk type. Only SSD is supported.

-
size

-
Integer

-
Available disk capacity (GB)

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 9 NodeTypeElasticVolumeSpecs
Parameter

-
Type

-
Description

-
type

-
String

-
Cloud disk type.

-
step

-
String

-
Cloud disk size increment

-
min_size

-
Integer

-
Minimum cloud disk size

-
max_size

-
Integer

-
Maximum cloud disk size

-

-

-

-
Example Request
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/node-types

-

-
Response Example
{
-  "node_types" : [ {
-    "spec_name" : "dws.d2.xlarge",
-    "id" : "ebe532d6-665f-40e6-a4d4-3c51545b6a67",
-    "datastore_type" : "dws",
-    "available_zones" : [ {
-      "code" : "az1",
-      "status" : "normal"
-    } ],
-    "ram" : 32,
-    "vcpus" : 4,
-    "datastores" : [ {
-      "version" : "8.1.3.200",
-      "attachments" : {
-        "min_cn" : 2,
-        "max_cn" : 20
-      }
-    } ],
-    "volume" : {
-      "type" : "SSD",
-      "size" : 160
-    },
-    "elastic_volume_specs" : [ {
-      "type" : "SSD",
-      "step" : 100,
-      "min_size" : 100,
-      "max_size" : 32000
-    } ],
-    "detail" : [ {
-      "type" : "vCPU",
-      "value" : "4"
-    }, {
-      "value" : "1675",
-      "type" : "LOCAL_DISK",
-      "unit" : "GB"
-    }, {
-      "type" : "mem",
-      "value" : "32",
-      "unit" : "GB"
-    } ]
-  } ],
-  "count" : 1
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The node type is queried successfully.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Cluster Management

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0023.html b/docs/dws/api-ref/dws_02_0023.html
index 74c06a401..0599b36a5 100644
--- a/docs/dws/api-ref/dws_02_0023.html
+++ b/docs/dws/api-ref/dws_02_0023.html
@@ -1,19 +1,37 @@
-
+
 
-
Snapshot Management APIs

-
A GaussDB(DWS) snapshot is a complete backup of a cluster. Snapshots are stored in the storage space of Object Storage Service (OBS). A snapshot can be used to restore a cluster to a newly created one that has the same flavor. Currently, you can only restore a cluster to a new one.

+
Snapshot Management

+
    

 

 

 
 
diff --git a/docs/dws/api-ref/dws_02_0024.html b/docs/dws/api-ref/dws_02_0024.html
deleted file mode 100644
index 1069feff4..000000000
--- a/docs/dws/api-ref/dws_02_0024.html
+++ /dev/null
@@ -1,219 +0,0 @@
-
-
-
Querying the Snapshot List

-
Function
This API is used to query the snapshot list.

-

-
URI
GET /v1.0/{project_id}/snapshots

-
-

-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

-

-

-

-
Request Parameters
None

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Response body parameters
Parameter

-
Type

-
Description

-
snapshots

-
Array of Snapshots objects

-
List of snapshot objects

-
count

-
Integer

-
Total number of snapshot objects

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 Snapshots
Parameter

-
Type

-
Description

-
id

-
String

-
Snapshot ID

-
name

-
String

-
Snapshot name

-
description

-
String

-
Snapshot description

-
started

-
String

-
Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

-
finished

-
String

-
Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

-
size

-
Double

-
Snapshot size, in GB

-
status

-
String

-
Snapshot status:

-
  • CREATING
  • AVAILABLE
  • UNAVAILABLE

-
type

-
String

-
Snapshot type. It can be:

-
  • MANUAL
  • AUTOMATED

-
cluster_id

-
String

-
ID of the cluster for which snapshots are created. For details about how to obtain the ID, see Obtaining the Cluster ID.

-

-

-

-
Example Request
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots

-

-
Response Example
{
-    "snapshots": [
-        {
-            "id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
-            "name": "snapshot-1",
-            "description": "",
-            "started": "2016-08-23T03:59:23Z",
-            "finished": "2016-08-23T04:01:40Z", 
-            "size": 500,
-            "status": "AVAILABLE",
-            "type": "MANUAL",
-            "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
-        },
-        {
-            "id": "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
-            "name": "snapshot-2",
-            "description": "",
-            "started": "2016-08-23T18:20:00Z",
-            "finished": "2016-08-23T18:22:12Z",
-            "size": 500,
-            "status": "AVAILABLE",
-            "type": "MANUAL",
-            "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
-        }
-    ],
-       "count":2
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The snapshot list is queried.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Snapshot Management APIs

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0025.html b/docs/dws/api-ref/dws_02_0025.html
deleted file mode 100644
index 6c2de08fd..000000000
--- a/docs/dws/api-ref/dws_02_0025.html
+++ /dev/null
@@ -1,404 +0,0 @@
-
-
-
Querying Snapshot Details

-
Function
This API is used to query snapshot details by using the snapshot ID.

-

-
URI
GET /v1.0/{project_id}/snapshots/{snapshot_id}

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameter description
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

-
snapshot_id

-
Yes

-
String

-
Snapshot ID

-

-

-

-
Request Parameters
None

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
Table 2 Response body parameters
Parameter

-
Type

-
Description

-
snapshot

-
SnapshotDetail object

-
Snapshot object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 SnapshotDetail
Parameter

-
Type

-
Description

-
id

-
String

-
Snapshot ID

-
name

-
String

-
Snapshot name

-
description

-
String

-
Snapshot description

-
started

-
String

-
Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

-
finished

-
String

-
Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ

-
size

-
Double

-
Snapshot size, in GB

-
status

-
String

-
Snapshot status:

-
  • CREATING
  • AVAILABLE
  • UNAVAILABLE

-
type

-
String

-
Snapshot type. It can be:

-
  • MANUAL
  • AUTOMATED

-
cluster_id

-
String

-
ID of the cluster for which snapshots are created.

-
cluster_name

-
String

-
Name of the cluster for which the snapshot is created

-
backup_key

-
String

-
Key generated during backup

-
prior_backup_key

-
String

-
Backup key of the previous snapshot used by the incremental backup The value FULL indicates a full snapshot.

-
base_backup_key

-
String

-
Backup key of a full snapshot

-
backup_device

-
String

-
Backup media

-
total_backup_size

-
Long

-
Accumulated size of a snapshot, from the full backup to the incremental backup. Unit: KB

-
base_backup_name

-
String

-
Name of a full snapshot

-
support_inplace_restore

-
Boolean

-
Whether data can be restored to the original cluster

-
fine_grained_backup

-
Boolean

-
Whether the backup is a fine-grained backup

-
fine_grained_backup_detail

-
FineGrainedSnapshotDetail object

-
Fine-grained backup information

-
guest_agent_version

-
String

-
GuestAgent version

-
cluster_status

-
String

-
Cluster status

-
  • AVAILABLE
    
-
  • UNAVAILABLE
    
-
  • FROZEN
    
-

-
bak_expected_start_time

-
String

-
Estimated snapshot start time

-
bak_keep_day

-
Integer

-
Backup retention days

-
bak_period

-
String

-
Cluster policy

-
db_user

-
String

-
Backup user

-
datastore

-
DataStore object

-
Database version

-
progress

-
String

-
Backup progress

-
backup_level

-
String

-
Backup level

-
  • cluster
  • schema

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 FineGrainedSnapshotDetail
Parameter

-
Type

-
Description

-
database

-
String

-
Database backup

-
schema_list

-
Array of String

-
Backup schema set

-
table_list

-
Array of String

-
Backup table set

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 5 DataStore
Parameter

-
Type

-
Description

-
type

-
String

-
Database type

-
version

-
String

-
Database version

-

-

-

-
Request Message
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7

-

-
Response Message
{
-    "snapshot": {
-        "id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
-        "name": "snapshot-1",
-        "description": "snapshot description",
-        "started": "2016-08-23T03:59:23Z",
-        "finished": "2016-08-23T04:01:40Z", 
-        "size": 500,
-        "status": "AVAILABLE",
-        "type": "MANUAL",
-        "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
-    }
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The snapshot details are queried.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Snapshot Management APIs

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0026.html b/docs/dws/api-ref/dws_02_0026.html
index cdc29df44..c7d576ffb 100644
--- a/docs/dws/api-ref/dws_02_0026.html
+++ b/docs/dws/api-ref/dws_02_0026.html
@@ -1,203 +1,56 @@
-
+
 
-
Creating a Snapshot

-
Function
This API is used to create snapshots for a specified cluster.

-

-
URI
POST /v1.0/{project_id}/snapshots

-
-

-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

-

-

-

-
Request Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Request body parameters
Parameter

-
Mandatory

-
Type

-
Description

-
snapshot

-
Yes

-
Snapshot object

-
Snapshot object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 Snapshot
Parameter

-
Mandatory

-
Type

-
Description

-
name

-
Yes

-
String

-
Snapshot name, which must be unique and start with a letter. It consists of 4 to 64 characters, which are case-insensitive and contain letters, digits, hyphens (-), and underscores (_) only.

-
cluster_id

-
Yes

-
String

-
ID of the cluster for which you want to create a snapshot. For details about how to obtain the ID, see Obtaining the Cluster ID.

-
description

-
No

-
String

-
Snapshot description. If no value is specified, the description is empty. Enter a maximum of 256 characters. The following special characters are not allowed: !<>'=&"

-

-

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
Table 4 Response body parameters
Parameter

-
Type

-
Description

-
snapshot

-
SnapshotResp object

-
Snapshot object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
Table 5 SnapshotResp
Parameter

-
Type

-
Description

-
id

-
String

-
Snapshot ID

-

-

-

-
Example Request
POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots
-
-{
-  "snapshot" : {
-    "name" : "snapshot-3",
-    "cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7",
-    "description" : "Snapshot-3 description"
-  }
-}

-

-
Example Response
{
-    "snapshot": {
-        "id": "2a4d0f86-67cd-408a-8b66-017454fb7793"
-    }
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The snapshot is created.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

+
Node Change

+
    

 

 

+
+
 

-
Parent topic: Snapshot Management APIs

+
Parent topic: API Description

 

 

 
diff --git a/docs/dws/api-ref/dws_02_0027.html b/docs/dws/api-ref/dws_02_0027.html
deleted file mode 100644
index 7b5c077ef..000000000
--- a/docs/dws/api-ref/dws_02_0027.html
+++ /dev/null
@@ -1,100 +0,0 @@
-
-
-
Deleting a Manual Snapshot

-
Function
This API is used to delete a specified manual snapshot.

-

-
URI
DELETE /v1.0/{project_id}/snapshots/{snapshot_id}

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameter description
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

-
snapshot_id

-
Yes

-
String

-
Snapshot ID

-

-

-

-
Request Parameters
None

-

-
Response Parameters
None

-

-
Example Requests
DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90

-

-
Example Response
None

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
202

-
The snapshot is deleted.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-

-

-

-
Parent topic: Snapshot Management APIs

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0030.html b/docs/dws/api-ref/dws_02_0030.html
index 3c1e2db83..a057c5e23 100644
--- a/docs/dws/api-ref/dws_02_0030.html
+++ b/docs/dws/api-ref/dws_02_0030.html
@@ -1,1196 +1,1196 @@
-
+
 
 
Error Code

-
No data is returned if an API fails to be called. You can locate the cause of error according to the error code of each API. When the calling fails, HTTP status code 4xx or 5xx is returned. The returned message body contains the specific error code and error information. If you fail to locate the cause of error, contact the database customer service and technical support and provide the error code so that we can help you solve the problem as soon as possible.

+
No data is returned if an API fails to be called. You can locate the cause of error according to the error code of each API. When the calling fails, HTTP status code 4xx or 5xx is returned. The returned message body contains the specific error code and error information. If you fail to locate the cause of error, contact the database customer service and technical support and provide the error code so that we can help you solve the problem as soon as possible.

 
-
Table 1 Error code
Status Code

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0031.html b/docs/dws/api-ref/dws_02_0031.html
index 4805c7a9a..2771df29b 100644
--- a/docs/dws/api-ref/dws_02_0031.html
+++ b/docs/dws/api-ref/dws_02_0031.html
@@ -1,153 +1,165 @@
-
+
Change History

-
Table 1 Error code
Status Code

 
Error Code

+
Error Code

 
Error Information

+
Error Information

 
Description

+
Description

 
Solution

+
Solution

 		
 

 
400

+
400

 
DWS.5001

+
DWS.5001

 
Invalid instance name.

+
Invalid instance name.

 
Invalid instance name.

+
Invalid instance name.

 
Enter a valid instance name according to the instance name description and try again later.

+
Enter a valid instance name according to the instance name description and try again later.

 		
 
400

+
400

 
DWS.5002

+
DWS.5002

 
Invalid database type.

+
Invalid database type.

 
Invalid database type.

+
Invalid database type.

 
Enter a valid database type according to the database parameter description and try again later.

+
Enter a valid database type according to the database parameter description and try again later.

 		
 
400

+
400

 
DWS.5003

+
DWS.5003

 
Invalid database version.

+
Invalid database version.

 
Invalid database version.

+
Invalid database version.

 
Enter a valid database version according to the database parameter description and try again later.

+
Enter a valid database version according to the database parameter description and try again later.

 		
 
400

+
400

 
DWS.5004

+
DWS.5004

 
Empty datastore field.

+
Empty datastore field.

 
Empty datastore field.

+
Empty datastore field.

 
Enter the correct datastore according to the actual situation and try again later.

+
Enter the correct datastore according to the actual situation and try again later.

 		
 
400

+
400

 
DWS.5005

+
DWS.5005

 
Database type or version not supported.

+
Database type or version not supported.

 
Database type or version not supported.

+
Database type or version not supported.

 
Enter a valid database type and version according to the database parameter description and try again later.

+
Enter a valid database type and version according to the database parameter description and try again later.

 		
 
400

+
400

 
DWS.5006

+
DWS.5006

 
Invalid specifications.

+
Invalid specifications.

 
Invalid specifications.

+
Invalid specifications.

 
Select the correct flavor and try again later.

+
Select the correct flavor and try again later.

 		
 
400

+
400

 
DWS.5010

+
DWS.5010

 
Invalid region.

+
Invalid region.

 
Invalid region.

+
Invalid region.

 
Select a valid region and try again.

+
Select a valid region and try again.

 		
 
400

+
400

 
DWS.5011

+
DWS.5011

 
Invalid AZ.

+
Invalid AZ.

 
Invalid AZ.

+
Invalid AZ.

 
Select a valid AZ and try again.

+
Select a valid AZ and try again.

 		
 
400

+
400

 
DWS.5012

+
DWS.5012

 
The region or AZ does not exist.

+
The region or AZ does not exist.

 
The region or AZ does not exist.

+
The region or AZ does not exist.

 
Enter a correct region or AZ and try again later.

+
Enter a correct region or AZ and try again later.

 		
 
400

+
400

 
DWS.5013

+
DWS.5013

 
Invalid password of database root.

+
Invalid password of database root.

 
Invalid password of database root.

+
Invalid password of database root.

 
Enter a valid password according to the password description.

+
Enter a valid password according to the password description.

 		
 
400

+
400

 
DWS.5014

+
DWS.5014

 
Invalid VPC ID.

+
Invalid VPC ID.

 
Invalid VPC ID.

+
Invalid VPC ID.

 
Enter a valid ID according to the description of parameter vpc_id.

+
Enter a valid ID according to the description of parameter vpc_id.

 		
 
400

+
400

 
DWS.5015

+
DWS.5015

 
Invalid subnet ID.

+
Invalid subnet ID.

 
Invalid subnet ID.

+
Invalid subnet ID.

 
Enter a valid ID according to the description of parameter subnet_id.

+
Enter a valid ID according to the description of parameter subnet_id.

 		
 
400

+
400

 
DWS.5016

+
DWS.5016

 
Invalid security group ID.

+
Invalid security group ID.

 
Invalid security group ID.

+
Invalid security group ID.

 
Enter a valid ID according to the description of the security group ID parameter.

+
Enter a valid ID according to the description of the security group ID parameter.

 		
 
400

+
400

 
DWS.5017

+
DWS.5017

 
Invalid retention period of automated backups.

+
Invalid retention period of automated backups.

 
Invalid retention period of automated backups.

+
Invalid retention period of automated backups.

 
Enter a proper retention period and try again later.

+
Enter a proper retention period and try again later.

 		
 
400

+
400

 
DWS.5018

+
DWS.5018

 
Invalid automated backup period.

+
Invalid automated backup period.

 
Invalid automated backup period.

+
Invalid automated backup period.

 
Enter a proper automated backup period and try again later.

+
Enter a proper automated backup period and try again later.

 		
 
404

+
404

 
DWS.5021

+
DWS.5021

 
The VPC does not exist or does not belong to the user.

+
The VPC does not exist or does not belong to the user.

 
The VPC does not exist or does not belong to the user.

+
The VPC does not exist or does not belong to the user.

 
Enter a correct VPC and try again later.

+
Enter a correct VPC and try again later.

 		
 
404

+
404

 
DWS.5022

+
DWS.5022

 
The subnet does not exist or does not belong to the VPC.

+
The subnet does not exist or does not belong to the VPC.

 
The subnet does not exist or does not belong to the VPC.

+
The subnet does not exist or does not belong to the VPC.

 
Enter a correct subnet and try again later.

+
Enter a correct subnet and try again later.

 		
 
404

+
404

 
DWS.5023

+
DWS.5023

 
The security group does not exist or does not belong to the VPC.

+
The security group does not exist or does not belong to the VPC.

 
The security group does not exist or does not belong to the VPC.

+
The security group does not exist or does not belong to the VPC.

 
Enter a correct security group and try again later.

+
Enter a correct security group and try again later.

 		
 
400

+
400

 
DWS.5027

+
DWS.5027

 
Invalid AZ.

+
Invalid AZ.

 
Invalid AZ.

+
Invalid AZ.

 
Enter a correct AZ and try again later.

+
Enter a correct AZ and try again later.

 		
 
400

+
400

 
DWS.5033

+
DWS.5033

 
The volume size is not a multiple of 10.

+
The volume size is not a multiple of 10.

 
The volume size is not a multiple of 10.

+
The volume size is not a multiple of 10.

 
Enter a valid size and try again.

+
Enter a valid size and try again.

 		
 
400

+
400

 
DWS.5034

+
DWS.5034

 
Flavors do not match.

+
Flavors do not match.

 
Flavors do not match.

+
Flavors do not match.

 
Select a correct flavor and try again.

+
Select a correct flavor and try again.

 		
 
403

+
403

 
DWS.5036

+
DWS.5036

 
Datastore does not exist or does not have sufficient permissions.

+
Datastore does not exist or does not have sufficient permissions.

 
Datastore does not exist or does not have sufficient permissions.

+
Datastore does not exist or does not have sufficient permissions.

 
Enter a correct Datastore and try again.

+
Enter a correct Datastore and try again.

 		
 
400

+
400

 
DWS.5037

+
DWS.5037

 
The parameter does not exist.

+
The parameter does not exist.

 
The parameter does not exist.

+
The parameter does not exist.

 
Enter the correct parameter group and try again.

+
Enter a valid parameter and try again.

 		
 
400

+
400

 
DWS.5038

+
DWS.5038

 
The parameter value is out of range.

+
The parameter value is out of range.

 
The parameter value is out of range.

+
The parameter value is out of range.

 
Enter a valid parameter and try again.

+
Enter a valid parameter and try again.

 		
 
400

+
400

 
DWS.5039

+
DWS.5039

 
Duplicate parameters.

+
Duplicate parameters.

 
Duplicate parameters.

+
Duplicate parameters.

 
Enter a valid parameter and try again.

+
Enter a valid parameter and try again.

 		
 
400

+
400

 
DWS.5045

+
DWS.5045

 
The current tenant is not allowed to perform this operation.

+
The current tenant is not allowed to perform this operation.

 
The current tenant is not allowed to perform this operation.

+
The current tenant is not allowed to perform this operation.

 
Ensure that the current tenant is the same as the tenant to which the cluster belongs and try again.

+
Ensure that the current tenant is the same as the tenant to which the cluster belongs and try again.

 		
 
400

+
400

 
DWS.5046

+
DWS.5046

 
nics is left black.

+
nics is left black.

 
nics is left black.

+
nics is left black.

 
Enter a correct nics and try again.

+
Enter a correct nics and try again.

 		
 
400

+
400

 
DWS.5047

+
DWS.5047

 
Invalid instance quantity.

+
Invalid instance quantity.

 
Invalid instance quantity.

+
Invalid instance quantity.

 
Enter a correct instance quantity.

+
Enter a correct instance quantity.

 		
 
400

+
400

 
DWS.5048

+
DWS.5048

 
Invalid extended parameter.

+
Invalid extended parameter.

 
Invalid extended parameter.

+
Invalid extended parameter.

 
Enter a valid extended parameter according to the corresponding description of the extended parameter.

+
Enter a valid extended parameter according to the corresponding description of the extended parameter.

 		
 
409

+
409

 
DWS.5050

+
DWS.5050

 
The cluster name already exists.

+
The cluster name already exists.

 
The cluster name already exists.

+
The cluster name already exists.

 
Enter a correct cluster name and try again later.

+
Enter a correct cluster name and try again later.

 		
 
400

+
400

 
DWS.5051

+
DWS.5051

 
Invalid IP address.

+
Invalid IP address.

 
Invalid IP address.

+
Invalid IP address.

 
Enter a valid IP address and try again.

+
Enter a valid IP address and try again.

 		
 
400

+
400

 
DWS.5052

+
DWS.5052

 
Invalid value of the AZ.

+
Invalid value of the AZ.

 
Invalid value of the AZ.

+
Invalid value of the AZ.

 
Enter a correct AZ and try again later.

+
Enter a correct AZ and try again later.

 		
 
400

+
400

 
DWS.5053

+
DWS.5053

 
The value of locality between instances is invalid.

+
The value of locality between instances is invalid.

 
The value of locality between instances is invalid.

+
The value of locality between instances is invalid.

 
Enter a correct locality value and try again later.

+
Enter a correct locality value and try again later.

 		
 
400

+
400

 
DWS.5054

+
DWS.5054

 
The parameter group ID is invalid.

+
The parameter group ID is invalid.

 
The parameter group ID is invalid.

+
The parameter group ID is invalid.

 
Enter a correct parameter group ID and try again later.

+
Enter a correct parameter group ID and try again later.

 		
 
400

+
400

 
DWS.5056

+
DWS.5056

 
Invalid string length.

+
Invalid string length.

 
Invalid string length.

+
Invalid string length.

 
Enter a valid string and try again.

+
Enter a valid string and try again.

 		
 
400

+
400

 
DWS.5057

+
DWS.5057

 
The cluster name pattern is invalid.

+
The cluster name pattern is invalid.

 
The cluster name pattern is invalid.

+
The cluster name pattern is invalid.

 
Enter a valid cluster name according to the cluster name description.

+
Enter a valid cluster name according to the cluster name description.

 		
 
400

+
400

 
DWS.5059

+
DWS.5059

 
Database username contains invalid characters.

+
Database username contains invalid characters.

 
Database username contains invalid characters.

+
Database username contains invalid characters.

 
Enter a valid database username according to the database username description.

+
Enter a valid database username according to the database username description.

 		
 
400

+
400

 
DWS.5060

+
DWS.5060

 
Integer type is of wrong range.

+
Integer type is of wrong range.

 
Integer type is of wrong range.

+
Integer type is of wrong range.

 
Enter a valid Integer type and try again later.

+
Enter a valid Integer type and try again later.

 		
 
400

+
400

 
DWS.5061

+
DWS.5061

 
The volume type is illegal.

+
The volume type is illegal.

 
The volume type is illegal.

+
The volume type is illegal.

 
Enter a valid volume type and try again later.

+
Enter a valid volume type and try again later.

 		
 
400

+
400

 
DWS.5062

+
DWS.5062

 
The volume tag is illegal.

+
The volume tag is illegal.

 
The volume tag is illegal.

+
The volume tag is illegal.

 
Enter a valid volume tag and try again later.

+
Enter a valid volume tag and try again later.

 		
 
400

+
400

 
DWS.5063

+
DWS.5063

 
Invalid Specific field.

+
Invalid Specific field.

 
Invalid Specific field.

+
Invalid Specific field.

 
Enter a correct Specific value and try again later.

+
Enter a correct Specific value and try again later.

 		
 
400

+
400

 
DWS.5064

+
DWS.5064

 
Invalid UUID.

+
Invalid UUID.

 
Invalid UUID.

+
Invalid UUID.

 
Enter a valid UUID and try again.

+
Enter a valid UUID and try again.

 		
 
400

+
400

 
DWS.5065

+
DWS.5065

 
Invalid format.

+
Invalid format.

 
Invalid format.

+
Invalid format.

 
Use a valid format and try again.

+
Use a valid format and try again.

 		
 
400

+
400

 
DWS.5070

+
DWS.5070

 
Flavor ref is invalid in xml.

+
Flavor ref is invalid in xml.

 
Flavor ref is invalid in xml.

+
Flavor ref is invalid in xml.

 
Enter correct flavor ref and try again later.

+
Enter correct flavor ref and try again later.

 		
 
400

+
400

 
DWS.5071

+
DWS.5071

 
The volume type is invalid in XML.

+
The volume type is invalid in XML.

 
The volume type is invalid in XML.

+
The volume type is invalid in XML.

 
Enter a correct disk type and try again later.

+
Enter a correct disk type and try again later.

 		
 
400

+
400

 
DWS.5078

+
DWS.5078

 
Invalid disk size.

+
Invalid disk size.

 
Invalid disk size.

+
Invalid disk size.

 
Enter a valid disk size and try again later.

+
Enter a valid disk size and try again later.

 		
 
400

+
400

 
DWS.5079

+
DWS.5079

 
The backup period is not permitted.

+
The backup period is not permitted.

 
The backup period is not permitted.

+
The backup period is not permitted.

 
Enter a proper backup period and try again later.

+
Enter a proper backup period and try again later.

 		
 
400

+
400

 
DWS.5080

+
DWS.5080

 
The backup retention period is not permitted.

+
The backup retention period is not permitted.

 
The backup retention period is not permitted.

+
The backup retention period is not permitted.

 
Enter a proper backup retention duration and try again later.

+
Enter a proper backup retention duration and try again later.

 		
 
400

+
400

 
DWS.5081

+
DWS.5081

 
The instance disk type is not allowed.

+
The instance disk type is not allowed.

 
The instance disk type is not allowed.

+
The instance disk type is not allowed.

 
Select a valid instance type and try again.

+
Select a valid instance type and try again.

 		
 
400

+
400

 
DWS.5082

+
DWS.5082

 
The database user name is not supported.

+
The database user name is not supported.

 
The database user name is not supported.

+
The database user name is not supported.

 
Enter a valid database username according to the database username description.

+
Enter a valid database username according to the database username description.

 		
 
400

+
400

 
DWS.5083

+
DWS.5083

 
Invalid affinity in the XML configuration.

+
Invalid affinity in the XML configuration.

 
Invalid affinity in the XML configuration.

+
Invalid affinity in the XML configuration.

 
Enter a valid affinity value and try again.

+
Enter a valid affinity value and try again.

 		
 
400

+
400

 
DWS.5084

+
DWS.5084

 
Incorrect volume configuration in the XML file.

+
Incorrect volume configuration in the XML file.

 
Incorrect volume configuration in the XML file.

+
Incorrect volume configuration in the XML file.

 
Enter a correct volume value and try again later.

+
Enter a correct volume value and try again later.

 		
 
400

+
400

 
DWS.5086

+
DWS.5086

 
The same instance type does not meet flavor consistency requirements.

+
The same instance type does not meet flavor consistency requirements.

 
The same instance type does not meet flavor consistency requirements.

+
The same instance type does not meet flavor consistency requirements.

 
Enter the correct flavor and try again later.

+
Enter the correct flavor and try again later.

 		
 
400

+
400

 
DWS.5087

+
DWS.5087

 
The same instance type does not meet disk consistency requirements.

+
The same instance type does not meet disk consistency requirements.

 
The same instance type does not meet disk consistency requirements.

+
The same instance type does not meet disk consistency requirements.

 
Enter a correct disk and try again later.

+
Enter a correct disk and try again later.

 		
 
400

+
400

 
DWS.5089

+
DWS.5089

 
Unsupported type.

+
Unsupported type.

 
Unsupported type.

+
Unsupported type.

 
Enter a supported type and try again.

+
Enter a supported type and try again.

 		
 
400

+
400

 
DWS.5091

+
DWS.5091

 
The number of nodes has reached the maximum.

+
The number of nodes has reached the maximum.

 
The number of nodes has reached the maximum.

+
The number of nodes has reached the maximum.

 
Enter a valid node quantity and try again.

+
Enter a valid node quantity and try again.

 		
 
400

+
400

 
DWS.5093

+
DWS.5093

 
Flavor information is invalid.

+
Flavor information is invalid.

 
Flavor information is invalid.

+
Flavor information is invalid.

 
Enter valid flavor information and try again later.

+
Enter valid flavor information and try again later.

 		
 
400

+
400

 
DWS.5095

+
DWS.5095

 
The current instance type does not support this operation.

+
The current instance type does not support this operation.

 
The current instance type does not support this operation.

+
The current instance type does not support this operation.

 
Select a correct instance type and try again.

+
Select a correct instance type and try again.

 		
 
400

+
400

 
DWS.5096

+
DWS.5096

 
Invalid disk quantity.

+
Invalid disk quantity.

 
Invalid disk quantity.

+
Invalid disk quantity.

 
Enter valid disk quantity and try again later.

+
Enter valid disk quantity and try again later.

 		
 
400

+
400

 
DWS.5097

+
DWS.5097

 
Region or AZ does not exist.

+
Region or AZ does not exist.

 
Region or AZ does not exist.

+
Region or AZ does not exist.

 
Enter a correct region or AZ and try again later.

+
Enter a correct region or AZ and try again later.

 		
 
400

+
400

 
DWS.5098

+
DWS.5098

 
Invalid EIP binding type.

+
Invalid EIP binding type.

 
Invalid EIP binding type.

+
Invalid EIP binding type.

 
Enter a correct EIP binding type and try again later.

+
Enter a correct EIP binding type and try again later.

 		
 
400

+
400

 
DWS.5104

+
DWS.5104

 
The subnet of an instance must be unique.

+
The subnet of an instance must be unique.

 
The subnet of an instance must be unique.

+
The subnet of an instance must be unique.

 
Ensure that the subnet of the instance is unique and try again.

+
Ensure that the subnet of the instance is unique and try again.

 		
 
400

+
400

 
DWS.5106

+
DWS.5106

 
Invalid instance type.

+
Invalid instance type.

 
Invalid instance type.

+
Invalid instance type.

 
Enter a valid instance type and try again later.

+
Enter a valid instance type and try again later.

 		
 
400

+
400

 
DWS.5107

+
DWS.5107

 
Invalid cluster mode.

+
Invalid cluster mode.

 
Invalid cluster mode.

+
Invalid cluster mode.

 
Enter a valid disk mode and try again later.

+
Enter a valid disk mode and try again later.

 		
 
400

+
400

 
DWS.5111

+
DWS.5111

 
The backup file ID does not exist.

+
The backup file ID does not exist.

 
The backup file ID does not exist.

+
The backup file ID does not exist.

 
Enter a correct backup file ID and try again later.

+
Enter a correct backup file ID and try again later.

 		
 
400

+
400

 
DWS.5130

+
DWS.5130

 
Invalid agency name.

+
Invalid agency name.

 
Invalid agency name.

+
Invalid agency name.

 
Enter a valid agency name and then try again.

+
Enter a valid agency name and then try again.

 		
 
400

+
400

 
DWS.5133

+
DWS.5133

 
Invalid EIP ID.

+
Invalid EIP ID.

 
Invalid EIP ID.

+
Invalid EIP ID.

 
Enter a valid EIP ID and try again.

+
Enter a valid EIP ID and try again.

 		
 
400

+
400

 
DWS.5135

+
DWS.5135

 
The EIP does not exist.

+
The EIP does not exist.

 
The EIP does not exist.

+
The EIP does not exist.

 
Enter a valid EIP and try again.

+
Enter a valid EIP and try again.

 		
 
400

+
400

 
DWS.5144

+
DWS.5144

 
Invalid password of the cluster administrator.

+
Invalid password of the cluster administrator.

 
Invalid password of the cluster administrator.

+
Invalid password of the cluster administrator.

 
Enter a valid cluster administrator password according to the description of the cluster administrator's password.

+
Enter a valid cluster administrator password according to the description of the cluster administrator's password.

 		
 
400

+
400

 
DWS.5145

+
DWS.5145

 
The cluster administrator password cannot contain the username, or the username spelled backwards.

+
The cluster administrator password cannot contain the username, or the username spelled backwards.

 
The cluster administrator password cannot contain the username, or the username spelled backwards.

+
The cluster administrator password cannot contain the username, or the username spelled backwards.

 
Enter a valid cluster administrator password as prompted and try again later.

+
Enter a valid cluster administrator password as prompted and try again later.

 		
 
400

+
400

 
DWS.5146

+
DWS.5146

 
The ECS group parameter is missing.

+
The ECS group parameter is missing.

 
The ECS group parameters are missing.

+
The ECS group parameters are missing.

 
Enter a valid parameter and try again.

+
Enter a valid parameter and try again.

 		
 
400

+
400

 
DWS.5147

+
DWS.5147

 
Invalid ECS group parameter.

+
Invalid ECS group parameter.

 
Invalid ECS group parameter.

+
Invalid ECS group parameter.

 
Enter a valid parameter and try again.

+
Enter a valid parameter and try again.

 		
 
400

+
400

 
DWS.5148

+
DWS.5148

 
The number of ECS groups has reached the upper limit.

+
The number of ECS groups has reached the upper limit.

 
The number of ECS groups has reached the upper limit.

+
The number of ECS groups has reached the upper limit.

 
Enter a valid ECS group quantity and try again.

+
Enter a valid ECS group quantity and try again.

 		
 
400

+
400

 
DWS.5149

+
DWS.5149

 
The snapshot ID is invalid.

+
The snapshot ID is invalid.

 
The snapshot ID is invalid.

+
The snapshot ID is invalid.

 
Enter a valid snapshot ID according to the snapshot ID description.

+
Enter a valid snapshot ID according to the snapshot ID description.

 		
 
400

+
400

 
DWS.5165

+
DWS.5165

 
Invalid null content in the data file.

+
Invalid null content in the data file.

 
Invalid null content in the data file.

+
Invalid null content in the data file.

 
Enter the correct control content and try again later.

+
Enter the correct control content and try again later.

 		
 
400

+
400

 
DWS.5166

+
DWS.5166

 
Invalid noescaping parameter in text format

+
Invalid noescaping parameter in text format

 
Invalid noescaping parameter in text format

+
Invalid noescaping parameter in text format

 
Enter the correct noescaping parameter and try again later.

+
Enter the correct noescaping parameter and try again later.

 		
 
400

+
400

 
DWS.5167

+
DWS.5167

 
Invalid header parameter in the data file. The supported values are true/on and false/off.

+
Invalid header parameter in the data file. The supported values are true/on and false/off.

 
Invalid header parameter in the data file. The supported values are true/on and false/off.

+
Invalid header parameter in the data file. The supported values are true/on and false/off.

 
Enter the correct header parameter and try again later.

+
Enter the correct header parameter and try again later.

 		
 
400

+
400

 
DWS.5168

+
DWS.5168

 
Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.

+
Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.

 
Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.

+
Invalid fill_missing_fields parameter in the data file. The supported values are true/on and false/off.

 
Enter the correct fill_missing_fields parameter and try again later.

+
Enter the correct fill_missing_fields parameter and try again later.

 		
 
400

+
400

 
DWS.5169

+
DWS.5169

 
Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.

+
Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.

 
Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.

+
Invalid ignore_extra_data parameter in the data file. The supported values are true/on and false/off.

 
Enter the correct ignore_extra_data parameter and try again later.

+
Enter the correct ignore_extra_data parameter and try again later.

 		
 
400

+
400

 
DWS.5170

+
DWS.5170

 
Invalid number of incorrect data formats during data import.

+
Invalid number of incorrect data formats during data import.

 
Invalid number of incorrect data formats during data import.

+
Invalid number of incorrect data formats during data import.

 
Enter the correct number of incorrect data formats and try again later.

+
Enter the correct number of incorrect data formats and try again later.

 		
 
400

+
400

 
DWS.5171

+
DWS.5171

 
Invalid username or password for logging in to the database.

+
Invalid username or password for logging in to the database.

 
Invalid username or password for logging in to the database.

+
Invalid username or password for logging in to the database.

 
Enter the correct username or password and try again later.

+
Enter the correct username or password and try again later.

 		
 
400

+
400

 
DWS.5172

+
DWS.5172

 
The database does not exist.

+
The database does not exist.

 
The database does not exist.

+
The database does not exist.

 
Enter the correct database name and try again later.

+
Enter the correct database name and try again later.

 		
 
400

+
400

 
DWS.5173

+
DWS.5173

 
The schema where the database table resides does not exist.

+
The schema where the database table resides does not exist.

 
The schema where the database table resides does not exist.

+
The schema where the database table resides does not exist.

 
Enter a correct schema and try again later.

+
Enter a correct schema and try again later.

 		
 
400

+
400

 
DWS.5174

+
DWS.5174

 
The database table does not exist.

+
The database table does not exist.

 
The database table does not exist.

+
The database table does not exist.

 
Enter the correct database table and try again later.

+
Enter the correct database table and try again later.

 		
 
400

+
400

 
DWS.5175

+
DWS.5175

 
The database username cannot be blank.

+
The database username cannot be blank.

 
The database username cannot be blank.

+
The database username cannot be blank.

 
Enter the username and try again later.

+
Enter the username and try again later.

 		
 
400

+
400

 
DWS.5176

+
DWS.5176

 
The password corresponding to the database username cannot be blank.

+
The password corresponding to the database username cannot be blank.

 
The password corresponding to the database username cannot be blank.

+
The password corresponding to the database username cannot be blank.

 
Enter the password and try again later.

+
Enter the password and try again later.

 		
 
400

+
400

 
DWS.5177

+
DWS.5177

 
Name of the database where the table to which data is loaded is located cannot be blank.

+
Name of the database where the table to which data is loaded is located cannot be blank.

 
Name of the database where the table to which data is loaded is located cannot be blank.

+
Name of the database where the table to which data is loaded is located cannot be blank.

 
Enter the database name and try again later.

+
Enter the database name and try again later.

 		
 
400

+
400

 
DWS.5178

+
DWS.5178

 
Schema where the table to which data is loaded is located cannot be blank.

+
Schema where the table to which data is loaded is located cannot be blank.

 
Schema where the table to which data is loaded is located cannot be blank.

+
Schema where the table to which data is loaded is located cannot be blank.

 
Enter the schema and try again later.

+
Enter the schema and try again later.

 		
 
400

+
400

 
DWS.5179

+
DWS.5179

 
Database table to which data is loaded cannot be blank.

+
Database table to which data is loaded cannot be blank.

 
Database table to which data is loaded cannot be blank.

+
Database table to which data is loaded cannot be blank.

 
Enter the database table and try again later.

+
Enter the database table and try again later.

 		
 
400

+
400

 
DWS.5180

+
DWS.5180

 
Invalid path for OBS file loading.

+
Invalid path for OBS file loading.

 
Invalid path for OBS file loading.

+
Invalid path for OBS file loading.

 
Enter a correct OBS loading path and try again later.

+
Enter a correct OBS loading path and try again later.

 		
 
400

+
400

 
DWS.5181

+
DWS.5181

 
Failed to load data. The error information is #failedReason#.

+
Failed to load data. The error information is #failedReason#.

 
Failed to load data. The error information is #failedReason#.

+
Failed to load data. The error information is #failedReason#.

 
Rectify the fault according to the error information and try again later.

+
Rectify the fault according to the error information and try again later.

 		
 
400

+
400

 
DWS.5182

+
DWS.5182

 
The current job is stopped.

+
The current job is stopped.

 
The current job is stopped.

+
The current job is stopped.

 
Select a loading job and cancel it.

+
Select a loading job and cancel it.

 		
 
400

+
400

 
DWS.5183

+
DWS.5183

 
The current job has been canceled.

+
The current job has been canceled.

 
The current job has been canceled.

+
The current job has been canceled.

 
Select a loading job and cancel it.

+
Select a loading job and cancel it.

 		
 
400

+
400

 
DWS.5184

+
DWS.5184

 
Invalid format of the data source file. The supported file formats are CSV and TEXT.

+
Invalid format of the data source file. The supported file formats are CSV and TEXT.

 
Invalid format of the data source file. The supported file formats are CSV and TEXT.

+
Invalid format of the data source file. The supported file formats are CSV and TEXT.

 
Enter a correct data source file format and try again later. The supported file formats are CSV and TEXT.

+
Enter a correct data source file format and try again later. The supported file formats are CSV and TEXT.

 		
 
400

+
400

 
DWS.5185

+
DWS.5185

 
Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.

+
Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.

 
Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.

+
Invalid encoding format of the data file. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.

 
Enter a correct encoding format and try again later. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.

+
Enter a correct encoding format and try again later. The supported file formats are GBK, UTF8, Latin1, and SQL_ASCII.

 		
 
400

+
400

 
DWS.5186

+
DWS.5186

 
Invalid field delimiter of row data in a data source file.

+
Invalid field delimiter of row data in a data source file.

 
Invalid field delimiter of row data in a data source file.

+
Invalid field delimiter of row data in a data source file.

 
Enter a correct field delimiter and try again later.

+
Enter a correct field delimiter and try again later.

 		
 
400

+
400

 
DWS.5187

+
DWS.5187

 
Invalid quote character for a CSV file.

+
Invalid quote character for a CSV file.

 
Invalid quote character for a CSV file.

+
Invalid quote character for a CSV file.

 
Enter a correct quote character and try again later.

+
Enter a correct quote character and try again later.

 		
 
400

+
400

 
DWS.5189

+
DWS.5189

 
Failed to obtain the AK/SK.

+
Failed to obtain the AK/SK.

 
Failed to obtain the AK/SK.

+
Failed to obtain the AK/SK.

 
Contact the database customer service or try again later.

+
Contact the database customer service or try again later.

 		
 
400

+
400

 
DWS.5191

+
DWS.5191

 
The tag does not exist.

+
The tag does not exist.

 
The tag does not exist.

+
The tag does not exist.

 
Enter the correct tag and try again later.

+
Enter the correct tag and try again later.

 		
 
400

+
400

 
DWS.5194

+
DWS.5194

 
The number of tags exceeds the maximum value.

+
The number of tags exceeds the maximum value.

 
The number of tags exceeds the maximum value.

+
The number of tags exceeds the maximum value.

 
Verify the number of tags for the resource and try again later.

+
Verify the number of tags for the resource and try again later.

 		
 
400

+
400

 
DWS.5197

+
DWS.5197

 
The tag is invalid.

+
The tag is invalid.

 
The tag is invalid.

+
The tag is invalid.

 
Enter the correct tag and try again later.

+
Enter the correct tag and try again later.

 		
 
400

+
400

 
DWS.5198

+
DWS.5198

 
Invalid username.

+
Invalid username.

 
Invalid username.

+
Invalid username.

 
Enter a correct username and try again.

+
Enter a correct username and try again.

 		
 
400

+
400

 
DWS.5199

+
DWS.5199

 
Invalid password.

+
Invalid password.

 
Invalid password.

+
Invalid password.

 
Enter a valid password and try again.

+
Enter a valid password and try again.

 		
 
400

+
400

 
DWS.5200

+
DWS.5200

 
The flavor has been sold out. Switch to another AZ or region.

-

+
The flavor has been sold out. Switch to another AZ or region.

+

 
The flavor has been sold out. Switch to another AZ or region.

+
The flavor has been sold out. Switch to another AZ or region.

 
Create a cluster of another flavor or switch to another AZ or region.

+
Create a cluster of another flavor or switch to another AZ or region.

 		
 
400

+
400

 
DWS.5202

+
DWS.5202

 
The subnet ID cannot be left blank.

+
The subnet ID cannot be left blank.

 
The subnet ID cannot be left blank.

+
The subnet ID cannot be left blank.

 
Enter a correct subnet ID and try again later.

+
Enter a correct subnet ID and try again later.

 		
 
400

+
400

 
DWS.5203

+
DWS.5203

 
The security group ID cannot be left blank.

+
The security group ID cannot be left blank.

 
The security group ID cannot be left blank.

+
The security group ID cannot be left blank.

 
Enter a valid security group ID and try again later.

+
Enter a valid security group ID and try again later.

 		
 
400

+
400

 
DWS.5206

+
DWS.5206

 
Databases of this version do not support the function.

+
Databases of this version do not support the function.

 
Databases of this version do not support the function.

+
Databases of this version do not support the function.

 
Ensure that the API parameters match the cluster version. If the parameters do not match the version, correct the parameters and try again.

+
Ensure that the API parameters match the cluster version. If the parameters do not match the version, correct the parameters and try again.

 		
 

 
 
 
 
Date

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0032.html b/docs/dws/api-ref/dws_02_0032.html
deleted file mode 100644
index abc081def..000000000
--- a/docs/dws/api-ref/dws_02_0032.html
+++ /dev/null
@@ -1,297 +0,0 @@
-
-
-
Restoring a Cluster

-
Function
This API is used to restore clusters using the snapshot.

-

-
URI
POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions

-
-
Date

 
Description

+
Description

 		
 

 
2025-07-18

+
2025-12-19

 
This issue is the twentieth official release for cluster version 9.1.0.211.

-
Modified the URIs of the tag management APIs. Modified the following sections:

-
+
This issue is the twenty-second official release for cluster version 9.1.0.211.

+
Added the following section:

+
 		
 
2025-04-03

+
2025-09-18

 
This issue is the nineteenth official release for cluster version 9.1.0.211.

+
This issue is the twenty-first official release for cluster version 9.1.0.211.

 		
 
2024-09-30

+
2025-07-18

 
This issue is the eighteenth official release for the 8.2.1.220 cluster.

+
This issue is the twentieth official release for cluster version 9.1.0.211.

+
Modified the URIs of the tag management APIs. Modified the following sections:

+
 		
 
2024-03-29

+
2025-04-03

 
This issue is the seventeenth official release for the 8.1.3.325 cluster.

+
This issue is the nineteenth official release for cluster version 9.1.0.211.

 		
 
2023-09-26

+
2024-09-30

 
This issue is the sixteenth official release.

-
Modified the following sections:

-
+
This issue is the eighteenth official release for cluster version 8.2.1.220.

 		
 
2022-11-03

+
2024-03-29

 
This issue is the fifteenth official release.

-
Modified the following sections:

-
Making an API Request

-
Creating a Cluster

+
This issue is the seventeenth official release for cluster version 8.1.3.325.

 		
 
2021-04-17

+
2023-09-26

 
This issue is the fourteenth official release.

-
Modified the following sections:

-
+
This issue is the sixteenth official release.

+
Modified the following sections:

+
 		
 
2020-11-03

+
2022-11-03

 
This issue is the thirteenth official release.

-
Modified the following sections:

-
Making an API Request

-
Creating a Cluster

+
This issue is the fifteenth official release.

+
Modified the following sections:

+
Making an API Request

+
Creating a Cluster

 		
 
2020-04-17

+
2021-04-17

 
This issue is the twelfth official release.

-
Modified the following sections:

-
+
This issue is the fourteenth official release.

+
Modified the following sections:

+
 		
 
2019-03-30

+
2020-11-03

 
This issue is the eleventh official release. It incorporates the following changes:

-
Modified the following sections:

-
+
This issue is the thirteenth official release.

+
Modified the following sections:

+
Making an API Request

+
Creating a Cluster

 		
 
2019-01-29

+
2020-04-17

 
This issue is the tenth official release.

-
Modified the following sections:

-
This issue is the twelfth official release.

+
Modified the following sections:

+
+
2019-03-30

+
This issue is the eleventh official release.

+
Modified the following sections:

+
+
2019-01-29

+
This issue is the tenth official release.

+
Modified the following sections:

+
 		
 
2018-10-24

+
2018-10-24

 
This issue is the ninth official release.

-
Modified the following sections:

-
  • Getting Started: Modifications are as follows:
    • API for Querying the Cluster List: Added parameters public_endpoints and endpoints to the response.
    • API for Querying Cluster Details: Modified the parameter sequence in the response, added parameters tags and maintain_window, and changed the number of addresses in parameter endpoints to two.
    
-
  • Querying the Snapshot List: Deleted the tag parameter from the response and changed the number of addresses in parameter endpoints to two in the response.
  • Querying Cluster Details: Added the tag parameter to the response.

+
This issue is the ninth official release.

+
Modified the following sections:

+
  • Getting Started: Modifications are as follows:
    • API for Querying the Cluster List: Added parameters public_endpoints and endpoints to the response.
    • API for Querying Cluster Details: Modified the parameter sequence in the response, added parameters tags and maintain_window, and changed the number of addresses in parameter endpoints to two.
    
+
  • Querying the Snapshot List: Deleted the tag parameter from the response and changed the number of addresses in parameter endpoints to two in the response.
  • Querying Cluster Details: Added the tag parameter to the response.

 		
 
2018-09-05

+
2018-09-05

 
This issue is the eighth official release.

-
Modified the following sections:

-
+
This issue is the eighth official release.

+
Modified the following sections:

+
 		
 
2018-06-21

+
2018-06-21

 
This issue is the seventh official release.

-
Added the following sections:

-
-
Modified the following sections:

-
+
This issue is the seventh official release.

+
Added the following section:

+
+
Modified the following sections:

+
 		
 
2018-02-12

+
2018-02-12

 
This issue is the sixth official release.

-
Added the following content:

-
-
Modified the following sections:

-
Error Code: Added solutions for the error code.

-
Deleted the following content:

-
AK/SK-based Authentication

+
This issue is the sixth official release.

+
Added the following sections:

+
+
Modified the following sections:

+
Error Code: Added solutions for the error code.

+
Deleted the following content:

+
AK/SK Authentication

 		
 
2017-12-08

+
2017-12-08

 
This issue is the fifth official release.

-
Modified the following section:

-
Creating a Cluster

+
This issue is the fifth official release.

+
Modified the following section:

+
Creating a Cluster

 		
 
2017-11-01

+
2017-11-01

 
This issue is the fourth official release.

-
Modified the following section:

-
+
This is the fourth official release.

+
Modified the following sections:

+
 		
 
2017-09-30

+
2017-09-30

 
This issue is the third official release.

-
Modified the following content:

-
+
This issue is the third official release.

+
Modified the following content:

+
 		
 
2017-08-30

+
2017-08-30

 
This issue is the second official release.

-
Modified the following sections:

-
+
This is the second official release.

+
Modified the following sections:

+
 		
 
2017-08-07

+
2017-08-07

 
This issue is the first official release.

+
This issue is the first official release.

 		
 

 

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 1 URI parameters
Parameter

-
Mandatory

-
Type

-
Description

-
project_id

-
Yes

-
String

-
Project ID. For details about how to obtain the ID, see Obtaining a Project ID.

-
snapshot_id

-
Yes

-
String

-
ID of the snapshot to be restored

-

-

-
-
Request Parameters

-

-
-
-
-
-
-
-
-
-
-
-
-
Table 2 Request body parameters
Parameter

-
Mandatory

-
Type

-
Description

-
restore

-
Yes

-
Restore object

-
Object to be restored

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 3 Restore
Parameter

-
Mandatory

-
Type

-
Description

-
name

-
Yes

-
String

-
Cluster name, which must be unique. The cluster name must contain 4 to 64 characters, which must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.

-
subnet_id

-
No

-
String

-
Subnet ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

-
security_group_id

-
No

-
String

-
Security group ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

-
vpc_id

-
No

-
String

-
VPC ID, which is used for configuring cluster network. The default value is the same as that of the original cluster.

-
availability_zone

-
No

-
String

-
AZ of a cluster. The default value is the same as that of the original cluster.

-
port

-
No

-
Integer

-
Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

-
public_ip

-
No

-
PublicIp object

-
Public IP address. If the parameter is not specified, public connection is not used by default.

-
enterprise_project_id

-
No

-
String

-
Enterprise project. The default enterprise project ID is 0.

-

-

-
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Table 4 PublicIp
Parameter

-
Mandatory

-
Type

-
Description

-
public_bind_type

-
Yes

-
String

-
Binding type of an EIP. The value can be one of the following:

-
  • auto_assign
  • not_use
  • bind_existing

-
eip_id

-
No

-
String

-
EIP ID

-

-

-

-
Response Parameters

-

-
-
-
-
-
-
-
-
-
-
Table 5 Response body parameters
Parameter

-
Type

-
Description

-
cluster

-
Cluster object

-
Cluster object

-

-

-
-

-
-
-
-
-
-
-
-
-
-
Table 6 Cluster
Parameter

-
Type

-
Description

-
id

-
String

-
Cluster ID

-

-

-

-
Example Request
POST 
-https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions
-{"restore": {
-        "name": "dws-1",
-        "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
-        "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
-        "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
-        "availability_zone": "eu-de-01",
-        "port": 8000,
-        "public_ip": {
-            "public_bind_type": "auto_assign",
-            "eip_id": ""
-        }, 
-        "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada"
-    }
-}

-

-
Example Responses
{
-    "cluster": {
-        "id": "7d85f602-a948-4a30-afd4-e84f47471c15"
-     }
-}

-

-
Status Code

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

-
Description

-
200

-
The cluster is restored.

-
400

-
Request error.

-
401

-
Authentication failed.

-
403

-
You do not have required permissions.

-
404

-
No resources found.

-
500

-
Internal service error.

-
503

-
Service unavailable.

-

-

-

-
-

-

-
Parent topic: Snapshot Management APIs

-

-

-
diff --git a/docs/dws/api-ref/dws_02_0034.html b/docs/dws/api-ref/dws_02_0034.html
index 29172583d..5fdf02ee7 100644
--- a/docs/dws/api-ref/dws_02_0034.html
+++ b/docs/dws/api-ref/dws_02_0034.html
@@ -1,105 +1,276 @@
-
+
 
 
API Overview

-
You can use the following GaussDB(DWS) functions with the APIs.

+
DWS provides in-house APIs. The following table lists the key functions of DWS APIs. For details about other APIs, see the corresponding sections.

 
-
Function

+

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dws/api-ref/dws_02_0036.html b/docs/dws/api-ref/dws_02_0036.html
index f1d73e022..92bed2ac4 100644
--- a/docs/dws/api-ref/dws_02_0036.html
+++ b/docs/dws/api-ref/dws_02_0036.html
@@ -1,14 +1,14 @@
-
+
Getting Started

-
This section describes how to use GaussDB(DWS) APIs to manage clusters. The procedure of the management clusters is as follows:

-
  1. Call the API in Authentication to obtain the user token, which will be put into the request header for authentication in a subsequent request.
  2. Call the API in Querying the Supported Node Types to obtain the supported node types.
  3. Call the API in Creating a Cluster to create a cluster.
  4. Call the API in Querying the Cluster List to obtain the cluster information.
  5. Call the API in Querying Cluster Details to view cluster details.
  6. Call the API in Creating a Snapshot to create a snapshot.
  7. Call the API in Querying the Snapshot List to check whether the snapshot is successfully created.
  8. Call the API in Restoring a Cluster to restore a cluster using its snapshot.
  9. Call the API in Deleting a Manual Snapshot to delete an unwanted snapshot.
  10. Call the API in Deleting a Cluster to delete a finished or unwanted cluster.

-
Prerequisites
  • You have created a VPC, subnet, and security group and obtained their IDs. For details, see Creating a VPC.
  • You have obtained the endpoints of IAM and GaussDB(DWS). For details, see "Regions and Endpoints".
  • You have obtained the project ID. For details, see Obtaining a Project ID.

+
This section describes how to use DWS APIs to manage clusters. The procedure of the management clusters is as follows:

+
  1. Call the API in Authentication to obtain the user token, which will be put into the request header for authentication in a subsequent request.
  2. Call the API in Querying Flavor Information to obtain the supported node types.
  3. Call the API in Creating a Cluster to create a cluster.
  4. Call the API in Querying the Cluster List to obtain the cluster information.
  5. Call the API in Querying Cluster Details to view the cluster details.
  6. Call the API in Creating a Snapshot to create a snapshot.
  7. Call the API in Querying the Snapshot List to check whether the snapshot is created successfully.
  8. Call the API in Restoring a Cluster to restore a cluster using its snapshot.
  9. Call the API in Deleting a Snapshot to delete an unwanted snapshot.
  10. Call the API in Deleting a Cluster to delete a finished or unwanted cluster.

+
Prerequisites
  • You have created a VPC, subnet, and security group and obtained their IDs. For details, see Creating a VPC.
  • You have obtained the endpoints of IAM and DWS. For details, see "Regions and Endpoints".
  • You have obtained the Project ID. For details, see Obtaining Project ID.

 

-
Managing a Cluster
The following values are examples (replace them based on the actual situation).

-
  • IAM endpoint: iam_endpoint
  • GaussDB(DWS) endpoint: dws_endpoint
  • VPC ID: 219ab8a0-1272-4049-a383-8ad0b770fa11
  • Subnet ID: d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec
  • Security group ID: 12e3c23a-8710-4b75-95e4-5c8d7f68ef3c
  • Project ID: 9bc552e6-19af-4326-800d-281a92984636

-
Perform the following operations to manage the cluster.

-
  1. Before calling other APIs, call the API in Authentication to obtain the token and set it as an environment variable.
    curl -H "Content-type:application/json" https://{iam_endpoint}/v3/auth/tokens -X POST -d '{
+
    Managing a Cluster
    The following values are examples (replace them based on the actual situation).
    
+
    • IAM endpoint: iam_endpoint
    • DWS endpoint: dws_endpoint
    • VPC ID: 219ab8a0-1272-4049-a383-8ad0b770fa11
    • Subnet ID: d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec
    • Security group ID: 12e3c23a-8710-4b75-95e4-5c8d7f68ef3c
    • Project ID: 9bc552e6-19af-4326-800d-281a92984636
    
+
    Perform the following operations to manage the cluster.
    
+
    1. Before calling other APIs, call the API in Authentication to obtain the token and set it as an environment variable.
      curl -H "Content-type:application/json" https://{iam_endpoint}/v3/auth/tokens -X POST -d '{
     "auth": {
         "identity": {
             "methods": [
@@ -16,11 +16,11 @@
             ],
             "password": {
                 "user": {
-                    "name": "testname",
+                    "name": "testname",
                     "domain": {
-                        "name": "testname"
+                        "name": "testname"
                     },
-                    "password": "Passw0rd"
+                    "password": "Passw0rd"
                 }
             }
         },
@@ -31,14 +31,14 @@
         }
     }
 }' -v -k
      
-
      1. Obtain the value of X-Subject-Token from the response header as follows. X-Subject-Token indicates the token.
        X-Subject-Token:MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
        
-
      2. Run the following command to set the token as an environment variable:
        export Token={X-Subject-Token}
        
-
        X-Subject-Token is the token obtained in the preceding step.
        export Token=MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
        
+
        1. Obtain the value of X-Subject-Token from the response header as follows. X-Subject-Token indicates the token.
          X-Subject-Token:MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
          
+
        2. Run the following command to set the token as an environment variable:
          export Token={X-Subject-Token}
          
+
          X-Subject-Token is the token obtained in the preceding step.
          export Token=MIidkgYJKoZIhvcNAQcCoIidgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
          
 
          
 
        
-
      3. Call the API in Querying the Supported Node Types to obtain the supported node types.
        curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/node_types -v -k
        
-
        The request response is as follows:
        
-
        status CODE 200
+
      4. Call the API in Querying Flavor Information to obtain the supported node types.
        curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/node_types -v -k
        
+
        The request response is as follows:
        
+
        status CODE 200
 {
     "node_types": [
         {
@@ -83,26 +83,26 @@
         }
     ]
 }
        
-
      5. Call the API in Creating a Cluster to create a cluster.
        The examples for configuring the cluster are as follows:
        
-
        • Cluster name: dws-demo
        • Administrator username: dbadmin
        • Administrator password: Dws2017demo!
        • Port: 8000
        • Node type: dws.d1.xlarge
        • Number of nodes: 3
        • Elastic IP (EIP): auto_assign
        
-
        curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
+
      6. Call the API in Creating a Cluster to create a cluster.
        The examples for configuring the cluster are as follows:
        
+
        • Cluster name: dws-demo
        • Administrator username: dbadmin
        • Administrator password: passw0rd
        • Port: 8000
        • Node type: dws.d1.xlarge
        • Number of nodes: 3
        • Elastic IP (EIP): auto_assign
        
+
        curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
     "node_type": "dws.d1.xlarge",
         "number_of_node": 3,
-        "subnet_id": "d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec",
-        "security_group_id": "12e3c23a-8710-4b75-95e4-5c8d7f68ef3c",
-        "vpc_id": "219ab8a0-1272-4049-a383-8ad0b770fa11",
+        "subnet_id": "d23ef2e9-8b90-49b3-bc4a-fd7d6bea6bec",
+        "security_group_id": "12e3c23a-8710-4b75-95e4-5c8d7f68ef3c",
+        "vpc_id": "219ab8a0-1272-4049-a383-8ad0b770fa11",
         "port": 8000,
         "name": "dws-demo",
         "user_name": "dbadmin",
-        "user_pwd": "Dws2017demo!",
+        "user_pwd": "passw0rd",
         "public_ip": {
             "public_bind_type": "auto_assign"
         }
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -v -k
        
-
        If status code 200 is returned, the request for creating a cluster is successfully sent.
        
-
      7. Call the API in Querying the Cluster List to obtain the cluster information.
        curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -k –v
        
-
        The request response is as follows:
        
-
        {
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -v -k
        
+
        If status code 200 is returned, the request for creating a cluster is successfully sent.
        
+
      8. Call the API in Querying the Cluster List to obtain the cluster information.
        curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters -k –v
        
+
        The request response is as follows:
        
+
        {
         "clusters": [
         {
         "id": "7ba031f6-81f4-4670-ad20-c490b91877e5",
@@ -127,17 +127,17 @@
         "public_endpoints": [
             {
                 "public_connect_info": "10.0.0.8:8000",
-                "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
+                "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
             }
          ],
         "endpoints": [
             {
                 "connect_info": "192.168.0.10:8000",
-                "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
+                "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
             },
             {
                 "connect_info": "192.168.0.12:8000",
-                "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+                "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
             }
          ] , 
         "updated": "2018-01-15T12:50:06",
@@ -146,11 +146,11 @@
         }
     ]
 }
        
-
        • If status is CREATING, the cluster is being created. If status is AVAILABLE, the cluster is successfully created.
        • The UUID of cluster dws-demo is 7ba031f6-81f4-4670-ad20-c490b91877e5. Record the UUID for subsequent use.
        
-
      9. Call the API in Querying Cluster Details to view cluster details.
        curl -X GET -H "Content-type:application/json" -H "X-Auth-Token:$Token" 
- https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -k -v
        
-
        The request response is as follows:
        
-
        {
+
        • If status is CREATING, the cluster is being created. If status is AVAILABLE, the cluster is successfully created.
        • The UUID of cluster dws-demo is 7ba031f6-81f4-4670-ad20-c490b91877e5. Record the UUID for subsequent use.
        
+
      10. Call the API in Querying Cluster Details to view the cluster details.
        curl -X GET -H "Content-type:application/json" -H "X-Auth-Token:$Token" 
+ https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -k -v
        
+
        The request response is as follows:
        
+
        {
     "cluster": {
         "id": "7ba031f6-81f4-4670-ad20-c490b91877e5",
         "status": "AVAILABLE",
@@ -176,24 +176,24 @@
         "public_endpoints": [
         {
                 "public_connect_info": "10.0.0.8:8000",
-                "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
+                "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
          }
          ],
         "endpoints": [
         {
                 "connect_info": "192.168.0.10:8000",
-                "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
+                "jdbc_url": "jdbc:postgresql://192.168.0.10:8000/<YOUR_DATABASE_name>"
         },
         {
                 "connect_info": "192.168.0.12:8000",
-                "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
+                "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<YOUR_DATABASE_name>"
         }
          ],
         "version": "1.1.0",
         "maintain_window": {
             "day": "Wed",
-            "start_time": "22:00",
-            "end_time": "02:00"
+            "start_time": "18:00",
+            "end_time": "22:00"
         }, 
         "recent_event": 1,
         "tags": null, 
@@ -202,25 +202,25 @@
         } 
     }
 }
        
-
        public_endpoints and endpoints can be queried from the response. After the cluster is successfully created, you can use public_endpoints or endpoints to access the cluster from an external source.
        
-
      11. Call the API in Creating a Snapshot to create a snapshot.
        Create snapshot snapshotForDemoCluster for cluster dws-demo.
        curl -X POST -H "Content-type:application/json" -H "X-Auth-Token:$Token" -d '{
+
        public_endpoints and endpoints can be queried from the response. After the cluster is successfully created, you can use public_endpoints or endpoints to access the cluster from an external source.
        
+
      12. Call the API in Creating a Snapshot to create a snapshot.
        Create snapshot snapshotForDemoCluster for cluster dws-demo.
        curl -X POST -H "Content-type:application/json" -H "X-Auth-Token:$Token" -d '{
     "snapshot": {
         "name": "snapshotForDemoCluster",
         "cluster_id": "7ba031f6-81f4-4670-ad20-c490b91877e5",
         "description": "Snapshot description" 
     }
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots -k -v
        
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots -k -v
    
 

-
The request response is as follows:

-
{
+
The request response is as follows:

+
{
   "snapshot": { 
       "id": "2a4d0f86-67cd-408a-8b66-017454fb7793" 
   }
 }

-
If status code 200 is returned, the request for creating a snapshot is successfully sent. Record id so that the ID can be used when you query the snapshot details later.

-
  • Call the API in Querying the Snapshot List to check whether the snapshot is successfully created.
    curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -k -v
    
-
    If the snapshot status in the response is AVAILABLE, the snapshot is successfully created. If the snapshot status is CREATING, the snapshot is being created.
    
-
    { 
+
    If status code 200 is returned, the request for creating a snapshot is successfully sent. Record id so that the ID can be used when you query the snapshot details later.
    
+
  • Call the API in Querying the Snapshot List to check whether the snapshot is created successfully.
    curl -X GET -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -k -v
    
+
    If the snapshot status in the response is AVAILABLE, the snapshot is successfully created. If the snapshot status is CREATING, the snapshot is being created.
    
+
    { 
     "snapshot": { 
         "id": "2a4d0f86-67cd-408a-8b66-017454fb7793", 
         "name": "snapshotForDemoCluster", 
@@ -233,19 +233,19 @@
         "cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c" 
     } 
 }
    
-
  • Call the API in Restoring a Cluster to restore a cluster using its snapshot.
    Restore snapshot snapshotForDemoCluster to new cluster dws-restore.
    curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
+
  • Call the API in Restoring a Cluster to restore a cluster using its snapshot.
    Restore snapshot snapshotForDemoCluster to new cluster dws-restore.
    curl -X POST -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
     "restore": {
         "name": "dws-restore"
     }
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793/actions -v -k
    
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793/actions -v -k
    • 
 
    
-
    If status code 200 is returned, the cluster is successfully restored. You can check the cluster restoration status by performing operations in Querying Snapshot Details.
    
-
  • Call the API in Deleting a Manual Snapshot to delete an unwanted snapshot.
    curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -v -k
    
-
    If status code 202 is returned, the snapshot is successfully deleted.
    
-
  • Call the API in Deleting a Cluster to delete an unwanted cluster.
    curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
+
    If status code 200 is returned, the cluster is successfully restored. You can check the cluster restoration status by performing operations in Querying Snapshot Details.
    
+
  • Call the API in Deleting a Snapshot to delete an unwanted snapshot.
    curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/snapshots/2a4d0f86-67cd-408a-8b66-017454fb7793 -v -k
    
+
    If status code 202 is returned, the snapshot is successfully deleted.
    
+
  • Call the API in Deleting a Cluster to delete a finished or unwanted cluster.
    curl -X DELETE -H 'Content-type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{
     "keep_last_manual_snapshot":0
-}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -v -k
    
-
    If status code 202 is returned, the cluster is successfully deleted.
    
+}' https://{dws_endpoint}/v1.0/9bc552e6-19af-4326-800d-281a92984636/clusters/7ba031f6-81f4-4670-ad20-c490b91877e5 -v -k
+
    If status code 202 is returned, the cluster is successfully deleted.
    
 
    • 
 
    
 
    
diff --git a/docs/dws/api-ref/dws_02_0037.html b/docs/dws/api-ref/dws_02_0037.html
index ac88a8ee8..50a5747ac 100644
--- a/docs/dws/api-ref/dws_02_0037.html
+++ b/docs/dws/api-ref/dws_02_0037.html
@@ -1,15 +1,35 @@
-
+
    API Description
    
-
    
+
    
 
    
 
diff --git a/docs/dws/api-ref/dws_02_0038.html b/docs/dws/api-ref/dws_02_0038.html
index 07d82ac33..919a8887b 100644
--- a/docs/dws/api-ref/dws_02_0038.html
+++ b/docs/dws/api-ref/dws_02_0038.html
@@ -1,313 +1,313 @@
-
+
 
 
    Status Code
    
-
    Table 1 describes the status code.
    
+
    Table 1 describes the status code.
    
 
-
    Table 1 APIs
    Function
    
 
    API
    
+
    API
    
 
    Description
    
+
    Description
    
     		
 
    
 
    Cluster management
    
+
    Cluster management
    
 
    Creating a Cluster
    
+
    Performing a Check Before Cluster Creation
    
 
    Creates a cluster.
    
+
    Performs a check before cluster creation.
    
     		
 
    Querying the Cluster List
    
+
    Creating a Cluster
    
 
    Queries and displays the cluster list.
    
+
    Creates a cluster.
    
     		
 
    Querying Cluster Details
    
+
    Querying the List of Clusters
    
 
    Queries cluster details.
    
+
    Queries and displays the cluster list.
    
     		
 
    Querying the Supported Node Types
    
+
    Querying Cluster Details
    
 
    Queries all node types supported by GaussDB(DWS).
    
+
    Queries cluster details.
    
     		
 
    Deleting a Cluster
    
+
    Querying Flavors
    
 
    Deletes a cluster.
    
+
    Queries all node types supported by DWS.
    
     		
 
    Restarting a Cluster
    
+
    Deleting a Cluster
    
 
    Restarts a cluster.
    
+
    Deletes a cluster.
    
     		
 
    Scaling Out a Cluster
    
+
    Restarting a Cluster
    
 
    Scales out a cluster.
    
+
    Restarts a cluster.
    
     		
 
    Resetting a Password
    
+
    Scaling Out a Cluster
    
 
    Resets the cluster administrator password.
    
+
    Scales out a cluster.
    
     		
 
    Snapshot management
    
+
    Resetting a Password
    
 
    Creating a Snapshot
    
-
    Creates snapshots for a specified cluster.
    
+
    Resets the cluster administrator password.
    
     		
 
    Querying the Snapshot List
    
+
    Querying the List of DSS Storage Pools
    
 
    Queries the snapshot list.
    
+
    Queries DSS storage pools available to a tenant.
    
     		
 
    Querying Snapshot Details
    
+
    Canceling the Read-Only Status
    
 
    Queries the snapshot details using the snapshot ID.
    
+
    Cancels the read-only status on the management console.
    
     		
 
    Deleting a Manual Snapshot
    
+
    Querying CNs in a Cluster
    
 
    Deletes a snapshot.
    
+
    Queries information about CNs in a specified cluster.
    
     		
 
    Restoring a Cluster
    
+
    Adding CN Nodes in Batches
    
 
    Restores a cluster using a snapshot.
    
+
    Adds CNs in batches to a specified cluster.
    
     		
 
    Tag management
    
+
    Deleting CN Nodes in Batches
    
 
    Querying Tags in a Project
    
-
    Query all tag of a project.
    
+
    Deletes CNs from a specified cluster.
    
     		
 
    Querying Cluster Tags
    
+
    Snapshot management
    
 
    Queries tags of a cluster.
    
+
    Creating a Snapshot
    
+
    Creates snapshots for a specified cluster.
    
     		
 
    Adding Tags in Batches
    
+
    Querying the Cluster Snapshot List
    
 
    Batch adds tags to a cluster in batches.
    
+
    Queries the snapshot list.
    
     		
 
    Deleting Tags in Batches
    
+
    Querying Snapshot Details
    
 
    Deletes tags from a cluster in batches.
    
+
    Queries the snapshot details using the snapshot ID.
    
+
    Deleting a Snapshot
    
+
    Deletes a snapshot.
    
+
    Deleting a Snapshot Policy
    
+
    Deletes a snapshot policy.
    
+
    Restoring a Cluster
    
+
    Restores a cluster using a snapshot.
    
+
    Copying a Snapshot
    
+
    Replicates an automated snapshot.
    
+
    Adding a Snapshot Policy
    
+
    Sets a snapshot policy.
    
+
    Incident management
    
+
    
+
    Querying the Event List
    
+
    Queries the event list.
    
+
    Querying Subscribed Events
    
+
    Queries subscribed events.
    
+
    Creating an Event Subscription
    
+
    Adds a subscribed event.
    
+
    Updating an Event Subscription
    
+
    Updates a subscribed event.
    
+
    Deleting an Event Subscription
    
+
    Deletes a subscribed event.
    
+
    Audit logs
    
+
    Querying Logs
    
+
    Queries audit logs.
    
+
    Alarm management
    
+
    Querying the Alarm Details List
    
+
    Queries the alarm details list.
    
+
    Querying the Alarm Statistics List
    
+
    Queries alarm statistics.
    
+
    Querying the Alarm Subscription List
    
+
    Queries subscribed alarms.
    
+
    Creating an Alarm Subscription
    
+
    Creates an alarm subscription.
    
+
    Editing an Alarm Subscription
    
+
    Updates a subscribed alarm.
    
+
    Deleting an Alarm Subscription
    
+
    Deletes a subscribed alarm.
    
+
    AZ
    
+
    Querying the AZ List
    
+
    Queries the AZs available for a tenant to create a cluster.
    
+
    Connection management
    
+
    
+
    
+
    
+
    
+
    
+
    
+
    
+
    Applying for a Domain Name
    
+
    Applies for a domain name for a specified cluster.
    
+
    Modifying a Cluster Domain Name
    
+
    Changes the domain name of a specified cluster.
    
+
    Deleting a Cluster Domain Name
    
+
    Deletes the domain name of a specified cluster.
    
+
    Obtaining the List of ELBs That Can Be Bound to a Cluster
    
+
    Queries the list of ELBs that can be associated with a cluster.
    
+
    Binding an ELB to a Cluster
    
+
    Binds an ELB to a cluster.
    
+
    Unbinding an ELB from a Cluster
    
+
    Unbinds an ELB from a cluster.
    
+
    Binding an EIP to a Cluster
    
+
    Binds an EIP to a cluster.
    
+
    Unbinding an EIP from a Cluster
    
+
    Unbound an EIP from a cluster.
    
+
    Tag management
    
+
    
+
    
+
    
+
    Querying Project Tags
    
+
    Queries project tags.
    
+
    Querying Cluster Tags
    
+
    Queries tags of a specified cluster.
    
+
    Adding Tags in Batches
    
+
    Batch adds tags to a specified cluster.
    
+
    Deleting Tags in Batches
    
+
    Batch deletes tags from a specified cluster.
    
     		
 
    
     
 
 
 
 
    Table 1 Status code
    Status Code
    
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/dws/api-ref/dws_02_0040.html b/docs/dws/api-ref/dws_02_0040.html
index dc2b6613a..53a2f3b76 100644
--- a/docs/dws/api-ref/dws_02_0040.html
+++ b/docs/dws/api-ref/dws_02_0040.html
@@ -1,12 +1,12 @@
-
+
    Creating a VPC
    
-
    Background
    Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using GaussDB(DWS).
    
-
    If you have already created a VPC, you do not need to create it again.
    
-
     
    For details about how to create a VPC, see Creating a VPC in the Virtual Private Cloud User Guide.
    
+
    Background
    Before creating a cluster, you need to create a VPC to provide a secure and isolated network environment for using DWS.
    
+
    If you have already created a VPC, you do not need to create it again.
    
+
     
    For details about how to create a VPC, see Creating a VPC in the Virtual Private Cloud User Guide.
    
 
    
 
    
-
    Procedure
    1. Log in to the management console.
    2. Under Network, click Virtual Private Cloud.
    3. On the Virtual Private Cloud page, click Create VPC to create a VPC. 
    4. Obtain the VPC and subnet ID for subsequent use in Creating a Cluster.
    5. On the Virtual Private Cloud page, choose Access Control > Security Groups in the navigation tree on the left, and click Create Security Group to create a security group.
    6. Obtain the security group ID for subsequent use in Creating a Cluster.
    
+
    Procedure
    1. Log in to the DWS console.
    2. Under Network, click Virtual Private Cloud.
    3. On the Virtual Private Cloud page, click Create VPC to create a VPC. 
    4. Obtain the VPC and subnet ID for subsequent use in Creating a Cluster.
    5. On the Virtual Private Cloud page, choose Access Control > Security Groups in the navigation tree on the left, and click Create Security Group to create a security group.
    6. Obtain the security group ID for subsequent use in Creating a Cluster.
    
 
    
 
    
 
    
diff --git a/docs/dws/api-ref/dws_02_0045.html b/docs/dws/api-ref/dws_02_0045.html
deleted file mode 100644
index 02baf9320..000000000
--- a/docs/dws/api-ref/dws_02_0045.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-
    Tag Management
    
-
    
-
    
-
-
diff --git a/docs/dws/api-ref/dws_02_0047.html b/docs/dws/api-ref/dws_02_0047.html
deleted file mode 100644
index 0db607d22..000000000
--- a/docs/dws/api-ref/dws_02_0047.html
+++ /dev/null
@@ -1,184 +0,0 @@
-
-
-
    Adding Tags in Batches
    
-
    Function
    This API is used to add tags to a cluster in batches.
    
-
    
-
    URI
    POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-create
    
-
-
    Table 1 Status code
    Status Code
    
 
    Code
    
+
    Code
    
 
    Description
    
+
    Description
    
     		
 
    
 
    100
    
+
    100
    
 
    Continue
    
+
    Continue
    
 
    The client continues sending the request.
    
-
    This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.
    
+
    The client continues sending the request.
    
+
    This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server.
    
     		
 
    101
    
+
    101
    
 
    Switching Protocols
    
+
    Switching Protocols
    
 
    Switching protocols. The target protocol must be more advanced than the source protocol.
    
-
    For example, the current HTTP protocol is switched to a later version.
    
+
    Switching protocols. The target protocol must be more advanced than the source protocol.
    
+
    For example, the current HTTP protocol is switched to a later version.
    
     		
 
    201
    
+
    201
    
 
    Created
    
+
    Created
    
 
    The request for creating a resource has been fulfilled. 
    
+
    The request for creating a resource has been fulfilled. 
    
     		
 
    202
    
+
    202
    
 
    Accepted
    
+
    Accepted
    
 
    The request has been accepted, but the processing has not been completed.
    
+
    The request has been accepted, but the processing has not been completed.
    
     		
 
    203
    
+
    203
    
 
    Non-Authoritative Information
    
+
    Non-Authoritative Information
    
 
    The server successfully processed the request, but is returning information that may be from another source.
    
+
    The server successfully processed the request, but is returning information that may be from another source.
    
     		
 
    204
    
+
    204
    
 
    NoContent
    
+
    NoContent
    
 
    The server has successfully processed the request, but has not returned any content.
    
-
    The status code is returned in response to an HTTP OPTIONS request.
    
+
    The server has successfully processed the request, but has not returned any content.
    
+
    The status code is returned in response to an HTTP OPTIONS request.
    
     		
 
    205
    
+
    205
    
 
    Reset Content
    
+
    Reset Content
    
 
    The server has fulfilled the request, but the requester is required to reset the content.
    
+
    The server has fulfilled the request, but the requester is required to reset the content.
    
     		
 
    206
    
+
    206
    
 
    Partial Content
    
+
    Partial Content
    
 
    The server has processed certain GET requests.
    
+
    The server has processed certain GET requests.
    
     		
 
    300
    
+
    300
    
 
    Multiple Choices
    
+
    Multiple Choices
    
 
    There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one.
    
+
    There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one.
    
     		
 
    301
    
+
    301
    
 
    Moved Permanently
    
+
    Moved Permanently
    
 
    The requested resource has been assigned a new permanent URI, and the new URI is contained in the response.
    
+
    The requested resource has been assigned a new permanent URI, and the new URI is contained in the response.
    
     		
 
    302
    
+
    302
    
 
    Found
    
+
    Found
    
 
    The requested resource resides temporarily under a different URI.
    
+
    The requested resource resides temporarily under a different URI.
    
     		
 
    303
    
+
    303
    
 
    See Other
    
+
    See Other
    
 
    Retrieve a location.
    
-
    The response to the request can be found under a different URI and should be retrieved using a GET or POST method.
    
+
    Retrieve a location.
    
+
    The response to the request can be found under a different URI and should be retrieved using a GET or POST method.
    
     		
 
    304
    
+
    304
    
 
    Not Modified
    
+
    Not Modified
    
 
    The requested resource has not been modified. When the server returns this status code, it does not return any resources.
    
+
    The requested resource has not been modified. When the server returns this status code, it does not return any resources.
    
     		
 
    305
    
+
    305
    
 
    Use Proxy
    
+
    Use Proxy
    
 
    The requested resource must be accessed through a proxy.
    
+
    The requested resource must be accessed through a proxy.
    
     		
 
    306
    
+
    306
    
 
    Unused
    
+
    Unused
    
 
    The HTTP status code is no longer used.
    
+
    The HTTP status code is no longer used.
    
     		
 
    400
    
+
    400
    
 
    BadRequest
    
+
    BadRequest
    
 
    Invalid request.
    
-
    The client should not repeat the request without modifications.
    
+
    Invalid request.
    
+
    The client should not repeat the request without modifications.
    
     		
 
    401
    
+
    401
    
 
    Unauthorized
    
+
    Unauthorized
    
 
    The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid.
    
+
    The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid.
    
     		
 
    402
    
+
    402
    
 
    Payment Required
    
+
    Payment Required
    
 
    This status code is reserved for future use.
    
+
    This status code is reserved for future use.
    
     		
 
    403
    
+
    403
    
 
    Forbidden
    
+
    Forbidden
    
 
    The server understood the request, but is refusing to fulfill it.
    
-
    The client should not repeat the request without modifications.
    
+
    The server understood the request, but is refusing to fulfill it.
    
+
    The client should not repeat the request without modifications.
    
     		
 
    404
    
+
    404
    
 
    NotFound
    
+
    NotFound
    
 
    The requested resource cannot be found.
    
-
    The client should not repeat the request without modifications.
    
+
    The requested resource cannot be found.
    
+
    The client should not repeat the request without modifications.
    
     		
 
    405
    
+
    405
    
 
    MethodNotAllowed
    
+
    MethodNotAllowed
    
 
    The method specified in the request is not supported for the requested resource.
    
-
    The client should not repeat the request without modifications.
    
+
    The method specified in the request is not supported for the requested resource.
    
+
    The client should not repeat the request without modifications.
    
     		
 
    406
    
+
    406
    
 
    Not Acceptable
    
+
    Not Acceptable
    
 
    The server cannot fulfill the request according to the content characteristics of the request.
    
+
    The server cannot fulfill the request according to the content characteristics of the request.
    
     		
 
    407
    
+
    407
    
 
    Proxy Authentication Required
    
+
    Proxy Authentication Required
    
 
    This status code is similar to 401, but indicates that the client must first authenticate itself with the proxy.
    
+
    This status code is similar to 401, but indicates that the client must first authenticate itself with the proxy.
    
     		
 
    408
    
+
    408
    
 
    Request Time-out
    
+
    Request Time-out
    
 
    The request timed out.
    
-
    The client may repeat the request without modifications at any later time.
    
+
    The request timed out.
    
+
    The client may repeat the request without modifications at any later time.
    
     		
 
    409
    
+
    409
    
 
    Conflict
    
+
    Conflict
    
 
    The request could not be completed due to a conflict with the current state of the resource. 
    
-
    This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.
    
+
    The request could not be completed due to a conflict with the current state of the resource. 
    
+
    This status code indicates that the resource that the client attempts to create already exits, or the request fails to be processed because of the update of the conflict request.
    
     		
 
    410
    
+
    410
    
 
    Gone
    
+
    Gone
    
 
    The requested resource is no longer available.
    
-
    The status code indicates that the requested resource has been deleted permanently. 
    
+
    The requested resource is no longer available.
    
+
    The status code indicates that the requested resource has been deleted permanently. 
    
     		
 
    411
    
+
    411
    
 
    Length Required
    
+
    Length Required
    
 
    The server refuses to process the request without a defined Content-Length.
    
+
    The server refuses to process the request without a defined Content-Length.
    
     		
 
    412
    
+
    412
    
 
    Precondition Failed
    
+
    Precondition Failed
    
 
    The server does not meet one of the preconditions that the requester puts on the request.
    
+
    The server does not meet one of the preconditions that the requester puts on the request.
    
     		
 
    413
    
+
    413
    
 
    Request Entity Too Large
    
+
    Request Entity Too Large
    
 
    The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a Retry-After header field.
    
+
    The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a Retry-After header field.
    
     		
 
    414
    
+
    414
    
 
    Request-URI Too Large
    
+
    Request-URI Too Large
    
 
    The URI provided was too long for the server to process.
    
+
    The URI provided was too long for the server to process.
    
     		
 
    415
    
+
    415
    
 
    Unsupported Media type
    
+
    Unsupported Media type
    
 
    The server is unable to process the media format in the request.
    
+
    The server is unable to process the media format in the request.
    
     		
 
    416
    
+
    416
    
 
    Requested range not satisfiable
    
+
    Requested range not satisfiable
    
 
    The requested range is invalid.
    
+
    The requested range is invalid.
    
     		
 
    417
    
+
    417
    
 
    Expectation Failed
    
+
    Expectation Failed
    
 
    The server fails to meet the requirements of the Expect request-header field.
    
+
    The server fails to meet the requirements of the Expect request-header field.
    
     		
 
    422
    
+
    422
    
 
    UnprocessableEntity
    
+
    UnprocessableEntity
    
 
    The request is well-formed but is unable to be processed due to semantic errors.
    
+
    The request is well-formed but is unable to be processed due to semantic errors.
    
     		
 
    429
    
+
    429
    
 
    TooManyRequests
    
+
    TooManyRequests
    
 
    The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.
    
+
    The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.
    
     		
 
    500
    
+
    500
    
 
    InternalServerError
    
+
    InternalServerError
    
 
    The server is able to receive the request but it could not understand the request.
    
+
    The server is able to receive the request but it could not understand the request.
    
     		
 
    501
    
+
    501
    
 
    Not Implemented
    
+
    Not Implemented
    
 
    The server does not support the requested function.
    
+
    The server does not support the requested function.
    
     		
 
    502
    
+
    502
    
 
    Bad Gateway
    
+
    Bad Gateway
    
 
    The server is acting as a gateway or proxy and receives an invalid request from a remote server.
    
+
    The server is acting as a gateway or proxy and receives an invalid request from a remote server.
    
     		
 
    503
    
+
    503
    
 
    ServiceUnavailable
    
+
    ServiceUnavailable
    
 
    The requested service is invalid.
    
-
    The client should not repeat the request without modifications.
    
+
    The requested service is invalid.
    
+
    The client should not repeat the request without modifications.
    
     		
 
    504
    
+
    504
    
 
    ServerTimeout
    
+
    ServerTimeout
    
 
    The request cannot be fulfilled within a given time. This status code is returned to the client only when the Timeout parameter is specified in the request.
    
+
    The request cannot be fulfilled within a given time. This status code is returned to the client only when the Timeout parameter is specified in the request.
    
     		
 
    505
    
+
    505
    
 
    HTTP Version not supported
    
+
    HTTP Version not supported
    
 
    The server does not support the HTTP protocol version used in the request.
    
+
    The server does not support the HTTP protocol version used in the request.
    
     		
 
    
     
 
 
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Project ID. To obtain the value, see Obtaining a Project ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    cluster_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Cluster ID. To obtain the value, see Obtaining the Cluster ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    
-
    
-
-
    Request Parameters
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 Request body parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    tags
    
-
    Yes
    
-
    Array of BatchCreateResourceTag objects
    
-
    Tag list.
    
-
    
-
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 BatchCreateResourceTag
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    key
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Tag key.
    
-
    Range
    
-
    N/A
    
-
    value
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Tag value.
    
-
    Range
    
-
    N/A
    
-
    
-
    
-
    
-
    Response Parameters
    Status code: 200
    
-
    Tags are added in batches.
    
-
    None
    
-
    
-
    Example Request
    Add tags whose key is key and value is value in batches.
    
-
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-create
-
-{
-  "tags" : [ {
-    "key" : "key",
-    "value" : "value"
-  } ]
-}
    
-
    
-
    Example Responses
    None
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    Tags are added in batches.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authorization failed.
    
-
    403
    
-
    No operation permission.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
-
    
-
    
-
    Parent topic: Tag Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0048.html b/docs/dws/api-ref/dws_02_0048.html
deleted file mode 100644
index 23f2ce396..000000000
--- a/docs/dws/api-ref/dws_02_0048.html
+++ /dev/null
@@ -1,191 +0,0 @@
-
-
-
    Deleting Tags in Batches
    
-
    Function
    This API is used to delete tags from a cluster in batches.
    
-
    
-
    URI
    POST /v1.0/{project_id}/clusters/{cluster_id}/tags/batch-delete
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Project ID. To obtain the value, see Obtaining a Project ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    cluster_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Cluster ID. To obtain the value, see Obtaining the Cluster ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    
-
    
-
    
-
    Request Parameters
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 Request body parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    tags
    
-
    Yes
    
-
    Array of BatchDeleteResourceTag objects
    
-
    Definition
    
-
    Tag list.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    
-
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 BatchDeleteResourceTag
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    key
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Tag key.
    
-
    Range
    
-
    N/A
    
-
    value
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Tag value.
    
-
    Range
    
-
    N/A
    
-
    
-
    
-
    
-
    Response Parameters
    Status code: 200
    
-
    Tags are deleted in batches.
    
-
    None
    
-
    
-
    Example Request
    Delete tags whose key is key and value is value in batches.
    
-
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/tags/batch-delete
-
-{
-  "tags" : [ {
-    "key" : "key",
-    "value" : "value"
-  } ]
-}
    
-
    
-
    Example Responses
    None
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    Tags are deleted in batches.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authorization failed.
    
-
    403
    
-
    No operation permission.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Parent topic: Tag Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0049.html b/docs/dws/api-ref/dws_02_0049.html
deleted file mode 100644
index a02affb2e..000000000
--- a/docs/dws/api-ref/dws_02_0049.html
+++ /dev/null
@@ -1,175 +0,0 @@
-
-
-
    Querying Cluster Tags
    
-
    Function
    This API is used to query the tags of a cluster.
    
-
    
-
    URI
    GET /v1.0/{project_id}/clusters/{cluster_id}/tags
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Project ID. To obtain the value, see Obtaining a Project ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    cluster_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Cluster ID. To obtain the value, see Obtaining the Cluster ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    
-
    
-
    
-
    Request Parameters
    None
    
-
    
-
    Response Parameters
    Status code: 200
    
-
-
    
-
-
-
-
-
-
-
-
-
-
    Table 2 Response body parameters
    Parameter
    
-
    Type
    
-
    Description
    
-
    tags
    
-
    Array of ResourceTag objects
    
-
    Definition
    
-
    Tag list.
    
-
    Range
    
-
    N/A
    
-
    
-
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 ResourceTag
    Parameter
    
-
    Type
    
-
    Description
    
-
    key
    
-
    String
    
-
    Definition
    
-
    Tag key.
    
-
    Range
    
-
    N/A
    
-
    value
    
-
    String
    
-
    Definition
    
-
    Tag value.
    
-
    Range
    
-
    N/A
    
-
    
-
    
-
    
-
    Example Request
    GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/tags
    
-
    
-
    Example Responses
    Status code: 200
    
-
    The cluster tags are queried successfully.
    
-
    {
-  "tags" : [ {
-    "key" : "key",
-    "value" : "value"
-  } ]
-}
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    The cluster tags are queried successfully.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authorization failed.
    
-
    403
    
-
    No operation permission.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Parent topic: Tag Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0050.html b/docs/dws/api-ref/dws_02_0050.html
deleted file mode 100644
index 8148be431..000000000
--- a/docs/dws/api-ref/dws_02_0050.html
+++ /dev/null
@@ -1,159 +0,0 @@
-
-
-
    Querying Tags in a Project
    
-
    Function
    This API is used to query the tags of a project.
    
-
    
-
    URI
    GET /v1.0/{project_id}/tags
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Definition
    
-
    Project ID. To obtain the value, see Obtaining a Project ID.
    
-
    Constraints
    
-
    N/A
    
-
    Range
    
-
    N/A
    
-
    Default Value
    
-
    N/A
    
-
    
-
    
-
    
-
    Request Parameters
    None
    
-
    
-
    Response Parameters
    Status code: 200
    
-
-
    
-
-
-
-
-
-
-
-
-
-
    Table 2 Response body parameters
    Parameter
    
-
    Type
    
-
    Description
    
-
    tags
    
-
    Array of ProjectTag objects
    
-
    Definition
    
-
    Tag object.
    
-
    Range
    
-
    N/A
    
-
    
-
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 ProjectTag
    Parameter
    
-
    Type
    
-
    Description
    
-
    key
    
-
    String
    
-
    Definition
    
-
    Key.
    
-
    Range
    
-
    N/A
    
-
    values
    
-
    Array of strings
    
-
    Definition
    
-
    Value.
    
-
    Range
    
-
    N/A
    
-
    
-
    
-
    
-
    Example Request
    GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/tags
    
-
    
-
    Example Responses
    Status code: 200
    
-
    The project tags are queried successfully.
    
-
    {
-  "tags" : [ {
-    "key" : "key",
-    "values" : [ "value-1", "value-2" ]
-  } ]
-}
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    The project tags are queried successfully.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authorization failed.
    
-
    403
    
-
    No operation permission.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Parent topic: Tag Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0052.html b/docs/dws/api-ref/dws_02_0052.html
deleted file mode 100644
index 7acb0a047..000000000
--- a/docs/dws/api-ref/dws_02_0052.html
+++ /dev/null
@@ -1,126 +0,0 @@
-
-
-
    Restarting a Cluster
    
-
    Function
    This API is used to restart clusters.
    
-
    
-
    URI
    POST /v1.0/{project_id}/clusters/{cluster_id}/restart
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
    
-
    cluster_id
    
-
    Yes
    
-
    String
    
-
    ID of the cluster to be restarted. For details about how to obtain the ID, see Obtaining the Cluster ID.
    
-
    
-
    
-
    
-
    Request Parameters
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 Request body parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    restart
    
-
    Yes
    
-
    Object
    
-
    Restart flag
    
-
    
-
    
-
    
-
    Response Parameters
    None
    
-
    
-
    Example Request
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/restart
-
-{
-  "restart" : { }
-}
    
-
    
-
    Example Response
    None
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    The cluster is restarted.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authentication failed.
    
-
    403
    
-
    You do not have required permissions.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Parent topic: Cluster Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0053.html b/docs/dws/api-ref/dws_02_0053.html
deleted file mode 100644
index 03c55c7f5..000000000
--- a/docs/dws/api-ref/dws_02_0053.html
+++ /dev/null
@@ -1,152 +0,0 @@
-
-
-
    Scaling Out a Cluster
    
-
    Function
    This API is used to scale out a cluster.
    
-
    
-
    URI
    POST /v1.0/{project_id}/clusters/{cluster_id}/resize
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
    
-
    cluster_id
    
-
    Yes
    
-
    String
    
-
    ID of the cluster to be scaled out. For details about how to obtain the ID, see Obtaining the Cluster ID.
    
-
    
-
    
-
    
-
    Request Parameters
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 Request body parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    scale_out
    
-
    No
    
-
    ScaleOut object
    
-
    Object to be scaled out
    
-
    
-
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 ScaleOut
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    count
    
-
    Yes
    
-
    Integer
    
-
    Number of nodes to be added
    
-
    
-
    
-
    
-
    Response Parameters
    None
    
-
    
-
    Example Request
    An example of the scale_out API is as follows:
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize
-
-{
-  "scale_out" : {
-    "count" : 3
-  }
-}
    
-
    
-
    
-
    Response Message
    None
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    The cluster is scaled out successfully.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authentication failed.
    
-
    403
    
-
    You do not have required permissions.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Parent topic: Cluster Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0054.html b/docs/dws/api-ref/dws_02_0054.html
deleted file mode 100644
index 33405ef26..000000000
--- a/docs/dws/api-ref/dws_02_0054.html
+++ /dev/null
@@ -1,128 +0,0 @@
-
-
-
    Resetting a Password
    
-
    Function
    This API is used to reset the password of cluster administrator.
    
-
    
-
    URI
    POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password
    
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 1 URI parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    project_id
    
-
    Yes
    
-
    String
    
-
    Project ID. For details about how to obtain the ID, see Obtaining a Project ID.
    
-
    cluster_id
    
-
    Yes
    
-
    String
    
-
    ID of the cluster whose password is to be reset. For details about how to obtain the ID, see Obtaining the Cluster ID.
    
-
    
-
    
-
    
-
    Request Parameters
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 Request body parameters
    Parameter
    
-
    Mandatory
    
-
    Type
    
-
    Description
    
-
    new_password
    
-
    Yes
    
-
    String
    
-
    New administrator password for logging in to a data warehouse cluster
    
-
    A password must conform to the following rules:
    
-
    • Contains 12 to 32 characters.
    • Cannot be the same as the username or the username written in reverse order.
    • Contains at least three types of the following:
      • Lowercase letters
      • Uppercase letters
      • Digits
      • Special characters: ~!?,.:;-_'"(){}[]/<>@#%^&*+|\=
      
-
    
-
    • Cannot be the same as previous passwords.
    • Cannot be a weak password.
    
-
    
-
    
-
    
-
    Example Request
    POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/reset-password
-
-{
-  "new_password" : "NewPassword!"
-}
    
-
    
-
    Response Example
    None
    
-
    
-
    Status Code
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Status Code
    
-
    Description
    
-
    200
    
-
    The password is reset.
    
-
    400
    
-
    Request error.
    
-
    401
    
-
    Authentication failed.
    
-
    403
    
-
    You do not have required permissions.
    
-
    404
    
-
    No resources found.
    
-
    500
    
-
    Internal service error.
    
-
    503
    
-
    Service unavailable.
    
-
    
-
    
-
    
-
    
-
    
-
    
-
    Parent topic: Cluster Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0055.html b/docs/dws/api-ref/dws_02_0055.html
deleted file mode 100644
index a4ccd664b..000000000
--- a/docs/dws/api-ref/dws_02_0055.html
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
    Tagging
    
-
    A tag is a key-value pair customized by users and used to classify and search for cloud resources.
    
-
    A tag consists of a tag key and a tag value.
    
-
    • A tag key can contain multiple tag values.
    • A cloud resource cannot have duplicate tag keys.
    
-
    On GaussDB(DWS), only cluster resources support the tag function.
    
-
    
-
    
-
    
-
    Parent topic: Tag Management
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0056.html b/docs/dws/api-ref/dws_02_0056.html
deleted file mode 100644
index 33d86aec3..000000000
--- a/docs/dws/api-ref/dws_02_0056.html
+++ /dev/null
@@ -1,284 +0,0 @@
-
-
-
    Permissions Policies and Supported Actions
    
-
    This section describes fine-grained permissions management for your GaussDB(DWS) service using IAM. You can skip this section if your cloud account already satisfies your needs.
    
-
    By default, new IAM users do not have permissions assigned. You need to add the users to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions. 
    
-
    You can grant users permissions by using roles and policies. Roles are provided by IAM to define service-based permissions depending on users' job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
    
-
     
    Policy-based authorization is useful if you want to allow or deny the access to an API.
    
-
    
-
    An account has full permissions to access all APIs, but each IAM user needs to be granted the necessary permissions before they can begin using the APIs. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the GaussDB(DWS) cluster list using an API, the user must have been granted permissions that allow the dws:openAPICluster:list action.
    
-
    Supported Actions
    GaussDB(DWS) provides system-defined policies that can be directly used in IAM. Database administrators can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:
    
-
    • Permissions: Allow or deny operations on specified resources under specific conditions.
    • APIs: RESTful APIs that can be called in a custom policy.
    • Actions: Added to a custom policy to control permissions for specific operations.
    • IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. 
       
      The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.
      
-
      
-
    
-
    GaussDB(DWS) supports the following actions that can be defined in custom policies:
    
-
-
    
-
    Managing Clusters
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Permissions
    
-
    APIs
    
-
    Actions
    
-
    IAM Project
    
-
     
    
-
    Enterprise Project
    
-
     
    
-
    Creating clusters
    
-
    POST /v1.0/{project_id}/clusters
    
-
    dws:openAPICluster:create
    
-
    √
    
-
    √
    
-
    Querying the cluster list
    
-
    GET /v1.0/{project_id}/clusters
    
-
    dws:openAPICluster:list
    
-
    √
    
-
    √
    
-
    Querying cluster details
    
-
    GET /v1.0/{project_id}/clusters/{cluster_id}
    
-
    dws:openAPICluster:getDetail
    
-
    √
    
-
    √
    
-
    Querying the node type
    
-
    GET /v2/{project_id}/node-types
    
-
    dws:openAPIFlavors:get
    
-
    √
    
-
    √
    
-
    Deleting clusters
    
-
    DELETE /v1.0/{project_id}/clusters/{cluster_id}
    
-
    dws:openAPICluster:delete
    
-
    √
    
-
    √
    
-
    Restarting clusters
    
-
    POST /v1.0/{project_id}/clusters/{cluster_id}/restart
    
-
    dws:openAPICluster:restart
    
-
    √
    
-
    √
    
-
    Scales out a cluster.
    
-
    POST /v1.0/{project_id}/clusters/{cluster_id}/resize
    
-
    dws:cluster:scaleOutOrOpenAPIResize
    
-
    √
    
-
    √
    
-
    Resetting the cluster's administrator password
    
-
    POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password
    
-
    dws:openAPICluster:resetPassword
    
-
    √
    
-
    √
    
-
    
-
    
-
    
-
    Managing Snapshots
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Permissions
    
-
    APIs
    
-
    Actions
    
-
    IAM Project
    
-
     
    
-
    Enterprise Project
    
-
     
    
-
    Creating snapshots
    
-
    POST /v1.0/{project_id}/snapshots
    
-
    dws:openAPISnapshot:create
    
-
    √
    
-
    √
    
-
    Querying the snapshot list
    
-
    GET /v1.0/{project_id}/snapshots
    
-
    dws:openAPISnapshot:list
    
-
    √
    
-
    √
    
-
    Querying snapshot details
    
-
    GET /v1.0/{project_id}/snapshots/{snapshot_id}
    
-
    dws:openAPISnapshot:detail
    
-
    √
    
-
    √
    
-
    Deleting snapshots
    
-
    DELETE /v1.0/{project_id}/snapshots/{snapshot_id}
    
-
    dws:openAPISnapshot:delete
    
-
    √
    
-
    √
    
-
    Restoring clusters
    
-
    POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions
    
-
    dws:openAPISnapshot:restore
    
-
    √
    
-
    √
    
-
    
-
    
-
    
-
    Managing Tags
    
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Permissions
    
-
    APIs
    
-
    Actions
    
-
    IAM Project
    
-
     
    
-
    Enterprise Project
    
-
     
    
-
    Adding a resource tag
    
-
    POST /v1.0/{project_id}/clusters/{resource_id}/tags
    
-
    dws:openAPITag:add
    
-
    √
    
-
    √
    
-
    Adding and deleting resource tags in batches
    
-
    POST /v1.0/{project_id}/clusters/{resource_id}/tags/action
    
-
    dws:openAPITag:update
    
-
    √
    
-
    √
    
-
    Querying resources by tag
    
-
    POST /v1.0/{project_id}/clusters/resource_instances/action
    
-
    dws:openAPITag:getResourceByTag
    
-
    √
    
-
    √
    
-
    Querying resource tags
    
-
    GET /v1.0/{project_id}/clusters/{resource_id}/tags
    
-
    dws:openAPITag:getResourceTag
    
-
    √
    
-
    √
    
-
    Querying tags in a specified project
    
-
    GET /v1.0/{project_id}/clusters/tags
    
-
    dws:openAPITag:list
    
-
    √
    
-
    √
    
-
    Deleting a tag
    
-
    DELETE /v1.0/{project_id}/clusters/{resource_id}/tags/{key}
    
-
    dws:openAPITag:delete
    
-
    √
    
-
    √
    
-
    
-
    
-
    
-
    
-
diff --git a/docs/dws/api-ref/dws_02_0057.html b/docs/dws/api-ref/dws_02_0057.html
index 677b41c1f..3492961a6 100644
--- a/docs/dws/api-ref/dws_02_0057.html
+++ b/docs/dws/api-ref/dws_02_0057.html
@@ -1,21 +1,21 @@
-
+
 
 
    Before You Start
    
-
    Overview
    Welcome to GaussDB(DWS). GaussDB(DWS) is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and supports online cluster scale-out and efficient loading of multiple data sources. It helps enterprises efficiently analyze and monetize massive amounts of data online.
    
-
    This guide explains how to use APIs to manage GaussDB(DWS) clusters, including creating, querying, and deleting tags and snapshots. For details about all supported operations, see API Overview.
    
-
    Before calling an API, get familiar with related concepts of GaussDB(DWS). For details, see "Service Overview" in the Data Warehouse Service User Guide.
    
-
    GaussDB(DWS) supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.
    
+
    Overview
    Welcome to DWS. DWS is a fully-managed and enterprise-level cloud data warehouse service. It is O&M-free, compatible with the PostgreSQL ecosystem, and supports online cluster scale-out and efficient loading of multiple data sources.
    
+
    This guide explains how to use APIs to manage DWS clusters, including creating, querying, and deleting tags and snapshots. For a comprehensive list of all supported operations, see API Overview.
    
+
    Before calling an API, get familiar with related concepts of DWS. For details, see "Service Overview" in the DWS User Guide.
    
+
    DWS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.
    
 
    
-
    Endpoints
    An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see "Regions and Endpoints".
    
+
    Endpoints
    An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see "Regions and Endpoints".
    
 
    
-
    Basic Concepts
    • Account
      An account has full access permissions for all the resources and cloud services under it. It can reset user passwords and grant users permissions. For security purposes, create IAM users and assign them permissions for routine management.
      
-
    • User
      An IAM user is created by an account to use cloud services. Each IAM user has its own identity credentials (password or access keys).
      
-
      The account name, username, and password will be required for API authentication.
      
-
    • Region
      A region is a geographic area where cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. By creating cloud resources in different regions, you can better meet customer requirements and comply with local laws and regulations.
      
-
    • AZ
      An AZ contains one or more physical data centers. Each AZ has independent power and network devices. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.
      
-
    • Project
      A project corresponds to a region. Default projects are defined to group and physically isolate resources (including compute, storage, and network resources) between different regions. Users can be granted permissions in a default project to access all resources under their accounts in the region associated with the project. For more refined access control, create subprojects under a project and apply for resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
      
-
      Figure 1 Project isolating model
      
-
    • Enterprise project
      Enterprise projects group and logically isolate resources. An enterprise project can contain resources from different regions, and resources can be transferred between enterprise projects.
      
+
      Basic Concepts
      • Account
        An account has full access permissions for all the resources and cloud services. It can be used to reset user passwords and grant user permissions. For security purposes, create IAM users and grant them permissions for routine management.
        
+
      • User
        An IAM user is created by an account to use cloud services. Each IAM user has its own identity credentials (password or access keys).
        
+
        The account, user, and password will be required for API authentication.
        
+
      • Region
        A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
        
+
      • AZ
        An AZ contains one or more physical data centers. Each AZ has independent power and network devices. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.
        
+
      • Project
        A project corresponds to a region. Default projects are defined to group and physically isolate resources (including compute, storage, and network resources) between different regions. Users can be granted permissions in a default project to access all resources under their accounts in the region associated with the project. For more refined access control, create subprojects under a project and apply for resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
        
+
        Figure 1 Project isolating model
        
+
      • Enterprise project
        Enterprise projects group and logically isolate resources. An enterprise project can contain resources from different regions, and resources can be transferred between enterprise projects.
        
 
      
 
      
 
    
diff --git a/docs/dws/api-ref/dws_02_0061.html b/docs/dws/api-ref/dws_02_0061.html
new file mode 100644
index 000000000..3e83a5c90
--- /dev/null
+++ b/docs/dws/api-ref/dws_02_0061.html
@@ -0,0 +1,307 @@
+
+
+
    Permissions and Supported Actions
    
+
    This section describes fine-grained permissions management for your DWS service using IAM. You can skip this section if your cloud account already satisfies your needs.
    
+
    By default, new IAM users do not have permissions assigned. You need to add the users to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions. 
    
+
    You can grant users permissions by using roles and policies. Roles are provided by IAM to define service-based permissions depending on user's job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
    
+
     
    Policy-based authorization is useful if you want to allow or deny the access to an API.
    
+
    
+
    An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the DWS cluster list using an API, the user must have been granted permissions that allow the dws:openAPICluster:list action.
    
+
    Supported Actions
    DWS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:
    
+
    • Permissions: Allow or deny operations on specified resources under specific conditions.
    • APIs: RESTful APIs that can be called in a custom policy.
    • Actions: Added to a custom policy to control permissions for specific operations.
    • IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. 
       
      The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.
      
+
      
+
    
+
    DWS supports the following actions that can be defined in custom policies:
    
+
+
    
+
    Managing Clusters
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Permissions
    
+
    APIs
    
+
    Actions
    
+
    IAM Project
    
+
     
    
+
    Enterprise Project
    
+
     
    
+
    Creating clusters
    
+
    POST /v1.0/{project_id}/clusters
    
+
    dws:openAPICluster:create
    
+
    √
    
+
    √
    
+
    Querying the cluster list
    
+
    GET /v1.0/{project_id}/clusters
    
+
    dws:openAPICluster:list
    
+
    √
    
+
    √
    
+
    Querying cluster details
    
+
    GET /v1.0/{project_id}/clusters/{cluster_id}
    
+
    dws:openAPICluster:getDetail
    
+
    √
    
+
    √
    
+
    Querying the node type
    
+
    GET /v2/{project_id}/node-types
    
+
    dws:openAPIFlavors:get
    
+
    √
    
+
    √
    
+
    Deleting clusters
    
+
    DELETE /v1.0/{project_id}/clusters/{cluster_id}
    
+
    dws:openAPICluster:delete
    
+
    √
    
+
    √
    
+
    Restarting clusters
    
+
    POST /v1.0/{project_id}/clusters/{cluster_id}/restart
    
+
    dws:openAPICluster:restart
    
+
    √
    
+
    √
    
+
    Scales out a cluster.
    
+
    POST /v1.0/{project_id}/clusters/{cluster_id}/resize
    
+
    dws:cluster:scaleOutOrOpenAPIResize
    
+
    √
    
+
    √
    
+
    Resetting the cluster's administrator password
    
+
    POST /v1.0/{project_id}/clusters/{cluster_id}/reset-password
    
+
    dws:openAPICluster:resetPassword
    
+
    √
    
+
    √
    
+
    Starting a cluster
    
+
    POST /v1/
    
+
    {project_id}/clusters/{cluster_id}/start
    
+
    dws:cluster:startCluster
    
+
    √
    
+
    ×
    
+
    Stopping a cluster
    
+
    POST /v1/{project_id}/clusters/{cluster_id}/stop
    
+
    dws:cluster:stopCluster
    
+
    √
    
+
    ×
    
+
    
+
    
+
    
+
    Managing Snapshots
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Permissions
    
+
    APIs
    
+
    Actions
    
+
    IAM Project
    
+
     
    
+
    Enterprise Project
    
+
     
    
+
    Creating snapshots
    
+
    POST /v1.0/{project_id}/snapshots
    
+
    dws:openAPISnapshot:create
    
+
    √
    
+
    √
    
+
    Querying the snapshot list
    
+
    GET /v1.0/{project_id}/snapshots
    
+
    dws:openAPISnapshot:list
    
+
    √
    
+
    √
    
+
    Querying snapshot details
    
+
    GET /v1.0/{project_id}/snapshots/{snapshot_id}
    
+
    dws:openAPISnapshot:detail
    
+
    √
    
+
    √
    
+
    Deleting snapshots
    
+
    DELETE /v1.0/{project_id}/snapshots/{snapshot_id}
    
+
    dws:openAPISnapshot:delete
    
+
    √
    
+
    √
    
+
    Restoring clusters
    
+
    POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions
    
+
    dws:openAPISnapshot:restore
    
+
    √
    
+
    √
    
+
    
+
    
+
    
+
    Managing Tags
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Permissions
    
+
    APIs
    
+
    Actions
    
+
    IAM Project
    
+
     
    
+
    Enterprise Project
    
+
     
    
+
    Adding a resource tag
    
+
    POST /v1.0/{project_id}/clusters/{resource_id}/tags
    
+
    dws:openAPITag:add
    
+
    √
    
+
    √
    
+
    Adding and deleting resource tags in batches
    
+
    POST /v1.0/{project_id}/clusters/{resource_id}/tags/action
    
+
    dws:openAPITag:update
    
+
    √
    
+
    √
    
+
    Querying resources by tag
    
+
    POST /v1.0/{project_id}/clusters/resource_instances/action
    
+
    dws:openAPITag:getResourceByTag
    
+
    √
    
+
    √
    
+
    Querying resource tags
    
+
    GET /v1.0/{project_id}/clusters/{resource_id}/tags
    
+
    dws:openAPITag:getResourceTag
    
+
    √
    
+
    √
    
+
    Querying tags in a specified project
    
+
    GET /v1.0/{project_id}/clusters/tags
    
+
    dws:openAPITag:list
    
+
    √
    
+
    √
    
+
    Deleting a tag
    
+
    DELETE /v1.0/{project_id}/clusters/{resource_id}/tags/{key}
    
+
    dws:openAPITag:delete
    
+
    √
    
+
    √
    
+
    
+
    
+
    
+
    
+
diff --git a/docs/dws/api-ref/dws_02_0062.html b/docs/dws/api-ref/dws_02_0062.html
index ea5e6b50c..fc82ab4a7 100644
--- a/docs/dws/api-ref/dws_02_0062.html
+++ b/docs/dws/api-ref/dws_02_0062.html
@@ -1,4 +1,4 @@
-
+
 
 
    Calling APIs
    
 
    
diff --git a/docs/dws/api-ref/dws_02_0063.html b/docs/dws/api-ref/dws_02_0063.html
index 1d8dfa564..31d85fcc4 100644
--- a/docs/dws/api-ref/dws_02_0063.html
+++ b/docs/dws/api-ref/dws_02_0063.html
@@ -1,211 +1,109 @@
-
+
 
 
    Making an API Request
    
-
    This section describes the structure of a REST API request, and describes how to call an API by obtaining a user token of the IAM service. The obtained token can then be used to authenticate the calling of other APIs.
    
-
    Request URI
    A request URI is in the following format:
    
-
    {URI-scheme}://{Endpoint}/{resource-path}?{query-string}
    
-
    Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
    
+
    This section describes the structure of a RESTful API request, and uses the IAM API for creating an IAM user as an example to describe how to call an API.
    
+
    Request URI
    A request URI is in the following format:
    
+
    {URI-scheme}://{Endpoint}/{resource-path}?{query-string}
    
+
    Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
    
 
-
    Table 1 URI parameter description
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
    Table 1 URI parameter description
    Parameter
    
 
    Description
    
+
    Description
    
     		
 
    
 
    URI-scheme
    
+
    URI-scheme
    
 
    Protocol used to transmit requests. All APIs use HTTPS.
    
+
    Protocol used to transmit requests. All APIs use HTTPS.
    
     		
 
    Endpoint
    
+
    Endpoint
    
 
    Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies between services in different regions. It can be obtained from the "Regions and Endpoints" section.
    
-
    For example, the endpoint of IAM in the eu-de region is iam.eu-de.otc.t-systems.com.
    
+
    Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
    
+
    For example, the endpoint of IAM in the eu-de region is iam.eu-de.otc.t-systems.com.
    
     		
 
    resource-path
    
+
    resource-path
    
 
    Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
    
+
    Access path of an API for performing a specified operation. Obtain the value from the URI of an API. For example, resource-path of the API used to create an IAM user is /v3.0/OS-USER/users.
    
     		
 
    query-string
    
+
    query-string
    
 
    Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ?limit=10 indicates that a maximum of 10 data records will be displayed.
    
+
    Query parameter, which is optional. The query parameter must be in the format of parameter-name=parameter-value and prefixed with a question mark (?). For example, limit=10 indicates that a maximum of 10 data records will be displayed.
    
     		
 
    
     
 
    
 
    
-
     
    To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
    
+
     
    To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
    
 
    
 
    
-
    Request Methods
    The HTTP protocol defines the following request methods that can be used to send a request to the server:
-
    Table 2 HTTP methods
    Method
    
+
    Request Methods
    The HTTP protocol defines the following request methods that can be used to send a request to the server.
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 HTTP methods
    Method
    
 
    Description
    
+
    Description
    
     		
 
    
 
    GET
    
+
    GET
    
 
    Requests the server to return specified resources.
    
+
    Requests the server to return specified resources.
    
     		
 
    PUT
    
+
    PUT
    
 
    Requests the server to update specified resources.
    
+
    Requests the server to update specified resources.
    
     		
 
    POST
    
+
    POST
    
 
    Requests the server to add resources or perform special operations.
    
+
    Requests the server to add resources or perform special operations.
    
     		
 
    DELETE
    
+
    DELETE
    
 
    Requests the server to delete specified resources, for example, an object.
    
+
    Requests the server to delete specified resources, for example, an object.
    
     		
 
    HEAD
    
+
    HEAD
    
 
    Same as GET except that the server must return only the response header.
    
+
    Same as GET except that the server must return only the response header.
    
     		
 
    PATCH
    
+
    PATCH
    
 
    Requests the server to update partial content of a specified resource.
    
-
    If the resource does not exist, a new resource will be created.
    
+
    Requests the server to update partial content of a specified resource.
    
+
    If the resource does not exist, a new resource will be created.
    
     		
 
    
     
 
    
 
    
 
    
-
    For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
    
 
    
-
    POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
    
-
    Request Header
    You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-type, which specifies the request body type.
    
-
    For details about common request headers, see Table 3.
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 Common request header fields
    Field
    
-
    Description
    
-
    Mandatory
    
-
    Example
    
-
    x-sdk-date
    
-
    Time when the request is sent. The time is in YYYYMMDD'T'HHMMSS'Z' format.
    
-
    The value is the current GMT time of the system.
    
-
    No
    
-
    20150907T101459Z
    
-
    Host
    
-
    Server information of the resource being requested. The value can be obtained from the URL of the service API. The value is in the format of hostname[:port]. If the port number is not specified, the default port is used. The default port number for HTTPS is 443.
    
-
    No
    
-
    code.test.com
    
-
    or
    
-
    code.test.com:443
    
-
    Content-Type
    
-
    Request body MIME type. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.
    
-
    Yes
    
-
    application/json
    
-
    Content-Length
    
-
    Length of the request body. The unit is byte.
    
-
    No
    
-
    3495
    
-
    X-Project-id
    
-
    Project ID. Obtain the project ID by following the instructions in Obtaining a Project ID.
    
-
    No
    
-
    e9993fc787d94b6c886cbaa340f9c0f4
    
-
    X-Auth-Token
    
-
    User token.
    
-
    The user token is a response to the API used to obtain a user token. This API is the only one that does not require authentication.
    
-
    The X-Subject-Token value contained in the returned message header is the token.
    
-
    No
    
-
    This parameter is mandatory for token-based authentication.
    
-
    The following is part of an example token:
    
-
    MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
    
-
    X-Language
    
-
    Request language.
    
-
    No
    
-
    en_us
    
-
    
+
    Request Header
    You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-type, which specifies the request body type.
    
+
    Common request headers include:
    
+
    • Content-Type: specifies the request body type or format. This field is mandatory and its default value is application/json. Other values of this field (if any) will be provided for specific APIs.
    • Authorization: specifies signature authentication information. This field is optional. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. For more information, see AK/SK-based Authentication.
    • X-Sdk-Date: specifies the time when a request is sent. This field is optional. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request. For more information, see AK/SK-based Authentication.
    • X-Auth-Token: specifies a user token only for token-based API authentication. 
    • X-Project-ID: specifies subproject ID. This field is optional and can be used in multi-project scenarios. This field is mandatory in the request header for accessing resources in a sub-project through AK/SK-based authentication.
    • X-Domain-ID: specifies the account ID, which is optional. When you call APIs of global services using AK/SK-based authentication, X-Domain-ID needs to be configured in the request header.
    
 
    
-
    
-
    The API used to obtain a user token does not require authentication. Therefore, only the Content-type field needs to be added to requests for calling the API. An example of such requests is as follows:
    
-
    
-
    POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
-Content-type: application/json
    
-
    Request Body
    The body of a request is often sent in a structured format (JSON or XML) as specified in the Content-type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8.
    
-
    The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
    
-
    In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace user_name, domainname (account name), ******** (login password), and xxxxxxxxxxxxxxxxxx (project ID) with actual ones. Obtain the project ID from the database administrator.
    
-
     
    The scope parameter specifies where a token takes effect. In the example, the token takes effect only on the resources specified by the project. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
    
-
    
-
    POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens
-Content-type: application/json
-
-{
-    "auth": {
-        "identity": {
-            "methods": [
-                "password"
-            ],
-            "password": {
-                "user": {
-                    "name": "user_name",
-                    "password": "********",
-                    "domain": {
-                        "name": "domainname"
-                    }
-                }
-            }
-        },
-        "scope": {
-            "project": {
-                "id": "xxxxxxxxxxxxxxxxxx"
-            }
-        }
-    }
-}
    
-
    If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
    
+
    Request Body
    The body of a request is often sent in a structured format (JSON or XML) as specified in the Content-type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8. Specify the character encoding mode in Content-type, for example, Content-Type: application/json; charset=utf-8.
    
+
    The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
    
+
    In the case of the API used to , the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included.
    
+
    • accountid: ID of the account to which the IAM user belongs.
    • username: IAM username to be created.
    • email: email address of the IAM user.
    • **********: password of the IAM user.
    
+
    
+
    Content-type: application/json
+X-Sdk-Date: 20240416T095341Z 
+ Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** 
+{ 
+      "user": { 
+          "domain_id": "accountid", 
+          "name": "username", 
+          "password": "**********", 
+          "email": "email", 
+          "description": "IAM User Description" 
+      } 
+  }
    
+
    The content required by an API request is ready. You can use curl, Postman, or write code to send the request to call the API.
    
 
    
 
    
 
    
diff --git a/docs/dws/api-ref/dws_02_0064.html b/docs/dws/api-ref/dws_02_0064.html
index e49fb4501..a57b38b49 100644
--- a/docs/dws/api-ref/dws_02_0064.html
+++ b/docs/dws/api-ref/dws_02_0064.html
@@ -1,12 +1,21 @@
-
+
 
 
    Authentication
    
-
    Calling an API can be authenticated using tokens.
    
-
    Token-based Authentication
    A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to request headers to get permissions for calling the API.
    
-
     
    The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
    
+
    You can use either of the following authentication methods when calling APIs:
    
+
    • AK/SK authentication: Requests are encrypted using an AK/SK.
    • Token authentication: Requests are authenticated using a token.
    
+
    AK/SK-based Authentication
     
    • AK/SK-based authentication supports API requests with a body no larger than 12 MB. For API requests with a larger body, you should use token-based authentication.
    • You can use the AK/SK in a permanent or temporary access key. The X-Security-Token field must be configured if the AK/SK in a temporary access key is used, and the field value is security_token of the temporary access key.
    
 
    
-
    When calling the API to obtain a user token, you must set auth.scope in the request body to project.
    
-
    { 
+
    In AK/SK-based authentication, the AK/SK is used to sign requests and the signature is then added to the requests for authentication.
    
+
    • AK: access key ID, which is a unique identifier used with a secret access key to sign requests cryptographically.
    • SK: secret access key. It is used together with an AK to sign requests. They can identify request senders and prevent requests from being modified.
    
+
    In AK/SK-based authentication, you can use the AK/SK to sign requests based on the signature algorithm or use a dedicated signing SDK to sign requests. For details about how to sign requests and use the signing SDK, see the AK/SK Signing and Authentication Guide.
    
+
     
    The signing SDKs are only used for signing requests and different from the SDKs provided by services.
    
+
    
+
    
+
    Token-based Authentication
    A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to request headers to get permissions for calling the API.
    
+
     
    • Cache the token for authentication to prevent frequently calling the IAM API to obtain the token. A token is valid for 24 hours.
    • Ensure that the token is valid while you use it. Using a token that will soon expire may cause API calling failures.
    
+
    
+
    When calling the API to obtain a user token, you must set auth.scope in the request body to project.
    
+
    { 
     "auth": { 
         "identity": { 
             "methods": [ 
@@ -14,22 +23,22 @@
             ], 
             "password": { 
                 "user": { 
-                    "name": "user_name", 
-                    "password": "********", 
+                    "name": "user_name", 
+                    "password": "********", 
                     "domain": { 
-                        "name": "domainname" 
+                        "name": "domainname" 
                     } 
                 } 
             } 
         }, 
-        "scope": { 
-            "project": { 
-                "id": "xxxxxxxx" 
-            } 
-        } 
+        "scope": { 
+            "project": { 
+                "name": "xxxxxxxx" 
+            } 
+        } 
     } 
 }
    
-
    After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. If the token is ABCDEFG...., add X-Auth-Token: ABCDEFG.... to a request.
    
+
    After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFG..., add X-Auth-Token: ABCDEFG.... to the request header.
    
 
    
 
    
 
    
diff --git a/docs/dws/api-ref/dws_02_0065.html b/docs/dws/api-ref/dws_02_0065.html
index 84cc00406..59d9916a2 100644
--- a/docs/dws/api-ref/dws_02_0065.html
+++ b/docs/dws/api-ref/dws_02_0065.html
@@ -1,35 +1,43 @@
-
+
 
 
    Response
    
-
    Status Code
    After sending a request, you will receive a response, including a status code, response header, and response body.
    
-
    A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
    
-
    For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
    
+
    After sending a request, you will receive a response containing the status code, response header, and response body.
    
+
    Status Code
    A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.
    
 
    
-
    Response Header
    Similar to a request, a response also has a header, for example, content-type.
    
-
    Figure 1 shows the response header fields for the API used to obtain a user token. The x-subject-token header field is the desired user token. You can use this token to authenticate the calling of other APIs.
    
-
    Figure 1 Header fields of the response to the request for obtaining a user token
    
+
    Response Header
    Similar to a request, a response also has a header, for example, content-type.
    
+
    Figure 1 Response headers
    
 
    
-
    Response Body
    The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-type header field. The response body transfers content except the response header.
    
+
    Response Body
    The body of a response is often returned in structured format (for example, JSON or XML) as specified in the Content-type header field. The response body transfers content except the response header.
    
 
    
-
    The following is part of the response body for the API used to obtain a user token. 
    
-
    {
-    "token": {
-        "expires_at": "2019-02-13T06:52:13.855000Z",
-        "methods": [
-            "password"
-        ],
-        "catalog": [
-            {
-                "endpoints": [
-                    {
-                        "region_id": "eu-de",
-......
    
-
    If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
    
-
    {
-    "error_msg": "The format of message is error", 
-     "error_code": "AS.0001" 
+
    { 
+    "user": { 
+        "id": "c131886aec...", 
+        "name": "IAMUser", 
+        "description": "IAM User Description", 
+        "areacode": "", 
+        "phone": "", 
+        "email": "***@***.com", 
+        "status": null, 
+        "enabled": true, 
+        "pwd_status": false, 
+        "access_mode": "default", 
+        "is_domain_owner": false, 
+        "xuser_id": "", 
+        "xuser_type": "", 
+        "password_expires_at": null, 
+        "create_time": "2024-05-21T09:03:41.000000", 
+        "domain_id": "d78cbac1..........", 
+        "xdomain_id": "30086000........", 
+        "xdomain_type": "", 
+        "default_project_id": null 
+    } 
 }
    
-
    In the response body, error_code is an error code, and error_msg provides information about the error.
    
+
    If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
    
+
    {
+    "error_msg": "The format of message is error", 
+     "error_code": "AS.0001" 
+}
    
+
    In the response body, error_code is an error code, and error_msg provides information about the error.
    
 
    
 
    
 
    
diff --git a/docs/dws/api-ref/dws_02_0066.html b/docs/dws/api-ref/dws_02_0066.html
index 7d325ea28..47e62427e 100644
--- a/docs/dws/api-ref/dws_02_0066.html
+++ b/docs/dws/api-ref/dws_02_0066.html
@@ -1,7 +1,7 @@
-
+
 
 
    Appendix
    
-
    
+