vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/CLASS.TXT.json
Chen, Junjie a03981f7be DCS API 20230220 Version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-04-22 14:08:39 +00:00

1154 lines
45 KiB
JSON
Raw Blame History

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