From a03981f7befddf20a3ef6a3bbd63b19b70603606 Mon Sep 17 00:00:00 2001 From: "Chen, Junjie" Date: Mon, 22 Apr 2024 14:08:39 +0000 Subject: [PATCH] DCS API 20230220 Version Reviewed-by: Bobkova, Natalia Co-authored-by: Chen, Junjie Co-committed-by: Chen, Junjie --- docs/dcs/api-ref/.placeholder | 0 docs/dcs/api-ref/ALL_META.TXT.json | 2424 +++++++++++-- .../dcs/api-ref/BackgroudTasksManagement.html | 22 + docs/dcs/api-ref/BackupRestoreManagement.html | 26 + docs/dcs/api-ref/BatchCreateOrDeleteTags.html | 165 + docs/dcs/api-ref/BatchDeleteInstances.html | 256 ++ .../api-ref/BatchShowNodesInformation.html | 467 +++ docs/dcs/api-ref/BatchStopMigrationTasks.html | 369 ++ docs/dcs/api-ref/CLASS.TXT.json | 1083 +++++- docs/dcs/api-ref/CacheAnalysisManagement.html | 40 + docs/dcs/api-ref/ChangeMasterStandby.html | 287 ++ .../api-ref/ConfigTemplatesManagement.html | 18 + docs/dcs/api-ref/CopyInstance.html | 222 ++ .../dcs/api-ref/CreateAutoExpireScanTask.html | 375 ++ docs/dcs/api-ref/CreateBigkeyScanTask.html | 443 +++ docs/dcs/api-ref/CreateCustomTemplate.html | 414 +++ docs/dcs/api-ref/CreateHotkeyScanTask.html | 452 +++ docs/dcs/api-ref/CreateInstance.html | 934 +++++ docs/dcs/api-ref/CreateMigrationTask.html | 725 ++++ .../api-ref/CreateOnlineMigrationTask.html | 375 ++ docs/dcs/api-ref/CreateRedislog.html | 333 ++ .../api-ref/CreateRedislogDownloadLink.html | 330 ++ docs/dcs/api-ref/DataMigrationManagement.html | 34 + docs/dcs/api-ref/DeleteBackgroundTask.html | 320 ++ docs/dcs/api-ref/DeleteBackupFile.html | 164 + docs/dcs/api-ref/DeleteBigkeyScanTask.html | 466 +++ docs/dcs/api-ref/DeleteCenterTask.html | 303 ++ docs/dcs/api-ref/DeleteHotkeyScanTask.html | 475 +++ docs/dcs/api-ref/DeleteIpFromDomainName.html | 319 ++ docs/dcs/api-ref/DeleteMigrationTask.html | 323 ++ docs/dcs/api-ref/DeleteSingleInstance.html | 85 + docs/dcs/api-ref/DownloadSSLCert.html | 207 ++ docs/dcs/api-ref/ErrorCode.html | 3205 +++++++++++++++++ .../api-ref/GroupReplicationManagement.html | 22 + .../api-ref/InstanceDiagnosisManagement.html | 18 + docs/dcs/api-ref/InstanceManagement.html | 22 + docs/dcs/api-ref/LifecycleManagement.html | 28 + docs/dcs/api-ref/ListAvailableZones.html | 143 + docs/dcs/api-ref/ListBackgroundTask.html | 683 ++++ docs/dcs/api-ref/ListBackupFileLinks.html | 260 ++ docs/dcs/api-ref/ListBackupRecords.html | 410 +++ docs/dcs/api-ref/ListBigkeyScanTasks.html | 445 +++ docs/dcs/api-ref/ListConfigHistories.html | 264 ++ docs/dcs/api-ref/ListConfigTemplates.html | 513 +++ docs/dcs/api-ref/ListConfigurations.html | 289 ++ docs/dcs/api-ref/ListDiagnosisTasks.html | 300 ++ docs/dcs/api-ref/ListFlavors.html | 693 ++++ .../dcs/api-ref/ListGroupReplicationInfo.html | 427 +++ docs/dcs/api-ref/ListHotKeyScanTasks.html | 445 +++ docs/dcs/api-ref/ListInstances.html | 813 +++++ docs/dcs/api-ref/ListMaintenanceWindows.html | 265 ++ docs/dcs/api-ref/ListMigrationTask.html | 572 +++ docs/dcs/api-ref/ListMonitoredObjects.html | 275 ++ .../ListMonitoredObjectsOfInstance.html | 425 +++ docs/dcs/api-ref/ListRedislog.html | 434 +++ docs/dcs/api-ref/ListRestoreRecords.html | 321 ++ docs/dcs/api-ref/ListSlowlog.html | 472 +++ .../ListStatisticsOfRunningInstances.html | 285 ++ docs/dcs/api-ref/ListTagsOfTenant.html | 202 ++ docs/dcs/api-ref/LogManagement.html | 22 + .../api-ref/NetworkSecurityManagement.html | 24 + docs/dcs/api-ref/OtherInterface.html | 26 + docs/dcs/api-ref/ParamManagement.html | 20 + docs/dcs/api-ref/ResizeInstance.html | 211 ++ docs/dcs/api-ref/RestartOrFlushInstances.html | 242 ++ docs/dcs/api-ref/RestoreInstance.html | 218 ++ docs/dcs/api-ref/SetOnlineMigrationTask.html | 467 +++ .../dcs/api-ref/ShowBigkeyAutoscanConfig.html | 335 ++ .../api-ref/ShowBigkeyScanTaskDetails.html | 461 +++ .../dcs/api-ref/ShowDiagnosisTaskDetails.html | 624 ++++ .../dcs/api-ref/ShowHotkeyAutoscanConfig.html | 335 ++ docs/dcs/api-ref/ShowHotkeyTaskDetails.html | 470 +++ docs/dcs/api-ref/ShowInstance.html | 978 +++++ docs/dcs/api-ref/ShowInstanceSSLDetail.html | 235 ++ docs/dcs/api-ref/ShowIpWhitelist.html | 107 +- docs/dcs/api-ref/ShowJobInfo.html | 364 ++ docs/dcs/api-ref/ShowMigrationTask.html | 725 ++++ docs/dcs/api-ref/ShowMigrationTaskStats.html | 359 ++ docs/dcs/api-ref/ShowQuotaOfTenant.html | 269 ++ docs/dcs/api-ref/ShowTags.html | 127 + docs/dcs/api-ref/StopMigrationTask.html | 725 ++++ docs/dcs/api-ref/TagManagement.html | 20 + .../api-ref/UpdateBigkeyAutoscanConfig.html | 372 ++ docs/dcs/api-ref/UpdateConfigurations.html | 227 ++ .../api-ref/UpdateHotkeyAutoScanConfig.html | 372 ++ docs/dcs/api-ref/UpdateInstance.html | 357 ++ docs/dcs/api-ref/UpdateIpWhitelist.html | 297 +- docs/dcs/api-ref/UpdateMigrationTask.html | 316 ++ docs/dcs/api-ref/UpdatePassword.html | 259 ++ docs/dcs/api-ref/UpdateSSLSwitch.html | 237 ++ docs/dcs/api-ref/UpdateSlavePriority.html | 326 ++ docs/dcs/api-ref/api-grant-policy.html | 636 ++++ docs/dcs/api-ref/dcs-api-0312003.html | 4 + docs/dcs/api-ref/dcs-api-0312004.html | 458 +-- docs/dcs/api-ref/dcs-api-0312005.html | 570 +-- docs/dcs/api-ref/dcs-api-0312006.html | 419 ++- docs/dcs/api-ref/dcs-api-0312007.html | 140 +- docs/dcs/api-ref/dcs-api-0312008.html | 58 +- docs/dcs/api-ref/dcs-api-0312009.html | 118 +- docs/dcs/api-ref/dcs-api-0312010.html | 86 +- docs/dcs/api-ref/dcs-api-0312013.html | 4 + docs/dcs/api-ref/dcs-api-0312014.html | 118 +- docs/dcs/api-ref/dcs-api-0312015.html | 2000 +++++----- docs/dcs/api-ref/dcs-api-0312016.html | 351 +- docs/dcs/api-ref/dcs-api-0312017.html | 108 +- docs/dcs/api-ref/dcs-api-0312018.html | 106 +- docs/dcs/api-ref/dcs-api-0312019.html | 122 +- docs/dcs/api-ref/dcs-api-0312020.html | 86 +- docs/dcs/api-ref/dcs-api-0312021.html | 95 +- docs/dcs/api-ref/dcs-api-0312022.html | 242 +- docs/dcs/api-ref/dcs-api-0312023.html | 190 +- docs/dcs/api-ref/dcs-api-0312024.html | 77 +- docs/dcs/api-ref/dcs-api-0312035.html | 11 +- docs/dcs/api-ref/dcs-api-0312036.html | 150 +- docs/dcs/api-ref/dcs-api-0312038.html | 4 + docs/dcs/api-ref/dcs-api-0312039.html | 94 +- docs/dcs/api-ref/dcs-api-0312040.html | 285 +- docs/dcs/api-ref/dcs-api-0312041.html | 70 +- docs/dcs/api-ref/dcs-api-0312042.html | 4 +- docs/dcs/api-ref/dcs-api-0312044.html | 2793 -------------- docs/dcs/api-ref/dcs-api-0312045.html | 34 +- docs/dcs/api-ref/dcs-api-0312049.html | 74 +- docs/dcs/api-ref/dcs-api-0312050.html | 228 ++ docs/dcs/api-ref/dcs-api-0514003.html | 15 - docs/dcs/api-ref/dcs-api-0514004.html | 394 -- docs/dcs/api-ref/dcs-api-0514005.html | 6 +- docs/dcs/api-ref/dcs-api-0605001.html | 38 + docs/dcs/api-ref/dcs-api-0605002.html | 23 + .../api-ref/en-us_topic_0000001645635650.html | 163 + .../api-ref/en-us_topic_0000001693796125.html | 171 + .../api-ref/en-us_topic_0000001693875369.html | 14 + docs/dcs/api-ref/topic_300000009.html | 13 - 132 files changed, 38733 insertions(+), 6653 deletions(-) delete mode 100644 docs/dcs/api-ref/.placeholder create mode 100644 docs/dcs/api-ref/BackgroudTasksManagement.html create mode 100644 docs/dcs/api-ref/BackupRestoreManagement.html create mode 100644 docs/dcs/api-ref/BatchCreateOrDeleteTags.html create mode 100644 docs/dcs/api-ref/BatchDeleteInstances.html create mode 100644 docs/dcs/api-ref/BatchShowNodesInformation.html create mode 100644 docs/dcs/api-ref/BatchStopMigrationTasks.html create mode 100644 docs/dcs/api-ref/CacheAnalysisManagement.html create mode 100644 docs/dcs/api-ref/ChangeMasterStandby.html create mode 100644 docs/dcs/api-ref/ConfigTemplatesManagement.html create mode 100644 docs/dcs/api-ref/CopyInstance.html create mode 100644 docs/dcs/api-ref/CreateAutoExpireScanTask.html create mode 100644 docs/dcs/api-ref/CreateBigkeyScanTask.html create mode 100644 docs/dcs/api-ref/CreateCustomTemplate.html create mode 100644 docs/dcs/api-ref/CreateHotkeyScanTask.html create mode 100644 docs/dcs/api-ref/CreateInstance.html create mode 100644 docs/dcs/api-ref/CreateMigrationTask.html create mode 100644 docs/dcs/api-ref/CreateOnlineMigrationTask.html create mode 100644 docs/dcs/api-ref/CreateRedislog.html create mode 100644 docs/dcs/api-ref/CreateRedislogDownloadLink.html create mode 100644 docs/dcs/api-ref/DataMigrationManagement.html create mode 100644 docs/dcs/api-ref/DeleteBackgroundTask.html create mode 100644 docs/dcs/api-ref/DeleteBackupFile.html create mode 100644 docs/dcs/api-ref/DeleteBigkeyScanTask.html create mode 100644 docs/dcs/api-ref/DeleteCenterTask.html create mode 100644 docs/dcs/api-ref/DeleteHotkeyScanTask.html create mode 100644 docs/dcs/api-ref/DeleteIpFromDomainName.html create mode 100644 docs/dcs/api-ref/DeleteMigrationTask.html create mode 100644 docs/dcs/api-ref/DeleteSingleInstance.html create mode 100644 docs/dcs/api-ref/DownloadSSLCert.html create mode 100644 docs/dcs/api-ref/ErrorCode.html create mode 100644 docs/dcs/api-ref/GroupReplicationManagement.html create mode 100644 docs/dcs/api-ref/InstanceDiagnosisManagement.html create mode 100644 docs/dcs/api-ref/InstanceManagement.html create mode 100644 docs/dcs/api-ref/LifecycleManagement.html create mode 100644 docs/dcs/api-ref/ListAvailableZones.html create mode 100644 docs/dcs/api-ref/ListBackgroundTask.html create mode 100644 docs/dcs/api-ref/ListBackupFileLinks.html create mode 100644 docs/dcs/api-ref/ListBackupRecords.html create mode 100644 docs/dcs/api-ref/ListBigkeyScanTasks.html create mode 100644 docs/dcs/api-ref/ListConfigHistories.html create mode 100644 docs/dcs/api-ref/ListConfigTemplates.html create mode 100644 docs/dcs/api-ref/ListConfigurations.html create mode 100644 docs/dcs/api-ref/ListDiagnosisTasks.html create mode 100644 docs/dcs/api-ref/ListFlavors.html create mode 100644 docs/dcs/api-ref/ListGroupReplicationInfo.html create mode 100644 docs/dcs/api-ref/ListHotKeyScanTasks.html create mode 100644 docs/dcs/api-ref/ListInstances.html create mode 100644 docs/dcs/api-ref/ListMaintenanceWindows.html create mode 100644 docs/dcs/api-ref/ListMigrationTask.html create mode 100644 docs/dcs/api-ref/ListMonitoredObjects.html create mode 100644 docs/dcs/api-ref/ListMonitoredObjectsOfInstance.html create mode 100644 docs/dcs/api-ref/ListRedislog.html create mode 100644 docs/dcs/api-ref/ListRestoreRecords.html create mode 100644 docs/dcs/api-ref/ListSlowlog.html create mode 100644 docs/dcs/api-ref/ListStatisticsOfRunningInstances.html create mode 100644 docs/dcs/api-ref/ListTagsOfTenant.html create mode 100644 docs/dcs/api-ref/LogManagement.html create mode 100644 docs/dcs/api-ref/NetworkSecurityManagement.html create mode 100644 docs/dcs/api-ref/OtherInterface.html create mode 100644 docs/dcs/api-ref/ParamManagement.html create mode 100644 docs/dcs/api-ref/ResizeInstance.html create mode 100644 docs/dcs/api-ref/RestartOrFlushInstances.html create mode 100644 docs/dcs/api-ref/RestoreInstance.html create mode 100644 docs/dcs/api-ref/SetOnlineMigrationTask.html create mode 100644 docs/dcs/api-ref/ShowBigkeyAutoscanConfig.html create mode 100644 docs/dcs/api-ref/ShowBigkeyScanTaskDetails.html create mode 100644 docs/dcs/api-ref/ShowDiagnosisTaskDetails.html create mode 100644 docs/dcs/api-ref/ShowHotkeyAutoscanConfig.html create mode 100644 docs/dcs/api-ref/ShowHotkeyTaskDetails.html create mode 100644 docs/dcs/api-ref/ShowInstance.html create mode 100644 docs/dcs/api-ref/ShowInstanceSSLDetail.html create mode 100644 docs/dcs/api-ref/ShowJobInfo.html create mode 100644 docs/dcs/api-ref/ShowMigrationTask.html create mode 100644 docs/dcs/api-ref/ShowMigrationTaskStats.html create mode 100644 docs/dcs/api-ref/ShowQuotaOfTenant.html create mode 100644 docs/dcs/api-ref/ShowTags.html create mode 100644 docs/dcs/api-ref/StopMigrationTask.html create mode 100644 docs/dcs/api-ref/TagManagement.html create mode 100644 docs/dcs/api-ref/UpdateBigkeyAutoscanConfig.html create mode 100644 docs/dcs/api-ref/UpdateConfigurations.html create mode 100644 docs/dcs/api-ref/UpdateHotkeyAutoScanConfig.html create mode 100644 docs/dcs/api-ref/UpdateInstance.html create mode 100644 docs/dcs/api-ref/UpdateMigrationTask.html create mode 100644 docs/dcs/api-ref/UpdatePassword.html create mode 100644 docs/dcs/api-ref/UpdateSSLSwitch.html create mode 100644 docs/dcs/api-ref/UpdateSlavePriority.html create mode 100644 docs/dcs/api-ref/api-grant-policy.html delete mode 100644 docs/dcs/api-ref/dcs-api-0312044.html create mode 100644 docs/dcs/api-ref/dcs-api-0312050.html delete mode 100644 docs/dcs/api-ref/dcs-api-0514003.html delete mode 100644 docs/dcs/api-ref/dcs-api-0514004.html create mode 100644 docs/dcs/api-ref/dcs-api-0605001.html create mode 100644 docs/dcs/api-ref/dcs-api-0605002.html create mode 100644 docs/dcs/api-ref/en-us_topic_0000001645635650.html create mode 100644 docs/dcs/api-ref/en-us_topic_0000001693796125.html create mode 100644 docs/dcs/api-ref/en-us_topic_0000001693875369.html delete mode 100644 docs/dcs/api-ref/topic_300000009.html diff --git a/docs/dcs/api-ref/.placeholder b/docs/dcs/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/dcs/api-ref/ALL_META.TXT.json b/docs/dcs/api-ref/ALL_META.TXT.json index a4dca720..8fd8f069 100644 --- a/docs/dcs/api-ref/ALL_META.TXT.json +++ b/docs/dcs/api-ref/ALL_META.TXT.json @@ -1,391 +1,2407 @@ [ + { + "dockw":"Redis,API参考-缓存,API Reference" + }, { "uri":"dcs-api-0417001.html", + "node_id":"dcs-api-0417001.xml", "product_code":"dcs", "code":"1", "des":"Distributed Cache Service (DCS) APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by o", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { - "uri":"dcs-api-0312003.html", + "uri":"en-us_topic_0000001693875369.html", + "node_id":"en-us_topic_0000001693875369.xml", "product_code":"dcs", "code":"2", "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":"Lifecycle Management APIs", - "title":"Lifecycle Management APIs", + "kw":"API Version Query", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"API Version Query", "githuburl":"" }, { - "uri":"dcs-api-0312004.html", + "uri":"en-us_topic_0000001693796125.html", + "node_id":"en-us_topic_0000001693796125.xml", "product_code":"dcs", "code":"3", - "des":"This API is used to create a DCS instance.The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.POST /v1.0/", + "des":"Querying Information of an API Version.URI formatGET /{api_version}ParametersParameterTypeDescriptionapi_versionStringTarget API version.The value can be v1.0 or v2.Sampl", "doc_type":"api", - "kw":"Creating a DCS Instance,Lifecycle Management APIs,API Reference", + "kw":"Querying Information of an API Version,API Version Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying Information of an API Version", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000001645635650.html", + "node_id":"en-us_topic_0000001645635650.xml", + "product_code":"dcs", + "code":"4", + "des":"This API is used to query the list of API versions.URI formatGET /Sample:GET https://{dcs_endpoint}/For details, see Error Codes.", + "doc_type":"api", + "kw":"Querying the List of API Versions,API Version Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying the List of API Versions", + "githuburl":"" + }, + { + "uri":"dcs-api-0605001.html", + "node_id":"dcs-api-0605001.xml", + "product_code":"dcs", + "code":"5", + "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":"APIs V2 (Recommended)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"APIs V2 (Recommended)", + "githuburl":"" + }, + { + "uri":"LifecycleManagement.html", + "node_id":"lifecyclemanagement.xml", + "product_code":"", + "code":"6", + "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":"Lifecycle Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Lifecycle Management", + "githuburl":"" + }, + { + "uri":"CreateInstance.html", + "node_id":"createinstance.xml", + "product_code":"", + "code":"7", + "des":"This API is used to create a DCS instance which is billed in pay-per-use mode.POST /v2/{project_id}/instancesStatus code: 200Status code: 400Status code: 401Status code: ", + "doc_type":"api", + "kw":"Creating a DCS Instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateInstance" + } + ], "title":"Creating a DCS Instance", "githuburl":"" }, { - "uri":"dcs-api-0312008.html", - "product_code":"dcs", - "code":"4", - "des":"This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}Table 1 describ", + "uri":"ListInstances.html", + "node_id":"listinstances.xml", + "product_code":"", + "code":"8", + "des":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v2/{project_id}/instancesNoneStatus code: 200Status code: 400Status cod", "doc_type":"api", - "kw":"Deleting a Single DCS Instance,Lifecycle Management APIs,API Reference", - "title":"Deleting a Single DCS Instance", + "kw":"Querying All DCS Instances,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListInstances" + } + ], + "title":"Querying All DCS Instances", "githuburl":"" }, { - "uri":"dcs-api-0312009.html", - "product_code":"dcs", - "code":"5", - "des":"This API is used to delete multiple DCS instances at a time.DELETE /v1.0/{project_id}/instances?allFailure={allFailure}Table 1 describes the parameters.Parameter descript", + "uri":"BatchDeleteInstances.html", + "node_id":"batchdeleteinstances.xml", + "product_code":"", + "code":"9", + "des":"This API is used to delete multiple DCS instances at a time.DELETE /v2/{project_id}/instancesStatus code: 200Status code: 500Status code: 400Batch deleting DCS instancesS", "doc_type":"api", - "kw":"Batch Deleting DCS Instances,Lifecycle Management APIs,API Reference", + "kw":"Batch Deleting DCS Instances,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchDeleteInstances" + } + ], "title":"Batch Deleting DCS Instances", "githuburl":"" }, { - "uri":"dcs-api-0312005.html", - "product_code":"dcs", - "code":"6", - "des":"This API is used to query the details about a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}Table 1 describes the parameters.Parameter descriptionP", - "doc_type":"api", - "kw":"Querying a DCS Instance,Lifecycle Management APIs,API Reference", - "title":"Querying a DCS Instance", - "githuburl":"" - }, - { - "uri":"dcs-api-0312006.html", - "product_code":"dcs", - "code":"7", - "des":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&sta", - "doc_type":"api", - "kw":"Querying All DCS Instances of a Tenant,Lifecycle Management APIs,API Reference", - "title":"Querying All DCS Instances of a Tenant", - "githuburl":"" - }, - { - "uri":"dcs-api-0312007.html", - "product_code":"dcs", - "code":"8", - "des":"This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, an", - "doc_type":"api", - "kw":"Modifying Information About a DCS Instance,Lifecycle Management APIs,API Reference", - "title":"Modifying Information About a DCS Instance", - "githuburl":"" - }, - { - "uri":"dcs-api-0312010.html", - "product_code":"dcs", - "code":"9", - "des":"This API is used to scale up a DCS Redis instance in the Running state.POST /v1.0/{project_id}/instances/{instance_id}/extendTable 1 describes the parameters.Parameter de", - "doc_type":"api", - "kw":"Scaling Up a DCS Instance,Lifecycle Management APIs,API Reference", - "title":"Scaling Up a DCS Instance", - "githuburl":"" - }, - { - "uri":"dcs-api-0312035.html", - "product_code":"dcs", + "uri":"ShowInstance.html", + "node_id":"showinstance.xml", + "product_code":"", "code":"10", + "des":"This API is used to query the details about a specified DCS instance.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Status code: 200The specified instanc", + "doc_type":"api", + "kw":"Querying a DCS instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowInstance" + } + ], + "title":"Querying a DCS instance", + "githuburl":"" + }, + { + "uri":"DeleteSingleInstance.html", + "node_id":"deletesingleinstance.xml", + "product_code":"", + "code":"11", + "des":"This API is used to delete a specified DCS instance to free up all resources occupied by it.To delete pay-per-use resources, perform operations in this section..DELETE /v", + "doc_type":"api", + "kw":"Deleting an Instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteSingleInstance" + } + ], + "title":"Deleting an Instance", + "githuburl":"" + }, + { + "uri":"UpdateInstance.html", + "node_id":"updateinstance.xml", + "product_code":"", + "code":"12", + "des":"This API is used to modify the information about a DCS instance, including the instance name, description, port, backup policy, start and end time of the maintenance wind", + "doc_type":"api", + "kw":"Modifying Details of a DCS Instance,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateInstance" + } + ], + "title":"Modifying Details of a DCS Instance", + "githuburl":"" + }, + { + "uri":"ResizeInstance.html", + "node_id":"resizeinstance.xml", + "product_code":"", + "code":"13", + "des":"This API is used to modify specifications of a DCS instance in the Running state.POST /v2/{project_id}/instances/{instance_id}/resizeNoneChanging instance specifications ", + "doc_type":"api", + "kw":"Modifying Instance Specifications,Lifecycle Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ResizeInstance" + } + ], + "title":"Modifying Instance Specifications", + "githuburl":"" + }, + { + "uri":"InstanceManagement.html", + "node_id":"instancemanagement.xml", + "product_code":"", + "code":"14", "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":"Instance Management APIs", - "title":"Instance Management APIs", + "kw":"Instance Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Instance Management", "githuburl":"" }, { - "uri":"dcs-api-0312018.html", - "product_code":"dcs", - "code":"11", - "des":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.PUT /v1.0/{project_id}/instances/statusTa", + "uri":"ChangeMasterStandby.html", + "node_id":"changemasterstandby.xml", + "product_code":"", + "code":"15", + "des":"This API is used to perform a master/standby switchover. Only master/standby instances support this operation.POST /v2/{project_id}/instances/{instance_id}/swapNoneStatus", "doc_type":"api", - "kw":"Restarting DCS Instances or Clearing DCS Instance Data,Instance Management APIs,API Reference", + "kw":"Master/Standby Switchover,Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ChangeMasterStandby" + } + ], + "title":"Master/Standby Switchover", + "githuburl":"" + }, + { + "uri":"UpdatePassword.html", + "node_id":"updatepassword.xml", + "product_code":"", + "code":"16", + "des":"This API is used to change the password of a DCS instance.PUT /v2/{project_id}/instances/{instance_id}/passwordStatus code: 200Status code: 400Status code: 500Changing th", + "doc_type":"api", + "kw":"Changing the Password,Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdatePassword" + } + ], + "title":"Changing the Password", + "githuburl":"" + }, + { + "uri":"RestartOrFlushInstances.html", + "node_id":"restartorflushinstances.xml", + "product_code":"", + "code":"17", + "des":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0, 5.0, and 6.0 instances.PUT /v2/{project_id}/instances/stat", + "doc_type":"api", + "kw":"Restarting DCS Instances or Clearing DCS Instance Data,Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"RestartOrFlushInstances" + } + ], "title":"Restarting DCS Instances or Clearing DCS Instance Data", "githuburl":"" }, { - "uri":"dcs-api-0312014.html", - "product_code":"dcs", - "code":"12", - "des":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v1.0/{project_id}/instances/statisticTable 1 describes the parameter.Para", + "uri":"ListStatisticsOfRunningInstances.html", + "node_id":"liststatisticsofrunninginstances.xml", + "product_code":"", + "code":"18", + "des":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v2/{project_id}/instances/statisticNoneStatus code: 200Status code: 400St", "doc_type":"api", - "kw":"Querying Statistics of All Running Instances,Instance Management APIs,API Reference", + "kw":"Querying Statistics of All Running Instances,Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListStatisticsOfRunningInstances" + } + ], "title":"Querying Statistics of All Running Instances", "githuburl":"" }, { - "uri":"dcs-api-0312016.html", - "product_code":"dcs", - "code":"13", - "des":"This API is used to query the number of instances in different states.GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}Table 1 describes the paramet", - "doc_type":"api", - "kw":"Querying DCS Instance Status,Instance Management APIs,API Reference", - "title":"Querying DCS Instance Status", - "githuburl":"" - }, - { - "uri":"dcs-api-0312019.html", - "product_code":"dcs", - "code":"14", - "des":"This API is used to change the password of a DCS instance.PUT /v1.0/{project_id}/instances/{instance_id}/passwordTable 1 describes the parameters.Parameter descriptionPar", - "doc_type":"api", - "kw":"Changing the Password of a DCS Instance,Instance Management APIs,API Reference", - "title":"Changing the Password of a DCS Instance", - "githuburl":"" - }, - { - "uri":"dcs-api-0312013.html", - "product_code":"dcs", - "code":"15", + "uri":"GroupReplicationManagement.html", + "node_id":"groupreplicationmanagement.xml", + "product_code":"", + "code":"19", "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":"Parameter Management APIs", - "title":"Parameter Management APIs", + "kw":"Shards and Replicas", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Shards and Replicas", "githuburl":"" }, { - "uri":"dcs-api-0312017.html", - "product_code":"dcs", - "code":"16", - "des":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v1.0/{project_id}/instances/{instance_id}/con", + "uri":"UpdateSlavePriority.html", + "node_id":"updateslavepriority.xml", + "product_code":"", + "code":"20", + "des":"This API is used to configure the replica priority. When the master node is faulty, a replica with a smaller weight has a higher priority to be promoted to master.POST /v", "doc_type":"api", - "kw":"Modifying Configuration Parameters,Parameter Management APIs,API Reference", + "kw":"Configuring Replica Priority,Shards and Replicas,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateSlavePriority" + } + ], + "title":"Configuring Replica Priority", + "githuburl":"" + }, + { + "uri":"DeleteIpFromDomainName.html", + "node_id":"deleteipfromdomainname.xml", + "product_code":"", + "code":"21", + "des":"This API is used to remove the IP address of a read replica from the domain name. After the removal, the read-only domain name will not be resolved to the IP address.DELE", + "doc_type":"api", + "kw":"Removing the IP Address,Shards and Replicas,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteIpFromDomainName" + } + ], + "title":"Removing the IP Address", + "githuburl":"" + }, + { + "uri":"ListGroupReplicationInfo.html", + "node_id":"listgroupreplicationinfo.xml", + "product_code":"", + "code":"22", + "des":"This API is used to query shards and replicas of cluster instances.GET /v2/{project_id}/instance/{instance_id}/groupsNoneStatus code: 200Status code: 500Status code: 400S", + "doc_type":"api", + "kw":"Querying Details of Shards,Shards and Replicas,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListGroupReplicationInfo" + } + ], + "title":"Querying Details of Shards", + "githuburl":"" + }, + { + "uri":"BatchShowNodesInformation.html", + "node_id":"batchshownodesinformation.xml", + "product_code":"", + "code":"23", + "des":"This API is used to query the node information, number of valid instances, and number of nodes of all instances in a specified project. No node information will be return", + "doc_type":"api", + "kw":"Querying Instance Nodes in Batches,Shards and Replicas,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchShowNodesInformation" + } + ], + "title":"Querying Instance Nodes in Batches", + "githuburl":"" + }, + { + "uri":"ParamManagement.html", + "node_id":"parammanagement.xml", + "product_code":"", + "code":"24", + "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":"Parameter Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Parameter Management", + "githuburl":"" + }, + { + "uri":"ListConfigurations.html", + "node_id":"listconfigurations.xml", + "product_code":"", + "code":"25", + "des":"This API is used to query the configuration parameters of a DCS instance.GET /v2/{project_id}/instances/{instance_id}/configsNoneStatus code: 200Status code: 400Status co", + "doc_type":"api", + "kw":"Querying DCS Instance Configuration Parameters,Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListConfigurations" + } + ], + "title":"Querying DCS Instance Configuration Parameters", + "githuburl":"" + }, + { + "uri":"UpdateConfigurations.html", + "node_id":"updateconfigurations.xml", + "product_code":"", + "code":"26", + "des":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v2/{project_id}/instances/{instance_id}/confi", + "doc_type":"api", + "kw":"Modifying Configuration Parameters,Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateConfigurations" + } + ], "title":"Modifying Configuration Parameters", "githuburl":"" }, { - "uri":"dcs-api-0312015.html", - "product_code":"dcs", - "code":"17", - "des":"This API is used to query the configuration parameters of a DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/configsTable 1 describes the parameters.Parameter ", + "uri":"ListConfigHistories.html", + "node_id":"listconfighistories.xml", + "product_code":"", + "code":"27", + "des":"This API is used to query the parameter modification record list of an instance by keyword.GET /v2/{project_id}/instances/{instance_id}/config-historiesNoneStatus code: 2", "doc_type":"api", - "kw":"Querying Configuration Parameters,Parameter Management APIs,API Reference", - "title":"Querying Configuration Parameters", + "kw":"Querying the List of Instance Parameter Modification Records,Parameter Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListConfigHistories" + } + ], + "title":"Querying the List of Instance Parameter Modification Records", "githuburl":"" }, { - "uri":"dcs-api-0514003.html", - "product_code":"dcs", - "code":"18", + "uri":"BackupRestoreManagement.html", + "node_id":"backuprestoremanagement.xml", + "product_code":"", + "code":"28", "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":"Data Migration APIs", - "title":"Data Migration APIs", + "kw":"Backup and Restoration", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Backup and Restoration", "githuburl":"" }, { - "uri":"dcs-api-0514004.html", - "product_code":"dcs", - "code":"19", - "des":"This API is used to create a data migration task.NonePOST /v2/{project_id}/migration-taskIf the status code is 200, the following parameters are returned:Example request ", + "uri":"DeleteBackupFile.html", + "node_id":"deletebackupfile.xml", + "product_code":"", + "code":"29", + "des":"This API is used to delete the backup files of a DCS instance.DELETE /v2/{project_id}/instances/{instance_id}/backups/{backup_id}NoneStatus code: 400Status code: 500NoneS", "doc_type":"api", - "kw":"Creating a Data Migration Task,Data Migration APIs,API Reference", - "title":"Creating a Data Migration Task", - "githuburl":"" - }, - { - "uri":"dcs-api-0514005.html", - "product_code":"dcs", - "code":"20", - "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":"Backup and Restoration APIs", - "title":"Backup and Restoration APIs", - "githuburl":"" - }, - { - "uri":"dcs-api-0312020.html", - "product_code":"dcs", - "code":"21", - "des":"This API is used to back up a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", - "doc_type":"api", - "kw":"Backing Up a DCS Instance,Backup and Restoration APIs,API Reference", - "title":"Backing Up a DCS Instance", - "githuburl":"" - }, - { - "uri":"dcs-api-0312021.html", - "product_code":"dcs", - "code":"22", - "des":"This API is used to restore a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", - "doc_type":"api", - "kw":"Restoring a DCS Instance,Backup and Restoration APIs,API Reference", - "title":"Restoring a DCS Instance", - "githuburl":"" - }, - { - "uri":"dcs-api-0312022.html", - "product_code":"dcs", - "code":"23", - "des":"This API is used to query the backup records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beg", - "doc_type":"api", - "kw":"Querying DCS Instance Backup Records,Backup and Restoration APIs,API Reference", - "title":"Querying DCS Instance Backup Records", - "githuburl":"" - }, - { - "uri":"dcs-api-0312023.html", - "product_code":"dcs", - "code":"24", - "des":"This API is used to query the restoration records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTim", - "doc_type":"api", - "kw":"Querying DCS Instance Restoration Records,Backup and Restoration APIs,API Reference", - "title":"Querying DCS Instance Restoration Records", - "githuburl":"" - }, - { - "uri":"dcs-api-0312024.html", - "product_code":"dcs", - "code":"25", - "des":"This API is used to delete the files backed up by a DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}Table 1 describes the parameters.Par", - "doc_type":"api", - "kw":"Deleting Backup Files,Backup and Restoration APIs,API Reference", + "kw":"Deleting Backup Files,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteBackupFile" + } + ], "title":"Deleting Backup Files", "githuburl":"" }, { - "uri":"topic_300000009.html", + "uri":"RestoreInstance.html", + "node_id":"restoreinstance.xml", "product_code":"", - "code":"26", + "code":"30", + "des":"This API is used to restore the backup data to a specific DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node inst", + "doc_type":"api", + "kw":"Restoring a DCS Instance,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"RestoreInstance" + } + ], + "title":"Restoring a DCS Instance", + "githuburl":"" + }, + { + "uri":"ListRestoreRecords.html", + "node_id":"listrestorerecords.xml", + "product_code":"", + "code":"31", + "des":"This API is used to query the restoration records of a specific DCS instance.GET /v2/{project_id}/instances/{instance_id}/restoresNoneStatus code: 200Status code: 400Stat", + "doc_type":"api", + "kw":"Querying DCS Instance Restoration Records,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListRestoreRecords" + } + ], + "title":"Querying DCS Instance Restoration Records", + "githuburl":"" + }, + { + "uri":"ListBackupFileLinks.html", + "node_id":"listbackupfilelinks.xml", + "product_code":"", + "code":"32", + "des":"This API is used to obtain the download links of backup files.POST /v2/{project_id}/instances/{instance_id}/backups/{backup_id}/linksStatus code: 200Status code: 400Statu", + "doc_type":"api", + "kw":"Obtaining the Backup File URL,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListBackupFileLinks" + } + ], + "title":"Obtaining the Backup File URL", + "githuburl":"" + }, + { + "uri":"CopyInstance.html", + "node_id":"copyinstance.xml", + "product_code":"", + "code":"33", + "des":"This API is used to back up a specific DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST /", + "doc_type":"api", + "kw":"Backing Up a DCS Instance,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CopyInstance" + } + ], + "title":"Backing Up a DCS Instance", + "githuburl":"" + }, + { + "uri":"ListBackupRecords.html", + "node_id":"listbackuprecords.xml", + "product_code":"", + "code":"34", + "des":"This API is used to query the backup records of a specific DCS instance.GET /v2/{project_id}/instances/{instance_id}/backupsNoneStatus code: 200Status code: 400Status cod", + "doc_type":"api", + "kw":"Listing DCS Instance Backup Records,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListBackupRecords" + } + ], + "title":"Listing DCS Instance Backup Records", + "githuburl":"" + }, + { + "uri":"DataMigrationManagement.html", + "node_id":"datamigrationmanagement.xml", + "product_code":"", + "code":"35", "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":"", + "doc_type":"api", + "kw":"Data Migration", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Data Migration", + "githuburl":"" + }, + { + "uri":"CreateMigrationTask.html", + "node_id":"createmigrationtask.xml", + "product_code":"", + "code":"36", + "des":"This API is used to create a backup import task.POST /v2/{project_id}/migration-taskStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404Status", + "doc_type":"api", + "kw":"Creating a Backup Import Task,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateMigrationTask" + } + ], + "title":"Creating a Backup Import Task", + "githuburl":"" + }, + { + "uri":"ListMigrationTask.html", + "node_id":"listmigrationtask.xml", + "product_code":"", + "code":"37", + "des":"This API is used to query the migration task list.GET /v2/{project_id}/migration-tasksNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404", + "doc_type":"api", + "kw":"Listing Migration Tasks,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListMigrationTask" + } + ], + "title":"Listing Migration Tasks", + "githuburl":"" + }, + { + "uri":"DeleteMigrationTask.html", + "node_id":"deletemigrationtask.xml", + "product_code":"", + "code":"38", + "des":"This API is used to delete data migration tasks.DELETE /v2/{project_id}/migration-tasks/deleteStatus code: 200Status code: 400Status code: 401Status code: 403Status code:", + "doc_type":"api", + "kw":"Deleting Data Migration Tasks,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteMigrationTask" + } + ], + "title":"Deleting Data Migration Tasks", + "githuburl":"" + }, + { + "uri":"ShowMigrationTask.html", + "node_id":"showmigrationtask.xml", + "product_code":"", + "code":"39", + "des":"This API is used to query migration task details.GET /v2/{project_id}/migration-task/{task_id}NoneStatus code: 200Status code: 400Status code: 401Status code: 403Status c", + "doc_type":"api", + "kw":"Querying Details of a Data Migration Task,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowMigrationTask" + } + ], + "title":"Querying Details of a Data Migration Task", + "githuburl":"" + }, + { + "uri":"UpdateMigrationTask.html", + "node_id":"updatemigrationtask.xml", + "product_code":"", + "code":"40", + "des":"This API is used to configure auto-reconnect for migration tasks.PUT /v2/{project_id}/migration-task/{task_id}Status code: 400Status code: 401Status code: 403Status code:", + "doc_type":"api", + "kw":"Configuring Auto-Reconnect for Migration Tasks,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateMigrationTask" + } + ], + "title":"Configuring Auto-Reconnect for Migration Tasks", + "githuburl":"" + }, + { + "uri":"StopMigrationTask.html", + "node_id":"stopmigrationtask.xml", + "product_code":"", + "code":"41", + "des":"This API is used to stop a data migration task.POST /v2/{project_id}/migration-task/{task_id}/stopNoneStatus code: 200Status code: 400Status code: 401Status code: 403Stat", + "doc_type":"api", + "kw":"Stopping a Data Migration Task,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"StopMigrationTask" + } + ], + "title":"Stopping a Data Migration Task", + "githuburl":"" + }, + { + "uri":"ShowMigrationTaskStats.html", + "node_id":"showmigrationtaskstats.xml", + "product_code":"", + "code":"42", + "des":"This API is used to query progress details about an online migration task.GET /v2/{project_id}/migration-task/{task_id}/statsNoneStatus code: 200Status code: 400Status co", + "doc_type":"api", + "kw":"Querying the Progress of an Online Migration Task,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowMigrationTaskStats" + } + ], + "title":"Querying the Progress of an Online Migration Task", + "githuburl":"" + }, + { + "uri":"CreateOnlineMigrationTask.html", + "node_id":"createonlinemigrationtask.xml", + "product_code":"", + "code":"43", + "des":"This API is used to create an online data migration task.POST /v2/{project_id}/migration/instanceStatus code: 200Status code: 400Status code: 401Status code: 403Status co", + "doc_type":"api", + "kw":"Creating an Online Data Migration Task,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateOnlineMigrationTask" + } + ], + "title":"Creating an Online Data Migration Task", + "githuburl":"" + }, + { + "uri":"SetOnlineMigrationTask.html", + "node_id":"setonlinemigrationtask.xml", + "product_code":"", + "code":"44", + "des":"This API is used to configure an online data migration task.POST /v2/{project_id}/migration/{task_id}/taskStatus code: 200Status code: 400Status code: 401Status code: 403", + "doc_type":"api", + "kw":"Configuring an Online Data Migration Task,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"SetOnlineMigrationTask" + } + ], + "title":"Configuring an Online Data Migration Task", + "githuburl":"" + }, + { + "uri":"BatchStopMigrationTasks.html", + "node_id":"batchstopmigrationtasks.xml", + "product_code":"", + "code":"45", + "des":"This API is used to stop data migration tasks in batches. If a success response is returned, the request is successfully delivered. The migration tasks are stopped only w", + "doc_type":"api", + "kw":"Stopping Data Migration Tasks,Data Migration,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchStopMigrationTasks" + } + ], + "title":"Stopping Data Migration Tasks", + "githuburl":"" + }, + { + "uri":"TagManagement.html", + "node_id":"tagmanagement.xml", + "product_code":"", + "code":"46", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"ListTagsOfTenant.html", + "node_id":"listtagsoftenant.xml", + "product_code":"", + "code":"47", + "des":"This API is used to query the tags of all resources owned by a tenant in a specific project.GET /v2/{project_id}/dcs/tagsNoneStatus code: 200Status code: 400Status code: ", + "doc_type":"api", + "kw":"Listing All Tags of a Tenant,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListTagsOfTenant" + } + ], + "title":"Listing All Tags of a Tenant", + "githuburl":"" + }, + { + "uri":"BatchCreateOrDeleteTags.html", + "node_id":"batchcreateordeletetags.xml", + "product_code":"", + "code":"48", + "des":"This API is used to add or delete tags in batches for a DCS instance.POST /v2/{project_id}/dcs/{instance_id}/tags/actionNoneAdding tags to a specified resource in batches", + "doc_type":"api", + "kw":"Batch Adding or Deleting Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchCreateOrDeleteTags" + } + ], + "title":"Batch Adding or Deleting Tags", + "githuburl":"" + }, + { + "uri":"ShowTags.html", + "node_id":"showtags.xml", + "product_code":"", + "code":"49", + "des":"This API is used to query the tags of an instance by its instance ID.GET /v2/{project_id}/instances/{instance_id}/tagsNoneStatus code: 200Status code: 200Instance tags qu", + "doc_type":"api", + "kw":"Querying Tags of a DCS Instance,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowTags" + } + ], + "title":"Querying Tags of a DCS Instance", + "githuburl":"" + }, + { + "uri":"CacheAnalysisManagement.html", + "node_id":"cacheanalysismanagement.xml", + "product_code":"", + "code":"50", + "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":"Cache Analysis", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Cache Analysis", + "githuburl":"" + }, + { + "uri":"CreateBigkeyScanTask.html", + "node_id":"createbigkeyscantask.xml", + "product_code":"", + "code":"51", + "des":"This API is used to create a big key analysis task for a DCS Redis instance.POST /v2/{project_id}/instances/{instance_id}/bigkey-taskNoneStatus code: 200Status code: 400S", + "doc_type":"api", + "kw":"Creating a Big Key Analysis Task,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateBigkeyScanTask" + } + ], + "title":"Creating a Big Key Analysis Task", + "githuburl":"" + }, + { + "uri":"ListBigkeyScanTasks.html", + "node_id":"listbigkeyscantasks.xml", + "product_code":"", + "code":"52", + "des":"This API is used to query the list of big key analysis tasks.GET /v2/{project_id}/instances/{instance_id}/bigkey-tasksNoneStatus code: 200Status code: 400Status code: 401", + "doc_type":"api", + "kw":"Listing Big Key Analysis Tasks,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListBigkeyScanTasks" + } + ], + "title":"Listing Big Key Analysis Tasks", + "githuburl":"" + }, + { + "uri":"ShowBigkeyScanTaskDetails.html", + "node_id":"showbigkeyscantaskdetails.xml", + "product_code":"", + "code":"53", + "des":"This API is used to query the big key analysis details.GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}NoneStatus code: 200Status code: 400Status code", + "doc_type":"api", + "kw":"Querying Big Key Analysis Details,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowBigkeyScanTaskDetails" + } + ], + "title":"Querying Big Key Analysis Details", + "githuburl":"" + }, + { + "uri":"DeleteBigkeyScanTask.html", + "node_id":"deletebigkeyscantask.xml", + "product_code":"", + "code":"54", + "des":"This API is used to delete a big key analysis task.DELETE /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}NoneStatus code: 200Status code: 400Status code:", + "doc_type":"api", + "kw":"Deleting a Big Key Analysis Task,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteBigkeyScanTask" + } + ], + "title":"Deleting a Big Key Analysis Task", + "githuburl":"" + }, + { + "uri":"UpdateBigkeyAutoscanConfig.html", + "node_id":"updatebigkeyautoscanconfig.xml", + "product_code":"", + "code":"55", + "des":"This API is used to configure automatic big key analysis.PUT /v2/{project_id}/instances/{instance_id}/bigkey/autoscanStatus code: 200Status code: 400Status code: 401Statu", + "doc_type":"api", + "kw":"Configuring Automatic Big Key Analysis,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateBigkeyAutoscanConfig" + } + ], + "title":"Configuring Automatic Big Key Analysis", + "githuburl":"" + }, + { + "uri":"ShowBigkeyAutoscanConfig.html", + "node_id":"showbigkeyautoscanconfig.xml", + "product_code":"", + "code":"56", + "des":"This API is used to query configurations of automatic big key analysis.GET /v2/{project_id}/instances/{instance_id}/bigkey/autoscanNoneStatus code: 200Status code: 400Sta", + "doc_type":"api", + "kw":"Querying the Configurations of Automatic Big Key Analysis,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowBigkeyAutoscanConfig" + } + ], + "title":"Querying the Configurations of Automatic Big Key Analysis", + "githuburl":"" + }, + { + "uri":"CreateHotkeyScanTask.html", + "node_id":"createhotkeyscantask.xml", + "product_code":"", + "code":"57", + "des":"This API is used to create a hot key analysis task. Redis 3.0 does not support hot key analysis.To perform hot key analysis, the instance's maxmemory-policy parameter mus", + "doc_type":"api", + "kw":"Creating a Hot Key Analysis Task,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateHotkeyScanTask" + } + ], + "title":"Creating a Hot Key Analysis Task", + "githuburl":"" + }, + { + "uri":"ListHotKeyScanTasks.html", + "node_id":"listhotkeyscantasks.xml", + "product_code":"", + "code":"58", + "des":"This API is used to query the list of hot key analysis tasks.GET /v2/{project_id}/instances/{instance_id}/hotkey-tasksNoneStatus code: 200Status code: 400Status code: 401", + "doc_type":"api", + "kw":"Listing Hot Key Analysis Tasks,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListHotKeyScanTasks" + } + ], + "title":"Listing Hot Key Analysis Tasks", + "githuburl":"" + }, + { + "uri":"ShowHotkeyTaskDetails.html", + "node_id":"showhotkeytaskdetails.xml", + "product_code":"", + "code":"59", + "des":"This API is used to query the hot key analysis details.GET /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}NoneStatus code: 200Status code: 400Status code", + "doc_type":"api", + "kw":"Querying Hot Key Analysis Details,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowHotkeyTaskDetails" + } + ], + "title":"Querying Hot Key Analysis Details", + "githuburl":"" + }, + { + "uri":"DeleteHotkeyScanTask.html", + "node_id":"deletehotkeyscantask.xml", + "product_code":"", + "code":"60", + "des":"This API is used to delete a hot key analysis task.DELETE /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}NoneStatus code: 200Status code: 400Status code:", + "doc_type":"api", + "kw":"Deleting a Hot Key Analysis Task,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteHotkeyScanTask" + } + ], + "title":"Deleting a Hot Key Analysis Task", + "githuburl":"" + }, + { + "uri":"UpdateHotkeyAutoScanConfig.html", + "node_id":"updatehotkeyautoscanconfig.xml", + "product_code":"", + "code":"61", + "des":"This API is used to configure automatic hot key analysis.PUT /v2/{project_id}/instances/{instance_id}/hotkey/autoscanStatus code: 200Status code: 400Status code: 401Statu", + "doc_type":"api", + "kw":"Configuring Automatic Hot Key Analysis,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateHotkeyAutoScanConfig" + } + ], + "title":"Configuring Automatic Hot Key Analysis", + "githuburl":"" + }, + { + "uri":"ShowHotkeyAutoscanConfig.html", + "node_id":"showhotkeyautoscanconfig.xml", + "product_code":"", + "code":"62", + "des":"This API is used to query configurations of automatic hot key analysis.GET /v2/{project_id}/instances/{instance_id}/hotkey/autoscanNoneStatus code: 200Status code: 400Sta", + "doc_type":"api", + "kw":"Querying the Configurations of Automatic Hot Key Analysis,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowHotkeyAutoscanConfig" + } + ], + "title":"Querying the Configurations of Automatic Hot Key Analysis", + "githuburl":"" + }, + { + "uri":"CreateAutoExpireScanTask.html", + "node_id":"createautoexpirescantask.xml", + "product_code":"", + "code":"63", + "des":"This API is used to create an expired key scan task. Redis 3.0 does not support expired key scan. The keyspace will be scanned to release the memory used by expired keys ", + "doc_type":"api", + "kw":"Creating an Expired Key Scan Task,Cache Analysis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateAutoExpireScanTask" + } + ], + "title":"Creating an Expired Key Scan Task", + "githuburl":"" + }, + { + "uri":"LogManagement.html", + "node_id":"logmanagement.xml", + "product_code":"", + "code":"64", + "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" + } + ], + "title":"Log Management", + "githuburl":"" + }, + { + "uri":"ListSlowlog.html", + "node_id":"listslowlog.xml", + "product_code":"", + "code":"65", + "des":"This API is used to query slow logs.GET /v2/{project_id}/instances/{instance_id}/slowlogNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 4", + "doc_type":"api", + "kw":"Querying the Slow Log,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListSlowlog" + } + ], + "title":"Querying the Slow Log", + "githuburl":"" + }, + { + "uri":"ListRedislog.html", + "node_id":"listredislog.xml", + "product_code":"", + "code":"66", + "des":"This API is used to query the Redis run logs.GET /v2/{project_id}/instances/{instance_id}/redislogNoneStatus code: 200Status code: 400Status code: 401Status code: 403Stat", + "doc_type":"api", + "kw":"Listing Redis Run Logs,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListRedislog" + } + ], + "title":"Listing Redis Run Logs", + "githuburl":"" + }, + { + "uri":"CreateRedislog.html", + "node_id":"createredislog.xml", + "product_code":"", + "code":"67", + "des":"This API is used to collect Redis run logs.POST /v2/{project_id}/instances/{instance_id}/redislogNoneStatus code: 400Status code: 401Status code: 403Status code: 404Statu", + "doc_type":"api", + "kw":"Collecting Redis Run Logs,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateRedislog" + } + ], + "title":"Collecting Redis Run Logs", + "githuburl":"" + }, + { + "uri":"CreateRedislogDownloadLink.html", + "node_id":"createredislogdownloadlink.xml", + "product_code":"", + "code":"68", + "des":"This API is used to obtain the link for downloading logs.POST /v2/{project_id}/instances/{instance_id}/redislog/{id}/linksNoneStatus code: 200Status code: 400Status code:", + "doc_type":"api", + "kw":"Obtaining the Log Download Link,Log Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateRedislogDownloadLink" + } + ], + "title":"Obtaining the Log Download Link", + "githuburl":"" + }, + { + "uri":"NetworkSecurityManagement.html", + "node_id":"networksecuritymanagement.xml", + "product_code":"", + "code":"69", + "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":"Network Security", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], "title":"Network Security", "githuburl":"" }, { - "uri":"UpdateIpWhitelist.html", + "uri":"UpdateSSLSwitch.html", + "node_id":"updatesslswitch.xml", "product_code":"", - "code":"27", - "des":"IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instancesThis API is used to configure IP address whitelist groups for a s", - "doc_type":"", + "code":"70", + "des":"This API is used to enable or disable SSL. This API is only supported by DCS Redis 6.0 instances.PUT /v2/{project_id}/instances/{instance_id}/sslStatus code: 200Status co", + "doc_type":"api", + "kw":"Enabling or Disabling SSL,Network Security,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateSSLSwitch" + } + ], + "title":"Enabling or Disabling SSL", + "githuburl":"" + }, + { + "uri":"ShowInstanceSSLDetail.html", + "node_id":"showinstancessldetail.xml", + "product_code":"", + "code":"71", + "des":"This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0 instances.GET /v2/{project_id}/instances/{instance_id}/sslNoneStatus ", + "doc_type":"api", + "kw":"Querying SSL Encryption of an Instance,Network Security,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowInstanceSSLDetail" + } + ], + "title":"Querying SSL Encryption of an Instance", + "githuburl":"" + }, + { + "uri":"DownloadSSLCert.html", + "node_id":"downloadsslcert.xml", + "product_code":"", + "code":"72", + "des":"This API is used to download the SSL certificate of an instance. This API is only supported by DCS Redis 6.0 instances.POST /v2/{project_id}/instances/{instance_id}/ssl-c", + "doc_type":"api", + "kw":"Downloading the SSL Certificate of an Instance,Network Security,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DownloadSSLCert" + } + ], + "title":"Downloading the SSL Certificate of an Instance", + "githuburl":"" + }, + { + "uri":"UpdateIpWhitelist.html", + "node_id":"updateipwhitelist.xml", + "product_code":"", + "code":"73", + "des":"This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist setting", + "doc_type":"api", "kw":"Configuring IP Whitelist Groups,Network Security,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateIpWhitelist" + } + ], "title":"Configuring IP Whitelist Groups", "githuburl":"" }, { "uri":"ShowIpWhitelist.html", + "node_id":"showipwhitelist.xml", "product_code":"", - "code":"28", + "code":"74", "des":"This API is used to query the IP address whitelist of a specific instance.GET /v2/{project_id}/instance/{instance_id}/whitelistNoneStatus code: 200Status code: 200Instanc", - "doc_type":"", + "doc_type":"api", "kw":"Querying the IP Whitelist of a DCS Instance,Network Security,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowIpWhitelist" + } + ], "title":"Querying the IP Whitelist of a DCS Instance", "githuburl":"" }, { - "uri":"dcs-api-0312038.html", - "product_code":"dcs", - "code":"29", + "uri":"BackgroudTasksManagement.html", + "node_id":"backgroudtasksmanagement.xml", + "product_code":"", + "code":"75", + "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":"Background Task Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Background Task Management", + "githuburl":"" + }, + { + "uri":"ListBackgroundTask.html", + "node_id":"listbackgroundtask.xml", + "product_code":"", + "code":"76", + "des":"This API is used to query background tasks.GET /v2/{project_id}/instances/{instance_id}/tasksNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status co", + "doc_type":"api", + "kw":"Listing Background Tasks,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListBackgroundTask" + } + ], + "title":"Listing Background Tasks", + "githuburl":"" + }, + { + "uri":"DeleteBackgroundTask.html", + "node_id":"deletebackgroundtask.xml", + "product_code":"", + "code":"77", + "des":"Deleting a background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code:", + "doc_type":"api", + "kw":"Deleting a Background Task,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteBackgroundTask" + } + ], + "title":"Deleting a Background Task", + "githuburl":"" + }, + { + "uri":"ShowJobInfo.html", + "node_id":"showjobinfo.xml", + "product_code":"", + "code":"78", + "des":"This API is used to query the task execution result.GET /v2/{project_id}/jobs/{job_id}NoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404", + "doc_type":"api", + "kw":"Querying the Job Execution Result of a Tenant,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowJobInfo" + } + ], + "title":"Querying the Job Execution Result of a Tenant", + "githuburl":"" + }, + { + "uri":"DeleteCenterTask.html", + "node_id":"deletecentertask.xml", + "product_code":"", + "code":"79", + "des":"This API is used to delete a task in the task center.DELETE /v2/{project_id}/tasks/{task_id}Status code: 400Status code: 401Status code: 403Status code: 404Status code: 5", + "doc_type":"api", + "kw":"Deleting a Task in the Task Center,Background Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteCenterTask" + } + ], + "title":"Deleting a Task in the Task Center", + "githuburl":"" + }, + { + "uri":"InstanceDiagnosisManagement.html", + "node_id":"instancediagnosismanagement.xml", + "product_code":"", + "code":"80", + "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":"Instance Diagnosis", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Instance Diagnosis", + "githuburl":"" + }, + { + "uri":"ListDiagnosisTasks.html", + "node_id":"listdiagnosistasks.xml", + "product_code":"", + "code":"81", + "des":"This API is used to query the list of diagnosis tasks of a specific DCS instance.GET /v2/{project_id}/instances/{instance_id}/diagnosisNoneStatus code: 200Status code: 40", + "doc_type":"api", + "kw":"Listing Instance Diagnosis Tasks,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListDiagnosisTasks" + } + ], + "title":"Listing Instance Diagnosis Tasks", + "githuburl":"" + }, + { + "uri":"ShowDiagnosisTaskDetails.html", + "node_id":"showdiagnosistaskdetails.xml", + "product_code":"", + "code":"82", + "des":"This API is used to query details about a diagnosis report based on the report ID.GET /v2/{project_id}/diagnosis/{report_id}NoneStatus code: 200Status code: 400Status cod", + "doc_type":"api", + "kw":"Querying a Specified Diagnosis Report,Instance Diagnosis,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowDiagnosisTaskDetails" + } + ], + "title":"Querying a Specified Diagnosis Report", + "githuburl":"" + }, + { + "uri":"ConfigTemplatesManagement.html", + "node_id":"configtemplatesmanagement.xml", + "product_code":"", + "code":"83", + "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":"Template Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Template Management", + "githuburl":"" + }, + { + "uri":"ListConfigTemplates.html", + "node_id":"listconfigtemplates.xml", + "product_code":"", + "code":"84", + "des":"This API is used to query parameter templates of a tenant, and allows you to specify query criteria.GET /v2/{project_id}/config-templatesNoneStatus code: 200Status code: ", + "doc_type":"api", + "kw":"Viewing Parameter Templates,Template Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListConfigTemplates" + } + ], + "title":"Viewing Parameter Templates", + "githuburl":"" + }, + { + "uri":"CreateCustomTemplate.html", + "node_id":"createcustomtemplate.xml", + "product_code":"", + "code":"85", + "des":"This API is used to create a custom template.POST /v2/{project_id}/config-templatesStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404Status ", + "doc_type":"api", + "kw":"Creating a Custom Template,Template Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateCustomTemplate" + } + ], + "title":"Creating a Custom Template", + "githuburl":"" + }, + { + "uri":"OtherInterface.html", + "node_id":"otherinterface.xml", + "product_code":"", + "code":"86", "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":"Other APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Other APIs", + "githuburl":"" + }, + { + "uri":"ListFlavors.html", + "node_id":"listflavors.xml", + "product_code":"", + "code":"87", + "des":"This API is used to query the product flavor (parameter spec_code) required for configuring a new DCS instance. If no search criterion is specified, all product specifica", + "doc_type":"api", + "kw":"Querying Product Flavors,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListFlavors" + } + ], + "title":"Querying Product Flavors", + "githuburl":"" + }, + { + "uri":"ListMaintenanceWindows.html", + "node_id":"listmaintenancewindows.xml", + "product_code":"", + "code":"88", + "des":"This API is used to query the start time and end time of maintenance windows.GET /v2/instances/maintain-windowsNoneStatus code: 200Status code: 500Status code: 200Mainten", + "doc_type":"api", + "kw":"Listing Maintenance Time Windows,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListMaintenanceWindows" + } + ], + "title":"Listing Maintenance Time Windows", + "githuburl":"" + }, + { + "uri":"ShowQuotaOfTenant.html", + "node_id":"showquotaoftenant.xml", + "product_code":"", + "code":"89", + "des":"This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have ", + "doc_type":"api", + "kw":"Querying the Tenant Quotas,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowQuotaOfTenant" + } + ], + "title":"Querying the Tenant Quotas", + "githuburl":"" + }, + { + "uri":"ListMonitoredObjectsOfInstance.html", + "node_id":"listmonitoredobjectsofinstance.xml", + "product_code":"", + "code":"90", + "des":"This API is used to query the monitored objects on secondary dimensions under primary dimension dcs_instance_id.GET /v2/{project_id}/dims/monitored-objects/{instance_id}N", + "doc_type":"api", + "kw":"Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListMonitoredObjectsOfInstance" + } + ], + "title":"Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension", + "githuburl":"" + }, + { + "uri":"ListMonitoredObjects.html", + "node_id":"listmonitoredobjects.xml", + "product_code":"", + "code":"91", + "des":"This API is used to query the monitored objects on the primary dimension dcs_instance_id.GET /v2/{project_id}/dims/monitored-objectsNoneStatus code: 200Status code: 500St", + "doc_type":"api", + "kw":"Listing Monitored Objects on Primary Dimensions,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListMonitoredObjects" + } + ], + "title":"Listing Monitored Objects on Primary Dimensions", + "githuburl":"" + }, + { + "uri":"ListAvailableZones.html", + "node_id":"listavailablezones.xml", + "product_code":"", + "code":"92", + "des":"This API is used to query the AZ information of the current region.GET /v2/available-zonesNoneStatus code: 200Status code: 200The query is successful.See Error Codes.", + "doc_type":"api", + "kw":"Querying AZs,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListAvailableZones" + } + ], + "title":"Querying AZs", + "githuburl":"" + }, + { + "uri":"dcs-api-0605002.html", + "node_id":"dcs-api-0605002.xml", + "product_code":"dcs", + "code":"93", + "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":"Outdated APIs (V1)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Outdated APIs (V1)", + "githuburl":"" + }, + { + "uri":"dcs-api-0312003.html", + "node_id":"dcs-api-0312003.xml", + "product_code":"dcs", + "code":"94", + "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":"Lifecycle Management APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Lifecycle Management APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312004.html", + "node_id":"dcs-api-0312004.xml", + "product_code":"dcs", + "code":"95", + "des":"This API is used to create a DCS instance.The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.POST /v1.0/", + "doc_type":"api", + "kw":"Creating a DCS Instance,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Creating a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312008.html", + "node_id":"dcs-api-0312008.xml", + "product_code":"dcs", + "code":"96", + "des":"This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}Table 1 describ", + "doc_type":"api", + "kw":"Deleting a Single DCS Instance,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Deleting a Single DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312009.html", + "node_id":"dcs-api-0312009.xml", + "product_code":"dcs", + "code":"97", + "des":"This API is used to delete multiple DCS instances at a time.DELETE /v1.0/{project_id}/instances?allFailure={allFailure}Table 1 describes the parameters.Parameter descript", + "doc_type":"api", + "kw":"Batch Deleting DCS Instances,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Batch Deleting DCS Instances", + "githuburl":"" + }, + { + "uri":"dcs-api-0312005.html", + "node_id":"dcs-api-0312005.xml", + "product_code":"dcs", + "code":"98", + "des":"This API is used to query the details about a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}Table 1 describes the parameters.Parameter descriptionP", + "doc_type":"api", + "kw":"Querying a DCS Instance,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312006.html", + "node_id":"dcs-api-0312006.xml", + "product_code":"dcs", + "code":"99", + "des":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&sta", + "doc_type":"api", + "kw":"Querying All DCS Instances of a Tenant,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying All DCS Instances of a Tenant", + "githuburl":"" + }, + { + "uri":"dcs-api-0312007.html", + "node_id":"dcs-api-0312007.xml", + "product_code":"dcs", + "code":"100", + "des":"This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, an", + "doc_type":"api", + "kw":"Modifying Information About a DCS Instance,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Modifying Information About a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312010.html", + "node_id":"dcs-api-0312010.xml", + "product_code":"dcs", + "code":"101", + "des":"This API is used to scale up a DCS Redis instance in the Running state.POST /v1.0/{project_id}/instances/{instance_id}/extendTable 1 describes the parameters.Parameter de", + "doc_type":"api", + "kw":"Scaling Up a DCS Instance,Lifecycle Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Scaling Up a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312035.html", + "node_id":"dcs-api-0312035.xml", + "product_code":"dcs", + "code":"102", + "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":"Instance Management APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Instance Management APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312018.html", + "node_id":"dcs-api-0312018.xml", + "product_code":"dcs", + "code":"103", + "des":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.PUT /v1.0/{project_id}/instances/statusTa", + "doc_type":"api", + "kw":"Restarting DCS Instances or Clearing DCS Instance Data,Instance Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Restarting DCS Instances or Clearing DCS Instance Data", + "githuburl":"" + }, + { + "uri":"dcs-api-0312014.html", + "node_id":"dcs-api-0312014.xml", + "product_code":"dcs", + "code":"104", + "des":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v1.0/{project_id}/instances/statisticTable 1 describes the parameter.Para", + "doc_type":"api", + "kw":"Querying Statistics of All Running Instances,Instance Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying Statistics of All Running Instances", + "githuburl":"" + }, + { + "uri":"dcs-api-0312016.html", + "node_id":"dcs-api-0312016.xml", + "product_code":"dcs", + "code":"105", + "des":"This API is used to query the number of instances in different states.GET /v1.0/{project_id}/instances/status?include_failure={include_failure}Table 1 describes the param", + "doc_type":"api", + "kw":"Querying DCS Instance Status,Instance Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying DCS Instance Status", + "githuburl":"" + }, + { + "uri":"dcs-api-0312019.html", + "node_id":"dcs-api-0312019.xml", + "product_code":"dcs", + "code":"106", + "des":"This API is used to change the password of a DCS instance.PUT /v1.0/{project_id}/instances/{instance_id}/passwordTable 1 describes the parameters.Parameter descriptionPar", + "doc_type":"api", + "kw":"Changing the Password of a DCS Instance,Instance Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Changing the Password of a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312013.html", + "node_id":"dcs-api-0312013.xml", + "product_code":"dcs", + "code":"107", + "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":"Parameter Management APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Parameter Management APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312017.html", + "node_id":"dcs-api-0312017.xml", + "product_code":"dcs", + "code":"108", + "des":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v1.0/{project_id}/instances/{instance_id}/con", + "doc_type":"api", + "kw":"Modifying Configuration Parameters,Parameter Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Modifying Configuration Parameters", + "githuburl":"" + }, + { + "uri":"dcs-api-0312015.html", + "node_id":"dcs-api-0312015.xml", + "product_code":"dcs", + "code":"109", + "des":"This API is used to query the configuration parameters of a DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/configsTable 1 describes the parameters.Parameter ", + "doc_type":"api", + "kw":"Querying Configuration Parameters,Parameter Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying Configuration Parameters", + "githuburl":"" + }, + { + "uri":"dcs-api-0514005.html", + "node_id":"dcs-api-0514005.xml", + "product_code":"dcs", + "code":"110", + "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":"Backup and Restoration APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Backup and Restoration APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312020.html", + "node_id":"dcs-api-0312020.xml", + "product_code":"dcs", + "code":"111", + "des":"This API is used to back up a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "doc_type":"api", + "kw":"Backing Up a DCS Instance,Backup and Restoration APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Backing Up a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312021.html", + "node_id":"dcs-api-0312021.xml", + "product_code":"dcs", + "code":"112", + "des":"This API is used to restore a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "doc_type":"api", + "kw":"Restoring a DCS Instance,Backup and Restoration APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Restoring a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312022.html", + "node_id":"dcs-api-0312022.xml", + "product_code":"dcs", + "code":"113", + "des":"This API is used to query the backup records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beg", + "doc_type":"api", + "kw":"Querying DCS Instance Backup Records,Backup and Restoration APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying DCS Instance Backup Records", + "githuburl":"" + }, + { + "uri":"dcs-api-0312023.html", + "node_id":"dcs-api-0312023.xml", + "product_code":"dcs", + "code":"114", + "des":"This API is used to query the restoration records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTim", + "doc_type":"api", + "kw":"Querying DCS Instance Restoration Records,Backup and Restoration APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Querying DCS Instance Restoration Records", + "githuburl":"" + }, + { + "uri":"dcs-api-0312024.html", + "node_id":"dcs-api-0312024.xml", + "product_code":"dcs", + "code":"115", + "des":"This API is used to delete the files backed up by a DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}Table 1 describes the parameters.Par", + "doc_type":"api", + "kw":"Deleting Backup Files,Backup and Restoration APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Deleting Backup Files", + "githuburl":"" + }, + { + "uri":"dcs-api-0312038.html", + "node_id":"dcs-api-0312038.xml", + "product_code":"dcs", + "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":"Other APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Other APIs", "githuburl":"" }, { "uri":"dcs-api-0312040.html", + "node_id":"dcs-api-0312040.xml", "product_code":"dcs", - "code":"30", + "code":"117", "des":"This API is used to query the product ID (parameter product_id) which indicates the specifications of the DCS service you created.GET /v1.0/productsRequest parametersNone", "doc_type":"api", "kw":"Querying Service Specifications,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Querying Service Specifications", "githuburl":"" }, { "uri":"dcs-api-0312036.html", + "node_id":"dcs-api-0312036.xml", "product_code":"dcs", - "code":"31", + "code":"118", "des":"This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have ", "doc_type":"api", "kw":"Querying the Quota of a Tenant,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Querying the Quota of a Tenant", "githuburl":"" }, { "uri":"dcs-api-0312041.html", + "node_id":"dcs-api-0312041.xml", "product_code":"dcs", - "code":"32", + "code":"119", "des":"The API is used to query the start time and end time of the maintenance time window.GET /v1.0/instances/maintain-windowsRequest parametersNoneExample requestNoneResponse ", "doc_type":"api", "kw":"Querying Maintenance Time Window,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Querying Maintenance Time Window", "githuburl":"" }, { "uri":"dcs-api-0312039.html", + "node_id":"dcs-api-0312039.xml", "product_code":"dcs", - "code":"33", + "code":"120", "des":"This API is used to query the ID of the AZ where a DCS instance resides.GET /v1.0/availableZonesRequest parametersNoneExample requestNoneResponse parametersTable 1 descri", "doc_type":"api", "kw":"Querying AZ Information,Other APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Querying AZ Information", "githuburl":"" }, { - "uri":"dcs-api-0312042.html", + "uri":"api-grant-policy.html", + "node_id":"api-grant-policy.xml", "product_code":"dcs", - "code":"34", + "code":"121", + "des":"This chapter describes fine-grained permissions management for your DCS. If your account does not need individual IAM users, you can skip the configurations described in ", + "doc_type":"api", + "kw":"Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"dcs-api-0312042.html", + "node_id":"dcs-api-0312042.xml", + "product_code":"dcs", + "code":"122", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Appendix", "githuburl":"" }, { "uri":"dcs-api-0312043.html", + "node_id":"dcs-api-0312043.xml", "product_code":"dcs", - "code":"35", + "code":"123", "des":"Table 1 describes the status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Status Codes", "githuburl":"" }, { - "uri":"dcs-api-0312044.html", - "product_code":"dcs", - "code":"36", + "uri":"ErrorCode.html", + "node_id":"errorcode_1.xml", + "product_code":"", + "code":"124", "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":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api" + } + ], "title":"Error Codes", "githuburl":"" }, { "uri":"dcs-api-0312045.html", + "node_id":"dcs-api-0312045.xml", "product_code":"dcs", - "code":"37", - "des":"A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.The following procedure describes how to obtain a project ID:On t", + "code":"125", + "des":"You can obtain a project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{Endpo", "doc_type":"api", "kw":"Obtaining a Project ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Obtaining a Project ID", "githuburl":"" }, { "uri":"dcs-api-0312047.html", + "node_id":"dcs-api-0312047.xml", "product_code":"dcs", - "code":"38", + "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":"DCS Instance Statuses,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"DCS Instance Statuses", "githuburl":"" }, { - "uri":"dcs-api-0312049.html", + "uri":"dcs-api-0312050.html", + "node_id":"dcs-api-0312050.xml", "product_code":"dcs", - "code":"39", + "code":"127", + "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":"Instance Diagnosis IDs,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], + "title":"Instance Diagnosis IDs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312049.html", + "node_id":"dcs-api-0312049.xml", + "product_code":"dcs", + "code":"128", "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dcs", + "opensource":"true" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/dcs/api-ref/BackgroudTasksManagement.html b/docs/dcs/api-ref/BackgroudTasksManagement.html new file mode 100644 index 00000000..337b96c1 --- /dev/null +++ b/docs/dcs/api-ref/BackgroudTasksManagement.html @@ -0,0 +1,22 @@ + + +

Background Task Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/BackupRestoreManagement.html b/docs/dcs/api-ref/BackupRestoreManagement.html new file mode 100644 index 00000000..37d4a2c2 --- /dev/null +++ b/docs/dcs/api-ref/BackupRestoreManagement.html @@ -0,0 +1,26 @@ + + +

Backup and Restoration

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/BatchCreateOrDeleteTags.html b/docs/dcs/api-ref/BatchCreateOrDeleteTags.html new file mode 100644 index 00000000..dfa46f15 --- /dev/null +++ b/docs/dcs/api-ref/BatchCreateOrDeleteTags.html @@ -0,0 +1,165 @@ + + +

Batch Adding or Deleting Tags

+

Function

This API is used to add or delete tags in batches for a DCS instance.

+
+

URI

POST /v2/{project_id}/dcs/{instance_id}/tags/action

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Operation to be performed. The value can be create or delete.

+

tags

+

Yes

+

Array of ResourceTag objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 ResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key.

+

  • Must be unique for each resource.

    +

  • Contains up to 128 characters.

    +

  • Must be unique and cannot be empty.

    +
+

value

+

No

+

String

+

Tag value.

+

  • This parameter is mandatory when action is set to create and is optional when action is set to delete.

    +

  • It can contain a maximum of 255 characters.

    +
+
+
+
+

Response Parameters

None

+
+

Example Requests

  • Adding tags to a specified resource in batches

    +
    POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action
+
+{
+  "action" : "create",
+  "tags" : [ {
+    "value" : "2",
+    "key" : "dcs001"
+  }, {
+    "value" : "4",
+    "key" : "dcs003"
+  } ]
+}
    +

  • Deleting tags from a specified instance in batches

    +
    POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action
+
+{
+  "action" : "delete",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "11"
+  } ]
+}
    +
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

Tags added or deleted successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dcs/api-ref/BatchDeleteInstances.html b/docs/dcs/api-ref/BatchDeleteInstances.html new file mode 100644 index 00000000..cb41e6f8 --- /dev/null +++ b/docs/dcs/api-ref/BatchDeleteInstances.html @@ -0,0 +1,256 @@ + + +

Batch Deleting DCS Instances

+

Function

This API is used to delete multiple DCS instances at a time.

+
+

URI

DELETE /v2/{project_id}/instances

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

all_failure

+

No

+

Boolean

+

Whether to delete all DCS instances that failed to be created. Values:

+

  • true: all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty.

    +

  • false or other values: The DCS instances specified by the instances parameter will be deleted.

    +
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instances

+

No

+

Array of strings

+

List of instance IDs.

+

This parameter is set only when the all_failure parameter in the URI is set to false or another value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

results

+

Array of BatchOpsResult objects

+

Result of deleting, restarting, or clearing data of an instance.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 BatchOpsResult

Parameter

+

Type

+

Description

+

result

+

String

+

Instance deletion result. Options: success and failed.

+

instance

+

String

+

DCS instance ID.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Batch deleting DCS instances

+
DELETE https://{dcs_endpoint}/v2/{project_id}/instances?all_failure={all_failure}
+
+{
+  "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ]
+}
+
+

Example Responses

Status code: 200

+

DCS instances deleted successfully.

+
{
+  "results" : [ {
+    "result" : "success",
+    "instance" : "54602a9d-5e22-4239-9123-77e350df4a34"
+  }, {
+    "result" : "success",
+    "instance" : "7166cdea-dbad-4d79-9610-7163e6f8b640"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

DCS instances deleted successfully.

+

500

+

Internal service error.

+

400

+

Invalid request.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dcs/api-ref/BatchShowNodesInformation.html b/docs/dcs/api-ref/BatchShowNodesInformation.html new file mode 100644 index 00000000..655aa85c --- /dev/null +++ b/docs/dcs/api-ref/BatchShowNodesInformation.html @@ -0,0 +1,467 @@ + + +

Querying Instance Nodes in Batches

+

Function

This API is used to query the node information, number of valid instances, and number of nodes of all instances in a specified project. No node information will be returned when the instance is being created. Available for Redis 4.0 and later instances.

+
+

Constraints

Available for Redis 4.0 and later instances.

+
+

URI

GET /v2/{project_id}/instances-logical-nodes

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page. The maximum value is 1000*. If this parameter is not specified, 10 items are displayed on each page by default.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

count

+

Integer

+

Total number of instances in the query result.

+

instances

+

Array of InstanceNodesInfoResp objects

+

Instance list.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 InstanceNodesInfoResp

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+

node_count

+

Integer

+

Total number of nodes of the current instance.

+

nodes

+

Array of NodesInfoResp objects

+

Node details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 NodesInfoResp

Parameter

+

Type

+

Description

+

logical_node_id

+

String

+

Logical node ID.

+

name

+

String

+

Node name.

+

status

+

String

+

Node status. The value can be:

+

  • Creating

    +

  • Active: running

    +

  • Inactive: faulty

    +

  • Deleting

    +

  • AddSharding: Shards are being added.

    +
+

Enumeration values:

+

  • Creating

    +

  • Active

    +

  • Inactive

    +

  • Deleting

    +

  • AddSharding

    +
+

az_code

+

String

+

AZ code.

+

node_role

+

String

+

Node type. Options:

+

  • redis-server: Redis server node

    +

  • redis-proxy: proxy node

    +
+

Enumeration values:

+

  • redis-server

    +

  • redis-proxy

    +
+

node_type

+

String

+

Node role. Options:

+

  • master: master node

    +

  • slave: standby node

    +

  • proxy: node of a Proxy Cluster instance

    +
+

Enumeration values:

+

  • master

    +

  • slave

    +

  • proxy

    +
+

node_ip

+

String

+

Node IP address.

+

node_port

+

String

+

Node port.

+

node_id

+

String

+

Node ID.

+

priority_weight

+

Integer

+

Replica promotion priority.

+

is_access

+

Boolean

+

Whether the IP address of the node can be directly accessed.

+

group_id

+

String

+

Shard ID.

+

group_name

+

String

+

Shard name.

+

is_remove_ip

+

Boolean

+

Whether the IP address is removed from the read-only domain name.

+

replication_id

+

String

+

Replica ID.

+

dimensions

+

Array of InstanceReplicationDimensionsInfo objects

+

Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics.

+

  • Replica monitoring is multi-dimensional. The returned array contains information about two dimensions. When querying monitoring data from Cloud Eye, transfer parameters of multiple dimensions to obtain the metric data.

    +

  • The first dimension is the primary dimension of the replica. The dimension name is dcs_instance_id, and the dimension value is the ID of the instance where the replica is located.

    +

  • The name of the second dimension is dcs_cluster_redis_node, and the dimension value is the ID of the monitored object of the replica, which is different from the replica ID or node ID.

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 6 InstanceReplicationDimensionsInfo

Parameter

+

Type

+

Description

+

name

+

String

+

Monitoring dimension name.

+

value

+

String

+

Dimension value.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances-logical-nodes?offset={offset}&limit={limit}
+
+

Example Responses

Status code: 200

+

Node information queried successfully.

+
{
+  "count" : 1,
+  "instances" : [ {
+    "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c",
+    "node_count" : 2,
+    "nodes" : [ {
+      "logical_node_id" : "8f997eb512a92834bf5914be52ca8919",
+      "name" : "(replica)192.168.0.178",
+      "status" : "Active",
+      "az_code" : "region01",
+      "node_role" : "redis-server",
+      "node_type" : "slave",
+      "node_ip" : "192.168.0.178",
+      "node_port" : "6379",
+      "node_id" : "8a2c26c17f4d6516017f4d7b77940030",
+      "is_access" : true,
+      "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3",
+      "group_name" : "group-0",
+      "priority_weight" : 100,
+      "is_remove_ip" : false,
+      "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6200"
+      } ]
+    } ]
+  } ]
+}
+

Status code: 500

+

Internal service error.

+
{
+  "error_code" : "DCS.5000",
+  "error_msg" : "Internal service error."
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4800",
+  "error_msg" : "Invalid offset in the request."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Node information queried successfully.

+

500

+

Internal service error.

+

400

+

Invalid request.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Shards and Replicas
+
+
+ diff --git a/docs/dcs/api-ref/BatchStopMigrationTasks.html b/docs/dcs/api-ref/BatchStopMigrationTasks.html new file mode 100644 index 00000000..c463f916 --- /dev/null +++ b/docs/dcs/api-ref/BatchStopMigrationTasks.html @@ -0,0 +1,369 @@ + + +

Stopping Data Migration Tasks

+

Function

This API is used to stop data migration tasks in batches. If a success response is returned, the request is successfully delivered. The migration tasks are stopped only when their status is TERMINATED.

+
+

URI

POST /v2/{project_id}/migration-task/batch-stop

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

migration_tasks

+

Yes

+

Array of strings

+

Data migration task list.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

migration_tasks

+

Array of StopMigrationTaskResult objects

+

Data migration task list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 StopMigrationTaskResult

Parameter

+

Type

+

Description

+

result

+

String

+

Result of delivering the request for stopping migration tasks.

+

Enumeration values:

+

  • success

    +

  • failed

    +
+

task_id

+

String

+

ID of the data migration task.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Stopping data migration tasks in batches

+
POST https://{dcs_endpoint}/v2/{project_id}/migration-task/batch-stop
+
+{
+  "migration_tasks" : [ "b21989ec-2889-4b8e-99db-19c073425ec2", "5130d57f-640a-435b-bc3a-0fb1860a5340" ]
+}
+
+

Example Responses

Status code: 200

+

"Migration tasks are being stopped.

+

The migration tasks are stopped when their status is TERMINATED.

+
+
{
+  "migration_tasks" : [ {
+    "result" : "success",
+    "task_id" : "b21989ec-2889-4b8e-99db-19c073425ec2"
+  }, {
+    "result" : "failed",
+    "task_id" : "5130d57f-640a-435b-bc3a-0fb1860a5340"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_msg" : "invalid migration task id in the request.",
+  "error_code" : "DCS.4855"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

"Migration tasks are being stopped.

+
NOTE:

The migration tasks are stopped when their status is TERMINATED.

+
+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Data Migration
+
+
+ diff --git a/docs/dcs/api-ref/CLASS.TXT.json b/docs/dcs/api-ref/CLASS.TXT.json index 9a142960..157b498b 100644 --- a/docs/dcs/api-ref/CLASS.TXT.json +++ b/docs/dcs/api-ref/CLASS.TXT.json @@ -11,236 +11,650 @@ { "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":"dcs", - "title":"Lifecycle Management APIs", - "uri":"dcs-api-0312003.html", + "title":"API Version Query", + "uri":"en-us_topic_0000001693875369.html", "doc_type":"api", "p_code":"", "code":"2" }, { - "desc":"This API is used to create a DCS instance.The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.POST /v1.0/", + "desc":"Querying Information of an API Version.URI formatGET /{api_version}ParametersParameterTypeDescriptionapi_versionStringTarget API version.The value can be v1.0 or v2.Sampl", "product_code":"dcs", - "title":"Creating a DCS Instance", - "uri":"dcs-api-0312004.html", + "title":"Querying Information of an API Version", + "uri":"en-us_topic_0000001693796125.html", "doc_type":"api", "p_code":"2", "code":"3" }, { - "desc":"This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}Table 1 describ", + "desc":"This API is used to query the list of API versions.URI formatGET /Sample:GET https://{dcs_endpoint}/For details, see Error Codes.", "product_code":"dcs", - "title":"Deleting a Single DCS Instance", - "uri":"dcs-api-0312008.html", + "title":"Querying the List of API Versions", + "uri":"en-us_topic_0000001645635650.html", "doc_type":"api", "p_code":"2", "code":"4" }, { - "desc":"This API is used to delete multiple DCS instances at a time.DELETE /v1.0/{project_id}/instances?allFailure={allFailure}Table 1 describes the parameters.Parameter descript", + "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":"dcs", - "title":"Batch Deleting DCS Instances", - "uri":"dcs-api-0312009.html", + "title":"APIs V2 (Recommended)", + "uri":"dcs-api-0605001.html", "doc_type":"api", - "p_code":"2", + "p_code":"", "code":"5" }, { - "desc":"This API is used to query the details about a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}Table 1 describes the parameters.Parameter descriptionP", + "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":"dcs", - "title":"Querying a DCS Instance", - "uri":"dcs-api-0312005.html", + "title":"Lifecycle Management", + "uri":"LifecycleManagement.html", "doc_type":"api", - "p_code":"2", + "p_code":"5", "code":"6" }, { - "desc":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&sta", + "desc":"This API is used to create a DCS instance which is billed in pay-per-use mode.POST /v2/{project_id}/instancesStatus code: 200Status code: 400Status code: 401Status code: ", "product_code":"dcs", - "title":"Querying All DCS Instances of a Tenant", - "uri":"dcs-api-0312006.html", + "title":"Creating a DCS Instance", + "uri":"CreateInstance.html", "doc_type":"api", - "p_code":"2", + "p_code":"6", "code":"7" }, { - "desc":"This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, an", + "desc":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v2/{project_id}/instancesNoneStatus code: 200Status code: 400Status cod", "product_code":"dcs", - "title":"Modifying Information About a DCS Instance", - "uri":"dcs-api-0312007.html", + "title":"Querying All DCS Instances", + "uri":"ListInstances.html", "doc_type":"api", - "p_code":"2", + "p_code":"6", "code":"8" }, { - "desc":"This API is used to scale up a DCS Redis instance in the Running state.POST /v1.0/{project_id}/instances/{instance_id}/extendTable 1 describes the parameters.Parameter de", + "desc":"This API is used to delete multiple DCS instances at a time.DELETE /v2/{project_id}/instancesStatus code: 200Status code: 500Status code: 400Batch deleting DCS instancesS", "product_code":"dcs", - "title":"Scaling Up a DCS Instance", - "uri":"dcs-api-0312010.html", + "title":"Batch Deleting DCS Instances", + "uri":"BatchDeleteInstances.html", "doc_type":"api", - "p_code":"2", + "p_code":"6", "code":"9" }, { - "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.", + "desc":"This API is used to query the details about a specified DCS instance.GET /v2/{project_id}/instances/{instance_id}NoneStatus code: 200Status code: 200The specified instanc", "product_code":"dcs", - "title":"Instance Management APIs", - "uri":"dcs-api-0312035.html", + "title":"Querying a DCS instance", + "uri":"ShowInstance.html", "doc_type":"api", - "p_code":"", + "p_code":"6", "code":"10" }, { - "desc":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.PUT /v1.0/{project_id}/instances/statusTa", + "desc":"This API is used to delete a specified DCS instance to free up all resources occupied by it.To delete pay-per-use resources, perform operations in this section..DELETE /v", "product_code":"dcs", - "title":"Restarting DCS Instances or Clearing DCS Instance Data", - "uri":"dcs-api-0312018.html", + "title":"Deleting an Instance", + "uri":"DeleteSingleInstance.html", "doc_type":"api", - "p_code":"10", + "p_code":"6", "code":"11" }, { - "desc":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v1.0/{project_id}/instances/statisticTable 1 describes the parameter.Para", + "desc":"This API is used to modify the information about a DCS instance, including the instance name, description, port, backup policy, start and end time of the maintenance wind", "product_code":"dcs", - "title":"Querying Statistics of All Running Instances", - "uri":"dcs-api-0312014.html", + "title":"Modifying Details of a DCS Instance", + "uri":"UpdateInstance.html", "doc_type":"api", - "p_code":"10", + "p_code":"6", "code":"12" }, { - "desc":"This API is used to query the number of instances in different states.GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}Table 1 describes the paramet", + "desc":"This API is used to modify specifications of a DCS instance in the Running state.POST /v2/{project_id}/instances/{instance_id}/resizeNoneChanging instance specifications ", "product_code":"dcs", - "title":"Querying DCS Instance Status", - "uri":"dcs-api-0312016.html", + "title":"Modifying Instance Specifications", + "uri":"ResizeInstance.html", "doc_type":"api", - "p_code":"10", + "p_code":"6", "code":"13" }, { - "desc":"This API is used to change the password of a DCS instance.PUT /v1.0/{project_id}/instances/{instance_id}/passwordTable 1 describes the parameters.Parameter descriptionPar", + "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":"dcs", - "title":"Changing the Password of a DCS Instance", - "uri":"dcs-api-0312019.html", + "title":"Instance Management", + "uri":"InstanceManagement.html", "doc_type":"api", - "p_code":"10", + "p_code":"5", "code":"14" }, { - "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.", + "desc":"This API is used to perform a master/standby switchover. Only master/standby instances support this operation.POST /v2/{project_id}/instances/{instance_id}/swapNoneStatus", "product_code":"dcs", - "title":"Parameter Management APIs", - "uri":"dcs-api-0312013.html", + "title":"Master/Standby Switchover", + "uri":"ChangeMasterStandby.html", "doc_type":"api", - "p_code":"", + "p_code":"14", "code":"15" }, { - "desc":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v1.0/{project_id}/instances/{instance_id}/con", + "desc":"This API is used to change the password of a DCS instance.PUT /v2/{project_id}/instances/{instance_id}/passwordStatus code: 200Status code: 400Status code: 500Changing th", "product_code":"dcs", - "title":"Modifying Configuration Parameters", - "uri":"dcs-api-0312017.html", + "title":"Changing the Password", + "uri":"UpdatePassword.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "code":"16" }, { - "desc":"This API is used to query the configuration parameters of a DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/configsTable 1 describes the parameters.Parameter ", + "desc":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0, 5.0, and 6.0 instances.PUT /v2/{project_id}/instances/stat", "product_code":"dcs", - "title":"Querying Configuration Parameters", - "uri":"dcs-api-0312015.html", + "title":"Restarting DCS Instances or Clearing DCS Instance Data", + "uri":"RestartOrFlushInstances.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "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.", + "desc":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v2/{project_id}/instances/statisticNoneStatus code: 200Status code: 400St", "product_code":"dcs", - "title":"Data Migration APIs", - "uri":"dcs-api-0514003.html", + "title":"Querying Statistics of All Running Instances", + "uri":"ListStatisticsOfRunningInstances.html", "doc_type":"api", - "p_code":"", + "p_code":"14", "code":"18" }, { - "desc":"This API is used to create a data migration task.NonePOST /v2/{project_id}/migration-taskIf the status code is 200, the following parameters are returned:Example request ", + "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":"dcs", - "title":"Creating a Data Migration Task", - "uri":"dcs-api-0514004.html", + "title":"Shards and Replicas", + "uri":"GroupReplicationManagement.html", "doc_type":"api", - "p_code":"18", + "p_code":"5", "code":"19" }, + { + "desc":"This API is used to configure the replica priority. When the master node is faulty, a replica with a smaller weight has a higher priority to be promoted to master.POST /v", + "product_code":"dcs", + "title":"Configuring Replica Priority", + "uri":"UpdateSlavePriority.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "desc":"This API is used to remove the IP address of a read replica from the domain name. After the removal, the read-only domain name will not be resolved to the IP address.DELE", + "product_code":"dcs", + "title":"Removing the IP Address", + "uri":"DeleteIpFromDomainName.html", + "doc_type":"api", + "p_code":"19", + "code":"21" + }, + { + "desc":"This API is used to query shards and replicas of cluster instances.GET /v2/{project_id}/instance/{instance_id}/groupsNoneStatus code: 200Status code: 500Status code: 400S", + "product_code":"dcs", + "title":"Querying Details of Shards", + "uri":"ListGroupReplicationInfo.html", + "doc_type":"api", + "p_code":"19", + "code":"22" + }, + { + "desc":"This API is used to query the node information, number of valid instances, and number of nodes of all instances in a specified project. No node information will be return", + "product_code":"dcs", + "title":"Querying Instance Nodes in Batches", + "uri":"BatchShowNodesInformation.html", + "doc_type":"api", + "p_code":"19", + "code":"23" + }, { "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":"dcs", - "title":"Backup and Restoration APIs", - "uri":"dcs-api-0514005.html", + "title":"Parameter Management", + "uri":"ParamManagement.html", "doc_type":"api", - "p_code":"", - "code":"20" - }, - { - "desc":"This API is used to back up a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", - "product_code":"dcs", - "title":"Backing Up a DCS Instance", - "uri":"dcs-api-0312020.html", - "doc_type":"api", - "p_code":"20", - "code":"21" - }, - { - "desc":"This API is used to restore a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", - "product_code":"dcs", - "title":"Restoring a DCS Instance", - "uri":"dcs-api-0312021.html", - "doc_type":"api", - "p_code":"20", - "code":"22" - }, - { - "desc":"This API is used to query the backup records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beg", - "product_code":"dcs", - "title":"Querying DCS Instance Backup Records", - "uri":"dcs-api-0312022.html", - "doc_type":"api", - "p_code":"20", - "code":"23" - }, - { - "desc":"This API is used to query the restoration records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTim", - "product_code":"dcs", - "title":"Querying DCS Instance Restoration Records", - "uri":"dcs-api-0312023.html", - "doc_type":"api", - "p_code":"20", + "p_code":"5", "code":"24" }, { - "desc":"This API is used to delete the files backed up by a DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}Table 1 describes the parameters.Par", + "desc":"This API is used to query the configuration parameters of a DCS instance.GET /v2/{project_id}/instances/{instance_id}/configsNoneStatus code: 200Status code: 400Status co", + "product_code":"dcs", + "title":"Querying DCS Instance Configuration Parameters", + "uri":"ListConfigurations.html", + "doc_type":"api", + "p_code":"24", + "code":"25" + }, + { + "desc":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v2/{project_id}/instances/{instance_id}/confi", + "product_code":"dcs", + "title":"Modifying Configuration Parameters", + "uri":"UpdateConfigurations.html", + "doc_type":"api", + "p_code":"24", + "code":"26" + }, + { + "desc":"This API is used to query the parameter modification record list of an instance by keyword.GET /v2/{project_id}/instances/{instance_id}/config-historiesNoneStatus code: 2", + "product_code":"dcs", + "title":"Querying the List of Instance Parameter Modification Records", + "uri":"ListConfigHistories.html", + "doc_type":"api", + "p_code":"24", + "code":"27" + }, + { + "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":"dcs", + "title":"Backup and Restoration", + "uri":"BackupRestoreManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"28" + }, + { + "desc":"This API is used to delete the backup files of a DCS instance.DELETE /v2/{project_id}/instances/{instance_id}/backups/{backup_id}NoneStatus code: 400Status code: 500NoneS", "product_code":"dcs", "title":"Deleting Backup Files", - "uri":"dcs-api-0312024.html", + "uri":"DeleteBackupFile.html", "doc_type":"api", - "p_code":"20", - "code":"25" + "p_code":"28", + "code":"29" + }, + { + "desc":"This API is used to restore the backup data to a specific DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node inst", + "product_code":"dcs", + "title":"Restoring a DCS Instance", + "uri":"RestoreInstance.html", + "doc_type":"api", + "p_code":"28", + "code":"30" + }, + { + "desc":"This API is used to query the restoration records of a specific DCS instance.GET /v2/{project_id}/instances/{instance_id}/restoresNoneStatus code: 200Status code: 400Stat", + "product_code":"dcs", + "title":"Querying DCS Instance Restoration Records", + "uri":"ListRestoreRecords.html", + "doc_type":"api", + "p_code":"28", + "code":"31" + }, + { + "desc":"This API is used to obtain the download links of backup files.POST /v2/{project_id}/instances/{instance_id}/backups/{backup_id}/linksStatus code: 200Status code: 400Statu", + "product_code":"dcs", + "title":"Obtaining the Backup File URL", + "uri":"ListBackupFileLinks.html", + "doc_type":"api", + "p_code":"28", + "code":"32" + }, + { + "desc":"This API is used to back up a specific DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST /", + "product_code":"dcs", + "title":"Backing Up a DCS Instance", + "uri":"CopyInstance.html", + "doc_type":"api", + "p_code":"28", + "code":"33" + }, + { + "desc":"This API is used to query the backup records of a specific DCS instance.GET /v2/{project_id}/instances/{instance_id}/backupsNoneStatus code: 200Status code: 400Status cod", + "product_code":"dcs", + "title":"Listing DCS Instance Backup Records", + "uri":"ListBackupRecords.html", + "doc_type":"api", + "p_code":"28", + "code":"34" + }, + { + "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":"dcs", + "title":"Data Migration", + "uri":"DataMigrationManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"35" + }, + { + "desc":"This API is used to create a backup import task.POST /v2/{project_id}/migration-taskStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404Status", + "product_code":"dcs", + "title":"Creating a Backup Import Task", + "uri":"CreateMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"36" + }, + { + "desc":"This API is used to query the migration task list.GET /v2/{project_id}/migration-tasksNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404", + "product_code":"dcs", + "title":"Listing Migration Tasks", + "uri":"ListMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"37" + }, + { + "desc":"This API is used to delete data migration tasks.DELETE /v2/{project_id}/migration-tasks/deleteStatus code: 200Status code: 400Status code: 401Status code: 403Status code:", + "product_code":"dcs", + "title":"Deleting Data Migration Tasks", + "uri":"DeleteMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"38" + }, + { + "desc":"This API is used to query migration task details.GET /v2/{project_id}/migration-task/{task_id}NoneStatus code: 200Status code: 400Status code: 401Status code: 403Status c", + "product_code":"dcs", + "title":"Querying Details of a Data Migration Task", + "uri":"ShowMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"39" + }, + { + "desc":"This API is used to configure auto-reconnect for migration tasks.PUT /v2/{project_id}/migration-task/{task_id}Status code: 400Status code: 401Status code: 403Status code:", + "product_code":"dcs", + "title":"Configuring Auto-Reconnect for Migration Tasks", + "uri":"UpdateMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"40" + }, + { + "desc":"This API is used to stop a data migration task.POST /v2/{project_id}/migration-task/{task_id}/stopNoneStatus code: 200Status code: 400Status code: 401Status code: 403Stat", + "product_code":"dcs", + "title":"Stopping a Data Migration Task", + "uri":"StopMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"41" + }, + { + "desc":"This API is used to query progress details about an online migration task.GET /v2/{project_id}/migration-task/{task_id}/statsNoneStatus code: 200Status code: 400Status co", + "product_code":"dcs", + "title":"Querying the Progress of an Online Migration Task", + "uri":"ShowMigrationTaskStats.html", + "doc_type":"api", + "p_code":"35", + "code":"42" + }, + { + "desc":"This API is used to create an online data migration task.POST /v2/{project_id}/migration/instanceStatus code: 200Status code: 400Status code: 401Status code: 403Status co", + "product_code":"dcs", + "title":"Creating an Online Data Migration Task", + "uri":"CreateOnlineMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"43" + }, + { + "desc":"This API is used to configure an online data migration task.POST /v2/{project_id}/migration/{task_id}/taskStatus code: 200Status code: 400Status code: 401Status code: 403", + "product_code":"dcs", + "title":"Configuring an Online Data Migration Task", + "uri":"SetOnlineMigrationTask.html", + "doc_type":"api", + "p_code":"35", + "code":"44" + }, + { + "desc":"This API is used to stop data migration tasks in batches. If a success response is returned, the request is successfully delivered. The migration tasks are stopped only w", + "product_code":"dcs", + "title":"Stopping Data Migration Tasks", + "uri":"BatchStopMigrationTasks.html", + "doc_type":"api", + "p_code":"35", + "code":"45" + }, + { + "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":"dcs", + "title":"Tag Management", + "uri":"TagManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"46" + }, + { + "desc":"This API is used to query the tags of all resources owned by a tenant in a specific project.GET /v2/{project_id}/dcs/tagsNoneStatus code: 200Status code: 400Status code: ", + "product_code":"dcs", + "title":"Listing All Tags of a Tenant", + "uri":"ListTagsOfTenant.html", + "doc_type":"api", + "p_code":"46", + "code":"47" + }, + { + "desc":"This API is used to add or delete tags in batches for a DCS instance.POST /v2/{project_id}/dcs/{instance_id}/tags/actionNoneAdding tags to a specified resource in batches", + "product_code":"dcs", + "title":"Batch Adding or Deleting Tags", + "uri":"BatchCreateOrDeleteTags.html", + "doc_type":"api", + "p_code":"46", + "code":"48" + }, + { + "desc":"This API is used to query the tags of an instance by its instance ID.GET /v2/{project_id}/instances/{instance_id}/tagsNoneStatus code: 200Status code: 200Instance tags qu", + "product_code":"dcs", + "title":"Querying Tags of a DCS Instance", + "uri":"ShowTags.html", + "doc_type":"api", + "p_code":"46", + "code":"49" + }, + { + "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":"dcs", + "title":"Cache Analysis", + "uri":"CacheAnalysisManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"50" + }, + { + "desc":"This API is used to create a big key analysis task for a DCS Redis instance.POST /v2/{project_id}/instances/{instance_id}/bigkey-taskNoneStatus code: 200Status code: 400S", + "product_code":"dcs", + "title":"Creating a Big Key Analysis Task", + "uri":"CreateBigkeyScanTask.html", + "doc_type":"api", + "p_code":"50", + "code":"51" + }, + { + "desc":"This API is used to query the list of big key analysis tasks.GET /v2/{project_id}/instances/{instance_id}/bigkey-tasksNoneStatus code: 200Status code: 400Status code: 401", + "product_code":"dcs", + "title":"Listing Big Key Analysis Tasks", + "uri":"ListBigkeyScanTasks.html", + "doc_type":"api", + "p_code":"50", + "code":"52" + }, + { + "desc":"This API is used to query the big key analysis details.GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}NoneStatus code: 200Status code: 400Status code", + "product_code":"dcs", + "title":"Querying Big Key Analysis Details", + "uri":"ShowBigkeyScanTaskDetails.html", + "doc_type":"api", + "p_code":"50", + "code":"53" + }, + { + "desc":"This API is used to delete a big key analysis task.DELETE /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}NoneStatus code: 200Status code: 400Status code:", + "product_code":"dcs", + "title":"Deleting a Big Key Analysis Task", + "uri":"DeleteBigkeyScanTask.html", + "doc_type":"api", + "p_code":"50", + "code":"54" + }, + { + "desc":"This API is used to configure automatic big key analysis.PUT /v2/{project_id}/instances/{instance_id}/bigkey/autoscanStatus code: 200Status code: 400Status code: 401Statu", + "product_code":"dcs", + "title":"Configuring Automatic Big Key Analysis", + "uri":"UpdateBigkeyAutoscanConfig.html", + "doc_type":"api", + "p_code":"50", + "code":"55" + }, + { + "desc":"This API is used to query configurations of automatic big key analysis.GET /v2/{project_id}/instances/{instance_id}/bigkey/autoscanNoneStatus code: 200Status code: 400Sta", + "product_code":"dcs", + "title":"Querying the Configurations of Automatic Big Key Analysis", + "uri":"ShowBigkeyAutoscanConfig.html", + "doc_type":"api", + "p_code":"50", + "code":"56" + }, + { + "desc":"This API is used to create a hot key analysis task. Redis 3.0 does not support hot key analysis.To perform hot key analysis, the instance's maxmemory-policy parameter mus", + "product_code":"dcs", + "title":"Creating a Hot Key Analysis Task", + "uri":"CreateHotkeyScanTask.html", + "doc_type":"api", + "p_code":"50", + "code":"57" + }, + { + "desc":"This API is used to query the list of hot key analysis tasks.GET /v2/{project_id}/instances/{instance_id}/hotkey-tasksNoneStatus code: 200Status code: 400Status code: 401", + "product_code":"dcs", + "title":"Listing Hot Key Analysis Tasks", + "uri":"ListHotKeyScanTasks.html", + "doc_type":"api", + "p_code":"50", + "code":"58" + }, + { + "desc":"This API is used to query the hot key analysis details.GET /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}NoneStatus code: 200Status code: 400Status code", + "product_code":"dcs", + "title":"Querying Hot Key Analysis Details", + "uri":"ShowHotkeyTaskDetails.html", + "doc_type":"api", + "p_code":"50", + "code":"59" + }, + { + "desc":"This API is used to delete a hot key analysis task.DELETE /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}NoneStatus code: 200Status code: 400Status code:", + "product_code":"dcs", + "title":"Deleting a Hot Key Analysis Task", + "uri":"DeleteHotkeyScanTask.html", + "doc_type":"api", + "p_code":"50", + "code":"60" + }, + { + "desc":"This API is used to configure automatic hot key analysis.PUT /v2/{project_id}/instances/{instance_id}/hotkey/autoscanStatus code: 200Status code: 400Status code: 401Statu", + "product_code":"dcs", + "title":"Configuring Automatic Hot Key Analysis", + "uri":"UpdateHotkeyAutoScanConfig.html", + "doc_type":"api", + "p_code":"50", + "code":"61" + }, + { + "desc":"This API is used to query configurations of automatic hot key analysis.GET /v2/{project_id}/instances/{instance_id}/hotkey/autoscanNoneStatus code: 200Status code: 400Sta", + "product_code":"dcs", + "title":"Querying the Configurations of Automatic Hot Key Analysis", + "uri":"ShowHotkeyAutoscanConfig.html", + "doc_type":"api", + "p_code":"50", + "code":"62" + }, + { + "desc":"This API is used to create an expired key scan task. Redis 3.0 does not support expired key scan. The keyspace will be scanned to release the memory used by expired keys ", + "product_code":"dcs", + "title":"Creating an Expired Key Scan Task", + "uri":"CreateAutoExpireScanTask.html", + "doc_type":"api", + "p_code":"50", + "code":"63" + }, + { + "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":"dcs", + "title":"Log Management", + "uri":"LogManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"64" + }, + { + "desc":"This API is used to query slow logs.GET /v2/{project_id}/instances/{instance_id}/slowlogNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 4", + "product_code":"dcs", + "title":"Querying the Slow Log", + "uri":"ListSlowlog.html", + "doc_type":"api", + "p_code":"64", + "code":"65" + }, + { + "desc":"This API is used to query the Redis run logs.GET /v2/{project_id}/instances/{instance_id}/redislogNoneStatus code: 200Status code: 400Status code: 401Status code: 403Stat", + "product_code":"dcs", + "title":"Listing Redis Run Logs", + "uri":"ListRedislog.html", + "doc_type":"api", + "p_code":"64", + "code":"66" + }, + { + "desc":"This API is used to collect Redis run logs.POST /v2/{project_id}/instances/{instance_id}/redislogNoneStatus code: 400Status code: 401Status code: 403Status code: 404Statu", + "product_code":"dcs", + "title":"Collecting Redis Run Logs", + "uri":"CreateRedislog.html", + "doc_type":"api", + "p_code":"64", + "code":"67" + }, + { + "desc":"This API is used to obtain the link for downloading logs.POST /v2/{project_id}/instances/{instance_id}/redislog/{id}/linksNoneStatus code: 200Status code: 400Status code:", + "product_code":"dcs", + "title":"Obtaining the Log Download Link", + "uri":"CreateRedislogDownloadLink.html", + "doc_type":"api", + "p_code":"64", + "code":"68" }, { "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":"dcs", "title":"Network Security", - "uri":"topic_300000009.html", + "uri":"NetworkSecurityManagement.html", "doc_type":"api", - "p_code":"", - "code":"26" + "p_code":"5", + "code":"69" }, { - "desc":"IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instancesThis API is used to configure IP address whitelist groups for a s", + "desc":"This API is used to enable or disable SSL. This API is only supported by DCS Redis 6.0 instances.PUT /v2/{project_id}/instances/{instance_id}/sslStatus code: 200Status co", + "product_code":"dcs", + "title":"Enabling or Disabling SSL", + "uri":"UpdateSSLSwitch.html", + "doc_type":"api", + "p_code":"69", + "code":"70" + }, + { + "desc":"This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0 instances.GET /v2/{project_id}/instances/{instance_id}/sslNoneStatus ", + "product_code":"dcs", + "title":"Querying SSL Encryption of an Instance", + "uri":"ShowInstanceSSLDetail.html", + "doc_type":"api", + "p_code":"69", + "code":"71" + }, + { + "desc":"This API is used to download the SSL certificate of an instance. This API is only supported by DCS Redis 6.0 instances.POST /v2/{project_id}/instances/{instance_id}/ssl-c", + "product_code":"dcs", + "title":"Downloading the SSL Certificate of an Instance", + "uri":"DownloadSSLCert.html", + "doc_type":"api", + "p_code":"69", + "code":"72" + }, + { + "desc":"This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist setting", "product_code":"dcs", "title":"Configuring IP Whitelist Groups", "uri":"UpdateIpWhitelist.html", "doc_type":"api", - "p_code":"26", - "code":"27" + "p_code":"69", + "code":"73" }, { "desc":"This API is used to query the IP address whitelist of a specific instance.GET /v2/{project_id}/instance/{instance_id}/whitelistNoneStatus code: 200Status code: 200Instanc", @@ -248,8 +662,377 @@ "title":"Querying the IP Whitelist of a DCS Instance", "uri":"ShowIpWhitelist.html", "doc_type":"api", - "p_code":"26", - "code":"28" + "p_code":"69", + "code":"74" + }, + { + "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":"dcs", + "title":"Background Task Management", + "uri":"BackgroudTasksManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"75" + }, + { + "desc":"This API is used to query background tasks.GET /v2/{project_id}/instances/{instance_id}/tasksNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status co", + "product_code":"dcs", + "title":"Listing Background Tasks", + "uri":"ListBackgroundTask.html", + "doc_type":"api", + "p_code":"75", + "code":"76" + }, + { + "desc":"Deleting a background task.DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}NoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code:", + "product_code":"dcs", + "title":"Deleting a Background Task", + "uri":"DeleteBackgroundTask.html", + "doc_type":"api", + "p_code":"75", + "code":"77" + }, + { + "desc":"This API is used to query the task execution result.GET /v2/{project_id}/jobs/{job_id}NoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404", + "product_code":"dcs", + "title":"Querying the Job Execution Result of a Tenant", + "uri":"ShowJobInfo.html", + "doc_type":"api", + "p_code":"75", + "code":"78" + }, + { + "desc":"This API is used to delete a task in the task center.DELETE /v2/{project_id}/tasks/{task_id}Status code: 400Status code: 401Status code: 403Status code: 404Status code: 5", + "product_code":"dcs", + "title":"Deleting a Task in the Task Center", + "uri":"DeleteCenterTask.html", + "doc_type":"api", + "p_code":"75", + "code":"79" + }, + { + "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":"dcs", + "title":"Instance Diagnosis", + "uri":"InstanceDiagnosisManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"80" + }, + { + "desc":"This API is used to query the list of diagnosis tasks of a specific DCS instance.GET /v2/{project_id}/instances/{instance_id}/diagnosisNoneStatus code: 200Status code: 40", + "product_code":"dcs", + "title":"Listing Instance Diagnosis Tasks", + "uri":"ListDiagnosisTasks.html", + "doc_type":"api", + "p_code":"80", + "code":"81" + }, + { + "desc":"This API is used to query details about a diagnosis report based on the report ID.GET /v2/{project_id}/diagnosis/{report_id}NoneStatus code: 200Status code: 400Status cod", + "product_code":"dcs", + "title":"Querying a Specified Diagnosis Report", + "uri":"ShowDiagnosisTaskDetails.html", + "doc_type":"api", + "p_code":"80", + "code":"82" + }, + { + "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":"dcs", + "title":"Template Management", + "uri":"ConfigTemplatesManagement.html", + "doc_type":"api", + "p_code":"5", + "code":"83" + }, + { + "desc":"This API is used to query parameter templates of a tenant, and allows you to specify query criteria.GET /v2/{project_id}/config-templatesNoneStatus code: 200Status code: ", + "product_code":"dcs", + "title":"Viewing Parameter Templates", + "uri":"ListConfigTemplates.html", + "doc_type":"api", + "p_code":"83", + "code":"84" + }, + { + "desc":"This API is used to create a custom template.POST /v2/{project_id}/config-templatesStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404Status ", + "product_code":"dcs", + "title":"Creating a Custom Template", + "uri":"CreateCustomTemplate.html", + "doc_type":"api", + "p_code":"83", + "code":"85" + }, + { + "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":"dcs", + "title":"Other APIs", + "uri":"OtherInterface.html", + "doc_type":"api", + "p_code":"5", + "code":"86" + }, + { + "desc":"This API is used to query the product flavor (parameter spec_code) required for configuring a new DCS instance. If no search criterion is specified, all product specifica", + "product_code":"dcs", + "title":"Querying Product Flavors", + "uri":"ListFlavors.html", + "doc_type":"api", + "p_code":"86", + "code":"87" + }, + { + "desc":"This API is used to query the start time and end time of maintenance windows.GET /v2/instances/maintain-windowsNoneStatus code: 200Status code: 500Status code: 200Mainten", + "product_code":"dcs", + "title":"Listing Maintenance Time Windows", + "uri":"ListMaintenanceWindows.html", + "doc_type":"api", + "p_code":"86", + "code":"88" + }, + { + "desc":"This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have ", + "product_code":"dcs", + "title":"Querying the Tenant Quotas", + "uri":"ShowQuotaOfTenant.html", + "doc_type":"api", + "p_code":"86", + "code":"89" + }, + { + "desc":"This API is used to query the monitored objects on secondary dimensions under primary dimension dcs_instance_id.GET /v2/{project_id}/dims/monitored-objects/{instance_id}N", + "product_code":"dcs", + "title":"Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension", + "uri":"ListMonitoredObjectsOfInstance.html", + "doc_type":"api", + "p_code":"86", + "code":"90" + }, + { + "desc":"This API is used to query the monitored objects on the primary dimension dcs_instance_id.GET /v2/{project_id}/dims/monitored-objectsNoneStatus code: 200Status code: 500St", + "product_code":"dcs", + "title":"Listing Monitored Objects on Primary Dimensions", + "uri":"ListMonitoredObjects.html", + "doc_type":"api", + "p_code":"86", + "code":"91" + }, + { + "desc":"This API is used to query the AZ information of the current region.GET /v2/available-zonesNoneStatus code: 200Status code: 200The query is successful.See Error Codes.", + "product_code":"dcs", + "title":"Querying AZs", + "uri":"ListAvailableZones.html", + "doc_type":"api", + "p_code":"86", + "code":"92" + }, + { + "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":"dcs", + "title":"Outdated APIs (V1)", + "uri":"dcs-api-0605002.html", + "doc_type":"api", + "p_code":"", + "code":"93" + }, + { + "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":"dcs", + "title":"Lifecycle Management APIs", + "uri":"dcs-api-0312003.html", + "doc_type":"api", + "p_code":"93", + "code":"94" + }, + { + "desc":"This API is used to create a DCS instance.The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.POST /v1.0/", + "product_code":"dcs", + "title":"Creating a DCS Instance", + "uri":"dcs-api-0312004.html", + "doc_type":"api", + "p_code":"94", + "code":"95" + }, + { + "desc":"This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}Table 1 describ", + "product_code":"dcs", + "title":"Deleting a Single DCS Instance", + "uri":"dcs-api-0312008.html", + "doc_type":"api", + "p_code":"94", + "code":"96" + }, + { + "desc":"This API is used to delete multiple DCS instances at a time.DELETE /v1.0/{project_id}/instances?allFailure={allFailure}Table 1 describes the parameters.Parameter descript", + "product_code":"dcs", + "title":"Batch Deleting DCS Instances", + "uri":"dcs-api-0312009.html", + "doc_type":"api", + "p_code":"94", + "code":"97" + }, + { + "desc":"This API is used to query the details about a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}Table 1 describes the parameters.Parameter descriptionP", + "product_code":"dcs", + "title":"Querying a DCS Instance", + "uri":"dcs-api-0312005.html", + "doc_type":"api", + "p_code":"94", + "code":"98" + }, + { + "desc":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&sta", + "product_code":"dcs", + "title":"Querying All DCS Instances of a Tenant", + "uri":"dcs-api-0312006.html", + "doc_type":"api", + "p_code":"94", + "code":"99" + }, + { + "desc":"This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, an", + "product_code":"dcs", + "title":"Modifying Information About a DCS Instance", + "uri":"dcs-api-0312007.html", + "doc_type":"api", + "p_code":"94", + "code":"100" + }, + { + "desc":"This API is used to scale up a DCS Redis instance in the Running state.POST /v1.0/{project_id}/instances/{instance_id}/extendTable 1 describes the parameters.Parameter de", + "product_code":"dcs", + "title":"Scaling Up a DCS Instance", + "uri":"dcs-api-0312010.html", + "doc_type":"api", + "p_code":"94", + "code":"101" + }, + { + "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":"dcs", + "title":"Instance Management APIs", + "uri":"dcs-api-0312035.html", + "doc_type":"api", + "p_code":"93", + "code":"102" + }, + { + "desc":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.PUT /v1.0/{project_id}/instances/statusTa", + "product_code":"dcs", + "title":"Restarting DCS Instances or Clearing DCS Instance Data", + "uri":"dcs-api-0312018.html", + "doc_type":"api", + "p_code":"102", + "code":"103" + }, + { + "desc":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v1.0/{project_id}/instances/statisticTable 1 describes the parameter.Para", + "product_code":"dcs", + "title":"Querying Statistics of All Running Instances", + "uri":"dcs-api-0312014.html", + "doc_type":"api", + "p_code":"102", + "code":"104" + }, + { + "desc":"This API is used to query the number of instances in different states.GET /v1.0/{project_id}/instances/status?include_failure={include_failure}Table 1 describes the param", + "product_code":"dcs", + "title":"Querying DCS Instance Status", + "uri":"dcs-api-0312016.html", + "doc_type":"api", + "p_code":"102", + "code":"105" + }, + { + "desc":"This API is used to change the password of a DCS instance.PUT /v1.0/{project_id}/instances/{instance_id}/passwordTable 1 describes the parameters.Parameter descriptionPar", + "product_code":"dcs", + "title":"Changing the Password of a DCS Instance", + "uri":"dcs-api-0312019.html", + "doc_type":"api", + "p_code":"102", + "code":"106" + }, + { + "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":"dcs", + "title":"Parameter Management APIs", + "uri":"dcs-api-0312013.html", + "doc_type":"api", + "p_code":"93", + "code":"107" + }, + { + "desc":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v1.0/{project_id}/instances/{instance_id}/con", + "product_code":"dcs", + "title":"Modifying Configuration Parameters", + "uri":"dcs-api-0312017.html", + "doc_type":"api", + "p_code":"107", + "code":"108" + }, + { + "desc":"This API is used to query the configuration parameters of a DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/configsTable 1 describes the parameters.Parameter ", + "product_code":"dcs", + "title":"Querying Configuration Parameters", + "uri":"dcs-api-0312015.html", + "doc_type":"api", + "p_code":"107", + "code":"109" + }, + { + "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":"dcs", + "title":"Backup and Restoration APIs", + "uri":"dcs-api-0514005.html", + "doc_type":"api", + "p_code":"93", + "code":"110" + }, + { + "desc":"This API is used to back up a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "product_code":"dcs", + "title":"Backing Up a DCS Instance", + "uri":"dcs-api-0312020.html", + "doc_type":"api", + "p_code":"110", + "code":"111" + }, + { + "desc":"This API is used to restore a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "product_code":"dcs", + "title":"Restoring a DCS Instance", + "uri":"dcs-api-0312021.html", + "doc_type":"api", + "p_code":"110", + "code":"112" + }, + { + "desc":"This API is used to query the backup records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beg", + "product_code":"dcs", + "title":"Querying DCS Instance Backup Records", + "uri":"dcs-api-0312022.html", + "doc_type":"api", + "p_code":"110", + "code":"113" + }, + { + "desc":"This API is used to query the restoration records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTim", + "product_code":"dcs", + "title":"Querying DCS Instance Restoration Records", + "uri":"dcs-api-0312023.html", + "doc_type":"api", + "p_code":"110", + "code":"114" + }, + { + "desc":"This API is used to delete the files backed up by a DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}Table 1 describes the parameters.Par", + "product_code":"dcs", + "title":"Deleting Backup Files", + "uri":"dcs-api-0312024.html", + "doc_type":"api", + "p_code":"110", + "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.", @@ -257,8 +1040,8 @@ "title":"Other APIs", "uri":"dcs-api-0312038.html", "doc_type":"api", - "p_code":"", - "code":"29" + "p_code":"93", + "code":"116" }, { "desc":"This API is used to query the product ID (parameter product_id) which indicates the specifications of the DCS service you created.GET /v1.0/productsRequest parametersNone", @@ -266,8 +1049,8 @@ "title":"Querying Service Specifications", "uri":"dcs-api-0312040.html", "doc_type":"api", - "p_code":"29", - "code":"30" + "p_code":"116", + "code":"117" }, { "desc":"This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have ", @@ -275,8 +1058,8 @@ "title":"Querying the Quota of a Tenant", "uri":"dcs-api-0312036.html", "doc_type":"api", - "p_code":"29", - "code":"31" + "p_code":"116", + "code":"118" }, { "desc":"The API is used to query the start time and end time of the maintenance time window.GET /v1.0/instances/maintain-windowsRequest parametersNoneExample requestNoneResponse ", @@ -284,8 +1067,8 @@ "title":"Querying Maintenance Time Window", "uri":"dcs-api-0312041.html", "doc_type":"api", - "p_code":"29", - "code":"32" + "p_code":"116", + "code":"119" }, { "desc":"This API is used to query the ID of the AZ where a DCS instance resides.GET /v1.0/availableZonesRequest parametersNoneExample requestNoneResponse parametersTable 1 descri", @@ -293,8 +1076,17 @@ "title":"Querying AZ Information", "uri":"dcs-api-0312039.html", "doc_type":"api", - "p_code":"29", - "code":"33" + "p_code":"116", + "code":"120" + }, + { + "desc":"This chapter describes fine-grained permissions management for your DCS. If your account does not need individual IAM users, you can skip the configurations described in ", + "product_code":"dcs", + "title":"Permissions Policies and Supported Actions", + "uri":"api-grant-policy.html", + "doc_type":"api", + "p_code":"", + "code":"121" }, { "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.", @@ -303,7 +1095,7 @@ "uri":"dcs-api-0312042.html", "doc_type":"api", "p_code":"", - "code":"34" + "code":"122" }, { "desc":"Table 1 describes the status codes.", @@ -311,26 +1103,26 @@ "title":"Status Codes", "uri":"dcs-api-0312043.html", "doc_type":"api", - "p_code":"34", - "code":"35" + "p_code":"122", + "code":"123" }, { "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":"dcs", "title":"Error Codes", - "uri":"dcs-api-0312044.html", + "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"34", - "code":"36" + "p_code":"122", + "code":"124" }, { - "desc":"A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.The following procedure describes how to obtain a project ID:On t", + "desc":"You can obtain a project ID by calling the API used to query project information based on the specified criteria.The API used to obtain a project ID is GET https://{Endpo", "product_code":"dcs", "title":"Obtaining a Project ID", "uri":"dcs-api-0312045.html", "doc_type":"api", - "p_code":"34", - "code":"37" + "p_code":"122", + "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.", @@ -338,8 +1130,17 @@ "title":"DCS Instance Statuses", "uri":"dcs-api-0312047.html", "doc_type":"api", - "p_code":"34", - "code":"38" + "p_code":"122", + "code":"126" + }, + { + "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":"dcs", + "title":"Instance Diagnosis IDs", + "uri":"dcs-api-0312050.html", + "doc_type":"api", + "p_code":"122", + "code":"127" }, { "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.", @@ -348,6 +1149,6 @@ "uri":"dcs-api-0312049.html", "doc_type":"api", "p_code":"", - "code":"39" + "code":"128" } ] \ No newline at end of file diff --git a/docs/dcs/api-ref/CacheAnalysisManagement.html b/docs/dcs/api-ref/CacheAnalysisManagement.html new file mode 100644 index 00000000..79f6ac7a --- /dev/null +++ b/docs/dcs/api-ref/CacheAnalysisManagement.html @@ -0,0 +1,40 @@ + + +

Cache Analysis

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/ChangeMasterStandby.html b/docs/dcs/api-ref/ChangeMasterStandby.html new file mode 100644 index 00000000..7d546f00 --- /dev/null +++ b/docs/dcs/api-ref/ChangeMasterStandby.html @@ -0,0 +1,287 @@ + + +

Master/Standby Switchover

+

Function

This API is used to perform a master/standby switchover. Only master/standby instances support this operation.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/swap

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/swap
+
+

Example Responses

Status code: 400

+

Invalid request.

+
{
+  "error_msg" : "Master standby swap is not supported.",
+  "error_code" : "DCS.4855",
+  "error_ext_msg" : null
+}
+
+

Status Codes

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

Status Code

+

Description

+

204

+

Master/standby switchover performed successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dcs/api-ref/ConfigTemplatesManagement.html b/docs/dcs/api-ref/ConfigTemplatesManagement.html new file mode 100644 index 00000000..f0c857bc --- /dev/null +++ b/docs/dcs/api-ref/ConfigTemplatesManagement.html @@ -0,0 +1,18 @@ + + +

Template Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/CopyInstance.html b/docs/dcs/api-ref/CopyInstance.html new file mode 100644 index 00000000..a8ef9f08 --- /dev/null +++ b/docs/dcs/api-ref/CopyInstance.html @@ -0,0 +1,222 @@ + + +

Backing Up a DCS Instance

+

Function

This API is used to back up a specific DCS instance.

+

Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.

+
+
+

URI

POST /v2/{project_id}/instances/{instance_id}/backups

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

remark

+

No

+

String

+

Description of DCS instance backup.

+

backup_format

+

No

+

String

+

Format of the DCS instance backup.

+

Enumeration values:

+

  • aof

    +

  • rdb

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

backup_id

+

String

+

Backup ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Backing up a specified DCS instance to an AOF file

+
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups
+
+{
+  "remark" : "Backup instances",
+  "backup_format" : "aof"
+}
+
+

Example Responses

Status code: 200

+

The specified DCS instance is backed up successfully.

+
{
+  "backup_id" : "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The specified DCS instance is backed up successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Backup and Restoration
+
+
+ diff --git a/docs/dcs/api-ref/CreateAutoExpireScanTask.html b/docs/dcs/api-ref/CreateAutoExpireScanTask.html new file mode 100644 index 00000000..5d7cce87 --- /dev/null +++ b/docs/dcs/api-ref/CreateAutoExpireScanTask.html @@ -0,0 +1,375 @@ + + +

Creating an Expired Key Scan Task

+

Function

This API is used to create an expired key scan task. Redis 3.0 does not support expired key scan. The keyspace will be scanned to release the memory used by expired keys that were not released due to the lazy free mechanism. This scan is on the master node of the instance and will affect instance performance. Perform this operation during off-peak hours.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/scan-expire-keys-task

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

Minimum: 0

+

Maximum: 36

+

instance_id

+

Yes

+

String

+

Instance ID.

+

Minimum: 0

+

Maximum: 36

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Expired key scan ID.

+

Minimum: 0

+

Maximum: 36

+

instance_id

+

String

+

Instance ID.

+

Minimum: 0

+

Maximum: 36

+

status

+

String

+

Scan task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Scan mode.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when a scan task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when a scan task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the scan task is being created.)

+

finished_at

+

String

+

Time when a scan task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the scan task is being created.)

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/scan-expire-keys-task
+
+

Example Responses

Status code: 200

+

Expired key scan task created successfully.

+
{
+  "id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a",
+  "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
+  "status" : "waiting",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z"
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4818",
+  "error_msg" : "Do not support auto expire scan."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Expired key scan task created successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

Request rejected.

+

404

+

The requested resource could not be found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/CreateBigkeyScanTask.html b/docs/dcs/api-ref/CreateBigkeyScanTask.html new file mode 100644 index 00000000..dd52772b --- /dev/null +++ b/docs/dcs/api-ref/CreateBigkeyScanTask.html @@ -0,0 +1,443 @@ + + +

Creating a Big Key Analysis Task

+

Function

This API is used to create a big key analysis task for a DCS Redis instance.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/bigkey-task

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Big key analysis record ID.

+

instance_id

+

String

+

Instance ID.

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

num

+

Integer

+

Number of big keys.

+

keys

+

Array of BigkeysBody objects

+

Big key record. (The value is null and is not returned when the analysis task is being created.)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BigkeysBody

Parameter

+

Type

+

Description

+

name

+

String

+

Key name.

+

type

+

String

+

Key type.

+

Enumeration values:

+

  • string

    +

  • list

    +

  • set

    +

  • zset

    +

  • hash

    +
+

shard

+

String

+

Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is ip:port.

+

db

+

Integer

+

Database where a big key is located.

+

size

+

Long

+

Size of the key value.

+

unit

+

String

+

Key unit. count: number of keys; byte: key size.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task
+
+

Example Responses

Status code: 200

+

Big key analysis task created successfully.

+
{
+  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "status" : "waiting",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z",
+  "num" : 0
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4919",
+  "error_msg" : "Does not support bigkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Big key analysis task created successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/CreateCustomTemplate.html b/docs/dcs/api-ref/CreateCustomTemplate.html new file mode 100644 index 00000000..0b9595f5 --- /dev/null +++ b/docs/dcs/api-ref/CreateCustomTemplate.html @@ -0,0 +1,414 @@ + + +

Creating a Custom Template

+

Function

This API is used to create a custom template.

+
+

URI

POST /v2/{project_id}/config-templates

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

template_id

+

Yes

+

String

+

Default template ID.

+

name

+

Yes

+

String

+

Template name.

+

type

+

Yes

+

String

+

Template type. Options:

+

  • sys: default template

    +

  • user: custom template

    +
+

Enumeration values:

+

  • sys

    +

  • user

    +
+

engine

+

No

+

String

+

Cache engine: Redis.

+

cache_mode

+

No

+

String

+

DCS instance type. Options:

+

  • single: single-node

    +

  • ha: master/standby

    +

  • cluster: Redis Cluster

    +

  • proxy: Proxy Cluster

    +
+

description

+

No

+

String

+

Template description.

+

engine_version

+

No

+

String

+

Cache version.

+

If the cache engine is Redis, the value can be 3.0, 4.0, 5.0, or 6.0.

+

params

+

Yes

+

Map<String,String>

+

Parameter configuration.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Template ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Creating a single-node, Redis 5.0 custom template

+
POST https://{dcs_endpoint}/v2/{project_id}/config-templates
+
+{
+  "name" : "Test",
+  "cache_mode" : "single",
+  "description" : "Test",
+  "engine" : "Redis",
+  "engine_version" : "5.0",
+  "params" : {
+    "latency-monitor-threshold" : 15
+  },
+  "template_id" : "11",
+  "type" : "sys"
+}
+
+

Example Responses

Status code: 200

+

The custom template is created successfully.

+
{
+  "id" : "efb1ba06-d3cd-4a77-9173-16f70f2d1343"
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "111400063",
+  "error_msg" : "Invalid {0} parameter in the request."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The custom template is created successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

Request rejected.

+

404

+

The requested resource could not be found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Template Management
+
+
+ diff --git a/docs/dcs/api-ref/CreateHotkeyScanTask.html b/docs/dcs/api-ref/CreateHotkeyScanTask.html new file mode 100644 index 00000000..84080b9f --- /dev/null +++ b/docs/dcs/api-ref/CreateHotkeyScanTask.html @@ -0,0 +1,452 @@ + + +

Creating a Hot Key Analysis Task

+

Function

This API is used to create a hot key analysis task. Redis 3.0 does not support hot key analysis.

+

To perform hot key analysis, the instance's maxmemory-policy parameter must be set to allkeys-lfu or volatile-lfu.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/hotkey-task

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Hot key analysis record ID.

+

instance_id

+

String

+

Instance ID.

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

num

+

Integer

+

Number of hot keys.

+

keys

+

Array of HotkeysBody objects

+

Hot key record. (The value is null and is not returned when the analysis task is being created.)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 HotkeysBody

Parameter

+

Type

+

Description

+

name

+

String

+

Key name.

+

type

+

String

+

Key type.

+

Enumeration values:

+

  • string

    +

  • list

    +

  • set

    +

  • zset

    +

  • hash

    +
+

shard

+

String

+

Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is ip:port.

+

db

+

Integer

+

Database where a hot key is located.

+

size

+

Long

+

Size of the key value.

+

unit

+

String

+

Key unit. count: number of keys; byte: key size.

+

freq

+

Integer

+

Reflects the access frequency of a key within a specific period of time.

+

The value is the logarithmic access frequency counter. The maximum value is 255, which indicates 1 million access requests. After the frequency reaches 255, the value will no longer increase even if access requests continue to increase. The value will decrease by 1 for every minute during which the key is not accessed.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task
+
+

Example Responses

Status code: 200

+

Hot key analysis task created successfully.

+
{
+  "id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a",
+  "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
+  "status" : "waiting",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z",
+  "num" : 0
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4922",
+  "error_msg" : "Does not support hotkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Hot key analysis task created successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/CreateInstance.html b/docs/dcs/api-ref/CreateInstance.html new file mode 100644 index 00000000..5cfe6ccc --- /dev/null +++ b/docs/dcs/api-ref/CreateInstance.html @@ -0,0 +1,934 @@ + + +

Creating a DCS Instance

+

Function

This API is used to create a DCS instance which is billed in pay-per-use mode.

+
+

URI

POST /v2/{project_id}/instances

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Instance name.

+

An instance name can contain letters, digits, underscores (_), and hyphens (-) and must start with a letter or digit.

+

When you create only one instance at a time, the value of this parameter can contain 4 to 64 characters. When you create multiple instances at a time, the value of this parameter can contain 4 to 56 characters. The instances are named in the format of custom name-n, where n starts from 000 and is incremented by 1. For example, if you create two instances and set the custom name to dcs_demo, the two instances are respectively named dcs_demo-000 and dcs_demo-001.

+

engine

+

Yes

+

String

+

Cache engine: Redis.

+

engine_version

+

No

+

String

+

Cache engine version.

+

If the cache engine is Redis, this parameter is mandatory. The version can be 3.0/4.0/5.0/6.0.

+

capacity

+

Yes

+

Float

+

Cache capacity (GB). For a single-node or master/standby DCS Redis 3.0 instance, the value can be 2, 4, 8, 16, 32, or 64. For a Proxy Cluster DCS Redis 3.0 instance, the value can be 64, 128, 256, 512, or 1024. For a single-node or master/standby DCS Redis 4.0 or 5.0 instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, or 64. For a cluster instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024.

+

spec_code

+

Yes

+

String

+

Product flavor. The query method is as follows:

+ +

az_codes

+

Yes

+

Array of strings

+

Code of the AZ where the cache node resides and which has available resources. For details, see Querying AZs. Check whether the desired AZ has available resources.

+

Master/Standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate multiple AZs. For details, see the example request.

+

vpc_id

+

Yes

+

String

+

VPC ID.

+

You can obtain it in either of the following ways:

+

  • Method 1: Log in to the VPC console and view the VPC ID on the My VPCs page.

    +

  • Method 2: Call the VPC API. For details, see the API for querying VPCs.

    +
+

subnet_id

+

Yes

+

String

+

Subnet network ID.

+

You can obtain it in either of the following ways:

+

  • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.

    +

  • Method 2: Call the VPC API. For details, see the API for querying subnets.

    +
+

security_group_id

+

No

+

String

+

ID of the security group to which the instance belongs.

+

This parameter is optional when engine is Redis and engine_version is 4.0, 5.0, or 6.0This parameter is mandatory when engine_version is 3.0. DCS Redis 4.0, 5.0, and 6.0 instances do not support security groups. They support only whitelist-based access control.

+

You can obtain it in either of the following ways:

+

  • Method 1: Log in to the VPC console and view the security group ID on the security group details page.

    +

  • Method 2: Call the API used to query security group details. For details, see the API for querying security group details. "

    +
+

publicip_id

+

No

+

String

+

ID of the EIP bound to the DCS Redis instance.

+

This parameter is reserved. Retain the default value.

+

Default: false

+

enterprise_project_id

+

No

+

String

+

Enterprise project ID.

+

enterprise_project_name

+

No

+

String

+

Enterprise project name.

+

description

+

No

+

String

+

Instance description.

+

The description can contain a maximum of 1024 characters.

+
NOTE:

The backslash () and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character () before the characters, for example, \\ and \".

+
+

enable_ssl

+

No

+

Boolean

+

This parameter is reserved. Retain the default value.

+

private_ip

+

No

+

String

+

IP address that is manually specified for a DCS instance. This parameter is available for DCS Redis instances.

+

instance_num

+

No

+

Integer

+

Number of instances to be created in batches. This parameter is available for DCS Redis instances.

+

Default value: 1.

+

Value range: 1 to 100

+

Default: 1

+

maintain_begin

+

No

+

String

+

UTC time when the maintenance time window starts. The format is HH:mm:ss.

+

  • The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see Listing Maintenance Time Windows

    +

  • For example, the start time must be on the hour, such as 18:00:00 and 19:00:00.

    +

  • The start time and end time must be set in pairs. If the start time is left blank, the end time must also be left blank. In this case, the system automatically sets the start time to 18:00:00.

    +
+

maintain_end

+

No

+

String

+

UTC time when the maintenance time window ends. The format is HH:mm:ss.

+

  • The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see Listing Maintenance Time Windows.

    +

  • The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.

    +

  • The start time and end time must be set in pairs. If the end time is left blank, the start time is also left blank. In this case, the system automatically sets the end time to 19:00:00.

    +
+

password

+

No

+

String

+

DCS instance authentication information.

+
NOTE:

When no_password_access is set to false or not specified, the request must contain the password parameter. The password of a DCS Redis instance must meet the following complexity requirements:

+
+

  • Must be a string consisting of 8 to 64 characters.

    +

  • The new password must be different from the old password.

    +

  • Must contain at least three of the following character types:

    +

    • Lowercase letters

      +

    • Uppercase letters

      +

    • Digits

      +

    • Special characters `~!@#$^&*()-_=+\|{},<.>/?

      +
    +
+

no_password_access

+

No

+

Boolean

+

Whether the instance can be accessed without a password.

+

  • true: The instance can be accessed without a password.

    +

  • false: The instance can be accessed only after password authentication. If this parameter is not set, the default value false is used.

    +
+

Default: false

+

bss_param

+

No

+

BssParam object

+

Parameter related to the billing mode. If this parameter is left blank, the default billing mode is pay-per-use. Other billing modes are not supported.

+

instance_backup_policy

+

No

+

BackupPolicy object

+

Backup policy. This parameter is supported when the instance type is master/standby or cluster.

+

tags

+

No

+

Array of ResourceTag objects

+

Instance tag key and value.

+

access_user

+

No

+

String

+

Leave this parameter empty.

+

enable_publicip

+

No

+

Boolean

+

This parameter is reserved. Retain the default value.

+

Default: false

+

port

+

No

+

Integer

+

Port customization.

+

If this parameter is not sent or is left empty when you create a Redis 4.0, 5.0, or 6.0 instance, the default port 6379 will be used. To customize a port, specify a port number in the range from 1 to 65535. For a DCS Redis 3.0 instance, the port cannot be customized. Port 6379 will be used.

+

rename_commands

+

No

+

Object

+

Critical command renaming.

+

If this parameter is not sent or is left empty when you create a Redis 4.0, 5.0, or 6.0 instance, no critical command will be renamed. Currently, only COMMAND, KEYS, FLUSHDB, FLUSHALL, SCAN, HSCAN, SSCAN, ZSCAN, and HGETALL commands can be renamed. Redis 3.0 instances do not support renaming of high-risk commands.

+

template_id

+

No

+

String

+

Parameter template ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BssParam

Parameter

+

Mandatory

+

Type

+

Description

+

is_auto_renew

+

No

+

String

+

This parameter is currently not used.

+

Default: false

+

charging_mode

+

Yes

+

String

+

Billing mode. The default value is postPaid, indicating pay-per-use.

+

Default: postPaid

+

is_auto_pay

+

No

+

String

+

This parameter is currently not used.

+

period_type

+

No

+

String

+

This parameter is currently not used.

+

period_num

+

No

+

Integer

+

This parameter is currently not used.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 BackupPolicy

Parameter

+

Mandatory

+

Type

+

Description

+

backup_type

+

Yes

+

String

+

Backup type.

+

  • auto: automatic backup

    +

  • manual: manual backup

    +
+

save_days

+

No

+

Integer

+

This parameter is mandatory when backup_type is set to auto. Retention period, in days. The value ranges from 1 to 7.

+

periodical_backup_plan

+

No

+

BackupPlan object

+

Backup schedule. This parameter is mandatory when backup_type is set to auto.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 BackupPlan

Parameter

+

Mandatory

+

Type

+

Description

+

timezone_offset

+

No

+

String

+

Time zone in which backup is performed. Range: GMT –12:00 to GMT +12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default.

+

backup_at

+

Yes

+

Array of integers

+

Day in a week on which backup starts. The value ranges from 1 to 7, where 1 indicates Monday, and 7 indicates Sunday.

+

period_type

+

Yes

+

String

+

Interval at which backup is performed, which supports only weekly currently.

+

begin_at

+

Yes

+

String

+

Time at which backup starts. 00:00-01:00 indicates that the backup starts at 00:00. The value must be on the hour. The backup interval is 1 hour.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 ResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key.

+

  • This field cannot be left blank.

    +

  • The key value of a resource must be unique.

    +

  • The tag key can contain a maximum of 36 characters.

    +

  • The tag key must be unique and cannot be empty.

    +
+

value

+

No

+

String

+

Tag value.

+

  • This parameter is mandatory when action is set to create and is optional when action is set to delete.

    +

  • The tag value can contain a maximum of 43 characters.

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instances

+

Array of Instances objects

+

DCS instance ID and name. If multiple DCS instances are created at a time, multiple DCS instance IDs and names will be returned.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 Instances

Parameter

+

Type

+

Description

+

instance_id

+

String

+

DCS instance ID.

+

instance_name

+

String

+

DCS instance name.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

  • Creating a DCS Redis instance

    +
    POST https://{dcs_endpoint}/v2/{project_id}/instances
+
+{
+  "name" : "dcs-APITest",
+  "description" : "Test",
+  "engine" : "Redis",
+  "engine_version" : "5.0",
+  "enterprise_project_id" : 0,
+  "enterprise_project_name" : "default",
+  "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
+  "security_group_id" : "securityGroupId",
+  "enable_ssl" : false,
+  "private_ip" : "",
+  "az_codes" : [ "region01" ],
+  "capacity" : 1,
+  "access_user" : "",
+  "password" : "********",
+  "enable_publicip" : false,
+  "spec_code" : "redis.single.xu1.large.1",
+  "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
+  "no_password_access" : false,
+  "template_id" : "b3ecc9c7-1133-4c47-a06a-21366e227d61"
+}
    +

  • Creating a pay-per-use, master/standby DCS Redis instance with a customized port, renamed commands, and cross-AZ deployment

    +
    {
+  "enterprise_project_name" : "default",
+  "vpc_id" : "c5cd009b-9ba9-41f2-9a26-2b8c3f3ffd39",
+  "description" : "Test",
+  "security_group_id" : "d57fad27-e3e9-43b7-9498-0a698ab63b27",
+  "port" : 4040,
+  "enable_ssl" : false,
+  "private_ip" : "",
+  "az_codes" : [ "region01", "region02" ],
+  "capacity" : 2,
+  "access_user" : "",
+  "instance_num" : 1,
+  "enterprise_project_id" : 0,
+  "password" : "********",
+  "enable_publicip" : false,
+  "engine" : "Redis",
+  "spec_code" : "redis.ha.au1.large.2",
+  "name" : "dcs-demo",
+  "subnet_id" : "7e95c4d6-d7af-424c-a3cf-2be10968fe81",
+  "engine_version" : "4.0",
+  "no_password_access" : false,
+  "rename_commands" : {
+    "keys" : "keys001",
+    "flushdb" : "flushdb001",
+    "flushall" : "flushall001"
+  }
+}
    +
+
+

Example Responses

Status code: 200

+

The DCS instance creation task is submitted successfully.

+

If the instance status is RUNNING, the DCS instance has been successfully created.

+
+

  • Example 1

    +
    {
+  "instances" : [ {
+    "instance_id" : "3c49fd6b-fc7c-419e-9644-b6cce008653f",
+    "instance_name" : "dcs-test005"
+  } ]
+}
    +

  • Example 2

    +
    {
+  "instances" : [ {
+    "instance_id" : "77284d69-cd51-4bf1-aa30-2e60f055800c",
+    "instance_name" : "dcs-APITest1"
+  } ]
+}
    +
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.1004",
+  "error_msg" : "Project ID does not match the token."
+}
+

Status code: 401

+

Invalid authentication information.

+
{
+  "error_code" : "DCS.1001",
+  "error_msg" : "Invalid token."
+}
+

Status code: 403

+

The request is rejected.

+
{
+  "error_code" : "DCS.2003",
+  "error_msg" : "This role does not have the permission to perform this operation."
+}
+

Status code: 404

+

The requested resource is not found.

+
{
+  "error_code" : "DCS.4001",
+  "error_msg" : "The requested URL does not exist."
+}
+

Status code: 500

+

Internal service error.

+
{
+  "error_code" : "DCS.5000",
+  "error_msg" : "Internal service error."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The DCS instance creation task is submitted successfully.

+
NOTE:

If the instance status is RUNNING, the DCS instance has been successfully created.

+
+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dcs/api-ref/CreateMigrationTask.html b/docs/dcs/api-ref/CreateMigrationTask.html new file mode 100644 index 00000000..2a96de71 --- /dev/null +++ b/docs/dcs/api-ref/CreateMigrationTask.html @@ -0,0 +1,725 @@ + + +

Creating a Backup Import Task

+

Function

This API is used to create a backup import task.

+
+

URI

POST /v2/{project_id}/migration-task

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

task_name

+

Yes

+

String

+

Backup import task name.

+

description

+

No

+

String

+

Backup import task description.

+

migration_type

+

Yes

+

String

+

Migration mode. Options:

+

  • backupfile_import: importing backup files

    +

  • online_migration: migrating data online This API can no longer be used to create an online migration task. Please call CreateOnlineMigrationTask instead.

    +
+

Enumeration values:

+

  • backupfile_import

    +
+

migration_method

+

Yes

+

String

+

Type of the migration, which can be full migration or incremental migration. Values:

+

  • full_amount_migration: full migration

    +

  • incremental_migration: incremental migration

    +
+

Enumeration values:

+

  • full_amount_migration

    +

  • incremental_migration

    +
+

backup_files

+

No

+

BackupFilesBody object

+

Backup files to be imported when the migration mode is backup file import.

+

network_type

+

No

+

String

+

Type of the network for communication between the source and target Redis when the migration mode is online data migration. This API can no longer be used to create an online migration task. Please call CreateOnlineMigrationTask instead.

+

Enumeration values:

+

  • vpc

    +

  • vpn

    +
+

source_instance

+

No

+

SourceInstanceBody object

+

Source Redis information. This parameter is mandatory when the migration mode is online data migration. This API can no longer be used to create an online migration task. Please call CreateOnlineMigrationTask instead.

+

target_instance

+

Yes

+

TargetInstanceBody object

+

Target Redis information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BackupFilesBody

Parameter

+

Mandatory

+

Type

+

Description

+

file_source

+

No

+

String

+

Data source, which can be an OBS bucket or a backup record.

+

Enumeration values:

+

  • self_build_obs

    +

  • backup_record

    +
+

bucket_name

+

Yes

+

String

+

Name of the OBS bucket.

+

files

+

Yes

+

Array of Files objects

+

List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket.

+

backup_id

+

No

+

String

+

Backup record ID. This parameter is mandatory when the data source is a backup record.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Files

Parameter

+

Mandatory

+

Type

+

Description

+

file_name

+

Yes

+

String

+

Name of a backup file.

+

size

+

No

+

String

+

File size in bytes.

+

update_at

+

No

+

String

+

Time when the file was last modified. The format is YYYY-MM-DD HH:MM:SS.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 SourceInstanceBody

Parameter

+

Mandatory

+

Type

+

Description

+

addrs

+

Yes

+

String

+

Source Redis address (specified in the source_instance parameter).

+

password

+

No

+

String

+

Redis password. If a password is set, this parameter is mandatory.

+

task_status

+

No

+

String

+

Task status.

+

id

+

No

+

String

+

Redis instance ID.

+

ip

+

No

+

String

+

Redis IP address.

+

port

+

No

+

String

+

Redis port.

+

name

+

No

+

String

+

Redis name.

+

proxy_multi_db

+

No

+

Boolean

+

Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

+

db

+

No

+

String

+

Redis database.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 TargetInstanceBody

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Redis instance ID (mandatory in the target_instance parameter).

+

name

+

No

+

String

+

Redis instance name (specified in the target_instance parameter).

+

password

+

No

+

String

+

Redis password. If a password is set, this parameter is mandatory.

+

ip

+

No

+

String

+

Redis IP address.

+

port

+

No

+

String

+

Redis port.

+

addrs

+

No

+

String

+

Redis instance address.

+

proxy_multi_db

+

No

+

Boolean

+

Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

+

db

+

No

+

String

+

Redis database.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Migration task ID.

+

name

+

String

+

Migration task name.

+

status

+

String

+

Migration status. Options: SUCCESS, FAILED, MIGRATING, TERMINATED.

+

Enumeration values:

+

  • SUCCESS

    +

  • FAILED

    +

  • MIGRATING

    +

  • TERMINATED

    +
+

error

+

String

+

Error message.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Creating a backup import task to migrate data from an OBS bucket

+
POST https://{dcs_endpoint}/v2/{project_id}/migration-task
+
+{
+  "task_name" : "migration1",
+  "description" : "Test",
+  "migration_type" : "backupfile_import",
+  "migration_method" : "full_amount_migration",
+  "backup_files" : {
+    "bucket_name" : "bucketName",
+    "file_source" : "self_build_obs",
+    "files" : [ {
+      "size" : "754.0MB",
+      "file_name" : "fileName"
+    } ]
+  },
+  "target_instance" : {
+    "id" : "d2c8399f-bdba-43c1-8069-3ff17a1a79d5",
+    "name" : "dcs-test",
+    "password" : "xxxxxx"
+  }
+}
+
+

Example Responses

Status code: 200

+

Backup import task created.

+
{
+  "id" : "8aa6999e71cb638b0171f485f5266ef0",
+  "name" : "dcs-test",
+  "status" : "MIGRATING",
+  "error" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Backup import task created.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Data Migration
+
+
+ diff --git a/docs/dcs/api-ref/CreateOnlineMigrationTask.html b/docs/dcs/api-ref/CreateOnlineMigrationTask.html new file mode 100644 index 00000000..b6c28e56 --- /dev/null +++ b/docs/dcs/api-ref/CreateOnlineMigrationTask.html @@ -0,0 +1,375 @@ + + +

Creating an Online Data Migration Task

+

Function

This API is used to create an online data migration task.

+
+

URI

POST /v2/{project_id}/migration/instance

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the online migration task.

+

description

+

No

+

String

+

Description of the online migration task.

+

vpc_id

+

Yes

+

String

+

VPC ID.

+

Methods:

+

  • Method 1: Log in to the VPC console and view the VPC ID in the VPC details.

    +

  • Method 2: Call the VPC API. For details, see the API for querying VPCs.

    +
+

subnet_id

+

Yes

+

String

+

Subnet network ID.

+

Methods:

+

  • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.

    +

  • Method 2: Call the VPC API. For details, see the API for querying subnets.

    +
+

security_group_id

+

Yes

+

String

+

Security group which the instance belongs to. A security group implements access control for VMs within a security group or in different security groups, enhancing VM security. You can define different access rules for a security group to protect the VMs that are added to this security group.

+

Methods:

+

  • Method 1: Log in to the VPC console and choose Access Control > Security Groups. You can create and configure a security group, and obtain the security group ID.

    +

  • Method 2: Call the API used to query security group details. For details, see the API for querying security group details.

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Online migration task ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Creating an online migration task and configuring the VPC, subnet, and security group for the migration ECS

+
POST https://{dcs_endpoint}/v2/{project_id}/migration/instance
+
+{
+  "name" : "dcs-migration-thrc",
+  "description" : "Creating an online data migration task",
+  "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
+  "subnet_id" : "40f15ed6-7f85-49d5-ba0e-65b940d4812c",
+  "security_group_id" : "9df96622-24b7-4813-84b8-ab74552a21d7"
+}
+
+

Example Responses

Status code: 200

+

Online data migration task created.

+
{
+  "instance_id" : "b21989ec-2889-4b8e-99db-19c073425ec2"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Online data migration task created.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Data Migration
+
+
+ diff --git a/docs/dcs/api-ref/CreateRedislog.html b/docs/dcs/api-ref/CreateRedislog.html new file mode 100644 index 00000000..a862f934 --- /dev/null +++ b/docs/dcs/api-ref/CreateRedislog.html @@ -0,0 +1,333 @@ + + +

Collecting Redis Run Logs

+

Function

This API is used to collect Redis run logs.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/redislog

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

query_time

+

No

+

Integer

+

Date offset, indicating that the query starts from the last n days. The value can be 0, 1, 3, or 7. For example, the value 0 indicates that the logs of the current day are queried, and the value 7 indicates that the logs of the last seven days are queried.

+

Enumeration values:

+

  • 0

    +

  • 1

    +

  • 3

    +

  • 7

    +
+

log_type

+

Yes

+

String

+

Log type. Currently, only Redis run logs are supported. The value is run.

+

replication_id

+

No

+

String

+

Replica ID. You can query the replica ID from Shards and Replicas. This parameter is mandatory when the instance is not single-node.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/redislog?log_type=run&query_time=7
+
+

Example Responses

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4800",
+  "error_msg" : "Invalid logType."
+}
+
+

Status Codes

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

Status Code

+

Description

+

204

+

Run logs collected successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dcs/api-ref/CreateRedislogDownloadLink.html b/docs/dcs/api-ref/CreateRedislogDownloadLink.html new file mode 100644 index 00000000..9b0a3764 --- /dev/null +++ b/docs/dcs/api-ref/CreateRedislogDownloadLink.html @@ -0,0 +1,330 @@ + + +

Obtaining the Log Download Link

+

Function

This API is used to obtain the link for downloading logs.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/redislog/{id}/links

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

id

+

Yes

+

String

+

Unique ID of a log, which is obtained from the API used to query run logs.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Log ID.

+

backup_id

+

String

+

Background task ID.

+

link

+

String

+

Log download link. The default validity period is 24 hours.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/0524e839a54847039e9b2b46e8aa788a/instances/5c597ce5-9823-48aa-bf4d-2defb9385b4a/redislog/3ea6ce21-048e-447a-83c3-3fb004b88439/links
+
+

Example Responses

Status code: 200

+

Log download link obtained successfully.

+
{
+  "id" : "3ea6ce21-048e-447a-83c3-3fb004b88439",
+  "backup_id" : "3ea6ce21-048e-447a-83c3-3fb004b88439",
+  "link" : "https://bucketxxxxx.{obs_endpoint}:443/xxxxx/redis_192.168.x.x_2021-04-16.log?AWSAccessKeyId=xxxxx"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Log download link obtained successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dcs/api-ref/DataMigrationManagement.html b/docs/dcs/api-ref/DataMigrationManagement.html new file mode 100644 index 00000000..4697e728 --- /dev/null +++ b/docs/dcs/api-ref/DataMigrationManagement.html @@ -0,0 +1,34 @@ + + +

Data Migration

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/DeleteBackgroundTask.html b/docs/dcs/api-ref/DeleteBackgroundTask.html new file mode 100644 index 00000000..9b5c18ea --- /dev/null +++ b/docs/dcs/api-ref/DeleteBackgroundTask.html @@ -0,0 +1,320 @@ + + +

Deleting a Background Task

+

Function

Deleting a background task.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

task_id

+

Yes

+

String

+

Background task ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

message

+

String

+

Returned message.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Deleting a background task.

+
DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa
+
+

Example Responses

Status code: 200

+

Background task deleted successfully.

+
{
+  "message" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Background task deleted successfully.

+

204

+

Background task deleted successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Background Task Management
+
+
+ diff --git a/docs/dcs/api-ref/DeleteBackupFile.html b/docs/dcs/api-ref/DeleteBackupFile.html new file mode 100644 index 00000000..8f8cacdc --- /dev/null +++ b/docs/dcs/api-ref/DeleteBackupFile.html @@ -0,0 +1,164 @@ + + +

Deleting Backup Files

+

Function

This API is used to delete the backup files of a DCS instance.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/backups/{backup_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

backup_id

+

Yes

+

String

+

Backup ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups/{backup_id}
+
+

Example Responses

None

+
+

Status Codes

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

Status Code

+

Description

+

204

+

Backup file deleted successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Backup and Restoration
+
+
+ diff --git a/docs/dcs/api-ref/DeleteBigkeyScanTask.html b/docs/dcs/api-ref/DeleteBigkeyScanTask.html new file mode 100644 index 00000000..8cb99d0f --- /dev/null +++ b/docs/dcs/api-ref/DeleteBigkeyScanTask.html @@ -0,0 +1,466 @@ + + +

Deleting a Big Key Analysis Task

+

Function

This API is used to delete a big key analysis task.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

+

bigkey_id

+

Yes

+

String

+

ID of the big key analysis task.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Big key analysis record ID.

+

instance_id

+

String

+

Instance ID.

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

num

+

Integer

+

Number of big keys.

+

keys

+

Array of BigkeysBody objects

+

Big key record. (The value is null and is not returned when the analysis task is being created.)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BigkeysBody

Parameter

+

Type

+

Description

+

name

+

String

+

Key name.

+

type

+

String

+

Key type.

+

Enumeration values:

+

  • string

    +

  • list

    +

  • set

    +

  • zset

    +

  • hash

    +
+

shard

+

String

+

Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is ip:port.

+

db

+

Integer

+

Database where a big key is located.

+

size

+

Long

+

Size of the key value.

+

unit

+

String

+

Key unit. count: number of keys; byte: key size.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task/858ee14c-2271-4489-8b82-7bda7459ae3e
+
+

Example Responses

Status code: 200

+

Big key analysis task deleted successfully.

+
{
+  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "status" : "success",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z",
+  "started_at" : "2020-06-15T02:21:23.534Z",
+  "finished_at" : "2020-06-15T02:21:25.588Z",
+  "keys" : [ {
+    "name" : "dcs-bigkey-test",
+    "type" : "string",
+    "shard" : "192.168.1.134:6379",
+    "db" : 0,
+    "size" : 3000,
+    "unit" : "byte"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4919",
+  "error_msg" : "Does not support bigkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Big key analysis task deleted successfully.

+

204

+

No big key analysis tasks deleted.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/DeleteCenterTask.html b/docs/dcs/api-ref/DeleteCenterTask.html new file mode 100644 index 00000000..673778fe --- /dev/null +++ b/docs/dcs/api-ref/DeleteCenterTask.html @@ -0,0 +1,303 @@ + + +

Deleting a Task in the Task Center

+

Function

This API is used to delete a task in the task center.

+
+

URI

DELETE /v2/{project_id}/tasks/{task_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

task_id

+

Yes

+

String

+

Background task ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

message

+

No

+

String

+

Deletion result.

+
+
+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/tasks/{task_id}
+
+

Example Responses

None

+
+

Status Codes

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

Status Code

+

Description

+

200

+

Background task deleted successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

Request rejected.

+

404

+

The requested resource could not be found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Background Task Management
+
+
+ diff --git a/docs/dcs/api-ref/DeleteHotkeyScanTask.html b/docs/dcs/api-ref/DeleteHotkeyScanTask.html new file mode 100644 index 00000000..4a124935 --- /dev/null +++ b/docs/dcs/api-ref/DeleteHotkeyScanTask.html @@ -0,0 +1,475 @@ + + +

Deleting a Hot Key Analysis Task

+

Function

This API is used to delete a hot key analysis task.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

hotkey_id

+

Yes

+

String

+

ID of the hot key analysis task.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Hot key analysis record ID.

+

instance_id

+

String

+

Instance ID.

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

num

+

Integer

+

Number of hot keys.

+

keys

+

Array of HotkeysBody objects

+

Hot key record. (The value is null and is not returned when the analysis task is being created.)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 HotkeysBody

Parameter

+

Type

+

Description

+

name

+

String

+

Key name.

+

type

+

String

+

Key type.

+

Enumeration values:

+

  • string

    +

  • list

    +

  • set

    +

  • zset

    +

  • hash

    +
+

shard

+

String

+

Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is ip:port.

+

db

+

Integer

+

Database where a hot key is located.

+

size

+

Long

+

Size of the key value.

+

unit

+

String

+

Key unit. count: number of keys; byte: key size.

+

freq

+

Integer

+

Reflects the access frequency of a key within a specific period of time.

+

The value is the logarithmic access frequency counter. The maximum value is 255, which indicates 1 million access requests. After the frequency reaches 255, the value will no longer increase even if access requests continue to increase. The value will decrease by 1 for every minute during which the key is not accessed.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task/0ccb25d5-27cf-4188-b5ea-987730a85371
+
+

Example Responses

Status code: 200

+

Hot key analysis record deleted.

+
{
+  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "status" : "success",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z",
+  "started_at" : "2020-06-15T02:21:23.534Z",
+  "finished_at" : "2020-06-15T02:21:25.588Z",
+  "keys" : [ {
+    "name" : "dcs-hotkey-test",
+    "type" : "string",
+    "shard" : "192.168.1.134:6379",
+    "db" : 0,
+    "size" : 3000,
+    "unit" : "byte",
+    "freq" : 4
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4922",
+  "error_msg" : "Does not support hotkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Hot key analysis record deleted.

+

204

+

Hot key analysis record not found.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/DeleteIpFromDomainName.html b/docs/dcs/api-ref/DeleteIpFromDomainName.html new file mode 100644 index 00000000..85f42b94 --- /dev/null +++ b/docs/dcs/api-ref/DeleteIpFromDomainName.html @@ -0,0 +1,319 @@ + + +

Removing the IP Address

+

Function

This API is used to remove the IP address of a read replica from the domain name. After the removal, the read-only domain name will not be resolved to the IP address.

+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

group_id

+

Yes

+

String

+

Shard ID.

+

node_id

+

Yes

+

String

+

Node ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the IP address removing task.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip
+
+

Example Responses

None

+
+

Status Codes

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

Status Code

+

Description

+

200

+

IP address removed successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Shards and Replicas
+
+
+ diff --git a/docs/dcs/api-ref/DeleteMigrationTask.html b/docs/dcs/api-ref/DeleteMigrationTask.html new file mode 100644 index 00000000..6e7cac51 --- /dev/null +++ b/docs/dcs/api-ref/DeleteMigrationTask.html @@ -0,0 +1,323 @@ + + +

Deleting Data Migration Tasks

+

Function

This API is used to delete data migration tasks.

+
+

URI

DELETE /v2/{project_id}/migration-tasks/delete

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

task_id_list

+

Yes

+

Array of strings

+

List of IDs of the migration tasks to be deleted.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

task_id_list

+

Array of strings

+

List of IDs of the migration tasks to be deleted.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Deleting data migration tasks

+
DELETE https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks/delete
+
+{
+  "task_id_list" : [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ]
+}
+
+

Example Responses

Status code: 200

+

Data migration task deleted successfully.

+
{
+  "task_id_list" : [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Data migration task deleted successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource does not exist. (No response. For details, see status code 200.)

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Data Migration
+
+
+ diff --git a/docs/dcs/api-ref/DeleteSingleInstance.html b/docs/dcs/api-ref/DeleteSingleInstance.html new file mode 100644 index 00000000..317c422b --- /dev/null +++ b/docs/dcs/api-ref/DeleteSingleInstance.html @@ -0,0 +1,85 @@ + + +

Deleting an Instance

+

Function

This API is used to delete a specified DCS instance to free up all resources occupied by it.

+

To delete pay-per-use resources, perform operations in this section..

+
+
+

URI

DELETE /v2/{project_id}/instances/{instance_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Example Requests

Deleting a specified instance

+
DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}
+
+

Example Responses

None

+
+

Status Codes

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

Status Code

+

Description

+

204

+

Instance deleted successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dcs/api-ref/DownloadSSLCert.html b/docs/dcs/api-ref/DownloadSSLCert.html new file mode 100644 index 00000000..88dd147d --- /dev/null +++ b/docs/dcs/api-ref/DownloadSSLCert.html @@ -0,0 +1,207 @@ + + +

Downloading the SSL Certificate of an Instance

+

Function

This API is used to download the SSL certificate of an instance. This API is only supported by DCS Redis 6.0 instances.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/ssl-certs/download

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

file_name

+

String

+

SSL certificate file name.

+

link

+

String

+

Download link of the SSL certificate.

+

bucket_name

+

String

+

Name of the OBS bucket for storing the SSL certificate.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl-certs/download
+
+

Example Responses

Status code: 200

+

SSL certificate of the instance downloaded.

+
{
+  "bucket_name" : "bucket_name",
+  "file_name" : "file_name",
+  "link" : "https://{bucket_name}.{obs_endpoint}:443/{ssl-XXX}/{file_name}?AWSAccessKeyId=XXX&Expires=XXX&Signature=XXX"
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4201",
+  "error_msg" : "Do not support SSL."
+}
+

Status code: 500

+

Internal service error.

+
{
+  "error_code" : "DCS.5010",
+  "error_msg" : "Failed to operate SSL in database."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

SSL certificate of the instance downloaded.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Network Security
+
+
+ diff --git a/docs/dcs/api-ref/ErrorCode.html b/docs/dcs/api-ref/ErrorCode.html new file mode 100644 index 00000000..8872c415 --- /dev/null +++ b/docs/dcs/api-ref/ErrorCode.html @@ -0,0 +1,3205 @@ + + +

Error Codes

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

Status Code

+

Error Codes

+

Error Message

+

Description

+

Solution

+

400

+

111400002

+

Invalid project ID format.

+

Invalid project ID format.

+

Check whether the request parameters are valid.

+

400

+

111400004

+

Empty request body.

+

Empty request body.

+

Check whether the request parameters are valid.

+

400

+

111400005

+

The message body contains invalid characters or is not in JSON format.

+

The message body contains invalid characters or is not in JSON format.

+

Check whether the request parameters are valid.

+

400

+

111400007

+

The selected cache engine type is not supported.

+

The selected cache engine type is not supported.

+

Check whether the request parameters are valid.

+

400

+

111400008

+

The selected cache engine version is not supported.

+

The selected cache engine version is not supported.

+

Check whether the request parameters are valid.

+

400

+

111400009

+

Invalid product ID in the request.

+

Invalid product ID in the request.

+

Check whether the request parameters are valid.

+

400

+

111400010

+

Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

+

Invalid instance name. The name can contain 4 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

Check whether the request parameters are valid.

+

400

+

111400011

+

DCS instance description cannot exceed 1024 characters.

+

DCS instance description cannot exceed 1024 characters.

+

Check whether the request parameters are valid.

+

400

+

111400012

+

Invalid capacity parameter in the request.

+

Invalid capacity parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400013

+

Invalid vpc_id in the request.

+

Invalid vpc_id in the request.

+

Check whether the request parameters are valid.

+

400

+

111400014

+

Invalid security_group_id in the request.

+

Invalid security_group_id in the request.

+

Check whether the request parameters are valid.

+

400

+

111400016

+

Invalid subnet_id in the request.

+

Invalid subnet_id in the request.

+

Check whether the request parameters are valid.

+

400

+

111400017

+

This DCS instance job task is still running.

+

This DCS instance job task is still running.

+

Try again later.

+

400

+

111400018

+

This subnet must exist in the VPC.

+

This subnet must exist in the VPC.

+

Check whether the request parameters are valid.

+

400

+

111400019

+

The password does not meet complexity requirements.

+

The password does not meet complexity requirements.

+

Check whether the request parameters are valid.

+

400

+

111400020

+

DHCP must be enabled for this subnet.

+

DHCP must be enabled for this subnet.

+

Check whether DHCP has been enabled.

+

400

+

111400021

+

The isAutoRenew parameter in the request must be either 0 or 1.

+

The isAutoRenew parameter in the request must be either 0 or 1.

+

Check whether the request parameters are valid.

+

400

+

111400022

+

Engine does not match the product id.

+

The cache engine does not match the product ID.

+

Check whether the request parameters are valid.

+

400

+

111400026

+

This operation is not allowed when the DCS instance is in the current state.

+

This operation is not allowed when the DCS instance is in the current state.

+

Try again later or contact technical support.

+

400

+

111400027

+

This operation is not supported on this node.

+

This operation is not supported on this node.

+

Try again later or contact technical support.

+

400

+

111400035

+

DCS instance quota of the tenant is insufficient.

+

DCS instance quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

111400036

+

Memory quota of the tenant is insufficient.

+

Memory quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

111400037

+

The instanceParams parameter in the request contains invalid characters or is not in JSON format.

+

The instanceParams parameter in the request contains invalid characters or is not in JSON format.

+

Check whether the request parameters are valid.

+

400

+

111400038

+

The periodNum parameter in the request must be an integer.

+

The periodNum parameter in the request must be an integer.

+

Check whether the request parameters are valid.

+

400

+

111400039

+

The quota limit has been reached.

+

The quota limit has been reached.

+

Check whether the request parameters are valid.

+

400

+

111400042

+

This AZ does not exist.

+

This AZ does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400045

+

This DCS instance is already unfrozen.

+

This DCS instance is already unfrozen.

+

Check whether the request parameters are valid.

+

400

+

111400046

+

This security group does not exist.

+

This security group does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400047

+

The periodType parameter in the request must be either 2 or 3.

+

The periodType parameter in the request must be either 2 or 3.

+

Check whether the request parameters are valid.

+

400

+

111400048

+

The security group must have both outbound and inbound rules with protocols set to ANY.

+

The security group must have both outbound and inbound rules with protocols set to ANY.

+

Check whether the request parameters are valid.

+

400

+

111400053

+

the upgrade instance version equals to current version.

+

The targetVersion parameter in the request cannot be the same as the source version.

+

Check whether the request parameters are valid.

+

400

+

111400054

+

the selected available zone quota not enough.

+

DCS resources in the selected AZ have been sold out.

+

Select another AZ or contact technical support.

+

400

+

111400060

+

This DCS instance name already exists.

+

This DCS instance name already exists.

+

Check whether the request parameters are valid.

+

400

+

111400061

+

Invalid instance ID format.

+

Invalid instance ID format.

+

Check whether the request parameters are valid.

+

400

+

111400062

+

Invalid {0} parameter in the request.

+

Invalid {0} parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400063

+

Invalid {0} parameter in the request.

+

Invalid {0} parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400064

+

The action parameter in the request must be start, stop, or restart.

+

The action parameter in the request must be start, stop, or restart.

+

Check whether the request parameters are valid.

+

400

+

111400065

+

The instances parameter in the request cannot be a null value or left unspecified.

+

The instances parameter in the request cannot be a null value or left unspecified.

+

Check whether the request parameters are valid.

+

400

+

111400066

+

Invalid value of the configure parameter {0}.

+

Invalid value of the configure parameter {0}.

+

Check whether the request parameters are valid.

+

400

+

111400067

+

The available_zones parameter in the request must an array that contains only one AZ ID.

+

The available_zones parameter in the request must an array that contains only one AZ ID.

+

Check whether the request parameters are valid.

+

400

+

111400068

+

This VPC does not exist.

+

This VPC does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400070

+

Invalid task ID format.

+

Invalid task ID format.

+

Check whether the request parameters are valid.

+

400

+

111400072

+

Invalid saveDays instance backup policy parameter in the request.

+

Invalid saveDays instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400073

+

Invalid backupType instance backup policy parameter in the request.

+

Invalid backupType instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400074

+

Invalid periodType instance backup policy parameter in the request.

+

Invalid periodType instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400075

+

Invalid backupAt instance backup policy parameter in the request.

+

Invalid backupAt instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400076

+

Invalid beginAt instance backup policy parameter in the request.

+

Invalid beginAt instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400080

+

Instance password verify failed.

+

Instance password verify failed.

+

Check whether the request parameters are valid.

+

400

+

111400086

+

only master standby instance is support this action

+

This operation is allowed only for master/standby instances.

+

Operation not allowed.

+

400

+

111400087

+

the backup record status is err when restore this instance

+

The restoration operation is allowed only when the backup task succeeded.

+

Try again later or contact technical support.

+

400

+

111400094

+

the system is not support dcs job.

+

The system does not support the background task function.

+

Operation not allowed.

+

400

+

111400095

+

the system is not support backup and restore.

+

The system does not support the backup and restoration function.

+

Operation not allowed.

+

400

+

111400096

+

the instance is backuping.

+

Backing up the instance... Please try again later.

+

Try again later.

+

400

+

111400097

+

the instance is restoring.

+

Restoring the instance... Please try again later.

+

Try again later.

+

400

+

111400098

+

The value of the remark parameter must be 0 to 128 characters in length.

+

The value of the remark parameter must be 0 to 128 characters in length.

+

Check whether the request parameters are valid.

+

400

+

111400099

+

DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted.

+

DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted.

+

Try again later.

+

400

+

111400100

+

The number of instance IDs in an instances array cannot exceed 50.

+

The number of instance IDs in an instances array cannot exceed 50.

+

Check whether the request parameters are valid.

+

400

+

111400102

+

The system is not support resize.

+

Scale-up is not supported.

+

Operation not allowed.

+

400

+

111400103

+

The system is not support resize.

+

The capacity to which the instance is scaled up must be greater than the original capacity.

+

Check whether the request parameters are valid.

+

400

+

111400104

+

The DCS instance is recovering from an internal fault. Please try again later or contact customer service.

+

The DCS instance is recovering from an internal fault. Please try again later or contact customer service.

+

Try again later or contact technical support.

+

400

+

111400105

+

The value of reserved-memory cannot be greater than the free memory size of this DCS instance.

+

The value of reserved-memory cannot be greater than the free memory size of this DCS instance.

+

Check whether the request parameters are valid.

+

400

+

111400106

+

The value of maintain time illegal.

+

Invalid maintenance time window.

+

Check whether the request parameters are valid.

+

400

+

111400107

+

The instance exists for unpaid sacle up orders. Please process non payment orders first.

+

This instance has unpaid scale-up orders. Please process the orders before continuing.

+

Process unpaid orders before continuing.

+

400

+

111400108

+

The Instance exists for processing sacle up order. Please try again later.

+

Scaling up the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400111

+

the instance is restarting.

+

Restarting the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400113

+

the instance is extending.

+

Scaling up the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400114

+

the instance is configuring.

+

Modifying instance configuration... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400115

+

the instance is changing the password.

+

The password is being changed. Try again later.

+

Try again later or contact technical support.

+

400

+

111400116

+

the instance is upgrading.

+

Upgrading the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400117

+

the instance is rollbacking the version.

+

Rolling back the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400118

+

the instance is creating.

+

Creating the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400119

+

Query Bill Sample failed

+

The instance does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400120

+

the instance is Freezing.

+

Freezing the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400800

+

Invalid {0} in the request.

+

Invalid {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

111400843

+

The no_password_access parameter is missing or its value is invalid.

+

The no_password_access parameter is missing or its value is invalid.

+

Check whether the request parameters are valid.

+

400

+

111400844

+

The access_user parameter is missing or its value is invalid.

+

The access_user parameter is missing or its value is invalid.

+

Check whether the request parameters are valid.

+

400

+

111400845

+

The password parameter is missing or its value is invalid.

+

The password parameter is missing or its value is invalid.

+

Check whether the request parameters are valid.

+

400

+

111400849

+

The request parameter new_password should not exist.

+

The request parameter new_password should not exist.

+

Check whether the request parameters are valid.

+

400

+

111400850

+

This operation is not supported when Password-Free Access is enabled for the instance.

+

This operation is not supported when Password-Free Access is enabled for the instance.

+

Reset the instance password.

+

400

+

DCS. 4855

+

Master standby swap is not supported.

+

Master/standby switchover is not supported.

+

Operation not allowed.

+

400

+

DCS.4002

+

Invalid project ID format.

+

Invalid project ID format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4004

+

Empty request body.

+

Empty request body.

+

Check whether the request parameters are valid.

+

400

+

DCS.4005

+

The message body contains invalid characters or is not in JSON format.

+

The message body contains invalid characters or is not in JSON format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4006

+

The selected cache engine type is not supported.

+

The selected cache engine type is not supported.

+

Check whether the request parameters are valid.

+

400

+

DCS.4007

+

Instance type is not supported.

+

Instance type is not supported.

+

Check whether the request parameters are valid.

+

400

+

DCS.4008

+

The selected cache engine version is not supported.

+

The selected cache engine version is not supported.

+

Check whether the request parameters are valid.

+

400

+

DCS.4009

+

Invalid product ID in the request.

+

Invalid product ID in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4010

+

Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

+

Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.

+

Check whether the request parameters are valid.

+

400

+

DCS.4011

+

DCS instance description cannot exceed 1024 characters.

+

DCS instance description cannot exceed 1024 characters.

+

Check whether the request parameters are valid.

+

400

+

DCS.4012

+

Invalid capacity parameter in the request.

+

Invalid capacity parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4013

+

Invalid vpc_id in the request.

+

Invalid vpc_id in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4014

+

Invalid security_group_id in the request.

+

Invalid security_group_id in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4016

+

Invalid subnet_id in the request.

+

Invalid subnet_id in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4017

+

This DCS instance job task is still running.

+

This DCS instance job task is still running.

+

Try again later.

+

400

+

DCS.4018

+

This subnet must exist in the VPC.

+

This subnet must exist in the VPC.

+

Check whether the request parameters are valid.

+

400

+

DCS.4019

+

The password does not meet complexity requirements.

+

The password does not meet complexity requirements.

+

Check whether the request parameters are valid.

+

400

+

DCS.4020

+

DHCP must be enabled for this subnet.

+

DHCP must be enabled for this subnet.

+

Check whether DHCP has been enabled.

+

400

+

DCS.4021

+

The isAutoRenew parameter in the request must be either 0 or 1.

+

The isAutoRenew parameter in the request must be either 0 or 1.

+

Check whether the request parameters are valid.

+

400

+

DCS.4022

+

Engine does not match the product id.

+

The cache engine does not match the product ID.

+

Check whether the request parameters are valid.

+

400

+

DCS.4025

+

The end time must be after the start time.

+

The end time must be after the start time.

+

Check whether the request parameters are valid.

+

400

+

DCS.4026

+

This operation is not allowed when the DCS instance is in the current state.

+

This operation is not allowed when the DCS instance is in the current state.

+

Try again later or contact technical support.

+

400

+

DCS.4027

+

This operation is not supported on this node.

+

This operation is not supported on this node.

+

Try again later or contact technical support.

+

400

+

DCS.4028

+

The diagnosis time range is max 10 minutes.

+

The diagnosis time range is max 10 minutes.

+

Check whether the request parameters are valid.

+

400

+

DCS.4030

+

The start time must be within the last seven days.

+

The start time must be within the last seven days.

+

Check whether the request parameters are valid.

+

400

+

DCS.4031

+

The start time must be before than the current server time.

+

The start time must be before than the current server time.

+

Check whether the request parameters are valid.

+

400

+

DCS.4033

+

The start time must be after the instance start time.

+

The start time must be after the instance start time.

+

Check whether the request parameters are valid.

+

400

+

DCS.4035

+

DCS instance quota of the tenant is insufficient.

+

DCS instance quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

DCS.4036

+

Memory quota of the tenant is insufficient.

+

Memory quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

DCS.4037

+

The instanceParams parameter in the request contains invalid characters or is not in JSON format.

+

The instanceParams parameter in the request contains invalid characters or is not in JSON format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4038

+

The periodNum parameter in the request must be an integer.

+

The periodNum parameter in the request must be an integer.

+

Check whether the request parameters are valid.

+

400

+

DCS.4039

+

The quota limit has been reached.

+

The quota limit has been reached.

+

Check whether the request parameters are valid.

+

400

+

DCS.4042

+

This AZ does not exist.

+

This AZ does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4045

+

This DCS instance is already unfrozen.

+

This DCS instance is already unfrozen.

+

Try again later or contact technical support.

+

400

+

DCS.4046

+

This security group does not exist.

+

This security group does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4047

+

The periodType parameter in the request must be either 2 or 3.

+

The periodType parameter in the request must be either 2 or 3.

+

Check whether the request parameters are valid.

+

400

+

DCS.4048

+

The security group must have both outbound and inbound rules with protocols set to ANY.

+

The security group must have both outbound and inbound rules with protocols set to ANY.

+

Check whether the request parameters are valid.

+

400

+

DCS.4049

+

The instance status is not running.

+

The instance status is not running.

+

Contact technical support.

+

400

+

DCS.4052

+

Customized domain name verification failed.

+

Customized domain name verification failed.

+

Check whether the customized domain name parameters are valid.

+

400

+

DCS.4053

+

the upgrade instance version equals to current version.

+

The targetVersion parameter in the request cannot be the same as the source version.

+

Check whether the request parameters are valid.

+

400

+

DCS.4054

+

the selected available zone quota not enough.

+

DCS resources in the selected AZ have been sold out.

+

Select another AZ or contact technical support.

+

400

+

DCS.4060

+

This DCS instance name already exists.

+

This DCS instance name already exists.

+

Check whether the request parameters are valid.

+

400

+

DCS.4061

+

Invalid instance ID format.

+

Invalid instance ID format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4062

+

Invalid {0} parameter in the request.

+

Invalid {0} parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4063

+

Invalid {0} parameter in the request.

+

Invalid {0} parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4064

+

The action parameter in the request must be start, stop, or restart.

+

The action parameter in the request must be start, stop, or restart.

+

Check whether the request parameters are valid.

+

400

+

DCS.4065

+

The instances parameter in the request cannot be a null value or left unspecified.

+

The instances parameter in the request cannot be a null value or left unspecified.

+

Check whether the request parameters are valid.

+

400

+

DCS.4066

+

Invalid value of the configure parameter {0}.

+

Invalid value of the configure parameter {0}.

+

Check whether the request parameters are valid.

+

400

+

DCS.4067

+

The available_zones parameter in the request must an array that contains only one AZ ID.

+

The available_zones parameter in the request must an array that contains only one AZ ID.

+

Check whether the request parameters are valid.

+

400

+

DCS.4068

+

This VPC does not exist.

+

This VPC does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4070

+

Invalid task ID format.

+

Invalid task ID format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4072

+

Invalid saveDays instance backup policy parameter in the request.

+

Invalid saveDays instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4073

+

Invalid backupType instance backup policy parameter in the request.

+

Invalid backupType instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4074

+

Invalid periodType instance backup policy parameter in the request.

+

Invalid periodType instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4075

+

Invalid backupAt instance backup policy parameter in the request.

+

Invalid backupAt instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4076

+

Invalid beginAt instance backup policy parameter in the request.

+

Invalid beginAt instance backup policy parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4080

+

Instance password verify failed.

+

Instance password verify failed.

+

Check whether the request parameters are valid.

+

400

+

DCS.4086

+

only master standby instance is support this action

+

This operation is allowed only for master/standby instances.

+

Operation not allowed.

+

400

+

DCS.4087

+

the backup record status is err when restore this instance

+

The restoration operation is allowed only when the backup task succeeded.

+

Try again later or contact technical support.

+

400

+

DCS.4094

+

the system is not support dcs job.

+

The system does not support the background task function.

+

Operation not allowed.

+

400

+

DCS.4095

+

the system is not support backup and restore.

+

The system does not support the backup and restoration function.

+

Operation not allowed.

+

400

+

DCS.4096

+

the instance is backuping.

+

Backing up the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4097

+

the instance is restoring.

+

Restoring the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4098

+

The value of the remark parameter must be 0 to 128 characters in length.

+

The value of the remark parameter must be 0 to 128 characters in length.

+

Check whether the request parameters are valid.

+

400

+

DCS.4099

+

DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted.

+

DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted.

+

Try again later.

+

400

+

DCS.4100

+

The number of instance IDs in an instances array cannot exceed 50.

+

The number of instance IDs in an instances array cannot exceed 50.

+

Check whether the request parameters are valid.

+

400

+

DCS.4102

+

The system is not support resize.

+

The system is not support resize.

+

Operation not allowed.

+

400

+

DCS.4103

+

The system is not support resize.

+

The system is not support resize.

+

Check whether the request parameters are valid.

+

400

+

DCS.4104

+

The DCS instance is recovering from an internal fault. Please try again later or contact customer service.

+

The DCS instance is recovering from an internal fault. Please try again later or contact customer service.

+

Try again later or contact technical support.

+

400

+

DCS.4105

+

The value of reserved-memory cannot be greater than the free memory size of this DCS instance.

+

The value of reserved-memory cannot be greater than the free memory size of this DCS instance.

+

Check whether the request parameters are valid.

+

400

+

DCS.4106

+

The value of maintain time illegal.

+

The value of maintain time illegal.

+

Check whether the request parameters are valid.

+

400

+

DCS.4107

+

The instance exists for unpaid sacle up orders. Please process non payment orders first.

+

The instance exists for unpaid sacle up orders. Please process non payment orders first.

+

Process unpaid orders before continuing.

+

400

+

DCS.4108

+

The Instance exists for processing sacle up order. Please try again later.

+

The Instance exists for processing sacle up order. Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4111

+

the instance is restarting.

+

Restarting the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4113

+

the instance is extending.

+

Scaling up the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4114

+

the instance is configuring.

+

Modifying instance configuration... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4115

+

the instance is changing the password.

+

The password is being changed. Try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4116

+

the instance is upgrading.

+

Upgrading the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4117

+

the instance is rollbacking the version.

+

Rolling back the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4118

+

the instance is creating.

+

Creating the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4119

+

Query Bill Sample failed

+

The instance does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4120

+

the instance is Freezing.

+

Freezing the instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4200

+

Instance type cannot be changed.

+

Instance type cannot be changed.

+

Check whether the request parameters are valid.

+

400

+

DCS.4253

+

All replicas have a priority of 0.

+

All replicas have a priority of 0.

+

Check whether the request parameters are valid.

+

400

+

DCS.4300

+

Client IP transparent transmission is being processed, please do not submit it repeatedly.

+

Client IP transparent transmission is being processed, please do not submit it repeatedly.

+

Client IP pass-through is being enabled or disabled.

+

400

+

DCS.4800

+

Invalid {0} in the request.

+

Invalid {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4819

+

The first_scan_at parameter is invalid. Its must be ISO format utc date-time. The time must be later than the current time.

+

first_scan_at must be ISO format utc date-time. The time must be later than the current time.

+

Check whether the request parameters are valid. Example of the ISO UTC format: "2021-08-18T07:33:00.000Z"

+

400

+

DCS.4820

+

The interval parameter is invalid. must Greater than or equal to 0.

+

The value of interval is invalid. It must be greater than or equal to 0 seconds.

+

Check whether the request parameters are valid.

+

400

+

DCS.4821

+

The timeout parameter is invalid. Its must Greater than or equal to interval * 2, if interval is 0, timeout must Greater than 1 second.

+

The value of the timeout parameter is invalid. The value must be greater than 0 and at least twice the scanning interval.

+

Check whether the request parameters are valid.

+

400

+

DCS.4822

+

The scan_keys_count parameter is invalid. Its must Greater than or equal to 10, and Less than or equal to 1000.

+

The value of the scan_keys_count parameter is invalid. The value range is from 10 to 1000.

+

Check whether the request parameters are valid.

+

400

+

DCS.4838

+

Do not support feature client ip transparent transmission.

+

Client IP pass-through is not supported.

+

Client IP pass-through is not enabled.

+

400

+

DCS.4839

+

Do not support feature public dns.

+

Public domain name resolution is not supported.

+

Public domain name resolution is not enabled.

+

400

+

DCS.4840

+

Do not support feature dns.

+

Domain name resolution is not supported.

+

Domain name resolution is disabled.

+

400

+

DCS.4841

+

Instance do not support client ip transparent transmission.

+

The instance does not support client IP pass-through.

+

The instance version does not support client IP pass-through.

+

400

+

DCS.4843

+

The no_password_access parameter is missing or its value is invalid.

+

The no_password_access parameter is missing or its value is invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4844

+

The access_user parameter is missing or its value is invalid.

+

The access_user parameter is missing or its value is invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4845

+

The password parameter is missing or its value is invalid.

+

The password parameter is missing or its value is invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4846

+

Client ip transparent transmission is already closed,please do not repeat the operation.

+

Client IP pass-through is already disabled.

+

Client IP pass-through is disabled.

+

400

+

DCS.4847

+

Client ip transparent transmission is already opened,please do not repeat the operation.

+

Client IP pass-through is already enabled.

+

Client IP pass-through is enabled.

+

400

+

DCS.4848

+

Client Management is not supported.

+

Session management is not supported.

+

Operation not allowed.

+

400

+

DCS.4849

+

The request parameter new_password should not exist.

+

The request parameter new_password should not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4850

+

This operation is not supported when Password-Free Access is enabled for the instance.

+

This operation is not supported when Password-Free Access is enabled for the instance.

+

Check whether the request parameters are valid.

+

400

+

DCS.4875

+

Create replication number exceed max number limit.

+

The maximum number of replicas that can be created has been reached.

+

Check whether the request parameters are valid.

+

400

+

DCS.4879

+

r/w instance have only one repl can not remove ip from dns

+

The IP address cannot be removed because a master/standby instance must have at least one replica IP address.

+

Check whether the request parameters are valid.

+

400

+

DCS.4911

+

The network ip insufficient.

+

The subnet does not have sufficient IP addresses.

+

Check the quantity of IP addresses in the subnet. Release IP addresses that are no longer used, or use another subnet that has sufficient IP addresses.

+

400

+

DCS.4918

+

Instance bigkey analyze is running.

+

The big key analysis is in progress.

+

Try again later.

+

400

+

DCS.4919

+

Does not support bigkey analyze.

+

Big key analysis is not supported.

+

Operation not allowed.

+

400

+

DCS.4927

+

The param spec_code is invalid

+

The param spec_code is invalid

+

Check whether the request parameters are valid.

+

400

+

DCS.4930

+

The request param node_list is invalid

+

Invalid node_list parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4931

+

Node is not replica, can't delete.

+

The replica cannot be deleted because it is not a read-only replica.

+

Check whether the request parameters are valid.

+

400

+

DCS.4935

+

Only one slave replication has dns ip, can not delete

+

The replica cannot be deleted because at least one DNS IP address must be retained.

+

Check whether the request parameters are valid.

+

400

+

DCS.4936

+

The master node cannot be deleted

+

The master node cannot be deleted.

+

Check whether the request parameters are valid.

+

400

+

DCS.4937

+

Only has one slave node,can not delete

+

Retain at least one replica in addition to the master.

+

Check whether the request parameters are valid.

+

400

+

DCS.4939

+

The param slave_priority_weight is invalid.

+

Invalid slave_priority_weight parameter in the parameter.

+

Check whether the request parameters are valid.

+

400

+

DCS.4941

+

The hotkey id does not exist.

+

The hot key analysis task ID does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4942

+

The bigkey id does not exist.

+

The big key analysis task ID does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4957

+

This operation is not allowed when the task is in the current state.

+

This operation is not allowed when the task is in the current state.

+

Only tasks in the successful state support this operation.

+

400

+

DCS.4998

+

Domain names are up to date.

+

The domain name has already been updated.

+

The domain name has already been updated.

+

400

+

DCS.4999

+

Do not support feature update domain name.

+

Domain name update is not supported.

+

Domain name optimization is not enabled.

+

401

+

111401001

+

Invalid token.

+

Invalid token.

+

Check whether the request parameters are valid.

+

401

+

111401002

+

Token expired.

+

Token expired.

+

Check whether the request parameters are valid.

+

401

+

111401003

+

No token in the request.

+

No token in the request.

+

Check whether the request parameters are valid.

+

401

+

111401004

+

Project ID does not match the token.

+

Project ID does not match the token.

+

Check whether the request parameters are valid.

+

401

+

DCS.1001

+

Invalid token.

+

Invalid token.

+

Check whether the request parameters are valid.

+

401

+

DCS.1002

+

Token expired.

+

Token expired.

+

Check whether the request parameters are valid.

+

401

+

DCS.1003

+

No token in the request.

+

No token in the request.

+

Check whether the request parameters are valid.

+

401

+

DCS.1004

+

Project ID does not match the token.

+

Project ID does not match the token.

+

Check whether the request parameters are valid.

+

403

+

111403002

+

This tenant has read permission only and cannot perform this operation.

+

This tenant has read permission only and cannot perform this operation.

+

Check whether the request parameters are valid.

+

403

+

111403003

+

This role does not have the permission to perform this operation.

+

This role does not have the permission to perform this operation.

+

Check whether the request parameters are valid.

+

403

+

DCS.2003

+

This role does not have the permission to perform this operation.

+

This role does not have the permission to perform this operation.

+

Check whether the request parameters are valid.

+

403

+

DCS.2007

+

Policy does not allow {} to be performed.

+

Insufficient permissions.

+

Check whether the account has the required operation permissions.

+

403

+

DCS.3002

+

This tenant has read permission only and cannot perform this operation.

+

This tenant has read permission only and cannot perform this operation.

+

Check whether the request parameters are valid.

+

403

+

DCS.3003

+

This role does not have the permission to perform this operation.

+

This role does not have the permission to perform this operation.

+

Check whether the request parameters are valid.

+

404

+

111404001

+

The requested URL does not exist.

+

The requested URL does not exist.

+

Check whether the request parameters are valid.

+

404

+

111404022

+

This DCS instance does not exist.

+

This DCS instance does not exist.

+

Check whether the request parameters are valid.

+

404

+

111404023

+

This DCS order does not exist.

+

This DCS order does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.3022

+

This DCS instance does not exist.

+

This DCS instance does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.4001

+

The requested URL does not exist.

+

The requested URL does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.4023

+

This DCS order does not exist.

+

This DCS order does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.5101

+

Create agency failed.

+

Create agency failed.

+

Try again later or contact technical support.

+

405

+

111405001

+

This request method is not allowed.

+

This request method is not allowed.

+

Check whether the request parameters are valid.

+

405

+

DCS.5001

+

This request method is not allowed.

+

This request method is not allowed.

+

Check whether the request parameters are valid.

+

409

+

DCS.4050

+

Domain name already exists.

+

Domain name already exists.

+

Please change the user-defined domain name and try again.

+

409

+

DCS.4051

+

The dns name history already exists in the instance.

+

The dns name history already exists in the instance.

+

Please release the existing histoical domain names.

+

500

+

111400069

+

Another user is modifying configuration parameters of the DCS instance. Please try again later.

+

Another user is modifying configuration parameters of the DCS instance. Please try again later.

+

Try again later.

+

500

+

111400101

+

Delete instance backup file failed.

+

The instance backup file fails to be deleted.

+

Contact technical support.

+

500

+

111400842

+

job execution status failed.

+

Failed to run the task.

+

Contact technical support.

+

500

+

111500000

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500006

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500017

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500020

+

vm add port fail

+

Failed to add a port for the VM.

+

Contact technical support.

+

500

+

111500024

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500031

+

create instance fail

+

Failed to create a DCS instance.

+

Contact technical support.

+

500

+

111500032

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500037

+

query order info fail

+

query order info fail

+

Try again later or contact technical support.

+

500

+

111500041

+

No resource tenant available.

+

No resource tenant available.

+

Try again later or contact technical support.

+

500

+

111500044

+

update resource status fail

+

Failed to update the status of the instance.

+

Try again later or contact technical support.

+

500

+

111500053

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500054

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500070

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500071

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500077

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500078

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500079

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500082

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500083

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500085

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500090

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500091

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500092

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500095

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500104

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DCS. 5094

+

Master standby swap failed.

+

Master/standby switchover failed.

+

Contact technical support.

+

500

+

DCS.4069

+

Another user is modifying configuration parameters of the DCS instance. Please try again later.

+

Another user is modifying configuration parameters of the DCS instance. Please try again later.

+

Try again later.

+

500

+

DCS.4101

+

Delete instance backup file failed.

+

The instance backup file fails to be deleted.

+

Contact technical support.

+

500

+

DCS.4842

+

job execution status failed.

+

Failed to run the task.

+

Contact technical support.

+

500

+

DCS.5000

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DCS.5006

+

Submit job failed.

+

Submission failed.

+

Contact technical support.

+

500

+

DCS.5017

+

Failed to save instance information.

+

Failed to save the instance information.

+

Contact technical support.

+

500

+

DCS.5020

+

vm add port fail

+

Failed to add a port for the VM.

+

Contact technical support.

+

500

+

DCS.5024

+

Query instance failed.

+

Failed to query the instance.

+

Contact technical support.

+

500

+

DCS.5031

+

create instance fail

+

Failed to create a DCS instance.

+

Contact technical support.

+

500

+

DCS.5032

+

Failed to create order.

+

Failed to create the order.

+

Contact technical support.

+

500

+

DCS.5037

+

query order info fail

+

Failed to query the order details.

+

Contact technical support.

+

500

+

DCS.5039

+

Obtain IAM service failed.

+

Obtain IAM service failed.

+

Contact technical support.

+

500

+

DCS.5040

+

Call IAM API for querying agency failed.

+

Call IAM API for querying agency failed.

+

Contact technical support.

+

500

+

DCS.5041

+

No resource tenant available.

+

No resource tenant available.

+

Contact technical support.

+

500

+

DCS.5042

+

Call IAM API for creating agency failed.

+

Call IAM API for creating agency failed.

+

Contact technical support.

+

500

+

DCS.5043

+

Call IAM API for querying permission failed.

+

Call IAM API for querying permission failed.

+

Contact technical support.

+

500

+

DCS.5044

+

update resource status fail

+

Failed to update the status of the instance.

+

Contact technical support.

+

500

+

DCS.5045

+

Call IAM API for adding project-level agency permissions failed.

+

Call IAM API for adding project-level agency permissions failed.

+

Contact technical support.

+

500

+

DCS.5053

+

Instance node not found.

+

Instance node not found.

+

Contact technical support.

+

500

+

DCS.5054

+

Failed to generate password.

+

Failed to generate a password.

+

Contact technical support.

+

500

+

DCS.5070

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DCS.5071

+

Failed to create instance backup strategy.

+

Failed to create the instance backup policy.

+

Contact technical support.

+

500

+

DCS.5077

+

Query instance failed.

+

Failed to query the instance backup policy.

+

Contact technical support.

+

500

+

DCS.5078

+

Query backup record failed.

+

Failed to query the backup record.

+

Contact technical support.

+

500

+

DCS.5079

+

Query group node failed.

+

Failed to query the restoration record.

+

Contact technical support.

+

500

+

DCS.5081

+

The resource tenant does not exist.

+

The resource tenant does not exist.

+

Contact technical support.

+

500

+

DCS.5082

+

Failed to register resource tenant backup user.

+

Failed to register the resource tenant backup user.

+

Contact technical support.

+

500

+

DCS.5083

+

Failed to save backup user.

+

The backup user fails to be saved.

+

Contact technical support.

+

500

+

DCS.5085

+

Failed to update backup strategy.

+

The backup policy fails to be updated.

+

Contact technical support.

+

500

+

DCS.5090

+

Failed to save backup information.

+

The backup information fails to be saved.

+

Contact technical support.

+

500

+

DCS.5091

+

Script execution failed.

+

Script execution failed.

+

Contact technical support.

+

500

+

DCS.5092

+

Failed to save and restore data.

+

Failed to save and restore data.

+

Contact technical support.

+

500

+

DCS.5095

+

The script execution failed and needs to be retried.

+

Script execution failed and needs to be retried.

+

Contact technical support.

+

500

+

DCS.5104

+

Failed to modify order.

+

Failed to modify the order.

+

Contact technical support.

+

400

+

DCS.4202

+

ssl request params are invalid.

+

ssl request params are invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4933

+

The param available_zones is invalid.

+

Check available_zones are valid.

+

Check whether the request parameters are valid.

+

400

+

DCS.5050

+

Shared VPCs are not supported.

+

Not Supported shared vpc.

+

Check whether the request parameters are valid.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/dcs/api-ref/GroupReplicationManagement.html b/docs/dcs/api-ref/GroupReplicationManagement.html new file mode 100644 index 00000000..b7f00ed8 --- /dev/null +++ b/docs/dcs/api-ref/GroupReplicationManagement.html @@ -0,0 +1,22 @@ + + +

Shards and Replicas

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/InstanceDiagnosisManagement.html b/docs/dcs/api-ref/InstanceDiagnosisManagement.html new file mode 100644 index 00000000..999c16f9 --- /dev/null +++ b/docs/dcs/api-ref/InstanceDiagnosisManagement.html @@ -0,0 +1,18 @@ + + +

Instance Diagnosis

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/InstanceManagement.html b/docs/dcs/api-ref/InstanceManagement.html new file mode 100644 index 00000000..f8fcab46 --- /dev/null +++ b/docs/dcs/api-ref/InstanceManagement.html @@ -0,0 +1,22 @@ + + +

Instance Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/LifecycleManagement.html b/docs/dcs/api-ref/LifecycleManagement.html new file mode 100644 index 00000000..0087c9e8 --- /dev/null +++ b/docs/dcs/api-ref/LifecycleManagement.html @@ -0,0 +1,28 @@ + + +

Lifecycle Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/ListAvailableZones.html b/docs/dcs/api-ref/ListAvailableZones.html new file mode 100644 index 00000000..83d4f96a --- /dev/null +++ b/docs/dcs/api-ref/ListAvailableZones.html @@ -0,0 +1,143 @@ + + +

Querying AZs

+

Function

This API is used to query the AZ information of the current region.

+
+

URI

GET /v2/available-zones

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 1 Response body parameters

Parameter

+

Type

+

Description

+

region_id

+

String

+

Region ID.

+

available_zones

+

Array of AvailableZones objects

+

Array of AZs.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 AvailableZones

Parameter

+

Type

+

Description

+

code

+

String

+

AZ code.

+

port

+

String

+

AZ port.

+

name

+

String

+

AZ name.

+

id

+

String

+

AZ ID.

+

resource_availability

+

String

+

Whether the AZ has available resources.

+

  • true: There are available resources in the AZ.

    +

  • false: No resource is available

    +
+

Enumeration values:

+

  • true

    +

  • false

    +
+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/available-zones
+
+

Example Responses

Status code: 200

+

The query is successful.

+
{
+  "region_id" : "region00",
+  "available_zones" : [ {
+    "code" : "region01",
+    "port" : "8403",
+    "name" : "AZ 1.",
+    "id" : "effdcbc7d4d64a02aa1fa26b42f56533",
+    "resource_availability" : "true"
+  }, {
+    "code" : "region02",
+    "port" : "8404",
+    "name" : "AZ 2.",
+    "id" : "a0865121f83b41cbafce65930a22a6e8",
+    "resource_availability" : "true"
+  }, {
+    "code" : "region03",
+    "port" : "8408",
+    "name" : "AZ 3.",
+    "id" : "2dcb154ac2724a6d92e9bcc859657c1e",
+    "resource_availability" : "true"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

The query is successful.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dcs/api-ref/ListBackgroundTask.html b/docs/dcs/api-ref/ListBackgroundTask.html new file mode 100644 index 00000000..214f2733 --- /dev/null +++ b/docs/dcs/api-ref/ListBackgroundTask.html @@ -0,0 +1,683 @@ + + +

Listing Background Tasks

+

Function

This API is used to query background tasks.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/tasks

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

start_time

+

No

+

String

+

Query start time (UTC). Format: yyyyMMddHHmmss, for example, 20200609160000.

+

end_time

+

No

+

String

+

Query end time (UTC). Format: yyyyMMddHHmmss, for example, 20200617155959.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

task_count

+

String

+

Number of tasks.

+

tasks

+

Array of SingleBackgroundTask objects

+

Task details array.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 SingleBackgroundTask

Parameter

+

Type

+

Description

+

id

+

String

+

Background task ID.

+

name

+

String

+

Background task name. The options are as follows:

+

EXTEND: modifying specifications

+

BindEip: enabling public access

+

UnBindEip: disabling public access

+

AddReplica: adding replicas

+

DelReplica: deleting replicas

+

AddWhitelist: configuring an IP whitelist

+

UpdatePort: changing the port

+

RemoveIpFromDns: removing IP addresses

+

masterStandbySwapJob: master/standby switchover

+

modify: changing the password

+

details

+

DetailsBody object

+

Details.

+

user_name

+

String

+

Username.

+

user_id

+

String

+

User ID.

+

params

+

String

+

Task parameters.

+

status

+

String

+

Task status.

+

created_at

+

String

+

Task start time, in the format 2020-06-17T07:38:42.503Z.

+

updated_at

+

String

+

Task end time, in the format 2020-06-17T07:38:42.503Z.

+

enable_show

+

Boolean

+

Task details that can be expanded.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 DetailsBody

Parameter

+

Type

+

Description

+

old_capacity

+

String

+

Capacity before the modification. This parameter has a value only when the specifications are modified.

+

new_capacity

+

String

+

Capacity after the modification. This parameter has a value only when the specifications are modified.

+

enable_public_ip

+

Boolean

+

Whether to enable public access. This parameter has a value only when public access is enabled.

+

public_ip_id

+

String

+

ID of the IP address used for public access. This parameter has a value only when public access is enabled.

+

public_ip_address

+

String

+

IP address used for public access. This parameter has a value only when public access is enabled.

+

enable_ssl

+

Boolean

+

Whether to enable SSL. This parameter has a value only when SSL is enabled.

+

old_cache_mode

+

String

+

Cache type before the modification. This parameter has a value only when the specifications are modified.

+

new_cache_mode

+

String

+

Cache type after the modification. This parameter has a value only when the specifications are modified.

+

old_resource_spec_code

+

String

+

Specification parameter before the modification. This parameter has a value only when the specifications are modified.

+

new_resource_spec_code

+

String

+

Specification parameter after the modification. This parameter has a value only when the specifications are modified.

+

old_replica_num

+

Integer

+

Number of replicas before the modification. This parameter has a value only when the specifications are modified.

+

new_replica_num

+

Integer

+

Number of replicas after the modification. This parameter has a value only when the specifications are modified.

+

old_cache_type

+

String

+

Cache type before the modification. This parameter has a value only when the specifications are modified.

+

new_cache_type

+

String

+

Specification type after the modification. This parameter has a value only when the specifications are modified.

+

replica_ip

+

String

+

Replica IP address.

+

replica_az

+

String

+

AZ where the replica is in.

+

group_name

+

String

+

Group name.

+

old_port

+

Integer

+

Old port.

+

new_port

+

Integer

+

New port.

+

is_only_adjust_charging

+

Boolean

+

Indicates whether to only change the billing mode.

+

account_name

+

String

+

Account name.

+

source_ip

+

String

+

Source IP address.

+

target_ip

+

String

+

Target IP address.

+

node_name

+

String

+

Node information.

+

rename_commands

+

Array of strings

+

Renamed command.

+

updated_config_length

+

Integer

+

Length of the updated configuration item.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks?offset=0&limit=10&begin_time=20200609160000&end_time=20200617155959
+
+

Example Responses

Status code: 200

+

Background tasks listed successfully.

+
  • {
+  "task_count" : 1,
+  "tasks" : [ {
+    "id" : "8abf6e1e72c12e7c0172c15b508500aa",
+    "name" : "EXTEND",
+    "user_name" : "dcs_000_02",
+    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
+    "details" : {
+      "old_cache_mode" : "single",
+      "new_cache_mode" : "single",
+      "old_capacity" : "0.125",
+      "new_capacity" : "0.25",
+      "old_resource_spec_code" : "redis.single.xu1.tiny.125",
+      "new_resource_spec_code" : "redis.single.xu1.tiny.256",
+      "old_replica_num" : 1,
+      "new_replica_num" : 1,
+      "old_cache_type" : "single",
+      "new_cache_type" : "single",
+      "replica_ip" : "192.192.0.1",
+      "replica_az" : "az01",
+      "group_name" : "group1",
+      "old_port" : 6379,
+      "new_port" : 6379,
+      "is_only_adjust_charging" : false,
+      "account_name" : "account1",
+      "source_ip" : "192.192.0.0",
+      "target_ip" : "192.192.0.1",
+      "node_name" : "node1",
+      "rename_commands" : [ ],
+      "updated_config_length" : 0
+    },
+    "enable_show" : false,
+    "status" : "SUCCESS",
+    "created_at" : "2020-06-17T08:18:06.597Z",
+    "updated_at" : "2020-06-17T08:18:10.106Z"
+  } ]
+}
    +
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Background tasks listed successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Background Task Management
+
+
+ diff --git a/docs/dcs/api-ref/ListBackupFileLinks.html b/docs/dcs/api-ref/ListBackupFileLinks.html new file mode 100644 index 00000000..035c9932 --- /dev/null +++ b/docs/dcs/api-ref/ListBackupFileLinks.html @@ -0,0 +1,260 @@ + + +

Obtaining the Backup File URL

+

Function

This API is used to obtain the download links of backup files.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/backups/{backup_id}/links

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

backup_id

+

Yes

+

String

+

Backup ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

expiration

+

Yes

+

Integer

+

Validity period (in seconds) of a URL. The value range is from 5 minutes to 24 hours.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

file_path

+

String

+

Paths of files in the OBS bucket.

+

bucket_name

+

String

+

Name of the OBS bucket.

+

links

+

Array of LinksItem objects

+

Collection of URLs for downloading backup files. A maximum of 64 links are allowed.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 LinksItem

Parameter

+

Type

+

Description

+

file_name

+

String

+

Backup file name.

+

link

+

String

+

URL for downloading backup files.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Obtaining the download links of backup files with 1800s validity

+
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups/{backup_id}/links
+
+{
+  "expiration" : 1800
+}
+
+

Example Responses

Status code: 200

+

Successfully obtained backup file URLs.

+
{
+  "file_path" : "42489641-23c4-4855-bc89-befc85e2b7f7/ddfe5f66-a965-43ff-aec7-f3b489dc071b/",
+  "bucket_name" : "bucket5da9cf3bfabc4cae9023695b934e5e2b",
+  "links" : [ {
+    "file_name" : "redis_192.168.63.250_6379_10923-16383_20190820211816.rdb",
+    "link" : "https://bucket5da9cf3bfabc4cae9023695b934e5e2b.{obs_endpoint}:443/42489641-23c4-4855-bc89-befc85e2b7f7/ddfe5f66-a965-43ff-aec7-f3b489dc071b/redis_192.168.63.250_6379_10923-16383_20190820211816.rdb?AWSAccessKeyId=VD8CEQNG8VMQODUAAM0D&Expires=1566308915&Signature=s3I%2BrLbo%2BFZw%2BUsjVere%2FOQdKEg%3D"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Successfully obtained backup file URLs.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Backup and Restoration
+
+
+ diff --git a/docs/dcs/api-ref/ListBackupRecords.html b/docs/dcs/api-ref/ListBackupRecords.html new file mode 100644 index 00000000..c1532862 --- /dev/null +++ b/docs/dcs/api-ref/ListBackupRecords.html @@ -0,0 +1,410 @@ + + +

Listing DCS Instance Backup Records

+

Function

This API is used to query the backup records of a specific DCS instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/backups

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

begin_time

+

No

+

String

+

Query start time (UTC). Format: yyyyMMddHHmmss, for example, 20170718235959.

+

end_time

+

No

+

String

+

Query end time (UTC). Format: yyyyMMddHHmmss, for example, 20170718235959.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total_num

+

Integer

+

Number of returned records.

+

backup_record_response

+

Array of BackupRecordResponse objects

+

Array of the backup details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 BackupRecordResponse

Parameter

+

Type

+

Description

+

backup_id

+

String

+

Backup ID.

+

period

+

String

+

Backup execution time.

+

backup_name

+

String

+

Backup record name.

+

instance_id

+

String

+

Instance ID.

+

size

+

Long

+

Size of the backup file (byte).

+

backup_type

+

String

+

Backup type.

+

  • manual: manual backup

    +

  • auto: automatic backup

    +
+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when the backup task is created.

+

updated_at

+

String

+

Time at which DCS instance backup is completed.

+

progress

+

String

+

Backup progress.

+

error_code

+

String

+

Error code displayed for a backup failure.

+

  • dcs.08.0001 - Failed to start the backup and restoration tool.

    +

  • dcs.08.0002 - Execution timed out.

    +

  • dcs.08.0003 - Failed to delete the bucket.

    +

  • dcs.08.0004 - Failed to obtain the AK/SK.

    +

  • dcs.08.0005 - Failed to create the bucket.

    +

  • dcs.08.0006 - Failed to query the backup data size.

    +

  • dcs.08.0007 - Failed to synchronize data during restoration.

    +

  • dcs.08.0008 - The scheduled backup task is not running. The instance is running other tasks.

    +
+

remark

+

String

+

Description of DCS instance backup.

+

status

+

String

+

Backup status. The options are as follows:

+

  • waiting: The task is waiting to begin.

    +

  • backuping: DCS instance backup is in progress.

    +

  • succeed: DCS instance backup succeeded.

    +

  • failed: DCS instance backup failed.

    +

  • expired: The backup file has expired.

    +

  • deleted: The backup file has been deleted manually.

    +
+

Enumeration values:

+

  • waiting

    +

  • backuping

    +

  • succeed

    +

  • failed

    +

  • expired

    +

  • deleted

    +
+

is_support_restore

+

String

+

Whether restoration is supported. Options: TRUE and FALSE.

+

execution_at

+

String

+

Execution time.

+

backup_format

+

String

+

Backup format.

+

Enumeration values:

+

  • aof

    +

  • rdb

    +
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups?offset={offset}&limit={limit}&beginTime={begin_Time}&end_time={end_Time}
+
+

Example Responses

Status code: 200

+

DCS instance backup records queried successfully.

+
{
+  "total_num" : 1,
+  "backup_record_response" : [ {
+    "period" : { },
+    "backup_type" : "manual",
+    "created_at" : "2019-05-10T08:31:16.166Z",
+    "remark" : "001",
+    "is_support_restore" : "TRUE",
+    "backup_id" : "4631832a-14c6-45b0-a0b3-3abd8f591ad1",
+    "backup_name" : "backup_20190510163116",
+    "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
+    "size" : 880232,
+    "updated_at" : "2019-05-10T08:32:30.546Z",
+    "progress" : "100.00",
+    "error_code" : { },
+    "status" : "succeed",
+    "execution_at" : "2019-05-11T08:31:16.166Z",
+    "backup_format" : "aof"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

DCS instance backup records queried successfully.

+

204

+

No DCS instance backup record is found.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Backup and Restoration
+
+
+ diff --git a/docs/dcs/api-ref/ListBigkeyScanTasks.html b/docs/dcs/api-ref/ListBigkeyScanTasks.html new file mode 100644 index 00000000..69995978 --- /dev/null +++ b/docs/dcs/api-ref/ListBigkeyScanTasks.html @@ -0,0 +1,445 @@ + + +

Listing Big Key Analysis Tasks

+

Function

This API is used to query the list of big key analysis tasks.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/bigkey-tasks

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

status

+

No

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+

count

+

Integer

+

Number of times that big keys are analyzed.

+

records

+

Array of RecordsResponse objects

+

List of big key analysis record.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RecordsResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Task execution record ID. (This ID corresponds to the task ID in the parameter for querying big key or hot key analysis details.)

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z.

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-tasks
+
+

Example Responses

Status code: 200

+

Big key analysis records queried successfully.

+
{
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "count" : 1,
+  "records" : [ {
+    "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+    "scan_type" : "manual",
+    "status" : "success",
+    "created_at" : "2020-06-15T02:21:18.669Z",
+    "started_at" : "2020-06-15T02:21:23.534Z",
+    "finished_at" : "2020-06-15T02:21:25.588Z"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4919",
+  "error_msg" : "Does not support bigkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Big key analysis records queried successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/ListConfigHistories.html b/docs/dcs/api-ref/ListConfigHistories.html new file mode 100644 index 00000000..cdc943ba --- /dev/null +++ b/docs/dcs/api-ref/ListConfigHistories.html @@ -0,0 +1,264 @@ + + +

Querying the List of Instance Parameter Modification Records

+

Function

This API is used to query the parameter modification record list of an instance by keyword.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/config-histories

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be no less than 0.

+

limit

+

No

+

Integer

+

Number of records displayed on each page. The minimum value is 1. The maximum value is 1000*. If this parameter is not specified, 10 records are displayed on each page by default.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

history_num

+

Integer

+

Number of instance parameter modification records.

+

histories

+

Array of HistoryInfo objects

+

Details of instance parameter modification records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 HistoryInfo

Parameter

+

Type

+

Description

+

history_id

+

String

+

Modification record ID.

+

type

+

String

+

Modification type.

+

created_at

+

String

+

Modification time.

+

status

+

String

+

Modification status.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/config-histories?offset=0&limit=10
+
+

Example Responses

Status code: 200

+

List of instance parameter modification records queried successfully.

+
{
+  "history_num" : 1,
+  "histories" : [ {
+    "history_id" : "4ae8507f-7992-40e2-9928-41ccf1db4bdc",
+    "type" : "config_param",
+    "created_at" : "2022-10-20T03:37:44.636Z",
+    "status" : "SUCCESS"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

List of instance parameter modification records queried successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Parameter Management
+
+
+ diff --git a/docs/dcs/api-ref/ListConfigTemplates.html b/docs/dcs/api-ref/ListConfigTemplates.html new file mode 100644 index 00000000..5b26b7f8 --- /dev/null +++ b/docs/dcs/api-ref/ListConfigTemplates.html @@ -0,0 +1,513 @@ + + +

Viewing Parameter Templates

+

Function

This API is used to query parameter templates of a tenant, and allows you to specify query criteria.

+
+

URI

GET /v2/{project_id}/config-templates

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Parameter template name. Fuzzy search is supported.

+

type

+

Yes

+

String

+

Template type. Options:

+

  • sys: default template

    +

  • user: custom template

    +
+

Enumeration values:

+

  • sys

    +

  • user

    +
+

engine

+

No

+

String

+

Cache engine: Redis.

+

engine_version

+

No

+

String

+

Cache version.

+

If the cache engine is Redis, the value can be 3.0/4.0/5.0/6.0.

+

cache_mode

+

No

+

String

+

DCS instance type. Options:

+

  • single: single-node

    +

  • ha: master/standby

    +

  • cluster: Redis Cluster

    +

  • proxy: Proxy Cluster

    +
+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of records displayed on each page. The minimum value is 1. The maximum value is 1000*. If this parameter is not specified, 10 records are displayed on each page by default.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

template_num

+

Integer

+

Number of templates.

+

templates

+

Array of ConfigTemplatesListInfo objects

+

Template details array.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ConfigTemplatesListInfo

Parameter

+

Type

+

Description

+

template_id

+

String

+

Template ID.

+

cache_mode

+

String

+

DCS instance type. Options:

+

  • single: single-node

    +

  • ha: master/standby

    +

  • cluster: Redis Cluster

    +

  • proxy: Proxy Cluster

    +
+

description

+

String

+

Template description.

+

engine

+

String

+

Cache engine: Redis.

+

engine_version

+

String

+

Cache version.

+

If the cache engine is Redis, the value can be 3.0, 4.0, 5.0, or 6.0.

+

name

+

String

+

Template name.

+

product_type

+

String

+

Edition. Only the basic edition is supported. Value: generic.

+

Enumeration values:

+

  • generic

    +

  • enterprise

    +
+

storage_type

+

String

+

Storage type.

+

Enumeration values:

+

  • DRAM

    +

  • SSD

    +
+

type

+

String

+

Template type. Options:

+

  • sys: default template

    +

  • user: custom template

    +
+

Enumeration values:

+

  • sys

    +

  • user

    +
+

created_at

+

String

+

Time when the template is created. This parameter is valid only in custom parameter templates. The format is 2023-05-10T11:09:35.802Z.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/config-templates?type=sys&engine=Redis&engine_version=5.0&cache_mode=ha&offset=0&limit=10
+
+

Example Responses

Status code: 200

+

Parameter templates listed.

+
{
+  "template_num" : 1,
+  "templates" : [ {
+    "template_id" : "6",
+    "cache_mode" : "single",
+    "description" : null,
+    "engine" : "Redis",
+    "engine_version" : "4.0",
+    "name" : "Default-Redis-4.0-single-generic-DRAM",
+    "product_type" : "generic",
+    "storage_type" : "DRAM",
+    "type" : "sys"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "111400063",
+  "error_msg" : "Invalid {0} parameter in the request."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Parameter templates listed.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

Request rejected.

+

404

+

The requested resource could not be found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Template Management
+
+
+ diff --git a/docs/dcs/api-ref/ListConfigurations.html b/docs/dcs/api-ref/ListConfigurations.html new file mode 100644 index 00000000..13c6b097 --- /dev/null +++ b/docs/dcs/api-ref/ListConfigurations.html @@ -0,0 +1,289 @@ + + +

Querying DCS Instance Configuration Parameters

+

Function

This API is used to query the configuration parameters of a DCS instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/configs

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

config_time

+

String

+

Time when the instance was operated on. For example, 2017-03-31T12:24:46.297Z.

+

instance_id

+

String

+

Instance ID.

+

redis_config

+

Array of QueryRedisConfig objects

+

Array of configuration items of the DCS instance.

+

config_status

+

String

+

DCS instance status that is being modified or has been modified. Options:

+

  • UPDATING

    +

  • FAILURE

    +

  • SUCCESS

    +
+

Enumeration values:

+

  • UPDATING

    +

  • FAILURE

    +

  • SUCCESS

    +
+

status

+

String

+

Instance status.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 QueryRedisConfig

Parameter

+

Type

+

Description

+

param_value

+

String

+

Configuration parameter value.

+

value_type

+

String

+

Type of the configuration parameter value.

+

value_range

+

String

+

Range of the configuration parameter value.

+

description

+

String

+

Description of the configuration item.

+

default_value

+

String

+

Default value of the configuration parameter.

+

param_name

+

String

+

Configuration parameter name.

+

param_id

+

String

+

Configuration parameter ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs
+
+

Example Responses

Status code: 200

+

Instance configuration parameters queried successfully.

+
{
+  "instance_id" : "50829e5a-a4fc-4c01-8651-80be8a491602",
+  "config_status" : "SUCCESS",
+  "config_time" : "2020-07-06T07:04:31.464Z",
+  "redis_config" : [ {
+    "param_id" : "1",
+    "param_name" : "timeout",
+    "description" : "Close the connection after a client is idle for N seconds (0 to disable)",
+    "param_value" : "101",
+    "value_range" : "0-7200",
+    "value_type" : "Interger",
+    "default_value" : "0"
+  } ],
+  "status" : "RUNNING"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Instance configuration parameters queried successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Parameter Management
+
+
+ diff --git a/docs/dcs/api-ref/ListDiagnosisTasks.html b/docs/dcs/api-ref/ListDiagnosisTasks.html new file mode 100644 index 00000000..e2ada785 --- /dev/null +++ b/docs/dcs/api-ref/ListDiagnosisTasks.html @@ -0,0 +1,300 @@ + + +

Listing Instance Diagnosis Tasks

+

Function

This API is used to query the list of diagnosis tasks of a specific DCS instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/diagnosis

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Number of records displayed on each page. The minimum value is 1. The maximum value is 1000. If this parameter is not specified, 10 records are displayed on each page by default.

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

diagnosis_report_list

+

Array of DiagnosisReportInfo objects

+

Diagnosis reports.

+

total_num

+

Integer

+

Total number of diagnosis reports.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 DiagnosisReportInfo

Parameter

+

Type

+

Description

+

report_id

+

String

+

Diagnosis report ID.

+

status

+

String

+

Diagnosis task status.

+

Enumeration values:

+

  • diagnosing

    +

  • finished

    +
+

begin_time

+

String

+

Start time of a diagnosis period. The format is 2017-03-31T12:24:46.297Z.

+

end_time

+

String

+

End time of a diagnosis period. The format is 2017-03-31T12:24:46.297Z.

+

created_at

+

String

+

Time when the diagnosis report is created.

+

node_num

+

Integer

+

Number of diagnosed nodes.

+

abnormal_item_sum

+

Integer

+

Total number of abnormal diagnosis items.

+

failed_item_sum

+

Integer

+

Total number of failed diagnosis items.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Instance diagnosis reports listed successfully.

+
{
+  "diagnosis_report_list" : [ {
+    "report_id" : "fb98e37a-3cd9-4c7a-96b1-d878266019e2",
+    "status" : "finished",
+    "begin_time" : "2021-04-15T06:02:00.000Z",
+    "end_time" : "2021-04-15T06:12:00.000Z",
+    "created_at" : "2021-04-15T06:12:06.641Z",
+    "abnormal_item_sum" : 2,
+    "failed_item_sum" : 0,
+    "node_num" : 2
+  } ],
+  "total_num" : 1
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Instance diagnosis reports listed successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Diagnosis
+
+
+ diff --git a/docs/dcs/api-ref/ListFlavors.html b/docs/dcs/api-ref/ListFlavors.html new file mode 100644 index 00000000..a97e99af --- /dev/null +++ b/docs/dcs/api-ref/ListFlavors.html @@ -0,0 +1,693 @@ + + +

Querying Product Flavors

+

Function

This API is used to query the product flavor (parameter spec_code) required for configuring a new DCS instance. If no search criterion is specified, all product specifications will be queried by default.

+
+

URI

GET /v2/{project_id}/flavors

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

spec_code

+

No

+

String

+

Product flavor.

+

cache_mode

+

No

+

String

+

DCS instance type. Options:

+

  • single: single-node

    +

  • ha: master/standby

    +

  • cluster: Redis Cluster

    +

  • proxy: Proxy Cluster

    +
+

engine

+

No

+

String

+

Cache engine. Options:

+

  • Redis

    +
+

engine_version

+

No

+

String

+

Cache engine version. If the cache engine is Redis, the options are as follows:

+

  • 3.0

    +

  • 4.0

    +

  • 5.0

    +

  • 6.0

    +
+

cpu_type

+

No

+

String

+

CPU architecture. The options are as follows:

+

  • x86_64: x86 architecture

    +

  • aarch64: Arm architecture

    +
+

Enumeration values:

+

  • x86_64

    +

  • aarch64

    +
+

capacity

+

No

+

String

+

Cache capacity (GB).

+

  • For a single-node or master/standby DCS Redis 3.0 instance, the value can be 2, 4, 8, 16, 32, or 64. For a Proxy Cluster DCS Redis 3.0 instance, the value can be 64, 128, 256, 512, or 1024.

    +

  • Redis 4.0/5.0/6.0: For a single-node or master/standby instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, or 64. For a cluster instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024.

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

flavors

+

Array of FlavorsItems objects

+

Product flavor details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 FlavorsItems

Parameter

+

Type

+

Description

+

spec_code

+

String

+

Product flavor.

+

cloud_service_type_code

+

String

+

Code of the cloud service type.

+

cloud_resource_type_code

+

String

+

Code of the cloud resource type.

+

cache_mode

+

String

+

DCS instance type. Options:

+

  • single: single-node

    +

  • ha: master/standby

    +

  • cluster: Redis Cluster

    +

  • proxy: Proxy Cluster

    +
+

engine

+

String

+

Cache engine.

+

engine_version

+

String

+

Cache engine version. If the cache engine is Redis, the version can be 3.0, 4.0, 5.0, or 6.0.

+

product_type

+

String

+

Edition of DCS for Redis. Value: generic: basic edition

+

cpu_type

+

String

+

CPU architecture. The options are as follows:

+

  • x86_64: x86 architecture

    +

  • aarch64: Arm architecture

    +
+

storage_type

+

String

+

Storage type. Currently, only the following value is supported: DRAM: in-memory storage

+

capacity

+

Array of strings

+

Cache capacity (GB).

+

billing_mode

+

Array of strings

+

Billing mode. The value can be:

+

  • Hourly: pay-per-use

    +
+

tenant_ip_count

+

Integer

+

Number of tenant IP addresses.

+

pricing_type

+

String

+

Pricing type. The options are as follows:

+

  • tier: Tiered pricing. One flavor corresponds to multiple capacity options.

    +

  • normal: One flavor corresponds to one capacity option.

    +
+

is_dec

+

Boolean

+

Whether Dedicated Cloud (DeC) is supported.

+

attrs

+

Array of AttrsObject objects

+

Other information about the flavor.

+

flavors_available_zones

+

Array of FlavorAzObject objects

+

AZs where there are available resources.

+

replica_count

+

Integer

+

Replicas.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 AttrsObject

Parameter

+

Type

+

Description

+

capacity

+

String

+

Cache capacity (GB).

+

name

+

String

+

Additional information items. The options are as follows:

+

  • sharding_num: Number of shards supported by the flavor.

    +

  • proxy_num: Number of proxies supported by Proxy Cluster instances of the specified flavor. If the instance is not a Proxy Cluster instance, the value of this parameter is 0.

    +

  • db_number: Number of DBs of the flavor.

    +

  • max_memory: Maximum available memory.

    +

  • max_connections: Maximum number of connections supported by the flavor.

    +

  • max_clients: Maximum number of clients supported by the flavor, which is usually equal to the maximum number of connections.

    +

  • max_bandwidth: Maximum bandwidth supported by the flavor.

    +

  • max_in_bandwidth: Maximum inbound bandwidth supported by the flavor, which is usually equal to the maximum bandwidth.

    +
+

value

+

String

+

Additional information value.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 FlavorAzObject

Parameter

+

Type

+

Description

+

capacity

+

String

+

Cache capacity (value).

+

unit

+

String

+

Cache capacity (unit).

+

available_zones

+

Array of strings

+

AZ information.

+

az_codes

+

Array of strings

+

AZs where there are available resources.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/flavors?cache_mode={cache_mode}&engine={engine}&engine_version={engine_version}&cpu_type={cpu_type}&capacity={capacity}
+
+

Example Responses

Status code: 200

+

Product flavors queried successfully.

+
{
+  "flavors" : [ {
+    "spec_code" : "redis.single.au1.large.1",
+    "cloud_service_type_code" : "hws.resource.type.dcs3",
+    "cloud_resource_type_code" : "hws.resource.type.dcs3",
+    "cache_mode" : "single",
+    "engine" : "redis",
+    "engine_version" : "4.0;5.0",
+    "product_type" : "generic",
+    "cpu_type" : "aarch64",
+    "storage_type" : "DRAM",
+    "capacity" : [ "1" ],
+    "billing_mode" : [ "Hourly" ],
+    "tenant_ip_count" : 1,
+    "pricing_type" : "normal",
+    "is_dec" : false,
+    "attrs" : [ {
+      "capacity" : "1",
+      "name" : "max_memory",
+      "value" : "1"
+    }, {
+      "capacity" : "1",
+      "name" : "max_connections",
+      "value" : "10000"
+    }, {
+      "capacity" : "1",
+      "name" : "sharding_num",
+      "value" : "1"
+    }, {
+      "capacity" : "1",
+      "name" : "proxy_num",
+      "value" : "0"
+    }, {
+      "capacity" : "1",
+      "name" : "db_number",
+      "value" : "256"
+    }, {
+      "capacity" : "1",
+      "name" : "max_clients",
+      "value" : "10000"
+    }, {
+      "capacity" : "1",
+      "name" : "max_bandwidth",
+      "value" : "80"
+    } ],
+    "flavors_available_zones" : [ {
+      "capacity" : "1",
+      "unit" : "GB",
+      "available_zones" : [ "d539378ec1324c85b76fefa3f7071458" ],
+      "az_codes" : [ "region01" ]
+    } ],
+    "replica_count" : 1
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.1004",
+  "error_msg" : "Project ID does not match the token."
+}
+

Status code: 401

+

Invalid authentication information.

+
{
+  "error_code" : "DCS.1001",
+  "error_msg" : "Invalid token."
+}
+

Status code: 403

+

The request is rejected.

+
{
+  "error_code" : "DCS.2003",
+  "error_msg" : "This role does not have the permission to perform this operation."
+}
+

Status code: 404

+

The requested resource is not found.

+
{
+  "error_code" : "DCS.4001",
+  "error_msg" : "The requested URL does not exist."
+}
+

Status code: 500

+

Internal service error.

+
{
+  "error_code" : "DCS.5000",
+  "error_msg" : "Internal service error."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Product flavors queried successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dcs/api-ref/ListGroupReplicationInfo.html b/docs/dcs/api-ref/ListGroupReplicationInfo.html new file mode 100644 index 00000000..f3679364 --- /dev/null +++ b/docs/dcs/api-ref/ListGroupReplicationInfo.html @@ -0,0 +1,427 @@ + + +

Querying Details of Shards

+

Function

This API is used to query shards and replicas of cluster instances.

+
+

URI

GET /v2/{project_id}/instance/{instance_id}/groups

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

group_list

+

Array of InstanceGroupListInfo objects

+

List of shards.

+

group_count

+

Integer

+

Total number of shards in the instance.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 3 InstanceGroupListInfo

Parameter

+

Type

+

Description

+

group_id

+

String

+

Shard ID.

+

group_name

+

String

+

Shard name.

+

replication_list

+

Array of InstanceReplicationListInfo objects

+

List of replicas in the shard.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 InstanceReplicationListInfo

Parameter

+

Type

+

Description

+

replication_role

+

String

+

Role of the replica. Options:

+

  • master: master

    +

  • slave: replica

    +
+

replication_ip

+

String

+

Replica IP address.

+

is_replication

+

Boolean

+

Whether the replica is a newly added one.

+

replication_id

+

String

+

Replica ID.

+

node_id

+

String

+

Node ID.

+

status

+

String

+

Replica status.

+

Enumeration values:

+

  • Active

    +

  • Inactive

    +
+

az_code

+

String

+

AZ where the replica is in.

+

dimensions

+

Array of InstanceReplicationDimensionsInfo objects

+

Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics.

+

  • Replica monitoring is multi-dimensional. The returned array contains information about two dimensions. When querying monitoring data from Cloud Eye, transfer parameters of multiple dimensions to obtain the metric data.

    +

  • The first dimension is the primary dimension of the replica. The dimension name is dcs_instance_id, and the dimension value corresponds to the ID of the instance to which the replica belongs.

    +

  • The name of the second dimension is dcs_cluster_redis_node, and the dimension value is the ID of the monitored object of the replica, which is different from the replica ID or node ID.

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 5 InstanceReplicationDimensionsInfo

Parameter

+

Type

+

Description

+

name

+

String

+

Monitoring dimension name.

+

value

+

String

+

Dimension value.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups
+
+

Example Responses

Status code: 200

+

Details of shards and replicas queried successfully.

+
{
+  "group_list" : [ {
+    "group_id" : "35e1bed6-7de5-4898-9eb2-c362c783df15",
+    "group_name" : "group-0",
+    "replication_list" : [ {
+      "az_code" : "region01",
+      "is_replication" : false,
+      "node_id" : "8abfa7aa73291f15017329e1cda0002d",
+      "replication_id" : "dfbd3f84-08bc-42f0-b538-01d03e6dc178",
+      "replication_ip" : "192.168.76.25",
+      "replication_role" : "master",
+      "status" : "Active",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6200"
+      } ]
+    }, {
+      "az_code" : "region01",
+      "is_replication" : false,
+      "node_id" : "8abfa7aa73291f15017329e1cdb0002e",
+      "replication_id" : "63d4c880-7050-464f-ab19-c8a297474d7d",
+      "replication_ip" : "192.168.78.207",
+      "replication_role" : "slave",
+      "status" : "Active",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6201"
+      } ]
+    } ]
+  }, {
+    "group_id" : "579a281f-6e63-4822-b0c7-e45c44b7c807",
+    "group_name" : "group-1",
+    "replication_list" : [ {
+      "az_code" : "region01",
+      "is_replication" : false,
+      "node_id" : "8abfa7aa73291f15017329e1cdbd002f",
+      "replication_id" : "6284c192-48d1-462b-8fd9-45dad067c1a2",
+      "replication_ip" : "192.168.73.164",
+      "replication_role" : "master",
+      "status" : "Active",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6202"
+      } ]
+    }, {
+      "az_code" : "region01",
+      "is_replication" : false,
+      "node_id" : "8abfa7aa73291f15017329e1cdc80030",
+      "replication_id" : "b927de3b-42f3-45b5-b0e4-8547f0ef6727",
+      "replication_ip" : "192.168.77.172",
+      "replication_role" : "slave",
+      "status" : "Active",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6203"
+      } ]
+    } ]
+  }, {
+    "group_id" : "c17305c6-6651-42d9-86bf-5a6087076eb7",
+    "group_name" : "group-2",
+    "replication_list" : [ {
+      "az_code" : "region01",
+      "is_replication" : false,
+      "node_id" : "8abfa7aa73291f15017329e1cdd90031",
+      "replication_id" : "caa6636d-a5c1-43b8-990a-3dc134da4522",
+      "replication_ip" : "192.168.76.143",
+      "replication_role" : "master",
+      "status" : "Active",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6204"
+      } ]
+    }, {
+      "az_code" : "region01",
+      "is_replication" : false,
+      "node_id" : "8abfa7aa73291f15017329e1cde50032",
+      "replication_id" : "4f46790d-a0b0-4a1b-aa02-1c554fccf62d",
+      "replication_ip" : "192.168.72.66",
+      "replication_role" : "slave",
+      "status" : "Active",
+      "dimensions" : [ {
+        "name" : "dcs_instance_id",
+        "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94"
+      }, {
+        "name" : "dcs_cluster_redis_node",
+        "value" : "8263dc69629c5b2d840e9816fa9c6205"
+      } ]
+    } ]
+  } ],
+  "group_count" : 3
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Details of shards and replicas queried successfully.

+

500

+

Internal service error.

+

400

+

Invalid request.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Shards and Replicas
+
+
+ diff --git a/docs/dcs/api-ref/ListHotKeyScanTasks.html b/docs/dcs/api-ref/ListHotKeyScanTasks.html new file mode 100644 index 00000000..816c0621 --- /dev/null +++ b/docs/dcs/api-ref/ListHotKeyScanTasks.html @@ -0,0 +1,445 @@ + + +

Listing Hot Key Analysis Tasks

+

Function

This API is used to query the list of hot key analysis tasks.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/hotkey-tasks

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

status

+

No

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+

count

+

Integer

+

Number of times that hot keys are analyzed.

+

records

+

Array of RecordsResponse objects

+

List of hot key analysis record.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RecordsResponse

Parameter

+

Type

+

Description

+

id

+

String

+

Task execution record ID. (This ID corresponds to the task ID in the parameter for querying big key or hot key analysis details.)

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z.

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-tasks
+
+

Example Responses

Status code: 200

+

Hot key analysis tasks listed successfully.

+
{
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "count" : 1,
+  "records" : [ {
+    "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+    "scan_type" : "manual",
+    "status" : "success",
+    "created_at" : "2020-06-15T02:21:18.669Z",
+    "started_at" : "2020-06-15T02:21:23.534Z",
+    "finished_at" : "2020-06-15T02:21:25.588Z"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4922",
+  "error_msg" : "Does not support hotkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Hot key analysis tasks listed successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/ListInstances.html b/docs/dcs/api-ref/ListInstances.html new file mode 100644 index 00000000..f51e842a --- /dev/null +++ b/docs/dcs/api-ref/ListInstances.html @@ -0,0 +1,813 @@ + + +

Querying All DCS Instances

+

Function

This API is used to query DCS instances of a tenant, and allows you to specify query criteria.

+
+

URI

GET /v2/{project_id}/instances

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

No

+

String

+

Instance ID.

+

include_failure

+

No

+

String

+

Whether to return the number of instances that fail to be created. If the value is true, the number of instances that failed to be created is returned. If the value is not true, the number is not returned.

+

include_delete

+

No

+

String

+

Whether to return the number of instances that have been deleted. If the value is true, the number of instances that have been deleted is returned. If the value is not true, the number is not returned.

+

name

+

No

+

String

+

Instance name.

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of records displayed on each page. The minimum value is 1. The maximum value is 1000. If this parameter is not specified, 10 records are displayed on each page by default.

+

status

+

No

+

String

+

Instance status. For details, see DCS Instance Statuses.

+

name_equal

+

No

+

String

+

Whether to search for the instance that precisely matches a specified instance name.

+

The default value is false, indicating that a fuzzy search is performed based on a specified instance name. If the value is true, the instance that precisely matches a specified instance name is queried.

+

tags

+

No

+

String

+

The query is based on the instance tag key and value. {key} indicates the tag key, and {value} indicates the tag value.

+

To query instances with multiple tag keys and values, separate key-value pairs with commas (,).

+

ip

+

No

+

String

+

IP address for connecting to the DCS instance.

+

capacity

+

No

+

String

+

DCS instance cache capacity in GB.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_num

+

Integer

+

Number of instances.

+

instances

+

Array of InstanceListInfo objects

+

Instance details array.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 InstanceListInfo

Parameter

+

Type

+

Description

+

publicip_id

+

String

+

ID of the EIP bound to the DCS Redis instance. This parameter is reserved. The value is null.

+

vpc_name

+

String

+

VPC name.

+

charging_mode

+

Integer

+

Billing mode. The value can be 0: pay-per-use.

+

vpc_id

+

String

+

VPC ID.

+

subnet_id

+

String

+

Subnet ID.

+

security_group_id

+

String

+

Security group ID.

+

created_at

+

String

+

Creation time. Format: 2017-03-31T12:24:46.297Z

+

updated_at

+

String

+

Update time. Format: 2017-03-31T19:24:46.297Z.

+

enable_ssl

+

Boolean

+

This parameter is reserved.

+

max_memory

+

Integer

+

Total memory size in MB.

+

used_memory

+

Integer

+

Used memory size in MB.

+

publicip_address

+

String

+

EIP bound to the DCS Redis instance. This parameter is reserved. The value is null.

+

capacity

+

Integer

+

Cache capacity (GB)

+

capacity_minor

+

String

+

Capacity (GB) of a small DCS instance (smaller than 1 GB).

+

order_id

+

String

+

Order ID. The value is null when a pay-per-use instance is created.

+

maintain_begin

+

String

+

UTC time when the maintenance time window starts. The format is HH:mm:ss.

+

maintain_end

+

String

+

UTC time when the maintenance time window ends. The format is HH:mm:ss.

+

engine

+

String

+

Cache engine.

+

engine_version

+

String

+

Cache version.

+

service_upgrade

+

Boolean

+

Whether the instance has an upgrade task.

+

  • true: yes

    +

  • false: no

    +
+

no_password_access

+

String

+

Indicates whether the instance can be accessed without a password.

+

  • true: The instance can be accessed without a password.

    +

  • false: The instance can be accessed only after password authentication.

    +
+

service_task_id

+

String

+

Upgrade task ID.

+

  • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.

    +

  • If the value of service_upgrade is set to false, the value of this parameter is empty.

    +
+

ip

+

String

+

IP address for connecting to the DCS instance. For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.

+

access_user

+

String

+

Username used for accessing a DCS instance after password authentication.

+

instance_id

+

String

+

Instance ID.

+

enable_publicip

+

Boolean

+

This parameter is reserved.

+

port

+

Integer

+

Port of the DCS instance.

+

user_id

+

String

+

User ID.

+

user_name

+

String

+

Username.

+

domain_name

+

String

+

Domain name of the instance.

+

readonly_domain_name

+

String

+

Read-only domain name of the instance. This parameter is available only for master/standby instances.

+

name

+

String

+

Instance name.

+

spec_code

+

String

+

Product flavor.

+

status

+

String

+

Instance status. For details, see DCS Instance Statuses.

+

tags

+

Array of ResourceTag objects

+

Instance tag key and value.

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

description

+

String

+

Description about the instance.

+

cpu_type

+

String

+

CPU type of the instance. Generally, the value is x86_64 or aarch64.

+

az_codes

+

Array of strings

+

AZs where there are available resources.

+

features

+

Features object

+

Features supported by the instance.

+

sub_status

+

String

+

Instance sub-status.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

  • Must be specified.

    +

  • Must be unique for each resource.

    +

  • Can contain a maximum of 36 characters.

    +

  • Must be unique and cannot be empty.

    +
+

value

+

String

+

Tag value.

+

  • This parameter is mandatory when action is set to create and is optional when action is set to delete.

    +

  • It can contain a maximum of 43 characters.

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 Features

Parameter

+

Type

+

Description

+

support_acl

+

Boolean

+

Whether ACL is supported.

+

  • true: Yes

    +

  • false: No

    +
+

support_transparent_client_ip

+

Boolean

+

Whether client IP pass-through is enabled.

+

  • true: Yes

    +

  • false: No

    +
+

support_ssl

+

Boolean

+

Whether SSL is supported.

+

  • true: Yes

    +

  • false: No

    +
+

support_audit_log

+

Boolean

+

Whether audit logs are supported

+

  • true: Yes

    +

  • false: No

    +
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances?offset=0&limit=10&name={name}&status={status}&id={id}&include_failure=true&include_delete=true&name_equal=false
+
+

Example Responses

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4800",
+  "error_msg" : "Invalid offset in the request."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

All instances are listed successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dcs/api-ref/ListMaintenanceWindows.html b/docs/dcs/api-ref/ListMaintenanceWindows.html new file mode 100644 index 00000000..37cf3795 --- /dev/null +++ b/docs/dcs/api-ref/ListMaintenanceWindows.html @@ -0,0 +1,265 @@ + + +

Listing Maintenance Time Windows

+

Function

This API is used to query the start time and end time of maintenance windows.

+
+

URI

GET /v2/instances/maintain-windows

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 1 Response body parameters

Parameter

+

Type

+

Description

+

maintain_windows

+

Array of MaintainWindowsEntity objects

+

List of supported maintenance time windows.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 MaintainWindowsEntity

Parameter

+

Type

+

Description

+

seq

+

Integer

+

Sequence number of the maintenance time window.

+

default

+

Boolean

+

Whether a maintenance time window is set to the default time segment.

+

begin

+

String

+

UTC time when the maintenance time window starts. The format is HH:mm:ss.

+

end

+

String

+

UTC time when the maintenance time window ends. The format is HH:mm:ss.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/instances/maintain-windows
+
+

Example Responses

Status code: 200

+

Maintenance time windows queried successfully.

+
{
+  "maintain_windows" : [ {
+    "default" : true,
+    "end" : "19",
+    "begin" : "18",
+    "seq" : 1
+  }, {
+    "default" : false,
+    "end" : "20",
+    "begin" : "19",
+    "seq" : 2
+  }, {
+    "default" : false,
+    "end" : "21",
+    "begin" : "20",
+    "seq" : 3
+  }, {
+    "default" : false,
+    "end" : "22",
+    "begin" : "21",
+    "seq" : 4
+  }, {
+    "default" : false,
+    "end" : "23",
+    "begin" : "22",
+    "seq" : 5
+  }, {
+    "default" : false,
+    "end" : "00",
+    "begin" : "23",
+    "seq" : 6
+  }, {
+    "default" : false,
+    "end" : "01",
+    "begin" : "00",
+    "seq" : 1
+  }, {
+    "default" : false,
+    "end" : "02",
+    "begin" : "01",
+    "seq" : 2
+  }, {
+    "default" : false,
+    "end" : "03",
+    "begin" : "02",
+    "seq" : 3
+  }, {
+    "default" : false,
+    "end" : "04",
+    "begin" : "03",
+    "seq" : 3
+  }, {
+    "default" : false,
+    "end" : "05",
+    "begin" : "04",
+    "seq" : 4
+  }, {
+    "default" : false,
+    "end" : "06",
+    "begin" : "05",
+    "seq" : 5
+  }, {
+    "default" : false,
+    "end" : "07",
+    "begin" : "06",
+    "seq" : 6
+  }, {
+    "default" : false,
+    "end" : "08",
+    "begin" : "07",
+    "seq" : 1
+  }, {
+    "default" : true,
+    "end" : "09",
+    "begin" : "08",
+    "seq" : 2
+  }, {
+    "default" : false,
+    "end" : "10",
+    "begin" : "09",
+    "seq" : 3
+  }, {
+    "default" : false,
+    "end" : "11",
+    "begin" : "10",
+    "seq" : 4
+  }, {
+    "default" : false,
+    "end" : "12",
+    "begin" : "11",
+    "seq" : 5
+  }, {
+    "default" : false,
+    "end" : "13",
+    "begin" : "12",
+    "seq" : 6
+  }, {
+    "default" : false,
+    "end" : "14",
+    "begin" : "13",
+    "seq" : 1
+  }, {
+    "default" : true,
+    "end" : "15",
+    "begin" : "14",
+    "seq" : 2
+  }, {
+    "default" : false,
+    "end" : "16",
+    "begin" : "15",
+    "seq" : 3
+  }, {
+    "default" : false,
+    "end" : "17",
+    "begin" : "16",
+    "seq" : 4
+  }, {
+    "default" : false,
+    "end" : "18",
+    "begin" : "17",
+    "seq" : 5
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Maintenance time windows queried successfully.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dcs/api-ref/ListMigrationTask.html b/docs/dcs/api-ref/ListMigrationTask.html new file mode 100644 index 00000000..387a4ffa --- /dev/null +++ b/docs/dcs/api-ref/ListMigrationTask.html @@ -0,0 +1,572 @@ + + +

Listing Migration Tasks

+

Function

This API is used to query the migration task list.

+
+

URI

GET /v2/{project_id}/migration-tasks

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

name

+

No

+

String

+

Name of the migration task.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

count

+

Integer

+

Number of migration tasks.

+

migration_tasks

+

Array of MigrationTaskList objects

+

Migration task list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 MigrationTaskList

Parameter

+

Type

+

Description

+

task_id

+

String

+

Migration task ID.

+

task_name

+

String

+

Migration task name.

+

status

+

String

+

Migration status. Options: SUCCESS, FAILED, MIGRATING, TERMINATED.

+

Enumeration values:

+

  • SUCCESS

    +

  • FAILED

    +

  • MIGRATING

    +

  • TERMINATED

    +
+

migration_type

+

String

+

Migration mode, which can be backup file import or online migration.

+

Enumeration values:

+

  • backupfile_import

    +

  • online_migration

    +
+

migration_method

+

String

+

Type of the migration, which can be full migration or incremental migration.

+

Enumeration values:

+

  • full_amount_migration

    +

  • incremental_migration

    +
+

ecs_tenant_private_ip

+

String

+

Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis.

+

data_source

+

String

+

Source Redis address, which is ip:port or a bucket name.

+

source_instance_name

+

String

+

Name of the source instance. If the source Redis is self-hosted, this parameter is left blank.

+

source_instance_id

+

String

+

ID of the source instance. If the source Redis is self-hosted, this parameter is left blank.

+

target_instance_addrs

+

String

+

Target Redis address. The format is ip:port.

+

target_instance_name

+

String

+

Target instance name.

+

target_instance_id

+

String

+

Target instance ID.

+

created_at

+

String

+

Time when the migration task is created.

+

description

+

String

+

Description of the migration task.

+

source_instance_status

+

String

+

Status of the source instance. If the source Redis is self-hosted, this parameter is left blank.

+

target_instance_status

+

String

+

Status of the target instance.

+

source_instance_subnet_id

+

String

+

ID of the source instance subnet. If the source Redis is self-hosted, this parameter is left blank.

+

target_instance_subnet_id

+

String

+

ID of the target instance subnet.

+

source_instance_spec_code

+

String

+

Specification code of the source instance. If the source Redis is self-hosted, this parameter is left blank.

+

target_instance_spec_code

+

String

+

Specification code of the target instance.

+

error_message

+

String

+

Error message.

+

released_at

+

String

+

Time when the migration ECS is released.

+

version

+

String

+

Version.

+

resume_mode

+

String

+

Operation mode, which can be auto or manual.

+

supported_features

+

Array of strings

+

Supported features.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks?offset=0&limit=10&name=dcs-migration-i9qk
+
+

Example Responses

Status code: 200

+

Querying the migration task list.

+
  • {
+  "count" : 1,
+  "migration_tasks" : [ {
+    "task_id" : "2944a563-6f27-4604-9c16-a9a53cd95cc7",
+    "task_name" : "dcs-migration-test-6-16",
+    "status" : "TERMINATED",
+    "migration_type" : "online_migration",
+    "migration_method" : "incremental_migration",
+    "data_source" : "192.168.0.200:6379",
+    "source_instance_name" : "migration-resource",
+    "source_instance_id" : "132e0017-715b-4556-930a-95c7db7e8f7a",
+    "target_instance_addrs" : "192.168.0.153:6379",
+    "target_instance_name" : "migration-target",
+    "target_instance_id" : "eb1a8d1c-9ea6-4fcd-ac43-c3d3c2493f06",
+    "created_at" : "2021-06-16T06:12:55.508Z",
+    "description" : "dcs-test",
+    "source_instance_status" : "RUNNING",
+    "target_instance_status" : "RUNNING",
+    "source_instance_subnet_id" : "192.168.0.1",
+    "target_instance_subnet_id" : "192.168.0.2",
+    "source_instance_spec_code" : "redis.single.xu1.tiny.128",
+    "target_instance_spec_code" : "redis.single.xu1.tiny.128",
+    "error_message" : null,
+    "released_at" : "202404011057",
+    "version" : "6.0.21",
+    "resume_mode" : "auto",
+    "supported_features" : [ ]
+  } ]
+}
    +
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Querying the migration task list.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Data Migration
+
+
+ diff --git a/docs/dcs/api-ref/ListMonitoredObjects.html b/docs/dcs/api-ref/ListMonitoredObjects.html new file mode 100644 index 00000000..bbf52968 --- /dev/null +++ b/docs/dcs/api-ref/ListMonitoredObjects.html @@ -0,0 +1,275 @@ + + +

Listing Monitored Objects on Primary Dimensions

+

Function

This API is used to query the monitored objects on the primary dimension dcs_instance_id.

+
+

URI

GET /v2/{project_id}/dims/monitored-objects

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Tenant ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

dim_name

+

Yes

+

String

+

Primary dimension ID, which can be dcs_instance_id.

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+

Default: 0

+

limit

+

No

+

Integer

+

Number of items displayed per page.

+

Default: 10

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

router

+

Array of strings

+

Route of the specified dimension. If the dimension is the primary dimension, the array contains the ID of the primary dimension.

+

children

+

Array of DimChild objects

+

Secondary dimensions under the specified dimension. This parameter is valid only when the dimension is dcs_instance_id.

+

  • The secondary dimension of a Proxy Cluster instance can be dcs_cluster_redis_node or dcs_cluster_proxy_node.

    +

  • The secondary dimension of a Redis Cluster instance can be dcs_cluster_proxy_node.

    +
+

instances

+

Array of InstancesMonitoredObject objects

+

Monitored objects of the specified dimension.

+

total

+

Integer

+

Total number of monitored objects on the primary dimension.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 DimChild

Parameter

+

Type

+

Description

+

dim_name

+

String

+

Dimension name. The value can be dcs_instance_id, dcs_cluster_redis_node, or dcs_cluster_proxy_node.

+

dim_route

+

String

+

Dimension route. Format: Dimension name,Sub-dimension name. For example, if dim_name is dcs_cluster_redis_node, the value of dim_route is dcs_instance_id,dcs_cluster_redis_node.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 InstancesMonitoredObject

Parameter

+

Type

+

Description

+

dcs_instance_id

+

String

+

ID of the monitored object, which is the instance ID.

+

name

+

String

+

Name of the monitored object, which is the instance name.

+

status

+

String

+

Status of the monitored object, which is the instance status.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}}/v2/{project_id}}/dims/monitored-objects?dim_name={dim_name}
+
+

Example Responses

Status code: 200

+

Successfully listed the monitored objects on the primary dimension.

+
{
+  "router" : [ "dcs_instance_id" ],
+  "total" : 3,
+  "children" : [ {
+    "dim_name" : "dcs_cluster_redis_node",
+    "dim_route" : "dcs_instance_id,dcs_cluster_redis_node"
+  }, {
+    "dim_name" : "dcs_cluster_proxy_node",
+    "dim_route" : "dcs_instance_id,dcs_cluster_proxy_node"
+  } ],
+  "instances" : [ {
+    "name" : "dcs-redis-single-node",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "fe909c47-8990-44a0-9154-d0a1e95e78fe"
+  }, {
+    "name" : "dcs-redis-master-standby",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "877e5ae3-482e-4c38-88a0-030a0fa6f399"
+  }, {
+    "name" : "dcs-proxy-cluster",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "448ee851-1366-47f2-913a-e21032e690c4"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Successfully listed the monitored objects on the primary dimension.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dcs/api-ref/ListMonitoredObjectsOfInstance.html b/docs/dcs/api-ref/ListMonitoredObjectsOfInstance.html new file mode 100644 index 00000000..54210331 --- /dev/null +++ b/docs/dcs/api-ref/ListMonitoredObjectsOfInstance.html @@ -0,0 +1,425 @@ + + +

Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension

+

Function

This API is used to query the monitored objects on secondary dimensions under primary dimension dcs_instance_id.

+
+

URI

GET /v2/{project_id}/dims/monitored-objects/{instance_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Tenant ID.

+

instance_id

+

Yes

+

String

+

ID of the monitored object on the primary dimension, which is the instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

dim_name

+

Yes

+

String

+

ID of the primary dimension, which can be dcs_instance_id.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

router

+

Array of strings

+

Route of the specified dimension. If the dimension is the primary dimension, the array contains the ID of the primary dimension.

+

children

+

Array of DimChild objects

+

Secondary dimensions under the specified dimension. This parameter is valid only when the dimension is dcs_instance_id.

+

  • The secondary dimension of a Proxy Cluster instance can be dcs_cluster_redis_node or dcs_cluster_proxy_node.

    +

  • The secondary dimension of a Redis Cluster instance can be dcs_cluster_proxy_node.

    +
+

instances

+

Array of InstancesMonitoredObject objects

+

Monitored objects of the specified dimension.

+

dcs_cluster_redis_node

+

Array of ClusterRedisNodeMonitoredObject objects

+

Monitored objects of the Redis Server. This parameter is valid for Proxy Cluster and Redis Cluster instances. The field name is the same as the secondary dimension object name under children.

+

dcs_cluster_proxy_node

+

Array of ProxyNodeMonitoredObject objects

+

Monitored objects of proxies. This parameter is valid only for Proxy Cluster DCS Redis 3.0 instances. The field name is the same as the secondary dimension object name under children.

+

dcs_cluster_proxy2_node

+

Array of Proxy2NodeMonitoredObject objects

+

Monitored objects of the Proxy. This parameter is valid only for Redis 4.0 and 5.0 Proxy Cluster instances. The field name is the same as the secondary dimension object name under children.

+

total

+

Integer

+

Total number of monitored objects on the primary dimension.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 DimChild

Parameter

+

Type

+

Description

+

dim_name

+

String

+

Dimension name. The value can be dcs_instance_id, dcs_cluster_redis_node, or dcs_cluster_proxy_node.

+

dim_route

+

String

+

Dimension route. Format: Dimension name,Sub-dimension name. For example, if dim_name is dcs_cluster_redis_node, the value of dim_route is dcs_instance_id,dcs_cluster_redis_node.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 InstancesMonitoredObject

Parameter

+

Type

+

Description

+

dcs_instance_id

+

String

+

ID of the monitored object, which is the instance ID.

+

name

+

String

+

Name of the monitored object, which is the instance name.

+

status

+

String

+

Status of the monitored object, which is the instance status.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 ClusterRedisNodeMonitoredObject

Parameter

+

Type

+

Description

+

dcs_instance_id

+

String

+

ID of the monitored object, which is the node ID.

+

name

+

String

+

Name of the monitored object, which is the node IP address.

+

dcs_cluster_redis_node

+

String

+

ID of the monitored object on the dcs_cluster_redis_node dimension.

+

status

+

String

+

Status of the monitored object, which is the node status.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 ProxyNodeMonitoredObject

Parameter

+

Type

+

Description

+

dcs_instance_id

+

String

+

ID of the monitored object, which is the node ID.

+

name

+

String

+

Name of the monitored object, which is the node IP address.

+

dcs_cluster_proxy_node

+

String

+

ID of the monitored object on the dcs_cluster_proxy_node dimension.

+

status

+

String

+

Status of the monitored object, which is the node status.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 8 Proxy2NodeMonitoredObject

Parameter

+

Type

+

Description

+

dcs_instance_id

+

String

+

ID of the monitored object, which is the node ID.

+

name

+

String

+

Name of the monitored object, which is the node IP address.

+

dcs_cluster_proxy2_node

+

String

+

ID of the monitored object on the dcs_cluster_proxy2_node dimension.

+

status

+

String

+

Status of the monitored object, which is the node status.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/dims/monitored-objects/{instance_id}?dim_name={dim_name}
+
+

Example Responses

Status code: 200

+

Successfully queried the monitored objects on the primary dimension.

+
{
+  "router" : [ "dcs_instance_id" ],
+  "total" : 1,
+  "children" : [ {
+    "dim_name" : "dcs_cluster_redis_node",
+    "dim_route" : "dcs_instance_id,dcs_cluster_redis_node"
+  } ],
+  "instances" : [ {
+    "name" : "dcs-test001",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19"
+  } ],
+  "dcs_cluster_redis_node" : [ {
+    "name" : "(master)192.168.2.145",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
+    "dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108"
+  }, {
+    "name" : "(replica)192.168.2.199",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
+    "dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc"
+  }, {
+    "name" : "(master)192.168.2.243",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
+    "dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517"
+  }, {
+    "name" : "(replica)192.168.2.164",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
+    "dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43"
+  }, {
+    "name" : "(master)192.168.2.95",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
+    "dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f"
+  }, {
+    "name" : "(replica)192.168.2.51",
+    "status" : "RUNNING",
+    "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19",
+    "dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Successfully queried the monitored objects on the primary dimension.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dcs/api-ref/ListRedislog.html b/docs/dcs/api-ref/ListRedislog.html new file mode 100644 index 00000000..4aefcf14 --- /dev/null +++ b/docs/dcs/api-ref/ListRedislog.html @@ -0,0 +1,434 @@ + + +

Listing Redis Run Logs

+

Function

This API is used to query the Redis run logs.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/redislog

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be no less than 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

log_type

+

Yes

+

String

+

Log type. Currently, only Redis run logs are supported. The value is run.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total_num

+

Integer

+

Total.

+

file_list

+

Array of RunlogItem objects

+

Run log list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RunlogItem

Parameter

+

Type

+

Description

+

id

+

String

+

Unique ID of a run log.

+

file_name

+

String

+

Run log file name.

+

group_name

+

String

+

Shard name.

+

replication_ip

+

String

+

IP address of the replica where the run logs are collected.

+

status

+

String

+

Run log status.

+

time

+

String

+

Date when run logs are collected. The format is yyyy-MM-dd.

+

backup_id

+

String

+

Log file ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/redislog?log_type=run&offset=1&limit=10
+
+

Example Responses

Status code: 200

+

Run logs queried successfully. If there is no log, 204 is returned.

+
{
+  "total_num" : 1,
+  "file_list" : [ {
+    "id" : "e79f2d97-e972-41f2-b51c-d18f65f39a45",
+    "file_name" : "redis_192.168.0.142_2021-04-16.log",
+    "status" : "succeed",
+    "time" : "2021-04-16",
+    "replication_ip" : "192.168.0.142",
+    "group_name" : "group-0",
+    "backup_id" : "e79f2d97-e972-41f2-b51c-d18f65f39a45"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4800",
+  "error_msg" : "Invalid logType."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Run logs queried successfully. If there is no log, 204 is returned.

+

204

+

Queried successfully and no log is found.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dcs/api-ref/ListRestoreRecords.html b/docs/dcs/api-ref/ListRestoreRecords.html new file mode 100644 index 00000000..ef9b8475 --- /dev/null +++ b/docs/dcs/api-ref/ListRestoreRecords.html @@ -0,0 +1,321 @@ + + +

Querying DCS Instance Restoration Records

+

Function

This API is used to query the restoration records of a specific DCS instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/restores

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

begin_time

+

No

+

String

+

Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

+

end_time

+

No

+

String

+

End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

restore_record_response

+

Array of InstanceRestoreInfo objects

+

Array of the restoration records.

+

total_num

+

Integer

+

Total number.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 InstanceRestoreInfo

Parameter

+

Type

+

Description

+

backup_id

+

String

+

Backup ID.

+

restore_id

+

String

+

ID of the restoration record.

+

backup_name

+

String

+

Backup record name.

+

updated_at

+

String

+

Time when the restoration completed.

+

restore_remark

+

String

+

Description of the restoration.

+

created_at

+

String

+

Time when the restoration task was created.

+

progress

+

String

+

Restoration progress.

+

error_code

+

String

+

Error code displayed for a restoration failure.

+

  • dcs.08.0001 - Failed to start the backup and restoration tool.

    +

  • dcs.08.0002 - Execution timed out.

    +

  • dcs.08.0003 - Failed to delete the bucket.

    +

  • dcs.08.0004 - Failed to obtain the AK/SK.

    +

  • dcs.08.0005 - Failed to create a bucket.

    +

  • dcs.08.0006 - Failed to query the backup data size.

    +

  • dcs.08.0007 - Failed to synchronize data during restoration.

    +

  • dcs.08.0008 - The scheduled backup task is not running. The instance is running other tasks.

    +
+

restore_name

+

String

+

Name of a restoration record.

+

backup_remark

+

String

+

Description of the backup.

+

status

+

String

+

Restoration status.

+

  • waiting: The task is waiting to begin.

    +

  • restoring: The restoration is in progress.

    +

  • succeed: The restoration is successful.

    +

  • failed: The restoration failed.

    +
+

Enumeration values:

+

  • waiting

    +

  • restoring

    +

  • succeed

    +

  • failed

    +
+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/restores?offset={offset}&limit={limit}&begin_Time={begin_Time}&end_Time={end_Time}
+
+

Example Responses

Status code: 200

+

DCS instance restoration records queried successfully.

+
{
+  "restore_record_response" : [ {
+    "backup_id" : "f4823e9e-fe9b-4ffd-be79-4e5d6de272bb",
+    "restore_id" : "a6155972-800c-4170-a479-3231e907d2f6",
+    "backup_name" : "backup_20170718000002",
+    "updated_at" : "2017-07-18T21:41:35.182Z",
+    "restore_remark" : "doctest",
+    "created_at" : "2017-07-18T21:41:20.721Z",
+    "progress" : "100.00",
+    "error_code" : { },
+    "restore_name" : "restore_20170718214120",
+    "backup_remark" : { },
+    "status" : "succeed"
+  } ],
+  "total_num" : 1
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

DCS instance restoration records queried successfully.

+

204

+

No instance restoration record found.

+

400

+

Invalid request.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Backup and Restoration
+
+
+ diff --git a/docs/dcs/api-ref/ListSlowlog.html b/docs/dcs/api-ref/ListSlowlog.html new file mode 100644 index 00000000..e88f556f --- /dev/null +++ b/docs/dcs/api-ref/ListSlowlog.html @@ -0,0 +1,472 @@ + + +

Querying the Slow Log

+

Function

This API is used to query slow logs.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/slowlog

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

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

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Offset, which is the position where the query starts. The value must be no less than 0.

+

limit

+

No

+

Integer

+

Number of items displayed on each page.

+

sort_key

+

No

+

String

+

Specifies the keyword based on which the return results are sorted. The value can be start_time or duration. The default value is start_time.

+

Enumeration values:

+

  • start_time

    +

  • duration

    +
+

sort_dir

+

No

+

String

+

Result sorting order. The value can be desc (descending order) or asc (ascending order). The default value is desc.

+

Enumeration values:

+

  • desc

    +

  • asc

    +
+

start_time

+

Yes

+

String

+

Query start time (UTC). Example: 1598803200000.

+

end_time

+

Yes

+

String

+

Query end time (UTC). Example: 1599494399000.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

total_num

+

Integer

+

Total number of slow logs.

+

count

+

Integer

+

Total.

+

slowlogs

+

Array of SlowlogItem objects

+

Slow log list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 SlowlogItem

Parameter

+

Type

+

Description

+

id

+

Integer

+

Unique ID of a slow log.

+

command

+

String

+

Slow command.

+

start_time

+

String

+

Execution start time. Example: 2020-06-19T07:06:07Z.

+

duration

+

String

+

Duration, in ms.

+

shard_name

+

String

+

Name of the shard where the slow command is executed. This parameter is supported only when the instance type is cluster.

+

database_id

+

Integer

+

Database ID, which is available only to some customers.

+

username

+

String

+

Account name that can operate slow logs. This parameter is available only to designated customers.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/slowlog?start_time=1598803200000&end_time=1599494399000
+
+

Example Responses

Status code: 200

+

Slow logs queried successfully.

+
{
+  "total_num" : 1,
+  "count" : 1,
+  "slowlogs" : [ {
+    "id" : 1,
+    "start_time" : "2020-06-19T07:06:07Z",
+    "command" : "SLOWLOG GET 128",
+    "duration" : "17",
+    "shard_name" : "group-0",
+    "database_id" : 1,
+    "username" : "default"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4800",
+  "error_msg" : "Invalid start_time in the request."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Slow logs queried successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/dcs/api-ref/ListStatisticsOfRunningInstances.html b/docs/dcs/api-ref/ListStatisticsOfRunningInstances.html new file mode 100644 index 00000000..3c67b13c --- /dev/null +++ b/docs/dcs/api-ref/ListStatisticsOfRunningInstances.html @@ -0,0 +1,285 @@ + + +

Querying Statistics of All Running Instances

+

Function

This API is used to query the statistics of all DCS instances that are in the Running state.

+
+

URI

GET /v2/{project_id}/instances/statistic

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

statistics

+

Array of InstanceStatistic objects

+

Statistics of all instances in the Running state.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 InstanceStatistic

Parameter

+

Type

+

Description

+

input_kbps

+

String

+

Incoming traffic (kbit/s) of the DCS instance.

+

output_kbps

+

String

+

Outgoing traffic (kbit/s) of the DCS instance.

+

instance_id

+

String

+

Instance ID.

+

keys

+

Long

+

Number of cached data records

+

used_memory

+

Long

+

Used memory size in MB.

+

max_memory

+

Long

+

Total memory size in MB.

+

cmd_get_count

+

Long

+

Number of times the GET command is run.

+

cmd_set_count

+

Long

+

Number of times the SET command is run.

+

used_cpu

+

String

+

Accumulated CPU time consumed by the cache in the user state and kernel state, in seconds.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/statistic
+
+

Example Responses

Status code: 200

+

Instance statistics queried successfully.

+
{
+  "statistics" : [ {
+    "output_kbps" : "0.0",
+    "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a",
+    "keys" : 0,
+    "used_memory" : 0,
+    "cmd_get_count" : 0,
+    "used_cpu" : "0.0",
+    "cmd_set_count" : 0,
+    "input_kbps" : "0.0",
+    "max_memory" : 460
+  }, {
+    "output_kbps" : "0.0",
+    "instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac",
+    "keys" : 0,
+    "used_memory" : 0,
+    "cmd_get_count" : 0,
+    "used_cpu" : "0.0",
+    "cmd_set_count" : 0,
+    "input_kbps" : "0.0",
+    "max_memory" : 460
+  }, {
+    "output_kbps" : "1.19",
+    "instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207",
+    "keys" : 0,
+    "used_memory" : 0,
+    "cmd_get_count" : 0,
+    "used_cpu" : "0.0",
+    "cmd_set_count" : 0,
+    "input_kbps" : "0.03",
+    "max_memory" : 460
+  }, {
+    "output_kbps" : "0.0",
+    "instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba",
+    "keys" : 0,
+    "used_memory" : 0,
+    "cmd_get_count" : 0,
+    "used_cpu" : "0.0",
+    "cmd_set_count" : 0,
+    "input_kbps" : "0.0",
+    "max_memory" : 6963
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Instance statistics queried successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dcs/api-ref/ListTagsOfTenant.html b/docs/dcs/api-ref/ListTagsOfTenant.html new file mode 100644 index 00000000..136db7f0 --- /dev/null +++ b/docs/dcs/api-ref/ListTagsOfTenant.html @@ -0,0 +1,202 @@ + + +

Listing All Tags of a Tenant

+

Function

This API is used to query the tags of all resources owned by a tenant in a specific project.

+
+

URI

GET /v2/{project_id}/dcs/tags

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

tags

+

Array of Tag objects

+

Tag list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 Tag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. The key contains a maximum of 128 characters.

+

values

+

Array of strings

+

Tag value.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

POST https://{dcs_endpoint}/v2/{project_id}/dcs/tags
+
+

Example Responses

Status code: 200

+

Successfully queried all tags of the tenant.

+
{
+  "tags" : [ {
+    "values" : [ "value1", "value2" ],
+    "key" : "1"
+  }, {
+    "values" : [ "value1", "value2" ],
+    "key" : "2"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Successfully queried all tags of the tenant.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/dcs/api-ref/LogManagement.html b/docs/dcs/api-ref/LogManagement.html new file mode 100644 index 00000000..32725ba7 --- /dev/null +++ b/docs/dcs/api-ref/LogManagement.html @@ -0,0 +1,22 @@ + + +

Log Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/NetworkSecurityManagement.html b/docs/dcs/api-ref/NetworkSecurityManagement.html new file mode 100644 index 00000000..faf22308 --- /dev/null +++ b/docs/dcs/api-ref/NetworkSecurityManagement.html @@ -0,0 +1,24 @@ + + +

Network Security

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/OtherInterface.html b/docs/dcs/api-ref/OtherInterface.html new file mode 100644 index 00000000..d996af68 --- /dev/null +++ b/docs/dcs/api-ref/OtherInterface.html @@ -0,0 +1,26 @@ + + +

Other APIs

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/ParamManagement.html b/docs/dcs/api-ref/ParamManagement.html new file mode 100644 index 00000000..a35d0166 --- /dev/null +++ b/docs/dcs/api-ref/ParamManagement.html @@ -0,0 +1,20 @@ + + +

Parameter Management

+

+
+
+ + +
+
Parent topic: APIs V2 (Recommended)
+
+
+ diff --git a/docs/dcs/api-ref/ResizeInstance.html b/docs/dcs/api-ref/ResizeInstance.html new file mode 100644 index 00000000..f6bba7c7 --- /dev/null +++ b/docs/dcs/api-ref/ResizeInstance.html @@ -0,0 +1,211 @@ + + +

Modifying Instance Specifications

+

Function

This API is used to modify specifications of a DCS instance in the Running state.

+
+

URI

POST /v2/{project_id}/instances/{instance_id}/resize

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

spec_code

+

Yes

+

String

+

Flavor after the modification. The query method is as follows:

+ +

new_capacity

+

Yes

+

Integer

+

New memory size of the DCS instance, in GB. For a single-node or master/standby DCS Redis 4.0, 5.0, or 6.0 instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, or 64. For a cluster instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or **1024.

+

Currently, the specifications of a Proxy Cluster DCS Redis 3.0 instance cannot be reduced. In addition to integers, 0.125, 0.25, and 0.5 are also supported.

+

bss_param

+

No

+

BssParamEntity object

+

This parameter does not need to be set for pay-per-use instances.

+

reserved_ip

+

No

+

Array of strings

+

IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

+

change_type

+

No

+

String

+

Modification type. Mandatory when the number of replicas of a DCS Redis 4.0 or 5.0 instance is modified.

+

  • createReplication: adding replicas

    +

  • deleteReplication: deleting replicas

    +

  • addSharding: adding shards

    +

  • instanceType: changing the instance type..

    +
+

Enumeration values:

+

  • createReplication

    +

  • deleteReplication

    +

  • addSharding

    +

  • instanceType

    +
+

available_zones

+

No

+

Array of strings

+

Code of the AZ where each replica is in. This parameter is mandatory when you add replicas to a DCS Redis 4.0 or 5.0 instance. Before specifying an AZ, ensure that there are available resources in it. This parameter is mandatory when you delete replicas from a cluster instance.

+

For details, see Querying AZs.

+

node_list

+

No

+

Array of strings

+

ID of the replica to delete. This parameter is mandatory when you delete replicas of a master/standby DCS Redis 4.0 or 5.0 instance. Currently, only one replica can be deleted at a time.

+

For details, see Querying Details of Shards and Replicas.

+

execute_immediately

+

No

+

Boolean

+

Whether to apply the change immediately. Options:

+

  • true (default): Apply the change immediately.

    +

  • false: Apply the change during the maintenance window. .

    +
+
+
+ +
+ + + + + + + + + + + +
Table 3 BssParamEntity

Parameter

+

Mandatory

+

Type

+

Description

+

is_auto_pay

+

No

+

String

+

This parameter is reserved.

+
+
+
+

Response Parameters

None

+
+

Example Requests

Changing instance specifications to 1 GB.

+
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize
+
+{
+  "spec_code" : "redis.ha.xu1.tiny.r2.1",
+  "new_capacity" : 1,
+  "reserved_ip" : [ "192.168.0.125" ],
+  "change_type" : "createReplication",
+  "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ],
+  "node_list" : [ "ff80808282eee5f90183120188ae093e" ],
+  "execute_immediately" : true
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

204

+

DCS instance specifications modified successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dcs/api-ref/RestartOrFlushInstances.html b/docs/dcs/api-ref/RestartOrFlushInstances.html new file mode 100644 index 00000000..13dc50ea --- /dev/null +++ b/docs/dcs/api-ref/RestartOrFlushInstances.html @@ -0,0 +1,242 @@ + + +

Restarting DCS Instances or Clearing DCS Instance Data

+

Function

This API is used to restart a running DCS instance.

+

Data clearance operations cannot be undone on DCS Redis 4.0, 5.0, and 6.0 instances.

+
+

URI

PUT /v2/{project_id}/instances/status

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

instances

+

No

+

Array of strings

+

List of instance IDs.

+

action

+

No

+

String

+

Operation on the instance:

+

restart: force restart

+

soft_restart: restart only the instance process

+

flush: clear data

+
NOTE:

Only DCS Redis 4.0, 5.0, and 6.0 instances can be flushed.

+
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

results

+

Array of BatchOpsResult objects

+

Result of deleting, restarting, or clearing data of an instance.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 BatchOpsResult

Parameter

+

Type

+

Description

+

result

+

String

+

Instance deletion result. Options: success and failed.

+

instance

+

String

+

DCS instance ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Force restarting a DCS instance

+
PUT https://{dcs_endpoint}/v2/{project_id}/instances/status
+
+{
+  "instances" : [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ],
+  "action" : "restart"
+}
+
+

Example Responses

Status code: 200

+

DCS instances restarted successfully or the instance data cleared successfully.

+
{
+  "results" : [ {
+    "instance" : "e3a7019c-8824-4c1a-8289-5300f19b9f64",
+    "result" : "success"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

DCS instances restarted successfully or the instance data cleared successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Management
+
+
+ diff --git a/docs/dcs/api-ref/RestoreInstance.html b/docs/dcs/api-ref/RestoreInstance.html new file mode 100644 index 00000000..51a64726 --- /dev/null +++ b/docs/dcs/api-ref/RestoreInstance.html @@ -0,0 +1,218 @@ + + +

Restoring a DCS Instance

+

Function

This API is used to restore the backup data to a specific DCS instance.

+

Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.

+
+
+

URI

POST /v2/{project_id}/instances/{instance_id}/restores

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

backup_id

+

Yes

+

String

+

Backup ID.

+

remark

+

No

+

String

+

Description of DCS instance restoration.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

restore_id

+

String

+

ID of the restoration record.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Restoring the backup files of the DCS instance

+
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/restores
+
+{
+  "backup_id" : "8ba256cb-e5ac-44f6-a3da-c03d8f0e5029",
+  "remark" : "restore instance"
+}
+
+

Example Responses

Status code: 200

+

Instance restored successfully.

+
{
+  "restore_id" : "a6155972-800c-4170-a479-3231e907d2f6"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Instance restored successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Backup and Restoration
+
+
+ diff --git a/docs/dcs/api-ref/SetOnlineMigrationTask.html b/docs/dcs/api-ref/SetOnlineMigrationTask.html new file mode 100644 index 00000000..8e577d94 --- /dev/null +++ b/docs/dcs/api-ref/SetOnlineMigrationTask.html @@ -0,0 +1,467 @@ + + +

Configuring an Online Data Migration Task

+

Function

This API is used to configure an online data migration task.

+
+

URI

POST /v2/{project_id}/migration/{task_id}/task

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

task_id

+

Yes

+

String

+

Online migration task ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

migration_method

+

Yes

+

String

+

Type of the migration.

+

  • Full migration is suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during the migration will not be migrated to the target instance.

    +

  • Incremental migration is suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances. After the full migration is complete, incremental migration starts.Options:

    +

  • full_amount_migration: full migration

    +

  • incremental_migration: incremental migration

    +
+

Enumeration values:

+

  • full_amount_migration

    +

  • incremental_migration

    +
+

resume_mode

+

Yes

+

String

+

Reconnection mode. In automatic reconnection mode, if the source and target instances are disconnected due to network exceptions, automatic reconnections will be performed indefinitely. Full synchronization will be triggered and requires more bandwidth if incremental synchronization becomes unavailable. Exercise caution when enabling this option. Values:

+

  • auto: automatically reconnect.

    +

  • manual: manually reconnect.

    +
+

Enumeration values:

+

  • auto

    +

  • manual

    +
+

bandwidth_limit_mb

+

No

+

String

+

Bandwidth limit. For incremental migration, you can limit the bandwidth to ensure smooth service running. When the data synchronization speed reaches the limit, it can no longer increase. - Unit: MB/s. - Value range: 1–10,240 (an integer greater than 0 and less than 10,241).

+

source_instance

+

Yes

+

ConfigMigrationInstanceBody object

+

Source Redis information.

+

target_instance

+

Yes

+

ConfigMigrationInstanceBody object

+

Target Redis information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 ConfigMigrationInstanceBody

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Redis instance ID (mandatory if the source Redis address is not specified).

+

addrs

+

No

+

String

+

Source Redis address (mandatory if the Redis instance ID is not specified).

+

password

+

No

+

String

+

Redis password. If a password is set, this parameter is mandatory.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Migration task ID.

+

name

+

String

+

Migration task name.

+

status

+

String

+

Migration status. Options: SUCCESS, FAILED, MIGRATING, TERMINATED.

+

Enumeration values:

+

  • SUCCESS

    +

  • FAILED

    +

  • MIGRATING

    +

  • TERMINATED

    +
+

error

+

String

+

Error message.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

Configuring an online migration task with migration type set to incremental, auto-reconnect enabled, and source and target instances configured

+
POST https://{dcs_endpoint}/v2/{project_id}/migration/{task_id}/task
+
+{
+  "migration_method" : "incremental_migration",
+  "bandwidth_limit_mb" : 123,
+  "resume_mode" : "auto",
+  "source_instance" : {
+    "id" : null,
+    "addrs" : "192.168.1.1:6379,192.168.0.0:6379",
+    "password" : "xxxxxx"
+  },
+  "target_instance" : {
+    "id" : "cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd",
+    "addrs" : null,
+    "password" : null
+  }
+}
+
+

Example Responses

Status code: 200

+

Online data migration task configured.

+
{
+  "id" : "90754308-a156-406f-a837-8f852f38a646",
+  "name" : "dcs-migration-1db7",
+  "status" : "FULLMIGRATING",
+  "error" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Online data migration task configured.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Data Migration
+
+
+ diff --git a/docs/dcs/api-ref/ShowBigkeyAutoscanConfig.html b/docs/dcs/api-ref/ShowBigkeyAutoscanConfig.html new file mode 100644 index 00000000..611c118e --- /dev/null +++ b/docs/dcs/api-ref/ShowBigkeyAutoscanConfig.html @@ -0,0 +1,335 @@ + + +

Querying the Configurations of Automatic Big Key Analysis

+

Function

This API is used to query configurations of automatic big key analysis.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/bigkey/autoscan

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+

enable_auto_scan

+

Boolean

+

Whether to enable scheduled cache analysis.

+

schedule_at

+

Array of strings

+

UTC time of the day that analysis is scheduled for. Example: 21:00.

+

updated_at

+

String

+

Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey/autoscan
+
+

Example Responses

Status code: 200

+

This API is used to query configurations of automatic big key analysis.

+
{
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "enable_auto_scan" : true,
+  "schedule_at" : [ "21:00" ],
+  "updated_at" : "2020-06-17T02:42:40.793Z"
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4919",
+  "error_msg" : "Does not support bigkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

This API is used to query configurations of automatic big key analysis.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/ShowBigkeyScanTaskDetails.html b/docs/dcs/api-ref/ShowBigkeyScanTaskDetails.html new file mode 100644 index 00000000..193580f8 --- /dev/null +++ b/docs/dcs/api-ref/ShowBigkeyScanTaskDetails.html @@ -0,0 +1,461 @@ + + +

Querying Big Key Analysis Details

+

Function

This API is used to query the big key analysis details.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. [For details, see Obtaining a Project ID.]

+

instance_id

+

Yes

+

String

+

Instance ID.

+

bigkey_id

+

Yes

+

String

+

ID of the big key analysis task.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Big key analysis record ID.

+

instance_id

+

String

+

Instance ID.

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

num

+

Integer

+

Number of big keys.

+

keys

+

Array of BigkeysBody objects

+

Big key record. (The value is null and is not returned when the analysis task is being created.)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 BigkeysBody

Parameter

+

Type

+

Description

+

name

+

String

+

Key name.

+

type

+

String

+

Key type.

+

Enumeration values:

+

  • string

    +

  • list

    +

  • set

    +

  • zset

    +

  • hash

    +
+

shard

+

String

+

Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is ip:port.

+

db

+

Integer

+

Database where a big key is located.

+

size

+

Long

+

Size of the key value.

+

unit

+

String

+

Key unit. count: number of keys; byte: key size.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task/858ee14c-2271-4489-8b82-7bda7459ae3e
+
+

Example Responses

Status code: 200

+

Big key analysis details queried successfully.

+
{
+  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "status" : "success",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z",
+  "started_at" : "2020-06-15T02:21:23.534Z",
+  "finished_at" : "2020-06-15T02:21:25.588Z",
+  "keys" : [ {
+    "name" : "dcs-bigkey-test",
+    "type" : "string",
+    "shard" : "192.168.1.134:6379",
+    "db" : 0,
+    "size" : 3000,
+    "unit" : "byte"
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4919",
+  "error_msg" : "Does not support bigkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Big key analysis details queried successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/ShowDiagnosisTaskDetails.html b/docs/dcs/api-ref/ShowDiagnosisTaskDetails.html new file mode 100644 index 00000000..a6e8288a --- /dev/null +++ b/docs/dcs/api-ref/ShowDiagnosisTaskDetails.html @@ -0,0 +1,624 @@ + + +

Querying a Specified Diagnosis Report

+

Function

This API is used to query details about a diagnosis report based on the report ID.

+
+

URI

GET /v2/{project_id}/diagnosis/{report_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

report_id

+

Yes

+

String

+

Diagnosis report ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

abnormal_item_sum

+

Integer

+

Total number of abnormal diagnosis items.

+

failed_item_sum

+

Integer

+

Total number of failed diagnosis items.

+

diagnosis_node_report_list

+

Array of DiagnosisNodeReport objects

+

Node diagnosis report list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 DiagnosisNodeReport

Parameter

+

Type

+

Description

+

node_ip

+

String

+

Node IP address, for example, 192.168.0.234:6379.

+

az_code

+

String

+

Code of the AZ where the node is.

+

group_name

+

String

+

Name of the shard where the node is.

+

abnormal_sum

+

Integer

+

Total number of abnormal diagnosis items.

+

failed_sum

+

Integer

+

Total number of failed diagnosis items.

+

role

+

String

+

Node role.

+

Enumeration values:

+

  • master

    +

  • slave

    +
+

diagnosis_dimension_list

+

Array of DiagnosisDimension objects

+

Diagnosis dimension list.

+

command_time_taken_list

+

CommandTimeTakenList object

+

Command execution duration list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 DiagnosisDimension

Parameter

+

Type

+

Description

+

name

+

String

+

Diagnosis dimension name.

+

Enumeration values:

+

  • network

    +

  • storage

    +

  • load

    +
+

abnormal_num

+

Integer

+

Total number of abnormal diagnosis items.

+

failed_num

+

Integer

+

Total number of failed diagnosis items.

+

diagnosis_item_list

+

Array of DiagnosisItem objects

+

Diagnosis items.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 DiagnosisItem

Parameter

+

Type

+

Description

+

name

+

String

+

Diagnosis item name.

+

Enumeration values:

+

  • connection_num

    +

  • rx_controlled

    +

  • persistence

    +

  • centralized_expiration

    +

  • inner_memory_fragmentation

    +

  • time_consuming_commands

    +

  • hit_ratio

    +

  • memory_usage

    +

  • cpu_usage

    +
+

cause_ids

+

Array of ConclusionItem objects

+

List of cause IDs. For details about the IDs, see "Instance Diagnosis IDs" in the appendix.

+

impact_ids

+

Array of ConclusionItem objects

+

List of impact IDs. For details about the IDs, see "Instance Diagnosis IDs" in the appendix.

+

advice_ids

+

Array of ConclusionItem objects

+

List of suggestion IDs. For details about the IDs, see "Instance Diagnosis IDs" in the appendix.

+

result

+

String

+

Diagnosis result.

+

Enumeration values:

+

  • failed

    +

  • abnormal

    +

  • normal

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 6 ConclusionItem

Parameter

+

Type

+

Description

+

id

+

Integer

+

Conclusion ID.

+

params

+

Map<String,String>

+

Conclusion parameters.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 CommandTimeTakenList

Parameter

+

Type

+

Description

+

total_num

+

Integer

+

Total number of times that commands are executed.

+

total_usec_sum

+

Double

+

Total duration of command execution.

+

result

+

String

+

Command execution latency result.

+

Enumeration values:

+

  • succeed

    +

  • failed

    +
+

command_list

+

Array of CommandTimeTaken objects

+

Command execution latency statistics.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 CommandTimeTaken

Parameter

+

Type

+

Description

+

calls_sum

+

Integer

+

Number of calls.

+

usec_sum

+

Double

+

Total time consumed.

+

command_name

+

String

+

Command name.

+

per_usec

+

String

+

Duration percentage.

+

average_usec

+

Double

+

Average duration of calls.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

The specified report is queried successfully.

+
{
+  "abnormal_item_sum" : 1,
+  "failed_item_sum" : 0,
+  "diagnosis_node_report_list" : [ {
+    "group_name" : "group-0",
+    "az_code" : "region01",
+    "node_ip" : "192.168.0.170:6379",
+    "abnormal_sum" : 1,
+    "failed_sum" : 0,
+    "role" : "master",
+    "command_time_taken_list" : {
+      "command_list" : [ {
+        "calls_sum" : 329,
+        "usec_sum" : 20.732,
+        "command_name" : "info",
+        "per_usec" : "68.61%",
+        "average_usec" : 0.063
+      }, {
+        "calls_sum" : 1788,
+        "usec_sum" : 1.787,
+        "command_name" : "ping",
+        "per_usec" : "5.91%",
+        "average_usec" : 0.001
+      }, {
+        "calls_sum" : 2,
+        "usec_sum" : 0.025,
+        "command_name" : "config",
+        "per_usec" : "0.08%",
+        "average_usec" : 0.013
+      }, {
+        "calls_sum" : 60,
+        "usec_sum" : 0.186,
+        "command_name" : "slowlog",
+        "per_usec" : "0.62%",
+        "average_usec" : 0.003
+      }, {
+        "calls_sum" : 1764,
+        "usec_sum" : 7.485,
+        "command_name" : "publish",
+        "per_usec" : "24.77%",
+        "average_usec" : 0.004
+      } ],
+      "result" : "succeed",
+      "error_code" : null,
+      "total_num" : 5,
+      "total_usec_sum" : 30.215
+    },
+    "diagnosis_dimension_list" : [ {
+      "name" : "load",
+      "abnormal_num" : 0,
+      "failed_num" : 0,
+      "diagnosis_item_list" : [ {
+        "name" : "cpu_usage",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      }, {
+        "name" : "time_consuming_commands",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      } ]
+    }, {
+      "name" : "storage",
+      "abnormal_num" : 1,
+      "failed_num" : 0,
+      "diagnosis_item_list" : [ {
+        "name" : "inner_memory_fragmentation",
+        "result" : "normal",
+        "cause_ids" : [ {
+          "id" : 7,
+          "params" : null
+        } ],
+        "impact_ids" : [ {
+          "id" : 3,
+          "params" : null
+        } ],
+        "advice_ids" : [ {
+          "id" : 4,
+          "params" : null
+        } ],
+        "error_code" : null
+      }, {
+        "name" : "persistence",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      }, {
+        "name" : "centralized_expiration",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      }, {
+        "name" : "memory_usage",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      }, {
+        "name" : "hit_ratio",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      } ]
+    }, {
+      "name" : "network",
+      "abnormal_num" : 0,
+      "failed_num" : 0,
+      "diagnosis_item_list" : [ {
+        "name" : "connection_num",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      }, {
+        "name" : "rx_controlled",
+        "result" : "normal",
+        "cause_ids" : null,
+        "impact_ids" : null,
+        "advice_ids" : null,
+        "error_code" : null
+      } ]
+    } ]
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The specified report is queried successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instance Diagnosis
+
+
+ diff --git a/docs/dcs/api-ref/ShowHotkeyAutoscanConfig.html b/docs/dcs/api-ref/ShowHotkeyAutoscanConfig.html new file mode 100644 index 00000000..9a2f2b41 --- /dev/null +++ b/docs/dcs/api-ref/ShowHotkeyAutoscanConfig.html @@ -0,0 +1,335 @@ + + +

Querying the Configurations of Automatic Hot Key Analysis

+

Function

This API is used to query configurations of automatic hot key analysis.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/hotkey/autoscan

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+

enable_auto_scan

+

Boolean

+

Whether to enable scheduled cache analysis.

+

schedule_at

+

Array of strings

+

UTC time of the day that analysis is scheduled for. Example: 21:00.

+

updated_at

+

String

+

Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey/autoscan
+
+

Example Responses

Status code: 200

+

This API is used to query configurations of automatic hot key analysis.

+
{
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "enable_auto_scan" : true,
+  "schedule_at" : [ "21:00" ],
+  "updated_at" : "2020-06-17T02:42:40.793Z"
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4922",
+  "error_msg" : "Does not support hotkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

This API is used to query configurations of automatic hot key analysis.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/ShowHotkeyTaskDetails.html b/docs/dcs/api-ref/ShowHotkeyTaskDetails.html new file mode 100644 index 00000000..bf62e523 --- /dev/null +++ b/docs/dcs/api-ref/ShowHotkeyTaskDetails.html @@ -0,0 +1,470 @@ + + +

Querying Hot Key Analysis Details

+

Function

This API is used to query the hot key analysis details.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+

hotkey_id

+

Yes

+

String

+

ID of the hot key analysis task.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

id

+

String

+

Hot key analysis record ID.

+

instance_id

+

String

+

Instance ID.

+

status

+

String

+

Analysis task status.

+

Enumeration values:

+

  • waiting

    +

  • running

    +

  • success

    +

  • failed

    +
+

scan_type

+

String

+

Analysis method.

+

Enumeration values:

+

  • manual

    +

  • auto

    +
+

created_at

+

String

+

Time when an analysis task is created. The format is 2020-06-15T02:21:18.669Z.

+

started_at

+

String

+

Time when an analysis task started. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

finished_at

+

String

+

Time when an analysis task ended. The format is 2020-06-15T02:21:18.669Z. (The value is null and is not returned when the analysis task is being created.)

+

num

+

Integer

+

Number of hot keys.

+

keys

+

Array of HotkeysBody objects

+

Hot key record. (The value is null and is not returned when the analysis task is being created.)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 HotkeysBody

Parameter

+

Type

+

Description

+

name

+

String

+

Key name.

+

type

+

String

+

Key type.

+

Enumeration values:

+

  • string

    +

  • list

    +

  • set

    +

  • zset

    +

  • hash

    +
+

shard

+

String

+

Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is ip:port.

+

db

+

Integer

+

Database where a hot key is located.

+

size

+

Long

+

Size of the key value.

+

unit

+

String

+

Key unit. count: number of keys; byte: key size.

+

freq

+

Integer

+

Reflects the access frequency of a key within a specific period of time.

+

The value is the logarithmic access frequency counter. The maximum value is 255, which indicates 1 million access requests. After the frequency reaches 255, the value will no longer increase even if access requests continue to increase. The value will decrease by 1 for every minute during which the key is not accessed.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task/0ccb25d5-27cf-4188-b5ea-987730a85371
+
+

Example Responses

Status code: 200

+

Hot key analysis details queried successfully.

+
{
+  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "status" : "success",
+  "scan_type" : "manual",
+  "created_at" : "2020-06-15T02:21:18.669Z",
+  "started_at" : "2020-06-15T02:21:23.534Z",
+  "finished_at" : "2020-06-15T02:21:25.588Z",
+  "keys" : [ {
+    "name" : "dcs-hotkey-test",
+    "type" : "string",
+    "shard" : "192.168.1.134:6379",
+    "db" : 0,
+    "size" : 3000,
+    "unit" : "byte",
+    "freq" : 4
+  } ]
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4922",
+  "error_msg" : "Does not support hotkey analyze."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Hot key analysis details queried successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource is not found.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Cache Analysis
+
+
+ diff --git a/docs/dcs/api-ref/ShowInstance.html b/docs/dcs/api-ref/ShowInstance.html new file mode 100644 index 00000000..7d64e64c --- /dev/null +++ b/docs/dcs/api-ref/ShowInstance.html @@ -0,0 +1,978 @@ + + +

Querying a DCS instance

+

Function

This API is used to query the details about a specified DCS instance.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_id

+

Yes

+

String

+

Instance ID.

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

vpc_name

+

String

+

VPC name.

+

charging_mode

+

Integer

+

Billing mode. The value can be 0: pay-per-use.

+

vpc_id

+

String

+

VPC ID.

+

user_name

+

String

+

Username.

+

created_at

+

String

+

Time when the instance is created. Format: 2017-03-31T12:24:46.297Z

+

description

+

String

+

Instance description

+

security_group_id

+

String

+

Security group ID.

+

security_group_name

+

String

+

Security group name.

+

max_memory

+

Integer

+

Total memory size in MB.

+

used_memory

+

Integer

+

Used memory size in MB.

+

capacity

+

Integer

+

DCS instance cache capacity in GB.

+

capacity_minor

+

String

+

Capacity (GB) of a small DCS instance (smaller than 1 GB).

+

maintain_begin

+

String

+

UTC time when the maintenance time window starts. The format is HH:mm:ss.

+

maintain_end

+

String

+

UTC time when the maintenance time window ends. The format is HH:mm:ss.

+

engine

+

String

+

DCS instance engine.

+

no_password_access

+

String

+

Indicates whether the instance can be accessed without a password.

+

  • true: The instance can be accessed without a password.

    +

  • false: The instance can be accessed only after password authentication.

    +
+

ip

+

String

+

IP address for connecting to the DCS instance. For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.

+

instance_backup_policy

+

InstanceBackupPolicy object

+

Backup policy. This parameter is supported when the instance type is master/standby or cluster.

+

az_codes

+

Array of strings

+

AZ where the instance is in. The AZ code is returned.

+

available_zones

+

Array of strings

+

ID of the AZ where the instance is in. The AZ ID is returned.

+

access_user

+

String

+

Username used for accessing a DCS instance after password authentication.

+

instance_id

+

String

+

Instance ID.

+

port

+

Integer

+

Port of the DCS instance.

+

user_id

+

String

+

User ID.

+

name

+

String

+

Instance name.

+

spec_code

+

String

+

Specification code.

+

subnet_id

+

String

+

Subnet ID.

+

subnet_name

+

String

+

Subnet name.

+

subnet_cidr

+

String

+

Subnet CIDR block.

+

engine_version

+

String

+

Cache version.

+

order_id

+

String

+

Order ID.

+

status

+

String

+

Instance status. For details, see DCS Instance Statuses.

+

domain_name

+

String

+

Domain name of the instance.

+

readonly_domain_name

+

String

+

Read-only domain name of the instance. This parameter is available only for master/standby instances.

+

enable_publicip

+

Boolean

+

This parameter is reserved.

+

publicip_id

+

String

+

ID of the EIP bound to the DCS Redis instance. This parameter is reserved. The value is null.

+

publicip_address

+

String

+

EIP bound to the DCS Redis instance. The value of this parameter is null if public network access is disabled.

+

enable_ssl

+

Boolean

+

This parameter is reserved.

+

service_upgrade

+

Boolean

+

Whether the instance has an upgrade task.

+

  • true: yes

    +

  • false: no

    +
+

service_task_id

+

String

+

Upgrade task ID.

+

  • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.

    +

  • If the value of service_upgrade is set to false, the value of this parameter is empty.

    +
+

enterprise_project_id

+

String

+

Enterprise project ID.

+

backend_addrs

+

String

+

Backend address of a cluster instance.

+

features

+

Features object

+

Features supported by the instance.

+

domain_name_info

+

DomainNameInfo object

+

Information about instance domain name update and public domain name resolution.

+

transparent_client_ip_enable

+

Boolean

+

Whether client IP pass-through is enabled.

+

sub_status

+

String

+

Instance sub-status.

+

tags

+

Array of ResourceTag objects

+

Instance tag key and value.

+

cpu_type

+

String

+

CPU type of the instance. Generally, the value is x86_64 or aarch64.

+

enterprise_project_name

+

String

+

Enterprise project name.

+

update_at

+

String

+

Update time, for example, 2022-07-06T09:32:16.502Z.

+

product_type

+

String

+

Edition. Only the basic edition is supported. Value: generic.

+

Enumeration values:

+

  • generic

    +

  • enterprise

    +
+

storage_type

+

String

+

Storage type (DRAM).

+

Enumeration values:

+

  • DRAM

    +
+

launched_at

+

String

+

Start time, for example, 2022-07-06T09:32:16.502Z.

+

cache_mode

+

String

+

Instance type. Options:

+

  • single: single-node

    +

  • ha: master/standby

    +

  • cluster: Redis Cluster

    +

  • proxy: Proxy Cluster

    +
+

support_slow_log_flag

+

String

+

Whether slow query logs are supported.

+

db_number

+

Integer

+

Number of databases.

+

replica_count

+

Integer

+

Number of replicas.

+

sharding_count

+

Integer

+

Number of shards in a cluster instance.

+

bandwidth_info

+

BandwidthInfo object

+

Bandwidth information.

+

cloud_service_type_code

+

String

+

Code of the cloud service type.

+

cloud_resource_type_code

+

String

+

Code of the cloud resource type.

+

inquery_spec_code

+

String

+

Specification code in the operations system.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 InstanceBackupPolicy

Parameter

+

Type

+

Description

+

backup_policy_id

+

String

+

Backup policy ID.

+

created_at

+

String

+

Creation time. Example: 2022-04-11T09:45:24.790Z

+

updated_at

+

String

+

Update time. Example: 2022-04-12T02:22:03.269Z

+

policy

+

BackupPolicy object

+

Backup policy.

+

tenant_id

+

String

+

Tenant ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 BackupPolicy

Parameter

+

Type

+

Description

+

backup_type

+

String

+

Backup type.

+

  • auto: automatic backup

    +

  • manual: manual backup

    +
+

save_days

+

Integer

+

This parameter is mandatory when backup_type is set to manual. Retention period, in days. The value ranges from 1 to 7. The automatic backup policy is retained when automatic backup is switched to manual backup.

+

periodical_backup_plan

+

BackupPlan object

+

Backup schedule. This parameter is mandatory when backup_type is set to manual. The automatic backup policy is retained when automatic backup is switched to manual backup.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 BackupPlan

Parameter

+

Type

+

Description

+

timezone_offset

+

String

+

Time zone in which backup is performed. This parameter is no longer used.

+

backup_at

+

Array of integers

+

Day in a week on which backup starts. The value ranges from 1 to 7, where 1 indicates Monday, and 7 indicates Sunday. The automatic backup policy is retained when automatic backup is switched to manual backup.

+

period_type

+

String

+

Interval at which backup is performed, which supports only weekly currently. The automatic backup policy is retained when automatic backup is switched to manual backup.

+

begin_at

+

String

+

UTC time when the backup starts. For example, 00:00-01:00 indicates that the backup starts at 00:00 (UTC time). The value must be on the hour. The backup interval is 1 hour. The automatic backup policy is retained when automatic backup is switched to manual backup.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 Features

Parameter

+

Type

+

Description

+

support_acl

+

Boolean

+

Whether ACL is supported.

+

  • true: Yes

    +

  • false: No

    +
+

support_transparent_client_ip

+

Boolean

+

Whether client IP pass-through is enabled.

+

  • true: Yes

    +

  • false: No

    +
+

support_ssl

+

Boolean

+

Whether SSL is supported.

+

  • true: Yes

    +

  • false: No

    +
+

support_audit_log

+

Boolean

+

Whether audit logs are supported

+

  • true: Yes

    +

  • false: No

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 DomainNameInfo

Parameter

+

Type

+

Description

+

support_public_resolve

+

Boolean

+

Whether to enable public domain name resolution.

+

  • true: enable

    +

  • false: disable

    +
+

is_latest_rules

+

Boolean

+

Whether the current domain name is the latest.

+

  • true: yes

    +

  • false: no

    +
+

zone_name

+

String

+

Region suffix of the domain name.

+

history_domain_names

+

Array of DomainNameEntity objects

+

Historical domain name information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 DomainNameEntity

Parameter

+

Type

+

Description

+

domain_name

+

String

+

Historical domain names of the instance.

+

is_readonly

+

Boolean

+

Whether the domain name is read-only.

+

  • true: Yes

    +

  • false: No

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 9 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

  • Must be specified.

    +

  • Must be unique for each resource.

    +

  • Can contain a maximum of 36 characters.

    +

  • Must be unique and cannot be empty.

    +
+

value

+

String

+

Tag value.

+

  • This parameter is mandatory when action is set to create and is optional when action is set to delete.

    +

  • It can contain a maximum of 43 characters.

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 BandwidthInfo

Parameter

+

Type

+

Description

+

begin_time

+

Long

+

Start time of temporary increase.

+

end_time

+

Long

+

End time of temporary increase.

+

current_time

+

Long

+

Current time.

+

bandwidth

+

Integer

+

Current bandwidth, in Mbit/s.

+

next_expand_time

+

Long

+

Next increase time.

+

expand_count

+

Integer

+

Number of increases.

+

expand_effect_time

+

Long

+

Interval between temporary increases.

+

expand_interval_time

+

Long

+

Time to the next increase.

+

max_expand_count

+

Integer

+

Maximum number of increases.

+

task_running

+

Boolean

+

Whether the task is running.

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}
+
+

Example Responses

Status code: 200

+

The specified instance is queried successfully.

+
{
+  "publicip_id" : null,
+  "vpc_name" : "dcs-beta",
+  "charging_mode" : 0,
+  "enterprise_project_name" : "default",
+  "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
+  "user_name" : "clouduser",
+  "created_at" : "2022-08-29T08:53:47.319Z",
+  "description" : null,
+  "cache_mode" : "ha",
+  "security_group_id" : "securityGroupId",
+  "enable_ssl" : false,
+  "max_memory" : 128,
+  "publicip_address" : null,
+  "capacity" : 0,
+  "maintain_begin" : "18:00:00",
+  "engine" : "Redis",
+  "maintain_end" : "19:00:00",
+  "capacity_minor" : ".125",
+  "service_upgrade" : false,
+  "subnet_name" : "dcs-beta",
+  "no_password_access" : "true",
+  "service_task_id" : null,
+  "ip" : "192.168.0.251",
+  "subnet_cidr" : "192.168.0.0/24",
+  "used_memory" : 2,
+  "security_group_name" : "securityGroupId",
+  "instance_backup_policy" : null,
+  "az_codes" : [ "xx-xxxxx-xx" ],
+  "available_zones" : [ "d539378ec1314c85b76fefa3f7071458" ],
+  "access_user" : null,
+  "enterprise_project_id" : "0",
+  "instance_id" : "a4c545cd-10b2-4efc-b0ab-a9b554ca0621",
+  "enable_publicip" : false,
+  "port" : 6379,
+  "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
+  "domain_name" : "redis-a4c545cd-10b2-4efc-b0ab-a9b554ca0621.dcs.example.com",
+  "name" : "dcs-billing",
+  "spec_code" : "redis.ha.xu1.tiny.r2.128",
+  "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
+  "engine_version" : "5.0",
+  "order_id" : null,
+  "status" : "RUNNING",
+  "features" : {
+    "support_acl" : true,
+    "support_transparent_client_ip" : true,
+    "support_ssl" : false,
+    "support_audit_log" : false
+  },
+  "domain_name_info" : {
+    "support_public_resolve" : true,
+    "is_latest_rules" : true,
+    "zone_name" : "dcs.example.com",
+    "history_domain_names" : null
+  },
+  "transparent_client_ip_enable" : true,
+  "sub_status" : "normal",
+  "cpu_type" : "x86_64",
+  "cloud_service_type_code" : "hws.service.type.dcs",
+  "cloud_resource_type_code" : "hws.resource.type.dcs3",
+  "inquery_spec_code" : "redis.ha.xu1.tiny.r2.128"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The specified instance is queried successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Lifecycle Management
+
+
+ diff --git a/docs/dcs/api-ref/ShowInstanceSSLDetail.html b/docs/dcs/api-ref/ShowInstanceSSLDetail.html new file mode 100644 index 00000000..2c6b6327 --- /dev/null +++ b/docs/dcs/api-ref/ShowInstanceSSLDetail.html @@ -0,0 +1,235 @@ + + +

Querying SSL Encryption of an Instance

+

Function

This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0 instances.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/ssl

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

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

enabled

+

Boolean

+

Enabling or disabling SSL.

+

Enumeration values:

+

  • true

    +

  • false

    +
+

ip

+

String

+

IP address used when SSL is enabled.

+

port

+

String

+

Port used when SSL is enabled.

+

domain_name

+

String

+

Domain name used when SSL is enabled.

+

ssl_expired_at

+

String

+

SSL certificate validity period (UTC time).

+

ssl_validated

+

Boolean

+

Whether the SSL certificate is valid.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

Maximum: 1024

+

error_code

+

String

+

Error code.

+

Maximum: 9

+

error_ext_msg

+

String

+

Extended error information. This parameter is not used currently and is set to null.

+

Maximum: 1024

+
+
+
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl
+
+

Example Responses

Status code: 200

+

Instance SSL queried successfully.

+
{
+  "enabled" : true,
+  "ip" : "192.168.0.5",
+  "port" : "6379",
+  "domain_name" : "redis-553a2516-b865-4159-b774-204dc0a36e37.dcs.example.com:6379",
+  "ssl_expired_at" : "2022-06-15T02:21:18.669Z",
+  "ssl_validated" : true
+}
+

Status code: 400

+

Invalid request.

+
{
+  "error_code" : "DCS.4201",
+  "error_msg" : "Do not support SSL."
+}
+

Status code: 500

+

Internal service error.

+
{
+  "error_code" : "DCS.5010",
+  "error_msg" : "Failed to operate SSL in database."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

Instance SSL queried successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Network Security
+
+
+ diff --git a/docs/dcs/api-ref/ShowIpWhitelist.html b/docs/dcs/api-ref/ShowIpWhitelist.html index b4703e32..dd943179 100644 --- a/docs/dcs/api-ref/ShowIpWhitelist.html +++ b/docs/dcs/api-ref/ShowIpWhitelist.html @@ -1,135 +1,144 @@

Querying the IP Whitelist of a DCS Instance

-

Function

This API is used to query the IP address whitelist of a specific instance.

+

Function

This API is used to query the IP address whitelist of a specific instance.

-

URI

GET /v2/{project_id}/instance/{instance_id}/whitelist

+

URI

GET /v2/{project_id}/instance/{instance_id}/whitelist

-
Table 1 Path parameter

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID.

+

Project ID. For details, see Obtaining a Project ID.

instance_id

+

instance_id

Yes

+

Yes

String

+

String

Instance ID.

+

Instance ID.
-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 2 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

enable_whitelist

+

instance_id

Boolean

+

String

Whether to enable the whitelist.

-

Options:

-
  • true
  • false
+

Instance ID.

whitelist

+

enable_whitelist

Array of Whitelist objects

+

Boolean

IP whitelist group.

+

Whether to enable the whitelist. The options are true and false.

+

Enumeration values:

+

  • true

    +

  • false

    +
+

whitelist

+

Array of Whitelist objects

+

IP whitelist group. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one.
-
Table 3 Whitelist

Parameter

+
- - - - - - - -
Table 3 Whitelist

Parameter

Type

+

Type

Description

+

Description

group_name

+

group_name

String

+

String

Whitelist group name. A maximum of four groups can be created for each instance.

+

Whitelist group name. A maximum of four groups can be created for each instance.

ip_list

+

ip_list

Array of strings

+

Array of strings

List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.

+

List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.
-

Example Request

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
+

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
-

Example Response

Status code: 200

-

Instance whitelist queried successfully.

-
{
+
Example Responses
Status code: 200

+
Instance whitelist queried successfully.

+
{
   "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
   "enable_whitelist" : true,
-  "whitelist" : {
+  "whitelist" : [ {
     "group_name" : "test001",
     "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
-  }
+  } ]
 }

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
Status Code

 
Description

+
Description

 		
 

 
200

+
200

 
Instance whitelist queried successfully.

+
Instance whitelist queried successfully.

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

 

-
Parent topic: Network Security

+
Parent topic: Network Security

 

 

 
diff --git a/docs/dcs/api-ref/ShowJobInfo.html b/docs/dcs/api-ref/ShowJobInfo.html
new file mode 100644
index 00000000..f7efbe5f
--- /dev/null
+++ b/docs/dcs/api-ref/ShowJobInfo.html
@@ -0,0 +1,364 @@
+
+
+
Querying the Job Execution Result of a Tenant

+
Function
This API is used to query the task execution result.

+

+
URI
GET /v2/{project_id}/jobs/{job_id}

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
job_id

+
Yes

+
String

+
Task ID.

+

+

+

+
Request Parameters
None

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
job_id

+
String

+
Task ID.

+
job_type

+
String

+
Job type. Options:

+
  • masterStandbySwapJob: switching master and standby nodes
    
+
  • modifyClientIpTransJob: modifying source IP pass-through
    
+

+
Enumeration values:

+
  • masterStandbySwapJob
    
+
  • modifyClientIpTransJob
    
+

+
status

+
String

+
Job status.

+
Enumeration values:

+
  • INIT
    
+
  • RUNNING
    
+
  • SUCCESS
    
+
  • FAIL
    
+

+
begin_time

+
String

+
Job start timestamp, in ms. The format is 1684191545379.

+
end_time

+
String

+
Job start timestamp, in ms. The format is 1684191548248.

+
fail_reason

+
String

+
Failure cause.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa/progress

+

+
Example Responses
Status code: 200

+
Details of the background task queried successfully.

+
{
+  "job_id" : "ff8080818822bbf70188235afc24141a",
+  "job_type" : "masterStandbySwapJob",
+  "status" : "SUCCESS",
+  "begin_time" : "1684191545379",
+  "end_time" : "1684191548248",
+  "fail_reason" : null
+}

+
Status code: 400

+
Invalid request.

+
{
+  "error_code" : "111400063",
+  "error_msg" : "Invalid {0} parameter in the request."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Details of the background task queried successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
Request rejected.

+
404

+
The requested resource could not be found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Background Task Management

+

+

+
diff --git a/docs/dcs/api-ref/ShowMigrationTask.html b/docs/dcs/api-ref/ShowMigrationTask.html
new file mode 100644
index 00000000..30b2b672
--- /dev/null
+++ b/docs/dcs/api-ref/ShowMigrationTask.html
@@ -0,0 +1,725 @@
+
+
+
Querying Details of a Data Migration Task

+
Function
This API is used to query migration task details.

+

+
URI
GET /v2/{project_id}/migration-task/{task_id}

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
task_id

+
Yes

+
String

+
Task ID.

+

+

+

+
Request Parameters
None

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
task_id

+
String

+
Migration task ID.

+
task_name

+
String

+
Migration task name.

+
description

+
String

+
Migration task description.

+
status

+
String

+
Migration task status. The value can be SUCCESS, FAILED, MIGRATING, TERMINATED, TERMINATING, INCRMIGRATING, FULLMIGRATING, RUNNING** (pending configuration), MIGRATION_FAILED, or RELEASED.

+
Enumeration values:

+
  • SUCCESS
    
+
  • FAILED
    
+
  • MIGRATING
    
+
  • TERMINATED
    
+
  • TERMINATING
    
+
  • INCRMIGEATING
    
+
  • FULLMIGRATING
    
+
  • RUNNING
    
+
  • MIGRATION_FAILED
    
+
  • RELEASED
    
+

+
migration_type

+
String

+
Migration mode, which can be backup file import or online migration.

+
Enumeration values:

+
  • backupfile_import
    
+
  • online_migration
    
+

+
migration_method

+
String

+
Type of the migration, which can be full migration or incremental migration.

+
Enumeration values:

+
  • full_amount_migration
    
+
  • incremental_migration
    
+

+
ecs_tenant_private_ip

+
String

+
Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis.

+
backup_files

+
BackupFilesBody object

+
Backup files to be imported when the migration mode is backup file import.

+
network_type

+
String

+
Network type, which can be VPC or VPN.

+
Enumeration values:

+
  • vpc
    
+
  • vpn
    
+

+
source_instance

+
SourceInstanceBody object

+
Source Redis information. This parameter is mandatory for online migration.

+
target_instance

+
TargetInstanceBody object

+
Target Redis instance information.

+
created_at

+
String

+
Time when the migration task is created.

+
updated_at

+
String

+
Time when the migration task is complete.

+
released_at

+
String

+
Time when the migration ECS is released.

+
version

+
String

+
Version.

+
resume_mode

+
String

+
Operation mode, which can be auto or manual.

+
supported_features

+
Array of strings

+
Supported features.

+
tenant_vpc_id

+
String

+
VPC ID.

+
tenant_subnet_id

+
String

+
Subnet ID.

+
tenant_security_group_id

+
String

+
Security group ID.

+
bandwidth_limit_mb

+
String

+
Maximum bandwidth.

+
task_status

+
String

+
Task status.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 3 BackupFilesBody
Parameter

+
Type

+
Description

+
file_source

+
String

+
Data source, which can be an OBS bucket or a backup record.

+
Enumeration values:

+
  • self_build_obs
    
+
  • backup_record
    
+

+
bucket_name

+
String

+
Name of the OBS bucket.

+
files

+
Array of Files objects

+
List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket.

+
backup_id

+
String

+
Backup record ID. This parameter is mandatory when the data source is a backup record.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 4 Files
Parameter

+
Type

+
Description

+
file_name

+
String

+
Name of a backup file.

+
size

+
String

+
File size in bytes.

+
update_at

+
String

+
Time when the file was last modified. The format is YYYY-MM-DD HH:MM:SS.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 5 SourceInstanceBody
Parameter

+
Type

+
Description

+
addrs

+
String

+
Source Redis address (specified in the source_instance parameter).

+
password

+
String

+
Redis password. If a password is set, this parameter is mandatory.

+
task_status

+
String

+
Task status.

+
id

+
String

+
Redis instance ID.

+
ip

+
String

+
Redis IP address.

+
port

+
String

+
Redis port.

+
name

+
String

+
Redis name.

+
proxy_multi_db

+
Boolean

+
Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

+
db

+
String

+
Redis database.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 6 TargetInstanceBody
Parameter

+
Type

+
Description

+
id

+
String

+
Redis instance ID (mandatory in the target_instance parameter).

+
name

+
String

+
Redis instance name (specified in the target_instance parameter).

+
password

+
String

+
Redis password. If a password is set, this parameter is mandatory.

+
ip

+
String

+
Redis IP address.

+
port

+
String

+
Redis port.

+
addrs

+
String

+
Redis instance address.

+
proxy_multi_db

+
Boolean

+
Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

+
db

+
String

+
Redis database.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 8 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 9 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 10 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 11 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
GET https://{dcs_endpoint}/v2/254d2280acb74d36a8b839746bcd7352 /migration-task/a276c1ffa0a54c2597fc824b917db317

+

+
Example Responses
Status code: 200

+
Details of a data migration task queried successfully.

+
  • {
+  "task_name" : "migration1",
+  "task_id" : "a276c1ffa0a54c2597fc824b917db317",
+  "status" : "TERMINATING",
+  "migration_type" : "incremental_migration",
+  "network_type" : "vpc",
+  "source_instance" : {
+    "addrs" : "192.168.1.2:6379",
+    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927e1",
+    "name" : "dcs-test",
+    "ip" : "192.168.1.2",
+    "port" : "6379",
+    "proxy_multi_db" : false,
+    "password" : "DCStest123",
+    "task_status" : "RUNNING",
+    "db" : "0"
+  },
+  "target_instance" : {
+    "addrs" : "192.168.1.2:6379",
+    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee",
+    "name" : "test-instance",
+    "ip" : "192.168.1.2",
+    "port" : "6379",
+    "proxy_multi_db" : false,
+    "password" : "DCStest123",
+    "task_status" : "RUNNING",
+    "db" : "0"
+  },
+  "created_at" : "2019/10/22 14:44:30",
+  "updated_at" : "2019/10/22 18:00:00"
+}
    
+

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Details of a data migration task queried successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
The request is rejected.

+
404

+
The requested resource is not found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Data Migration

+

+

+
diff --git a/docs/dcs/api-ref/ShowMigrationTaskStats.html b/docs/dcs/api-ref/ShowMigrationTaskStats.html
new file mode 100644
index 00000000..b0600b22
--- /dev/null
+++ b/docs/dcs/api-ref/ShowMigrationTaskStats.html
@@ -0,0 +1,359 @@
+
+
+
Querying the Progress of an Online Migration Task

+
Function
This API is used to query progress details about an online migration task.

+

+
URI
GET /v2/{project_id}/migration-task/{task_id}/stats

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
task_id

+
Yes

+
String

+
Task ID.

+

+

+

+
Request Parameters
None

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
full_migration_progress

+
String

+
Percentage of the full migration progress.

+
offset

+
String

+
Offset of incremental migration, which is the difference between the data volume of the source Redis and the target Redis during the incremental migration. If the offset is 0, there is no data difference between the source and the target Redis during the incremental migration.

+
source_dbsize

+
String

+
Number of keys in the source Redis.

+
target_dbsize

+
String

+
Number of keys in the target Redis.

+
target_input_kbps

+
String

+
Key write traffic of the target Redis, in KB/s.

+
target_ops

+
String

+
Number of concurrent operations per second on the target Redis.

+
is_migrating

+
Boolean

+
Whether the migration task is in progress.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/31c6fd2b-2893-430b-90ff-d1adb8060585/stats

+

+
Example Responses
Status code: 200

+
Progress of the online migration task queried successfully.

+
{
+  "full_migration_progress" : 100,
+  "offset" : 100,
+  "source_dbsize" : 531221,
+  "target_dbsize" : 531211,
+  "target_input_kbps" : 50,
+  "target_ops" : 5300,
+  "is_migrating" : true
+}

+
Status code: 400

+
Invalid request.

+
{
+  "error_code" : "DCS.4133",
+  "error_msg" : "Instance job is not found."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Progress of the online migration task queried successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
The request is rejected.

+
404

+
The requested resource is not found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Data Migration

+

+

+
diff --git a/docs/dcs/api-ref/ShowQuotaOfTenant.html b/docs/dcs/api-ref/ShowQuotaOfTenant.html
new file mode 100644
index 00000000..777905c7
--- /dev/null
+++ b/docs/dcs/api-ref/ShowQuotaOfTenant.html
@@ -0,0 +1,269 @@
+
+
+
Querying the Tenant Quotas

+
Function
This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions.

+

+
URI
GET /v2/{project_id}/quota

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+

+

+

+
Request Parameters
None

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
quotas

+
quotas object

+
Quota information.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
Table 3 quotas
Parameter

+
Type

+
Description

+
resources

+
Array of Resources objects

+
List of quotas

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 4 Resources
Parameter

+
Type

+
Description

+
unit

+
String

+
Resource unit.

+
  • When type is set to instance, no value is returned.
    
+
  • When type is set to ram, GB is returned.
    
+

+
min

+
Integer

+
Minimum limit of instance quota when type is set to instance.

+
  • Minimum limit of memory quota when type is set to ram.
    
+

+
max

+
Integer

+
Maximum limit of instance quota when type is set to instance.

+
  • Maximum limit of memory quota when type is set to ram.
    
+

+
quota

+
Integer

+
Maximum number of instances that can be created and maximum allowed total memory.

+
used

+
Integer

+
Number of created instances and used memory.

+
type

+
String

+
The value can be instance or ram.

+
  • instances: instance quota
    
+
  • ram: memory quota
    
+

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/quota

+

+
Example Responses
Status code: 200

+
Tenant quota queried successfully.

+
{
+  "quotas" : {
+    "resources" : [ {
+      "unit" : { },
+      "min" : 1,
+      "max" : 10,
+      "quota" : 10,
+      "used" : 3,
+      "type" : "instance"
+    }, {
+      "unit" : "GB",
+      "min" : 1,
+      "max" : 800,
+      "quota" : 800,
+      "used" : 22,
+      "type" : "ram"
+    } ]
+  }
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Tenant quota queried successfully.

+
400

+
Invalid request.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Other APIs

+

+

+
diff --git a/docs/dcs/api-ref/ShowTags.html b/docs/dcs/api-ref/ShowTags.html
new file mode 100644
index 00000000..7f75f2f7
--- /dev/null
+++ b/docs/dcs/api-ref/ShowTags.html
@@ -0,0 +1,127 @@
+
+
+
Querying Tags of a DCS Instance

+
Function
This API is used to query the tags of an instance by its instance ID.

+

+
URI
GET /v2/{project_id}/instances/{instance_id}/tags

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
instance_id

+
Yes

+
String

+
Instance ID.

+

+

+

+
Request Parameters
None

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
tags

+
Array of QueryResourceTag objects

+
Tag list.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 3 QueryResourceTag
Parameter

+
Type

+
Description

+
key

+
String

+
Tag key.

+
value

+
String

+
Tag value.

+

+

+

+
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/tags

+

+
Example Responses
Status code: 200

+
Instance tags queried successfully.

+
{
+  "tags" : [ {
+    "value" : "a",
+    "key" : "1"
+  }, {
+    "value" : "b",
+    "key" : "2"
+  } ]
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Instance tags queried successfully.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Tag Management

+

+

+
diff --git a/docs/dcs/api-ref/StopMigrationTask.html b/docs/dcs/api-ref/StopMigrationTask.html
new file mode 100644
index 00000000..8ea08160
--- /dev/null
+++ b/docs/dcs/api-ref/StopMigrationTask.html
@@ -0,0 +1,725 @@
+
+
+
Stopping a Data Migration Task

+
Function
This API is used to stop a data migration task.

+

+
URI
POST /v2/{project_id}/migration-task/{task_id}/stop

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
task_id

+
Yes

+
String

+
Task ID

+

+

+

+
Request Parameters
None

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
task_id

+
String

+
Migration task ID.

+
task_name

+
String

+
Migration task name.

+
description

+
String

+
Migration task description.

+
status

+
String

+
Migration task status. The value can be SUCCESS, FAILED, MIGRATING, TERMINATED, TERMINATING, INCRMIGRATING, FULLMIGRATING, RUNNING** (pending configuration), MIGRATION_FAILED, or RELEASED.

+
Enumeration values:

+
  • SUCCESS
    
+
  • FAILED
    
+
  • MIGRATING
    
+
  • TERMINATED
    
+
  • TERMINATING
    
+
  • INCRMIGEATING
    
+
  • FULLMIGRATING
    
+
  • RUNNING
    
+
  • MIGRATION_FAILED
    
+
  • RELEASED
    
+

+
migration_type

+
String

+
Migration mode, which can be backup file import or online migration.

+
Enumeration values:

+
  • backupfile_import
    
+
  • online_migration
    
+

+
migration_method

+
String

+
Type of the migration, which can be full migration or incremental migration.

+
Enumeration values:

+
  • full_amount_migration
    
+
  • incremental_migration
    
+

+
ecs_tenant_private_ip

+
String

+
Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis.

+
backup_files

+
BackupFilesBody object

+
Backup files to be imported when the migration mode is backup file import.

+
network_type

+
String

+
Network type, which can be VPC or VPN.

+
Enumeration values:

+
  • vpc
    
+
  • vpn
    
+

+
source_instance

+
SourceInstanceBody object

+
Source Redis information. This parameter is mandatory for online migration.

+
target_instance

+
TargetInstanceBody object

+
Target Redis instance information.

+
created_at

+
String

+
Time when the migration task is created.

+
updated_at

+
String

+
Time when the migration task is complete.

+
released_at

+
String

+
Time when the migration ECS is released.

+
version

+
String

+
Version.

+
resume_mode

+
String

+
Operation mode, which can be auto or manual.

+
supported_features

+
Array of strings

+
Supported features.

+
tenant_vpc_id

+
String

+
VPC ID.

+
tenant_subnet_id

+
String

+
Subnet ID.

+
tenant_security_group_id

+
String

+
Security group ID.

+
bandwidth_limit_mb

+
String

+
Maximum bandwidth.

+
task_status

+
String

+
Task status.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 3 BackupFilesBody
Parameter

+
Type

+
Description

+
file_source

+
String

+
Data source, which can be an OBS bucket or a backup record.

+
Enumeration values:

+
  • self_build_obs
    
+
  • backup_record
    
+

+
bucket_name

+
String

+
Name of the OBS bucket.

+
files

+
Array of Files objects

+
List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket.

+
backup_id

+
String

+
Backup record ID. This parameter is mandatory when the data source is a backup record.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 4 Files
Parameter

+
Type

+
Description

+
file_name

+
String

+
Name of a backup file.

+
size

+
String

+
File size in bytes.

+
update_at

+
String

+
Time when the file was last modified. The format is YYYY-MM-DD HH:MM:SS.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 5 SourceInstanceBody
Parameter

+
Type

+
Description

+
addrs

+
String

+
Source Redis address (specified in the source_instance parameter).

+
password

+
String

+
Redis password. If a password is set, this parameter is mandatory.

+
task_status

+
String

+
Task status.

+
id

+
String

+
Redis instance ID.

+
ip

+
String

+
Redis IP address.

+
port

+
String

+
Redis port.

+
name

+
String

+
Redis name.

+
proxy_multi_db

+
Boolean

+
Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

+
db

+
String

+
Redis database.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 6 TargetInstanceBody
Parameter

+
Type

+
Description

+
id

+
String

+
Redis instance ID (mandatory in the target_instance parameter).

+
name

+
String

+
Redis instance name (specified in the target_instance parameter).

+
password

+
String

+
Redis password. If a password is set, this parameter is mandatory.

+
ip

+
String

+
Redis IP address.

+
port

+
String

+
Redis port.

+
addrs

+
String

+
Redis instance address.

+
proxy_multi_db

+
Boolean

+
Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

+
db

+
String

+
Redis database.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 8 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 9 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 10 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 11 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
POST https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca/stop

+

+
Example Responses
Status code: 200

+
Data migration task stopped successfully.

+
  • {
+  "task_name" : "migration1",
+  "task_id" : "a276c1ffa0a54c2597fc824b917db317",
+  "status" : "TERMINATING",
+  "migration_type" : "incremental_migration",
+  "network_type" : "vpc",
+  "source_instance" : {
+    "addrs" : "192.168.1.2:6379",
+    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927e1",
+    "name" : "dcs-test",
+    "ip" : "192.168.1.2",
+    "port" : "6379",
+    "proxy_multi_db" : false,
+    "password" : "DCStest123",
+    "task_status" : "RUNNING",
+    "db" : "0"
+  },
+  "target_instance" : {
+    "addrs" : "192.168.1.2:6379",
+    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee",
+    "name" : "test-instance",
+    "ip" : "192.168.1.2",
+    "port" : "6379",
+    "proxy_multi_db" : false,
+    "password" : "DCStest123",
+    "task_status" : "RUNNING",
+    "db" : "0"
+  },
+  "created_at" : "2019/10/22 14:44:30",
+  "updated_at" : "2019/10/22 18:00:00"
+}
    
+

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Data migration task stopped successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
The request is rejected.

+
404

+
The requested resource is not found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Data Migration

+

+

+
diff --git a/docs/dcs/api-ref/TagManagement.html b/docs/dcs/api-ref/TagManagement.html
new file mode 100644
index 00000000..592f2310
--- /dev/null
+++ b/docs/dcs/api-ref/TagManagement.html
@@ -0,0 +1,20 @@
+
+
+
Tag Management

+
    

+

+
+
diff --git a/docs/dcs/api-ref/UpdateBigkeyAutoscanConfig.html b/docs/dcs/api-ref/UpdateBigkeyAutoscanConfig.html
new file mode 100644
index 00000000..d763f48d
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateBigkeyAutoscanConfig.html
@@ -0,0 +1,372 @@
+
+
+
Configuring Automatic Big Key Analysis

+
Function
This API is used to configure automatic big key analysis.

+

+
URI
PUT /v2/{project_id}/instances/{instance_id}/bigkey/autoscan

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. [For details, see Obtaining a Project ID.]

+
instance_id

+
Yes

+
String

+
Instance ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
enable_auto_scan

+
Yes

+
Boolean

+
Whether to enable scheduled cache analysis.

+
schedule_at

+
Yes

+
Array of strings

+
UTC time of the day that cache analysis is scheduled for. Example: 21:00.

+

+

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
instance_id

+
String

+
Instance ID.

+
enable_auto_scan

+
Boolean

+
Whether to enable scheduled cache analysis.

+
schedule_at

+
Array of strings

+
UTC time of the day that analysis is scheduled for. Example: 21:00.

+
updated_at

+
String

+
Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 8 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
Scheduling big key analysis tasks to start at 21:00 every day

+
PUT https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey/autoscan
+
+{
+  "enable_auto_scan" : true,
+  "schedule_at" : [ "21:00" ]
+}

+

+
Example Responses
Status code: 200

+
Big key analysis task configured successfully.

+
{
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "enable_auto_scan" : true,
+  "schedule_at" : [ "21:00" ],
+  "updated_at" : "2020-06-17T02:42:40.793Z"
+}

+
Status code: 400

+
Invalid request.

+
{
+  "error_code" : "DCS.4919",
+  "error_msg" : "Does not support bigkey analyze."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Big key analysis task configured successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
The request is rejected.

+
404

+
The requested resource is not found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Cache Analysis

+

+

+
diff --git a/docs/dcs/api-ref/UpdateConfigurations.html b/docs/dcs/api-ref/UpdateConfigurations.html
new file mode 100644
index 00000000..0fb90d15
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateConfigurations.html
@@ -0,0 +1,227 @@
+
+
+
Modifying Configuration Parameters

+
Function
You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.

+

+
URI
PUT /v2/{project_id}/instances/{instance_id}/configs

+
+

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

+
Mandatory

+
Type

+
Description

+
instance_id

+
Yes

+
String

+
Instance ID.

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
redis_config

+
No

+
Array of RedisConfig objects

+
Array of configuration items of the DCS instance.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 3 RedisConfig
Parameter

+
Mandatory

+
Type

+
Description

+
param_value

+
Yes

+
String

+
Value of the configuration item.

+
param_name

+
Yes

+
String

+
Configuration item name.

+
param_id

+
Yes

+
String

+
Configuration item ID.

+

+

+

+
Response Parameters
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
Modifying the instance configuration parameters. For example, set the timeout parameter (maximum amount of idle time after which a client connection is terminated) to 1000 seconds.

+
PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs
+
+{
+  "redis_config" : [ {
+    "param_id" : "1",
+    "param_name" : "timeout",
+    "param_value" : "1000"
+  } ]
+}

+

+
Example Responses
None

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
204

+
DCS instance configurations modified successfully.

+
400

+
Invalid request.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Parameter Management

+

+

+
diff --git a/docs/dcs/api-ref/UpdateHotkeyAutoScanConfig.html b/docs/dcs/api-ref/UpdateHotkeyAutoScanConfig.html
new file mode 100644
index 00000000..b35d0083
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateHotkeyAutoScanConfig.html
@@ -0,0 +1,372 @@
+
+
+
Configuring Automatic Hot Key Analysis

+
Function
This API is used to configure automatic hot key analysis.

+

+
URI
PUT /v2/{project_id}/instances/{instance_id}/hotkey/autoscan

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
instance_id

+
Yes

+
String

+
Instance ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
enable_auto_scan

+
Yes

+
Boolean

+
Whether to enable scheduled cache analysis.

+
schedule_at

+
Yes

+
Array of strings

+
UTC time of the day that cache analysis is scheduled for. Example: 21:00.

+

+

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
instance_id

+
String

+
Instance ID.

+
enable_auto_scan

+
Boolean

+
Whether to enable scheduled cache analysis.

+
schedule_at

+
Array of strings

+
UTC time of the day that analysis is scheduled for. Example: 21:00.

+
updated_at

+
String

+
Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 8 Response body parameters
Parameter

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
Scheduling hot key analysis tasks to start at 21:00 every day

+
PUT https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey/autoscan
+
+{
+  "enable_auto_scan" : true,
+  "schedule_at" : [ "21:00" ]
+}

+

+
Example Responses
Status code: 200

+
Automatic hot key analysis configured successfully.

+
{
+  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
+  "enable_auto_scan" : true,
+  "schedule_at" : [ "21:00" ],
+  "updated_at" : "2020-06-17T02:42:40.793Z"
+}

+
Status code: 400

+
Invalid request.

+
{
+  "error_code" : "DCS.4922",
+  "error_msg" : "Does not support hotkey analyze."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Automatic hot key analysis configured successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
The request is rejected.

+
404

+
The requested resource is not found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Cache Analysis

+

+

+
diff --git a/docs/dcs/api-ref/UpdateInstance.html b/docs/dcs/api-ref/UpdateInstance.html
new file mode 100644
index 00000000..9944b2ca
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateInstance.html
@@ -0,0 +1,357 @@
+
+
+
Modifying Details of a DCS Instance

+
Function
This API is used to modify the information about a DCS instance, including the instance name, description, port, backup policy, start and end time of the maintenance window, and security group.

+

+
URI
PUT /v2/{project_id}/instances/{instance_id}

+
+

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

+
Mandatory

+
Type

+
Description

+
instance_id

+
Yes

+
String

+
Instance ID.

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
name

+
No

+
String

+
Instance name.

+
An instance name can contain letters, digits, underscores (_), and hyphens (-) and must start with a letter.

+
When you create only one instance at a time, the value of this parameter can contain 4 to 64 characters. When you create multiple instances at a time, the value of this parameter can contain 4 to 56 characters. The instances are named in the format of custom name-n, where n starts from 000 and is incremented by 1. For example, if you create two instances and set the custom name to dcs_demo, the two instances are respectively named dcs_demo-000 and dcs_demo-001.

+
description

+
No

+
String

+
Instance description. The description can contain a maximum of 1024 characters.

+
 NOTE: 
The backslash (\) and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character (\) before the characters, for example, \\ and \".

+

+
Minimum: 0

+
Maximum: 1024

+
port

+
No

+
Integer

+
Port for connecting to the Redis instance. The port range is from 1 to 65535. After the port is changed, all connections to the Redis instance are interrupted, and services must connect to the new port. Only DCS Redis 4.0 and later instances support port change.

+
Minimum: 1

+
Maximum: 65535

+
rename_commands

+
No

+
RenameCommandResp object

+
Command renaming list.

+
maintain_begin

+
No

+
String

+
UTC time when the maintenance time window starts. The format is HH:mm:ss.

+
  • The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see Listing Maintenance Time Windows.
    
+
  • For example, the start time must be 18:00:00, 19:00:00, and so on.
    
+
  • The start time and end time must be set in pairs. If the start time is left blank, the end time must also be left blank.
    
+

+
maintain_end

+
No

+
String

+
UTC time when the maintenance time window ends. The format is HH:mm:ss.

+
  • The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see Listing Maintenance Time Windows
    
+
  • The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00.
    
+
  • The start time and end time must be set in pairs. If the end time is left blank, the start time must also be left blank.
    
+

+
security_group_id

+
No

+
String

+
Security group ID.

+
The value can be obtained from the VPC console or the API used to query the security group list.

+
This parameter is supported only by DCS Redis 3.0 instances.

+
instance_backup_policy

+
No

+
BackupPolicy object

+
Backup policy. This parameter is supported when the instance type is master/standby or cluster.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 3 RenameCommandResp
Parameter

+
Mandatory

+
Type

+
Description

+
command

+
No

+
String

+
Command COMMAND.

+
flushall

+
No

+
String

+
Command FLUSHALL.

+
flushdb

+
No

+
String

+
Command FLUSHDB.

+
hgetall

+
No

+
String

+
Command HGETALL.

+
keys

+
No

+
String

+
Command KEYS.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 4 BackupPolicy
Parameter

+
Mandatory

+
Type

+
Description

+
backup_type

+
Yes

+
String

+
Backup type.

+
  • auto: automatic backup
    
+
  • manual: manual backup
    
+

+
save_days

+
No

+
Integer

+
This parameter is mandatory when backup_type is set to manual. Retention period, in days. The value ranges from 1 to 7. The automatic backup policy is retained when automatic backup is switched to manual backup.

+
periodical_backup_plan

+
No

+
BackupPlan object

+
Backup schedule. This parameter is mandatory when backup_type is set to manual. The automatic backup policy is retained when automatic backup is switched to manual backup.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 5 BackupPlan
Parameter

+
Mandatory

+
Type

+
Description

+
timezone_offset

+
No

+
String

+
Time zone in which backup is performed. This parameter is no longer used.

+
backup_at

+
Yes

+
Array of integers

+
Day in a week on which backup starts. The value ranges from 1 to 7, where 1 indicates Monday, and 7 indicates Sunday. The automatic backup policy is retained when automatic backup is switched to manual backup.

+
period_type

+
Yes

+
String

+
Interval at which backup is performed, which supports only weekly currently. The automatic backup policy is retained when automatic backup is switched to manual backup.

+
begin_at

+
Yes

+
String

+
UTC time when the backup starts. For example, 00:00-01:00 indicates that the backup starts at 00:00 (UTC time). The value must be on the hour. The backup interval is 1 hour. The automatic backup policy is retained when automatic backup is switched to manual backup.

+

+

+

+
Response Parameters
None

+

+
Example Requests
Changing the name of a specified instance to dcs002 and port to 6379, and configuring an auto backup policy

+
PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}
+
+{
+  "name" : "dcs002",
+  "description" : "instance description",
+  "port" : 6379,
+  "maintain_begin" : "18:00:00",
+  "maintain_end" : "19:00:00",
+  "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162",
+  "instance_backup_policy" : {
+    "backup_type" : "auto",
+    "save_days" : "1,",
+    "periodical_backup_plan" : {
+      "backup_at" : [ "1", "2", "3", "4", "6", "7" ],
+      "period_type" : "weekly",
+      "begin_at" : "00:00-01:00"
+    }
+  }
+}

+

+
Example Responses
None

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
204

+
DCS instance modified successfully.

+
400

+
Invalid request.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Lifecycle Management

+

+

+
diff --git a/docs/dcs/api-ref/UpdateIpWhitelist.html b/docs/dcs/api-ref/UpdateIpWhitelist.html
index 14e11e5e..79521d90 100644
--- a/docs/dcs/api-ref/UpdateIpWhitelist.html
+++ b/docs/dcs/api-ref/UpdateIpWhitelist.html
@@ -1,298 +1,308 @@
 
 
 
Configuring IP Whitelist Groups

-
 
IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instances

-

-
Function
This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one.

+
Function
This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one. IP whitelist groups are supported only by DCS Redis 4.0/5.0/6.0 instances, and not by DCS Redis 3.0 instances.

 

-
URI
PUT /v2/{project_id}/instance/{instance_id}/whitelist

+
URI
PUT /v2/{project_id}/instance/{instance_id}/whitelist

 
-
Table 1 Path parameter
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 1 Path Parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
project_id

+
project_id

 
Yes

+
Yes

 
String

+
String

 
Project ID.

+
Project ID. For details, see Obtaining a Project ID.

 		
 
instance_id

+
instance_id

 
Yes

+
Yes

 
String

+
String

 
Instance ID.

+
Instance ID.

 		
 

 
 

 

 
-
Request Parameters

-
Table 2 Request body parameters
Parameter

+
Request Parameters

+

-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
Table 2 Request body parameters
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
enable_whitelist

+
instance_id

 
Yes

+
No

 
Boolean

+
String

 
Whether to enable the whitelist.

-
Options:

-
  • true
  • false

+
Instance ID.

 		
 
whitelist

+
enable_whitelist

 
Yes

+
Yes

 
Array of Whitelist objects

+
Boolean

 
IP whitelist group.

+
Whether to enable the whitelist. The options are true and false.

+
Enumeration values:

+
  • true
    
+
  • false
    
+

+
whitelist

+
Yes

+
Array of Whitelist objects

+
IP whitelist group. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one.

 		
 

 
 

 

 
-
Table 3 Whitelist
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 3 Whitelist
Parameter

 
Mandatory

+
Mandatory

 
Type

+
Type

 
Description

+
Description

 		
 

 
group_name

+
group_name

 
Yes

+
Yes

 
String

+
String

 
Whitelist group name. A maximum of four groups can be created for each instance.

+
Whitelist group name. A maximum of four groups can be created for each instance.

 		
 
ip_list

+
ip_list

 
Yes

+
Yes

 
Array of strings

+
Array of strings

 
List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.

+
List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.

 		
 

 
 

 

 
-
Response Parameters
Status code: 400

+
Response Parameters
Status code: 400

 
-
Table 4 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 4 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_msg

+
error_msg

 
String

+
String

 
Error information.

-
Maximum length: 1024 characters

+
Error message.

+
Maximum: 1024

 		
 
error_code

+
error_code

 
String

+
String

 
Error code.

-
Maximum length: 9 characters

+
Error code.

+
Maximum: 9

 		
 
error_ext_msg

+
error_ext_msg

 
String

+
String

 
Extended error information. This parameter is not used currently and is set to null.

-
Maximum length: 1024 characters

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

 		
 

 
 

 

-
Status code: 401

+
Status code: 401

 
-
Table 5 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 5 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_msg

+
error_msg

 
String

+
String

 
Error information.

-
Maximum length: 1024 characters

+
Error message.

+
Maximum: 1024

 		
 
error_code

+
error_code

 
String

+
String

 
Error code.

-
Maximum length: 9 characters

+
Error code.

+
Maximum: 9

 		
 
error_ext_msg

+
error_ext_msg

 
String

+
String

 
Extended error information. This parameter is not used currently and is set to null.

-
Maximum length: 1024 characters

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

 		
 

 
 

 

-
Status code: 403

+
Status code: 403

 
-
Table 6 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 6 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_msg

+
error_msg

 
String

+
String

 
Error information.

-
Maximum length: 1024 characters

+
Error message.

+
Maximum: 1024

 		
 
error_code

+
error_code

 
String

+
String

 
Error code.

-
Maximum length: 9 characters

+
Error code.

+
Maximum: 9

 		
 
error_ext_msg

+
error_ext_msg

 
String

+
String

 
Extended error information. This parameter is not used currently and is set to null.

-
Maximum length: 1024 characters

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

 		
 

 
 

 

-
Status code: 404

+
Status code: 404

 
-
Table 7 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 7 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_msg

+
error_msg

 
String

+
String

 
Error information.

-
Maximum length: 1024 characters

+
Error message.

+
Maximum: 1024

 		
 
error_code

+
error_code

 
String

+
String

 
Error code.

-
Maximum length: 9 characters

+
Error code.

+
Maximum: 9

 		
 
error_ext_msg

+
error_ext_msg

 
String

+
String

 
Extended error information. This parameter is not used currently and is set to null.

-
Maximum length: 1024 characters

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

 		
 

 
 

 

-
Status code: 500

+
Status code: 500

 
-
Table 8 Response body parameters
Parameter

+

-
-
-
-
-
-
-
-
-
-
-
Table 8 Response body parameters
Parameter

 
Type

+
Type

 
Description

+
Description

 		
 

 
error_msg

+
error_msg

 
String

+
String

 
Error information.

-
Maximum length: 1024 characters

+
Error message.

+
Maximum: 1024

 		
 
error_code

+
error_code

 
String

+
String

 
Error code.

-
Maximum length: 9 characters

+
Error code.

+
Maximum: 9

 		
 
error_ext_msg

+
error_ext_msg

 
String

+
String

 
Extended error information. This parameter is not used currently and is set to null.

-
Maximum length: 1024 characters

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

 		
 

 
 

 

 
-
Example Request
PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
+
Example Requests
  • Enabling the whitelist and configuring IP addresses allowed to access the instance
    
+
    PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
 
 {
   "enable_whitelist" : true,
@@ -301,56 +311,59 @@
     "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
   } ]
 }
    
+
  • Enabling the whitelist and configuring subnet mask allowed to access the instance.
    
+
    PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
    
+

 

-
Example Response
None

+
Example Responses
None

 

-
Status Codes

-
Status Code

+
Status Codes

+

-
-
-
-
-
-
-
-
-
-
-
-
-
Status Code

 
Description

+
Description

 		
 

 
204

+
204

 
IP whitelist groups configured successfully.

+
IP whitelist groups configured successfully.

 		
 
400

+
400

 
Invalid request.

+
Invalid request.

 		
 
401

+
401

 
Invalid authentication information.

+
Invalid authentication information.

 		
 
403

+
403

 
The request is rejected.

+
The request is rejected.

 		
 
404

+
404

 
The requested resource could not be found.

+
The requested resource is not found.

 		
 
500

+
500

 
Internal service error

+
Internal service error.

 		
 

 
 

 

 

-
Error Codes
See Error Codes.

+
Error Codes
See Error Codes.

 

 

 

 

-
Parent topic: Network Security

+
Parent topic: Network Security

 

 

 
diff --git a/docs/dcs/api-ref/UpdateMigrationTask.html b/docs/dcs/api-ref/UpdateMigrationTask.html
new file mode 100644
index 00000000..901f6729
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateMigrationTask.html
@@ -0,0 +1,316 @@
+
+
+
Configuring Auto-Reconnect for Migration Tasks

+
Function
This API is used to configure auto-reconnect for migration tasks.

+

+
URI
PUT /v2/{project_id}/migration-task/{task_id}

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
task_id

+
Yes

+
String

+
ID of the data migration task.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
resume_mode

+
No

+
String

+
Reconnection mode of the migration tasks.

+
Enumeration values:

+
  • **auto**: automatically reconnect
    
+
  • **manual**: manually reconnect
    
+

+

+

+

+
Response Parameters
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
PUT https://{dcs_endpoint}/v2/{project_id}/migration-task/{task_id}
+
+{
+  "resume_mode" : "auto"
+}

+

+
Example Responses
Status code: 400

+
Invalid request.

+
{
+  "error_code" : "111400063",
+  "error_msg" : "Invalid {0} parameter in the request."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Details of the background task queried successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
Request rejected.

+
404

+
The requested resource could not be found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Data Migration

+

+

+
diff --git a/docs/dcs/api-ref/UpdatePassword.html b/docs/dcs/api-ref/UpdatePassword.html
new file mode 100644
index 00000000..505dfbd3
--- /dev/null
+++ b/docs/dcs/api-ref/UpdatePassword.html
@@ -0,0 +1,259 @@
+
+
+
Changing the Password

+
Function
This API is used to change the password of a DCS instance.

+

+
URI
PUT /v2/{project_id}/instances/{instance_id}/password

+
+

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

+
Mandatory

+
Type

+
Description

+
instance_id

+
Yes

+
String

+
Instance ID.

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
old_password

+
Yes

+
String

+
Old password.

+
new_password

+
Yes

+
String

+
New password.

+

+

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
lock_time

+
String

+
Lock duration. If the authentication fails and the account is locked, a response is returned and is not null.

+
result

+
String

+
Password change result:

+
  • success: Password is changed successfully.
    
+
  • passwordFailed: Password authentication failed.
    
+
  • locked: The account has been locked.
    
+
  • failed: Password change failed.
    
+

+
Enumeration values:

+
  • success
    
+
  • passwordFailed
    
+
  • locked
    
+
  • failed
    
+

+
lock_time_left

+
String

+
Remaining time before the account is unlocked. When the account is locked, a response is returned and is not null.

+
retry_times_left

+
String

+
Number of remaining password attempts. If the authentication fails, a response is returned and is not null.

+
message

+
String

+
Modification result description.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
Changing the password of the DCS instance by entering the old and new passwords

+
PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password
+
+{
+  "old_password" : "XXXXXX",
+  "new_password" : "XXXXXX"
+}

+

+
Example Responses
Status code: 200

+
Password is changed successfully.

+
{
+  "lock_time" : "0",
+  "result" : "success",
+  "lock_time_left" : "0",
+  "retry_times_left" : "5",
+  "message" : "Modify DCSInstance password success."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
Password is changed successfully.

+
400

+
Invalid request.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Instance Management

+

+

+
diff --git a/docs/dcs/api-ref/UpdateSSLSwitch.html b/docs/dcs/api-ref/UpdateSSLSwitch.html
new file mode 100644
index 00000000..921eba85
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateSSLSwitch.html
@@ -0,0 +1,237 @@
+
+
+
Enabling or Disabling SSL

+
Function
This API is used to enable or disable SSL. This API is only supported by DCS Redis 6.0 instances.

+

+
URI
PUT /v2/{project_id}/instances/{instance_id}/ssl

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
instance_id

+
Yes

+
String

+
Instance ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
enabled

+
Yes

+
Boolean

+
Enabling or disabling SSL.

+
Enumeration values:

+
  • true
    
+
  • false
    
+

+

+

+

+
Response Parameters
Status code: 200

+
+

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

+
Type

+
Description

+
job_id

+
String

+
DCS task ID.

+
instance_id

+
String

+
Instance ID.

+
result

+
String

+
Execution result.

+

+

+
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl
+
+{
+  "enabled" : true
+}

+

+
Example Responses
Status code: 200

+
SSL enabled or disabled.

+
{
+  "job_id" : "ff8080817fe01bb2017fe3cf68860481",
+  "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
+  "result" : "success"
+}

+
Status code: 400

+
Invalid request.

+
{
+  "error_code" : "DCS.4201",
+  "error_msg" : "Do not support SSL."
+}

+
Status code: 500

+
Internal service error.

+
{
+  "error_code" : "DCS.5010",
+  "error_msg" : "Failed to operate SSL in database."
+}

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
200

+
SSL enabled or disabled.

+
400

+
Invalid request.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Network Security

+

+

+
diff --git a/docs/dcs/api-ref/UpdateSlavePriority.html b/docs/dcs/api-ref/UpdateSlavePriority.html
new file mode 100644
index 00000000..ad0ac1c6
--- /dev/null
+++ b/docs/dcs/api-ref/UpdateSlavePriority.html
@@ -0,0 +1,326 @@
+
+
+
Configuring Replica Priority

+
Function
This API is used to configure the replica priority. When the master node is faulty, a replica with a smaller weight has a higher priority to be promoted to master.

+

+
URI
POST /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/slave-priority

+
+

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

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID. For details, see Obtaining a Project ID.

+
instance_id

+
Yes

+
String

+
Instance ID.

+
group_id

+
Yes

+
String

+
Shard ID.

+
node_id

+
Yes

+
String

+
Node ID.

+

+

+

+
Request Parameters

+

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

+
Mandatory

+
Type

+
Description

+
slave_priority_weight

+
Yes

+
Integer

+
Replica priority. The value ranges from 0 to 100. Value 0 indicates that the promotion is disabled by default.

+

+

+

+
Response Parameters
Status code: 400

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 401

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 403

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 404

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+
Status code: 500

+
+

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

+
Type

+
Description

+
error_msg

+
String

+
Error message.

+
Maximum: 1024

+
error_code

+
String

+
Error code.

+
Maximum: 9

+
error_ext_msg

+
String

+
Extended error information. This parameter is not used currently and is set to null.

+
Maximum: 1024

+

+

+

+
Example Requests
Setting the replica priority to 100

+
POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/replications/{node_id}/slave-priority
+
+{
+  "slave_priority_weight" : 100
+}

+

+
Example Responses
None

+

+
Status Codes

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status Code

+
Description

+
204

+
Replica priority configured successfully.

+
400

+
Invalid request.

+
401

+
Invalid authentication information.

+
403

+
The request is rejected.

+
404

+
The requested resource is not found.

+
500

+
Internal service error.

+

+

+

+
Error Codes
See Error Codes.

+

+

+

+

+
Parent topic: Shards and Replicas

+

+

+
diff --git a/docs/dcs/api-ref/api-grant-policy.html b/docs/dcs/api-ref/api-grant-policy.html
new file mode 100644
index 00000000..6c83cbc9
--- /dev/null
+++ b/docs/dcs/api-ref/api-grant-policy.html
@@ -0,0 +1,636 @@
+
+
+
Permissions Policies and Supported Actions

+
This chapter describes fine-grained permissions management for your DCS. If your account does not need individual IAM users, you can skip the configurations described in this chapter.

+
By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on cloud services based on the permissions.

+
You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user 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.

+
 
You can use policies to allow or deny access to specific APIs.

+

+
An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. 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 ECSs using an API, the user must have been granted permissions that allow the dcs:servers:list action.

+
Supported Actions
DCS provides system-defined policies, which can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Actions supported by policies are specific to APIs. Common concepts related to policies include:

+
  • Permissions: Allow or deny certain operations.
  • APIs: REST APIs that can be called in a custom policy.
  • Actions: Added to a custom policy to control permissions for specific operations.
  • Dependent actions: When assigning permissions for an action, you also need to assign permissions for the dependent actions.
  • IAM and 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 Project. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. The check mark (√) indicates that the action supports the project and the cross symbol (×) indicates that the action does not support the project. 

+
The following table lists the API actions supported by DCS.

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 1 DCS actions
Permission

+
Action

+
API

+
IAM Projects

+
Enterprise Project

+
Creating a DCS instance

+
dcs:instance:create

+
POST /v2/{project_id}/instances

+
√

+
√

+
Querying an instance

+
dcs:instance:get

+
GET /v2/{project_id}/instances/{instance_id}

+
√

+
√

+
Modifying the information about an instance

+
dcs:instance:modify

+
PUT /v2/{project_id}/instances/{instance_id}

+
√

+
√

+
Deleting an instance

+
dcs:instance:delete

+
DELETE /v2/{project_id}/instances/{instance_id}

+
√

+
√

+
Expanding instance capacity

+
dcs:instance:scale

+
POST /v2/{project_id}/instances/{instance_id}/resize

+
√

+
√

+
Querying all instances

+
dcs:instance:list

+
GET /v2/{project_id}/instances

+
√

+
√

+
Querying instance configuration parameters

+
dcs:instance:getConfiguration

+
GET /v2/{project_id}/instances/{instance_id}/configs

+
√

+
√

+
Modifying instance configuration parameters

+
dcs:instance:modifyConfigureation

+
PUT /v2/{project_id}/instances/{instance_id}/configs

+
√

+
√

+
Restarting an instance or clearing instance data

+
dcs:instance:modifyStatus

+
PUT /v2/{project_id}/instances/status

+
√

+
√

+
Changing the instance password

+
dcs:instance:modifyAuthInfo

+
PUT /v2/{project_id}/instances/{instance_id}/password

+
√

+
√

+
Backing up an instance

+
dcs:instance:backupData

+
POST /v2/{project_id}/instances/{instance_id}/backups

+
√

+
√

+
Restoring an instance

+
dcs:instance:restoreData

+
POST /v2/{project_id}/instances/{instance_id}/restores

+
√

+
√

+
Querying backup records

+
dcs:instance:getDataBackupLog

+
GET /v2/{project_id}/instances/{instance_id}/backups

+
√

+
√

+
Querying restoration records

+
dcs:instance:getDataRestoreLog

+
GET /v2/{project_id}/instances/{instance_id}/restores

+
√

+
√

+
Deleting backup files

+
dcs:instance:deleteDataBackupFile

+
DELETE /v2/{project_id}/instances/{instance_id}/backups/{backup_id}

+
√

+
√

+
Listing background tasks

+
dcs:instance:getBackgroundTask

+
GET /v2/{project_id}/instances/{instance_id}/tasks

+
√

+
√

+
Deleting a background task

+
dcs:instance:deleteBackgroundTask

+
DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}

+
√

+
√

+
Resetting the instance password

+
dcs:instance:resetAuthInfo

+
POST /v2/{project_id}/instances/{instance_id}/password/reset

+
√

+
√

+
Downloading backup files

+
dcs:instance:downloadBackupData

+
POST /v2/{project_id}/instances/{instance_id}/backups/{backup_id}/links

+
√

+
√

+
Web CLI

+
dcs:instance:webcli

+
-

+
√

+
√

+
Creating a migration task

+
dcs:migrationTask:create

+
POST /v2/{project_id}/migration-task

+
√

+
X

+
Modifying migration task configurations or stopping a migration task

+
dcs:migrationTask:modify

+
POST /v2/{project_id}/migration-task/{task_id}/stop

+
√

+
X

+
Deleting a migration task

+
dcs:migrationTask:delete

+
DELETE /v2/{project_id}/migration-tasks/delete

+
√

+
X

+
Listing migration tasks

+
dcs:migrationTask:list

+
GET /v2/{project_id}/migration-tasks

+
√

+
X

+
Querying details of a data migration task

+
dcs:migrationTask:get

+
GET /v2/{project_id}/migration-task/{task_id}

+
√

+
X

+
Diagnosing an instance

+
dcs:instance:diagnosis

+
POST /v2/{project_id}/instances/{instance_id}/diagnosis

+
√

+
√

+
Viewing parameter templates

+
dcs:template:list

+
GET /v2/{project_id}/config-templates

+
√

+
X

+
Creating a parameter template

+
dcs:template:create

+
POST /v2/{project_id}/config-templates

+
√

+
X

+
Performing a master/standby switchover

+
dcs:instance:swap

+
POST /v2/{project_id}/instances/{instance_id}/swap

+
√

+
√

+
Modifying the whitelist of an instance

+
dcs:whitelist:modify

+
PUT /v2/{project_id}/instance/{instance_id}/whitelist

+
√

+
√

+
Obtaining the whitelist of an instance

+
dcs:whitelist:list

+
GET /v2/{project_id}/instance/{instance_id}/whitelist

+
√

+
√

+
Creating a user for accessing an instance

+
dcs:aclaccount:create

+
POST /v2/{project_id}/instances/{instance_id}/accounts

+
√

+
√

+
Deleting an instance user

+
dcs:aclaccount:delete

+
DELETE /v2/{project_id}/instances/{instance_id}/accounts/{account_id}

+
√

+
√

+
Modifying the information about an instance user

+
dcs:aclaccount:modify

+
PUT /v2/{project_id}/instances/{instance_id}/accounts/{account_id}

+
√

+
√

+
Obtaining the list of instance users

+
dcs:aclaccount:list

+
GET /v2/{project_id}/instances/{instance_id}/accounts

+
√

+
√

+
Querying slow logs

+
dcs:slowlog:list

+
GET /v2/{project_id}/instances/{instance_id}/slowlog

+
√

+
√

+
Viewing parameter templates

+
dcs:template:get

+
-

+
√

+
X

+
Viewing the task progress

+
dcs:job:get

+
-

+
√

+
√

+
Viewing audit logs

+
dcs:auditlog:get

+
-

+
√

+
√

+
Querying instance upgrade information

+
dcs:instance:getUpgradeInfo

+
-

+
√

+
√

+
Querying SSL encryption of an instance

+
dcs:ssl:get

+
-

+
√

+
√

+
Updating domain names

+
dcs:domainname:rebuild

+
-

+
√

+
√

+
Switching IP addresses

+
dcs:migrationTask:exchangeIp

+
-

+
√

+
X

+
Rolling back IP address switching

+
dcs:migrationTask:rollbackIp

+
-

+
√

+
X

+
Killing Redis sessions

+
dcs:clients:kill

+
-

+
√

+
√

+
Modifying a parameter template

+
dcs:template:modify

+
-

+
√

+
X

+
Enabling or disabling public domain name resolution

+
dcs:publicdomainname:update

+
-

+
√

+
√

+
Deleting a parameter template

+
dcs:template:delete

+
-

+
√

+
X

+
Releasing historical domain names

+
dcs:histroydomainname:release

+
-

+
√

+
√

+
Upgrading the instance version

+
dcs:instance:upgrade

+
-

+
√

+
√

+
Analyzing big or hot keys

+
dcs:instance:analyze

+
-

+
√

+
√

+
Enabling or disabling audit logging

+
dcs:auditlog:modify

+
-

+
√

+
√

+
Enabling or disabling client IP pass-through

+
dcs:clientiptrans:modify

+
-

+
√

+
√

+
Modifying SSL encryption for an instance

+
dcs:ssl:modify

+
-

+
√

+
√

+
Querying the Redis session list

+
dcs:clients:list

+
-

+
√

+
√

+

+

+

+
diff --git a/docs/dcs/api-ref/dcs-api-0312003.html b/docs/dcs/api-ref/dcs-api-0312003.html
index 601fbc17..74f32b20 100644
--- a/docs/dcs/api-ref/dcs-api-0312003.html
+++ b/docs/dcs/api-ref/dcs-api-0312003.html
@@ -19,5 +19,9 @@
 
  • Scaling Up a DCS Instance
    
 
    • 
 
+
+
    
+
    Parent topic: Outdated APIs (V1)
    
+
    
 
 
diff --git a/docs/dcs/api-ref/dcs-api-0312004.html b/docs/dcs/api-ref/dcs-api-0312004.html
index fe504532..38c7830b 100644
--- a/docs/dcs/api-ref/dcs-api-0312004.html
+++ b/docs/dcs/api-ref/dcs-api-0312004.html
@@ -1,29 +1,29 @@
 
 
 
    Creating a DCS Instance
    
-
    Function
    This API is used to create a DCS instance.
    
-
     
    The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.
    
+
    Function
    This API is used to create a DCS instance.
    
+
     
    The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.
    
 
    
 
    
-
    URI
    POST /v1.0/{project_id}/instances
    
-
    Table 1 describes the parameter.
-
    Table 1 Parameter description
    Parameter
    
+
    URI
    POST /v1.0/{project_id}/instances
    
+
    Table 1 describes the parameter.
+
    
-
-
-
-
-
-
-
@@ -31,391 +31,391 @@
 
-
    Request
    Request parameters
    
-
    Table 2 describes the request parameters.
    
+
    Request
    Request parameters
    
+
    Table 2 describes the request parameters.
    
 
-
    Table 1 Parameter description
    Parameter
    
 
    Type
    
+
    Type
    
 
    Mandatory
    
+
    Mandatory
    
 
    Description
    
+
    Description
    
     		
 
    
 
    project_id
    
+
    project_id
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
    
+
    Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
    
     		
 
    
     
 
 
    Table 2 Parameter description
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 2 Parameter description
    Parameter
    
 
    Type
    
+
    Type
    
 
    Mandatory
    
+
    Mandatory
    
 
    Description
    
+
    Description
    
     		
 
    
 
    name
    
+
    name
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    DCS instance name.
    
-
    An instance name can contain 4 to 64 characters and must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.
    
+
    DCS instance name.
    
+
    An instance name can contain 4 to 64 characters and must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.
    
     		
 
    description
    
+
    description
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Brief description of the DCS instance.
    
-
    The description supports up to 1024 characters.
    
-
     NOTE: 
    The backslash (\) and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character (\) before the characters, for example, \\ and \".
    
+
    Brief description of the DCS instance.
    
+
    The description supports up to 1024 characters.
    
+
     NOTE: 
    The backslash (\) and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character (\) before the characters, for example, \\ and \".
    
 
    
     		
 
    engine
    
+
    engine
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    Cache engine. Value: Redis.
    
+
    Cache engine. Value: Redis.
    
     		
 
    engine_version
    
+
    engine_version
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    Cache engine version. If the cache engine is Redis, the value can be 3.0, 4.0, or 5.0.
    
+
    Cache engine version. If the cache engine is Redis, the value can be 3.0, 4.0, 5.0, or 6.0.
    
     		
 
    spec_code
    
+
    spec_code
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    DCS instance specification code.
    
-
    To obtain the value, go to the instance creation page on the DCS console, and view Flavor Name in the Instance Specification table.
    
+
    DCS instance specification code.
    
+
    To obtain the value, go to the instance creation page on the DCS console, and view Flavor Name in the Instance Specification table.
    
     		
 
    capacity
    
+
    capacity
    
 
    Float
    
+
    Float
    
 
    Yes
    
+
    Yes
    
 
    Cache capacity. Unit: GB.
    
-
    • For a single-node or master/standby DCS Redis 3.0 instance, the value can be 2, 4, 8, 16, 32, or 64. For a Proxy Cluster DCS Redis 3.0 instance, the value can be 64, 128, 256, 512, or 1024.
    • For a single-node or master/standby DCS Redis 4.0 or 5.0 instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 24, 48, or 64. For a Redis Cluster DCS Redis 4.0 or 5.0 instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024.
    
+
    Cache capacity. Unit: GB.
    
+
    • For a single-node or master/standby DCS Redis 3.0 instance, the value can be 2, 4, 8, 16, 32, or 64. For a Proxy Cluster DCS Redis 3.0 instance, the value can be 64, 128, 256, 512, or 1024.
    • For a single-node or master/standby DCS Redis 4.0 or later instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 24, 48, or 64. For a cluster DCS Redis instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024. 
    
     		
 
    no_password_access
    
+
    no_password_access
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    An indicator of whether a DCS instance can be accessed in password-free mode.
    
-
    • true: indicates that a DCS instance can be accessed without a password.
    • false: indicates that a DCS instance can be accessed only after password authentication.
    
-
    Default value: false.
    
+
    An indicator of whether a DCS instance can be accessed in password-free mode.
    
+
    • true: indicates that a DCS instance can be accessed without a password.
    • false: indicates that a DCS instance can be accessed only after password authentication.
    
+
    Default value: false.
    
     		
 
    password
    
+
    password
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Password of a DCS instance.
    
-
     NOTE: 
    If no_password_access is set to false or not set, the request must contain the password parameter.
    
+
    Password of a DCS instance.
    
+
     NOTE: 
    If no_password_access is set to false or not set, the request must contain the password parameter.
    
 
    
-
    The password of a DCS Redis instance must meet the following complexity requirements:
    
-
    • Must be a string consisting of 8 to 32 characters.
    • Must be different from the old password.
    • Contains at least three of the following character types:
      • Lowercase letters
      • Uppercase letters
      • Digits
      • Special characters (`~!@#$^&*()-_=+\|{}:,<.>/?)
      
+
      The password of a DCS Redis instance must meet the following complexity requirements:
      
+
      • Must be a string consisting of 8 to 64 characters.
      • Must be different from the old password.
      • Contains at least three of the following character types:
        • Lowercase letters
        • Uppercase letters
        • Digits
        • Special characters (`~!@#$^&*()-_=+\|{},<.>/?)
        
 
      
 
    		
 
    vpc_id
    
+
    vpc_id
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    VPC ID.
    
-
    Obtain the value by using either of the following methods:
    
-
    • Method 1: Log in to VPC console and view the VPC ID in the VPC details.
    • Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the Virtual Private Cloud API Reference.
    
+
    VPC ID.
    
+
    Obtain the value by using either of the following methods:
    
+
    • Method 1: Log in to VPC console and view the VPC ID in the VPC details.
    • Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the Virtual Private Cloud API Reference.
    
     		
 
    security_group_id
    
+
    security_group_id
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    ID of the security group which the instance belongs to.
    
-
    This parameter is mandatory when the engine is Redis and engine_version is 3.0. DCS Redis 3.0 instances support security group access control.
    
-
    This parameter is optional when the engine is Redis and engine_version is 4.0 or 5.0. DCS Redis 4.0 and 5.0 instances do not support security groups.
    
-
    Obtain the value by using either of the following methods:
    
-
    • Method 1: Log in to the VPC console and view the security group ID on the security group details page.
    • Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
    
+
    ID of the security group which the instance belongs to.
    
+
    This parameter is mandatory when the engine is Redis and engine_version is 3.0. DCS Redis 3.0 instances support security group access control.
    
+
    This parameter is optional when the engine is Redis and engine_version is 4.0 or 5.0. DCS Redis 4.0 and 5.0 instances do not support security groups.
    
+
    Obtain the value by using either of the following methods:
    
+
    • Method 1: Log in to the VPC console and view the security group ID on the security group details page.
    • Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
    
     		
 
    subnet_id
    
+
    subnet_id
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    Network ID of the subnet.
    
-
    Obtain the value by using either of the following methods:
    
-
    • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.
    • Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the Virtual Private Cloud API Reference.
    
+
    Network ID of the subnet.
    
+
    Obtain the value by using either of the following methods:
    
+
    • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.
    • Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the Virtual Private Cloud API Reference.
    
     		
 
    available_zones
    
+
    available_zones
    
 
    Array
    
+
    Array
    
 
    Yes
    
+
    Yes
    
 
    ID of the AZ where the cache node resides and which has available resources. For details on how to obtain the value, see Querying AZ Information. Check whether the AZ has available resources.
    
-
    Master/Standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate multiple AZs. For details, see the example request.
    
+
    ID of the AZ where the cache node resides and which has available resources. For details on how to obtain the value, see Querying AZ Information. Check whether the AZ has available resources.
    
+
    Master/Standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate multiple AZs. For details, see the example request.
    
     		
 
    product_id
    
+
    product_id
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    ID of the product that can be created. For details, see Querying Service Specifications.
    
-
    The parameter value is in the format of spec_code-Abbreviation of the billing mode. The abbreviation of the billing mode can only be h, indicating pay-per-use.
    
-
    For example, redis.single.au1.large.1-h indicates a pay-per-use product whose specification code is redis.single.au1.large.1.
    
-
     NOTE: 
    When obtaining the product ID from the product specifications, ensure that the billing mode specified in the product ID is the same as the selected billing mode. For example, to buy a master/standby DCS Redis 3.0 instance billed in pay-per-use mode, you can search for the product ID corresponding to the record whose charging_type is Hourly and spec_code is dcs.master_standby in the response message.
    
+
    ID of the product that can be created. For details, see Querying Service Specifications.
    
+
    The parameter value is in the format of spec_code-Abbreviation of the billing mode. The abbreviation of the billing mode can only be h, indicating pay-per-use.
    
+
    For example, redis.single.au1.large.1-h indicates a pay-per-use product whose specification code is redis.single.au1.large.1.
    
+
     NOTE: 
    When obtaining the product ID from the product specifications, ensure that the billing mode specified in the product ID is the same as the selected billing mode. For example, to buy a master/standby DCS Redis 3.0 instance billed in pay-per-use mode, you can search for the product ID corresponding to the record whose charging_type is Hourly and spec_code is dcs.master_standby in the response message.
    
 
    
     		
 
    instance_backup_policy
    
+
    instance_backup_policy
    
 
    Object
    
+
    Object
    
 
    No
    
+
    No
    
 
    Backup policy.
    
-
    This parameter is available for master/standby and cluster DCS instances. For details, see Table 3 and Table 4.
    
+
    Backup policy.
    
+
    This parameter is available for master/standby and cluster DCS instances. For details, see Table 3 and Table 4.
    
     		
 
    enable_publicip
    
+
    enable_publicip
    
 
    Boolean
    
+
    Boolean
    
 
    No
    
+
    No
    
 
    An indicator of whether to enable public access for a DCS Redis instance.
    
-
    • true: enable.
    • false: disable.
    
+
    An indicator of whether to enable public access for a DCS Redis instance.
    
+
    • true: enable.
    • false: disable.
    
     		
 
    publicip_id
    
+
    publicip_id
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    ID of the elastic IP address bound to a DCS Redis instance.
    
-
    This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).
    
+
    ID of the elastic IP address bound to a DCS Redis instance.
    
+
    This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).
    
     		
 
    enable_ssl
    
+
    enable_ssl
    
 
    Boolean
    
+
    Boolean
    
 
    No
    
+
    No
    
 
    An indicator of whether to enable SSL for public access to a DCS Redis instance.
    
-
    • true: enable.
    • false: disable.
    
+
    An indicator of whether to enable SSL for public access to a DCS Redis instance.
    
+
    • true: enable.
    • false: disable.
    
     		
 
    maintain_begin
    
+
    maintain_begin
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Time at which the maintenance time window starts.
    
-
    Format: hh:mm:ss.
    
-
    • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
    • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
    • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_start is left blank, parameter maintain_end is also blank. In this case, the system automatically set the start time to 02:00:00.
    
+
    Time at which the maintenance time window starts.
    
+
    Format: hh:mm:ss.
    
+
    • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
    • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
    • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_start is left blank, parameter maintain_end is also blank. In this case, the system automatically set the start time to 02:00:00.
    
     		
 
    maintain_end
    
+
    maintain_end
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Time at which the maintenance time window ends.
    
-
    Format: hh:mm:ss.
    
-
    • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
    
-
    • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
    • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank. In this case, the system automatically set the end time to 06:00:00.
    
+
    Time at which the maintenance time window ends.
    
+
    Format: hh:mm:ss.
    
+
    • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
    
+
    • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
    • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank. In this case, the system automatically set the end time to 06:00:00.
    
     		
 
    enterprise_project_id
    
+
    enterprise_project_id
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Enterprise project ID.
    
+
    Enterprise project ID.
    
     		
 
    enterprise_project_name
    
+
    enterprise_project_name
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Enterprise project name.
    
+
    Enterprise project name.
    
     		
 
    instance_num
    
+
    instance_num
    
 
    Integer
    
+
    Integer
    
 
    No
    
+
    No
    
 
    Number of instances to be created in batches. 
    
-
    Default value: 1.
    
-
    Value range: 1–100.
    
+
    Number of instances to be created in batches. 
    
+
    Default value: 1.
    
+
    Value range: 1–100.
    
     		
 
    private_ips
    
+
    private_ips
    
 
    Array of strings
    
+
    Array of strings
    
 
    No
    
+
    No
    
 
    IP address that is manually specified for a DCS instance.
    
+
    IP address that is manually specified for a DCS instance.
    
     		
 
    port
    
+
    port
    
 
    Integer
    
+
    Integer
    
 
    No
    
+
    No
    
 
    Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 instances.
    
-
    If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, the default port 6379 will be used. To customize a port, specify a port number in the range from 1 to 65535.
    
+
    Port customization , which is supported only by Redis 4.0 and later instances and not by Redis 3.0 instances.
    
+
    If this parameter is not sent or is left empty when you create a Redis instance, the default port 6379 will be used. To customize a port, specify a port number in the range from 1 to 65535.
    
     		
 
    rename_commands
    
+
    rename_commands
    
 
    Object
    
+
    Object
    
 
    No
    
+
    No
    
 
    Critical command renaming, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 instances.
    
-
    If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, no critical command will be renamed. Currently, only COMMAND, KEYS, FLUSHDB, FLUSHALL, and HGETALL commands can be renamed.
    
+
    Critical command renaming , which is supported only by Redis 4.0 and later instances and not by Redis 3.0 instances.
    
+
    If this parameter is not sent or is left empty when you create a Redis instance, no critical command will be renamed. Currently, you can rename the COMMAND, KEYS, FLUSHDB, FLUSHALL, HGETALL, SCAN, HSCAN, SSCAN, and ZSCAN commands.
    
     		
 
    
     
 
    
 
    
 
-
    Table 3 instance_backup_policy parameter description
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 3 instance_backup_policy parameter description
    Parameter
    
 
    Type
    
+
    Type
    
 
    Mandatory
    
+
    Mandatory
    
 
    Description
    
+
    Description
    
     		
 
    
 
    save_days
    
+
    save_days
    
 
    Integer
    
+
    Integer
    
 
    No
    
+
    No
    
 
    This parameter is mandatory when backup_type is set to manual.
    
-
    Retention period.
    
-
    Unit: day.
    
-
    Value range: 1–7.
    
+
    This parameter is mandatory when backup_type is set to manual.
    
+
    Retention period.
    
+
    Unit: day.
    
+
    Value range: 1–7.
    
     		
 
    backup_type
    
+
    backup_type
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Backup type.
    
-
    Options:
    
-
    • auto: automatic backup.
    • manual: manual backup.
    
-
    The default value is manual.
    
+
    Backup type.
    
+
    Options:
    
+
    • auto: automatic backup.
    • manual: manual backup.
    
+
    The default value is manual.
    
     		
 
    periodical_backup_plan
    
+
    periodical_backup_plan
    
 
    Object
    
+
    Object
    
 
    Yes
    
+
    Yes
    
 
    Backup plan. For details, see Table 4.
    
+
    Backup plan. For details, see Table 4.
    
     		
 
    
     
 
    
 
    
 
-
    Table 4 periodical_backup_plan parameter description
    Parameter
    
+
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Table 4 periodical_backup_plan parameter description
    Parameter
    
 
    Type
    
+
    Type
    
 
    Mandatory
    
+
    Mandatory
    
 
    Description
    
+
    Description
    
     		
 
    
 
    begin_at
    
+
    begin_at
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    Time at which backup starts.
    
-
    "00:00-01:00" indicates that backup starts at 00:00:00.
    
+
    Time at which backup starts.
    
+
    "00:00-01:00" indicates that backup starts at 00:00:00.
    
     		
 
    period_type
    
+
    period_type
    
 
    String
    
+
    String
    
 
    Yes
    
+
    Yes
    
 
    Interval at which backup is performed.
    
-
    Currently, only weekly backup is supported.
    
+
    Interval at which backup is performed.
    
+
    Currently, only weekly backup is supported.
    
     		
 
    backup_at
    
+
    backup_at
    
 
    Array
    
+
    Array
    
 
    Yes
    
+
    Yes
    
 
    Day in a week on which backup starts.
    
-
    Value range: 1–7, where 1 indicates Monday and 7 indicates Sunday.
    
+
    Day in a week on which backup starts.
    
+
    Value range: 1–7, where 1 indicates Monday and 7 indicates Sunday.
    
     		
 
    timezone_offset
    
+
    timezone_offset
    
 
    String
    
+
    String
    
 
    No
    
+
    No
    
 
    Time zone in which backup is performed.
    
-
    Value range: GMT–12:00 to GMT+12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default.
    
+
    Time zone in which backup is performed.
    
+
    Value range: GMT–12:00 to GMT+12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default.
    
     		
 
    
     
 
    
 
    
-
    Example request
    
-
    • Request URL:
      POST https://{dcs_endpoint}/v1.0/{project_id}/instances
      
+
      Example request
      
+
      • Request URL:
        POST https://{dcs_endpoint}/v1.0/{project_id}/instances
        
 
      
-
      • Example:
        Creating a DCS Redis instance
        {
+
        • Example:
          Creating a DCS Redis instance
          {
     "name": "dcs-APITest",
     "description": "Test",
     "engine": "Redis",
@@ -443,28 +443,28 @@
 
          
 
        
 
        
-
        Response
        Response parameters
        
-
        Table 5 describes the response parameters.
-
        Table 5 Parameter description
        Parameter
        
+
        Response
        Response parameters
        
+
        Table 5 describes the response parameters.
+
        
-
-
-
-
-
-
-
-
@@ -472,33 +472,33 @@
 
 
-
        Table 5 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        instances
        
+
        instances
        
 
        Array of Objects
        
+
        Array of Objects
        
 
        DCS instance list. For details, see Table 6.
        
+
        DCS instance list. For details, see Table 6.
        
         		
 
        
         
 
        Table 6 instances parameters
        Parameter
        
+
        
-
-
-
-
-
-
-
-
        Table 6 instances parameters
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        instance_name
        
+
        instance_name
        
 
        String
        
+
        String
        
 
        DCS instance name.
        
+
        DCS instance name.
        
         		
 
        
         
 
        
 
        
-
        Example response
        
-
        {
+
        Example response
        
+
        {
     "instances": [
         {
             "instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f",
@@ -508,17 +508,17 @@
     "instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f"
 }
        
 
-
        Status Code
        Table 7 describes the status code of successful operations. For details about other status codes, see Table 1. 
        
+
        Status Code
        Table 7 describes the status code of successful operations. For details about other status codes, see Table 1. 
        
 
-
        Table 7 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312005.html b/docs/dcs/api-ref/dcs-api-0312005.html
index 2752614b..4715f4b4 100644
--- a/docs/dcs/api-ref/dcs-api-0312005.html
+++ b/docs/dcs/api-ref/dcs-api-0312005.html
@@ -1,36 +1,36 @@
 
        Querying a DCS Instance
        
-
        Function
        This API is used to query the details about a specified DCS instance.
        
+
        Function
        This API is used to query the details about a specified DCS instance.
        
 
        
-
        URI
        GET /v1.0/{project_id}/instances/{instance_id}
        
-
        Table 1 describes the parameters.
-
        Table 7 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        DCS instance created successfully.
        
+
        DCS instance created successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        GET /v1.0/{project_id}/instances/{instance_id}
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -38,599 +38,599 @@
 
-
        Request
        Request parameters
        
-
        None
        
-
        Example request
        
-
        Request URL:
        
-
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
        
+
        Request
        Request parameters
        
+
        None
        
+
        Example request
        
+
        Request URL:
        
+
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
        
 
        
-
        Response
        Response parameters
        
-
        Table 2 describes the response parameters.
        
+
        Response
        Response parameters
        
+
        Table 2 describes the response parameters.
        
 
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        ID of the instance to be queried
        
+
        ID of the instance to be queried
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        name
        
+
        name
        
 
        String
        
+
        String
        
 
        DCS instance name.
        
+
        DCS instance name.
        
         		
 
        engine
        
+
        engine
        
 
        String
        
+
        String
        
 
        DCS instance engine.
        
+
        DCS instance engine.
        
         		
 
        capacity
        
+
        capacity
        
 
        Integer
        
+
        Integer
        
 
        DCS instance cache capacity. Unit: GB.
        
+
        DCS instance cache capacity. Unit: GB.
        
         		
 
        ip
        
+
        ip
        
 
        String
        
+
        String
        
 
        IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.
        
+
        IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.
        
         		
 
        domainName
        
+
        domainName
        
 
        String
        
+
        String
        
 
        Domain name of the instance.
        
+
        Domain name of the instance.
        
         		
 
        port
        
+
        port
        
 
        Integer
        
+
        Integer
        
 
        Port number of the cache node.
        
+
        Port number of the cache node.
        
         		
 
        status
        
+
        status
        
 
        String
        
+
        String
        
 
        Cache instance status. For details about status, see DCS Instance Statuses.
        
+
        Cache instance status. For details about status, see DCS Instance Statuses.
        
         		
 
        libos
        
+
        libos
        
 
        Boolean
        
+
        Boolean
        
 
        • true: This instance is a libos instance.
        • false: This instance is not a libos instance.
        
+
        • true: This instance is a libos instance.
        • false: This instance is not a libos instance.
        
         		
 
        description
        
+
        description
        
 
        String
        
+
        String
        
 
        Brief description of the DCS instance.
        
+
        Brief description of the DCS instance.
        
         		
 
        max_memory
        
+
        max_memory
        
 
        Integer
        
+
        Integer
        
 
        Total memory size.
        
-
        Unit: MB.
        
+
        Total memory size.
        
+
        Unit: MB.
        
         		
 
        used_memory
        
+
        used_memory
        
 
        Integer
        
+
        Integer
        
 
        Size of the used memory.
        
-
        Unit: MB.
        
+
        Size of the used memory.
        
+
        Unit: MB.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        resource_spec_code
        
+
        resource_spec_code
        
 
        String
        
+
        String
        
 
        Resource specifications.
        
-
        For example:
        
-
        • dcs.single_node: indicates a DCS instance in single-node mode.
        • dcs.master_standby: indicates a DCS instance in master/standby mode.
        • dcs.cluster: indicates a DCS instance in cluster mode.
        
+
        Resource specifications.
        
+
        For example:
        
+
        • dcs.single_node: indicates a DCS instance in single-node mode.
        • dcs.master_standby: indicates a DCS instance in master/standby mode.
        • dcs.cluster: indicates a DCS instance in cluster mode.
        
         		
 
        engine_version
        
+
        engine_version
        
 
        String
        
+
        String
        
 
        Cache engine version.
        
+
        Cache engine version.
        
         		
 
        internal_version
        
+
        internal_version
        
 
        String
        
+
        String
        
 
        Internal DCS version.
        
+
        Internal DCS version.
        
         		
 
        charging_mode
        
+
        charging_mode
        
 
        Integer
        
+
        Integer
        
 
        Billing mode. 0: pay-per-use.
        
+
        Billing mode. 0: pay-per-use.
        
         		
 
        capacity_minor
        
+
        capacity_minor
        
 
        String
        
+
        String
        
 
        Cache capacity of a small-scale, single-node DCS instance.
        
+
        Cache capacity of a small-scale, single-node DCS instance.
        
         		
 
        vpc_id
        
+
        vpc_id
        
 
        String
        
+
        String
        
 
        VPC ID.
        
+
        VPC ID.
        
         		
 
        vpc_name
        
+
        vpc_name
        
 
        String
        
+
        String
        
 
        VPC name.
        
+
        VPC name.
        
         		
 
        created_at
        
+
        created_at
        
 
        String
        
+
        String
        
 
        Time at which the DCS instance is created.
        
-
        For example, 2017-03-31T12:24:46.297Z.
        
+
        Time at which the DCS instance is created.
        
+
        For example, 2017-03-31T12:24:46.297Z.
        
         		
 
        error_code
        
+
        error_code
        
 
        String
        
+
        String
        
 
        Error code returned when the DCS instance fails to be created or is abnormal.
        
-
        For details about error codes, see Error Codes.
        
+
        Error code returned when the DCS instance fails to be created or is abnormal.
        
+
        For details about error codes, see Error Codes.
        
         		
 
        user_id
        
+
        user_id
        
 
        String
        
+
        String
        
 
        User ID.
        
+
        User ID.
        
         		
 
        user_name
        
+
        user_name
        
 
        String
        
+
        String
        
 
        Username.
        
+
        Username.
        
         		
 
        maintain_begin
        
+
        maintain_begin
        
 
        String
        
+
        String
        
 
        Time at which the maintenance time window starts.
        
-
        Format: hh:mm:ss.
        
+
        Time at which the maintenance time window starts.
        
+
        Format: hh:mm:ss.
        
         		
 
        maintain_end
        
+
        maintain_end
        
 
        String
        
+
        String
        
 
        Time at which the maintenance time window ends.
        
-
        Format: hh:mm:ss.
        
+
        Time at which the maintenance time window ends.
        
+
        Format: hh:mm:ss.
        
         		
 
        no_password_access
        
+
        no_password_access
        
 
        String
        
+
        String
        
 
        An indicator of whether a DCS instance can be accessed in password-free mode.
        
-
        • true: indicates that a DCS instance can be accessed without a password.
        • false: indicates that a DCS instance can be accessed only after password authentication.
        
+
        An indicator of whether a DCS instance can be accessed in password-free mode.
        
+
        • true: indicates that a DCS instance can be accessed without a password.
        • false: indicates that a DCS instance can be accessed only after password authentication.
        
         		
 
        access_user
        
+
        access_user
        
 
        String
        
+
        String
        
 
        Username used for accessing a DCS instance with password authentication.
        
+
        Username used for accessing a DCS instance with password authentication.
        
         		
 
        enable_publicip
        
+
        enable_publicip
        
 
        Boolean
        
+
        Boolean
        
 
        An indicator of whether public access is enabled for a DCS Redis instance. Options:
        
-
        • true: enabled.
        • false: disabled.
        
+
        An indicator of whether public access is enabled for a DCS Redis instance. Options:
        
+
        • true: enabled.
        • false: disabled.
        
         		
 
        publicip_id
        
+
        publicip_id
        
 
        String
        
+
        String
        
 
        ID of the elastic IP address bound to a DCS Redis instance.
        
-
        The parameter value is null if public access is disabled.
        
+
        ID of the elastic IP address bound to a DCS Redis instance.
        
+
        The parameter value is null if public access is disabled.
        
         		
 
        publicip_address
        
+
        publicip_address
        
 
        String
        
+
        String
        
 
        Elastic IP address bound to a DCS Redis instance.
        
-
        The parameter value is null if public access is disabled.
        
+
        Elastic IP address bound to a DCS Redis instance.
        
+
        The parameter value is null if public access is disabled.
        
         		
 
        enable_ssl
        
+
        enable_ssl
        
 
        Boolean
        
+
        Boolean
        
 
        An indicator of whether to enable SSL for public access to a DCS Redis instance.
        
-
        • true: enabled.
        • false: disabled.
        
+
        An indicator of whether to enable SSL for public access to a DCS Redis instance.
        
+
        • true: enabled.
        • false: disabled.
        
         		
 
        service_upgrade
        
+
        service_upgrade
        
 
        Boolean
        
+
        Boolean
        
 
        An indicator of whether an upgrade task has been created for a DCS instance.
        
-
        • true: yes.
        • false: no.
        
+
        An indicator of whether an upgrade task has been created for a DCS instance.
        
+
        • true: yes.
        • false: no.
        
         		
 
        service_task_id
        
+
        service_task_id
        
 
        String
        
+
        String
        
 
        Upgrade task ID.
        
-
        • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
        • If the value of service_upgrade is set to false, the value of this parameter is empty.
        
+
        Upgrade task ID.
        
+
        • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
        • If the value of service_upgrade is set to false, the value of this parameter is empty.
        
         		
 
        enterprise_project_id
        
+
        enterprise_project_id
        
 
        String
        
+
        String
        
 
        Enterprise project ID.
        
+
        Enterprise project ID.
        
         		
 
        product_type
        
+
        product_type
        
 
        String
        
+
        String
        
 
        Edition of DCS for Redis. Options:
        
-
        • generic: standard edition
        • libos: high-performance edition
        
+
        Edition of DCS for Redis. Options:
        
+
        • generic: standard edition
        • libos: high-performance edition
        
         		
 
        cpu_type
        
+
        cpu_type
        
 
        String
        
+
        String
        
 
        CPU architecture. Options: x86_64 and aarch_64.
        
+
        CPU architecture. The value can be x86_64 or aarch_64.
        
         		
 
        storage_type
        
+
        storage_type
        
 
        String
        
+
        String
        
 
        Memory type. Options: DRAM and SCM.
        
+
        Memory type. Options: DRAM and SCM.
        
         		
 
        cache_mode
        
+
        cache_mode
        
 
        String
        
+
        String
        
 
        DCS instance type. Options:
        
-
        • single: single-node
        • ha: master/standby
        • cluster: Redis Cluster
        • proxy: Proxy Cluster
        
+
        DCS instance type. Options:
        
+
        • single: single-node
        • ha: master/standby
        • cluster: Redis Cluster
        • proxy: Proxy Cluster
        
         		
 
        launched_at
        
+
        launched_at
        
 
        String
        
+
        String
        
 
        Time when the instance started running.
        
+
        Time when the instance started running.
        
         		
 
        available_zones
        
+
        available_zones
        
 
        Array
        
+
        Array
        
 
        AZ where a cache node resides. The value of this parameter in the response contains an AZ ID.
        
+
        AZ where a cache node resides. The value of this parameter in the response contains an AZ ID.
        
         		
 
        subnet_id
        
+
        subnet_id
        
 
        String
        
+
        String
        
 
        Subnet ID.
        
+
        Subnet ID.
        
         		
 
        security_group_id
        
+
        security_group_id
        
 
        String
        
+
        String
        
 
        Security group ID.
        
+
        Security group ID.
        
         		
 
        backend_addrs
        
+
        backend_addrs
        
 
        String
        
+
        String
        
 
        Backend address of a cluster instance.
        
+
        Backend address of a cluster instance.
        
         		
 
        cloud_service_type_code
        
+
        cloud_service_type_code
        
 
        String
        
+
        String
        
 
        Cloud service type code.
        
+
        Cloud service type code.
        
         		
 
        cloud_resource_type_code
        
+
        cloud_resource_type_code
        
 
        String
        
+
        String
        
 
        Cloud resource type code.
        
+
        Cloud resource type code.
        
         		
 
        product_id
        
+
        product_id
        
 
        String
        
+
        String
        
 
        Product ID.
        
+
        Product ID.
        
         		
 
        security_group_name
        
+
        security_group_name
        
 
        String
        
+
        String
        
 
        Security group name.
        
+
        Security group name.
        
         		
 
        subnet_name
        
+
        subnet_name
        
 
        String
        
+
        String
        
 
        Subnet name.
        
+
        Subnet name.
        
         		
 
        subnet_cidr
        
+
        subnet_cidr
        
 
        String
        
+
        String
        
 
        Subnet segment.
        
+
        Subnet segment.
        
         		
 
        order_id
        
+
        order_id
        
 
        String
        
+
        String
        
 
        Order ID.
        
+
        Order ID.
        
         		
 
        instance_backup_policy
        
+
        instance_backup_policy
        
 
        Object
        
+
        Object
        
 
        Backup policy.
        
-
        This parameter is available for master/standby and cluster DCS instances. For details, see Table 3.
        
+
        Backup policy.
        
+
        This parameter is available for master/standby and cluster DCS instances. For details, see Table 3.
        
         		
 
        tags
        
+
        tags
        
 
        Array of Objects
        
+
        Array of Objects
        
 
        Instance tag key and value.
        
+
        Instance tag key and value.
        
         		
 
        spec_code
        
+
        spec_code
        
 
        String
        
+
        String
        
 
        Product specification code.
        
+
        Product specification code.
        
         		
 
        domain_name
        
+
        domain_name
        
 
        String
        
+
        String
        
 
        Domain name of the instance.
        
+
        Domain name of the instance.
        
         		
 
        readonlyDomainName
        
+
        readonlyDomainName
        
 
        String
        
+
        String
        
 
        Read-only domain name.
        
+
        Read-only domain name.
        
         		
 
        readonly_domain_name
        
+
        readonly_domain_name
        
 
        String
        
+
        String
        
 
        Read-only domain name.
        
+
        Read-only domain name.
        
         		
 
        freeze_scene
        
+
        freeze_scene
        
 
        String
        
+
        String
        
 
        Scenario where the instance is frozen.
        
+
        Scenario where the instance is frozen.
        
         		
 
        update_at
        
+
        update_at
        
 
        String
        
+
        String
        
 
        Update time.
        
+
        Update time.
        
         		
 
        task_status
        
+
        task_status
        
 
        String
        
+
        String
        
 
        Task status.
        
+
        Task status.
        
         		
 
        is_free
        
+
        is_free
        
 
        Boolean
        
+
        Boolean
        
 
        Whether the instance is free of charge.
        
+
        Whether the instance is free of charge.
        
         		
 
        az_codes
        
+
        az_codes
        
 
        Array of strings
        
+
        Array of strings
        
 
        AZs with available resources.
        
+
        AZs with available resources.
        
         		
 
        crr_role
        
+
        crr_role
        
 
        String
        
+
        String
        
 
        Role in cross-region DR.
        
+
        Role in cross-region DR.
        
         		
 
        inquery_spec_code
        
+
        inquery_spec_code
        
 
        String
        
+
        String
        
 
        Product specification code.
        
+
        Product specification code.
        
         		
 
        support_slow_log_flag
        
+
        support_slow_log_flag
        
 
        String
        
+
        String
        
 
        Whether slow query logs are supported.
        
+
        Whether slow query logs are supported.
        
         		
 
        ipv6
        
+
        ipv6
        
 
        String
        
+
        String
        
 
        IPv6 address.
        
+
        IPv6 address.
        
         		
 
        enable_ipv6
        
+
        enable_ipv6
        
 
        Boolean
        
+
        Boolean
        
 
        Whether IPv6 is enabled.
        
+
        Whether IPv6 is enabled.
        
         		
 
        description
        
+
        description
        
 
        String
        
+
        String
        
 
        Instance description.
        
+
        Instance description.
        
         		
 
        db_number
        
+
        db_number
        
 
        int
        
+
        int
        
 
        Number of databases in the instance.
        
+
        Number of databases in the instance.
        
         		
 
        support_acl
        
+
        support_acl
        
 
        Boolean
        
+
        Boolean
        
 
        Whether ACL is supported.
        
+
        Whether ACL is supported.
        
         		
 
        task
        
+
        task
        
 
        String
        
+
        String
        
 
        Task response.
        
+
        Task response.
        
         		
 
        enterprise_project_name
        
+
        enterprise_project_name
        
 
        String
        
+
        String
        
 
        Enterprise project name.
        
+
        Enterprise project name.
        
         		
 
        sharding_count
        
+
        sharding_count
        
 
        int
        
+
        int
        
 
        Number of shards.
        
+
        Number of shards.
        
         		
 
        
         
 
        
 
        
 
-
        Table 3 instance_backup_policy
        Parameter
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 3 instance_backup_policy
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        backup_policy_id
        
+
        backup_policy_id
        
 
        String
        
+
        String
        
 
        Backup policy ID.
        
+
        Backup policy ID.
        
         		
 
        created_at
        
+
        created_at
        
 
        String
        
+
        String
        
 
        Creation time.
        
+
        Creation time.
        
         		
 
        updated_at
        
+
        updated_at
        
 
        String
        
+
        String
        
 
        Update time.
        
+
        Update time.
        
         		
 
        policy
        
+
        policy
        
 
        Object
        
+
        Object
        
 
        For details, see Table 3 and Table 4.
        
+
        For details, see Table 3 and Table 4.
        
         		
 
        tenant_id
        
+
        tenant_id
        
 
        String
        
+
        String
        
 
        Tenant ID.
        
+
        Tenant ID.
        
         		
 
        
         
 
        
 
        
-
        Example response
        
-
        
+
        Example response
        
+
        
 
-
        {
+
        {
    "free":null,
    "max_memory":1024,
    "used_memory":1,
@@ -705,17 +705,17 @@
    "enterprise_project_name":null,
    "sharding_count":0
 }
        
-
        Status Code
        Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 4 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312006.html b/docs/dcs/api-ref/dcs-api-0312006.html
index 47b0febd..89534000 100644
--- a/docs/dcs/api-ref/dcs-api-0312006.html
+++ b/docs/dcs/api-ref/dcs-api-0312006.html
@@ -1,143 +1,142 @@
 
        Querying All DCS Instances of a Tenant
        
-
        Function
        This API is used to query DCS instances of a tenant, and allows you to specify query criteria.
        
+
        Function
        This API is used to query DCS instances of a tenant, and allows you to specify query criteria.
        
 
        
-
        URI
        GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}
        
-
        Table 1 describes the parameters.
-
        Table 4 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        Specified instance queried successfully.
        
+
        Specified instance queried successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&include_failure={include_failure}&ip={ip}&tags={key}={value}
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        start
        
+
        start
        
 
        Integer
        
+
        Integer
        
 
        No
        
+
        No
        
 
        Start number for querying DCS instances. It cannot be lower than 1.
        
-
        By default, the start number is 1.
        
+
        Start number for querying DCS instances. It cannot be lower than 1.
        
+
        By default, the start number is 1.
        
         		
 
        limit
        
+
        limit
        
 
        Integer
        
+
        Integer
        
 
        No
        
+
        No
        
 
        Number of DCS instances displayed on each page.
        
-
        Minimum value: 1
        
-
        Maximum value: 2000
        
-
        If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page.
        
+
        Number of DCS instances displayed on each page.
        
+
        Minimum value: 1
        
+
        Maximum value: 2000
        
+
        If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page.
        
         		
 
        name
        
+
        name
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        DCS instance name.
        
+
        DCS instance name.
        
         		
 
        id
        
+
        id
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        Instance ID.
        
+
        Instance ID.
        
         		
 
        status
        
+
        status
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        DCS instance status. For details about status, see DCS Instance Statuses.
        
+
        DCS instance status. For details about status, see DCS Instance Statuses.
        
         		
 
        ip
        
+
        ip
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        IP address for connecting to the DCS instance
        
+
        IP address for connecting to the DCS instance
        
         		
 
        isExactMatchName
        
+
        include_failure
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        An indicator of whether to perform an exact or fuzzy match based on instance name.
        
-
        Options:
        
-
        • true: exact match
        • false: fuzzy match
        
-
        Default value: false.
        
+
        An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller.
        
+
        Options:
        
+
        • true: The number of DCS instances that failed to be created will be returned to the API caller.
        • false or others: The number of DCS instances that failed to be created will not be returned to the API caller.
        
         		
 
        tags
        
+
        tags
        
 
        Array of Objects
        
+
        Array of Objects
        
 
        No
        
+
        No
        
 
        Query based on the instance tag key and value. {key} indicates the tag key, and {value} indicates the tag value.
        
-
        To query instances with multiple tag keys and values, separate key-value pairs with commas (,).
        
+
        Query based on the instance tag key and value. {key} indicates the tag key, and {value} indicates the tag value.
        
+
        To query instances with multiple tag keys and values, separate key-value pairs with commas (,).
        
         		
 
        
         
 
        
 
        
 
        
-
        Example
        
-
        GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&isExactMatchName=false  
        
+
        Example
        
+
        GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&include_failure=true  
        
 
        
-
        Request
        Request parameters
        
-
        None
        
-
        Example request
        
-
        None
        
+
        Request
        Request parameters
        
+
        None
        
+
        Example request
        
+
        None
        
 
        
-
        Response
        Response parameters
        
-
        Table 2 describes the response parameters.
-
        Table 2 Parameter description
        Parameter
        
+
        Response
        Response parameters
        
+
        Table 2 describes the response parameters.
+
        
-
-
-
-
-
-
-
-
@@ -145,311 +144,311 @@
 
 
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        instances
        
+
        instances
        
 
        Array
        
+
        Array
        
 
        Array of DCS instance details.
        
+
        Array of DCS instance details.
        
         		
 
        instance_num
        
+
        instance_num
        
 
        Integer
        
+
        Integer
        
 
        Number of DCS instances.
        
+
        Number of DCS instances.
        
         		
 
        
         
 
        Table 3 Parameter description of the instance array
        Parameter
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 3 instances parameters
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        name
        
+
        name
        
 
        String
        
+
        String
        
 
        DCS instance name.
        
+
        DCS instance name.
        
         		
 
        engine
        
+
        engine
        
 
        String
        
+
        String
        
 
        Cache engine.
        
+
        Cache engine.
        
         		
 
        capacity
        
+
        capacity
        
 
        Integer
        
+
        Integer
        
 
        Cache capacity.
        
-
        Unit: GB.
        
+
        Cache capacity.
        
+
        Unit: GB.
        
         		
 
        ip
        
+
        ip
        
 
        String
        
+
        String
        
 
        IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.
        
+
        IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.
        
         		
 
        domainName
        
+
        domainName
        
 
        String
        
+
        String
        
 
        Domain name of the instance.
        
+
        Domain name of the instance.
        
         		
 
        port
        
+
        port
        
 
        Integer
        
+
        Integer
        
 
        Port number of the cache node.
        
+
        Port number of the cache node.
        
         		
 
        status
        
+
        status
        
 
        String
        
+
        String
        
 
        Cache instance status. For details about status, see DCS Instance Statuses.
        
+
        Cache instance status. For details about status, see DCS Instance Statuses.
        
         		
 
        max_memory
        
+
        max_memory
        
 
        Integer
        
+
        Integer
        
 
        Overall memory size.
        
-
        Unit: MB.
        
+
        Overall memory size.
        
+
        Unit: MB.
        
         		
 
        used_memory
        
+
        used_memory
        
 
        Integer
        
+
        Integer
        
 
        Size of the used memory.
        
-
        Unit: MB.
        
+
        Size of the used memory.
        
+
        Unit: MB.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        resource_spec_code
        
+
        resource_spec_code
        
 
        String
        
+
        String
        
 
        Resource specifications.
        
-
        For example:
        
-
        • dcs.single_node: indicates a DCS instance in single-node mode.
        • dcs.master_standby: indicates a DCS instance in master/standby mode.
        • dcs.cluster: indicates a DCS instance in cluster mode.
        
+
        Resource specifications.
        
+
        For example:
        
+
        • dcs.single_node: indicates a DCS instance in single-node mode.
        • dcs.master_standby: indicates a DCS instance in master/standby mode.
        • dcs.cluster: indicates a DCS instance in cluster mode.
        
         		
 
        engine_version
        
+
        engine_version
        
 
        String
        
+
        String
        
 
        Cache engine version.
        
+
        Cache engine version.
        
         		
 
        internal_version
        
+
        internal_version
        
 
        String
        
+
        String
        
 
        Internal DCS version.
        
+
        Internal DCS version.
        
         		
 
        charging_mode
        
+
        charging_mode
        
 
        Integer
        
+
        Integer
        
 
        Billing mode. 0: pay-per-use.
        
+
        Billing mode. 0: pay-per-use.
        
         		
 
        capacity_minor
        
+
        capacity_minor
        
 
        String
        
+
        String
        
 
        Small-scale cache capacity. Unit: GB.
        
+
        Small-scale cache capacity. Unit: GB.
        
         		
 
        vpc_id
        
+
        vpc_id
        
 
        String
        
+
        String
        
 
        VPC ID.
        
+
        VPC ID.
        
         		
 
        vpc_name
        
+
        vpc_name
        
 
        String
        
+
        String
        
 
        VPC name.
        
+
        VPC name.
        
         		
 
        created_at
        
+
        created_at
        
 
        String
        
+
        String
        
 
        Time at which the DCS instance is created. For example, 2017-03-31T12:24:46.297Z.
        
+
        Time at which the DCS instance is created. For example, 2017-03-31T12:24:46.297Z.
        
         		
 
        error_code
        
+
        error_code
        
 
        String
        
+
        String
        
 
        Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see Error Codes.
        
+
        Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see Error Codes.
        
         		
 
        user_id
        
+
        user_id
        
 
        String
        
+
        String
        
 
        User ID.
        
+
        User ID.
        
         		
 
        user_name
        
+
        user_name
        
 
        String
        
+
        String
        
 
        Username.
        
+
        Username.
        
         		
 
        maintain_begin
        
+
        maintain_begin
        
 
        String
        
+
        String
        
 
        Time at which the maintenance time window starts. Format: hh:mm:ss.
        
+
        Time at which the maintenance time window starts. Format: hh:mm:ss.
        
         		
 
        maintain_end
        
+
        maintain_end
        
 
        String
        
+
        String
        
 
        Time at which the maintenance time window ends. Format: hh:mm:ss.
        
+
        Time at which the maintenance time window ends. Format: hh:mm:ss.
        
         		
 
        no_password_access
        
+
        no_password_access
        
 
        String
        
+
        String
        
 
        An indicator of whether a DCS instance can be accessed in password-free mode.
        
-
        • true: indicates that a DCS instance can be accessed without a password.
        • false: indicates that a DCS instance can be accessed only after password authentication.
        
+
        An indicator of whether a DCS instance can be accessed in password-free mode.
        
+
        • true: indicates that a DCS instance can be accessed without a password.
        • false: indicates that a DCS instance can be accessed only after password authentication.
        
         		
 
        access_user
        
+
        access_user
        
 
        String
        
+
        String
        
 
        Username used for accessing a DCS instance with password authentication.
        
+
        Username used for accessing a DCS instance with password authentication.
        
         		
 
        enable_publicip
        
+
        enable_publicip
        
 
        Boolean
        
+
        Boolean
        
 
        An indicator of whether public access is enabled for a DCS Redis instance.
        
-
        • true: enabled.
        • false: disabled.
        
+
        An indicator of whether public access is enabled for a DCS Redis instance.
        
+
        • true: enabled.
        • false: disabled.
        
         		
 
        publicip_address
        
+
        publicip_address
        
 
        String
        
+
        String
        
 
        Elastic IP address bound to a DCS Redis instance.
        
-
        The parameter value is null if public access is disabled.
        
+
        Elastic IP address bound to a DCS Redis instance.
        
+
        The parameter value is null if public access is disabled.
        
         		
 
        publicip_id
        
+
        publicip_id
        
 
        String
        
+
        String
        
 
        ID of the elastic IP address bound to a DCS Redis instance.
        
-
        The parameter value is null if public access is disabled.
        
+
        ID of the elastic IP address bound to a DCS Redis instance.
        
+
        The parameter value is null if public access is disabled.
        
         		
 
        enable_ssl
        
+
        enable_ssl
        
 
        Boolean
        
+
        Boolean
        
 
        An indicator of whether to enable SSL for public access to a DCS Redis instance.
        
-
        • true: enabled.
        • false: disabled.
        
+
        An indicator of whether to enable SSL for public access to a DCS Redis instance.
        
+
        • true: enabled.
        • false: disabled.
        
         		
 
        service_upgrade
        
+
        service_upgrade
        
 
        Boolean
        
+
        Boolean
        
 
        An indicator of whether an upgrade task has been created for a DCS instance.
        
-
        • true: yes.
        • false: no.
        
+
        An indicator of whether an upgrade task has been created for a DCS instance.
        
+
        • true: yes.
        • false: no.
        
         		
 
        service_task_id
        
+
        service_task_id
        
 
        String
        
+
        String
        
 
        Upgrade task ID.
        
-
        • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
        • If the value of service_upgrade is set to false, the value of this parameter is empty.
        
+
        Upgrade task ID.
        
+
        • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
        • If the value of service_upgrade is set to false, the value of this parameter is empty.
        
         		
 
        security_group_id
        
+
        security_group_id
        
 
        String
        
+
        String
        
 
        Security group name.
        
+
        Security group name.
        
         		
 
        tags
        
+
        tags
        
 
        Array of Objects
        
+
        Array of Objects
        
 
        Instance tag key and value.
        
+
        Instance tag key and value.
        
         		
 
        spec_code
        
+
        spec_code
        
 
        String
        
+
        String
        
 
        Product specification code.
        
+
        Product specification code.
        
         		
 
        domain_name
        
+
        domain_name
        
 
        String
        
+
        String
        
 
        Domain name of the instance.
        
+
        Domain name of the instance.
        
         		
 
        readonlyDomainName
        
+
        readonlyDomainName
        
 
        String
        
+
        String
        
 
        Read-only domain name.
        
+
        Read-only domain name.
        
         		
 
        readonly_domain_name
        
+
        readonly_domain_name
        
 
        String
        
+
        String
        
 
        Read-only domain name.
        
+
        Read-only domain name.
        
         		
 
        freeze_scene
        
+
        freeze_scene
        
 
        String
        
+
        String
        
 
        Scenario where the instance is frozen.
        
+
        Scenario where the instance is frozen.
        
         		
 
        update_at
        
+
        update_at
        
 
        String
        
+
        String
        
 
        Update time. For example, 2017-03-31T12:24:46.297Z.
        
+
        Update time. For example, 2017-03-31T12:24:46.297Z.
        
         		
 
        subnet_id
        
+
        subnet_id
        
 
        String
        
+
        String
        
 
        Subnet ID.
        
+
        Subnet ID.
        
         		
 
        
         
 
        
 
        
-
        Example response
        
-
        {"instances":[
+
        Example response
        
+
        {"instances":[
 {
        "max_memory":2048,
        "used_memory":1,
@@ -495,17 +494,17 @@
 "instance_num":1
 } 
        
 
-
        Status Code
        Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 4 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312007.html b/docs/dcs/api-ref/dcs-api-0312007.html
index 7f6a3e00..cc188324 100644
--- a/docs/dcs/api-ref/dcs-api-0312007.html
+++ b/docs/dcs/api-ref/dcs-api-0312007.html
@@ -1,36 +1,36 @@
 
        Modifying Information About a DCS Instance
        
-
        Function
        This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, and security group.
        
+
        Function
        This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, and security group.
        
 
        
-
        URI
        PUT /v1.0/{project_id}/instances/{instance_id}
        
-
        Table 1 describes the parameters.
-
        Table 4 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        All DCS instances of the tenant queried successfully.
        
+
        All DCS instances of the tenant queried successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        PUT /v1.0/{project_id}/instances/{instance_id}
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -38,95 +38,95 @@
 
-
        Request
        Request parameters
        
-
        Table 2 describes the request parameters.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Request
        Request parameters
        
+
        Table 2 describes the request parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        name
        
+
        name
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        DCS instance name.
        
-
        An instance name can contain 4 to 64 characters, including letters, digits, underscores (_), and hyphens (-), and must start with a letter.
        
+
        DCS instance name.
        
+
        An instance name can contain 4 to 64 characters, including letters, digits, underscores (_), and hyphens (-), and must start with a letter.
        
         		
 
        description
        
+
        description
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        Brief description of the DCS instance.
        
-
        A brief description supports up to 1024 characters.
        
-
         NOTE: 
        "\" is defined as an escape character in the queue description. If you need to enter a backward slash (\) or a double quotation mark (") in the queue description, enter \\ or \".
        
+
        Brief description of the DCS instance.
        
+
        A brief description supports up to 1024 characters.
        
+
         NOTE: 
        "\" is defined as an escape character in the queue description. If you need to enter a backward slash (\) or a double quotation mark (") in the queue description, enter \\ or \".
        
 
        
         		
 
        instance_backup_policy
        
+
        instance_backup_policy
        
 
        Object
        
+
        Object
        
 
        No
        
+
        No
        
 
        Backup policy.
        
-
        This parameter is available for master/standby and cluster DCS instances. For details, see Table 3 and Table 4.
        
+
        Backup policy.
        
+
        This parameter is available for master/standby and cluster DCS instances. For details, see Table 3 and Table 4.
        
         		
 
        maintain_begin
        
+
        maintain_begin
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        Time at which the maintenance time window starts.
        
-
        Format: hh:mm:ss.
        
-
        • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
        • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
        • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_begin is left blank, parameter maintain_end is also blank.
        
+
        Time at which the maintenance time window starts.
        
+
        Format: hh:mm:ss.
        
+
        • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
        • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
        • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_begin is left blank, parameter maintain_end is also blank.
        
         		
 
        maintain_end
        
+
        maintain_end
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        Time at which the maintenance time window ends.
        
-
        Format: hh:mm:ss.
        
-
        • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
        
-
        • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
        • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank.
        
+
        Time at which the maintenance time window ends.
        
+
        Format: hh:mm:ss.
        
+
        • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
        
+
        • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
        • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank.
        
         		
 
        security_group_id
        
+
        security_group_id
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        Security group ID.
        
-
        The value can be obtained from the VPC console or the API.
        
-
        This parameter is supported only by DCS Redis 3.0 instances.
        
+
        Security group ID.
        
+
        The value can be obtained from the VPC console or the API.
        
+
        This parameter is supported only by DCS Redis 3.0 instances.
        
         		
 
        
         
 
        
 
        
 
        
-
        Example request
        
-
        Request URL:
        
-
        PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
        
-
        • Example 1
          {
+
          Example request
          
+
          Request URL:
          
+
          PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
          
+
          • Example 1
            {
     "description": "instance description"
 }
            
-
          • Example 2
            {
+
          • Example 2
            {
     "name": "dcs002",
     "description": "instance description",
     "instance_backup_policy": {
@@ -151,22 +151,22 @@
 }
            
 
          
 
        
-
        Response
        Response parameters
        
-
        None
        
-
        Example response
        
-
        None
        
+
        Response
        Response parameters
        
+
        None
        
+
        Example response
        
+
        None
        
 
        
-
        Status Code
        Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 3 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312008.html b/docs/dcs/api-ref/dcs-api-0312008.html
index 299bf99b..e4e24d4e 100644
--- a/docs/dcs/api-ref/dcs-api-0312008.html
+++ b/docs/dcs/api-ref/dcs-api-0312008.html
@@ -1,36 +1,36 @@
 
        Deleting a Single DCS Instance
        
-
        Function
        This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.
        
+
        Function
        This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.
        
 
        
-
        URI
        DELETE /v1.0/{project_id}/instances/{instance_id}
        
-
        Table 1 describes the parameter.
-
        Table 3 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        204
        
+
        204
        
 
        DCS instance modified successfully.
        
+
        DCS instance modified successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        DELETE /v1.0/{project_id}/instances/{instance_id}
        
+
        Table 1 describes the parameter.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -38,28 +38,28 @@
 
-
        Request
        Request parameters
        
-
        None
        
-
        Example request
        
-
        Request URL:
        
-
        DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
        
+
        Request
        Request parameters
        
+
        None
        
+
        Example request
        
+
        Request URL:
        
+
        DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
        
 
        
-
        Response
        Response parameters
        
-
        None
        
-
        Example response
        
-
        None
        
+
        Response
        Response parameters
        
+
        None
        
+
        Example response
        
+
        None
        
 
        
-
        Status Code
        Table 2 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 2 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Instance ID.
        
+
        Instance ID.
        
         		
 
        
         
 
 
        Table 2 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312009.html b/docs/dcs/api-ref/dcs-api-0312009.html
index d9178e8e..fc3dea23 100644
--- a/docs/dcs/api-ref/dcs-api-0312009.html
+++ b/docs/dcs/api-ref/dcs-api-0312009.html
@@ -1,38 +1,38 @@
 
        Batch Deleting DCS Instances
        
-
        Function
        This API is used to delete multiple DCS instances at a time.
        
+
        Function
        This API is used to delete multiple DCS instances at a time.
        
 
        
-
        URI
        DELETE /v1.0/{project_id}/instances?allFailure={allFailure}
        
-
        Table 1 describes the parameters.
-
        Table 2 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        204
        
+
        204
        
 
        DCS instances deleted successfully.
        
+
        DCS instances deleted successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        DELETE /v1.0/{project_id}/instances?allFailure={allFailure}
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -40,58 +40,58 @@
 
-
        Request
        Request parameters
        
-
        Table 2 describes the request parameters.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        allFailure
        
+
        allFailure
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        An indicator of whether all DCS instances failed to be created will be deleted. Options:
        
-
        Options:
        
-
        • true: all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty.
        • false or other values: The DCS instances specified by the instances parameter in the API request will be deleted.
        
+
        An indicator of whether all DCS instances failed to be created will be deleted. Options:
        
+
        Options:
        
+
        • true: all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty.
        • false or other values: The DCS instances specified by the instances parameter in the API request will be deleted.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Request
        Request parameters
        
+
        Table 2 describes the request parameters.
+
        
-
-
-
-
-
-
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        instances
        
+
        instances
        
 
        Array
        
+
        Array
        
 
        No
        
+
        No
        
 
        IDs of DCS instances to be deleted.
        
-
        This parameter is set only when the allFailure parameter in the URI is set to false or another value.
        
-
        A maximum of 50 instances can be deleted at a time.
        
+
        IDs of DCS instances to be deleted.
        
+
        This parameter is set only when the allFailure parameter in the URI is set to false or another value.
        
+
        A maximum of 50 instances can be deleted at a time.
        
         		
 
        
         
 
        
 
        
 
        
-
        Request URL:
        
-
        DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure}
        
-
        Example request with allFailure set to false:
        
-
        {
+
        Request URL:
        
+
        DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure}
        
+
        Example request with allFailure set to false:
        
+
        {
     "instances": [
         "54602a9d-5e22-4239-9123-77e350df4a34",
         "7166cdea-dbad-4d79-9610-7163e6f8b640"
     ]
 }
        
 
        
-
        Response
        Response parameters
        
-
        If the value of the allFailure parameter in the URI is false, an empty response is then returned. If the value of the allFailure parameter in the URI is true, a response containing the parameter in Table 3 is returned.
-
        Table 3 Parameter description
        Parameter
        
+
        Response
        Response parameters
        
+
        If the value of the allFailure parameter in the URI is false, an empty response is then returned. If the value of the allFailure parameter in the URI is true, a response containing the parameter in Table 3 is returned.
+
        
-
-
-
-
-
@@ -99,33 +99,33 @@
 
 
-
        Table 3 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        results
        
+
        results
        
 
        Array
        
+
        Array
        
 
        For details about how to delete an instance, see Table 4.
        
+
        For details about how to delete an instance, see Table 4.
        
         		
 
        
         
 
        Table 4 results parameter description
        Parameter
        
+
        
-
-
-
-
-
-
-
-
        Table 4 results parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        instance
        
+
        instance
        
 
        String
        
+
        String
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        result
        
+
        result
        
 
        String
        
+
        String
        
 
        Instance deletion result. Options: success and failed
        
+
        Instance deletion result. Options: success and failed
        
         		
 
        
         
 
        
 
        
-
        Example response
        
-
        {
+
        Example response
        
+
        {
     "results": [
         {
             "instance": "54602a9d-5e22-4239-9123-77e350df4a34",
@@ -138,22 +138,22 @@
     ]
 }
        
 
-
        Status Code
        Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 5 Status codes
        Status Code
        
+
        
-
-
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312010.html b/docs/dcs/api-ref/dcs-api-0312010.html
index deccec5e..b9002997 100644
--- a/docs/dcs/api-ref/dcs-api-0312010.html
+++ b/docs/dcs/api-ref/dcs-api-0312010.html
@@ -1,36 +1,36 @@
 
        Scaling Up a DCS Instance
        
-
        Function
        This API is used to scale up a DCS Redis instance in the Running state.
        
+
        Function
        This API is used to scale up a DCS Redis instance in the Running state.
        
 
        
-
        URI
        POST /v1.0/{project_id}/instances/{instance_id}/extend
        
-
        Table 1 describes the parameters.
-
        Table 5 Status codes
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        DCS instances deleted successfully.
        
+
        DCS instances deleted successfully.
        
         		
 
        204
        
+
        204
        
 
        DCS instances that failed to be created are cleared successfully.
        
+
        DCS instances that failed to be created are cleared successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        POST /v1.0/{project_id}/instances/{instance_id}/extend
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -38,68 +38,68 @@
 
-
        Request
        Request parameters
        
-
        Table 2 describes the request parameters.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Instance ID.
        
+
        Instance ID.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Request
        Request parameters
        
+
        Table 2 describes the request parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        new_capacity
        
+
        new_capacity
        
 
        Integer
        
+
        Integer
        
 
        Yes
        
+
        Yes
        
 
        New specification (memory space) of the DCS instance. The new specification to which the DCS instance will be scaled up must be greater than the current specification. Unit: GB.
        
+
        New specification (memory space) of the DCS instance. The new specification to which the DCS instance will be scaled up must be greater than the current specification. Unit: GB.
        
         		
 
        spec_code
        
+
        spec_code
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        DCS instance specification code.
        
-
        This parameter is optional for DCS Redis 3.0 instances.
        
-
        This parameter is mandatory for DCS Redis 4.0 and Redis 5.0 instances.
        
+
        DCS instance specification code.
        
+
        This parameter is optional for DCS Redis 3.0 instances.
        
+
        This parameter is mandatory for DCS Redis 4.0 and later instances.
        
         		
 
        
         
 
        
 
        
 
        
-
        Example request
        
-
        • Request URL:
          POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/extend
          
+
          Example request
          
+
          • Request URL:
            POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/extend
            
 
          
-
          • Example:
            {
+
            • Example:
              {
     "spec_code":"redis.single.au1.large.4",
     "new_capacity":4,
  
 }
              
 
            
 
        
-
        Response
        Response parameters
        
-
        None
        
-
        Example response
        
-
        None
        
+
        Response
        Response parameters
        
+
        None
        
+
        Example response
        
+
        None
        
 
        
-
        Status Code
        Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 3 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312013.html b/docs/dcs/api-ref/dcs-api-0312013.html
index e165f940..89bf4fe3 100644
--- a/docs/dcs/api-ref/dcs-api-0312013.html
+++ b/docs/dcs/api-ref/dcs-api-0312013.html
@@ -9,5 +9,9 @@
 
      • Querying Configuration Parameters
        
 
        • 
+
+
        
+
        Parent topic: Outdated APIs (V1)
        
+
        
 
diff --git a/docs/dcs/api-ref/dcs-api-0312014.html b/docs/dcs/api-ref/dcs-api-0312014.html
index f8aa6fcf..2de2562e 100644
--- a/docs/dcs/api-ref/dcs-api-0312014.html
+++ b/docs/dcs/api-ref/dcs-api-0312014.html
@@ -1,27 +1,27 @@
 
        Querying Statistics of All Running Instances
        
-
        Function
        This API is used to query the statistics of all DCS instances that are in the Running state.
        
+
        Function
        This API is used to query the statistics of all DCS instances that are in the Running state.
        
 
        
-
        URI
        GET /v1.0/{project_id}/instances/statistic
        
-
        Table 1 describes the parameter.
-
        Table 3 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        204
        
+
        204
        
 
        Scale-up task submitted successfully.
        
+
        Scale-up task submitted successfully.
        
         		
 
        
         
 
 
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        GET /v1.0/{project_id}/instances/statistic
        
+
        Table 1 describes the parameter.
+
        
-
-
-
-
-
-
-
@@ -29,26 +29,26 @@
 
-
        Request
        Request parameters
        
-
        None
        
-
        Example request
        
-
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/statistic
        
+
        Request
        Request parameters
        
+
        None
        
+
        Example request
        
+
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/statistic
        
 
        
-
        Response
        Response parameters
        
-
        Table 2 describes the response parameter.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Response
        Response parameters
        
+
        Table 2 describes the response parameter.
+
        
-
-
-
-
-
@@ -56,81 +56,81 @@
 
 
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        statistics
        
+
        statistics
        
 
        Array
        
+
        Array
        
 
        Statistics of all instances in the Running state. For details, see Table 3.
        
+
        Statistics of all instances in the Running state. For details, see Table 3.
        
         		
 
        
         
 
        Table 3 statistics parameter description
        Parameter
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 3 statistics parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        keys
        
+
        keys
        
 
        Integer
        
+
        Integer
        
 
        Number of cached data records
        
+
        Number of cached data records
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        DCS instance ID
        
+
        DCS instance ID
        
         		
 
        used_memory
        
+
        used_memory
        
 
        Integer
        
+
        Integer
        
 
        Size of the used memory in MB
        
+
        Size of the used memory in MB
        
         		
 
        max_memory
        
+
        max_memory
        
 
        Integer
        
+
        Integer
        
 
        Overall memory size in MB
        
+
        Overall memory size in MB
        
         		
 
        cmd_get_count
        
+
        cmd_get_count
        
 
        Integer
        
+
        Integer
        
 
        Number of times the GET command is run
        
+
        Number of times the GET command is run
        
         		
 
        cmd_set_count
        
+
        cmd_set_count
        
 
        Integer
        
+
        Integer
        
 
        Number of times the SET command is run
        
+
        Number of times the SET command is run
        
         		
 
        used_cpu
        
+
        used_cpu
        
 
        String
        
+
        String
        
 
        Percentage of CPU usage
        
+
        Percentage of CPU usage
        
         		
 
        input_kbps
        
+
        input_kbps
        
 
        String
        
+
        String
        
 
        Incoming traffic (kbit/s) of the DCS instance
        
+
        Incoming traffic (kbit/s) of the DCS instance
        
         		
 
        output_kbps
        
+
        output_kbps
        
 
        String
        
+
        String
        
 
        Outgoing traffic (kbit/s) of the DCS instance
        
+
        Outgoing traffic (kbit/s) of the DCS instance
        
         		
 
        
         
 
        
 
        
-
        Example response
        {
+
        Example response
        {
     "statistics" : [{
             "keys" : 0,
             "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a",
@@ -176,17 +176,17 @@
 }
        
 
        
 
        
-
        Status Code
        Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 4 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312015.html b/docs/dcs/api-ref/dcs-api-0312015.html
index f2c9f668..8f7cd729 100644
--- a/docs/dcs/api-ref/dcs-api-0312015.html
+++ b/docs/dcs/api-ref/dcs-api-0312015.html
@@ -1,36 +1,36 @@
 
        Querying Configuration Parameters
        
-
        Function
        This API is used to query the configuration parameters of a DCS instance.
        
+
        Function
        This API is used to query the configuration parameters of a DCS instance.
        
 
        
-
        URI
        GET /v1.0/{project_id}/instances/{instance_id}/configs
        
-
        Table 1 describes the parameters.
-
        Table 4 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        Statistics of all instances queried successfully.
        
+
        Statistics of all instances queried successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        GET /v1.0/{project_id}/instances/{instance_id}/configs
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -38,62 +38,62 @@
 
-
        Request
        Request parameters
        
-
        None
        
-
        Example request
        
-
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
        
+
        Request
        Request parameters
        
+
        None
        
+
        Example request
        
+
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
        
 
        
-
        Response
        Response parameters
        
-
        Table 2 describes the response parameters.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        ID of the instance to be queried.
        
+
        ID of the instance to be queried.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Response
        Response parameters
        
+
        Table 2 describes the response parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -101,1942 +101,1942 @@
 
 
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        status
        
+
        status
        
 
        String
        
+
        String
        
 
        Current status of a DCS instance.
        
+
        Current status of a DCS instance.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        DCS instance ID.
        
+
        DCS instance ID.
        
         		
 
        redis_config
        
+
        redis_config
        
 
        Array
        
+
        Array
        
 
        Array of configuration items of the DCS instance. For details, see Table 3.
        
+
        Array of configuration items of the DCS instance. For details, see Table 3.
        
         		
 
        config_status
        
+
        config_status
        
 
        String
        
+
        String
        
 
        DCS instance status that is being modified or has been modified. Options:
        
-
        • UPDATING
        • FAILURE
        • SUCCESS
        
+
        DCS instance status that is being modified or has been modified. Options:
        
+
        • UPDATING
        • FAILURE
        • SUCCESS
        
         		
 
        config_time
        
+
        config_time
        
 
        String
        
+
        String
        
 
        Time at which the DCS instance is operated on. For example, 2017-03-31T12:24:46.297Z.
        
+
        Time at which the DCS instance is operated on. For example, 2017-03-31T12:24:46.297Z.
        
         		
 
        cluster_v1
        
+
        cluster_v1
        
 
        Boolean
        
+
        Boolean
        
 
        Instance type. If true is returned, the instance is a Proxy Cluster DCS Redis 3.0 instance. If false is returned, the instance is not a Proxy Cluster DCS Redis 3.0 instance.
        
+
        Instance type. If true is returned, the instance is a Proxy Cluster DCS Redis 3.0 instance. If false is returned, the instance is not a Proxy Cluster DCS Redis 3.0 instance.
        
         		
 
        
         
 
        Table 3 redis_config parameter description
        Parameter
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 3 redis_config parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        description
        
+
        description
        
 
        String
        
+
        String
        
 
        Configuration item description.
        
+
        Configuration item description.
        
         		
 
        param_id
        
+
        param_id
        
 
        String
        
+
        String
        
 
        Configuration parameter ID. For the possible values, see the Parameter ID column in Table 4.
        
+
        Configuration parameter ID. For the possible values, see the Parameter ID column in Table 4.
        
         		
 
        param_name
        
+
        param_name
        
 
        String
        
+
        String
        
 
        Configuration parameter name. For the possible values, see the Parameter Name column in Table 4.
        
+
        Configuration parameter name. For the possible values, see the Parameter Name column in Table 4.
        
         		
 
        param_value
        
+
        param_value
        
 
        String
        
+
        String
        
 
        Configuration parameter value.
        
+
        Configuration parameter value.
        
         		
 
        default_value
        
+
        default_value
        
 
        String
        
+
        String
        
 
        Default value of the configuration parameter. For the possible values, see the Default Value column in Table 4.
        
+
        Default value of the configuration parameter. For the possible values, see the Default Value column in Table 4.
        
         		
 
        value_type
        
+
        value_type
        
 
        String
        
+
        String
        
 
        Type of the configuration parameter value. For the possible values, see the Value Type column in Table 4.
        
+
        Type of the configuration parameter value. For the possible values, see the Value Type column in Table 4.
        
         		
 
        value_range
        
+
        value_range
        
 
        String
        
+
        String
        
 
        Range of the configuration parameter value. For the possible values, see the Value Range column in Table 4.
        
+
        Range of the configuration parameter value. For the possible values, see the Value Range column in Table 4.
        
         		
 
        node_role
        
+
        node_role
        
 
        String
        
+
        String
        
 
        If null or empty is returned, the node is a default node, that is, the Redis Server node. If proxy is returned, the node is a proxy node.
        
+
        If null or empty is returned, the node is a default node, that is, the Redis Server node. If proxy is returned, the node is a proxy node.
        
         		
 
        
         
 
        
 
        
-
        Table 4 describes the configuration parameters of a DCS instance.
        
+
        Table 4 describes the configuration parameters of a DCS instance.
        
 
-
        Table 4 Configuration parameters of a DCS instance
        Parameter ID
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 4 Configuration parameters of a DCS instance
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        1
        
+
        1
        
 
        timeout
        
+
        timeout
        
 
        Integer
        
+
        Integer
        
 
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
+
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
 
        0–7200 seconds
        
+
        0–7200 seconds
        
 
        0
        
+
        0
        
         		
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
-
        volatile-lfu
        
-
        allkeys-lfu
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
+
        volatile-lfu
        
+
        allkeys-lfu
        
 
        noeviction or volatile-lru
        
-
        The value range and default value depend on the instance version and type.
        
+
        noeviction or volatile-lru
        
+
        The value range and default value depend on the instance version and type.
        
         		
 
        3
        
+
        3
        
 
        hash-max-ziplist-entries
        
+
        hash-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        4
        
+
        4
        
 
        hash-max-ziplist-value
        
+
        hash-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        5
        
+
        5
        
 
        list-max-ziplist-entries
        
+
        list-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.
        
+
        When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        6
        
+
        6
        
 
        list-max-ziplist-value
        
+
        list-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.
        
+
        When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        7
        
+
        7
        
 
        set-max-intset-entries
        
+
        set-max-intset-entries
        
 
        Integer
        
+
        Integer
        
 
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
+
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        8
        
+
        8
        
 
        zset-max-ziplist-entries
        
+
        zset-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
+
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
 
        1–10,000
        
+
        1–10,000
        
 
        128
        
+
        128
        
         		
 
        9
        
+
        9
        
 
        zset-max-ziplist-value
        
+
        zset-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
+
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        10
        
+
        10
        
 
        latency-monitor-threshold
        
+
        latency-monitor-threshold
        
 
        IntegerInteger
        
+
        IntegerInteger
        
 
        The minimum amount of latency that will be logged as latency spikes
        
-
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
-
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.
        
+
        The minimum amount of latency that will be logged as latency spikes
        
+
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
+
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit the Redis official website.
        
 
        0–86,400,000 ms
        
+
        0–86,400,000 ms
        
 
        0
        
+
        0
        
         		
 
        11
        
+
        11
        
 
        maxclients
        
+
        maxclients
        
 
        Integer
        
+
        Integer
        
 
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
+
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
 
        1000–50,000
        
+
        1000–50,000
        
 
        10,000
        
+
        10,000
        
         		
 
        12
        
+
        12
        
 
        reserved-memory
        
+
        reserved-memory
        
 
        Integer
        
+
        Integer
        
 
        Reserved memory, which is the number of megabytes reserved for the backend to perform internal processing such as persistence and master/standby replication.
        
-
        This parameter is available only for master/standby instances.
        
-
        The size of the reserved memory can be adjusted, but must be in the value range described in the next column. For more information about maximum available memory of each instance type, see Distributed Cache Service User Guide.
        
+
        Reserved memory, which is the number of megabytes reserved for the backend to perform internal processing such as persistence and master/standby replication.
        
+
        This parameter is available only for master/standby instances.
        
+
        The size of the reserved memory can be adjusted, but must be in the value range described in the next column. For more information about maximum available memory of each instance type, see Distributed Cache Service User Guide.
        
 
        0% to 50% of maximum memory space initially available to the instance and below the current free memory space. Unit: MB.
        
+
        0% to 50% of maximum memory space initially available to the instance and below the current free memory space. Unit: MB.
        
 
        0
        
+
        0
        
         		
 
        13
        
+
        13
        
 
        notify-keyspace-events
        
+
        notify-keyspace-events
        
 
        String
        
+
        String
        
 
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
+
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
 
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
-
        K: Keyspace events, published with the __keyspace@__ prefix
        
-
        E: Keyevent events, published with the __keyevent@__ prefix
        
-
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
-
        $: String commands
        
-
        l: List commands
        
-
        s: Set commands
        
-
        h: Hash commands
        
-
        z: Sorted set commands
        
-
        x: Expired events (events generated every time a key expires)
        
-
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
-
        For more information, see the following note.
        
+
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
+
        K: Keyspace events, published with the __keyspace@__ prefix
        
+
        E: Keyevent events, published with the __keyevent@__ prefix
        
+
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
+
        $: String commands
        
+
        l: List commands
        
+
        s: Set commands
        
+
        h: Hash commands
        
+
        z: Sorted set commands
        
+
        x: Expired events (events generated every time a key expires)
        
+
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
+
        For more information, see the following note.
        
 
        Ex
        
+
        Ex
        
         		
 
        14
        
+
        14
        
 
        repl-backlog-size
        
+
        repl-backlog-size
        
 
        Integer
        
+
        Integer
        
 
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
+
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
 
        16,384–1,073,741,824
        
+
        16,384–1,073,741,824
        
 
        1,048,576
        
+
        1,048,576
        
         		
 
        15
        
+
        15
        
 
        repl-backlog-ttl
        
+
        repl-backlog-ttl
        
 
        Integer
        
+
        Integer
        
 
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
+
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
 
        0–604,800
        
+
        0–604,800
        
 
        3600
        
+
        3600
        
         		
 
        16
        
+
        16
        
 
        appendfsync
        
+
        appendfsync
        
 
        String
        
+
        String
        
 
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
+
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
 
        Redis calls fsync() in one of the following ways:
        
-
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
-
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
+
        Redis calls fsync() in one of the following ways:
        
+
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
+
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
 
        everysec
        
+
        everysec
        
         		
 
        17
        
+
        17
        
 
        appendonly
        
+
        appendonly
        
 
        String
        
+
        String
        
 
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
+
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
 
        yes,no
        
+
        yes,no
        
 
        yes
        
+
        yes
        
         		
 
        18
        
+
        18
        
 
        slowlog-log-slower-than
        
+
        slowlog-log-slower-than
        
 
        Integer
        
+
        Integer
        
 
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
+
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
 
        0–1,000,000
        
+
        0–1,000,000
        
 
        10,000
        
+
        10,000
        
         		
 
        19
        
+
        19
        
 
        slowlog-max-len
        
+
        slowlog-max-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
+
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
 
        0–1000
        
+
        0–1000
        
 
        128
        
+
        128
        
         		
 
        20
        
+
        20
        
 
        lua-time-limit
        
+
        lua-time-limit
        
 
        Integer
        
+
        Integer
        
 
        The maximum time allowed for executing a Lua script, in milliseconds.
        
+
        The maximum time allowed for executing a Lua script, in milliseconds.
        
 
        100–5000
        
+
        100–5000
        
 
        5000
        
+
        5000
        
         		
 
        21
        
+
        21
        
 
        repl-timeout
        
+
        repl-timeout
        
 
        Integer
        
+
        Integer
        
 
        Replication timeout, in seconds.
        
+
        Replication timeout, in seconds.
        
 
        30–3600
        
+
        30–3600
        
 
        60
        
+
        60
        
         		
 
        22
        
+
        22
        
 
        proto-max-bulk-len
        
+
        proto-max-bulk-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum size (in bytes) of a single element request.
        
+
        The maximum size (in bytes) of a single element request.
        
 
        1,048,576–536,870,912
        
+
        1,048,576–536,870,912
        
 
        536,870,912
        
+
        536,870,912
        
         		
 
        23
        
+
        23
        
 
        master-read-only
        
+
        master-read-only
        
 
        String
        
+
        String
        
 
        Sets the instance to be read-only. All write operations will fail.
        
+
        Sets the instance to be read-only. All write operations will fail.
        
 
        yes,no
        
+
        yes,no
        
 
        no
        
+
        no
        
         		
 
        24
        
+
        24
        
 
        client-output-buffer-slave-soft-limit
        
+
        client-output-buffer-slave-soft-limit
        
 
        Integer
        
+
        Integer
        
 
        Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
        
+
        Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
        
 
        0–134,217,728
        
+
        0–134,217,728
        
 
        13,421,772
        
+
        13,421,772
        
         		
 
        25
        
+
        25
        
 
        client-output-buffer-slave-hard-limit
        
+
        client-output-buffer-slave-hard-limit
        
 
        Integer
        
+
        Integer
        
 
        Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
        
+
        Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
        
 
        0–134,217,728
        
+
        0–134,217,728
        
 
        13,421,772
        
+
        13,421,772
        
         		
 
        26
        
+
        26
        
 
        client-output-buffer-limit-slave-soft-seconds
        
+
        client-output-buffer-limit-slave-soft-seconds
        
 
        Integer
        
+
        Integer
        
 
        Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
        
+
        Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
        
 
        0–60
        
+
        0–60
        
 
        60
        
+
        60
        
         		
 
        30
        
+
        30
        
 
        reserved-memory-percent
        
+
        reserved-memory-percent
        
 
        Integer
        
+
        Integer
        
 
        Percentage of memory reserved for non-cache memory usage.
        
+
        Percentage of memory reserved for non-cache memory usage.
        
 
        0–80
        
+
        0–80
        
 
        0
        
+
        0
        
         		
 
        
         
 
        
 
        
-
        Table 5, Table 6, Table 7, Table 8, Table 9, and Table 10 describe the configuration parameters of different DCS instances.
        
+
        Table 5, Table 6, Table 7, Table 8, Table 9, and Table 10 describe the configuration parameters of different DCS instances.
        
 
-
        Table 5 Configuration parameters of a single-node DCS Redis 3.0 instance
        Instance Type
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 5 Configuration parameters of a single-node DCS Redis 3.0 instance
        Instance Type
        
 
        Parameter ID
        
+
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        Single-node Redis 3.0
        
+
        Single-node Redis 3.0
        
 
        1
        
+
        1
        
 
        timeout
        
+
        timeout
        
 
        Integer
        
+
        Integer
        
 
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
+
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
 
        0–7200 seconds
        
+
        0–7200 seconds
        
 
        0
        
+
        0
        
         		
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
 
        noeviction
        
+
        noeviction
        
         		
 
        3
        
+
        3
        
 
        hash-max-ziplist-entries
        
+
        hash-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        4
        
+
        4
        
 
        hash-max-ziplist-value
        
+
        hash-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        5
        
+
        5
        
 
        list-max-ziplist-entries
        
+
        list-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.
        
+
        When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        6
        
+
        6
        
 
        list-max-ziplist-value
        
+
        list-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.
        
+
        When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        7
        
+
        7
        
 
        set-max-intset-entries
        
+
        set-max-intset-entries
        
 
        Integer
        
+
        Integer
        
 
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
+
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        8
        
+
        8
        
 
        zset-max-ziplist-entries
        
+
        zset-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
+
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
 
        1–10,000
        
+
        1–10,000
        
 
        128
        
+
        128
        
         		
 
        9
        
+
        9
        
 
        zset-max-ziplist-value
        
+
        zset-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
+
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        10
        
+
        10
        
 
        latency-monitor-threshold
        
+
        latency-monitor-threshold
        
 
        Integer
        
+
        Integer
        
 
        The minimum amount of latency that will be logged as latency spikes
        
-
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
-
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.
        
+
        The minimum amount of latency that will be logged as latency spikes
        
+
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
+
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit the Redis official website.
        
 
        0–86,400,000 ms
        
+
        0–86,400,000 ms
        
 
        0
        
+
        0
        
         		
 
        13
        
+
        13
        
 
        notify-keyspace-events
        
+
        notify-keyspace-events
        
 
        String
        
+
        String
        
 
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
+
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
 
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
-
        K: Keyspace events, published with the __keyspace@__ prefix
        
-
        E: Keyevent events, published with the __keyevent@__ prefix
        
-
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
-
        $: String commands
        
-
        l: List commands
        
-
        s: Set commands
        
-
        h: Hash commands
        
-
        z: Sorted set commands
        
-
        x: Expired events (events generated every time a key expires)
        
-
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
-
        For more information, see the note below the table.
        
+
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
+
        K: Keyspace events, published with the __keyspace@__ prefix
        
+
        E: Keyevent events, published with the __keyevent@__ prefix
        
+
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
+
        $: String commands
        
+
        l: List commands
        
+
        s: Set commands
        
+
        h: Hash commands
        
+
        z: Sorted set commands
        
+
        x: Expired events (events generated every time a key expires)
        
+
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
+
        For more information, see the note below the table.
        
 
        Ex
        
+
        Ex
        
         		
 
        18
        
+
        18
        
 
        slowlog-log-slower-than
        
+
        slowlog-log-slower-than
        
 
        Integer
        
+
        Integer
        
 
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
+
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
 
        0–1,000,000
        
+
        0–1,000,000
        
 
        10,000
        
+
        10,000
        
         		
 
        19
        
+
        19
        
 
        slowlog-max-len
        
+
        slowlog-max-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
+
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
 
        0–1000
        
+
        0–1000
        
 
        128
        
+
        128
        
         		
 
        30
        
+
        30
        
 
        reserved-memory-percent
        
+
        reserved-memory-percent
        
 
        Integer
        
+
        Integer
        
 
        Percentage of memory reserved for non-cache memory usage.
        
+
        Percentage of memory reserved for non-cache memory usage.
        
 
        0–80
        
+
        0–80
        
 
        0
        
+
        0
        
         		
 
        
         
 
        
 
        
 
-
        Table 6 Configuration parameters of a master/standby DCS Redis 3.0 instance
        Instance Type
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 6 Configuration parameters of a master/standby DCS Redis 3.0 instance
        Instance Type
        
 
        Parameter ID
        
+
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        Master/standby Redis 3.0
        
+
        Master/standby Redis 3.0
        
 
        1
        
+
        1
        
 
        timeout
        
+
        timeout
        
 
        Integer
        
+
        Integer
        
 
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
+
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
 
        0–7200 seconds
        
+
        0–7200 seconds
        
 
        0
        
+
        0
        
         		
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
 
        noeviction
        
+
        noeviction
        
         		
 
        3
        
+
        3
        
 
        hash-max-ziplist-entries
        
+
        hash-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        4
        
+
        4
        
 
        hash-max-ziplist-value
        
+
        hash-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        5
        
+
        5
        
 
        list-max-ziplist-entries
        
+
        list-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.
        
+
        When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        6
        
+
        6
        
 
        list-max-ziplist-value
        
+
        list-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.
        
+
        When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        7
        
+
        7
        
 
        set-max-intset-entries
        
+
        set-max-intset-entries
        
 
        Integer
        
+
        Integer
        
 
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
+
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        8
        
+
        8
        
 
        zset-max-ziplist-entries
        
+
        zset-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
+
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
 
        1–10,000
        
+
        1–10,000
        
 
        128
        
+
        128
        
         		
 
        9
        
+
        9
        
 
        zset-max-ziplist-value
        
+
        zset-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
+
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        10
        
+
        10
        
 
        latency-monitor-threshold
        
+
        latency-monitor-threshold
        
 
        Integer
        
+
        Integer
        
 
        The minimum amount of latency that will be logged as latency spikes
        
-
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
-
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.
        
+
        The minimum amount of latency that will be logged as latency spikes
        
+
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
+
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit the Redis official website.
        
 
        0–86,400,000 ms
        
+
        0–86,400,000 ms
        
 
        0
        
+
        0
        
         		
 
        13
        
+
        13
        
 
        notify-keyspace-events
        
+
        notify-keyspace-events
        
 
        String
        
+
        String
        
 
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
+
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
 
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
-
        K: Keyspace events, published with the __keyspace@__ prefix
        
-
        E: Keyevent events, published with the __keyevent@__ prefix
        
-
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
-
        $: String commands
        
-
        l: List commands
        
-
        s: Set commands
        
-
        h: Hash commands
        
-
        z: Sorted set commands
        
-
        x: Expired events (events generated every time a key expires)
        
-
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
-
        For more information, see the following note.
        
+
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
+
        K: Keyspace events, published with the __keyspace@__ prefix
        
+
        E: Keyevent events, published with the __keyevent@__ prefix
        
+
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
+
        $: String commands
        
+
        l: List commands
        
+
        s: Set commands
        
+
        h: Hash commands
        
+
        z: Sorted set commands
        
+
        x: Expired events (events generated every time a key expires)
        
+
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
+
        For more information, see the following note.
        
 
        Ex
        
+
        Ex
        
         		
 
        14
        
+
        14
        
 
        repl-backlog-size
        
+
        repl-backlog-size
        
 
        Integer
        
+
        Integer
        
 
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
+
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
 
        16,384–1,073,741,824
        
+
        16,384–1,073,741,824
        
 
        1,048,576
        
+
        1,048,576
        
         		
 
        15
        
+
        15
        
 
        repl-backlog-ttl
        
+
        repl-backlog-ttl
        
 
        Integer
        
+
        Integer
        
 
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
+
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
 
        0–604,800
        
+
        0–604,800
        
 
        3600
        
+
        3600
        
         		
 
        16
        
+
        16
        
 
        appendfsync
        
+
        appendfsync
        
 
        String
        
+
        String
        
 
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
+
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
 
        Redis calls fsync() in one of the following ways:
        
-
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
-
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
+
        Redis calls fsync() in one of the following ways:
        
+
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
+
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
 
        everysec
        
+
        everysec
        
         		
 
        17
        
+
        17
        
 
        appendonly
        
+
        appendonly
        
 
        String
        
+
        String
        
 
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
+
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
 
        yes,no
        
+
        yes,no
        
 
        yes
        
+
        yes
        
         		
 
        18
        
+
        18
        
 
        slowlog-log-slower-than
        
+
        slowlog-log-slower-than
        
 
        Integer
        
+
        Integer
        
 
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
+
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
 
        0–1,000,000
        
+
        0–1,000,000
        
 
        10,000
        
+
        10,000
        
         		
 
        19
        
+
        19
        
 
        slowlog-max-len
        
+
        slowlog-max-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
+
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
 
        0–1000
        
+
        0–1000
        
 
        128
        
+
        128
        
         		
 
        30
        
+
        30
        
 
        reserved-memory-percent
        
+
        reserved-memory-percent
        
 
        Integer
        
+
        Integer
        
 
        Percentage of memory reserved for non-cache memory usage.
        
+
        Percentage of memory reserved for non-cache memory usage.
        
 
        0–80
        
+
        0–80
        
 
        0
        
+
        0
        
         		
 
        
         
 
        
 
        
 
-
        Table 7 Configuration parameters of a Proxy Cluster DCS Redis 3.0 instance
        Instance Type
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 7 Configuration parameters of a Proxy Cluster DCS Redis 3.0 instance
        Instance Type
        
 
        Parameter ID
        
+
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        Proxy Cluster Redis 3.0
        
+
        Proxy Cluster Redis 3.0
        
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
 
        volatile-lru
        
+
        volatile-lru
        
         		
 
        
         
 
        
 
        
 
-
        Table 8 Configuration parameters of a single-node DCS Redis 4.0 or 5.0 instance
        Instance Type
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 8 Configuration parameters of a single-node DCS Redis 4.0 or 5.0 instance
        Instance Type
        
 
        Parameter ID
        
+
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        Single-node Redis 4.0 or 5.0
        
+
        Single-node Redis 4.0 or 5.0
        
 
        1
        
+
        1
        
 
        timeout
        
+
        timeout
        
 
        Integer
        
+
        Integer
        
 
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
+
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
 
        0–7200 seconds
        
+
        0–7200 seconds
        
 
        0
        
+
        0
        
         		
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
-
        volatile-lfu
        
-
        allkeys-lfu
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
+
        volatile-lfu
        
+
        allkeys-lfu
        
 
        volatile-lru
        
+
        volatile-lru
        
         		
 
        3
        
+
        3
        
 
        hash-max-ziplist-entries
        
+
        hash-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        4
        
+
        4
        
 
        hash-max-ziplist-value
        
+
        hash-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        7
        
+
        7
        
 
        set-max-intset-entries
        
+
        set-max-intset-entries
        
 
        Integer
        
+
        Integer
        
 
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
+
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        8
        
+
        8
        
 
        zset-max-ziplist-entries
        
+
        zset-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
+
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
 
        1–10,000
        
+
        1–10,000
        
 
        128
        
+
        128
        
         		
 
        9
        
+
        9
        
 
        zset-max-ziplist-value
        
+
        zset-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
+
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        10
        
+
        10
        
 
        latency-monitor-threshold
        
+
        latency-monitor-threshold
        
 
        Integer
        
+
        Integer
        
 
        The minimum amount of latency that will be logged as latency spikes
        
-
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
-
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.
        
+
        The minimum amount of latency that will be logged as latency spikes
        
+
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
+
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit the Redis official website.
        
 
        0–86,400,000 ms
        
+
        0–86,400,000 ms
        
 
        0
        
+
        0
        
         		
 
        11
        
+
        11
        
 
        maxclients
        
+
        maxclients
        
 
        Integer
        
+
        Integer
        
 
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
+
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
 
        1000–50,000
        
+
        1000–50,000
        
 
        10,000
        
+
        10,000
        
         		
 
        13
        
+
        13
        
 
        notify-keyspace-events
        
+
        notify-keyspace-events
        
 
        String
        
+
        String
        
 
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
+
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
 
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
-
        K: Keyspace events, published with the __keyspace@__ prefix
        
-
        E: Keyevent events, published with the __keyevent@__ prefix
        
-
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
-
        $: String commands
        
-
        l: List commands
        
-
        s: Set commands
        
-
        h: Hash commands
        
-
        z: Sorted set commands
        
-
        x: Expired events (events generated every time a key expires)
        
-
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
-
        For more information, see the following note.
        
+
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
+
        K: Keyspace events, published with the __keyspace@__ prefix
        
+
        E: Keyevent events, published with the __keyevent@__ prefix
        
+
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
+
        $: String commands
        
+
        l: List commands
        
+
        s: Set commands
        
+
        h: Hash commands
        
+
        z: Sorted set commands
        
+
        x: Expired events (events generated every time a key expires)
        
+
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
+
        For more information, see the following note.
        
 
        Ex
        
+
        Ex
        
         		
 
        18
        
+
        18
        
 
        slowlog-log-slower-than
        
+
        slowlog-log-slower-than
        
 
        Integer
        
+
        Integer
        
 
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
+
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
 
        0–1,000,000
        
+
        0–1,000,000
        
 
        10,000
        
+
        10,000
        
         		
 
        19
        
+
        19
        
 
        slowlog-max-len
        
+
        slowlog-max-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
+
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
 
        0–1000
        
+
        0–1000
        
 
        128
        
+
        128
        
         		
 
        20
        
+
        20
        
 
        lua-time-limit
        
+
        lua-time-limit
        
 
        Integer
        
+
        Integer
        
 
        The maximum time allowed for executing a Lua script, in milliseconds.
        
+
        The maximum time allowed for executing a Lua script, in milliseconds.
        
 
        100–5000
        
+
        100–5000
        
 
        5000
        
+
        5000
        
         		
 
        22
        
+
        22
        
 
        proto-max-bulk-len
        
+
        proto-max-bulk-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum size (in bytes) of a single element request.
        
+
        The maximum size (in bytes) of a single element request.
        
 
        1,048,576–536,870,912
        
+
        1,048,576–536,870,912
        
 
        536,870,912
        
+
        536,870,912
        
         		
 
        23
        
+
        23
        
 
        master-read-only
        
+
        master-read-only
        
 
        String
        
+
        String
        
 
        Sets the instance to be read-only. All write operations will fail.
        
+
        Sets the instance to be read-only. All write operations will fail.
        
 
        yes,no
        
+
        yes,no
        
 
        no
        
+
        no
        
         		
 
        
         
 
        
 
        
 
-
        Table 9 Configuration parameters of a master/standby DCS Redis 4.0 or 5.0 instance
        Instance Type
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 9 Configuration parameters of a master/standby DCS Redis 4.0 or 5.0 instance
        Instance Type
        
 
        Parameter ID
        
+
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        Master/standby Redis 4.0 or 5.0
        
+
        Master/standby Redis 4.0 or 5.0
        
 
        1
        
+
        1
        
 
        timeout
        
+
        timeout
        
 
        Integer
        
+
        Integer
        
 
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
+
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
 
        0–7200 seconds
        
+
        0–7200 seconds
        
 
        0
        
+
        0
        
         		
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
-
        volatile-lfu
        
-
        allkeys-lfu
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
+
        volatile-lfu
        
+
        allkeys-lfu
        
 
        volatile-lru
        
+
        volatile-lru
        
         		
 
        3
        
+
        3
        
 
        hash-max-ziplist-entries
        
+
        hash-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        4
        
+
        4
        
 
        hash-max-ziplist-value
        
+
        hash-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        7
        
+
        7
        
 
        set-max-intset-entries
        
+
        set-max-intset-entries
        
 
        Integer
        
+
        Integer
        
 
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
+
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        8
        
+
        8
        
 
        zset-max-ziplist-entries
        
+
        zset-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
+
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
 
        1–10,000
        
+
        1–10,000
        
 
        128
        
+
        128
        
         		
 
        9
        
+
        9
        
 
        zset-max-ziplist-value
        
+
        zset-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
+
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        10
        
+
        10
        
 
        latency-monitor-threshold
        
+
        latency-monitor-threshold
        
 
        Integer
        
+
        Integer
        
 
        The minimum amount of latency that will be logged as latency spikes
        
-
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
-
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.
        
+
        The minimum amount of latency that will be logged as latency spikes
        
+
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
+
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit the Redis official website.
        
 
        0–86,400,000 ms
        
+
        0–86,400,000 ms
        
 
        0
        
+
        0
        
         		
 
        11
        
+
        11
        
 
        maxclients
        
+
        maxclients
        
 
        Integer
        
+
        Integer
        
 
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
+
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
 
        1000–50,000
        
+
        1000–50,000
        
 
        10,000
        
+
        10,000
        
         		
 
        13
        
+
        13
        
 
        notify-keyspace-events
        
+
        notify-keyspace-events
        
 
        String
        
+
        String
        
 
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
+
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
 
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
-
        K: Keyspace events, published with the __keyspace@__ prefix
        
-
        E: Keyevent events, published with the __keyevent@__ prefix
        
-
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
-
        $: String commands
        
-
        l: List commands
        
-
        s: Set commands
        
-
        h: Hash commands
        
-
        z: Sorted set commands
        
-
        x: Expired events (events generated every time a key expires)
        
-
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
-
        For more information, see the note below the table.
        
+
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
+
        K: Keyspace events, published with the __keyspace@__ prefix
        
+
        E: Keyevent events, published with the __keyevent@__ prefix
        
+
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
+
        $: String commands
        
+
        l: List commands
        
+
        s: Set commands
        
+
        h: Hash commands
        
+
        z: Sorted set commands
        
+
        x: Expired events (events generated every time a key expires)
        
+
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
+
        For more information, see the note below the table.
        
 
        Ex
        
+
        Ex
        
         		
 
        14
        
+
        14
        
 
        repl-backlog-size
        
+
        repl-backlog-size
        
 
        Integer
        
+
        Integer
        
 
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
+
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
 
        16,384–1,073,741,824
        
+
        16,384–1,073,741,824
        
 
        1,048,576
        
+
        1,048,576
        
         		
 
        15
        
+
        15
        
 
        repl-backlog-ttl
        
+
        repl-backlog-ttl
        
 
        IntegerInteger
        
+
        IntegerInteger
        
 
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
+
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
 
        0–604,800
        
+
        0–604,800
        
 
        3600
        
+
        3600
        
         		
 
        16
        
+
        16
        
 
        appendfsync
        
+
        appendfsync
        
 
        String
        
+
        String
        
 
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
+
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
 
        Redis calls fsync() in one of the following ways:
        
-
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
-
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
+
        Redis calls fsync() in one of the following ways:
        
+
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
+
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
 
        everysec
        
+
        everysec
        
         		
 
        17
        
+
        17
        
 
        appendonly
        
+
        appendonly
        
 
        String
        
+
        String
        
 
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
+
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
 
        yes,no
        
+
        yes,no
        
 
        yes
        
+
        yes
        
         		
 
        18
        
+
        18
        
 
        slowlog-log-slower-than
        
+
        slowlog-log-slower-than
        
 
        Integer
        
+
        Integer
        
 
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
+
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
 
        0–1,000,000
        
+
        0–1,000,000
        
 
        10,000
        
+
        10,000
        
         		
 
        19
        
+
        19
        
 
        slowlog-max-len
        
+
        slowlog-max-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
+
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
 
        0–1000
        
+
        0–1000
        
 
        128
        
+
        128
        
         		
 
        20
        
+
        20
        
 
        lua-time-limit
        
+
        lua-time-limit
        
 
        Integer
        
+
        Integer
        
 
        The maximum time allowed for executing a Lua script, in milliseconds.
        
+
        The maximum time allowed for executing a Lua script, in milliseconds.
        
 
        100–5000
        
+
        100–5000
        
 
        5000
        
+
        5000
        
         		
 
        21
        
+
        21
        
 
        repl-timeout
        
+
        repl-timeout
        
 
        Integer
        
+
        Integer
        
 
        Replication timeout, in seconds.
        
+
        Replication timeout, in seconds.
        
 
        30–3600
        
+
        30–3600
        
 
        60
        
+
        60
        
         		
 
        22
        
+
        22
        
 
        proto-max-bulk-len
        
+
        proto-max-bulk-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum size (in bytes) of a single element request.
        
+
        The maximum size (in bytes) of a single element request.
        
 
        1,048,576–536,870,912
        
+
        1,048,576–536,870,912
        
 
        536,870,912
        
+
        536,870,912
        
         		
 
        23
        
+
        23
        
 
        master-read-only
        
+
        master-read-only
        
 
        String
        
+
        String
        
 
        Sets the instance to be read-only. All write operations will fail.
        
+
        Sets the instance to be read-only. All write operations will fail.
        
 
        yes,no
        
+
        yes,no
        
 
        no
        
+
        no
        
         		
 
        24
        
+
        24
        
 
        client-output-buffer-slave-soft-limit
        
+
        client-output-buffer-slave-soft-limit
        
 
        Integer
        
+
        Integer
        
 
        Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
        
+
        Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
        
 
        0–134,217,728
        
+
        0–134,217,728
        
 
        13,421,772
        
+
        13,421,772
        
         		
 
        25
        
+
        25
        
 
        client-output-buffer-slave-hard-limit
        
+
        client-output-buffer-slave-hard-limit
        
 
        Integer
        
+
        Integer
        
 
        Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
        
+
        Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
        
 
        0–134,217,728
        
+
        0–134,217,728
        
 
        13,421,772
        
+
        13,421,772
        
         		
 
        26
        
+
        26
        
 
        client-output-buffer-limit-slave-soft-seconds
        
+
        client-output-buffer-limit-slave-soft-seconds
        
 
        Integer
        
+
        Integer
        
 
        Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
        
+
        Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
        
 
        0–60
        
+
        0–60
        
 
        60
        
+
        60
        
         		
 
        
         
 
        
 
        
 
-
        Table 10 Configuration parameters of a Redis Cluster DCS Redis 4.0 or 5.0 instance
        Instance Type
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 10 Configuration parameters of a Redis Cluster DCS Redis 4.0 or 5.0 instance
        Instance Type
        
 
        Parameter ID
        
+
        Parameter ID
        
 
        Parameter Name
        
+
        Parameter Name
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
 
        Value Range
        
+
        Value Range
        
 
        Default Value
        
+
        Default Value
        
         		
 
        
 
        Redis 4.0 or 5.0 Redis cluster
        
+
        Redis 4.0 or 5.0 Redis cluster
        
 
        1
        
+
        1
        
 
        timeout
        
+
        timeout
        
 
        Integer
        
+
        Integer
        
 
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
+
        Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.
        
 
        0–7200 seconds
        
+
        0–7200 seconds
        
 
        0
        
+
        0
        
         		
 
        2
        
+
        2
        
 
        maxmemory-policy
        
+
        maxmemory-policy
        
 
        String
        
+
        String
        
 
        How Redis will select what to remove when maxmemory is reached.
        
-
        For details about key eviction, see the Redis official website.
        
+
        How Redis will select what to remove when maxmemory is reached.
        
+
        For details about key eviction, see the Redis official website.
        
 
        volatile-lru
        
-
        allkeys-lru
        
-
        volatile-random
        
-
        allkeys-random
        
-
        volatile-ttl
        
-
        noeviction
        
-
        volatile-lfu
        
-
        allkeys-lfu
        
+
        volatile-lru
        
+
        allkeys-lru
        
+
        volatile-random
        
+
        allkeys-random
        
+
        volatile-ttl
        
+
        noeviction
        
+
        volatile-lfu
        
+
        allkeys-lfu
        
 
        volatile-lru
        
+
        volatile-lru
        
         		
 
        3
        
+
        3
        
 
        hash-max-ziplist-entries
        
+
        hash-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        4
        
+
        4
        
 
        hash-max-ziplist-value
        
+
        hash-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
+
        When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        7
        
+
        7
        
 
        set-max-intset-entries
        
+
        set-max-intset-entries
        
 
        Integer
        
+
        Integer
        
 
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
+
        When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        512
        
+
        512
        
         		
 
        8
        
+
        8
        
 
        zset-max-ziplist-entries
        
+
        zset-max-ziplist-entries
        
 
        Integer
        
+
        Integer
        
 
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
+
        When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.
        
 
        1–10,000
        
+
        1–10,000
        
 
        128
        
+
        128
        
         		
 
        9
        
+
        9
        
 
        zset-max-ziplist-value
        
+
        zset-max-ziplist-value
        
 
        Integer
        
+
        Integer
        
 
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
+
        When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.
        
 
        1–10,000
        
+
        1–10,000
        
 
        64
        
+
        64
        
         		
 
        10
        
+
        10
        
 
        latency-monitor-threshold
        
+
        latency-monitor-threshold
        
 
        Integer
        
+
        Integer
        
 
        The minimum amount of latency that will be logged as latency spikes
        
-
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
-
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.
        
+
        The minimum amount of latency that will be logged as latency spikes
        
+
        If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.
        
+
        By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit the Redis official website.
        
 
        0–86,400,000 ms
        
+
        0–86,400,000 ms
        
 
        0
        
+
        0
        
         		
 
        11
        
+
        11
        
 
        maxclients
        
+
        maxclients
        
 
        Integer
        
+
        Integer
        
 
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
+
        The maximum number of clients allowed to be concurrently connected to a DCS instance.
        
 
        1000–50,000
        
+
        1000–50,000
        
 
        10,000
        
+
        10,000
        
         		
 
        13
        
+
        13
        
 
        notify-keyspace-events
        
+
        notify-keyspace-events
        
 
        String
        
+
        String
        
 
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
+
        Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.
        
 
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
-
        K: Keyspace events, published with the __keyspace@__ prefix
        
-
        E: Keyevent events, published with the __keyevent@__ prefix
        
-
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
-
        $: String commands
        
-
        l: List commands
        
-
        s: Set commands
        
-
        h: Hash commands
        
-
        z: Sorted set commands
        
-
        x: Expired events (events generated every time a key expires)
        
-
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
-
        For more information, see the note below the table.
        
+
        If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.
        
+
        K: Keyspace events, published with the __keyspace@__ prefix
        
+
        E: Keyevent events, published with the __keyevent@__ prefix
        
+
        g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME
        
+
        $: String commands
        
+
        l: List commands
        
+
        s: Set commands
        
+
        h: Hash commands
        
+
        z: Sorted set commands
        
+
        x: Expired events (events generated every time a key expires)
        
+
        e: Evicted events (events generated when a key is evicted for maxmemory)
        
+
        For more information, see the note below the table.
        
 
        Ex
        
+
        Ex
        
         		
 
        14
        
+
        14
        
 
        repl-backlog-size
        
+
        repl-backlog-size
        
 
        Integer
        
+
        Integer
        
 
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
+
        The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.
        
 
        16,384–1,073,741,824
        
+
        16,384–1,073,741,824
        
 
        1,048,576
        
+
        1,048,576
        
         		
 
        15
        
+
        15
        
 
        repl-backlog-ttl
        
+
        repl-backlog-ttl
        
 
        Integer
        
+
        Integer
        
 
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
+
        The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.
        
 
        0–604,800
        
+
        0–604,800
        
 
        3600
        
+
        3600
        
         		
 
        16
        
+
        16
        
 
        appendfsync
        
+
        appendfsync
        
 
        String
        
+
        String
        
 
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
+
        Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.
        
 
        Redis calls fsync() in one of the following ways:
        
-
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
-
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
+
        Redis calls fsync() in one of the following ways:
        
+
        no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.
        
+
        always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.
        
 
        everysec
        
+
        everysec
        
         		
 
        17
        
+
        17
        
 
        appendonly
        
+
        appendonly
        
 
        String
        
+
        String
        
 
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
+
        Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.
        
 
        yes,no
        
+
        yes,no
        
 
        yes
        
+
        yes
        
         		
 
        18
        
+
        18
        
 
        slowlog-log-slower-than
        
+
        slowlog-log-slower-than
        
 
        Integer
        
+
        Integer
        
 
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
+
        Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.
        
 
        0–1,000,000
        
+
        0–1,000,000
        
 
        10,000
        
+
        10,000
        
         		
 
        19
        
+
        19
        
 
        slowlog-max-len
        
+
        slowlog-max-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
+
        The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.
        
 
        0–1000
        
+
        0–1000
        
 
        128
        
+
        128
        
         		
 
        20
        
+
        20
        
 
        lua-time-limit
        
+
        lua-time-limit
        
 
        Integer
        
+
        Integer
        
 
        The maximum time allowed for executing a Lua script, in milliseconds.
        
+
        The maximum time allowed for executing a Lua script, in milliseconds.
        
 
        100–5000
        
+
        100–5000
        
 
        5000
        
+
        5000
        
         		
 
        21
        
+
        21
        
 
        repl-timeout
        
+
        repl-timeout
        
 
        Integer
        
+
        Integer
        
 
        Replication timeout, in seconds.
        
+
        Replication timeout, in seconds.
        
 
        30–3600
        
+
        30–3600
        
 
        60
        
+
        60
        
         		
 
        22
        
+
        22
        
 
        proto-max-bulk-len
        
+
        proto-max-bulk-len
        
 
        Integer
        
+
        Integer
        
 
        The maximum size (in bytes) of a single element request.
        
+
        The maximum size (in bytes) of a single element request.
        
 
        1,048,576–536,870,912
        
+
        1,048,576–536,870,912
        
 
        536,870,912
        
+
        536,870,912
        
         		
 
        23
        
+
        23
        
 
        master-read-only
        
+
        master-read-only
        
 
        String
        
+
        String
        
 
        Sets the instance to be read-only. All write operations will fail.
        
+
        Sets the instance to be read-only. All write operations will fail.
        
 
        yes,no
        
+
        yes,no
        
 
        no
        
+
        no
        
         		
 
        24
        
+
        24
        
 
        client-output-buffer-slave-soft-limit
        
+
        client-output-buffer-slave-soft-limit
        
 
        Integer
        
+
        Integer
        
 
        Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
        
+
        Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.
        
 
        0–134,217,728
        
+
        0–134,217,728
        
 
        13,421,772
        
+
        13,421,772
        
         		
 
        25
        
+
        25
        
 
        client-output-buffer-slave-hard-limit
        
+
        client-output-buffer-slave-hard-limit
        
 
        Integer
        
+
        Integer
        
 
        Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
        
+
        Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.
        
 
        0–134,217,728
        
+
        0–134,217,728
        
 
        13,421,772
        
+
        13,421,772
        
         		
 
        26
        
+
        26
        
 
        client-output-buffer-limit-slave-soft-seconds
        
+
        client-output-buffer-limit-slave-soft-seconds
        
 
        Integer
        
+
        Integer
        
 
        Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
        
+
        Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.
        
 
        0–60
        
+
        0–60
        
 
        60
        
+
        60
        
         		
 
        
         
 
        
 
        
-
         
        More about the notify-keyspace-events parameter:
        
-
        • Allowed characters are K, E, KE, A, g, l, s, h, z, x, e, and $. The parameter value must contain either K or E.
        • A is an alias for g$lshzxe and cannot be used together with any of the characters in g$lshzxe.
        • For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
        
+
         
        More about the notify-keyspace-events parameter:
        
+
        • Allowed characters are K, E, KE, A, g, l, s, h, z, x, e, and $. The parameter value must contain either K or E.
        • A is an alias for g$lshzxe and cannot be used together with any of the characters in g$lshzxe.
        • For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
        
 
        
-
        Example response
        {
+
        Example response
        {
     "status": "RUNNING",
     "instance_id": "c08fdc6e-5c25-4185-ab57-c0a5529b727f",
     "redis_config": [
@@ -2154,17 +2154,17 @@
 }
        
 
        
 
        
-
        Status Code
        Table 11 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 11 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 11 Status code
        Status Code
        
+
        
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312016.html b/docs/dcs/api-ref/dcs-api-0312016.html
index e7ed9400..8bd27a59 100644
--- a/docs/dcs/api-ref/dcs-api-0312016.html
+++ b/docs/dcs/api-ref/dcs-api-0312016.html
@@ -1,37 +1,37 @@
 
        Querying DCS Instance Status
        
-
        Function
        This API is used to query the number of instances in different states.
        
+
        Function
        This API is used to query the number of instances in different states.
        
 
        
-
        URI
        GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}
        
-
        Table 1 describes the parameters.
-
        Table 11 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        Instance configurations queried successfully.
        
+
        Instance configurations queried successfully.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        GET /v1.0/{project_id}/instances/status?include_failure={include_failure}
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -39,148 +39,303 @@
 
-
        Request
        Request parameters
        
-
        None
        
-
        Example request
        
-
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?includeFailure=true
        
+
        Request
        Request parameters
        
+
        None
        
+
        Example request
        
+
        GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?include_failure=true
        
 
        
-
        Response
        Response parameters
        
-
        Table 2 describes the response parameters.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        includeFailure
        
+
        include_failure
        
 
        String
        
+
        String
        
 
        No
        
+
        No
        
 
        An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options:
        
-
        • true: The number of DCS instances that failed to be created will be returned to the API caller.
        • false or others: The number of DCS instances that failed to be created will not be returned to the API caller.
        
+
        An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options:
        
+
        • true: The number of DCS instances that failed to be created will be returned to the API caller.
        • false or others: The number of DCS instances that failed to be created will not be returned to the API caller.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Response
        Response parameters
        
+
        Table 2 describes the response parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Description
        
+
        Description
        
         		
 
        
 
        creating_count
        
+
        redis
        
 
        Integer
        
+
        StatusStatistic object
        
 
        Number of instances that are being created.
        
+
        Redis instance quantity statistics.
        
         		
 
        deleting_count
        
+
        creating_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that are being deleted.
        
+
        Number of instances that are being created.
        
         		
 
        running_count
        
+
        deleting_count
        
 
        Integer
        
+
        Integer
        
 
        Number of running instances.
        
+
        Number of instances that are being deleted.
        
         		
 
        error_count
        
+
        running_count
        
 
        Integer
        
+
        Integer
        
 
        Number of abnormal instances.
        
+
        Number of running instances.
        
         		
 
        restarting_count
        
+
        error_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that are being restarted.
        
+
        Number of abnormal instances.
        
         		
 
        createfailed_count
        
+
        restarting_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that fail to be created.
        
+
        Number of instances that are being restarted.
        
         		
 
        extending_count
        
+
        createfailed_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that are being scaled up.
        
+
        Number of instances that fail to be created.
        
         		
 
        upgrading_count
        
+
        extending_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that are being upgraded.
        
+
        Number of instances that are being scaled up.
        
         		
 
        paying_count
        
+
        upgrading_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances for which payment is in progress.
        
+
        Number of instances that are being upgraded.
        
         		
 
        migrating_count
        
+
        paying_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances on which data migration is in progress.
        
+
        Number of instances for which payment is in progress.
        
         		
 
        flushing_count
        
+
        migrating_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances whose data is being cleared.
        
+
        Number of instances on which data migration is in progress.
        
         		
 
        closed_count
        
+
        flushing_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that have been stopped.
        
+
        Number of instances whose data is being cleared.
        
         		
 
        starting_count
        
+
        closed_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that are being started.
        
+
        Number of instances that have been stopped.
        
         		
 
        closing_count
        
+
        starting_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances that are being stopped.
        
+
        Number of instances that are being started.
        
         		
 
        restoring_count
        
+
        closing_count
        
 
        Integer
        
+
        Integer
        
 
        Number of instances for which data restoration is in progress.
        
+
        Number of instances that are being stopped.
        
+
        restoring_count
        
+
        Integer
        
+
        Number of instances for which data restoration is in progress.
        
         		
 
        
         
 
        
 
        
 
        
-
        Example response
        
-
        
-
        {"memcached":{
-    "paying_count":0,
-    "migrating_count":0,
-    "error_count":0,
-    "restarting_count":0,
-    "createfailed_count":0,
-    "flushing_count":0,
-    "closed_count":0,
-    "extending_count":0,
-    "creating_count":0,
-    "starting_count":0,
-    "closing_count":0,
-    "running_count":0,
-    "upgrading_count":0,
-    "restoring_count":0
-   },
+
+
        
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
        Table 3 StatusStatistic
        Parameter
        
+
        Type
        
+
        Description
        
+
        paying_count
        
+
        Integer
        
+
        Number of instances for which payment is in progress.
        
+
        migrating_count
        
+
        Integer
        
+
        Number of instances on which data migration is in progress.
        
+
        flushing_count
        
+
        Integer
        
+
        Number of instances whose data is being cleared.
        
+
        upgrading_count
        
+
        Integer
        
+
        Number of instances that are being upgraded.
        
+
        restoring_count
        
+
        Integer
        
+
        Number of instances for which data restoration is in progress.
        
+
        extending_count
        
+
        Integer
        
+
        Number of instances that are being scaled up.
        
+
        creating_count
        
+
        Integer
        
+
        Number of instances that are being created.
        
+
        running_count
        
+
        Integer
        
+
        Number of running instances.
        
+
        error_count
        
+
        Integer
        
+
        Number of abnormal instances.
        
+
        createfailed_count
        
+
        Integer
        
+
        Number of instances that fail to be created.
        
+
        restarting_count
        
+
        Integer
        
+
        Number of instances that are being restarted.
        
+
        
+
        
+
        Status code: 400
        
+
+
        
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
        Table 4 Response body parameters
        Parameter
        
+
        Type
        
+
        Description
        
+
        error_msg
        
+
        String
        
+
        Error message.
        
+
        Maximum length: 1024 characters
        
+
        error_code
        
+
        String
        
+
        Error code.
        
+
        Maximum length: 9 characters
        
+
        error_ext_msg
        
+
        String
        
+
        Extended error information. This parameter is not used currently and is set to null.
        
+
        Maximum length: 1024 characters
        
+
        
+
        
+
        Status code: 500
        
+
+
        
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
        Table 5 Response body parameters
        Parameter
        
+
        Type
        
+
        Description
        
+
        error_msg
        
+
        String
        
+
        Error message.
        
+
        Maximum length: 1024 characters
        
+
        error_code
        
+
        String
        
+
        Error code.
        
+
        Maximum length: 9 characters
        
+
        error_ext_msg
        
+
        String
        
+
        Extended error information. This parameter is not used currently and is set to null.
        
+
        Maximum length: 1024 characters
        
+
        
+
        
+
        Example response
        
+
        
+
        {
 "paying_count":0,
 "migrating_count":0,
 "error_count":0,
@@ -214,17 +369,27 @@
 }
        
 
        
 
        
-
        Status Code
        Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
        
+
        Status Code
        Table 6 describes the status code of successful operations. For details about other status codes, see Table 1.
        
 
-
        Table 3 Status code
        Status Code
        
+
        
-
-
-
+
+
+
+
+
+
diff --git a/docs/dcs/api-ref/dcs-api-0312017.html b/docs/dcs/api-ref/dcs-api-0312017.html
index 94ba2f3d..c3bf2817 100644
--- a/docs/dcs/api-ref/dcs-api-0312017.html
+++ b/docs/dcs/api-ref/dcs-api-0312017.html
@@ -1,36 +1,36 @@
 
        Modifying Configuration Parameters
        
-
        Function
        You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.
        
+
        Function
        You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.
        
 
        
-
        URI
        PUT /v1.0/{project_id}/instances/{instance_id}/configs
        
-
        Table 1 describes the parameters.
-
        Table 6 Status code
        Status Code
        
 
        Description
        
+
        Description
        
         		
 
        
 
        200
        
+
        200
        
 
        Quantities of DCS instances in different statuses queried successfully.
        
+
        Quantities of DCS instances in different statuses queried successfully.
        
+
        400
        
+
        The request is invalid.
        
+
        500
        
+
        Internal service error.
        
         		
 
        
         
 
 
        Table 1 Parameter description
        Parameter
        
+
        URI
        PUT /v1.0/{project_id}/instances/{instance_id}/configs
        
+
        Table 1 describes the parameters.
+
        
-
-
-
-
-
-
-
-
-
-
-
@@ -38,25 +38,25 @@
 
-
        Request
        Request parameters
        
-
        Table 2 describes the request parameters.
-
        Table 1 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        project_id
        
+
        project_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Project ID.
        
+
        Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
        
         		
 
        instance_id
        
+
        instance_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        ID of the instance to be modified.
        
+
        ID of the instance to be modified.
        
         		
 
        
         
 
 
        Table 2 Parameter description
        Parameter
        
+
        Request
        Request parameters
        
+
        Table 2 describes the request parameters.
+
        
-
-
-
-
-
-
-
@@ -64,51 +64,51 @@
 
 
-
        Table 2 Parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        redis_config
        
+
        redis_config
        
 
        Array
        
+
        Array
        
 
        Yes
        
+
        Yes
        
 
        Array of configuration items of the DCS instance.
        
+
        Array of configuration items of the DCS instance.
        
         		
 
        
         
 
        Table 3 redis_config parameter description
        Parameter
        
+
        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        Table 3 redis_config parameter description
        Parameter
        
 
        Type
        
+
        Type
        
 
        Mandatory
        
+
        Mandatory
        
 
        Description
        
+
        Description
        
         		
 
        
 
        param_id
        
+
        param_id
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Configuration item ID.
        
+
        Configuration item ID.
        
         		
 
        param_name
        
+
        param_name
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Configuration item name.
        
+
        Configuration item name.
        
         		
 
        param_value
        
+
        param_value
        
 
        String
        
+
        String
        
 
        Yes
        
+
        Yes
        
 
        Value of the configuration item.
        
+
        Value of the configuration item.
        
         		
 
        
         
 
        
 
        
-
        For possible values of parameters in Table 3, see Table 4.
        
-
        Example request
        
-
        • Request URL:
          PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
          
+
          For possible values of parameters in Table 3, see Table 4.
          
+
          Example request
          
+
          • Request URL:
            PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
            
 
          
-
          • Example:
            { 
+
            • Example:
              { 
     "redis_config": [ 
         { 
             "param_id": "1", 
@@ -119,22 +119,22 @@
 }
              
 
            
 
-
            Response
            Response parameters
            
-
            None
            
-
            Example response
            
-
            None
            
+
            Response
            Response parameters
            
+
            None
            
+
            Example response
            
+
            None
            
 
            
-
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 4 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312018.html b/docs/dcs/api-ref/dcs-api-0312018.html
index af96347c..48bad014 100644
--- a/docs/dcs/api-ref/dcs-api-0312018.html
+++ b/docs/dcs/api-ref/dcs-api-0312018.html
@@ -1,28 +1,28 @@
 
            Restarting DCS Instances or Clearing DCS Instance Data
            
-
            Function
            This API is used to restart a running DCS instance.
            
-
            Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.
            
+
            Function
            This API is used to restart a running DCS instance.
            
+
            Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.
            
 
            
-
            URI
            PUT /v1.0/{project_id}/instances/status
            
-
            Table 1 describes the parameter.
-
            Table 4 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            204
            
+
            204
            
 
            DCS instance configurations modified successfully.
            
+
            DCS instance configurations modified successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            PUT /v1.0/{project_id}/instances/status
            
+
            Table 1 describes the parameter.
+
            
-
-
-
-
-
-
-
@@ -30,46 +30,46 @@
 
-
            Request
            Request parameters
            
-
            Table 2 describes the request parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Request
            Request parameters
            
+
            Table 2 describes the request parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            action
            
+
            action
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Action performed on DCS instances. Options: restart, and flush.
            
-
             NOTE: 
            Only DCS Redis 4.0 and 5.0 instances can be flushed.
            
+
            Action performed on DCS instances. Options: restart, and flush.
            
+
             NOTE: 
            Only DCS Redis 4.0 and 5.0 instances can be flushed.
            
 
            
             		
 
            instances
            
+
            instances
            
 
            Array
            
+
            Array
            
 
            Yes
            
+
            Yes
            
 
            List of DCS instance IDs.
            
+
            List of DCS instance IDs.
            
             		
 
            
             
 
            
 
            
 
            
-
            Example request
            
-
            • Request URL:
              PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status
              
+
              Example request
              
+
              • Request URL:
                PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status
                
 
              
-
              • Example:
                {
+
                • Example:
                  {
     "action": "restart",
     "instances": [
         "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
@@ -77,21 +77,21 @@
 }
                  
 
                
 
            
-
            Response
            Response parameters
            
-
            Table 3 describes the response parameter.
-
            Table 3 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 3 describes the response parameter.
+
            
-
-
-
-
-
@@ -99,32 +99,32 @@
 
 
-
            Table 3 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            results
            
+
            results
            
 
            Array
            
+
            Array
            
 
            Indicates the result of instance modification.
            
+
            Indicates the result of instance modification.
            
             		
 
            
             
 
            Table 4 results parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
            Table 4 results parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            instance
            
+
            instance
            
 
            String
            
+
            String
            
 
            DCS instance ID.
            
+
            DCS instance ID.
            
             		
 
            result
            
+
            result
            
 
            String
            
+
            String
            
 
            Instance modification result. Options: success or failed
            
+
            Instance modification result. Options: success or failed
            
             		
 
            
             
 
            
 
            
-
            Example response
            {
+
            Example response
            {
     "results": [
         {
             "result": "success",
@@ -134,17 +134,17 @@
 }
            
 
            
 
            
-
            Status Code
            Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 5 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312019.html b/docs/dcs/api-ref/dcs-api-0312019.html
index 2a16da38..df8f17de 100644
--- a/docs/dcs/api-ref/dcs-api-0312019.html
+++ b/docs/dcs/api-ref/dcs-api-0312019.html
@@ -1,36 +1,36 @@
 
            Changing the Password of a DCS Instance
            
-
            Function
            This API is used to change the password of a DCS instance.
            
+
            Function
            This API is used to change the password of a DCS instance.
            
 
            
-
            URI
            PUT /v1.0/{project_id}/instances/{instance_id}/password
            
-
            Table 1 describes the parameters.
-
            Table 5 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Successfully restarted DCS instance or cleared DCS instance data.
            
+
            Successfully restarted DCS instance or cleared DCS instance data.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            PUT /v1.0/{project_id}/instances/{instance_id}/password
            
+
            Table 1 describes the parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
@@ -38,36 +38,36 @@
 
-
            Request
            Request parameters
            
-
            Table 2 describes the request parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            DCS instance ID.
            
+
            DCS instance ID.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Request
            Request parameters
            
+
            Table 2 describes the request parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
@@ -75,66 +75,66 @@
 
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            old_password
            
+
            old_password
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Old password.
            
+
            Old password.
            
             		
 
            new_password
            
+
            new_password
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            New password.
            
-
            Password complexity requirements:
            
-
            • Cannot be empty.
            • Cannot be the username or the username spelled backwards.
            • Can be 8 to 32 characters long.
            • Contain at least three of the following character types:
              • Lowercase letters
              • Uppercase letters
              • Digits
              • Special characters (`~!@#$^&*()-_=+\|{}:,<.>/?)
              
+
            New password.
            
+
            Password complexity requirements:
            
+
            • Cannot be empty.
            • Cannot be the username or the username spelled backwards.
            • Can contain 8 to 64 characters.
            • Contain at least three of the following character types:
              • Lowercase letters
              • Uppercase letters
              • Digits
              • Special characters (`~!@#$^&*()-_=+\|{}:,<.>/?)
              
 
            
             		
 
            
 
            
 
            
-
            Example request
            
-
            • Request URL:
              PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password
              
+
              Example request
              
+
              • Request URL:
                PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password
                
 
              
-
              • Example:
                {
+
                • Example:
                  {
     "old_password": "XXXXXX",
     "new_password": "XXXXXX"
 }
                  
 
                
 
            
-
            Response
            Response parameters
            
-
            Table 3 describes the response parameters.
-
            Table 3 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 3 describes the response parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 3 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            result
            
+
            result
            
 
            String
            
+
            String
            
 
            An indicator of whether the password is successfully changed: Options:
            
-
            • Success: Password changed successfully.
            • passwordFailed: The old password is incorrect.
            • Locked: This account has been locked.
            • Failed: Failed to change the password.
            
+
            An indicator of whether the password is successfully changed: Options:
            
+
            • Success: Password changed successfully.
            • passwordFailed: The old password is incorrect.
            • Locked: This account has been locked.
            • Failed: Failed to change the password.
            
             		
 
            message
            
+
            message
            
 
            String
            
+
            String
            
 
            Result of password change.
            
+
            Result of password change.
            
             		
 
            retry_times_left
            
+
            retry_times_left
            
 
            String
            
+
            String
            
 
            Number of remaining password attempts. If the old password is incorrect, the value of this parameter is not null.
            
+
            Number of remaining password attempts. If the old password is incorrect, the value of this parameter is not null.
            
             		
 
            lock_time
            
+
            lock_time
            
 
            String
            
+
            String
            
 
            Account lockout duration. If the old password is incorrect or the account is locked, the value of this parameter is not null.
            
+
            Account lockout duration. If the old password is incorrect or the account is locked, the value of this parameter is not null.
            
             		
 
            lock_time_left
            
+
            lock_time_left
            
 
            String
            
+
            String
            
 
            Remaining time before the account is unlocked. If the account is locked, the value of this parameter is not null.
            
+
            Remaining time before the account is unlocked. If the account is locked, the value of this parameter is not null.
            
             		
 
            
             
 
            
 
            
 
            
-
            Example response
            //Change password success.
+
            Example response
            //Change password success.
 {
     "result" : "Success",
     "message" : "Modify DCSInstance password success.",
@@ -152,17 +152,17 @@
 }
            
 
            
 
            
-
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 4 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312020.html b/docs/dcs/api-ref/dcs-api-0312020.html
index e725c5d4..2eb33ad0 100644
--- a/docs/dcs/api-ref/dcs-api-0312020.html
+++ b/docs/dcs/api-ref/dcs-api-0312020.html
@@ -1,38 +1,38 @@
 
            Backing Up a DCS Instance
            
-
            Function
            This API is used to back up a specified DCS instance.
            
-
             
            Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.
            
+
            Function
            This API is used to back up a specified DCS instance.
            
+
             
            Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.
            
 
            
 
            
-
            URI
            POST /v1.0/{project_id}/instances/{instance_id}/backups
            
-
            Table 1 describes the parameters.
-
            Table 4 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Password changed successfully.
            
+
            Password changed successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            POST /v1.0/{project_id}/instances/{instance_id}/backups
            
+
            Table 1 describes the parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
@@ -40,76 +40,76 @@
 
-
            Request
            Request parameters
            
-
            Table 2 describes the request parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            DCS instance ID.
            
+
            DCS instance ID.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Request
            Request parameters
            
+
            Table 2 describes the request parameters.
+
            
-
-
-
-
-
-
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            remark
            
+
            remark
            
 
            String
            
+
            String
            
 
            No
            
+
            No
            
 
            Description of DCS instance backup.
            
+
            Description of DCS instance backup.
            
             		
 
            
             
 
            
 
            
 
            
-
            Example request
            
-
            • Request URL:
              POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups
              
+
              Example request
              
+
              • Request URL:
                POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups
                
 
              
-
              • Example:
                {
+
                • Example:
                  {
     "remark": "Backup instances"
 }
                  
 
                
 
            
-
            Response
            Response parameters
            
-
            Table 3 describes the response parameter.
-
            Table 3 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 3 describes the response parameter.
+
            
-
-
-
-
-
            Table 3 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            backup_id
            
+
            backup_id
            
 
            String
            
+
            String
            
 
            ID of the backup record
            
+
            ID of the backup record
            
             		
 
            
             
 
            
 
            
 
            
-
            Example response
            {
+
            Example response
            {
     "backup_id": "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
 }
            
 
            
 
            
-
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 4 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312021.html b/docs/dcs/api-ref/dcs-api-0312021.html
index cabcfebe..ce8894c4 100644
--- a/docs/dcs/api-ref/dcs-api-0312021.html
+++ b/docs/dcs/api-ref/dcs-api-0312021.html
@@ -1,38 +1,38 @@
 
            Restoring a DCS Instance
            
-
            Function
            This API is used to restore a specified DCS instance.
            
-
             
            Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.
            
+
            Function
            This API is used to restore a specified DCS instance.
            
+
             
            Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.
            
 
            
 
            
-
            URI
            POST /v1.0/{project_id}/instances/{instance_id}/restores
            
-
            Table 1 describes the parameters.
-
            Table 4 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Backup task created successfully.
            
+
            Backup task created successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            POST /v1.0/{project_id}/instances/{instance_id}/restores
            
+
            Table 1 describes the parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
@@ -40,85 +40,86 @@
 
-
            Request
            Request parameters
            
-
            Table 2 describes the request parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            DCS instance ID.
            
+
            DCS instance ID.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Request
            Request parameters
            
+
            Table 2 describes the request parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            remark
            
+
            remark
            
 
            String
            
+
            String
            
 
            No
            
+
            No
            
 
            Description of DCS instance restoration
            
+
            Description of DCS instance restoration
            
             		
 
            backup_id
            
+
            backup_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            ID of the backup record
            
+
            ID of the backup record
            
             		
 
            
             
 
            
 
            
 
            
-
            Example request
            
-
            POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores
            
-
            {
+
            Example request
            
+
            Request URL:
            
+
            POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores
            
+
            Example:
            {
     "remark":"restore instance",
     "backup_id":"8ba256cb-e5ac-44f6-a3da-c03d8f0e5029"
 }
            
 
            
 
            
-
            Response
            Response parameters
            
-
            Table 3 describes the response parameter.
-
            Table 3 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 3 describes the response parameter.
+
            
-
-
-
-
-
            Table 3 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            restore_id
            
+
            restore_id
            
 
            String
            
+
            String
            
 
            ID of the restoration record
            
+
            ID of the restoration record
            
             		
 
            
             
 
            
 
            
 
            
-
            Example response
            {
+
            Example response
            {
     "restore_id": "a6155972-800c-4170-a479-3231e907d2f6"
 }
            
 
            
 
            
-
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 4 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312022.html b/docs/dcs/api-ref/dcs-api-0312022.html
index b7f60ca9..2fcc8993 100644
--- a/docs/dcs/api-ref/dcs-api-0312022.html
+++ b/docs/dcs/api-ref/dcs-api-0312022.html
@@ -1,72 +1,72 @@
 
            Querying DCS Instance Backup Records
            
-
            Function
            This API is used to query the backup records of a specified DCS instance.
            
+
            Function
            This API is used to query the backup records of a specified DCS instance.
            
 
            
-
            URI
            GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
-
            Table 1 describes the parameters.
-
            Table 4 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Restoration task created successfully.
            
+
            Restoration task created successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
+
            Table 1 describes the parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -74,33 +74,33 @@
 
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
 
            
-
            Response
            Response parameters
            
-
            Table 2 describes the response parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            DCS instance ID.
            
+
            DCS instance ID.
            
             		
 
            start
            
+
            start
            
 
            Integer
            
+
            Integer
            
 
            No
            
+
            No
            
 
            Start sequence number of the backup record that is to be queried. By default, this parameter is set to 1.
            
+
            Start sequence number of the backup record that is to be queried. By default, this parameter is set to 1.
            
             		
 
            limit
            
+
            limit
            
 
            Integer
            
+
            Integer
            
 
            No
            
+
            No
            
 
            Number of backup records displayed on each page. The minimum value of this parameter is 1. If this parameter is not set, 10 backup records are displayed on each page by default.
            
+
            Number of backup records displayed on each page. The minimum value of this parameter is 1. If this parameter is not set, 10 backup records are displayed on each page by default.
            
             		
 
            beginTime
            
+
            beginTime
            
 
            String
            
+
            String
            
 
            No
            
+
            No
            
 
            Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
+
            Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
             		
 
            endTime
            
+
            endTime
            
 
            String
            
+
            String
            
 
            No
            
+
            No
            
 
            End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
+
            End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 2 describes the response parameters.
+
            
-
-
-
-
-
-
-
-
@@ -108,176 +108,176 @@
 
 
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            backup_record_response
            
+
            backup_record_response
            
 
            Array
            
+
            Array
            
 
            Array of the backup records. For details about backup_record_response, see Table 3.
            
+
            Array of the backup records. For details about backup_record_response, see Table 3.
            
             		
 
            total_num
            
+
            total_num
            
 
            Integer
            
+
            Integer
            
 
            Number of obtained backup records.
            
+
            Number of obtained backup records.
            
             		
 
            
             
 
            Table 3 backup_record_response parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 3 backup_record_response parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            status
            
+
            status
            
 
            String
            
+
            String
            
 
            Backup status. Options:
            
-
            • waiting: DCS instance restoration is waiting to begin.
            • backuping: DCS instance backup is in progress.
            • succeed: DCS instance backup succeeded.
            • failed: DCS instance backup failed.
            • expired: The backup file expires.
            • deleted: The backup file has been deleted manually. 
            
+
            Backup status. Options:
            
+
            • waiting: DCS instance restoration is waiting to begin.
            • backuping: DCS instance backup is in progress.
            • succeed: DCS instance backup succeeded.
            • failed: DCS instance backup failed.
            • expired: The backup file expires.
            • deleted: The backup file has been deleted manually. 
            
             		
 
            remark
            
+
            remark
            
 
            String
            
+
            String
            
 
            Description of DCS instance backup
            
+
            Description of DCS instance backup
            
             		
 
            period
            
+
            period
            
 
            String
            
+
            String
            
 
            Time segment in which DCS instance backup was performed
            
+
            Time segment in which DCS instance backup was performed
            
             		
 
            progress
            
+
            progress
            
 
            String
            
+
            String
            
 
            Backup progress
            
+
            Backup progress
            
             		
 
            size
            
+
            size
            
 
            Long
            
+
            Long
            
 
            Size of the backup file. Unit: byte.
            
+
            Size of the backup file. Unit: byte.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            DCS instance ID
            
+
            DCS instance ID
            
             		
 
            backup_id
            
+
            backup_id
            
 
            String
            
+
            String
            
 
            ID of the backup record
            
+
            ID of the backup record
            
             		
 
            created_at
            
+
            created_at
            
 
            String
            
+
            String
            
 
            Time at which the backup task is created
            
+
            Time at which the backup task is created
            
             		
 
            updated_at
            
+
            updated_at
            
 
            String
            
+
            String
            
 
            Time at which DCS instance backup is completed
            
+
            Time at which DCS instance backup is completed
            
             		
 
            execution_at
            
+
            execution_at
            
 
            String
            
+
            String
            
 
            Time at which the backup starts.
            
+
            Time at which the backup starts.
            
             		
 
            backup_type
            
+
            backup_type
            
 
            String
            
+
            String
            
 
            Backup type. Options:
            
-
            • manual: manual backup
            • auto: automatic backup
            
+
            Backup type. Options:
            
+
            • manual: manual backup
            • auto: automatic backup
            
             		
 
            backup_name
            
+
            backup_name
            
 
            String
            
+
            String
            
 
            Name of the backup record
            
+
            Name of the backup record
            
             		
 
            backup_format
            
+
            backup_format
            
 
            String
            
+
            String
            
 
            Backup format.
            
+
            Backup format.
            
             		
 
            error_code
            
+
            error_code
            
 
            String
            
+
            String
            
 
            Error code returned if DCS instance backup fails. For details about error codes, see Table 4.
            
+
            Error code returned if DCS instance backup fails. For details about error codes, see Table 4.
            
             		
 
            is_support_restore
            
+
            is_support_restore
            
 
            String
            
+
            String
            
 
            An indicator of whether restoration is supported. Options: TRUE or FALSE.
            
+
            An indicator of whether restoration is supported. Options: TRUE or FALSE.
            
             		
 
            
             
 
            
 
            
 
-
            Table 4 Error codes returned in case of a backup or restoration failure
            Error Code
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 4 Error codes returned in case of a backup or restoration failure
            Error Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            dcs.08.0001
            
+
            dcs.08.0001
            
 
            Failed to start the backup and restore tool.
            
+
            Failed to start the backup and restore tool.
            
             		
 
            dcs.08.0002
            
+
            dcs.08.0002
            
 
            Operation timed out.
            
+
            Operation timed out.
            
             		
 
            dcs.08.0003
            
+
            dcs.08.0003
            
 
            Failed to delete bucket.
            
+
            Failed to delete bucket.
            
             		
 
            dcs.08.0004
            
+
            dcs.08.0004
            
 
            Failed to obtain AK/SK.
            
+
            Failed to obtain AK/SK.
            
             		
 
            dcs.08.0005
            
+
            dcs.08.0005
            
 
            Failed to create bucket.
            
+
            Failed to create bucket.
            
             		
 
            dcs.08.0006
            
+
            dcs.08.0006
            
 
            Failed to obtain backup file size.
            
+
            Failed to obtain backup file size.
            
             		
 
            dcs.08.0007
            
+
            dcs.08.0007
            
 
            Data synchronization failed during instance restoration.
            
+
            Data synchronization failed during instance restoration.
            
             		
 
            dcs.08.0008
            
+
            dcs.08.0008
            
 
            Automatic backup of the instance cannot start because the instance is running other jobs.
            
+
            Automatic backup of the instance cannot start because the instance is running other jobs.
            
             		
 
            
             
 
            
 
            
-
            Example response
            
-
            {
+
            Example response
            
+
            {
     "backup_record_response": [
         {
             "status": "succeed",
@@ -300,17 +300,17 @@
     "total_num": 1
 }
            
 
-
            Status Code
            Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 5 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312023.html b/docs/dcs/api-ref/dcs-api-0312023.html
index 5eb8c9ad..e28e0713 100644
--- a/docs/dcs/api-ref/dcs-api-0312023.html
+++ b/docs/dcs/api-ref/dcs-api-0312023.html
@@ -1,72 +1,72 @@
 
            Querying DCS Instance Restoration Records
            
-
            Function
            This API is used to query the restoration records of a specified DCS instance.
            
+
            Function
            This API is used to query the restoration records of a specified DCS instance.
            
 
            
-
            URI
            GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
-
            Table 1 describes the parameters.
-
            Table 5 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            DCS instance backup records queried successfully.
            
+
            DCS instance backup records queried successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
+
            Table 1 describes the parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -74,33 +74,33 @@
 
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
            
 
            
-
            Response
            Response parameters
            
-
            Table 2 describes the response parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            DCS instance ID.
            
+
            DCS instance ID.
            
             		
 
            start
            
+
            start
            
 
            Integer
            
+
            Integer
            
 
            No
            
+
            No
            
 
            Start sequence number of the restoration record to be queried. By default, this parameter is set to 1.
            
+
            Start sequence number of the restoration record to be queried. By default, this parameter is set to 1.
            
             		
 
            limit
            
+
            limit
            
 
            Integer
            
+
            Integer
            
 
            No
            
+
            No
            
 
            Number of restoration records displayed on each page. The minimum value of this parameter is 1. If this parameter is not specified, 10 restoration records are displayed on each page by default.
            
+
            Number of restoration records displayed on each page. The minimum value of this parameter is 1. If this parameter is not specified, 10 restoration records are displayed on each page by default.
            
             		
 
            beginTime
            
+
            beginTime
            
 
            String
            
+
            String
            
 
            No
            
+
            No
            
 
            Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
+
            Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
             		
 
            endTime
            
+
            endTime
            
 
            String
            
+
            String
            
 
            No
            
+
            No
            
 
            End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
+
            End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 2 describes the response parameters.
+
            
-
-
-
-
-
-
-
-
@@ -108,110 +108,110 @@
 
 
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            restore_record_response
            
+
            restore_record_response
            
 
            Array
            
+
            Array
            
 
            Array of the restoration records.
            
+
            Array of the restoration records.
            
             		
 
            total_num
            
+
            total_num
            
 
            Integer
            
+
            Integer
            
 
            Number of obtained backup records.
            
+
            Number of obtained backup records.
            
             		
 
            
             
 
            Table 3 restore_record_response parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 3 restore_record_response parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            status
            
+
            status
            
 
            String
            
+
            String
            
 
            Restoration status
            
-
            • waiting: DCS instance restoration is waiting to begin.
            • restoring: DCS instance restoration is in progress. 
            • succeed: DCS instance restoration succeeded. 
            • failed: DCS instance restoration failed.
            
+
            Restoration status
            
+
            • waiting: DCS instance restoration is waiting to begin.
            • restoring: DCS instance restoration is in progress. 
            • succeed: DCS instance restoration succeeded. 
            • failed: DCS instance restoration failed.
            
             		
 
            progress
            
+
            progress
            
 
            String
            
+
            String
            
 
            Restoration progress
            
+
            Restoration progress
            
             		
 
            restore_id
            
+
            restore_id
            
 
            String
            
+
            String
            
 
            ID of the restoration record
            
+
            ID of the restoration record
            
             		
 
            backup_id
            
+
            backup_id
            
 
            String
            
+
            String
            
 
            ID of the backup record
            
+
            ID of the backup record
            
             		
 
            restore_remark
            
+
            restore_remark
            
 
            String
            
+
            String
            
 
            Description of DCS instance restoration
            
+
            Description of DCS instance restoration
            
             		
 
            backup_remark
            
+
            backup_remark
            
 
            String
            
+
            String
            
 
            Description of DCS instance backup
            
+
            Description of DCS instance backup
            
             		
 
            created_at
            
+
            created_at
            
 
            String
            
+
            String
            
 
            Time at which the restoration task is created
            
+
            Time at which the restoration task is created
            
             		
 
            updated_at
            
+
            updated_at
            
 
            String
            
+
            String
            
 
            Time at which DCS instance restoration completed
            
+
            Time at which DCS instance restoration completed
            
             		
 
            restore_name
            
+
            restore_name
            
 
            String
            
+
            String
            
 
            Name of the restoration record
            
+
            Name of the restoration record
            
             		
 
            backup_name
            
+
            backup_name
            
 
            String
            
+
            String
            
 
            Name of the backup record
            
+
            Name of the backup record
            
             		
 
            sourceInstanceID
            
+
            sourceInstanceID
            
 
            String
            
+
            String
            
 
            Source instance ID.
            
+
            Source instance ID.
            
             		
 
            sourceInstanceName
            
+
            sourceInstanceName
            
 
            String
            
+
            String
            
 
            Source instance name.
            
+
            Source instance name.
            
             		
 
            error_code
            
+
            error_code
            
 
            String
            
+
            String
            
 
            Error code returned if DCS instance restoration fails. For details about error codes, see Table 4.
            
+
            Error code returned if DCS instance restoration fails. For details about error codes, see Table 4.
            
             		
 
            
             
 
            
 
            
-
            Example response
            {
+
            Example response
            {
     "restore_record_response": [
         {
             "status": "succeed",
@@ -233,17 +233,17 @@
 }
            
 
            
 
            
-
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 4 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312024.html b/docs/dcs/api-ref/dcs-api-0312024.html
index 36f03360..ead86803 100644
--- a/docs/dcs/api-ref/dcs-api-0312024.html
+++ b/docs/dcs/api-ref/dcs-api-0312024.html
@@ -1,45 +1,45 @@
 
            Deleting Backup Files
            
-
            Function
            This API is used to delete the files backed up by a DCS instance.
            
+
            Function
            This API is used to delete the files backed up by a DCS instance.
            
 
            
-
            URI
            DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
            
-
            Table 1 describes the parameters.
-
            Table 4 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            DCS instance restoration record queried successfully.
            
+
            DCS instance restoration record queried successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
            
+
            Table 1 describes the parameters.
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -47,48 +47,49 @@
 
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            Request URL:
            
+
            DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
            
 
            
-
            Response
            Response parameters
            
-
            Table 2 describes the response parameters.
            
+
            Response
            Response parameters
            
+
            Table 2 describes the response parameters.
            
 
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            instance_id
            
+
            instance_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            DCS instance ID
            
+
            DCS instance ID
            
             		
 
            backup_id
            
+
            backup_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            ID of the backup record
            
+
            ID of the backup record
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            
-
-
-
-
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            message
            
+
            message
            
 
            String
            
+
            String
            
 
            Result of deleting the backup file
            
+
            Result of deleting the backup file
            
             		
 
            
             
 
            
 
            
-
            Example response
            
-
            {
+
            Example response
            
+
            {
     "message": ""
 }
            
 
-
            Status Code
            Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 3 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312035.html b/docs/dcs/api-ref/dcs-api-0312035.html
index d5e568e0..a324f09c 100644
--- a/docs/dcs/api-ref/dcs-api-0312035.html
+++ b/docs/dcs/api-ref/dcs-api-0312035.html
@@ -1,11 +1,8 @@
 
 
-
-  
            Instance Management APIs
            
-
-  
            
+
            Instance Management APIs
            
+
            
 
            
-
 
 
diff --git a/docs/dcs/api-ref/dcs-api-0312036.html b/docs/dcs/api-ref/dcs-api-0312036.html
index 2593d32e..40d3a2c4 100644
--- a/docs/dcs/api-ref/dcs-api-0312036.html
+++ b/docs/dcs/api-ref/dcs-api-0312036.html
@@ -1,27 +1,27 @@
 
 
 
            Querying the Quota of a Tenant
            
-
            Function
            This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions.
            
+
            Function
            This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions.
            
 
            
-
            URI
            GET  /v1.0/{project_id}/quota
            
-
            Table 1 describes the parameter.
-
            Table 3 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Backup file deleted successfully.
            
+
            Backup file deleted successfully.
            
             		
 
            
 
            Table 1 Parameter description
            Parameter
            
+
            URI
            GET  /v1.0/{project_id}/quota
            
+
            Table 1 describes the parameter.
+
            
-
-
-
-
-
-
-
@@ -29,30 +29,30 @@
 
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            None
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            None
            
 
            
-
            Response
            Response parameters
            
-
            Table 2 describes the response parameters.
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            project_id
            
+
            project_id
            
 
            String
            
+
            String
            
 
            Yes
            
+
            Yes
            
 
            Project ID.
            
+
            Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.
            
             		
 
            
             
 
 
            Table 2 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 2 describes the response parameters.
+
            
-
-
-
-
-
-
-
@@ -60,120 +60,120 @@
 
 
-
            Table 2 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            quotas
            
+
            quotas
            
 
            Object
            
+
            Object
            
 
            Yes
            
+
            Yes
            
 
            Quota information. For details, see Table 3.
            
+
            Quota information. For details, see Table 3.
            
             		
 
            
             
 
            Table 3 quotas parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
            Table 3 quotas parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Mandatory
            
+
            Mandatory
            
 
            Description
            
+
            Description
            
             		
 
            
 
            resources
            
+
            resources
            
 
            Array
            
+
            Array
            
 
            Yes
            
+
            Yes
            
 
            List of quotas. For details, see Table 4.
            
+
            List of quotas. For details, see Table 4.
            
             		
 
            resource_user
            
+
            resource_user
            
 
            Object
            
+
            Object
            
 
            Yes
            
+
            Yes
            
 
            Information about a resource tenant For details, see Table 5.
            
+
            Information about a resource tenant For details, see Table 5.
            
             		
 
            
             
 
            
 
            
 
-
            Table 4 resources parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 4 resources parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            quota
            
+
            quota
            
 
            Integer
            
+
            Integer
            
 
            Maximum number of instances that can be created and maximum allowed total memory.
            
+
            Maximum number of instances that can be created and maximum allowed total memory.
            
             		
 
            used
            
+
            used
            
 
            Integer
            
+
            Integer
            
 
            Number of created instances and used memory.
            
+
            Number of created instances and used memory.
            
             		
 
            type
            
+
            type
            
 
            String
            
+
            String
            
 
            Values:
            
-
            • instances: indicates the instance quota.
            • ram: indicates the memory quota.
            
+
            Values:
            
+
            • instances: indicates the instance quota.
            • ram: indicates the memory quota.
            
             		
 
            unit
            
+
            unit
            
 
            String
            
+
            String
            
 
            Resource unit.
            
-
            • When type is set to instance, no value is returned.
            • When type is set to ram, GB is returned.
            
+
            Resource unit.
            
+
            • When type is set to instance, no value is returned.
            • When type is set to ram, GB is returned.
            
             		
 
            max
            
+
            max
            
 
            Integer
            
+
            Integer
            
 
            • Indicates the maximum limit of instance quota when type is set to instance.
            • Indicates the maximum limit of memory quota when type is set to ram.
            
+
            • Indicates the maximum limit of instance quota when type is set to instance.
            • Indicates the maximum limit of memory quota when type is set to ram.
            
             		
 
            min
            
+
            min
            
 
            Integer
            
+
            Integer
            
 
            • Indicates the minimum limit of instance quota when type is set to instance.
            • Indicates the minimum limit of memory quota when type is set to ram.
            
+
            • Indicates the minimum limit of instance quota when type is set to instance.
            • Indicates the minimum limit of memory quota when type is set to ram.
            
             		
 
            
             
 
            
 
            
 
-
            Table 5 resource_user parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
            Table 5 resource_user parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            tenant_id
            
+
            tenant_id
            
 
            String
            
+
            String
            
 
            Resource tenant ID
            
+
            Resource tenant ID
            
             		
 
            tenant_name
            
+
            tenant_name
            
 
            String
            
+
            String
            
 
            Resource tenant name
            
+
            Resource tenant name
            
             		
 
            
             
 
            
 
            
-
            Example response
            {
+
            Example response
            {
     "quotas": {
         "resources": [
             {
@@ -201,17 +201,17 @@
 }
            
 
            
 
            
-
            Status Code
            Table 6 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 6 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 6 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312038.html b/docs/dcs/api-ref/dcs-api-0312038.html
index b8f362ef..7b061e76 100644
--- a/docs/dcs/api-ref/dcs-api-0312038.html
+++ b/docs/dcs/api-ref/dcs-api-0312038.html
@@ -13,5 +13,9 @@
 
          • Querying AZ Information
            
 
            • 
+
+
            
+
            Parent topic: Outdated APIs (V1)
            
+
            
 
diff --git a/docs/dcs/api-ref/dcs-api-0312039.html b/docs/dcs/api-ref/dcs-api-0312039.html
index 424778cd..f7e9e3aa 100644
--- a/docs/dcs/api-ref/dcs-api-0312039.html
+++ b/docs/dcs/api-ref/dcs-api-0312039.html
@@ -1,37 +1,37 @@
 
            Querying AZ Information
            
-
            Function
            This API is used to query the ID of the AZ where a DCS instance resides. 
            
+
            Function
            This API is used to query the ID of the AZ where a DCS instance resides. 
            
 
            
-
            URI
            GET /v1.0/availableZones
            
+
            URI
            GET /v1.0/availableZones
            
 
            
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            None
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            None
            
 
            
-
            Response
            Response parameters
            
-
            Table 1 describes the response parameters.
-
            Table 6 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Tenant quota queried successfully.
            
+
            Tenant quota queried successfully.
            
             		
 
            
             
 
 
 
 
            Table 1 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 1 describes the response parameters.
+
            
-
-
-
-
-
-
-
-
@@ -39,64 +39,56 @@
 
 
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            regionId
            
+
            region_id
            
 
            String
            
+
            String
            
 
            Region ID.
            
+
            Region ID.
            
             		
 
            available_zones
            
+
            available_zones
            
 
            Array
            
+
            Array
            
 
            Array of AZs. For details, see Table 2.
            
+
            Array of AZs. For details, see Table 2.
            
             		
 
            
             
 
            Table 2 Parameter description of the available_zones array
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 2 Parameter description of the available_zones array
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            id
            
+
            id
            
 
            String
            
+
            String
            
 
            AZ ID.
            
+
            AZ ID.
            
             		
 
            code
            
+
            code
            
 
            String
            
+
            String
            
 
            AZ code.
            
+
            AZ code.
            
             		
 
            name
            
+
            name
            
 
            String
            
+
            String
            
 
            AZ name.
            
+
            AZ name.
            
             		
 
            port
            
+
            port
            
 
            String
            
+
            String
            
 
            Port number of the AZ.
            
+
            Port number of the AZ.
            
             		
 
            resource_availability
            
+
            resource_availability
            
 
            String
            
+
            String
            
 
            An indicator of whether there are available Redis 3.0 resources in the AZ.
            
-
            • true: There are available resources in the AZ.
            • false: There are no available resources in the AZ.
            
-
            resource_availability_dcs2
            
-
            String
            
-
            An indicator of whether there are available Redis 4.0 and 5.0 resources in the AZ.
            
-
            • true: There are available resources in the AZ.
            • false: There are no available resources in the AZ.
            
+
            An indicator of whether there are available resources in the AZ.
            
+
            • true: There are available resources in the AZ.
            • false: There are no available resources in the AZ.
            
             		
 
            
             
 
            
 
            
-
            Example response
            
+
            Example response
            
 
-
            {
+
            {
     "regionId": "XXXXXX",
     "available_zones": [
         {
@@ -122,17 +114,17 @@
         }
     ]
 } 
            
-
            Status Code
            Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 3 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312040.html b/docs/dcs/api-ref/dcs-api-0312040.html
index 73523dad..505b06dc 100644
--- a/docs/dcs/api-ref/dcs-api-0312040.html
+++ b/docs/dcs/api-ref/dcs-api-0312040.html
@@ -1,30 +1,30 @@
 
            Querying Service Specifications
            
-
            Function
            This API is used to query the product ID (parameter product_id) which indicates the specifications of the DCS service you created. 
            
+
            Function
            This API is used to query the product ID (parameter product_id) which indicates the specifications of the DCS service you created. 
            
 
            
-
            URI
            GET /v1.0/products
            
+
            URI
            GET /v1.0/products
            
 
            
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            None
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            None
            
 
            
-
            Response
            Response parameters
            
-
            Table 1 describes the response parameters.
-
            Table 3 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            AZ information queried successfully.
            
+
            AZ information queried successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 1 describes the response parameters.
+
            
-
-
-
-
-
@@ -32,271 +32,277 @@
 
 
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            products
            
+
            products
            
 
            Array
            
+
            Array
            
 
            List of specifications of the DCS service to which you can subscribe.
            
+
            List of specifications of the DCS service to which you can subscribe.
            
             		
 
            
             
 
            Table 2 products parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 2 products parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            product_id
            
+
            product_id
            
 
            String
            
+
            String
            
 
            Product ID used to differentiate DCS specifications.
            
+
            Product ID used to differentiate DCS specifications.
            
             		
 
            spec_code
            
+
            spec_code
            
 
            String
            
+
            String
            
 
            DCS instance specification code. Options:
            
-
            • dcs.single_node
            • dcs.master_standby
            • dcs.cluster
            • redis.ha.xu1.tiny.r4.512
            • redis.ha.xu1.tiny.r2.128
            • redis.cluster.xu1.large.r5.4
            • redis.ha.xu1.tiny.r4.256
            • redis.ha.xu1.tiny.r2.512
            • redis.cluster.xu1.large.r1.32
            • redis.cluster.xu1.large.r4.768
            • redis.ha.xu1.large.r3.2
            • redis.single.xu1.large.64
            • redis.cluster.xu1.large.r5.8
            • redis.ha.xu1.large.r3.32
            • redis.cluster.xu1.large.r2.8
            • redis.ha.xu1.large.r4.1
            • redis.ha.xu1.tiny.r2.256
            • redis.cluster.xu1.large.r4.1024
            • redis.ha.xu1.large.r5.16
            • redis.cluster.xu1.large.r4.32
            • redis.ha.xu1.large.r5.24
            • redis.ha.xu1.large.r4.64
            • redis.cluster.xu1.large.r2.1024
            • redis.ha.xu1.large.r2.48
            • redis.ha.xu1.large.r2.24
            • redis.ha.xu1.large.r5.64
            • redis.ha.xu1.tiny.r5.512
            • redis.ha.xu1.large.r3.8
            • redis.cluster.xu1.large.r1.768
            • redis.ha.xu1.large.r3.24
            • redis.cluster.xu1.large.r3.512
            • redis.ha.xu1.large.r3.1
            • redis.cluster.xu1.large.r4.4
            • redis.cluster.xu1.large.r1.24
            • redis.ha.xu1.large.r4.2
            • redis.cluster.xu1.large.r5.192
            • redis.single.xu1.large.16
            • redis.cluster.xu1.large.r3.1024
            • redis.ha.xu1.large.r4.24
            • redis.cluster.xu1.large.r2.48
            • redis.ha.xu1.large.r2.1
            • redis.ha.xu1.large.r3.48
            • redis.single.xu1.large.4
            • redis.cluster.xu1.large.r4.48
            • redis.cluster.xu1.large.r3.768
            • redis.ha.xu1.tiny.r4.128
            • redis.ha.xu1.large.r5.1
            • redis.cluster.xu1.large.r2.96
            • redis.cluster.xu1.large.r3.4
            • redis.cluster.xu1.large.r1.128
            • redis.single.xu1.large.2
            • redis.ha.xu1.tiny.r3.128
            • redis.cluster.xu1.large.r2.512
            • redis.cluster.xu1.large.r3.8
            • redis.cluster.xu1.large.r4.128
            • redis.cluster.xu1.large.r3.96
            • redis.ha.xu1.large.r4.8
            • redis.ha.xu1.large.r5.48
            • redis.single.xu1.large.8
            • redis.cluster.xu1.large.r2.24
            • redis.cluster.xu1.large.r1.4
            • redis.cluster.xu1.large.r5.32
            • redis.cluster.xu1.large.r1.64
            • redis.cluster.xu1.large.r4.96
            • redis.single.xu1.tiny.256
            • redis.cluster.xu1.large.r5.128
            • redis.cluster.xu1.large.r2.16
            • redis.cluster.xu1.large.r4.8
            • redis.cluster.xu1.large.r4.512
            • redis.cluster.xu1.large.r1.384
            • redis.cluster.xu1.large.r5.768
            • redis.cluster.xu1.large.r3.256
            • redis.cluster.xu1.large.r1.256
            • redis.cluster.xu1.large.r4.64
            • redis.cluster.xu1.large.r5.256
            • redis.cluster.xu1.large.r4.384
            • redis.ha.xu1.tiny.r5.128
            • redis.cluster.xu1.large.r3.24
            • redis.cluster.xu1.large.r4.192
            • redis.cluster.xu1.large.r1.96
            • redis.ha.xu1.large.r2.2
            • redis.single.xu1.large.24
            • redis.ha.xu1.large.r4.4
            • redis.cluster.xu1.large.r1.1024
            • redis.ha.xu1.large.r2.16
            • redis.ha.xu1.large.r4.16
            • redis.cluster.xu1.large.r5.96
            • redis.cluster.xu1.large.r5.384
            • redis.cluster.xu1.large.r3.16
            • redis.ha.xu1.large.r3.16
            • redis.ha.xu1.large.r4.32
            • redis.ha.xu1.tiny.r5.256
            • redis.single.xu1.large.32
            • redis.ha.xu1.large.r5.2
            • redis.cluster.xu1.large.r1.16
            • redis.cluster.xu1.large.r2.384
            • redis.cluster.xu1.large.r2.192
            • redis.cluster.xu1.large.r1.48
            • redis.ha.xu1.large.r5.8
            • redis.cluster.xu1.large.r5.16
            • redis.cluster.xu1.large.r3.128
            • redis.ha.xu1.large.r3.4
            • redis.cluster.xu1.large.r1.192
            • redis.cluster.xu1.large.r3.384
            • redis.cluster.xu1.large.r2.4
            • redis.ha.xu1.large.r2.4
            • redis.single.xu1.tiny.128
            • redis.cluster.xu1.large.r1.512
            • redis.ha.xu1.large.r2.64
            • redis.cluster.xu1.large.r2.128
            • redis.cluster.xu1.large.r2.768
            • redis.cluster.xu1.large.r5.64
            • redis.cluster.xu1.large.r3.48
            • redis.single.xu1.tiny.512
            • redis.cluster.xu1.large.r5.48
            • redis.ha.xu1.large.r4.48
            • redis.cluster.xu1.large.r4.24
            • redis.ha.xu1.large.r5.4
            • redis.ha.xu1.large.r2.8
            • redis.ha.xu1.large.r3.64
            • redis.cluster.xu1.large.r2.64
            • redis.cluster.xu1.large.r2.32
            • redis.cluster.xu1.large.r4.16
            • redis.cluster.xu1.large.r4.256
            • redis.single.xu1.large.1
            • redis.cluster.xu1.large.r1.8
            • redis.cluster.xu1.large.r3.32
            • redis.single.xu1.large.48
            • redis.cluster.xu1.large.r5.1024
            • redis.cluster.xu1.large.r3.192
            • redis.cluster.xu1.large.r2.256
            • redis.ha.xu1.tiny.r3.256
            • redis.cluster.xu1.large.r5.24
            • redis.ha.xu1.tiny.r3.512
            • redis.cluster.xu1.large.r5.512
            • redis.ha.xu1.large.r5.32
            • redis.cluster.xu1.large.r3.64
            • redis.ha.xu1.large.r2.32
            • redis.ha.xu1.large.p2.16
            • redis.ha.xu1.large.p2.32
            • redis.ha.xu1.large.p2.64
            • redis.ha.xu1.large.p2.8
            • redis.ha.xu1.large.p3.16
            • redis.ha.xu1.large.p3.32
            • redis.ha.xu1.large.p3.64
            • redis.ha.xu1.large.p3.8
            • redis.ha.xu1.large.p4.16
            • redis.ha.xu1.large.p4.32
            • redis.ha.xu1.large.p4.64
            • redis.ha.xu1.large.p4.8
            • redis.ha.xu1.large.p5.16
            • redis.ha.xu1.large.p5.32
            • redis.ha.xu1.large.p5.64
            • redis.ha.xu1.large.p5.8
            • redis.ha.xu1.large.p6.16
            • redis.ha.xu1.large.p6.32
            • redis.ha.xu1.large.p6.64
            • redis.ha.xu1.large.p6.8
            
+
            DCS instance specification code. Options:
            
+
            • dcs.single_node
            • dcs.master_standby
            • dcs.cluster
            • redis.ha.xu1.tiny.r4.512
            • redis.ha.xu1.tiny.r2.128
            • redis.cluster.xu1.large.r5.4
            • redis.ha.xu1.tiny.r4.256
            • redis.ha.xu1.tiny.r2.512
            • redis.cluster.xu1.large.r1.32
            • redis.cluster.xu1.large.r4.768
            • redis.ha.xu1.large.r3.2
            • redis.single.xu1.large.64
            • redis.cluster.xu1.large.r5.8
            • redis.ha.xu1.large.r3.32
            • redis.cluster.xu1.large.r2.8
            • redis.ha.xu1.large.r4.1
            • redis.ha.xu1.tiny.r2.256
            • redis.cluster.xu1.large.r4.1024
            • redis.ha.xu1.large.r5.16
            • redis.cluster.xu1.large.r4.32
            • redis.ha.xu1.large.r5.24
            • redis.ha.xu1.large.r4.64
            • redis.cluster.xu1.large.r2.1024
            • redis.ha.xu1.large.r2.48
            • redis.ha.xu1.large.r2.24
            • redis.ha.xu1.large.r5.64
            • redis.ha.xu1.tiny.r5.512
            • redis.ha.xu1.large.r3.8
            • redis.cluster.xu1.large.r1.768
            • redis.ha.xu1.large.r3.24
            • redis.cluster.xu1.large.r3.512
            • redis.ha.xu1.large.r3.1
            • redis.cluster.xu1.large.r4.4
            • redis.cluster.xu1.large.r1.24
            • redis.ha.xu1.large.r4.2
            • redis.cluster.xu1.large.r5.192
            • redis.single.xu1.large.16
            • redis.cluster.xu1.large.r3.1024
            • redis.ha.xu1.large.r4.24
            • redis.cluster.xu1.large.r2.48
            • redis.ha.xu1.large.r2.1
            • redis.ha.xu1.large.r3.48
            • redis.single.xu1.large.4
            • redis.cluster.xu1.large.r4.48
            • redis.cluster.xu1.large.r3.768
            • redis.ha.xu1.tiny.r4.128
            • redis.ha.xu1.large.r5.1
            • redis.cluster.xu1.large.r2.96
            • redis.cluster.xu1.large.r3.4
            • redis.cluster.xu1.large.r1.128
            • redis.single.xu1.large.2
            • redis.ha.xu1.tiny.r3.128
            • redis.cluster.xu1.large.r2.512
            • redis.cluster.xu1.large.r3.8
            • redis.cluster.xu1.large.r4.128
            • redis.cluster.xu1.large.r3.96
            • redis.ha.xu1.large.r4.8
            • redis.ha.xu1.large.r5.48
            • redis.single.xu1.large.8
            • redis.cluster.xu1.large.r2.24
            • redis.cluster.xu1.large.r1.4
            • redis.cluster.xu1.large.r5.32
            • redis.cluster.xu1.large.r1.64
            • redis.cluster.xu1.large.r4.96
            • redis.single.xu1.tiny.256
            • redis.cluster.xu1.large.r5.128
            • redis.cluster.xu1.large.r2.16
            • redis.cluster.xu1.large.r4.8
            • redis.cluster.xu1.large.r4.512
            • redis.cluster.xu1.large.r1.384
            • redis.cluster.xu1.large.r5.768
            • redis.cluster.xu1.large.r3.256
            • redis.cluster.xu1.large.r1.256
            • redis.cluster.xu1.large.r4.64
            • redis.cluster.xu1.large.r5.256
            • redis.cluster.xu1.large.r4.384
            • redis.ha.xu1.tiny.r5.128
            • redis.cluster.xu1.large.r3.24
            • redis.cluster.xu1.large.r4.192
            • redis.cluster.xu1.large.r1.96
            • redis.ha.xu1.large.r2.2
            • redis.single.xu1.large.24
            • redis.ha.xu1.large.r4.4
            • redis.cluster.xu1.large.r1.1024
            • redis.ha.xu1.large.r2.16
            • redis.ha.xu1.large.r4.16
            • redis.cluster.xu1.large.r5.96
            • redis.cluster.xu1.large.r5.384
            • redis.cluster.xu1.large.r3.16
            • redis.ha.xu1.large.r3.16
            • redis.ha.xu1.large.r4.32
            • redis.ha.xu1.tiny.r5.256
            • redis.single.xu1.large.32
            • redis.ha.xu1.large.r5.2
            • redis.cluster.xu1.large.r1.16
            • redis.cluster.xu1.large.r2.384
            • redis.cluster.xu1.large.r2.192
            • redis.cluster.xu1.large.r1.48
            • redis.ha.xu1.large.r5.8
            • redis.cluster.xu1.large.r5.16
            • redis.cluster.xu1.large.r3.128
            • redis.ha.xu1.large.r3.4
            • redis.cluster.xu1.large.r1.192
            • redis.cluster.xu1.large.r3.384
            • redis.cluster.xu1.large.r2.4
            • redis.ha.xu1.large.r2.4
            • redis.single.xu1.tiny.128
            • redis.cluster.xu1.large.r1.512
            • redis.ha.xu1.large.r2.64
            • redis.cluster.xu1.large.r2.128
            • redis.cluster.xu1.large.r2.768
            • redis.cluster.xu1.large.r5.64
            • redis.cluster.xu1.large.r3.48
            • redis.single.xu1.tiny.512
            • redis.cluster.xu1.large.r5.48
            • redis.ha.xu1.large.r4.48
            • redis.cluster.xu1.large.r4.24
            • redis.ha.xu1.large.r5.4
            • redis.ha.xu1.large.r2.8
            • redis.ha.xu1.large.r3.64
            • redis.cluster.xu1.large.r2.64
            • redis.cluster.xu1.large.r2.32
            • redis.cluster.xu1.large.r4.16
            • redis.cluster.xu1.large.r4.256
            • redis.single.xu1.large.1
            • redis.cluster.xu1.large.r1.8
            • redis.cluster.xu1.large.r3.32
            • redis.single.xu1.large.48
            • redis.cluster.xu1.large.r5.1024
            • redis.cluster.xu1.large.r3.192
            • redis.cluster.xu1.large.r2.256
            • redis.ha.xu1.tiny.r3.256
            • redis.cluster.xu1.large.r5.24
            • redis.ha.xu1.tiny.r3.512
            • redis.cluster.xu1.large.r5.512
            • redis.ha.xu1.large.r5.32
            • redis.cluster.xu1.large.r3.64
            • redis.ha.xu1.large.r2.32
            • redis.ha.xu1.large.p2.16
            • redis.ha.xu1.large.p2.32
            • redis.ha.xu1.large.p2.64
            • redis.ha.xu1.large.p2.8
            • redis.ha.xu1.large.p3.16
            • redis.ha.xu1.large.p3.32
            • redis.ha.xu1.large.p3.64
            • redis.ha.xu1.large.p3.8
            • redis.ha.xu1.large.p4.16
            • redis.ha.xu1.large.p4.32
            • redis.ha.xu1.large.p4.64
            • redis.ha.xu1.large.p4.8
            • redis.ha.xu1.large.p5.16
            • redis.ha.xu1.large.p5.32
            • redis.ha.xu1.large.p5.64
            • redis.ha.xu1.large.p5.8
            • redis.ha.xu1.large.p6.16
            • redis.ha.xu1.large.p6.32
            • redis.ha.xu1.large.p6.64
            • redis.ha.xu1.large.p6.8
            
             		
 
            cache_mode
            
+
            cache_mode
            
 
            String
            
+
            String
            
 
            DCS instance type. Options:
            
-
            • single: single-node
            • ha: master/standby
            • cluster: Redis Cluster
            • proxy: Proxy Cluster
            • ha_rw_split: read/write splitting
            
+
            DCS instance type. Options:
            
+
            • single: single-node
            • ha: master/standby
            • cluster: Redis Cluster
            • proxy: Proxy Cluster
            • ha_rw_split: read/write splitting
            
             		
 
            product_type
            
+
            product_type
            
 
            String
            
+
            String
            
 
            Edition of DCS for Redis.
            
+
            Edition of DCS for Redis.
            
             		
 
            cpu_type
            
+
            cpu_type
            
 
            String
            
+
            String
            
 
            CPU architecture.
            
+
            CPU architecture.
            
             		
 
            storage_type
            
+
            storage_type
            
 
            String
            
+
            String
            
 
            Storage type.
            
+
            Storage type.
            
             		
 
            details
            
+
            details
            
 
            Array of Object
            
+
            Array of Object
            
 
            Details of the specifications. Table 3 describes the parameters in this array.
            
+
            Details of the specifications. Table 3 describes the parameters in this array.
            
             		
 
            engine
            
+
            engine
            
 
            String
            
+
            String
            
 
            Cache engine.
            
+
            Cache engine.
            
             		
 
            engine_versions
            
+
            engine_versions
            
 
            String
            
+
            String
            
 
            Cache engine version.
            
+
            Cache engine version.
            
             		
 
            spec_details
            
+
            spec_details
            
 
            String
            
+
            String
            
 
            DCS specifications. The value subjects to the returned specifications.
            
+
            DCS specifications. The value subjects to the returned specifications.
            
             		
 
            spec_details2
            
+
            spec_details2
            
 
            String
            
+
            String
            
 
            Detailed DCS specifications, including the maximum number of connections and maximum memory size.
            
+
            Detailed DCS specifications, including the maximum number of connections and maximum memory size.
            
             		
 
            charging_type
            
+
            charging_type
            
 
            String
            
+
            String
            
 
            Billing mode. Value: Hourly.
            
+
            Billing mode. Value: Hourly.
            
             		
 
            price
            
+
            price
            
 
            Double
            
+
            Double
            
 
            Price of the DCS service to which you can subscribe. (This parameter has been abandoned.)
            
+
            Price of the DCS service to which you can subscribe. (This parameter has been abandoned.)
            
             		
 
            currency
            
+
            currency
            
 
            String
            
+
            String
            
 
            Currency.
            
+
            Currency.
            
             		
 
            prod_type
            
+
            prod_type
            
 
            String
            
+
            String
            
 
            Product type.
            
-
            Options: instance and obs_space.
            
+
            Product type.
            
+
            Options: instance and obs_space.
            
             		
 
            cloud_service_type_code
            
+
            cloud_service_type_code
            
 
            String
            
+
            String
            
 
            Cloud service type code.
            
+
            Cloud service type code.
            
             		
 
            cloud_resource_type_code
            
+
            cloud_resource_type_code
            
 
            String
            
+
            String
            
 
            Cloud resource type code.
            
+
            Cloud resource type code.
            
             		
 
            flavors
            
+
            flavors
            
 
            Array
            
+
            Array
            
 
            AZs with available resources. Table 4 describes the parameters in this array.
            
+
            AZs with available resources. Table 4 describes the parameters in this array.
            
             		
 
            billing_factor
            
+
            billing_factor
            
 
            String
            
+
            String
            
 
            Billing item.
            
+
            Billing item.
            
             		
 
            
             
 
            
 
            
 
-
            Table 3 details parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 3 details parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            capacity
            
+
            capacity
            
 
            String
            
+
            String
            
 
            Specification (total memory) of the DCS instance.
            
+
            Specification (total memory) of the DCS instance.
            
             		
 
            max_bandwidth
            
+
            max_bandwidth
            
 
            String
            
+
            String
            
 
            Maximum bandwidth supported by the specification.
            
+
            Maximum bandwidth supported by the specification.
            
             		
 
            max_clients
            
+
            max_clients
            
 
            String
            
+
            String
            
 
            Maximum number of clients supported by the specification, which is usually equal to the maximum number of connections.
            
+
            Maximum number of clients supported by the specification, which is usually equal to the maximum number of connections.
            
             		
 
            max_connections
            
+
            max_connections
            
 
            String
            
+
            String
            
 
            Maximum number of connections supported by the specification.
            
+
            Maximum number of connections supported by the specification.
            
             		
 
            max_in_bandwidth
            
+
            max_in_bandwidth
            
 
            String
            
+
            String
            
 
            Maximum inbound bandwidth supported by the specification, which is usually equal to the maximum bandwidth.
            
+
            Maximum inbound bandwidth supported by the specification, which is usually equal to the maximum bandwidth.
            
             		
 
            max_memory
            
+
            max_memory
            
 
            String
            
+
            String
            
 
            Maximum available memory.
            
+
            Maximum available memory.
            
             		
 
            tenant_ip_count
            
+
            tenant_ip_count
            
 
            String
            
+
            String
            
 
            Number of tenant IP addresses corresponding to the specifications.
            
+
            Number of tenant IP addresses corresponding to the specifications.
            
             		
 
            sharding_num
            
+
            sharding_num
            
 
            String
            
+
            String
            
 
            Number of shards supported by the specifications.
            
+
            Number of shards supported by the specifications.
            
             		
 
            proxy_num
            
+
            proxy_num
            
 
            String
            
+
            String
            
 
            Number of proxies supported by Proxy Cluster instances of the specified specifications. If the instance is not a Proxy Cluster instance, the value of this parameter is 0.
            
+
            Number of proxies supported by Proxy Cluster instances of the specified specifications. If the instance is not a Proxy Cluster instance, the value of this parameter is 0.
            
             		
 
            db_number
            
+
            db_number
            
 
            String
            
+
            String
            
 
            Number of DBs of the specifications.
            
+
            Number of DBs of the specifications.
            
             		
 
            
             
 
            
 
            
 
-
            Table 4 flavors parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
            Table 4 flavors parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            capacity
            
+
            capacity
            
 
            String
            
+
            String
            
 
            Specification (total memory) of the DCS instance.
            
+
            Specification (total memory) of the DCS instance.
            
             		
 
            unit
            
+
            unit
            
 
            String
            
+
            String
            
 
            Memory unit.
            
+
            Capacity unit.
            
             		
 
            available_zones
            
+
            available_zones
            
 
            Array
            
+
            Array
            
 
            AZ ID.
            
+
            AZ ID.
            
+
            az_codes
            
+
            Array
            
+
            AZ ID.
            
             		
 
            
             
 
            
 
            
-
            Example response
            
-
            
-
            	{
+
            Example response
            
+
            	{
 		"product_id": "dcs.master_standby-h",
 		"spec_code": "dcs.master_standby",
 		"cache_mode": "ha",
@@ -330,6 +336,9 @@
 			"unit": "GB",
 			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
 			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"],
+                        "az_codes": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
 			"d573142f24894ef3bd3664de068b44b0"]
 		},
 		{
@@ -337,6 +346,9 @@
 			"unit": "GB",
 			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
 			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"],
+                        "az_codes": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
 			"d573142f24894ef3bd3664de068b44b0"]
 		},
 		{
@@ -344,6 +356,9 @@
 			"unit": "GB",
 			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
 			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"],
+                        "az_codes": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
 			"d573142f24894ef3bd3664de068b44b0"]
 		},
 		{
@@ -351,6 +366,9 @@
 			"unit": "GB",
 			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
 			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"],
+                        "az_codes": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
 			"d573142f24894ef3bd3664de068b44b0"]
 		},
 		{
@@ -358,6 +376,9 @@
 			"unit": "GB",
 			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
 			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"],
+                        "az_codes": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
 			"d573142f24894ef3bd3664de068b44b0"]
 		},
 		{
@@ -365,22 +386,26 @@
 			"unit": "GB",
 			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
 			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"],
+                        "az_codes": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
 			"d573142f24894ef3bd3664de068b44b0"]
 		}],
 		"billing_factor": "Duration"
 	}
            
 
            
-
            Status Code
            Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            
+
            Status Code
            Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            Table 5 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312041.html b/docs/dcs/api-ref/dcs-api-0312041.html
index c728c556..bd30f2f5 100644
--- a/docs/dcs/api-ref/dcs-api-0312041.html
+++ b/docs/dcs/api-ref/dcs-api-0312041.html
@@ -1,30 +1,30 @@
 
            Querying Maintenance Time Window
            
-
            Function
            The API is used to query the start time and end time of the maintenance time window.
            
+
            Function
            The API is used to query the start time and end time of the maintenance time window.
            
 
            
-
            URI
            GET /v1.0/instances/maintain-windows
            
+
            URI
            GET /v1.0/instances/maintain-windows
            
 
            
-
            Request
            Request parameters
            
-
            None
            
-
            Example request
            
-
            None
            
+
            Request
            Request parameters
            
+
            None
            
+
            Example request
            
+
            None
            
 
            
-
            Response
            Response parameters
            
-
            Table 1 describes the response parameters.
-
            Table 5 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Service specifications queried successfully.
            
+
            Service specifications queried successfully.
            
             		
 
            
             
 
 
            Table 1 Parameter description
            Parameter
            
+
            Response
            Response parameters
            
+
            Table 1 describes the response parameters.
+
            
-
-
-
-
-
@@ -32,46 +32,46 @@
 
 
-
            Table 1 Parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            maintain_windows
            
+
            maintain_windows
            
 
            Array
            
+
            Array
            
 
            List of supported maintenance time windows.
            
+
            List of supported maintenance time windows.
            
             		
 
            
             
 
            Table 2 maintain_windows parameter description
            Parameter
            
+
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 2 maintain_windows parameter description
            Parameter
            
 
            Type
            
+
            Type
            
 
            Description
            
+
            Description
            
             		
 
            
 
            seq
            
+
            seq
            
 
            Integer
            
+
            Integer
            
 
            Sequence number of the maintenance time window.
            
+
            Sequence number of the maintenance time window.
            
             		
 
            begin
            
+
            begin
            
 
            String
            
+
            String
            
 
            Start time of the maintenance time window.
            
+
            Start time of the maintenance time window.
            
             		
 
            end
            
+
            end
            
 
            String
            
+
            String
            
 
            End time of the maintenance time window.
            
+
            End time of the maintenance time window.
            
             		
 
            default
            
+
            default
            
 
            Boolean
            
+
            Boolean
            
 
            An indicator of whether the maintenance time window is set to the default time segment.
            
+
            An indicator of whether the maintenance time window is set to the default time segment.
            
             		
 
            
             
 
            
 
            
-
            Example response
            {
+
            Example response
            {
     "maintain_windows": [
         {
             "seq": 1,
@@ -113,17 +113,17 @@
 }
            
 
            
 
            
-
            Status Code
            Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
            
+
            Status Code
            Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.
            
 
-
            
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 3 Status code
            Status Code
            
+
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0312042.html b/docs/dcs/api-ref/dcs-api-0312042.html
index e63ebe00..4e208310 100644
--- a/docs/dcs/api-ref/dcs-api-0312042.html
+++ b/docs/dcs/api-ref/dcs-api-0312042.html
@@ -6,12 +6,14 @@
 
 
diff --git a/docs/dcs/api-ref/dcs-api-0312044.html b/docs/dcs/api-ref/dcs-api-0312044.html
deleted file mode 100644
index 44c4ee11..00000000
--- a/docs/dcs/api-ref/dcs-api-0312044.html
+++ /dev/null
@@ -1,2793 +0,0 @@
-
-
-
            Error Codes
            
-
            
-
            Table 3 Status code
            Status Code
            
 
            Description
            
+
            Description
            
             		
 
            
 
            200
            
+
            200
            
 
            Successfully queried the maintenance time window.
            
+
            Successfully queried the maintenance time window.
            
             		
 
            
             
 
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Status Code
            
-
            Error Code
            
-
            Error Message
            
-
            Description
            
-
            Solution
            
-
            400
            
-
            111400002
            
-
            Invalid project ID format.
            
-
            Invalid project ID format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400004
            
-
            Empty request body.
            
-
            Empty request body.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400005
            
-
            The message body contains invalid characters or is not in JSON format.
            
-
            The message body contains invalid characters or is not in JSON format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400007
            
-
            The selected cache engine type is not supported.
            
-
            The selected cache engine type is not supported.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400008
            
-
            The selected cache engine version is not supported.
            
-
            The selected cache engine version is not supported.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400009
            
-
            Invalid product ID in the request.
            
-
            Invalid product ID in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400010
            
-
            Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
            
-
            Invalid DCS instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400011
            
-
            DCS instance description cannot exceed 1024 characters.
            
-
            DCS instance description cannot exceed 1024 characters.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400012
            
-
            Invalid capacity parameter in the request.
            
-
            Invalid capacity parameter in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400013
            
-
            Invalid vpc_id in the request.
            
-
            Invalid vpc_id in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400014
            
-
            Invalid security_group_id in the request.
            
-
            Invalid security_group_id in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400016
            
-
            Invalid subnet_id in the request.
            
-
            Invalid subnet_id in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400017
            
-
            This DCS instance job task is still running.
            
-
            A background task associated with this instance is running.
            
-
            Try again later.
            
-
            400
            
-
            111400018
            
-
            This subnet must exist in the VPC.
            
-
            This subnet must exist in the VPC.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400019
            
-
            The password does not meet complexity requirements.
            
-
            The password does not meet complexity requirements.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400020
            
-
            DHCP must be enabled for this subnet.
            
-
            DHCP must be enabled for this subnet.
            
-
            Check whether DHCP has been enabled.
            
-
            400
            
-
            111400021
            
-
            The isAutoRenew parameter in the request must be either 0 or 1.
            
-
            Invalid isAutoRenew in the request. It must be either 0 or 1.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400022
            
-
            Engine does not match the product id.
            
-
            The cache engine does not match the product ID.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400026
            
-
            This operation is not allowed when the DCS instance is in the current state.
            
-
            This operation is not allowed when the DCS instance is in the current state.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400027
            
-
            This operation is not supported on this node.
            
-
            The current node does not support this operation.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400035
            
-
            DCS instance quota of the tenant is insufficient.
            
-
            DCS instance quota of the tenant is insufficient.
            
-
            Contact technical support.
            
-
            400
            
-
            111400036
            
-
            Memory quota of the tenant is insufficient.
            
-
            Memory quota of the tenant is insufficient.
            
-
            Contact technical support.
            
-
            400
            
-
            111400037
            
-
            The instanceParams parameter in the request contains invalid characters or is not in JSON format.
            
-
            The instanceParams parameter in the request contains invalid characters or is not in JSON format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400038
            
-
            The periodNum parameter in the request must be an integer.
            
-
            The periodNum parameter in the request must be an integer.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400039
            
-
            The quota limit has been reached.
            
-
            The quota limit has been reached.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400042
            
-
            This AZ does not exist.
            
-
            This AZ does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400045
            
-
            This DCS instance is already unfrozen.
            
-
            The instance is not frozen and cannot be unfrozen.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400046
            
-
            This security group does not exist.
            
-
            This security group does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400047
            
-
            The periodType parameter in the request must be either 2 or 3.
            
-
            The periodType parameter in the request must be either 2 or 3.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400048
            
-
            The security group must have both outbound and inbound rules with protocols set to ANY.
            
-
            The security group must have both outbound and inbound rules with protocols set to ANY.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400053
            
-
            the upgrade instance version equals to current version.
            
-
            The targetVersion parameter in the request cannot be the same as the source version.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400054
            
-
            the selected available zone quota not enough.
            
-
            The DCS resources in the selected AZ are not sufficient.
            
-
            Select another AZ or contact technical support.
            
-
            400
            
-
            111400060
            
-
            This DCS instance name already exists.
            
-
            This instance name already exists.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400061
            
-
            Invalid instance ID format.
            
-
            Invalid instance ID format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400062
            
-
            Invalid {0} parameter in the request.
            
-
            Invalid parameter {0} in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400063
            
-
            Invalid {0} parameter in the request.
            
-
            Invalid parameter {0} in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400064
            
-
            The action parameter in the request restart.
            
-
            The action parameter in the request must be restart.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400065
            
-
            The instances parameter in the request cannot be a null value or left unspecified.
            
-
            The instances parameter in the request cannot be a null value or left unspecified.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400066
            
-
            Invalid value of the configure parameter {0}.
            
-
            Invalid configuration parameter {0}.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400067
            
-
            The available_zones parameter in the request must an array that contains only one AZ ID.
            
-
            The available_zones parameter in the request must be an array that contains only one AZ ID.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400068
            
-
            This VPC does not exist.
            
-
            This VPC does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400070
            
-
            Invalid task ID format.
            
-
            Invalid task ID format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400072
            
-
            Invalid saveDays instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter saveDays in the request must be in the range from 1 to 7.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400073
            
-
            Invalid backupType instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter backupType in the request must be either auto or manual.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400074
            
-
            Invalid periodType instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter periodType in the request must be weekly.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400075
            
-
            Invalid backupAt instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter backupAt in the request cannot be null or undefined.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400076
            
-
            Invalid beginAt instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter beginAt in the request must be in the 00:00–00:00 format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400080
            
-
            Instance password verify failed.
            
-
            Invalid password for accessing the selected DCS instance.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400086
            
-
            only master standby instance is support this action
            
-
            This operation is allowed only for master/standby DCS instances.
            
-
            Operation not allowed.
            
-
            400
            
-
            111400087
            
-
            the backup record status is err when restore this instance
            
-
            The restore operation is allowed only when the backup task is in the Succeeded state.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400094
            
-
            the system is not support dcs job.
            
-
            The system does not support the background task function.
            
-
            Operation not allowed.
            
-
            400
            
-
            111400095
            
-
            the system is not support backup and restore.
            
-
            The system does not support the backup and restoration function.
            
-
            Operation not allowed.
            
-
            400
            
-
            111400096
            
-
            the instance is backuping.
            
-
            Backing up the DCS instance... Please try again later.
            
-
            Try again later.
            
-
            400
            
-
            111400097
            
-
            the instance is restoring.
            
-
            Restoring the DCS instance... Please try again later.
            
-
            Try again later.
            
-
            400
            
-
            111400098
            
-
            The value of the remark parameter must be 0 to 128 characters in length.
            
-
            The value of the remark parameter cannot exceed 128 characters long.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400099
            
-
            DCS instances in the Creating, Restarting state cannot be deleted.
            
-
            DCS instances in the Creating or Restarting state cannot be deleted.
            
-
            Try again later.
            
-
            400
            
-
            111400100
            
-
            The number of instance IDs in an instances array cannot exceed 50.
            
-
            The number of instance IDs in an instances array cannot exceed 50.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400102
            
-
            The system is not support resize.
            
-
            Scale-up is not supported.
            
-
            Operation not allowed.
            
-
            400
            
-
            111400103
            
-
            The system is not support resize.
            
-
            The capacity to which the DCS instance is scaled up must be greater than the original capacity.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400104
            
-
            The DCS instance is recovering from an internal fault. Please try again later or contact customer service.
            
-
            The DCS instance is recovering from an internal fault. Please try again later or contact technical support.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400105
            
-
            The value of reserved-memory cannot be greater than the free memory size of this DCS instance.
            
-
            The value of reserved-memory cannot be greater than the free memory size of this DCS instance.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400106
            
-
            The value of maintain time illegal.
            
-
            Invalid maintenance time window.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400108
            
-
            The Instance exists for processing scale up order. Please try again later.
            
-
            Scaling up the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400111
            
-
            the instance is restarting.
            
-
            Restarting the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400113
            
-
            the instance is extending.
            
-
            Scaling up the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400114
            
-
            the instance is configuring.
            
-
            Modifying instance configuration... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400115
            
-
            the instance is changing the password.
            
-
            Changing instance password... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400116
            
-
            the instance is upgrading.
            
-
            Upgrading the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400117
            
-
            the instance is rollbacking the version.
            
-
            Rolling back the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400118
            
-
            the instance is creating.
            
-
            Creating the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400119
            
-
            Query Bill Sample failed
            
-
            This DCS instance does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400120
            
-
            the instance is Freezing.
            
-
            Freezing the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            111400800
            
-
            Invalid {0} in the request.
            
-
            Invalid parameter {0} in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400843
            
-
            The no_password_access parameter is missing or its value is invalid.
            
-
            Parameter no_password_access is missing or invalid.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400844
            
-
            The access_user parameter is missing or its value is invalid.
            
-
            Parameter access_user is missing or invalid.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400845
            
-
            The password parameter is missing or its value is invalid.
            
-
            Parameter password is missing or invalid.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400849
            
-
            The request parameter new_password should not exist.
            
-
            Request parameter new_password should not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            111400850
            
-
            This operation is not supported when Password-Free Access is enabled for the instance.
            
-
            This operation is not supported when password-free access is enabled for the instance.
            
-
            Reset the instance password.
            
-
            400
            
-
            DCS. 4855
            
-
            Master standby swap is not supported.
            
-
            Master/Standby switchover is not supported.
            
-
            Operation not allowed.
            
-
            400
            
-
            DCS.1004
            
-
            Project ID does not match the token.
            
-
            Project ID does not match the token.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4002
            
-
            Invalid project ID format.
            
-
            Invalid project ID format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4004
            
-
            Empty request body.
            
-
            Empty request body.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4005
            
-
            The message body contains invalid characters or is not in JSON format.
            
-
            The message body contains invalid characters or is not in JSON format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4007
            
-
            The selected cache engine type is not supported.
            
-
            The selected cache engine edition is not supported.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4008
            
-
            The selected cache engine version is not supported.
            
-
            The selected cache engine version is not supported.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4009
            
-
            Invalid product ID in the request.
            
-
            Invalid product ID in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4010
            
-
            Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed.
            
-
            Invalid DCS instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4011
            
-
            DCS instance description cannot exceed 1024 characters.
            
-
            DCS instance description cannot exceed 1024 characters.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4012
            
-
            Invalid capacity parameter in the request.
            
-
            Invalid capacity parameter in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4013
            
-
            Invalid vpc_id in the request.
            
-
            Invalid vpc_id in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4014
            
-
            Invalid security_group_id in the request.
            
-
            Invalid security_group_id in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4016
            
-
            Invalid subnet_id in the request.
            
-
            Invalid subnet_id in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4017
            
-
            This DCS instance job task is still running.
            
-
            A background task associated with this instance is running.
            
-
            Try again later.
            
-
            400
            
-
            DCS.4018
            
-
            This subnet must exist in the VPC.
            
-
            This subnet must exist in the VPC.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4019
            
-
            The password does not meet complexity requirements.
            
-
            The password does not meet complexity requirements.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4020
            
-
            DHCP must be enabled for this subnet.
            
-
            DHCP must be enabled for this subnet.
            
-
            Check whether DHCP has been enabled.
            
-
            400
            
-
            DCS.4021
            
-
            The isAutoRenew parameter in the request must be either 0 or 1.
            
-
            Invalid isAutoRenew in the request. It must be either 0 or 1.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4022
            
-
            Engine does not match the product id.
            
-
            The cache engine does not match the product ID.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4026
            
-
            This operation is not allowed when the DCS instance is in the current state.
            
-
            This operation is not allowed when the DCS instance is in the current state.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4027
            
-
            This operation is not supported on this node.
            
-
            The specified operation is not supported on the current node.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4035
            
-
            DCS instance quota of the tenant is insufficient.
            
-
            DCS instance quota of the tenant is insufficient.
            
-
            Contact technical support.
            
-
            400
            
-
            DCS.4036
            
-
            Memory quota of the tenant is insufficient.
            
-
            Memory quota of the tenant is insufficient.
            
-
            Contact technical support.
            
-
            400
            
-
            DCS.4037
            
-
            The instanceParams parameter in the request contains invalid characters or is not in JSON format.
            
-
            The instanceParams parameter in the request contains invalid characters or is not in JSON format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4038
            
-
            The periodNum parameter in the request must be an integer.
            
-
            The periodNum parameter in the request must be an integer.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4039
            
-
            The quota limit has been reached.
            
-
            The quota limit has been reached.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4042
            
-
            This AZ does not exist.
            
-
            This AZ does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4045
            
-
            This DCS instance is already unfrozen.
            
-
            The instance is not frozen and cannot be unfrozen.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4046
            
-
            This security group does not exist.
            
-
            The specified security group does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4047
            
-
            The periodType parameter in the request must be either 2 or 3.
            
-
            The periodType parameter in the request must be either 2 or 3.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4048
            
-
            The security group must have both outbound and inbound rules with protocols set to ANY.
            
-
            The security group must have both outbound and inbound rules with protocols set to ANY.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4049
            
-
            The instance status is not running.
            
-
            The instance status is not running.
            
-
            Contact technical support.
            
-
            400
            
-
            DCS.4053
            
-
            the upgrade instance version equals to current version.
            
-
            The targetVersion parameter in the request cannot be the same as the source version.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4054
            
-
            the selected available zone quota not enough.
            
-
            The DCS resources in the selected AZ are not sufficient.
            
-
            Select another AZ or contact technical support.
            
-
            400
            
-
            DCS.4060
            
-
            This DCS instance name already exists.
            
-
            This instance name already exists.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4061
            
-
            Invalid instance ID format.
            
-
            Invalid instance ID format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4062
            
-
            Invalid {0} parameter in the request.
            
-
            Invalid parameter {0} in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4063
            
-
            Invalid {0} parameter in the request.
            
-
            Invalid parameter {0} in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4064
            
-
            The action parameter in the request must be restart.
            
-
            The action parameter in the request must be restart.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4065
            
-
            The instances parameter in the request cannot be a null value or left unspecified.
            
-
            The instances parameter in the request cannot be a null value or left unspecified.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4066
            
-
            Invalid value of the configure parameter {0}.
            
-
            Invalid configuration parameter {0}.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4067
            
-
            The available_zones parameter in the request must an array that contains only one AZ ID.
            
-
            The available_zones parameter in the request must be an array that contains only one AZ ID.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4068
            
-
            This VPC does not exist.
            
-
            This VPC does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4070
            
-
            Invalid task ID format.
            
-
            Invalid task ID format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4072
            
-
            Invalid saveDays instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter saveDays in the request must be in the range from 1 to 7.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4073
            
-
            Invalid backupType instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter backupType in the request must be either auto or manual.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4074
            
-
            Invalid periodType instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter periodType in the request must be weekly.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4075
            
-
            Invalid backupAt instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter backupAt in the request cannot be null or undefined.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4076
            
-
            Invalid beginAt instance backup policy parameter in the request.
            
-
            The value of the instance backup parameter beginAt in the request must be in the 00:00–00:00 format.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4080
            
-
            Instance password verify failed.
            
-
            Invalid instance password.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4086
            
-
            only master standby instance is support this action
            
-
            This operation is allowed only for master/standby DCS instances.
            
-
            Operation not allowed.
            
-
            400
            
-
            DCS.4087
            
-
            the backup record status is err when restore this instance
            
-
            The restore operation is allowed only when the backup task is in the Succeeded state.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4094
            
-
            the system is not support dcs job.
            
-
            The system does not support the background task function.
            
-
            Operation not allowed.
            
-
            400
            
-
            DCS.4095
            
-
            the system is not support backup and restore.
            
-
            The system does not support the backup and restoration function.
            
-
            Operation not allowed.
            
-
            400
            
-
            DCS.4096
            
-
            the instance is backuping.
            
-
            Backing up the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4097
            
-
            the instance is restoring.
            
-
            Restoring the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4098
            
-
            The value of the remark parameter must be 0 to 128 characters in length.
            
-
            The value of the remark parameter cannot exceed 128 characters long.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4099
            
-
            DCS instances in the Creating, Restarting state cannot be deleted.
            
-
            DCS instances in the Creating or Restarting state cannot be deleted.
            
-
            Try again later.
            
-
            400
            
-
            DCS.4100
            
-
            The number of instance IDs in an instances array cannot exceed 50.
            
-
            The number of instance IDs in an instances array cannot exceed 50.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4102
            
-
            The system is not support resize.
            
-
            Scale-up is not supported.
            
-
            Operation not allowed.
            
-
            400
            
-
            DCS.4103
            
-
            The system is not support resize.
            
-
            The capacity to which the DCS instance is scaled up must be greater than the original capacity.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4104
            
-
            The DCS instance is recovering from an internal fault. Please try again later or contact customer service.
            
-
            The DCS instance is recovering from an internal fault. Please try again later or contact technical support.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4105
            
-
            The value of reserved-memory cannot be greater than the free memory size of this DCS instance.
            
-
            The value of reserved-memory cannot be greater than the free memory size of this DCS instance.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4106
            
-
            The value of maintain time illegal.
            
-
            Invalid maintenance time window.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4108
            
-
            The Instance exists for processing sacle up order. Please try again later.
            
-
            Scaling up the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4111
            
-
            the instance is restarting.
            
-
            Restarting the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4113
            
-
            the instance is extending.
            
-
            Scaling up the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4114
            
-
            the instance is configuring.
            
-
            Modifying instance configuration... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4115
            
-
            the instance is changing the password.
            
-
            Changing instance password... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4116
            
-
            the instance is upgrading.
            
-
            Upgrading the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4117
            
-
            the instance is rollbacking the version.
            
-
            Rolling back the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4118
            
-
            the instance is creating.
            
-
            Creating the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4119
            
-
            Query Bill Sample failed
            
-
            This DCS instance does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4120
            
-
            the instance is Freezing.
            
-
            Freezing the DCS instance... Please try again later.
            
-
            Try again later or contact technical support.
            
-
            400
            
-
            DCS.4800
            
-
            Invalid {0} in the request.
            
-
            Invalid parameter {0} in the request.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4843
            
-
            The no_password_access parameter is missing or its value is invalid.
            
-
            Parameter no_password_access is missing or invalid.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4844
            
-
            The access_user parameter is missing or its value is invalid.
            
-
            Parameter access_user is missing or invalid.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4845
            
-
            The password parameter is missing or its value is invalid.
            
-
            Parameter password is missing or invalid.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4849
            
-
            The request parameter new_password should not exist.
            
-
            Request parameter new_password should not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4850
            
-
            This operation is not supported when Password-Free Access is enabled for the instance.
            
-
            This operation is not supported when password-free access is enabled for the instance.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4875
            
-
            Create replication number exceed max number limit.
            
-
            The maximum number of replicas that can be created has been reached.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4879
            
-
            r/w instance have only one repl can not remove ip from dns
            
-
            The IP address cannot be removed because a master/standby instance must have at least one replica IP address.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4911
            
-
            The network ip insufficient.
            
-
            The subnet does not have sufficient IP addresses.
            
-
            Check the quantity of IP addresses in the subnet. Release IP addresses that are no longer used or use another subnet that has sufficient IP addresses.
            
-
            400
            
-
            DCS.4918
            
-
            Instance bigkey analyze is running.
            
-
            The big key analysis is in progress.
            
-
            Try again later.
            
-
            400
            
-
            DCS.4919
            
-
            Does not support bigkey analyze.
            
-
            Big key analysis is not supported.
            
-
            Operation not allowed.
            
-
            400
            
-
            DCS.4930
            
-
            The request param node_list is invalid
            
-
            Invalid node_list parameter in the parameter.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4931
            
-
            Node is not replica, can't delete.
            
-
            The replica cannot be deleted because it is not a read-only replica.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4935
            
-
            Only one slave replication has dns ip, can not delete
            
-
            The replica cannot be deleted because at least one DNS IP address must be retained.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4936
            
-
            The master node cannot be deleted
            
-
            The master node cannot be deleted.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4937
            
-
            Only has one slave node,can not delete
            
-
            Retain at least one replica in addition to the master.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4939
            
-
            The param slave_priority_weight is invalid.
            
-
            Invalid slave_priority_weight parameter in the parameter.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4941
            
-
            The hotkey id does not exist.
            
-
            The hot key analysis task ID does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            400
            
-
            DCS.4942
            
-
            The bigkey id does not exist.
            
-
            The big key analysis task ID does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            111401001
            
-
            Invalid token.
            
-
            Invalid token.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            111401002
            
-
            Token expired.
            
-
            The token has expired.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            111401003
            
-
            No token in the request.
            
-
            The token is missing.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            111401004
            
-
            Project ID does not match the token.
            
-
            Project ID does not match the token.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            DCS.1001
            
-
            Invalid token.
            
-
            Invalid token.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            DCS.1002
            
-
            Token expired.
            
-
            The token has expired.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            DCS.1003
            
-
            No token in the request.
            
-
            The token is missing.
            
-
            Check whether the request parameters are valid.
            
-
            401
            
-
            DCS.1004
            
-
            Project ID does not match the token.
            
-
            Project ID does not match the token.
            
-
            Check whether the request parameters are valid.
            
-
            403
            
-
            111403002
            
-
            This tenant has read permission only and cannot perform this operation.
            
-
            This tenant has read permissions only and cannot perform this operation.
            
-
            Check whether the request parameters are valid.
            
-
            403
            
-
            111403003
            
-
            This role does not have the permission to perform this operation.
            
-
            This role does not have the permissions to perform this operation.
            
-
            Check whether the request parameters are valid.
            
-
            403
            
-
            DCS.2007
            
-
            Policy does not allow {} to be performed.
            
-
            Insufficient permissions.
            
-
            Check whether the account has the required operation permissions.
            
-
            403
            
-
            DCS.3002
            
-
            This tenant has read permission only and cannot perform this operation.
            
-
            This tenant has read permissions only and cannot perform this operation.
            
-
            Check whether the request parameters are valid.
            
-
            403
            
-
            DCS.3003
            
-
            This role does not have the permission to perform this operation.
            
-
            This role does not have the permissions to perform this operation.
            
-
            Check whether the request parameters are valid.
            
-
            404
            
-
            111404001
            
-
            The requested URL does not exist.
            
-
            The requested URL does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            404
            
-
            111404022
            
-
            This DCS instance does not exist.
            
-
            This DCS instance does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            404
            
-
            111404023
            
-
            This DCS order does not exist.
            
-
            The order does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            404
            
-
            DCS.4001
            
-
            The requested URL does not exist.
            
-
            The requested URL does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            404
            
-
            DCS.4022
            
-
            This DCS instance does not exist.
            
-
            This DCS instance does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            404
            
-
            DCS.4023
            
-
            This DCS order does not exist.
            
-
            The order does not exist.
            
-
            Check whether the request parameters are valid.
            
-
            405
            
-
            111405001
            
-
            This request method is not allowed.
            
-
            The request method is not allowed.
            
-
            Check whether the request parameters are valid.
            
-
            405
            
-
            DCS.5001
            
-
            This request method is not allowed.
            
-
            The request method is not allowed.
            
-
            Check whether the request parameters are valid.
            
-
            500
            
-
            111400069
            
-
            Another user is modifying configuration parameters of the DCS instance. Please try again later.
            
-
            Another user is modifying configuration parameters of the DCS instance. Try again later.
            
-
            Try again later.
            
-
            500
            
-
            111400101
            
-
            Delete instance backup file failed.
            
-
            Failed to delete the instance backup files.
            
-
            Contact technical support.
            
-
            500
            
-
            111400842
            
-
            job execution status failed.
            
-
            Failed to run the task.
            
-
            Contact technical support.
            
-
            500
            
-
            111500000
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500006
            
-
            
-
            Failed to submit Job for background execution.
            
-
            Failed to submit Job for background execution.
            
-
            Contact technical support.
            
-
            500
            
-
            111500017
            
-
            
-
            Failed to save instance information.
            
-
            Failed to save instance information.
            
-
            Contact technical support.
            
-
            500
            
-
            111500020
            
-
            vm add port fail
            
-
            A port fails to be added for the VM.
            
-
            Contact technical support.
            
-
            500
            
-
            111500024
            
-
            
-
            Query instance failed.
            
-
            The instance fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            111500031
            
-
            create instance fail
            
-
            Failed to create the DCS instance.
            
-
            Contact technical support.
            
-
            500
            
-
            111500032
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500037
            
-
            query order info fail
            
-
            Failed to query the order details.
            
-
            Try again later or contact technical support.
            
-
            500
            
-
            111500041
            
-
            No resource tenant available.
            
-
            No resource tenant available.
            
-
            Try again later or contact technical support.
            
-
            500
            
-
            111500044
            
-
            update resource status fail
            
-
            Failed to update the status of the DCS instance.
            
-
            Try again later or contact technical support.
            
-
            500
            
-
            111500053
            
-
            
-
            No instance node found.
            
-
            No instance node found.
            
-
            Contact technical support.
            
-
            500
            
-
            111500054
            
-
            
-
            Generate a password error.
            
-
            Failed to generate a password.
            
-
            Contact technical support.
            
-
            500
            
-
            111500070
            
-
            Internal service error.
            
-
            Parameter modification failed.
            
-
            Contact technical support.
            
-
            500
            
-
            111500071
            
-
            Failed to create instance backup strategy.
            
-
            The instance backup policy fails to be created.
            
-
            Contact technical support.
            
-
            500
            
-
            111500077
            
-
            Query instance backup strategy failed.
            
-
            The instance backup policy fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            111500078
            
-
            Query backup record failed.
            
-
            The backup record fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            111500079
            
-
            
-
            Query restore record failed.
            
-
            The restoration record fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            111500082
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500083
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500085
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500090
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500092
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            111500104
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS. 5094
            
-
            Master standby swap failed.
            
-
            Master/Standby switchover failed.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.4069
            
-
            Another user is modifying configuration parameters of the DCS instance. Please try again later.
            
-
            Another user is modifying configuration parameters of the DCS instance. Try again later.
            
-
            Try again later.
            
-
            500
            
-
            DCS.4101
            
-
            Delete instance backup file failed.
            
-
            Failed to delete the instance backup files.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.4842
            
-
            job execution status failed.
            
-
            Failed to run the task.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5000
            
-
            The system is busy. Please try again later.
            
-
            System busy. Try again later.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5006
            
-
            Job submit failed
            
-
            Failed to submit the task.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5006
            
-
            Submit job failed.
            
-
            Failed to submit the task.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5017
            
-
            Failed to save instance information.
            
-
            Failed to save the instance information.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5020
            
-
            vm add port fail
            
-
            A port fails to be added for the VM.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5024
            
-
            Query instance failed.
            
-
            The instance fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5031
            
-
            create instance fail
            
-
            Failed to create the DCS instance.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5032
            
-
            Failed to create order.
            
-
            Failed to create the order number.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5037
            
-
            query order info fail
            
-
            Failed to query the order details.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5041
            
-
            No resource tenant available.
            
-
            No resource tenant available.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5044
            
-
            update resource status fail
            
-
            Failed to update the status of the DCS instance.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5053
            
-
            Instance node not found.
            
-
            The specified instance node is not found.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5054
            
-
            Failed to generate password.
            
-
            The password fails to be generated.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5070
            
-
            Internal service error.
            
-
            Internal service error.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5071
            
-
            Failed to create instance backup strategy.
            
-
            The instance backup policy fails to be created.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5077
            
-
            Query instance backup strategy failed
            
-
            The instance backup policy fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5077
            
-
            Query instance failed.
            
-
            The instance fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5078
            
-
            Query backup record failed.
            
-
            The backup record fails to be queried.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5079
            
-
            Query group node failed.
            
-
            Failed to query the node.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5081
            
-
            Query instance group information failed.
            
-
            Failed to query the instance shard information.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5082
            
-
            Failed to register resource tenant backup user.
            
-
            The resource tenant backup user fails to be registered.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5083
            
-
            Failed to save backup user.
            
-
            The backup user fails to be saved.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5085
            
-
            Query instance whitelist failed.
            
-
            Failed to query the instance whitelist.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5090
            
-
            Failed to save backup information.
            
-
            The backup information fails to be saved.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5091
            
-
            Do not support create small spec instance.
            
-
            Small-specification instances cannot be created.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5092
            
-
            Failed to get master node.
            
-
            The master node of a master/standby instance cannot be found.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5095
            
-
            The script execution failed and needs to be retried.
            
-
            The script fails to be executed and needs to be executed again.
            
-
            Contact technical support.
            
-
            500
            
-
            DCS.5104
            
-
            Failed to modify order.
            
-
            Failed to modify the order.
            
-
            Contact technical support.
            
-
            
-
            
-
-
            
-
            
-
            Parent topic: Appendix
            
-
            
-
            
-
diff --git a/docs/dcs/api-ref/dcs-api-0312045.html b/docs/dcs/api-ref/dcs-api-0312045.html
index c48af838..5c1d658b 100644
--- a/docs/dcs/api-ref/dcs-api-0312045.html
+++ b/docs/dcs/api-ref/dcs-api-0312045.html
@@ -1,10 +1,36 @@
 
 
 
            Obtaining a Project ID
            
-
            Obtaining a Project ID on the Console
            A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.
            
-
            The following procedure describes how to obtain a project ID:
            
-
            1. Sign up and log in to the management console.
            2. Click the username and choose My Credential from the drop-down list.
              On the My Credential page, view project IDs in the project list.
              
-
              Figure 1 Viewing project IDs
              
+
              Obtaining a Project ID by Calling an API
              You can obtain a project ID by calling the 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} is the IAM endpoint and can be obtained from Regions and Endpoints. 
              
+
              The following is an example response. The value of id in the projects section is the project ID.
              
+
              {
+    "projects": [
+        {
+            "domain_id": "65382450e8f64ac0870cd180d14e684b",
+            "is_domain": false,
+            "parent_id": "65382450e8f64ac0870cd180d14e684b",
+            "name": "project_name",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
+            },
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}
              
+
              
+
              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. Sign up and log in to the management console.
              2. Click the username in the upper right corner and choose My Credentials from the drop-down list.
              3. On the My Credentials page, view project IDs in the project list.
                Figure 1 Viewing project IDs
                
 
              
 
              
 
              
diff --git a/docs/dcs/api-ref/dcs-api-0312049.html b/docs/dcs/api-ref/dcs-api-0312049.html
index 0b52111c..ee97ce19 100644
--- a/docs/dcs/api-ref/dcs-api-0312049.html
+++ b/docs/dcs/api-ref/dcs-api-0312049.html
@@ -8,53 +8,105 @@
 
            		
 
            
 
            2022-10-12
            
+
            2024-04-07
            
+
            Added some parameters and parameter examples to the Listing Migration Tasks, Querying Details of a Data Migration Task, Stopping a Data Migration Task, Listing Big Key Analysis Tasks, and Listing Background Tasks APIs.
            
+
            2024-03-12
            
+
            Update Enabling or Disabling SSL.
            
+
            Added DCS.4202 to section Error Codes.
            
+
            2023-12-26
            
+            		
+
            2023-12-13
            
+
            Added the Enabling or Disabling SSL, Querying SSL Encryption of an Instance, and Downloading the SSL Certificate of an Instance APIs.
            
+
            2023-09-27
            
+            		
+
            2023-05-15
            
+
            Added Permissions Policies and Supported Actions.
            
+
            2023-04-21
            
+
            Optimized descriptions and parameters.
            
+
            2023-03-27
            
+
            Modified the request example in section Querying Service Specifications and added the returned content of az_codes.
            
+
            2023-01-17
            
+            		
+
            2022-12-13
            
+
            Modified the following content:
            
+
+
            2022-10-12
            
             		
 
            Modified the following content:
            
-
+
             		
 
            
 
            2022-08-04
            
             		
 
            Modified the following content:
            
-
+
             		
 
            
 
            2022-07-13
            
             		
 
            Modified the following content:
            
-
            • Changed the JSON parameter type to Object.
            • Changed the Enum parameter type to String.
            • Added parameters cluster_v1 and node_role in section Querying Configuration Parameters.
            
+
            • Changed the JSON parameter type to Object.
            • Changed the Enum parameter type to String.
            • Added parameters cluster_v1 and node_role in section Querying Configuration Parameters.
            
             		
 
            
 
            2022-04-11
            
             		
 
            Modified the following content:
            
-
            Added the spec_code parameter in section Scaling Up a DCS Instance.
            
+
            Added the spec_code parameter in section Scaling Up a DCS Instance.
            
             		
 
            
 
            2021-06-30
            
             		
 
            Modified the following content:
            
-
+
             		
 
            
 
            2021-04-14
            
             		
 
            Modified the following content:
            
-
-
+
+
             		
 
            
 
            2020-09-30
            
             		
 
            Modified the following content:
            
-
            • Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs.
            • Added description about creating DCS Redis 4.0 and 5.0 instances in section Creating a DCS Instance.
            • Optimized Error Codes.
            
+
            • Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs.
            • Added description about creating DCS Redis 4.0 and 5.0 instances in section Creating a DCS Instance.
            • Optimized section "Error Code."
            
             		
 
            
 
            2020-06-16
            
             		
 
            Modified the following content:
            
-
            Added error codes such as 111400102 in section Error Codes.
            
+
            Added error codes such as 111400102 in the Error Codes section.
            
             		
 
            
 
            2020-03-25
            
@@ -91,7 +143,7 @@
 
            Modified the following content:
            • Provided support for DCS instances in the cluster mode.
            • Changed instance password complexity rules.
            
 
            
 
            Added the following content:
            
-
+
             		
 
            
 
            2017-05-30
            
diff --git a/docs/dcs/api-ref/dcs-api-0312050.html b/docs/dcs/api-ref/dcs-api-0312050.html
new file mode 100644
index 00000000..cbf28878
--- /dev/null
+++ b/docs/dcs/api-ref/dcs-api-0312050.html
@@ -0,0 +1,228 @@
+
+
+
            Instance Diagnosis IDs
            
+
            
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 1 cause_ids
            ID
            
+
            Type
            
+
            Description
            
+
            1
            
+
            cause
            
+
            The number of connected clients exceeds {THRESHOLD}.
            
+
            2
            
+
            cause
            
+
            The instantaneous traffic is too high.
            
+
            3
            
+
            cause
            
+
            The underlying disk is abnormal.
            
+
            4
            
+
            cause
            
+
            Data persistence failed.
            
+
            5
            
+
            cause
            
+
            Memory usage exceeds {THRESHOLD}.
            
+
            6
            
+
            cause
            
+
            RDB persistence is enabled. Memory usage exceeds {THRESHOLD}.
            
+
            7
            
+
            cause
            
+
            Excessive memory fragmentation.
            
+
            8
            
+
            cause
            
+
            Cache hit rate is lower than {THRESHOLD}.
            
+
            9
            
+
            cause
            
+
            Too many keys have expired at the same time.
            
+
            10
            
+
            cause
            
+
            The following commands with time complexity O(N) are executed: {COMMANDS}
            
+
            11
            
+
            cause
            
+
            CPU usage exceeds {THRESHOLD}.
            
+
            12
            
+
            cause
            
+
            Data is persisted.
            
+
            13
            
+
            cause
            
+
            QPS has increased.
            
+
            
+
            
+
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 2 impact_ids
            ID
            
+
            Type
            
+
            Description
            
+
            1
            
+
            impact
            
+
            Redis connections will be refused.
            
+
            2
            
+
            impact
            
+
            Redis will be disconnected.
            
+
            3
            
+
            impact
            
+
            Redis responses will slow down.
            
+
            4
            
+
            impact
            
+
            RDB persistence will fail.
            
+
            5
            
+
            impact
            
+
            Cache hit ratio will decrease.
            
+
            6
            
+
            impact
            
+
            AOF persistence will fail.
            
+
            
+
            
+
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 3 advice_ids
            ID
            
+
            Type
            
+
            Description
            
+
            1
            
+
            advice
            
+
            Retrieve connections from the connection pool.
            
+
            2
            
+
            advice
            
+
            Use read/write splitting or a cluster.
            
+
            3
            
+
            advice
            
+
            Expand the capacity of the instance.
            
+
            4
            
+
            advice
            
+
            Manually run the MEMORY PURGE command during low-demand hours.
            
+
            5
            
+
            advice
            
+
            Check the Redis usage or reduce the cache granularity to avoid memory eviction.
            
+
            6
            
+
            advice
            
+
            Set different expiration time for the keys.
            
+
            7
            
+
            advice
            
+
            Do not use commands with time complexity of O(N).
            
+
            
+
            
+
            
+
            
+
            
+
            Parent topic: Appendix
            
+
            
+
            
+
diff --git a/docs/dcs/api-ref/dcs-api-0514003.html b/docs/dcs/api-ref/dcs-api-0514003.html
deleted file mode 100644
index 488b1e6c..00000000
--- a/docs/dcs/api-ref/dcs-api-0514003.html
+++ /dev/null
@@ -1,15 +0,0 @@
-
-
-
-  
            Data Migration APIs
            
-
-  
            
-
            
-
-
-
diff --git a/docs/dcs/api-ref/dcs-api-0514004.html b/docs/dcs/api-ref/dcs-api-0514004.html
deleted file mode 100644
index 614756bb..00000000
--- a/docs/dcs/api-ref/dcs-api-0514004.html
+++ /dev/null
@@ -1,394 +0,0 @@
-
-
-
            Creating a Data Migration Task
            
-
            Function
            This API is used to create a data migration task.
            
-
            
-
            Constraints
            None
            
-
            
-
            URI
            POST /v2/{project_id}/migration-task
            
-
-
            
-
-
-
-
-
-
-
-
-
-
-
-
            Table 1 URI parameter
            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
            
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 2 Request body parameter description
            Parameter
            
-
            Mandatory
            
-
            Type
            
-
            Description
            
-
            task_name
            
-
            Yes
            
-
            String
            
-
            Name of the migration task.
            
-
            description
            
-
            No
            
-
            String
            
-
            Description of the migration task.
            
-
            migration_type
            
-
            Yes
            
-
            String
            
-
            Mode of the migration.
            
-
            Options:
            
-
            • backupfile_import: indicates importing backup files.
            • online_migration: indicates migrating data online.
            
-
            migration_method
            
-
            Yes
            
-
            String
            
-
            Type of the migration.
            
-
            Options:
            
-
            • full_amount_migration: indicates a full migration.
            • incremental_migration: indicates an incremental migration.
            
-
            backup_files
            
-
            No
            
-
            BackupFilesBody Object
            
-
            Backup files to be imported when the migration mode is importing backup files.
            
-
            network_type
            
-
            No
            
-
            String
            
-
            Type of the network for communication between the source and destination Redis when the migration mode is online data migration.
            
-
            Options:
            
-
            • vpc
            • vpn
            
-
            source_instance
            
-
            No
            
-
            SourceInstanceBody Object
            
-
            Source Redis information. This parameter is mandatory when the migration mode is online data migration.
            
-
            target_instance
            
-
            Yes
            
-
            TargetInstanceBody Object
            
-
            Destination Redis instance information.
            
-
            
-
            
-
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 3 BackupFilesBody
            Parameter
            
-
            Mandatory
            
-
            Type
            
-
            Description
            
-
            file_source
            
-
            No
            
-
            String
            
-
            Data source. Currently, only OBS buckets are supported. The value is self_build_obs.
            
-
            bucket_name
            
-
            Yes
            
-
            String
            
-
            OBS bucket name.
            
-
            files
            
-
            Yes
            
-
            Array of Files Objects
            
-
            List of backup files to be imported.
            
-
            
-
            
-
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 4 Files
            Parameter
            
-
            Mandatory
            
-
            Type
            
-
            Description
            
-
            file_name
            
-
            Yes
            
-
            String
            
-
            Name of a backup file.
            
-
            size
            
-
            No
            
-
            String
            
-
            File size in bytes.
            
-
            update_at
            
-
            No
            
-
            String
            
-
            Time when the file is last modified. The format is YYYY-MM-DD HH:MM:SS.
            
-
            
-
            
-
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 5 SourceInstanceBody
            Parameter
            
-
            Mandatory
            
-
            Type
            
-
            Description
            
-
            addrs
            
-
            Yes
            
-
            String
            
-
            Source Redis name (specified in the source_instance parameter).
            
-
            password
            
-
            No
            
-
            String
            
-
            Redis password. If a password is set, this parameter is mandatory.
            
-
            
-
            
-
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 6 TargetInstanceBody
            Parameter
            
-
            Mandatory
            
-
            Type
            
-
            Description
            
-
            id
            
-
            Yes
            
-
            String
            
-
            Destination Redis instance ID (mandatory in the target_instance parameter).
            
-
            name
            
-
            No
            
-
            String
            
-
            Destination Redis instance name (specified in the target_instance parameter).
            
-
            password
            
-
            No
            
-
            String
            
-
            Redis password. If a password is set, this parameter is mandatory.
            
-
            
-
            
-
            
-
            Response
            If the status code is 200, the following parameters are returned:
            
-
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Table 7 Parameter description
            Parameter
            
-
            Type
            
-
            Description
            
-
            id
            
-
            String
            
-
            ID of the migration task.
            
-
            name
            
-
            String
            
-
            Name of the migration task.
            
-
            status
            
-
            String
            
-
            Migration task status. The value can be:
            
-
            • SUCCESS: Migration succeeded.
            • FAILED: Migration failed.
            • MIGRATING: Migration is in progress.
            • TERMINATED: Migration has been stopped.
            • TERMINATING: Migration is being stopped.
            • RUNNING: The migration task has been created and is waiting to be executed.
            • CREATING: The migration task is being created.
            • FULLMIGRATING: Full migration is in progress.
            • INCRMIGEATING: Incremental migration is in progress.
            • ERROR: faulty
            • DELETED: faulty
            • RELEASED: automatically released
            • MIGRATION_SUCCESS: The migration is successful, and resources are to be cleared.
            • MIGRATION_FAILED: The migration failed, and resources are to be cleared.
            
-
            
-
            
-
            
-
            Example Request
            • Example request URL:
              POST https://{dcs_endpoint}/v2/{project_id}/migration-task
              
-
            • Example request 1 (online migration)
              { 
-  "task_name" : "lmd-test", 
-  "description" : "Test", 
-  "migration_type" : "online_migration", 
-  "migration_method" : "full_amount_migration", 
-  "network_type" : "vpc", 
-  "source_instance" : { 
-    "addrs" : "192.168.1.135:6379", 
-    "password" : "xxxxxx" 
-  }, 
-  "target_instance" : { 
-    "name" : "dcs-test", 
-    "id" : "4cd5dbb8-aacd-4603-b817-3e97d48c7a20" 
-  } 
-}
              
-
            • Example request 2 (importing a backup file)
              {
- "backup_files": {
-  "bucket_name": "bucket-lmz",
-  "file_source": "self_build_obs",
-  "files": [
-   {
-    "file_name": "appendonly03.aof"
-   }
-  ]
- },
- "migration_method": "full_amount_migration",
- "migration_type": "backupfile_import",
- "target_instance": {
-  "id": "318ed365-3c1b-42d7-a5b6-663dded628a0"
- },
- "task_name": "lmd-test"
-}
              
-
            
-
            
-
            Example Response
            If the status code is 200, the data migration task is successfully created.
            
-
            { 
-  "id" : "8aa6999e71cb638b0171f485f5266ef0", 
-  "name" : "lmd-test", 
-  "status" : "MIGRATING" 
-}
            
-
            
-
            Status Code
            
-
            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
            Status Code
            
-
            Description
            
-
            200
            
-
            Data migration task created successfully.
            
-
            400
            
-
            Invalid request.
            
-
            500
            
-
            Internal service error.
            
-
            
-
            
-
            
-
            Error Codes
            For details, see Error Codes.
            
-
            
-
            
-
            
-
            
-
            Parent topic: Data Migration APIs
            
-
            
-
            
-
diff --git a/docs/dcs/api-ref/dcs-api-0514005.html b/docs/dcs/api-ref/dcs-api-0514005.html
index 315a89de..2e10f031 100644
--- a/docs/dcs/api-ref/dcs-api-0514005.html
+++ b/docs/dcs/api-ref/dcs-api-0514005.html
@@ -1,7 +1,7 @@
 
 
 
            Backup and Restoration APIs
            
-
            
+
            
 
            
 
            
 
+
+
            
+
            Parent topic: Outdated APIs (V1)
            
+
            
 
            
 
diff --git a/docs/dcs/api-ref/dcs-api-0605001.html b/docs/dcs/api-ref/dcs-api-0605001.html
new file mode 100644
index 00000000..88e9b078
--- /dev/null
+++ b/docs/dcs/api-ref/dcs-api-0605001.html
@@ -0,0 +1,38 @@
+
+
+
            APIs V2 (Recommended)
            
+
            
+
            
+
+
diff --git a/docs/dcs/api-ref/dcs-api-0605002.html b/docs/dcs/api-ref/dcs-api-0605002.html
new file mode 100644
index 00000000..895d345f
--- /dev/null
+++ b/docs/dcs/api-ref/dcs-api-0605002.html
@@ -0,0 +1,23 @@
+
+
+
+  
            Outdated APIs (V1)
            
+
+  
            
+
            
+
+
+
diff --git a/docs/dcs/api-ref/en-us_topic_0000001645635650.html b/docs/dcs/api-ref/en-us_topic_0000001645635650.html
new file mode 100644
index 00000000..a39de2fe
--- /dev/null
+++ b/docs/dcs/api-ref/en-us_topic_0000001645635650.html
@@ -0,0 +1,163 @@
+
+
+
            Querying the List of API Versions
            
+
            Function
            This API is used to query the list of API versions.
            
+
            
+
            URI
            URI format
            
+
            GET /
            
+
            
+
            Request
            Sample:
            GET https://{dcs_endpoint}/
            
+
            
+
            
+
            Response
            
+
            
+
+
+
+
+
+
+
+
+
+
            Table 1 Response parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            versions
            
+
            Array of objects
            
+
            List of API versions. For details, see Table 2.
            
+
            
+
            
+
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 2 versions parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            min_version
            
+
            String
            
+
            The minimum minorversion supported. If the version does not support minorversions, the value is empty.
            
+
            links
            
+
            Array of objects
            
+
            API version URI. For details, see Table 3.
            
+
            id
            
+
            String
            
+
            ID of the API version.
            
+
            updated
            
+
            String
            
+
            The last time when the API version was updated.
            
+
            Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
            
+
            version
            
+
            String
            
+
            The maximum minorversion supported. If the version does not support minorversions, the value is empty.
            
+
            status
            
+
            String
            
+
            API version status. The value can be as follows:
            • CURRENT: DCS custom APIs provide multiple versions. For APIs offering the same functions, you are recommended to use the v2 APIs.
            • DEPRECATED: The version is a deprecated version, which may be deleted later.
            
+
            
+
            
+
            
+
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 3 links parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            rel
            
+
            String
            
+
            Identifies the semantics of the relationship.
            
+
            href
            
+
            String
            
+
            Defines the semantics of the relationship.
            
+
            
+
            
+
            
+
            Sample
            {
+	"versions": [{
+		"id": "v1.0",
+		"links": [{
+			"href": "self",
+			"rel": "https://{dcs_endpoint}/v1.0/"
+		}],
+		"min_version": "",
+		"status": "DEPRECATED",
+		"updated": "2016-12-09T00:00:00Z",
+		"version": ""
+	},
+	{
+		"id": "v2",
+		"links": [{
+			"href": "self",
+			"rel": "https://{dcs_endpoint}/v2/"
+		}],
+		"min_version": "",
+		"status": "CURRENT",
+		"updated": "2016-12-09T00:00:00Z",
+		"version": ""
+	}]
+}
            
+
            
+
            Status Code
            
+
            
+
+
+
+
+
+
+
+
            Status Code
            
+
            Description
            
+
            200
            
+
            Normal
            
+
            
+
            
+
            
+
            Error Codes
            For details, see Error Codes.
            
+
            
+
            
+
            
+
            
+
            Parent topic: API Version Query
            
+
            
+
            
+
diff --git a/docs/dcs/api-ref/en-us_topic_0000001693796125.html b/docs/dcs/api-ref/en-us_topic_0000001693796125.html
new file mode 100644
index 00000000..1df090e7
--- /dev/null
+++ b/docs/dcs/api-ref/en-us_topic_0000001693796125.html
@@ -0,0 +1,171 @@
+
+
+
            Querying Information of an API Version
            
+
            Function
            Querying Information of an API Version.
            
+
            
+
            URI
            URI format
            
+
            GET /{api_version}
+
            
+
+
+
+
+
+
+
+
+
+
            Table 1 Parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            api_version
            
+
            String
            
+
            Target API version.
            
+
            The value can be v1.0 or v2.
            
+
            
+
            
+
            
+
            
+
            Request
            Sample:
            GET https://{dcs_endpoint}/v2
            
+
            
+
            
+
            Response
            
+
            
+
+
+
+
+
+
+
+
+
+
            Table 2 Response parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            version
            
+
            Object
            
+
            List of API versions. For details, see Table 3.
            
+
            
+
            
+
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 3 versions parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            min_version
            
+
            String
            
+
            The minimum minorversion supported. If the version does not support minorversions, the value is empty.
            
+
            links
            
+
            Array of objects
            
+
            API version URI. For details, see Table 4.
            
+
            id
            
+
            String
            
+
            ID of the API version.
            
+
            updated
            
+
            String
            
+
            The last time when the API version was updated.
            
+
            version
            
+
            String
            
+
            The maximum minorversion supported. If the version does not support minorversions, the value is empty.
            
+
            status
            
+
            String
            
+
            API version status. The value can be as follows:
            
+
            • CURRENT: DCS custom APIs provide multiple versions. For APIs offering the same functions, you are recommended to use the v2 APIs.
            • DEPRECATED: The version is a deprecated version, which may be deleted later.
            
+
            
+
            
+
+
            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
            Table 4 links parameters
            Parameter
            
+
            Type
            
+
            Description
            
+
            rel
            
+
            String
            
+
            Identifies the semantics of the relationship.
            
+
            href
            
+
            String
            
+
            Defines the semantics of the relationship.
            
+
            
+
            
+
            
+
            Sample
            {
+	"version": {
+		"id": "v2",
+		"links": [{
+			"href": "self",
+			"rel": "https://{dcs_endpoint}/v2/"
+		}],
+		"min_version": "",
+		"status": "CURRENT",
+		"updated": "2016-12-09T00:00:00Z",
+		"version": ""
+	}
+}
            
+
            
+
            Status Code
            
+
            
+
+
+
+
+
+
+
+
            Status Code
            
+
            Description
            
+
            200
            
+
            Normal
            
+
            
+
            
+
            
+
            Error Codes
            For details, see Error Codes.
            
+
            
+
            
+
            
+
            
+
            Parent topic: API Version Query
            
+
            
+
            
+
diff --git a/docs/dcs/api-ref/en-us_topic_0000001693875369.html b/docs/dcs/api-ref/en-us_topic_0000001693875369.html
new file mode 100644
index 00000000..df3221f2
--- /dev/null
+++ b/docs/dcs/api-ref/en-us_topic_0000001693875369.html
@@ -0,0 +1,14 @@
+
+
+
            API Version Query
            
+
            
+
            
+
+
diff --git a/docs/dcs/api-ref/topic_300000009.html b/docs/dcs/api-ref/topic_300000009.html
deleted file mode 100644
index fc289737..00000000
--- a/docs/dcs/api-ref/topic_300000009.html
+++ /dev/null
@@ -1,13 +0,0 @@
-
-
-
            Network Security
            
-
            
-
-