diff --git a/docs/dcs/api-ref/ALL_META.TXT.json b/docs/dcs/api-ref/ALL_META.TXT.json index 8fd8f0697..52971f516 100644 --- a/docs/dcs/api-ref/ALL_META.TXT.json +++ b/docs/dcs/api-ref/ALL_META.TXT.json @@ -100,7 +100,7 @@ { "uri":"LifecycleManagement.html", "node_id":"lifecyclemanagement.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -108,7 +108,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Lifecycle Management", @@ -117,7 +118,7 @@ { "uri":"CreateInstance.html", "node_id":"createinstance.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -127,6 +128,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateInstance" } ], @@ -136,7 +138,7 @@ { "uri":"ListInstances.html", "node_id":"listinstances.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -146,6 +148,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListInstances" } ], @@ -155,7 +158,7 @@ { "uri":"BatchDeleteInstances.html", "node_id":"batchdeleteinstances.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -165,6 +168,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"BatchDeleteInstances" } ], @@ -174,7 +178,7 @@ { "uri":"ShowInstance.html", "node_id":"showinstance.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -184,6 +188,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowInstance" } ], @@ -193,7 +198,7 @@ { "uri":"DeleteSingleInstance.html", "node_id":"deletesingleinstance.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -203,6 +208,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteSingleInstance" } ], @@ -212,7 +218,7 @@ { "uri":"UpdateInstance.html", "node_id":"updateinstance.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -222,6 +228,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateInstance" } ], @@ -231,7 +238,7 @@ { "uri":"ResizeInstance.html", "node_id":"resizeinstance.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -241,6 +248,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ResizeInstance" } ], @@ -250,7 +258,7 @@ { "uri":"InstanceManagement.html", "node_id":"instancemanagement.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -258,7 +266,8 @@ "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Instance Management", @@ -267,7 +276,7 @@ { "uri":"ChangeMasterStandby.html", "node_id":"changemasterstandby.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -277,6 +286,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ChangeMasterStandby" } ], @@ -286,7 +296,7 @@ { "uri":"UpdatePassword.html", "node_id":"updatepassword.xml", - "product_code":"", + "product_code":"dcs", "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", @@ -296,18 +306,39 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdatePassword" } ], "title":"Changing the Password", "githuburl":"" }, + { + "uri":"ResetPassword.html", + "node_id":"resetpassword.xml", + "product_code":"dcs", + "code":"17", + "des":"This API is used to reset the password of a DCS instance.POST /v2/{project_id}/instances/{instance_id}/password/resetStatus code: 200Status code: 400Status code: 500Reset", + "doc_type":"api", + "kw":"Resetting a Password,Instance Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"dcs", + "operation_id":"ResetPassword" + } + ], + "title":"Resetting a 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", + "product_code":"dcs", + "code":"18", + "des":"This API is used to restart a running DCS instance.This API can also be used to clear data of DCS Redis 4.0 and later instances. Cleared data cannot be restored. Exercise", "doc_type":"api", "kw":"Restarting DCS Instances or Clearing DCS Instance Data,Instance Management,API Reference", "search_title":"", @@ -315,6 +346,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"RestartOrFlushInstances" } ], @@ -324,8 +356,8 @@ { "uri":"ListStatisticsOfRunningInstances.html", "node_id":"liststatisticsofrunninginstances.xml", - "product_code":"", - "code":"18", + "product_code":"dcs", + "code":"19", "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,API Reference", @@ -334,6 +366,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListStatisticsOfRunningInstances" } ], @@ -343,15 +376,16 @@ { "uri":"GroupReplicationManagement.html", "node_id":"groupreplicationmanagement.xml", - "product_code":"", - "code":"19", + "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":"Shards and Replicas", "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Shards and Replicas", @@ -360,8 +394,8 @@ { "uri":"UpdateSlavePriority.html", "node_id":"updateslavepriority.xml", - "product_code":"", - "code":"20", + "product_code":"dcs", + "code":"21", "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":"Configuring Replica Priority,Shards and Replicas,API Reference", @@ -370,6 +404,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateSlavePriority" } ], @@ -379,8 +414,8 @@ { "uri":"DeleteIpFromDomainName.html", "node_id":"deleteipfromdomainname.xml", - "product_code":"", - "code":"21", + "product_code":"dcs", + "code":"22", "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", @@ -389,6 +424,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteIpFromDomainName" } ], @@ -398,9 +434,9 @@ { "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", + "product_code":"dcs", + "code":"23", + "des":"This API is used to query information about shards and replicas of Redis 4.0 and later instances (single-node ones not included).GET /v2/{project_id}/instance/{instance_i", "doc_type":"api", "kw":"Querying Details of Shards,Shards and Replicas,API Reference", "search_title":"", @@ -408,6 +444,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListGroupReplicationInfo" } ], @@ -417,9 +454,9 @@ { "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", + "product_code":"dcs", + "code":"24", + "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 returne", "doc_type":"api", "kw":"Querying Instance Nodes in Batches,Shards and Replicas,API Reference", "search_title":"", @@ -427,6 +464,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"BatchShowNodesInformation" } ], @@ -436,15 +474,16 @@ { "uri":"ParamManagement.html", "node_id":"parammanagement.xml", - "product_code":"", - "code":"24", + "product_code":"dcs", + "code":"25", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Parameter Management", @@ -453,8 +492,8 @@ { "uri":"ListConfigurations.html", "node_id":"listconfigurations.xml", - "product_code":"", - "code":"25", + "product_code":"dcs", + "code":"26", "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", @@ -463,6 +502,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListConfigurations" } ], @@ -472,8 +512,8 @@ { "uri":"UpdateConfigurations.html", "node_id":"updateconfigurations.xml", - "product_code":"", - "code":"26", + "product_code":"dcs", + "code":"27", "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", @@ -482,6 +522,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateConfigurations" } ], @@ -491,8 +532,8 @@ { "uri":"ListConfigHistories.html", "node_id":"listconfighistories.xml", - "product_code":"", - "code":"27", + "product_code":"dcs", + "code":"28", "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 the List of Instance Parameter Modification Records,Parameter Management,API Reference", @@ -501,6 +542,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListConfigHistories" } ], @@ -510,15 +552,16 @@ { "uri":"BackupRestoreManagement.html", "node_id":"backuprestoremanagement.xml", - "product_code":"", - "code":"28", + "product_code":"dcs", + "code":"29", "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", "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Backup and Restoration", @@ -527,8 +570,8 @@ { "uri":"DeleteBackupFile.html", "node_id":"deletebackupfile.xml", - "product_code":"", - "code":"29", + "product_code":"dcs", + "code":"30", "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":"Deleting Backup Files,Backup and Restoration,API Reference", @@ -537,6 +580,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteBackupFile" } ], @@ -546,8 +590,8 @@ { "uri":"RestoreInstance.html", "node_id":"restoreinstance.xml", - "product_code":"", - "code":"30", + "product_code":"dcs", + "code":"31", "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", @@ -556,6 +600,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"RestoreInstance" } ], @@ -565,8 +610,8 @@ { "uri":"ListRestoreRecords.html", "node_id":"listrestorerecords.xml", - "product_code":"", - "code":"31", + "product_code":"dcs", + "code":"32", "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", @@ -575,6 +620,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListRestoreRecords" } ], @@ -584,8 +630,8 @@ { "uri":"ListBackupFileLinks.html", "node_id":"listbackupfilelinks.xml", - "product_code":"", - "code":"32", + "product_code":"dcs", + "code":"33", "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", @@ -594,6 +640,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListBackupFileLinks" } ], @@ -603,8 +650,8 @@ { "uri":"CopyInstance.html", "node_id":"copyinstance.xml", - "product_code":"", - "code":"33", + "product_code":"dcs", + "code":"34", "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", @@ -613,6 +660,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CopyInstance" } ], @@ -622,8 +670,8 @@ { "uri":"ListBackupRecords.html", "node_id":"listbackuprecords.xml", - "product_code":"", - "code":"34", + "product_code":"dcs", + "code":"35", "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", @@ -632,6 +680,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListBackupRecords" } ], @@ -641,15 +690,16 @@ { "uri":"DataMigrationManagement.html", "node_id":"datamigrationmanagement.xml", - "product_code":"", - "code":"35", + "product_code":"dcs", + "code":"36", "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", "search_title":"", "metedata":[ { - "documenttype":"api" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Data Migration", @@ -658,8 +708,8 @@ { "uri":"CreateMigrationTask.html", "node_id":"createmigrationtask.xml", - "product_code":"", - "code":"36", + "product_code":"dcs", + "code":"37", "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", @@ -668,6 +718,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateMigrationTask" } ], @@ -677,8 +728,8 @@ { "uri":"ListMigrationTask.html", "node_id":"listmigrationtask.xml", - "product_code":"", - "code":"37", + "product_code":"dcs", + "code":"38", "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", @@ -687,6 +738,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListMigrationTask" } ], @@ -696,8 +748,8 @@ { "uri":"DeleteMigrationTask.html", "node_id":"deletemigrationtask.xml", - "product_code":"", - "code":"38", + "product_code":"dcs", + "code":"39", "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", @@ -706,6 +758,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteMigrationTask" } ], @@ -715,8 +768,8 @@ { "uri":"ShowMigrationTask.html", "node_id":"showmigrationtask.xml", - "product_code":"", - "code":"39", + "product_code":"dcs", + "code":"40", "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", @@ -725,6 +778,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowMigrationTask" } ], @@ -734,8 +788,8 @@ { "uri":"UpdateMigrationTask.html", "node_id":"updatemigrationtask.xml", - "product_code":"", - "code":"40", + "product_code":"dcs", + "code":"41", "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", @@ -744,6 +798,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateMigrationTask" } ], @@ -753,8 +808,8 @@ { "uri":"StopMigrationTask.html", "node_id":"stopmigrationtask.xml", - "product_code":"", - "code":"41", + "product_code":"dcs", + "code":"42", "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", @@ -763,6 +818,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"StopMigrationTask" } ], @@ -772,8 +828,8 @@ { "uri":"ShowMigrationTaskStats.html", "node_id":"showmigrationtaskstats.xml", - "product_code":"", - "code":"42", + "product_code":"dcs", + "code":"43", "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", @@ -782,6 +838,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowMigrationTaskStats" } ], @@ -791,8 +848,8 @@ { "uri":"CreateOnlineMigrationTask.html", "node_id":"createonlinemigrationtask.xml", - "product_code":"", - "code":"43", + "product_code":"dcs", + "code":"44", "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", @@ -801,6 +858,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateOnlineMigrationTask" } ], @@ -810,8 +868,8 @@ { "uri":"SetOnlineMigrationTask.html", "node_id":"setonlinemigrationtask.xml", - "product_code":"", - "code":"44", + "product_code":"dcs", + "code":"45", "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", @@ -820,6 +878,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"SetOnlineMigrationTask" } ], @@ -829,8 +888,8 @@ { "uri":"BatchStopMigrationTasks.html", "node_id":"batchstopmigrationtasks.xml", - "product_code":"", - "code":"45", + "product_code":"dcs", + "code":"46", "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", @@ -839,6 +898,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"BatchStopMigrationTasks" } ], @@ -848,15 +908,16 @@ { "uri":"TagManagement.html", "node_id":"tagmanagement.xml", - "product_code":"", - "code":"46", + "product_code":"dcs", + "code":"47", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Tag Management", @@ -865,8 +926,8 @@ { "uri":"ListTagsOfTenant.html", "node_id":"listtagsoftenant.xml", - "product_code":"", - "code":"47", + "product_code":"dcs", + "code":"48", "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", @@ -875,6 +936,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListTagsOfTenant" } ], @@ -884,8 +946,8 @@ { "uri":"BatchCreateOrDeleteTags.html", "node_id":"batchcreateordeletetags.xml", - "product_code":"", - "code":"48", + "product_code":"dcs", + "code":"49", "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", @@ -894,6 +956,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"BatchCreateOrDeleteTags" } ], @@ -903,8 +966,8 @@ { "uri":"ShowTags.html", "node_id":"showtags.xml", - "product_code":"", - "code":"49", + "product_code":"dcs", + "code":"50", "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", @@ -913,6 +976,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowTags" } ], @@ -922,15 +986,16 @@ { "uri":"CacheAnalysisManagement.html", "node_id":"cacheanalysismanagement.xml", - "product_code":"", - "code":"50", + "product_code":"dcs", + "code":"51", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Cache Analysis", @@ -939,8 +1004,8 @@ { "uri":"CreateBigkeyScanTask.html", "node_id":"createbigkeyscantask.xml", - "product_code":"", - "code":"51", + "product_code":"dcs", + "code":"52", "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", @@ -949,6 +1014,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateBigkeyScanTask" } ], @@ -958,8 +1024,8 @@ { "uri":"ListBigkeyScanTasks.html", "node_id":"listbigkeyscantasks.xml", - "product_code":"", - "code":"52", + "product_code":"dcs", + "code":"53", "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", @@ -968,6 +1034,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListBigkeyScanTasks" } ], @@ -977,8 +1044,8 @@ { "uri":"ShowBigkeyScanTaskDetails.html", "node_id":"showbigkeyscantaskdetails.xml", - "product_code":"", - "code":"53", + "product_code":"dcs", + "code":"54", "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", @@ -987,6 +1054,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowBigkeyScanTaskDetails" } ], @@ -996,8 +1064,8 @@ { "uri":"DeleteBigkeyScanTask.html", "node_id":"deletebigkeyscantask.xml", - "product_code":"", - "code":"54", + "product_code":"dcs", + "code":"55", "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", @@ -1006,6 +1074,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteBigkeyScanTask" } ], @@ -1015,8 +1084,8 @@ { "uri":"UpdateBigkeyAutoscanConfig.html", "node_id":"updatebigkeyautoscanconfig.xml", - "product_code":"", - "code":"55", + "product_code":"dcs", + "code":"56", "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", @@ -1025,6 +1094,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateBigkeyAutoscanConfig" } ], @@ -1034,8 +1104,8 @@ { "uri":"ShowBigkeyAutoscanConfig.html", "node_id":"showbigkeyautoscanconfig.xml", - "product_code":"", - "code":"56", + "product_code":"dcs", + "code":"57", "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", @@ -1044,6 +1114,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowBigkeyAutoscanConfig" } ], @@ -1053,9 +1124,9 @@ { "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", + "product_code":"dcs", + "code":"58", + "des":"This API is used to create a hot key analysis task.To perform hot key analysis, the instance's maxmemory-policy parameter must be set to allkeys-lfu or volatile-lfu.POST ", "doc_type":"api", "kw":"Creating a Hot Key Analysis Task,Cache Analysis,API Reference", "search_title":"", @@ -1063,6 +1134,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateHotkeyScanTask" } ], @@ -1072,8 +1144,8 @@ { "uri":"ListHotKeyScanTasks.html", "node_id":"listhotkeyscantasks.xml", - "product_code":"", - "code":"58", + "product_code":"dcs", + "code":"59", "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", @@ -1082,6 +1154,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListHotKeyScanTasks" } ], @@ -1091,8 +1164,8 @@ { "uri":"ShowHotkeyTaskDetails.html", "node_id":"showhotkeytaskdetails.xml", - "product_code":"", - "code":"59", + "product_code":"dcs", + "code":"60", "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", @@ -1101,6 +1174,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowHotkeyTaskDetails" } ], @@ -1110,8 +1184,8 @@ { "uri":"DeleteHotkeyScanTask.html", "node_id":"deletehotkeyscantask.xml", - "product_code":"", - "code":"60", + "product_code":"dcs", + "code":"61", "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", @@ -1120,6 +1194,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteHotkeyScanTask" } ], @@ -1129,8 +1204,8 @@ { "uri":"UpdateHotkeyAutoScanConfig.html", "node_id":"updatehotkeyautoscanconfig.xml", - "product_code":"", - "code":"61", + "product_code":"dcs", + "code":"62", "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", @@ -1139,6 +1214,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateHotkeyAutoScanConfig" } ], @@ -1148,8 +1224,8 @@ { "uri":"ShowHotkeyAutoscanConfig.html", "node_id":"showhotkeyautoscanconfig.xml", - "product_code":"", - "code":"62", + "product_code":"dcs", + "code":"63", "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", @@ -1158,6 +1234,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowHotkeyAutoscanConfig" } ], @@ -1167,9 +1244,9 @@ { "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 ", + "product_code":"dcs", + "code":"64", + "des":"This API is used to create an expired key scan task.The keyspace will be scanned to release the memory used by expired keys that were not released due to the lazy free me", "doc_type":"api", "kw":"Creating an Expired Key Scan Task,Cache Analysis,API Reference", "search_title":"", @@ -1177,6 +1254,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateAutoExpireScanTask" } ], @@ -1186,15 +1264,16 @@ { "uri":"LogManagement.html", "node_id":"logmanagement.xml", - "product_code":"", - "code":"64", + "product_code":"dcs", + "code":"65", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Log Management", @@ -1203,8 +1282,8 @@ { "uri":"ListSlowlog.html", "node_id":"listslowlog.xml", - "product_code":"", - "code":"65", + "product_code":"dcs", + "code":"66", "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", @@ -1213,6 +1292,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListSlowlog" } ], @@ -1222,8 +1302,8 @@ { "uri":"ListRedislog.html", "node_id":"listredislog.xml", - "product_code":"", - "code":"66", + "product_code":"dcs", + "code":"67", "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", @@ -1232,6 +1312,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListRedislog" } ], @@ -1241,8 +1322,8 @@ { "uri":"CreateRedislog.html", "node_id":"createredislog.xml", - "product_code":"", - "code":"67", + "product_code":"dcs", + "code":"68", "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", @@ -1251,6 +1332,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateRedislog" } ], @@ -1260,8 +1342,8 @@ { "uri":"CreateRedislogDownloadLink.html", "node_id":"createredislogdownloadlink.xml", - "product_code":"", - "code":"68", + "product_code":"dcs", + "code":"69", "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", @@ -1270,6 +1352,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateRedislogDownloadLink" } ], @@ -1279,15 +1362,16 @@ { "uri":"NetworkSecurityManagement.html", "node_id":"networksecuritymanagement.xml", - "product_code":"", - "code":"69", + "product_code":"dcs", + "code":"70", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Network Security", @@ -1296,9 +1380,9 @@ { "uri":"UpdateSSLSwitch.html", "node_id":"updatesslswitch.xml", - "product_code":"", - "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", + "product_code":"dcs", + "code":"71", + "des":"This API is used to configure SSL. This API is only supported by DCS Redis 6.0/7.0 instances.PUT /v2/{project_id}/instances/{instance_id}/sslStatus code: 200Status code: ", "doc_type":"api", "kw":"Enabling or Disabling SSL,Network Security,API Reference", "search_title":"", @@ -1306,6 +1390,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateSSLSwitch" } ], @@ -1315,9 +1400,9 @@ { "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 ", + "product_code":"dcs", + "code":"72", + "des":"This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0/7.0 instances.GET /v2/{project_id}/instances/{instance_id}/sslNoneSta", "doc_type":"api", "kw":"Querying SSL Encryption of an Instance,Network Security,API Reference", "search_title":"", @@ -1325,6 +1410,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowInstanceSSLDetail" } ], @@ -1334,9 +1420,9 @@ { "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", + "product_code":"dcs", + "code":"73", + "des":"This API is used to download the SSL certificate of an instance. This API is only supported by DCS Redis 6.0/7.0 instances.POST /v2/{project_id}/instances/{instance_id}/s", "doc_type":"api", "kw":"Downloading the SSL Certificate of an Instance,Network Security,API Reference", "search_title":"", @@ -1344,6 +1430,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DownloadSSLCert" } ], @@ -1353,8 +1440,8 @@ { "uri":"UpdateIpWhitelist.html", "node_id":"updateipwhitelist.xml", - "product_code":"", - "code":"73", + "product_code":"dcs", + "code":"74", "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", @@ -1363,6 +1450,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"UpdateIpWhitelist" } ], @@ -1372,8 +1460,8 @@ { "uri":"ShowIpWhitelist.html", "node_id":"showipwhitelist.xml", - "product_code":"", - "code":"74", + "product_code":"dcs", + "code":"75", "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":"api", "kw":"Querying the IP Whitelist of a DCS Instance,Network Security,API Reference", @@ -1382,6 +1470,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowIpWhitelist" } ], @@ -1391,15 +1480,16 @@ { "uri":"BackgroudTasksManagement.html", "node_id":"backgroudtasksmanagement.xml", - "product_code":"", - "code":"75", + "product_code":"dcs", + "code":"76", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Background Task Management", @@ -1408,8 +1498,8 @@ { "uri":"ListBackgroundTask.html", "node_id":"listbackgroundtask.xml", - "product_code":"", - "code":"76", + "product_code":"dcs", + "code":"77", "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", @@ -1418,6 +1508,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListBackgroundTask" } ], @@ -1427,8 +1518,8 @@ { "uri":"DeleteBackgroundTask.html", "node_id":"deletebackgroundtask.xml", - "product_code":"", - "code":"77", + "product_code":"dcs", + "code":"78", "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", @@ -1437,6 +1528,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteBackgroundTask" } ], @@ -1446,8 +1538,8 @@ { "uri":"ShowJobInfo.html", "node_id":"showjobinfo.xml", - "product_code":"", - "code":"78", + "product_code":"dcs", + "code":"79", "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", @@ -1456,6 +1548,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowJobInfo" } ], @@ -1465,8 +1558,8 @@ { "uri":"DeleteCenterTask.html", "node_id":"deletecentertask.xml", - "product_code":"", - "code":"79", + "product_code":"dcs", + "code":"80", "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", @@ -1475,6 +1568,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"DeleteCenterTask" } ], @@ -1484,15 +1578,16 @@ { "uri":"InstanceDiagnosisManagement.html", "node_id":"instancediagnosismanagement.xml", - "product_code":"", - "code":"80", + "product_code":"dcs", + "code":"81", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Instance Diagnosis", @@ -1501,8 +1596,8 @@ { "uri":"ListDiagnosisTasks.html", "node_id":"listdiagnosistasks.xml", - "product_code":"", - "code":"81", + "product_code":"dcs", + "code":"82", "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", @@ -1511,6 +1606,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListDiagnosisTasks" } ], @@ -1520,8 +1616,8 @@ { "uri":"ShowDiagnosisTaskDetails.html", "node_id":"showdiagnosistaskdetails.xml", - "product_code":"", - "code":"82", + "product_code":"dcs", + "code":"83", "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", @@ -1530,6 +1626,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowDiagnosisTaskDetails" } ], @@ -1539,15 +1636,16 @@ { "uri":"ConfigTemplatesManagement.html", "node_id":"configtemplatesmanagement.xml", - "product_code":"", - "code":"83", + "product_code":"dcs", + "code":"84", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Template Management", @@ -1556,8 +1654,8 @@ { "uri":"ListConfigTemplates.html", "node_id":"listconfigtemplates.xml", - "product_code":"", - "code":"84", + "product_code":"dcs", + "code":"85", "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", @@ -1566,6 +1664,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListConfigTemplates" } ], @@ -1575,8 +1674,8 @@ { "uri":"CreateCustomTemplate.html", "node_id":"createcustomtemplate.xml", - "product_code":"", - "code":"85", + "product_code":"dcs", + "code":"86", "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", @@ -1585,6 +1684,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"CreateCustomTemplate" } ], @@ -1594,15 +1694,16 @@ { "uri":"OtherInterface.html", "node_id":"otherinterface.xml", - "product_code":"", - "code":"86", + "product_code":"dcs", + "code":"87", "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" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Other APIs", @@ -1611,8 +1712,8 @@ { "uri":"ListFlavors.html", "node_id":"listflavors.xml", - "product_code":"", - "code":"87", + "product_code":"dcs", + "code":"88", "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", @@ -1621,6 +1722,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListFlavors" } ], @@ -1630,8 +1732,8 @@ { "uri":"ListMaintenanceWindows.html", "node_id":"listmaintenancewindows.xml", - "product_code":"", - "code":"88", + "product_code":"dcs", + "code":"89", "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", @@ -1640,6 +1742,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListMaintenanceWindows" } ], @@ -1649,8 +1752,8 @@ { "uri":"ShowQuotaOfTenant.html", "node_id":"showquotaoftenant.xml", - "product_code":"", - "code":"89", + "product_code":"dcs", + "code":"90", "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", @@ -1659,6 +1762,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ShowQuotaOfTenant" } ], @@ -1668,8 +1772,8 @@ { "uri":"ListMonitoredObjectsOfInstance.html", "node_id":"listmonitoredobjectsofinstance.xml", - "product_code":"", - "code":"90", + "product_code":"dcs", + "code":"91", "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", @@ -1678,6 +1782,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListMonitoredObjectsOfInstance" } ], @@ -1687,8 +1792,8 @@ { "uri":"ListMonitoredObjects.html", "node_id":"listmonitoredobjects.xml", - "product_code":"", - "code":"91", + "product_code":"dcs", + "code":"92", "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", @@ -1697,6 +1802,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListMonitoredObjects" } ], @@ -1706,8 +1812,8 @@ { "uri":"ListAvailableZones.html", "node_id":"listavailablezones.xml", - "product_code":"", - "code":"92", + "product_code":"dcs", + "code":"93", "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", @@ -1716,6 +1822,7 @@ { "opensource":"true", "documenttype":"api", + "prodname":"dcs", "operation_id":"ListAvailableZones" } ], @@ -1726,7 +1833,7 @@ "uri":"dcs-api-0605002.html", "node_id":"dcs-api-0605002.xml", "product_code":"dcs", - "code":"93", + "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":"Outdated APIs (V1)", @@ -1745,7 +1852,7 @@ "uri":"dcs-api-0312003.html", "node_id":"dcs-api-0312003.xml", "product_code":"dcs", - "code":"94", + "code":"95", "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", @@ -1764,7 +1871,7 @@ "uri":"dcs-api-0312004.html", "node_id":"dcs-api-0312004.xml", "product_code":"dcs", - "code":"95", + "code":"96", "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", @@ -1783,7 +1890,7 @@ "uri":"dcs-api-0312008.html", "node_id":"dcs-api-0312008.xml", "product_code":"dcs", - "code":"96", + "code":"97", "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", @@ -1802,7 +1909,7 @@ "uri":"dcs-api-0312009.html", "node_id":"dcs-api-0312009.xml", "product_code":"dcs", - "code":"97", + "code":"98", "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", @@ -1821,7 +1928,7 @@ "uri":"dcs-api-0312005.html", "node_id":"dcs-api-0312005.xml", "product_code":"dcs", - "code":"98", + "code":"99", "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", @@ -1840,7 +1947,7 @@ "uri":"dcs-api-0312006.html", "node_id":"dcs-api-0312006.xml", "product_code":"dcs", - "code":"99", + "code":"100", "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", @@ -1859,7 +1966,7 @@ "uri":"dcs-api-0312007.html", "node_id":"dcs-api-0312007.xml", "product_code":"dcs", - "code":"100", + "code":"101", "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", @@ -1878,7 +1985,7 @@ "uri":"dcs-api-0312010.html", "node_id":"dcs-api-0312010.xml", "product_code":"dcs", - "code":"101", + "code":"102", "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", @@ -1897,7 +2004,7 @@ "uri":"dcs-api-0312035.html", "node_id":"dcs-api-0312035.xml", "product_code":"dcs", - "code":"102", + "code":"103", "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", @@ -1916,7 +2023,7 @@ "uri":"dcs-api-0312018.html", "node_id":"dcs-api-0312018.xml", "product_code":"dcs", - "code":"103", + "code":"104", "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", @@ -1935,7 +2042,7 @@ "uri":"dcs-api-0312014.html", "node_id":"dcs-api-0312014.xml", "product_code":"dcs", - "code":"104", + "code":"105", "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", @@ -1954,7 +2061,7 @@ "uri":"dcs-api-0312016.html", "node_id":"dcs-api-0312016.xml", "product_code":"dcs", - "code":"105", + "code":"106", "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", @@ -1973,7 +2080,7 @@ "uri":"dcs-api-0312019.html", "node_id":"dcs-api-0312019.xml", "product_code":"dcs", - "code":"106", + "code":"107", "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", @@ -1992,7 +2099,7 @@ "uri":"dcs-api-0312013.html", "node_id":"dcs-api-0312013.xml", "product_code":"dcs", - "code":"107", + "code":"108", "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", @@ -2011,7 +2118,7 @@ "uri":"dcs-api-0312017.html", "node_id":"dcs-api-0312017.xml", "product_code":"dcs", - "code":"108", + "code":"109", "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", @@ -2030,7 +2137,7 @@ "uri":"dcs-api-0312015.html", "node_id":"dcs-api-0312015.xml", "product_code":"dcs", - "code":"109", + "code":"110", "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", @@ -2049,7 +2156,7 @@ "uri":"dcs-api-0514005.html", "node_id":"dcs-api-0514005.xml", "product_code":"dcs", - "code":"110", + "code":"111", "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", @@ -2068,7 +2175,7 @@ "uri":"dcs-api-0312020.html", "node_id":"dcs-api-0312020.xml", "product_code":"dcs", - "code":"111", + "code":"112", "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", @@ -2087,7 +2194,7 @@ "uri":"dcs-api-0312021.html", "node_id":"dcs-api-0312021.xml", "product_code":"dcs", - "code":"112", + "code":"113", "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", @@ -2106,7 +2213,7 @@ "uri":"dcs-api-0312022.html", "node_id":"dcs-api-0312022.xml", "product_code":"dcs", - "code":"113", + "code":"114", "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", @@ -2125,7 +2232,7 @@ "uri":"dcs-api-0312023.html", "node_id":"dcs-api-0312023.xml", "product_code":"dcs", - "code":"114", + "code":"115", "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", @@ -2144,7 +2251,7 @@ "uri":"dcs-api-0312024.html", "node_id":"dcs-api-0312024.xml", "product_code":"dcs", - "code":"115", + "code":"116", "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", @@ -2163,7 +2270,7 @@ "uri":"dcs-api-0312038.html", "node_id":"dcs-api-0312038.xml", "product_code":"dcs", - "code":"116", + "code":"117", "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", @@ -2182,7 +2289,7 @@ "uri":"dcs-api-0312040.html", "node_id":"dcs-api-0312040.xml", "product_code":"dcs", - "code":"117", + "code":"118", "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", @@ -2201,7 +2308,7 @@ "uri":"dcs-api-0312036.html", "node_id":"dcs-api-0312036.xml", "product_code":"dcs", - "code":"118", + "code":"119", "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", @@ -2220,7 +2327,7 @@ "uri":"dcs-api-0312041.html", "node_id":"dcs-api-0312041.xml", "product_code":"dcs", - "code":"119", + "code":"120", "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", @@ -2239,7 +2346,7 @@ "uri":"dcs-api-0312039.html", "node_id":"dcs-api-0312039.xml", "product_code":"dcs", - "code":"120", + "code":"121", "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", @@ -2258,7 +2365,7 @@ "uri":"api-grant-policy.html", "node_id":"api-grant-policy.xml", "product_code":"dcs", - "code":"121", + "code":"122", "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", @@ -2277,7 +2384,7 @@ "uri":"dcs-api-0312042.html", "node_id":"dcs-api-0312042.xml", "product_code":"dcs", - "code":"122", + "code":"123", "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", @@ -2296,7 +2403,7 @@ "uri":"dcs-api-0312043.html", "node_id":"dcs-api-0312043.xml", "product_code":"dcs", - "code":"123", + "code":"124", "des":"Table 1 describes the status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", @@ -2314,8 +2421,8 @@ { "uri":"ErrorCode.html", "node_id":"errorcode_1.xml", - "product_code":"", - "code":"124", + "product_code":"dcs", + "code":"125", "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", @@ -2323,7 +2430,8 @@ "metedata":[ { "opensource":"true", - "documenttype":"api" + "documenttype":"api", + "prodname":"dcs" } ], "title":"Error Codes", @@ -2333,7 +2441,7 @@ "uri":"dcs-api-0312045.html", "node_id":"dcs-api-0312045.xml", "product_code":"dcs", - "code":"125", + "code":"126", "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", @@ -2352,7 +2460,7 @@ "uri":"dcs-api-0312047.html", "node_id":"dcs-api-0312047.xml", "product_code":"dcs", - "code":"126", + "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":"DCS Instance Statuses,Appendix,API Reference", @@ -2371,7 +2479,7 @@ "uri":"dcs-api-0312050.html", "node_id":"dcs-api-0312050.xml", "product_code":"dcs", - "code":"127", + "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":"Instance Diagnosis IDs,Appendix,API Reference", @@ -2390,7 +2498,7 @@ "uri":"dcs-api-0312049.html", "node_id":"dcs-api-0312049.xml", "product_code":"dcs", - "code":"128", + "code":"129", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/dcs/api-ref/BatchCreateOrDeleteTags.html b/docs/dcs/api-ref/BatchCreateOrDeleteTags.html index dfa46f157..00d2c52db 100644 --- a/docs/dcs/api-ref/BatchCreateOrDeleteTags.html +++ b/docs/dcs/api-ref/BatchCreateOrDeleteTags.html @@ -1,7 +1,7 @@

Batch Adding or Deleting Tags

-

Function

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

+

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

diff --git a/docs/dcs/api-ref/BatchDeleteInstances.html b/docs/dcs/api-ref/BatchDeleteInstances.html index cb41e6f8d..766fb6bad 100644 --- a/docs/dcs/api-ref/BatchDeleteInstances.html +++ b/docs/dcs/api-ref/BatchDeleteInstances.html @@ -1,7 +1,7 @@

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 /v2/{project_id}/instances

@@ -81,45 +81,45 @@

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

+
- - - - -
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

results

+

results

Array of BatchOpsResult objects

+

Array of BatchOpsResult objects

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

+

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

-
Table 5 BatchOpsResult

Parameter

+
- - - - - - - - @@ -127,36 +127,33 @@

Status code: 500

-
Table 5 BatchOpsResult

Parameter

Type

+

Type

Description

+

Description

result

+

result

String

+

String

Instance deletion result. Options: success and failed.

+

Instance deletion result. Options: success and failed.

instance

+

instance

String

+

String

DCS instance ID.

+

DCS instance ID.

Table 6 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -164,36 +161,33 @@

Status code: 400

-
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 7 Response body parameters

Parameter

+
- - - - - - - - - - - diff --git a/docs/dcs/api-ref/BatchShowNodesInformation.html b/docs/dcs/api-ref/BatchShowNodesInformation.html index 655aa85c4..264db9c08 100644 --- a/docs/dcs/api-ref/BatchShowNodesInformation.html +++ b/docs/dcs/api-ref/BatchShowNodesInformation.html @@ -1,7 +1,9 @@

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.

+

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.

@@ -66,212 +68,196 @@

Response Parameters

Status code: 200

-
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 3 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

count

+

count

Integer

+

Integer

Total number of instances in the query result.

+

Total number of instances in the query result.

instances

+

instances

Array of InstanceNodesInfoResp objects

+

Array of InstanceNodesInfoResp objects

Instance list.

+

Instance list.

-
Table 4 InstanceNodesInfoResp

Parameter

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

Parameter

Type

+

Type

Description

+

Description

instance_id

+

instance_id

String

+

String

Instance ID.

+

Instance ID.

node_count

+

node_count

Integer

+

Integer

Total number of nodes of the current instance.

+

Total number of nodes of the current instance.

nodes

+

nodes

Array of NodesInfoResp objects

+

Array of NodesInfoResp objects

Node details.

+

Node details.

-
Table 5 NodesInfoResp

Parameter

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

Parameter

Type

+

Type

Description

+

Description

logical_node_id

+

logical_node_id

String

+

String

Logical node ID.

+

Logical node ID.

name

+

name

String

+

String

Node name.

+

Node name.

status

+

status

String

+

String

Node status. The value can be:

+

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

+

az_code

String

+

String

AZ code.

+

AZ code.

node_role

+

node_role

String

+

String

Node type. Options:

+

Node type. Options:

  • redis-server: Redis server node

  • redis-proxy: proxy node

-

Enumeration values:

-
  • redis-server

    -
  • redis-proxy

    -

node_type

+

node_type

String

+

String

Node role. Options:

+

Node role. Options:

  • master: master node

  • slave: standby node

  • proxy: node of a Proxy Cluster instance

-

Enumeration values:

-
  • master

    -
  • slave

    -
  • proxy

    -

node_ip

+

node_ip

String

+

String

Node IP address.

+

Node IP address.

node_port

+

node_port

String

+

String

Node port.

+

Node port.

node_id

+

node_id

String

+

String

Node ID.

+

Node ID.

priority_weight

+

priority_weight

Integer

+

Integer

Replica promotion priority.

+

Replica promotion priority.

is_access

+

is_access

Boolean

+

Boolean

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

+

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

group_id

+

group_id

String

+

String

Shard ID.

+

Shard ID.

group_name

+

group_name

String

+

String

Shard name.

+

Shard name.

is_remove_ip

+

is_remove_ip

Boolean

+

Boolean

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

+

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

replication_id

+

replication_id

String

+

String

Replica ID.

+

Replica ID.

dimensions

+

dimensions

Array of InstanceReplicationDimensionsInfo objects

+

Array of InstanceReplicationDimensionsInfo objects

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

+

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.

    @@ -282,26 +268,26 @@
-
Table 6 InstanceReplicationDimensionsInfo

Parameter

+
- - - - - - - - @@ -309,36 +295,33 @@

Status code: 500

-
Table 6 InstanceReplicationDimensionsInfo

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Monitoring dimension name.

+

Monitoring dimension name.

value

+

value

String

+

String

Dimension value.

+

Dimension value.

Table 7 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -346,36 +329,33 @@

Status code: 400

-
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 8 Response body parameters

Parameter

+
- - - - - - - - - - - diff --git a/docs/dcs/api-ref/BatchStopMigrationTasks.html b/docs/dcs/api-ref/BatchStopMigrationTasks.html index c463f916f..d2ced1527 100644 --- a/docs/dcs/api-ref/BatchStopMigrationTasks.html +++ b/docs/dcs/api-ref/BatchStopMigrationTasks.html @@ -1,7 +1,7 @@

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.

+

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

@@ -54,49 +54,45 @@

Response Parameters

Status code: 200

-
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 3 Response body parameters

Parameter

+
- - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

migration_tasks

+

migration_tasks

Array of StopMigrationTaskResult objects

+

Array of StopMigrationTaskResult objects

Data migration task list.

+

Data migration task list.

-
Table 4 StopMigrationTaskResult

Parameter

+
- - - - - - - - @@ -104,36 +100,33 @@

Status code: 400

-
Table 4 StopMigrationTaskResult

Parameter

Type

+

Type

Description

+

Description

result

+

result

String

+

String

Result of delivering the request for stopping migration tasks.

-

Enumeration values:

-
  • success

    -
  • failed

    -
+

Result of delivering the request for stopping migration tasks.

task_id

+

task_id

String

+

String

ID of the data migration task.

+

ID of the data migration task.

Table 5 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -141,36 +134,33 @@

Status code: 401

-
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 6 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -178,36 +168,33 @@

Status code: 403

-
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 7 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -215,36 +202,33 @@

Status code: 404

-
Table 7 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 8 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -252,36 +236,33 @@

Status code: 500

-
Table 8 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 9 Response body parameters

Parameter

+
- - - - - - - - - - - diff --git a/docs/dcs/api-ref/CLASS.TXT.json b/docs/dcs/api-ref/CLASS.TXT.json index 157b498b0..f3e99855c 100644 --- a/docs/dcs/api-ref/CLASS.TXT.json +++ b/docs/dcs/api-ref/CLASS.TXT.json @@ -144,13 +144,22 @@ "code":"16" }, { - "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", + "desc":"This API is used to reset the password of a DCS instance.POST /v2/{project_id}/instances/{instance_id}/password/resetStatus code: 200Status code: 400Status code: 500Reset", + "product_code":"dcs", + "title":"Resetting a Password", + "uri":"ResetPassword.html", + "doc_type":"api", + "p_code":"14", + "code":"17" + }, + { + "desc":"This API is used to restart a running DCS instance.This API can also be used to clear data of DCS Redis 4.0 and later instances. Cleared data cannot be restored. Exercise", "product_code":"dcs", "title":"Restarting DCS Instances or Clearing DCS Instance Data", "uri":"RestartOrFlushInstances.html", "doc_type":"api", "p_code":"14", - "code":"17" + "code":"18" }, { "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", @@ -159,7 +168,7 @@ "uri":"ListStatisticsOfRunningInstances.html", "doc_type":"api", "p_code":"14", - "code":"18" + "code":"19" }, { "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.", @@ -168,7 +177,7 @@ "uri":"GroupReplicationManagement.html", "doc_type":"api", "p_code":"5", - "code":"19" + "code":"20" }, { "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", @@ -176,8 +185,8 @@ "title":"Configuring Replica Priority", "uri":"UpdateSlavePriority.html", "doc_type":"api", - "p_code":"19", - "code":"20" + "p_code":"20", + "code":"21" }, { "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", @@ -185,26 +194,26 @@ "title":"Removing the IP Address", "uri":"DeleteIpFromDomainName.html", "doc_type":"api", - "p_code":"19", - "code":"21" + "p_code":"20", + "code":"22" }, { - "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", + "desc":"This API is used to query information about shards and replicas of Redis 4.0 and later instances (single-node ones not included).GET /v2/{project_id}/instance/{instance_i", "product_code":"dcs", "title":"Querying Details of Shards", "uri":"ListGroupReplicationInfo.html", "doc_type":"api", - "p_code":"19", - "code":"22" + "p_code":"20", + "code":"23" }, { - "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", + "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 returne", "product_code":"dcs", "title":"Querying Instance Nodes in Batches", "uri":"BatchShowNodesInformation.html", "doc_type":"api", - "p_code":"19", - "code":"23" + "p_code":"20", + "code":"24" }, { "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.", @@ -213,7 +222,7 @@ "uri":"ParamManagement.html", "doc_type":"api", "p_code":"5", - "code":"24" + "code":"25" }, { "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", @@ -221,8 +230,8 @@ "title":"Querying DCS Instance Configuration Parameters", "uri":"ListConfigurations.html", "doc_type":"api", - "p_code":"24", - "code":"25" + "p_code":"25", + "code":"26" }, { "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", @@ -230,8 +239,8 @@ "title":"Modifying Configuration Parameters", "uri":"UpdateConfigurations.html", "doc_type":"api", - "p_code":"24", - "code":"26" + "p_code":"25", + "code":"27" }, { "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", @@ -239,8 +248,8 @@ "title":"Querying the List of Instance Parameter Modification Records", "uri":"ListConfigHistories.html", "doc_type":"api", - "p_code":"24", - "code":"27" + "p_code":"25", + "code":"28" }, { "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.", @@ -249,7 +258,7 @@ "uri":"BackupRestoreManagement.html", "doc_type":"api", "p_code":"5", - "code":"28" + "code":"29" }, { "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", @@ -257,8 +266,8 @@ "title":"Deleting Backup Files", "uri":"DeleteBackupFile.html", "doc_type":"api", - "p_code":"28", - "code":"29" + "p_code":"29", + "code":"30" }, { "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", @@ -266,8 +275,8 @@ "title":"Restoring a DCS Instance", "uri":"RestoreInstance.html", "doc_type":"api", - "p_code":"28", - "code":"30" + "p_code":"29", + "code":"31" }, { "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", @@ -275,8 +284,8 @@ "title":"Querying DCS Instance Restoration Records", "uri":"ListRestoreRecords.html", "doc_type":"api", - "p_code":"28", - "code":"31" + "p_code":"29", + "code":"32" }, { "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", @@ -284,8 +293,8 @@ "title":"Obtaining the Backup File URL", "uri":"ListBackupFileLinks.html", "doc_type":"api", - "p_code":"28", - "code":"32" + "p_code":"29", + "code":"33" }, { "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 /", @@ -293,8 +302,8 @@ "title":"Backing Up a DCS Instance", "uri":"CopyInstance.html", "doc_type":"api", - "p_code":"28", - "code":"33" + "p_code":"29", + "code":"34" }, { "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", @@ -302,8 +311,8 @@ "title":"Listing DCS Instance Backup Records", "uri":"ListBackupRecords.html", "doc_type":"api", - "p_code":"28", - "code":"34" + "p_code":"29", + "code":"35" }, { "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.", @@ -312,7 +321,7 @@ "uri":"DataMigrationManagement.html", "doc_type":"api", "p_code":"5", - "code":"35" + "code":"36" }, { "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", @@ -320,8 +329,8 @@ "title":"Creating a Backup Import Task", "uri":"CreateMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"36" + "p_code":"36", + "code":"37" }, { "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", @@ -329,8 +338,8 @@ "title":"Listing Migration Tasks", "uri":"ListMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"37" + "p_code":"36", + "code":"38" }, { "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:", @@ -338,8 +347,8 @@ "title":"Deleting Data Migration Tasks", "uri":"DeleteMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"38" + "p_code":"36", + "code":"39" }, { "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", @@ -347,8 +356,8 @@ "title":"Querying Details of a Data Migration Task", "uri":"ShowMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"39" + "p_code":"36", + "code":"40" }, { "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:", @@ -356,8 +365,8 @@ "title":"Configuring Auto-Reconnect for Migration Tasks", "uri":"UpdateMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"40" + "p_code":"36", + "code":"41" }, { "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", @@ -365,8 +374,8 @@ "title":"Stopping a Data Migration Task", "uri":"StopMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"41" + "p_code":"36", + "code":"42" }, { "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", @@ -374,8 +383,8 @@ "title":"Querying the Progress of an Online Migration Task", "uri":"ShowMigrationTaskStats.html", "doc_type":"api", - "p_code":"35", - "code":"42" + "p_code":"36", + "code":"43" }, { "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", @@ -383,8 +392,8 @@ "title":"Creating an Online Data Migration Task", "uri":"CreateOnlineMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"43" + "p_code":"36", + "code":"44" }, { "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", @@ -392,8 +401,8 @@ "title":"Configuring an Online Data Migration Task", "uri":"SetOnlineMigrationTask.html", "doc_type":"api", - "p_code":"35", - "code":"44" + "p_code":"36", + "code":"45" }, { "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", @@ -401,8 +410,8 @@ "title":"Stopping Data Migration Tasks", "uri":"BatchStopMigrationTasks.html", "doc_type":"api", - "p_code":"35", - "code":"45" + "p_code":"36", + "code":"46" }, { "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.", @@ -411,7 +420,7 @@ "uri":"TagManagement.html", "doc_type":"api", "p_code":"5", - "code":"46" + "code":"47" }, { "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: ", @@ -419,8 +428,8 @@ "title":"Listing All Tags of a Tenant", "uri":"ListTagsOfTenant.html", "doc_type":"api", - "p_code":"46", - "code":"47" + "p_code":"47", + "code":"48" }, { "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", @@ -428,8 +437,8 @@ "title":"Batch Adding or Deleting Tags", "uri":"BatchCreateOrDeleteTags.html", "doc_type":"api", - "p_code":"46", - "code":"48" + "p_code":"47", + "code":"49" }, { "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", @@ -437,8 +446,8 @@ "title":"Querying Tags of a DCS Instance", "uri":"ShowTags.html", "doc_type":"api", - "p_code":"46", - "code":"49" + "p_code":"47", + "code":"50" }, { "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.", @@ -447,7 +456,7 @@ "uri":"CacheAnalysisManagement.html", "doc_type":"api", "p_code":"5", - "code":"50" + "code":"51" }, { "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", @@ -455,8 +464,8 @@ "title":"Creating a Big Key Analysis Task", "uri":"CreateBigkeyScanTask.html", "doc_type":"api", - "p_code":"50", - "code":"51" + "p_code":"51", + "code":"52" }, { "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", @@ -464,8 +473,8 @@ "title":"Listing Big Key Analysis Tasks", "uri":"ListBigkeyScanTasks.html", "doc_type":"api", - "p_code":"50", - "code":"52" + "p_code":"51", + "code":"53" }, { "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", @@ -473,8 +482,8 @@ "title":"Querying Big Key Analysis Details", "uri":"ShowBigkeyScanTaskDetails.html", "doc_type":"api", - "p_code":"50", - "code":"53" + "p_code":"51", + "code":"54" }, { "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:", @@ -482,8 +491,8 @@ "title":"Deleting a Big Key Analysis Task", "uri":"DeleteBigkeyScanTask.html", "doc_type":"api", - "p_code":"50", - "code":"54" + "p_code":"51", + "code":"55" }, { "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", @@ -491,8 +500,8 @@ "title":"Configuring Automatic Big Key Analysis", "uri":"UpdateBigkeyAutoscanConfig.html", "doc_type":"api", - "p_code":"50", - "code":"55" + "p_code":"51", + "code":"56" }, { "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", @@ -500,17 +509,17 @@ "title":"Querying the Configurations of Automatic Big Key Analysis", "uri":"ShowBigkeyAutoscanConfig.html", "doc_type":"api", - "p_code":"50", - "code":"56" + "p_code":"51", + "code":"57" }, { - "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", + "desc":"This API is used to create a hot key analysis task.To perform hot key analysis, the instance's maxmemory-policy parameter must be set to allkeys-lfu or volatile-lfu.POST ", "product_code":"dcs", "title":"Creating a Hot Key Analysis Task", "uri":"CreateHotkeyScanTask.html", "doc_type":"api", - "p_code":"50", - "code":"57" + "p_code":"51", + "code":"58" }, { "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", @@ -518,8 +527,8 @@ "title":"Listing Hot Key Analysis Tasks", "uri":"ListHotKeyScanTasks.html", "doc_type":"api", - "p_code":"50", - "code":"58" + "p_code":"51", + "code":"59" }, { "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", @@ -527,8 +536,8 @@ "title":"Querying Hot Key Analysis Details", "uri":"ShowHotkeyTaskDetails.html", "doc_type":"api", - "p_code":"50", - "code":"59" + "p_code":"51", + "code":"60" }, { "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:", @@ -536,8 +545,8 @@ "title":"Deleting a Hot Key Analysis Task", "uri":"DeleteHotkeyScanTask.html", "doc_type":"api", - "p_code":"50", - "code":"60" + "p_code":"51", + "code":"61" }, { "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", @@ -545,8 +554,8 @@ "title":"Configuring Automatic Hot Key Analysis", "uri":"UpdateHotkeyAutoScanConfig.html", "doc_type":"api", - "p_code":"50", - "code":"61" + "p_code":"51", + "code":"62" }, { "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", @@ -554,17 +563,17 @@ "title":"Querying the Configurations of Automatic Hot Key Analysis", "uri":"ShowHotkeyAutoscanConfig.html", "doc_type":"api", - "p_code":"50", - "code":"62" + "p_code":"51", + "code":"63" }, { - "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 ", + "desc":"This API is used to create an expired key scan task.The keyspace will be scanned to release the memory used by expired keys that were not released due to the lazy free me", "product_code":"dcs", "title":"Creating an Expired Key Scan Task", "uri":"CreateAutoExpireScanTask.html", "doc_type":"api", - "p_code":"50", - "code":"63" + "p_code":"51", + "code":"64" }, { "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.", @@ -573,7 +582,7 @@ "uri":"LogManagement.html", "doc_type":"api", "p_code":"5", - "code":"64" + "code":"65" }, { "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", @@ -581,8 +590,8 @@ "title":"Querying the Slow Log", "uri":"ListSlowlog.html", "doc_type":"api", - "p_code":"64", - "code":"65" + "p_code":"65", + "code":"66" }, { "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", @@ -590,8 +599,8 @@ "title":"Listing Redis Run Logs", "uri":"ListRedislog.html", "doc_type":"api", - "p_code":"64", - "code":"66" + "p_code":"65", + "code":"67" }, { "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", @@ -599,8 +608,8 @@ "title":"Collecting Redis Run Logs", "uri":"CreateRedislog.html", "doc_type":"api", - "p_code":"64", - "code":"67" + "p_code":"65", + "code":"68" }, { "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:", @@ -608,8 +617,8 @@ "title":"Obtaining the Log Download Link", "uri":"CreateRedislogDownloadLink.html", "doc_type":"api", - "p_code":"64", - "code":"68" + "p_code":"65", + "code":"69" }, { "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.", @@ -618,34 +627,34 @@ "uri":"NetworkSecurityManagement.html", "doc_type":"api", "p_code":"5", - "code":"69" + "code":"70" }, { - "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", + "desc":"This API is used to configure SSL. This API is only supported by DCS Redis 6.0/7.0 instances.PUT /v2/{project_id}/instances/{instance_id}/sslStatus code: 200Status code: ", "product_code":"dcs", "title":"Enabling or Disabling SSL", "uri":"UpdateSSLSwitch.html", "doc_type":"api", - "p_code":"69", - "code":"70" + "p_code":"70", + "code":"71" }, { - "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 ", + "desc":"This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0/7.0 instances.GET /v2/{project_id}/instances/{instance_id}/sslNoneSta", "product_code":"dcs", "title":"Querying SSL Encryption of an Instance", "uri":"ShowInstanceSSLDetail.html", "doc_type":"api", - "p_code":"69", - "code":"71" + "p_code":"70", + "code":"72" }, { - "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", + "desc":"This API is used to download the SSL certificate of an instance. This API is only supported by DCS Redis 6.0/7.0 instances.POST /v2/{project_id}/instances/{instance_id}/s", "product_code":"dcs", "title":"Downloading the SSL Certificate of an Instance", "uri":"DownloadSSLCert.html", "doc_type":"api", - "p_code":"69", - "code":"72" + "p_code":"70", + "code":"73" }, { "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", @@ -653,8 +662,8 @@ "title":"Configuring IP Whitelist Groups", "uri":"UpdateIpWhitelist.html", "doc_type":"api", - "p_code":"69", - "code":"73" + "p_code":"70", + "code":"74" }, { "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", @@ -662,8 +671,8 @@ "title":"Querying the IP Whitelist of a DCS Instance", "uri":"ShowIpWhitelist.html", "doc_type":"api", - "p_code":"69", - "code":"74" + "p_code":"70", + "code":"75" }, { "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.", @@ -672,7 +681,7 @@ "uri":"BackgroudTasksManagement.html", "doc_type":"api", "p_code":"5", - "code":"75" + "code":"76" }, { "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", @@ -680,8 +689,8 @@ "title":"Listing Background Tasks", "uri":"ListBackgroundTask.html", "doc_type":"api", - "p_code":"75", - "code":"76" + "p_code":"76", + "code":"77" }, { "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:", @@ -689,8 +698,8 @@ "title":"Deleting a Background Task", "uri":"DeleteBackgroundTask.html", "doc_type":"api", - "p_code":"75", - "code":"77" + "p_code":"76", + "code":"78" }, { "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", @@ -698,8 +707,8 @@ "title":"Querying the Job Execution Result of a Tenant", "uri":"ShowJobInfo.html", "doc_type":"api", - "p_code":"75", - "code":"78" + "p_code":"76", + "code":"79" }, { "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", @@ -707,8 +716,8 @@ "title":"Deleting a Task in the Task Center", "uri":"DeleteCenterTask.html", "doc_type":"api", - "p_code":"75", - "code":"79" + "p_code":"76", + "code":"80" }, { "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.", @@ -717,7 +726,7 @@ "uri":"InstanceDiagnosisManagement.html", "doc_type":"api", "p_code":"5", - "code":"80" + "code":"81" }, { "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", @@ -725,8 +734,8 @@ "title":"Listing Instance Diagnosis Tasks", "uri":"ListDiagnosisTasks.html", "doc_type":"api", - "p_code":"80", - "code":"81" + "p_code":"81", + "code":"82" }, { "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", @@ -734,8 +743,8 @@ "title":"Querying a Specified Diagnosis Report", "uri":"ShowDiagnosisTaskDetails.html", "doc_type":"api", - "p_code":"80", - "code":"82" + "p_code":"81", + "code":"83" }, { "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.", @@ -744,7 +753,7 @@ "uri":"ConfigTemplatesManagement.html", "doc_type":"api", "p_code":"5", - "code":"83" + "code":"84" }, { "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: ", @@ -752,8 +761,8 @@ "title":"Viewing Parameter Templates", "uri":"ListConfigTemplates.html", "doc_type":"api", - "p_code":"83", - "code":"84" + "p_code":"84", + "code":"85" }, { "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 ", @@ -761,8 +770,8 @@ "title":"Creating a Custom Template", "uri":"CreateCustomTemplate.html", "doc_type":"api", - "p_code":"83", - "code":"85" + "p_code":"84", + "code":"86" }, { "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.", @@ -771,7 +780,7 @@ "uri":"OtherInterface.html", "doc_type":"api", "p_code":"5", - "code":"86" + "code":"87" }, { "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", @@ -779,8 +788,8 @@ "title":"Querying Product Flavors", "uri":"ListFlavors.html", "doc_type":"api", - "p_code":"86", - "code":"87" + "p_code":"87", + "code":"88" }, { "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", @@ -788,8 +797,8 @@ "title":"Listing Maintenance Time Windows", "uri":"ListMaintenanceWindows.html", "doc_type":"api", - "p_code":"86", - "code":"88" + "p_code":"87", + "code":"89" }, { "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 ", @@ -797,8 +806,8 @@ "title":"Querying the Tenant Quotas", "uri":"ShowQuotaOfTenant.html", "doc_type":"api", - "p_code":"86", - "code":"89" + "p_code":"87", + "code":"90" }, { "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", @@ -806,8 +815,8 @@ "title":"Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension", "uri":"ListMonitoredObjectsOfInstance.html", "doc_type":"api", - "p_code":"86", - "code":"90" + "p_code":"87", + "code":"91" }, { "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", @@ -815,8 +824,8 @@ "title":"Listing Monitored Objects on Primary Dimensions", "uri":"ListMonitoredObjects.html", "doc_type":"api", - "p_code":"86", - "code":"91" + "p_code":"87", + "code":"92" }, { "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.", @@ -824,8 +833,8 @@ "title":"Querying AZs", "uri":"ListAvailableZones.html", "doc_type":"api", - "p_code":"86", - "code":"92" + "p_code":"87", + "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.", @@ -834,7 +843,7 @@ "uri":"dcs-api-0605002.html", "doc_type":"api", "p_code":"", - "code":"93" + "code":"94" }, { "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.", @@ -842,8 +851,8 @@ "title":"Lifecycle Management APIs", "uri":"dcs-api-0312003.html", "doc_type":"api", - "p_code":"93", - "code":"94" + "p_code":"94", + "code":"95" }, { "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/", @@ -851,8 +860,8 @@ "title":"Creating a DCS Instance", "uri":"dcs-api-0312004.html", "doc_type":"api", - "p_code":"94", - "code":"95" + "p_code":"95", + "code":"96" }, { "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", @@ -860,8 +869,8 @@ "title":"Deleting a Single DCS Instance", "uri":"dcs-api-0312008.html", "doc_type":"api", - "p_code":"94", - "code":"96" + "p_code":"95", + "code":"97" }, { "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", @@ -869,8 +878,8 @@ "title":"Batch Deleting DCS Instances", "uri":"dcs-api-0312009.html", "doc_type":"api", - "p_code":"94", - "code":"97" + "p_code":"95", + "code":"98" }, { "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", @@ -878,8 +887,8 @@ "title":"Querying a DCS Instance", "uri":"dcs-api-0312005.html", "doc_type":"api", - "p_code":"94", - "code":"98" + "p_code":"95", + "code":"99" }, { "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", @@ -887,8 +896,8 @@ "title":"Querying All DCS Instances of a Tenant", "uri":"dcs-api-0312006.html", "doc_type":"api", - "p_code":"94", - "code":"99" + "p_code":"95", + "code":"100" }, { "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", @@ -896,8 +905,8 @@ "title":"Modifying Information About a DCS Instance", "uri":"dcs-api-0312007.html", "doc_type":"api", - "p_code":"94", - "code":"100" + "p_code":"95", + "code":"101" }, { "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", @@ -905,8 +914,8 @@ "title":"Scaling Up a DCS Instance", "uri":"dcs-api-0312010.html", "doc_type":"api", - "p_code":"94", - "code":"101" + "p_code":"95", + "code":"102" }, { "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.", @@ -914,8 +923,8 @@ "title":"Instance Management APIs", "uri":"dcs-api-0312035.html", "doc_type":"api", - "p_code":"93", - "code":"102" + "p_code":"94", + "code":"103" }, { "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", @@ -923,8 +932,8 @@ "title":"Restarting DCS Instances or Clearing DCS Instance Data", "uri":"dcs-api-0312018.html", "doc_type":"api", - "p_code":"102", - "code":"103" + "p_code":"103", + "code":"104" }, { "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", @@ -932,8 +941,8 @@ "title":"Querying Statistics of All Running Instances", "uri":"dcs-api-0312014.html", "doc_type":"api", - "p_code":"102", - "code":"104" + "p_code":"103", + "code":"105" }, { "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", @@ -941,8 +950,8 @@ "title":"Querying DCS Instance Status", "uri":"dcs-api-0312016.html", "doc_type":"api", - "p_code":"102", - "code":"105" + "p_code":"103", + "code":"106" }, { "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", @@ -950,8 +959,8 @@ "title":"Changing the Password of a DCS Instance", "uri":"dcs-api-0312019.html", "doc_type":"api", - "p_code":"102", - "code":"106" + "p_code":"103", + "code":"107" }, { "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.", @@ -959,8 +968,8 @@ "title":"Parameter Management APIs", "uri":"dcs-api-0312013.html", "doc_type":"api", - "p_code":"93", - "code":"107" + "p_code":"94", + "code":"108" }, { "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", @@ -968,8 +977,8 @@ "title":"Modifying Configuration Parameters", "uri":"dcs-api-0312017.html", "doc_type":"api", - "p_code":"107", - "code":"108" + "p_code":"108", + "code":"109" }, { "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 ", @@ -977,8 +986,8 @@ "title":"Querying Configuration Parameters", "uri":"dcs-api-0312015.html", "doc_type":"api", - "p_code":"107", - "code":"109" + "p_code":"108", + "code":"110" }, { "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.", @@ -986,8 +995,8 @@ "title":"Backup and Restoration APIs", "uri":"dcs-api-0514005.html", "doc_type":"api", - "p_code":"93", - "code":"110" + "p_code":"94", + "code":"111" }, { "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 ", @@ -995,8 +1004,8 @@ "title":"Backing Up a DCS Instance", "uri":"dcs-api-0312020.html", "doc_type":"api", - "p_code":"110", - "code":"111" + "p_code":"111", + "code":"112" }, { "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 ", @@ -1004,8 +1013,8 @@ "title":"Restoring a DCS Instance", "uri":"dcs-api-0312021.html", "doc_type":"api", - "p_code":"110", - "code":"112" + "p_code":"111", + "code":"113" }, { "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", @@ -1013,8 +1022,8 @@ "title":"Querying DCS Instance Backup Records", "uri":"dcs-api-0312022.html", "doc_type":"api", - "p_code":"110", - "code":"113" + "p_code":"111", + "code":"114" }, { "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", @@ -1022,8 +1031,8 @@ "title":"Querying DCS Instance Restoration Records", "uri":"dcs-api-0312023.html", "doc_type":"api", - "p_code":"110", - "code":"114" + "p_code":"111", + "code":"115" }, { "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", @@ -1031,8 +1040,8 @@ "title":"Deleting Backup Files", "uri":"dcs-api-0312024.html", "doc_type":"api", - "p_code":"110", - "code":"115" + "p_code":"111", + "code":"116" }, { "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.", @@ -1040,8 +1049,8 @@ "title":"Other APIs", "uri":"dcs-api-0312038.html", "doc_type":"api", - "p_code":"93", - "code":"116" + "p_code":"94", + "code":"117" }, { "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", @@ -1049,8 +1058,8 @@ "title":"Querying Service Specifications", "uri":"dcs-api-0312040.html", "doc_type":"api", - "p_code":"116", - "code":"117" + "p_code":"117", + "code":"118" }, { "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 ", @@ -1058,8 +1067,8 @@ "title":"Querying the Quota of a Tenant", "uri":"dcs-api-0312036.html", "doc_type":"api", - "p_code":"116", - "code":"118" + "p_code":"117", + "code":"119" }, { "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 ", @@ -1067,8 +1076,8 @@ "title":"Querying Maintenance Time Window", "uri":"dcs-api-0312041.html", "doc_type":"api", - "p_code":"116", - "code":"119" + "p_code":"117", + "code":"120" }, { "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", @@ -1076,8 +1085,8 @@ "title":"Querying AZ Information", "uri":"dcs-api-0312039.html", "doc_type":"api", - "p_code":"116", - "code":"120" + "p_code":"117", + "code":"121" }, { "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 ", @@ -1086,7 +1095,7 @@ "uri":"api-grant-policy.html", "doc_type":"api", "p_code":"", - "code":"121" + "code":"122" }, { "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.", @@ -1095,7 +1104,7 @@ "uri":"dcs-api-0312042.html", "doc_type":"api", "p_code":"", - "code":"122" + "code":"123" }, { "desc":"Table 1 describes the status codes.", @@ -1103,8 +1112,8 @@ "title":"Status Codes", "uri":"dcs-api-0312043.html", "doc_type":"api", - "p_code":"122", - "code":"123" + "p_code":"123", + "code":"124" }, { "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.", @@ -1112,8 +1121,8 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"122", - "code":"124" + "p_code":"123", + "code":"125" }, { "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", @@ -1121,8 +1130,8 @@ "title":"Obtaining a Project ID", "uri":"dcs-api-0312045.html", "doc_type":"api", - "p_code":"122", - "code":"125" + "p_code":"123", + "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.", @@ -1130,8 +1139,8 @@ "title":"DCS Instance Statuses", "uri":"dcs-api-0312047.html", "doc_type":"api", - "p_code":"122", - "code":"126" + "p_code":"123", + "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.", @@ -1139,8 +1148,8 @@ "title":"Instance Diagnosis IDs", "uri":"dcs-api-0312050.html", "doc_type":"api", - "p_code":"122", - "code":"127" + "p_code":"123", + "code":"128" }, { "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.", @@ -1149,6 +1158,6 @@ "uri":"dcs-api-0312049.html", "doc_type":"api", "p_code":"", - "code":"128" + "code":"129" } ] \ No newline at end of file diff --git a/docs/dcs/api-ref/ChangeMasterStandby.html b/docs/dcs/api-ref/ChangeMasterStandby.html index 7d546f00b..4fc22c4b9 100644 --- a/docs/dcs/api-ref/ChangeMasterStandby.html +++ b/docs/dcs/api-ref/ChangeMasterStandby.html @@ -1,7 +1,7 @@

Master/Standby Switchover

-

Function

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

+

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

@@ -41,36 +41,33 @@

Response Parameters

Status code: 400

-
Table 9 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 2 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -78,36 +75,33 @@

Status code: 401

-
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -115,36 +109,33 @@

Status code: 403

-
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 4 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -152,36 +143,33 @@

Status code: 404

-
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 5 Response body parameters

Parameter

+
- - - - - - - - - - - @@ -189,36 +177,33 @@

Status code: 500

-
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 6 Response body parameters

Parameter

+
- - - - - - - - - - - diff --git a/docs/dcs/api-ref/CopyInstance.html b/docs/dcs/api-ref/CopyInstance.html index a8ef9f08b..12c15a28d 100644 --- a/docs/dcs/api-ref/CopyInstance.html +++ b/docs/dcs/api-ref/CopyInstance.html @@ -1,217 +1,209 @@

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.

+

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

+

URI

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

-
Table 6 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

instance_id

+

instance_id

Yes

+

Yes

String

+

String

Instance ID.

+

Instance ID.

project_id

+

project_id

Yes

+

Yes

String

+

String

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

+

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

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

remark

+

remark

No

+

No

String

+

String

Description of DCS instance backup.

+

Description of DCS instance backup.

backup_format

+

backup_format

No

+

No

String

+

String

Format of the DCS instance backup.

-

Enumeration values:

-
  • aof

    -
  • rdb

    -
+

Format of the DCS instance backup.

+

Enumeration values:

+
  • aof
  • rdb
-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

backup_id

+

backup_id

String

+

String

Backup ID.

+

Backup ID.

-

Status code: 400

+

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Status code: 500

+

Status code: 500

-
Table 5 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Example Requests

Backing up a specified DCS instance to an AOF file

-
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups
+

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.

-
{
+

Example Responses

Status code: 200

+

The specified DCS instance is backed up successfully.

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

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - -

Status Code

Description

+

Description

200

+

200

The specified DCS instance is backed up successfully.

+

The specified DCS instance is backed up successfully.

400

+

400

Invalid request.

+

Invalid request.

500

+

500

Internal service error.

+

Internal service error.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/dcs/api-ref/CreateAutoExpireScanTask.html b/docs/dcs/api-ref/CreateAutoExpireScanTask.html index 5d7cce87f..f8717f44f 100644 --- a/docs/dcs/api-ref/CreateAutoExpireScanTask.html +++ b/docs/dcs/api-ref/CreateAutoExpireScanTask.html @@ -1,370 +1,341 @@

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.

+

Function

This API is used to create an expired key scan task.

+

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

+

URI

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

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

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

-

Minimum: 0

-

Maximum: 36

+

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

instance_id

+

instance_id

Yes

+

Yes

String

+

String

Instance ID.

-

Minimum: 0

-

Maximum: 36

+

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

id

+

id

String

+

String

Expired key scan ID.

-

Minimum: 0

-

Maximum: 36

+

Expired key scan ID.

instance_id

+

instance_id

String

+

String

Instance ID.

-

Minimum: 0

-

Maximum: 36

+

Instance ID.

status

+

status

String

+

String

Scan task status.

-

Enumeration values:

-
  • waiting

    -
  • running

    -
  • success

    -
  • failed

    -
+

Scan task status. Value range:

+
  • waiting
  • running
  • success
  • failed

scan_type

+

scan_type

String

+

String

Scan mode.

-

Enumeration values:

-
  • manual

    -
  • auto

    -
+

Scan mode. Value range:

+
  • manual
  • auto

created_at

+

created_at

String

+

String

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

+

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

started_at

+

started_at

String

+

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.)

+

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

+

finished_at

String

+

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.)

+

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

+

Status code: 400

-
Table 3 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Status code: 401

+

Status code: 401

-
Table 4 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Status code: 403

+

Status code: 403

-
Table 5 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Status code: 404

+

Status code: 404

-
Table 6 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Status code: 500

+

Status code: 500

-
Table 7 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Example Requests

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

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.

-
{
+

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.

-
{
+

Status code: 400

+

Invalid request.

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

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Expired key scan task created successfully.

+

Expired key scan task created successfully.

400

+

400

Invalid request.

+

Invalid request.

401

+

401

Invalid authentication information.

+

Invalid authentication information.

403

+

403

Request rejected.

+

Request rejected.

404

+

404

The requested resource could not be found.

+

The requested resource could not be found.

500

+

500

Internal service error.

+

Internal service error.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/dcs/api-ref/CreateBigkeyScanTask.html b/docs/dcs/api-ref/CreateBigkeyScanTask.html index dd52772b0..307687686 100644 --- a/docs/dcs/api-ref/CreateBigkeyScanTask.html +++ b/docs/dcs/api-ref/CreateBigkeyScanTask.html @@ -1,382 +1,353 @@

Creating a Big Key Analysis Task

-

Function

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

+

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

+

URI

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

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. [For details, see Obtaining a 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

id

+

id

String

+

String

Big key analysis record ID.

+

Big key analysis record ID.

instance_id

+

instance_id

String

+

String

Instance ID.

+

Instance ID.

status

+

status

String

+

String

Analysis task status.

-

Enumeration values:

-
  • waiting

    -
  • running

    -
  • success

    -
  • failed

    -
+

Analysis task status. Value range:

+
  • waiting
  • running
  • success
  • failed

scan_type

+

scan_type

String

+

String

Analysis method.

-

Enumeration values:

-
  • manual

    -
  • auto

    -
+

Analysis method. Value range:

+
  • manual
  • auto

created_at

+

created_at

String

+

String

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

+

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

started_at

+

started_at

String

+

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.)

+

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

+

finished_at

String

+

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.)

+

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

+

num

Integer

+

Integer

Number of big keys.

+

Number of big keys.

keys

+

keys

Array of BigkeysBody objects

+

Array of BigkeysBody objects

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

+

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

-
Table 3 BigkeysBody

Parameter

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

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Key name.

+

Key name.

type

+

type

String

+

String

Key type.

-

Enumeration values:

-
  • string

    -
  • list

    -
  • set

    -
  • zset

    -
  • hash

    -
+

Key type. Value range:

+
  • string
  • list
  • set
  • zset
  • hash

shard

+

shard

String

+

String

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

+

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

db

+

db

Integer

+

Integer

Database where a big key is located.

+

Database where a big key is located.

size

+

size

Long

+

Long

Size of the key value.

+

Size of the key value.

unit

+

unit

String

+

String

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

+

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

-

Status code: 400

+

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Example Requests

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

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.

-
{
+

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",
@@ -384,55 +355,55 @@
   "created_at" : "2020-06-15T02:21:18.669Z",
   "num" : 0
 }
-

Status code: 400

-

Invalid request.

-
{
+

Status code: 400

+

Invalid request.

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

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Big key analysis task created successfully.

+

Big key analysis task created 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 is not 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.

diff --git a/docs/dcs/api-ref/CreateCustomTemplate.html b/docs/dcs/api-ref/CreateCustomTemplate.html index 0b9595f51..f70e62312 100644 --- a/docs/dcs/api-ref/CreateCustomTemplate.html +++ b/docs/dcs/api-ref/CreateCustomTemplate.html @@ -1,341 +1,316 @@

Creating a Custom Template

-

Function

This API is used to create a custom template.

+

Function

This API is used to create a custom template.

-

URI

POST /v2/{project_id}/config-templates

+

URI

POST /v2/{project_id}/config-templates

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

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

+

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

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

template_id

+

template_id

Yes

+

Yes

String

+

String

Default template ID.

+

Default template ID.

name

+

name

Yes

+

Yes

String

+

String

Template name.

+

Template name.

type

+

type

Yes

+

Yes

String

+

String

Template type. Options:

-
  • sys: default template

    -
  • user: custom template

    -
-

Enumeration values:

-
  • sys

    -
  • user

    -
+

Template type. Options:

+
  • sys: default template
  • user: custom template

engine

+

engine

No

+

No

String

+

String

Cache engine: Redis.

+

Cache engine: Redis.

cache_mode

+

cache_mode

No

+

No

String

+

String

DCS instance type. Options:

-
  • single: single-node

    -
  • ha: master/standby

    -
  • cluster: Redis Cluster

    -
  • proxy: Proxy Cluster

    -
+

DCS instance type. The value range is as follows:

+
  • single: single-node
  • ha: master/standby
  • cluster: Redis Cluster
  • proxy: Proxy Cluster
  • ha_rw_split: read/write splitting

description

+

description

No

+

No

String

+

String

Template description.

+

Template description.

engine_version

+

engine_version

No

+

No

String

+

String

Cache version.

-

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

+

Cache version.

+

If the cache engine is Redis, the version can be 4.0/5.0/6.0/7.0.

params

+

params

Yes

+

Yes

Map<String,String>

+

Map<String,String>

Parameter configuration.

+

Parameter configuration.

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
- - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Template ID.

+

Template ID.

-

Status code: 400

+

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: 1024

+

Error information.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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: 1024

+

Error information.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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: 1024

+

Error information.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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: 1024

+

Error information.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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: 1024

+

Error information.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Example Requests

Creating a single-node, Redis 5.0 custom template

-
POST https://{dcs_endpoint}/v2/{project_id}/config-templates
+

Example Requests

Creating a single-node, Redis 5.0 custom template

+
POST https://{dcs_endpoint}/v2/{project_id}/config-templates
 
 {
   "name" : "Test",
@@ -350,60 +325,60 @@
   "type" : "sys"
 }
-

Example Responses

Status code: 200

-

The custom template is created successfully.

-
{
+

Example Responses

Status code: 200

+

The custom template is created successfully.

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

Status code: 400

-

Invalid request.

-
{
+

Status code: 400

+

Invalid request.

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

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

The custom template is created successfully.

+

The custom template is created successfully.

400

+

400

Invalid request.

+

Invalid request.

401

+

401

Invalid authentication information.

+

Invalid authentication information.

403

+

403

Request rejected.

+

Request rejected.

404

+

404

The requested resource could not be found.

+

The requested resource could not be found.

500

+

500

Internal service error.

+

Internal service error.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/dcs/api-ref/CreateHotkeyScanTask.html b/docs/dcs/api-ref/CreateHotkeyScanTask.html index 84080b9fd..631017a4e 100644 --- a/docs/dcs/api-ref/CreateHotkeyScanTask.html +++ b/docs/dcs/api-ref/CreateHotkeyScanTask.html @@ -1,391 +1,362 @@

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.

+

Function

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

+

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

+

URI

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

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. [For details, see Obtaining a 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

id

+

id

String

+

String

Hot key analysis record ID.

+

Hot key analysis record ID.

instance_id

+

instance_id

String

+

String

Instance ID.

+

Instance ID.

status

+

status

String

+

String

Analysis task status.

-

Enumeration values:

-
  • waiting

    -
  • running

    -
  • success

    -
  • failed

    -
+

Analysis task status. Value range:

+
  • waiting
  • running
  • success
  • failed

scan_type

+

scan_type

String

+

String

Analysis method.

-

Enumeration values:

-
  • manual

    -
  • auto

    -
+

Analysis method. Value range:

+
  • manual
  • auto

created_at

+

created_at

String

+

String

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

+

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

started_at

+

started_at

String

+

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.)

+

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

+

finished_at

String

+

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.)

+

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

+

num

Integer

+

Integer

Number of hot keys.

+

Number of hot keys.

keys

+

keys

Array of HotkeysBody objects

+

Array of HotkeysBody objects

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

+

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

-
Table 3 HotkeysBody

Parameter

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

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Key name.

+

Key name.

type

+

type

String

+

String

Key type.

-

Enumeration values:

-
  • string

    -
  • list

    -
  • set

    -
  • zset

    -
  • hash

    -
+

Key type. Value range:

+
  • string
  • list
  • set
  • zset
  • hash

shard

+

shard

String

+

String

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

+

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

db

+

db

Integer

+

Integer

Database where a hot key is located.

+

Database where a hot key is located.

size

+

size

Long

+

Long

Size of the key value.

+

Size of the key value.

unit

+

unit

String

+

String

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

+

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

freq

+

freq

Integer

+

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.

+

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

+

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

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 message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Example Requests

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

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.

-
{
+

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",
@@ -393,55 +364,55 @@
   "created_at" : "2020-06-15T02:21:18.669Z",
   "num" : 0
 }
-

Status code: 400

-

Invalid request.

-
{
+

Status code: 400

+

Invalid request.

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

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - - - - - -

Status Code

Description

+

Description

200

+

200

Hot key analysis task created successfully.

+

Hot key analysis task created 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 is not 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.

diff --git a/docs/dcs/api-ref/CreateInstance.html b/docs/dcs/api-ref/CreateInstance.html index 5cfe6cccb..73994b4ae 100644 --- a/docs/dcs/api-ref/CreateInstance.html +++ b/docs/dcs/api-ref/CreateInstance.html @@ -1,783 +1,734 @@

Creating a DCS Instance

-

Function

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

+

Function

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

-

URI

POST /v2/{project_id}/instances

+

URI

POST /v2/{project_id}/instances

-
Table 1 Path Parameters

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

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

+

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

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

Yes

+

Yes

String

+

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.

+

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

+

engine

Yes

+

Yes

String

+

String

Cache engine: Redis.

+

Cache engine: Redis.

engine_version

+

engine_version

No

+

No

String

+

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.

+

Cache version.

+

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

capacity

+

capacity

Yes

+

Yes

Float

+

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.

+

Cache capacity (GB).

+
  • For a single-node or master/standby DCS Redis 4.0/5.0/6.0/7.0 instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 24, 32, 48, 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. For a read/write splitting DCS Redis 4.0/5.0 instance, the value can be 1, 2, 4, 8, 16, 32, or 64.

spec_code

+

spec_code

Yes

+

Yes

String

+

String

Product flavor. The query method is as follows:

- +

Product flavor. The query method is as follows:

+

az_codes

+

az_codes

Yes

+

Yes

Array of strings

+

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.

+

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, read/write splitting, 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

+

vpc_id

Yes

+

Yes

String

+

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.

    -
+

VPC ID.

+

To obtain it, do as follows:

+
  • 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

+

subnet_id

Yes

+

Yes

String

+

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.

    -
+

Network ID of the subnet.

+

To obtain it, do as follows:

+
  • 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

+

security_group_id

No

+

No

String

+

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. "

    -
+

Security group to which the instance belongs.

+

DCS Redis 4.0 and later instances do not support security groups but whitelists.

+

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

+

publicip_id

No

+

No

String

+

String

ID of the EIP bound to the DCS Redis instance.

-

This parameter is reserved. Retain the default value.

-

Default: false

+

ID of the EIP bound to the DCS Redis instance.

+

This parameter is reserved. Retain the default value.

enterprise_project_id

+

enterprise_project_id

No

+

No

String

+

String

Enterprise project ID.

+

Enterprise project ID.

enterprise_project_name

+

enterprise_project_name

No

+

No

String

+

String

Enterprise project name.

+

Enterprise project name.

description

+

description

No

+

No

String

+

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 \".

+

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

+

enable_ssl

No

+

No

Boolean

+

Boolean

This parameter is reserved. Retain the default value.

+

This parameter is reserved. Retain the default value.

private_ip

+

private_ip

No

+

No

String

+

String

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

+

IP address that is specified for a DCS instance.

instance_num

+

instance_num

No

+

No

Integer

+

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

+

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

+

Default value: 1.

+

Value range: 1 to 100

maintain_begin

+

maintain_begin

No

+

No

String

+

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.

    -
+

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

+

maintain_end

No

+

No

String

+

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.

    -
+

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

+

password

No

+

No

String

+

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:

+

Password of a DCS instance.

+
NOTE:

When no_password_access is set to false or not specified, the request must contain the password parameter.

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

      -
    +

    The password of a DCS Redis instance must meet the following complexity requirements:

    +
    • Can contain 8 to 32 characters.
    • Must contain at least three of the following character types:
      • Lowercase letters
      • Uppercase letters
      • Digits
      • Special characters `~!@#$^&*()-_=+\|{},<.>/?

no_password_access

+

no_password_access

No

+

No

Boolean

+

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

    +

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.

save_days

+

bss_param

No

+

No

Integer

+

BssParam object

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

+

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.

periodical_backup_plan

+

instance_backup_policy

No

+

No

BackupPlan object

+

BackupPolicy object

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

+

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

+

If the cache engine is Redis, leave this parameter empty.

+

enable_publicip

+

No

+

Boolean

+

This parameter is reserved. Retain the default value.

+

port

+

No

+

Integer

+

Port customization.

+

If this parameter is not sent or is left empty when you create a Redis 4.0 or later 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

+

No

+

Object

+

Critical commands can be renamed.

+

If this parameter is not sent or is left empty when you create a Redis 4.0 or later instance, no critical command will be renamed. Currently, only COMMAND, KEYS, FLUSHDB, FLUSHALL, SCAN, HSCAN, SSCAN, ZSCAN, and HGETALL commands can be renamed.

+

template_id

+

No

+

String

+

Parameter template ID. The default template is used when no ID is specified. To specify a custom parameter template, obtain the template ID by referring to Viewing Parameter Templates.

-
Table 5 BackupPlan

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

timezone_offset

+

is_auto_renew

No

+

No

String

+

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.

+

This parameter is currently not used.

backup_at

+

charging_mode

Yes

+

Yes

Array of integers

+

String

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

+

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

period_type

+

is_auto_pay

Yes

+

No

String

+

String

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

+

This parameter is currently not used.

begin_at

+

period_type

Yes

+

No

String

+

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.

+

This parameter is currently not used.

+

period_num

+

No

+

Integer

+

This parameter is currently not used.

-
Table 6 ResourceTag

Parameter

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

backup_type

Yes

+

Yes

String

+

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.

    -
+

Backup type.

+
  • auto: automatic backup
  • manual: manual backup

value

+

save_days

No

+

No

String

+

Integer

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.

    -
+

This parameter is mandatory when backup_type is set to auto.

+

Retention period, in days. The value ranges from 1 to 7.

-
- -

Response Parameters

Status code: 200

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

Parameter

-

Type

-

Description

-

instances

+

periodical_backup_plan

Array of Instances objects

+

No

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

+

BackupPlan object

+

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

-
Table 8 Instances

Parameter

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

Parameter

Type

+

Mandatory

Description

+

Type

+

Description

instance_id

+

timezone_offset

String

+

No

DCS instance ID.

+

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.

instance_name

+

backup_at

String

+

Yes

DCS instance name.

+

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.

-

Status code: 400

-
Table 9 Response body parameters

Parameter

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

Parameter

Type

+

Mandatory

Description

+

Type

+

Description

error_msg

+

key

String

+

Yes

Error message.

-

Maximum: 1024

+

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.

error_code

+

value

String

+

No

Error code.

-

Maximum: 9

+

String

error_ext_msg

-

String

-

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

-

Maximum: 1024

+

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.
-

Status code: 401

+ +

Response Parameters

Status code: 200

-
Table 10 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

instances

String

+

Array of Instances objects

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

+

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

-

Status code: 403

-
Table 11 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

instance_id

String

+

String

Error message.

-

Maximum: 1024

+

DCS instance ID.

error_code

+

instance_name

String

+

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

+

DCS instance name.

-

Status code: 404

+

Status code: 400

-
Table 12 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

-

Status code: 500

+

Status code: 401

-
Table 13 Response body parameters

Parameter

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

Parameter

Type

+

Type

Description

+

Description

error_msg

+

error_msg

String

+

String

Error message.

-

Maximum: 1024

+

Error message.

error_code

+

error_code

String

+

String

Error code.

-

Maximum: 9

+

Error code.

error_ext_msg

+

error_ext_msg

String

+

String

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

-

Maximum: 1024

+

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

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

error_code

+

String

+

Error code.

+

error_ext_msg

+

String

+

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

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

error_code

+

String

+

Error code.

+

error_ext_msg

+

String

+

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

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error message.

+

error_code

+

String

+

Error code.

+

error_ext_msg

+

String

+

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

-

Example Requests

  • Creating a DCS Redis instance

    -
    POST https://{dcs_endpoint}/v2/{project_id}/instances
    +

    Example Requests

    • Creating a DCS Redis instance
      POST https://{dcs_endpoint}/v2/{project_id}/instances
       
       {
         "name" : "dcs-APITest",
      @@ -787,7 +738,6 @@
         "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" ],
      @@ -800,12 +750,10 @@
         "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

      -
      {
      +
    • 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" : "",
      @@ -830,100 +778,98 @@
       }
    -

    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 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

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

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

      Status code: 400

      -

      Invalid request.

      -
      {
      +

      Status code: 400

      +

      Invalid request.

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

      Status code: 401

      -

      Invalid authentication information.

      -
      {
      +

      Status code: 401

      +

      Invalid authentication information.

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

      Status code: 403

      -

      The request is rejected.

      -
      {
      +

      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.

      -
      {
      +

      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.

      -
      {
      +

      Status code: 500

      +

      Internal service error.

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

    Status Codes

    -
    - - - @@ -359,6 +346,15 @@ + + + + +

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    The DCS instance creation task is submitted successfully.

    -
    NOTE:

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

    +

    The DCS instance creation task is submitted successfully.

    +
    NOTE:

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

    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 is not 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.

    diff --git a/docs/dcs/api-ref/CreateMigrationTask.html b/docs/dcs/api-ref/CreateMigrationTask.html index 2a96de710..3872f3fab 100644 --- a/docs/dcs/api-ref/CreateMigrationTask.html +++ b/docs/dcs/api-ref/CreateMigrationTask.html @@ -1,7 +1,7 @@

    Creating a Backup Import Task

    -

    Function

    This API is used to create a backup import task.

    +

    Function

    This API is used to create a backup import task.

    URI

    POST /v2/{project_id}/migration-task

    @@ -63,13 +63,11 @@

    String

    Migration mode. Options:

    +

    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

    @@ -78,14 +76,11 @@

    String

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

    +

    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

    @@ -104,10 +99,6 @@

    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

    @@ -149,15 +140,11 @@

    String

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

    -

    Enumeration values:

    -
    • self_build_obs

      -
    • backup_record

      -

    bucket_name

    Yes

    +

    No

    String

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

    task_status

    +

    No

    +

    String

    +

    Task status.

    +

    ip

    No

    @@ -410,46 +406,40 @@

    Response Parameters

    Status code: 200

    -
    Table 7 Response body parameters

    Parameter

    +
    - - - - - - - - - - - - - - @@ -457,36 +447,33 @@

    Status code: 400

    -
    Table 7 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Migration task ID.

    +

    Migration task ID.

    name

    +

    name

    String

    +

    String

    Migration task name.

    +

    Migration task name.

    status

    +

    status

    String

    +

    String

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

    -

    Enumeration values:

    -
    • SUCCESS

      -
    • FAILED

      -
    • MIGRATING

      -
    • TERMINATED

      -
    +

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

    error

    +

    error

    String

    +

    String

    Error message.

    +

    Error message.

    Table 8 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -494,36 +481,33 @@

    Status code: 401

    -
    Table 8 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 9 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -531,36 +515,33 @@

    Status code: 403

    -
    Table 9 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 10 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -568,36 +549,33 @@

    Status code: 404

    -
    Table 10 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 11 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -605,36 +583,33 @@

    Status code: 500

    -
    Table 11 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 12 Response body parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/dcs/api-ref/CreateOnlineMigrationTask.html b/docs/dcs/api-ref/CreateOnlineMigrationTask.html index b6c28e567..4333292be 100644 --- a/docs/dcs/api-ref/CreateOnlineMigrationTask.html +++ b/docs/dcs/api-ref/CreateOnlineMigrationTask.html @@ -1,7 +1,7 @@

    Creating an Online Data Migration Task

    -

    Function

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

    +

    Function

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

    URI

    POST /v2/{project_id}/migration/instance

    @@ -64,7 +64,7 @@
    - -
    Table 12 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    String

    VPC ID.

    -

    Methods:

    +

    To obtain it, do as follows:

    • 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.

    @@ -76,8 +76,8 @@

    String

    Subnet network ID.

    -

    Methods:

    +

    Network ID of the subnet.

    +

    To obtain it, do as follows:

    • 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.

    @@ -89,8 +89,9 @@

    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:

    +

    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.

    +

    To obtain it, do as follows:

    • 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.

    @@ -102,19 +103,19 @@

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

    +
    - - - - - @@ -122,36 +123,33 @@

    Status code: 400

    -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    instance_id

    +

    instance_id

    String

    +

    String

    Online migration task ID.

    +

    Online migration task ID.

    Table 4 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -159,36 +157,33 @@

    Status code: 401

    -
    Table 4 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 5 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -196,36 +191,33 @@

    Status code: 403

    -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 6 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -233,36 +225,33 @@

    Status code: 404

    -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 7 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -270,36 +259,33 @@

    Status code: 500

    -
    Table 7 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 8 Response body parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/dcs/api-ref/CreateRedislog.html b/docs/dcs/api-ref/CreateRedislog.html index a862f934f..5a9ed537a 100644 --- a/docs/dcs/api-ref/CreateRedislog.html +++ b/docs/dcs/api-ref/CreateRedislog.html @@ -1,7 +1,7 @@

    Collecting Redis Run Logs

    -

    Function

    This API is used to collect Redis run logs.

    +

    Function

    This API is used to collect Redis run logs.

    URI

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

    @@ -54,12 +54,6 @@
    Table 8 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    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

    @@ -88,36 +82,33 @@

    Response Parameters

    Status code: 400

    -
    Table 3 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -125,36 +116,33 @@

    Status code: 401

    -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 4 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -162,36 +150,33 @@

    Status code: 403

    -
    Table 4 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 5 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -199,36 +184,33 @@

    Status code: 404

    -
    Table 5 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 6 Response body parameters

    Parameter

    +
    - - - - - - - - - - - @@ -236,36 +218,33 @@

    Status code: 500

    -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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

    Table 7 Response body parameters

    Parameter

    +
    - - - - - - - - - - - diff --git a/docs/dcs/api-ref/CreateRedislogDownloadLink.html b/docs/dcs/api-ref/CreateRedislogDownloadLink.html index 9b0a3764f..e19104054 100644 --- a/docs/dcs/api-ref/CreateRedislogDownloadLink.html +++ b/docs/dcs/api-ref/CreateRedislogDownloadLink.html @@ -1,7 +1,7 @@

    Obtaining the Log Download Link

    -

    Function

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

    +

    Function

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

    Response Parameters

    Status code: 200

    -
    Table 7 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    error_msg

    +

    error_msg

    String

    +

    String

    Error message.

    -

    Maximum: 1024

    +

    Error message.

    error_code

    +

    error_code

    String

    +

    String

    Error code.

    -

    Maximum: 9

    +

    Error code.

    error_ext_msg

    +

    error_ext_msg

    String

    +

    String

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

    -

    Maximum: 1024

    +

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