diff --git a/docs/dcs/api-ref/ALL_META.TXT.json b/docs/dcs/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..a4dca720 --- /dev/null +++ b/docs/dcs/api-ref/ALL_META.TXT.json @@ -0,0 +1,392 @@ +[ + { + "uri":"dcs-api-0417001.html", + "product_code":"dcs", + "code":"1", + "des":"Distributed Cache Service (DCS) APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by o", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"dcs-api-0312003.html", + "product_code":"dcs", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Lifecycle Management APIs", + "title":"Lifecycle Management APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312004.html", + "product_code":"dcs", + "code":"3", + "des":"This API is used to create a DCS instance.The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.POST /v1.0/", + "doc_type":"api", + "kw":"Creating a DCS Instance,Lifecycle Management APIs,API Reference", + "title":"Creating a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312008.html", + "product_code":"dcs", + "code":"4", + "des":"This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}Table 1 describ", + "doc_type":"api", + "kw":"Deleting a Single DCS Instance,Lifecycle Management APIs,API Reference", + "title":"Deleting a Single DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312009.html", + "product_code":"dcs", + "code":"5", + "des":"This API is used to delete multiple DCS instances at a time.DELETE /v1.0/{project_id}/instances?allFailure={allFailure}Table 1 describes the parameters.Parameter descript", + "doc_type":"api", + "kw":"Batch Deleting DCS Instances,Lifecycle Management APIs,API Reference", + "title":"Batch Deleting DCS Instances", + "githuburl":"" + }, + { + "uri":"dcs-api-0312005.html", + "product_code":"dcs", + "code":"6", + "des":"This API is used to query the details about a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}Table 1 describes the parameters.Parameter descriptionP", + "doc_type":"api", + "kw":"Querying a DCS Instance,Lifecycle Management APIs,API Reference", + "title":"Querying a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312006.html", + "product_code":"dcs", + "code":"7", + "des":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&sta", + "doc_type":"api", + "kw":"Querying All DCS Instances of a Tenant,Lifecycle Management APIs,API Reference", + "title":"Querying All DCS Instances of a Tenant", + "githuburl":"" + }, + { + "uri":"dcs-api-0312007.html", + "product_code":"dcs", + "code":"8", + "des":"This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, an", + "doc_type":"api", + "kw":"Modifying Information About a DCS Instance,Lifecycle Management APIs,API Reference", + "title":"Modifying Information About a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312010.html", + "product_code":"dcs", + "code":"9", + "des":"This API is used to scale up a DCS Redis instance in the Running state.POST /v1.0/{project_id}/instances/{instance_id}/extendTable 1 describes the parameters.Parameter de", + "doc_type":"api", + "kw":"Scaling Up a DCS Instance,Lifecycle Management APIs,API Reference", + "title":"Scaling Up a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312035.html", + "product_code":"dcs", + "code":"10", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Instance Management APIs", + "title":"Instance Management APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312018.html", + "product_code":"dcs", + "code":"11", + "des":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.PUT /v1.0/{project_id}/instances/statusTa", + "doc_type":"api", + "kw":"Restarting DCS Instances or Clearing DCS Instance Data,Instance Management APIs,API Reference", + "title":"Restarting DCS Instances or Clearing DCS Instance Data", + "githuburl":"" + }, + { + "uri":"dcs-api-0312014.html", + "product_code":"dcs", + "code":"12", + "des":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v1.0/{project_id}/instances/statisticTable 1 describes the parameter.Para", + "doc_type":"api", + "kw":"Querying Statistics of All Running Instances,Instance Management APIs,API Reference", + "title":"Querying Statistics of All Running Instances", + "githuburl":"" + }, + { + "uri":"dcs-api-0312016.html", + "product_code":"dcs", + "code":"13", + "des":"This API is used to query the number of instances in different states.GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}Table 1 describes the paramet", + "doc_type":"api", + "kw":"Querying DCS Instance Status,Instance Management APIs,API Reference", + "title":"Querying DCS Instance Status", + "githuburl":"" + }, + { + "uri":"dcs-api-0312019.html", + "product_code":"dcs", + "code":"14", + "des":"This API is used to change the password of a DCS instance.PUT /v1.0/{project_id}/instances/{instance_id}/passwordTable 1 describes the parameters.Parameter descriptionPar", + "doc_type":"api", + "kw":"Changing the Password of a DCS Instance,Instance Management APIs,API Reference", + "title":"Changing the Password of a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312013.html", + "product_code":"dcs", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Parameter Management APIs", + "title":"Parameter Management APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312017.html", + "product_code":"dcs", + "code":"16", + "des":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v1.0/{project_id}/instances/{instance_id}/con", + "doc_type":"api", + "kw":"Modifying Configuration Parameters,Parameter Management APIs,API Reference", + "title":"Modifying Configuration Parameters", + "githuburl":"" + }, + { + "uri":"dcs-api-0312015.html", + "product_code":"dcs", + "code":"17", + "des":"This API is used to query the configuration parameters of a DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/configsTable 1 describes the parameters.Parameter ", + "doc_type":"api", + "kw":"Querying Configuration Parameters,Parameter Management APIs,API Reference", + "title":"Querying Configuration Parameters", + "githuburl":"" + }, + { + "uri":"dcs-api-0514003.html", + "product_code":"dcs", + "code":"18", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Data Migration APIs", + "title":"Data Migration APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0514004.html", + "product_code":"dcs", + "code":"19", + "des":"This API is used to create a data migration task.NonePOST /v2/{project_id}/migration-taskIf the status code is 200, the following parameters are returned:Example request ", + "doc_type":"api", + "kw":"Creating a Data Migration Task,Data Migration APIs,API Reference", + "title":"Creating a Data Migration Task", + "githuburl":"" + }, + { + "uri":"dcs-api-0514005.html", + "product_code":"dcs", + "code":"20", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Backup and Restoration APIs", + "title":"Backup and Restoration APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312020.html", + "product_code":"dcs", + "code":"21", + "des":"This API is used to back up a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "doc_type":"api", + "kw":"Backing Up a DCS Instance,Backup and Restoration APIs,API Reference", + "title":"Backing Up a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312021.html", + "product_code":"dcs", + "code":"22", + "des":"This API is used to restore a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "doc_type":"api", + "kw":"Restoring a DCS Instance,Backup and Restoration APIs,API Reference", + "title":"Restoring a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312022.html", + "product_code":"dcs", + "code":"23", + "des":"This API is used to query the backup records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beg", + "doc_type":"api", + "kw":"Querying DCS Instance Backup Records,Backup and Restoration APIs,API Reference", + "title":"Querying DCS Instance Backup Records", + "githuburl":"" + }, + { + "uri":"dcs-api-0312023.html", + "product_code":"dcs", + "code":"24", + "des":"This API is used to query the restoration records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTim", + "doc_type":"api", + "kw":"Querying DCS Instance Restoration Records,Backup and Restoration APIs,API Reference", + "title":"Querying DCS Instance Restoration Records", + "githuburl":"" + }, + { + "uri":"dcs-api-0312024.html", + "product_code":"dcs", + "code":"25", + "des":"This API is used to delete the files backed up by a DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}Table 1 describes the parameters.Par", + "doc_type":"api", + "kw":"Deleting Backup Files,Backup and Restoration APIs,API Reference", + "title":"Deleting Backup Files", + "githuburl":"" + }, + { + "uri":"topic_300000009.html", + "product_code":"", + "code":"26", + "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":"", + "kw":"Network Security", + "title":"Network Security", + "githuburl":"" + }, + { + "uri":"UpdateIpWhitelist.html", + "product_code":"", + "code":"27", + "des":"IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instancesThis API is used to configure IP address whitelist groups for a s", + "doc_type":"", + "kw":"Configuring IP Whitelist Groups,Network Security,API Reference", + "title":"Configuring IP Whitelist Groups", + "githuburl":"" + }, + { + "uri":"ShowIpWhitelist.html", + "product_code":"", + "code":"28", + "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":"", + "kw":"Querying the IP Whitelist of a DCS Instance,Network Security,API Reference", + "title":"Querying the IP Whitelist of a DCS Instance", + "githuburl":"" + }, + { + "uri":"dcs-api-0312038.html", + "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":"Other APIs", + "title":"Other APIs", + "githuburl":"" + }, + { + "uri":"dcs-api-0312040.html", + "product_code":"dcs", + "code":"30", + "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", + "title":"Querying Service Specifications", + "githuburl":"" + }, + { + "uri":"dcs-api-0312036.html", + "product_code":"dcs", + "code":"31", + "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", + "title":"Querying the Quota of a Tenant", + "githuburl":"" + }, + { + "uri":"dcs-api-0312041.html", + "product_code":"dcs", + "code":"32", + "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", + "title":"Querying Maintenance Time Window", + "githuburl":"" + }, + { + "uri":"dcs-api-0312039.html", + "product_code":"dcs", + "code":"33", + "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", + "title":"Querying AZ Information", + "githuburl":"" + }, + { + "uri":"dcs-api-0312042.html", + "product_code":"dcs", + "code":"34", + "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", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"dcs-api-0312043.html", + "product_code":"dcs", + "code":"35", + "des":"Table 1 describes the status codes.", + "doc_type":"api", + "kw":"Status Codes,Appendix,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"dcs-api-0312044.html", + "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":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"dcs-api-0312045.html", + "product_code":"dcs", + "code":"37", + "des":"A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.The following procedure describes how to obtain a project ID:On t", + "doc_type":"api", + "kw":"Obtaining a Project ID,Appendix,API Reference", + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"dcs-api-0312047.html", + "product_code":"dcs", + "code":"38", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"DCS Instance Statuses,Appendix,API Reference", + "title":"DCS Instance Statuses", + "githuburl":"" + }, + { + "uri":"dcs-api-0312049.html", + "product_code":"dcs", + "code":"39", + "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", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/dcs/api-ref/CLASS.TXT.json b/docs/dcs/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..9a142960 --- /dev/null +++ b/docs/dcs/api-ref/CLASS.TXT.json @@ -0,0 +1,353 @@ +[ + { + "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":"Lifecycle Management APIs", + "uri":"dcs-api-0312003.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"This API is used to create a DCS instance.The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.POST /v1.0/", + "product_code":"dcs", + "title":"Creating a DCS Instance", + "uri":"dcs-api-0312004.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}Table 1 describ", + "product_code":"dcs", + "title":"Deleting a Single DCS Instance", + "uri":"dcs-api-0312008.html", + "doc_type":"api", + "p_code":"2", + "code":"4" + }, + { + "desc":"This API is used to delete multiple DCS instances at a time.DELETE /v1.0/{project_id}/instances?allFailure={allFailure}Table 1 describes the parameters.Parameter descript", + "product_code":"dcs", + "title":"Batch Deleting DCS Instances", + "uri":"dcs-api-0312009.html", + "doc_type":"api", + "p_code":"2", + "code":"5" + }, + { + "desc":"This API is used to query the details about a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}Table 1 describes the parameters.Parameter descriptionP", + "product_code":"dcs", + "title":"Querying a DCS Instance", + "uri":"dcs-api-0312005.html", + "doc_type":"api", + "p_code":"2", + "code":"6" + }, + { + "desc":"This API is used to query DCS instances of a tenant, and allows you to specify query criteria.GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&sta", + "product_code":"dcs", + "title":"Querying All DCS Instances of a Tenant", + "uri":"dcs-api-0312006.html", + "doc_type":"api", + "p_code":"2", + "code":"7" + }, + { + "desc":"This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, an", + "product_code":"dcs", + "title":"Modifying Information About a DCS Instance", + "uri":"dcs-api-0312007.html", + "doc_type":"api", + "p_code":"2", + "code":"8" + }, + { + "desc":"This API is used to scale up a DCS Redis instance in the Running state.POST /v1.0/{project_id}/instances/{instance_id}/extendTable 1 describes the parameters.Parameter de", + "product_code":"dcs", + "title":"Scaling Up a DCS Instance", + "uri":"dcs-api-0312010.html", + "doc_type":"api", + "p_code":"2", + "code":"9" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dcs", + "title":"Instance Management APIs", + "uri":"dcs-api-0312035.html", + "doc_type":"api", + "p_code":"", + "code":"10" + }, + { + "desc":"This API is used to restart a running DCS instance.Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.PUT /v1.0/{project_id}/instances/statusTa", + "product_code":"dcs", + "title":"Restarting DCS Instances or Clearing DCS Instance Data", + "uri":"dcs-api-0312018.html", + "doc_type":"api", + "p_code":"10", + "code":"11" + }, + { + "desc":"This API is used to query the statistics of all DCS instances that are in the Running state.GET /v1.0/{project_id}/instances/statisticTable 1 describes the parameter.Para", + "product_code":"dcs", + "title":"Querying Statistics of All Running Instances", + "uri":"dcs-api-0312014.html", + "doc_type":"api", + "p_code":"10", + "code":"12" + }, + { + "desc":"This API is used to query the number of instances in different states.GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}Table 1 describes the paramet", + "product_code":"dcs", + "title":"Querying DCS Instance Status", + "uri":"dcs-api-0312016.html", + "doc_type":"api", + "p_code":"10", + "code":"13" + }, + { + "desc":"This API is used to change the password of a DCS instance.PUT /v1.0/{project_id}/instances/{instance_id}/passwordTable 1 describes the parameters.Parameter descriptionPar", + "product_code":"dcs", + "title":"Changing the Password of a DCS Instance", + "uri":"dcs-api-0312019.html", + "doc_type":"api", + "p_code":"10", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dcs", + "title":"Parameter Management APIs", + "uri":"dcs-api-0312013.html", + "doc_type":"api", + "p_code":"", + "code":"15" + }, + { + "desc":"You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.PUT /v1.0/{project_id}/instances/{instance_id}/con", + "product_code":"dcs", + "title":"Modifying Configuration Parameters", + "uri":"dcs-api-0312017.html", + "doc_type":"api", + "p_code":"15", + "code":"16" + }, + { + "desc":"This API is used to query the configuration parameters of a DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/configsTable 1 describes the parameters.Parameter ", + "product_code":"dcs", + "title":"Querying Configuration Parameters", + "uri":"dcs-api-0312015.html", + "doc_type":"api", + "p_code":"15", + "code":"17" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dcs", + "title":"Data Migration APIs", + "uri":"dcs-api-0514003.html", + "doc_type":"api", + "p_code":"", + "code":"18" + }, + { + "desc":"This API is used to create a data migration task.NonePOST /v2/{project_id}/migration-taskIf the status code is 200, the following parameters are returned:Example request ", + "product_code":"dcs", + "title":"Creating a Data Migration Task", + "uri":"dcs-api-0514004.html", + "doc_type":"api", + "p_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.", + "product_code":"dcs", + "title":"Backup and Restoration APIs", + "uri":"dcs-api-0514005.html", + "doc_type":"api", + "p_code":"", + "code":"20" + }, + { + "desc":"This API is used to back up a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "product_code":"dcs", + "title":"Backing Up a DCS Instance", + "uri":"dcs-api-0312020.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to restore a specified DCS instance.Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.POST ", + "product_code":"dcs", + "title":"Restoring a DCS Instance", + "uri":"dcs-api-0312021.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to query the backup records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beg", + "product_code":"dcs", + "title":"Querying DCS Instance Backup Records", + "uri":"dcs-api-0312022.html", + "doc_type":"api", + "p_code":"20", + "code":"23" + }, + { + "desc":"This API is used to query the restoration records of a specified DCS instance.GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTim", + "product_code":"dcs", + "title":"Querying DCS Instance Restoration Records", + "uri":"dcs-api-0312023.html", + "doc_type":"api", + "p_code":"20", + "code":"24" + }, + { + "desc":"This API is used to delete the files backed up by a DCS instance.DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}Table 1 describes the parameters.Par", + "product_code":"dcs", + "title":"Deleting Backup Files", + "uri":"dcs-api-0312024.html", + "doc_type":"api", + "p_code":"20", + "code":"25" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dcs", + "title":"Network Security", + "uri":"topic_300000009.html", + "doc_type":"api", + "p_code":"", + "code":"26" + }, + { + "desc":"IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instancesThis API is used to configure IP address whitelist groups for a s", + "product_code":"dcs", + "title":"Configuring IP Whitelist Groups", + "uri":"UpdateIpWhitelist.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "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":"26", + "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.", + "product_code":"dcs", + "title":"Other APIs", + "uri":"dcs-api-0312038.html", + "doc_type":"api", + "p_code":"", + "code":"29" + }, + { + "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":"29", + "code":"30" + }, + { + "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":"29", + "code":"31" + }, + { + "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":"29", + "code":"32" + }, + { + "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":"29", + "code":"33" + }, + { + "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":"34" + }, + { + "desc":"Table 1 describes the status codes.", + "product_code":"dcs", + "title":"Status Codes", + "uri":"dcs-api-0312043.html", + "doc_type":"api", + "p_code":"34", + "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.", + "product_code":"dcs", + "title":"Error Codes", + "uri":"dcs-api-0312044.html", + "doc_type":"api", + "p_code":"34", + "code":"36" + }, + { + "desc":"A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.The following procedure describes how to obtain a project ID:On t", + "product_code":"dcs", + "title":"Obtaining a Project ID", + "uri":"dcs-api-0312045.html", + "doc_type":"api", + "p_code":"34", + "code":"37" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dcs", + "title":"DCS Instance Statuses", + "uri":"dcs-api-0312047.html", + "doc_type":"api", + "p_code":"34", + "code":"38" + }, + { + "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":"39" + } +] \ No newline at end of file diff --git a/docs/dcs/api-ref/PARAMETERS.txt b/docs/dcs/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/dcs/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/dcs/api-ref/ShowIpWhitelist.html b/docs/dcs/api-ref/ShowIpWhitelist.html new file mode 100644 index 00000000..b4703e32 --- /dev/null +++ b/docs/dcs/api-ref/ShowIpWhitelist.html @@ -0,0 +1,135 @@ + + +

Querying the IP Whitelist of a DCS Instance

+

Function

This API is used to query the IP address whitelist of a specific instance.

+
+

URI

GET /v2/{project_id}/instance/{instance_id}/whitelist

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameter

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

enable_whitelist

+

Boolean

+

Whether to enable the whitelist.

+

Options:

+
  • true
  • false
+

whitelist

+

Array of Whitelist objects

+

IP whitelist group.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 Whitelist

Parameter

+

Type

+

Description

+

group_name

+

String

+

Whitelist group name. A maximum of four groups can be created for each instance.

+

ip_list

+

Array of strings

+

List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.

+
+
+
+

Example Request

GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
+
+

Example Response

Status code: 200

+

Instance whitelist queried successfully.

+
{
+  "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
+  "enable_whitelist" : true,
+  "whitelist" : {
+    "group_name" : "test001",
+    "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
+  }
+}
+
+

Status Codes

+
+ + + + + + + +

Status Code

+

Description

+

200

+

Instance whitelist queried successfully.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Network Security
+
+
+ diff --git a/docs/dcs/api-ref/UpdateIpWhitelist.html b/docs/dcs/api-ref/UpdateIpWhitelist.html new file mode 100644 index 00000000..14e11e5e --- /dev/null +++ b/docs/dcs/api-ref/UpdateIpWhitelist.html @@ -0,0 +1,356 @@ + + +

Configuring IP Whitelist Groups

+

IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instances

+
+

Function

This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one.

+
+

URI

PUT /v2/{project_id}/instance/{instance_id}/whitelist

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameter

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

enable_whitelist

+

Yes

+

Boolean

+

Whether to enable the whitelist.

+

Options:

+
  • true
  • false
+

whitelist

+

Yes

+

Array of Whitelist objects

+

IP whitelist group.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Whitelist

Parameter

+

Mandatory

+

Type

+

Description

+

group_name

+

Yes

+

String

+

Whitelist group name. A maximum of four groups can be created for each instance.

+

ip_list

+

Yes

+

Array of strings

+

List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.

+
+
+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum length: 1024 characters

+

error_code

+

String

+

Error code.

+

Maximum length: 9 characters

+

error_ext_msg

+

String

+

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

+

Maximum length: 1024 characters

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum length: 1024 characters

+

error_code

+

String

+

Error code.

+

Maximum length: 9 characters

+

error_ext_msg

+

String

+

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

+

Maximum length: 1024 characters

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum length: 1024 characters

+

error_code

+

String

+

Error code.

+

Maximum length: 9 characters

+

error_ext_msg

+

String

+

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

+

Maximum length: 1024 characters

+
+
+

Status code: 404

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum length: 1024 characters

+

error_code

+

String

+

Error code.

+

Maximum length: 9 characters

+

error_ext_msg

+

String

+

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

+

Maximum length: 1024 characters

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_msg

+

String

+

Error information.

+

Maximum length: 1024 characters

+

error_code

+

String

+

Error code.

+

Maximum length: 9 characters

+

error_ext_msg

+

String

+

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

+

Maximum length: 1024 characters

+
+
+
+

Example Request

PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
+
+{
+  "enable_whitelist" : true,
+  "whitelist" : [ {
+    "group_name" : "test001",
+    "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
+  } ]
+}
+
+

Example Response

None

+
+

Status Codes

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

Status Code

+

Description

+

204

+

IP whitelist groups configured successfully.

+

400

+

Invalid request.

+

401

+

Invalid authentication information.

+

403

+

The request is rejected.

+

404

+

The requested resource could not be found.

+

500

+

Internal service error

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Network Security
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312003.html b/docs/dcs/api-ref/dcs-api-0312003.html new file mode 100644 index 00000000..601fbc17 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312003.html @@ -0,0 +1,23 @@ + + +

Lifecycle Management APIs

+
+
+ +
+ diff --git a/docs/dcs/api-ref/dcs-api-0312004.html b/docs/dcs/api-ref/dcs-api-0312004.html new file mode 100644 index 00000000..fe504532 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312004.html @@ -0,0 +1,534 @@ + + +

Creating a DCS Instance

+

Function

This API is used to create a DCS instance.

+

The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.

+
+
+

URI

POST /v1.0/{project_id}/instances

+
Table 1 describes the parameter. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID.

+
+
+
+
+

Request

Request parameters

+

Table 2 describes the request parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

name

+

String

+

Yes

+

DCS instance name.

+

An instance name can contain 4 to 64 characters and must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

description

+

String

+

No

+

Brief description of the DCS instance.

+

The description supports up to 1024 characters.

+
NOTE:

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

+
+

engine

+

String

+

Yes

+

Cache engine. Value: Redis.

+

engine_version

+

String

+

Yes

+

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

+

spec_code

+

String

+

No

+

DCS instance specification code.

+

To obtain the value, go to the instance creation page on the DCS console, and view Flavor Name in the Instance Specification table.

+

capacity

+

Float

+

Yes

+

Cache capacity. Unit: GB.

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

no_password_access

+

String

+

Yes

+

An indicator of whether a DCS instance can be accessed in password-free mode.

+
  • true: indicates that a DCS instance can be accessed without a password.
  • false: indicates that a DCS instance can be accessed only after password authentication.
+

Default value: false.

+

password

+

String

+

No

+

Password of a DCS instance.

+
NOTE:

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

+
+

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

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

vpc_id

+

String

+

Yes

+

VPC ID.

+

Obtain the value by using either of the following methods:

+
  • Method 1: Log in to VPC console and view the VPC ID in the VPC details.
  • Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the Virtual Private Cloud API Reference.
+

security_group_id

+

String

+

Yes

+

ID of the security group which the instance belongs to.

+

This parameter is mandatory when the engine is Redis and engine_version is 3.0. DCS Redis 3.0 instances support security group access control.

+

This parameter is optional when the engine is Redis and engine_version is 4.0 or 5.0. DCS Redis 4.0 and 5.0 instances do not support security groups.

+

Obtain the value by using either of the following methods:

+
  • Method 1: Log in to the VPC console and view the security group ID on the security group details page.
  • Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the Virtual Private Cloud API Reference.
+

subnet_id

+

String

+

Yes

+

Network ID of the subnet.

+

Obtain the value by using either of the following methods:

+
  • Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.
  • Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the Virtual Private Cloud API Reference.
+

available_zones

+

Array

+

Yes

+

ID of the AZ where the cache node resides and which has available resources. For details on how to obtain the value, see Querying AZ Information. Check whether the AZ has available resources.

+

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

+

product_id

+

String

+

Yes

+

ID of the product that can be created. For details, see Querying Service Specifications.

+

The parameter value is in the format of spec_code-Abbreviation of the billing mode. The abbreviation of the billing mode can only be h, indicating pay-per-use.

+

For example, redis.single.au1.large.1-h indicates a pay-per-use product whose specification code is redis.single.au1.large.1.

+
NOTE:

When obtaining the product ID from the product specifications, ensure that the billing mode specified in the product ID is the same as the selected billing mode. For example, to buy a master/standby DCS Redis 3.0 instance billed in pay-per-use mode, you can search for the product ID corresponding to the record whose charging_type is Hourly and spec_code is dcs.master_standby in the response message.

+
+

instance_backup_policy

+

Object

+

No

+

Backup policy.

+

This parameter is available for master/standby and cluster DCS instances. For details, see Table 3 and Table 4.

+

enable_publicip

+

Boolean

+

No

+

An indicator of whether to enable public access for a DCS Redis instance.

+
  • true: enable.
  • false: disable.
+

publicip_id

+

String

+

No

+

ID of the elastic IP address bound to a DCS Redis instance.

+

This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).

+

enable_ssl

+

Boolean

+

No

+

An indicator of whether to enable SSL for public access to a DCS Redis instance.

+
  • true: enable.
  • false: disable.
+

maintain_begin

+

String

+

No

+

Time at which the maintenance time window starts.

+

Format: hh:mm:ss.

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
  • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
  • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_start is left blank, parameter maintain_end is also blank. In this case, the system automatically set the start time to 02:00:00.
+

maintain_end

+

String

+

No

+

Time at which the maintenance time window ends.

+

Format: hh:mm:ss.

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
+
  • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
  • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank. In this case, the system automatically set the end time to 06:00:00.
+

enterprise_project_id

+

String

+

No

+

Enterprise project ID.

+

enterprise_project_name

+

String

+

No

+

Enterprise project name.

+

instance_num

+

Integer

+

No

+

Number of instances to be created in batches.

+

Default value: 1.

+

Value range: 1–100.

+

private_ips

+

Array of strings

+

No

+

IP address that is manually specified for a DCS instance.

+

port

+

Integer

+

No

+

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 instances.

+

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

+

rename_commands

+

Object

+

No

+

Critical command renaming, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 instances.

+

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

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 instance_backup_policy parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

save_days

+

Integer

+

No

+

This parameter is mandatory when backup_type is set to manual.

+

Retention period.

+

Unit: day.

+

Value range: 1–7.

+

backup_type

+

String

+

No

+

Backup type.

+

Options:

+
  • auto: automatic backup.
  • manual: manual backup.
+

The default value is manual.

+

periodical_backup_plan

+

Object

+

Yes

+

Backup plan. For details, see Table 4.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 periodical_backup_plan parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

begin_at

+

String

+

Yes

+

Time at which backup starts.

+

"00:00-01:00" indicates that backup starts at 00:00:00.

+

period_type

+

String

+

Yes

+

Interval at which backup is performed.

+

Currently, only weekly backup is supported.

+

backup_at

+

Array

+

Yes

+

Day in a week on which backup starts.

+

Value range: 1–7, where 1 indicates Monday and 7 indicates Sunday.

+

timezone_offset

+

String

+

No

+

Time zone in which backup is performed.

+

Value range: GMT–12:00 to GMT+12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default.

+
+
+

Example request

+ + +
+

Response

Response parameters

+
Table 5 describes the response parameters. +
+ + + + + + + + + + + + + +
Table 5 Parameter description

Parameter

+

Type

+

Description

+

instance_id

+

String

+

DCS instance ID.

+

instances

+

Array of Objects

+

DCS instance list. For details, see Table 6.

+
+
+
+ +
+ + + + + + + + + + + + + +
Table 6 instances parameters

Parameter

+

Type

+

Description

+

instance_id

+

String

+

DCS instance ID.

+

instance_name

+

String

+

DCS instance name.

+
+
+

Example response

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

Status Code

Table 7 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 7 Status code

Status Code

+

Description

+

200

+

DCS instance created successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312005.html b/docs/dcs/api-ref/dcs-api-0312005.html new file mode 100644 index 00000000..2752614b --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312005.html @@ -0,0 +1,731 @@ + + +

Querying a DCS Instance

+

Function

This API is used to query the details about a specified DCS instance.

+
+

URI

GET /v1.0/{project_id}/instances/{instance_id}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

For details on how to obtain the value of this parameter, see Obtaining a Project ID.

+

instance_id

+

String

+

Yes

+

ID of the instance to be queried

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+

Request URL:

+
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
+
+

Response

Response parameters

+

Table 2 describes the response parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

name

+

String

+

DCS instance name.

+

engine

+

String

+

DCS instance engine.

+

capacity

+

Integer

+

DCS instance cache capacity. Unit: GB.

+

ip

+

String

+

IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.

+

domainName

+

String

+

Domain name of the instance.

+

port

+

Integer

+

Port number of the cache node.

+

status

+

String

+

Cache instance status. For details about status, see DCS Instance Statuses.

+

libos

+

Boolean

+
  • true: This instance is a libos instance.
  • false: This instance is not a libos instance.
+

description

+

String

+

Brief description of the DCS instance.

+

max_memory

+

Integer

+

Total memory size.

+

Unit: MB.

+

used_memory

+

Integer

+

Size of the used memory.

+

Unit: MB.

+

instance_id

+

String

+

DCS instance ID.

+

resource_spec_code

+

String

+

Resource specifications.

+

For example:

+
  • dcs.single_node: indicates a DCS instance in single-node mode.
  • dcs.master_standby: indicates a DCS instance in master/standby mode.
  • dcs.cluster: indicates a DCS instance in cluster mode.
+

engine_version

+

String

+

Cache engine version.

+

internal_version

+

String

+

Internal DCS version.

+

charging_mode

+

Integer

+

Billing mode. 0: pay-per-use.

+

capacity_minor

+

String

+

Cache capacity of a small-scale, single-node DCS instance.

+

vpc_id

+

String

+

VPC ID.

+

vpc_name

+

String

+

VPC name.

+

created_at

+

String

+

Time at which the DCS instance is created.

+

For example, 2017-03-31T12:24:46.297Z.

+

error_code

+

String

+

Error code returned when the DCS instance fails to be created or is abnormal.

+

For details about error codes, see Error Codes.

+

user_id

+

String

+

User ID.

+

user_name

+

String

+

Username.

+

maintain_begin

+

String

+

Time at which the maintenance time window starts.

+

Format: hh:mm:ss.

+

maintain_end

+

String

+

Time at which the maintenance time window ends.

+

Format: hh:mm:ss.

+

no_password_access

+

String

+

An indicator of whether a DCS instance can be accessed in password-free mode.

+
  • true: indicates that a DCS instance can be accessed without a password.
  • false: indicates that a DCS instance can be accessed only after password authentication.
+

access_user

+

String

+

Username used for accessing a DCS instance with password authentication.

+

enable_publicip

+

Boolean

+

An indicator of whether public access is enabled for a DCS Redis instance. Options:

+
  • true: enabled.
  • false: disabled.
+

publicip_id

+

String

+

ID of the elastic IP address bound to a DCS Redis instance.

+

The parameter value is null if public access is disabled.

+

publicip_address

+

String

+

Elastic IP address bound to a DCS Redis instance.

+

The parameter value is null if public access is disabled.

+

enable_ssl

+

Boolean

+

An indicator of whether to enable SSL for public access to a DCS Redis instance.

+
  • true: enabled.
  • false: disabled.
+

service_upgrade

+

Boolean

+

An indicator of whether an upgrade task has been created for a DCS instance.

+
  • true: yes.
  • false: no.
+

service_task_id

+

String

+

Upgrade task ID.

+
  • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
  • If the value of service_upgrade is set to false, the value of this parameter is empty.
+

enterprise_project_id

+

String

+

Enterprise project ID.

+

product_type

+

String

+

Edition of DCS for Redis. Options:

+
  • generic: standard edition
  • libos: high-performance edition
+

cpu_type

+

String

+

CPU architecture. Options: x86_64 and aarch_64.

+

storage_type

+

String

+

Memory type. Options: DRAM and SCM.

+

cache_mode

+

String

+

DCS instance type. Options:

+
  • single: single-node
  • ha: master/standby
  • cluster: Redis Cluster
  • proxy: Proxy Cluster
+

launched_at

+

String

+

Time when the instance started running.

+

available_zones

+

Array

+

AZ where a cache node resides. The value of this parameter in the response contains an AZ ID.

+

subnet_id

+

String

+

Subnet ID.

+

security_group_id

+

String

+

Security group ID.

+

backend_addrs

+

String

+

Backend address of a cluster instance.

+

cloud_service_type_code

+

String

+

Cloud service type code.

+

cloud_resource_type_code

+

String

+

Cloud resource type code.

+

product_id

+

String

+

Product ID.

+

security_group_name

+

String

+

Security group name.

+

subnet_name

+

String

+

Subnet name.

+

subnet_cidr

+

String

+

Subnet segment.

+

order_id

+

String

+

Order ID.

+

instance_backup_policy

+

Object

+

Backup policy.

+

This parameter is available for master/standby and cluster DCS instances. For details, see Table 3.

+

tags

+

Array of Objects

+

Instance tag key and value.

+

spec_code

+

String

+

Product specification code.

+

domain_name

+

String

+

Domain name of the instance.

+

readonlyDomainName

+

String

+

Read-only domain name.

+

readonly_domain_name

+

String

+

Read-only domain name.

+

freeze_scene

+

String

+

Scenario where the instance is frozen.

+

update_at

+

String

+

Update time.

+

task_status

+

String

+

Task status.

+

is_free

+

Boolean

+

Whether the instance is free of charge.

+

az_codes

+

Array of strings

+

AZs with available resources.

+

crr_role

+

String

+

Role in cross-region DR.

+

inquery_spec_code

+

String

+

Product specification code.

+

support_slow_log_flag

+

String

+

Whether slow query logs are supported.

+

ipv6

+

String

+

IPv6 address.

+

enable_ipv6

+

Boolean

+

Whether IPv6 is enabled.

+

description

+

String

+

Instance description.

+

db_number

+

int

+

Number of databases in the instance.

+

support_acl

+

Boolean

+

Whether ACL is supported.

+

task

+

String

+

Task response.

+

enterprise_project_name

+

String

+

Enterprise project name.

+

sharding_count

+

int

+

Number of shards.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 instance_backup_policy

Parameter

+

Type

+

Description

+

backup_policy_id

+

String

+

Backup policy ID.

+

created_at

+

String

+

Creation time.

+

updated_at

+

String

+

Update time.

+

policy

+

Object

+

For details, see Table 3 and Table 4.

+

tenant_id

+

String

+

Tenant ID.

+
+
+

Example response

+

+
+
{
+   "free":null,
+   "max_memory":1024,
+   "used_memory":1,
+   "instance_id":"f1da146b-f567-411a-a4c2-276fb831ca28",
+   "name":"Test-DCS-Single-9e210c64",
+   "resource_spec_code":"redis.single.xu1.large.1",
+   "spec_code":"redis.single.xu1.large.1",
+   "engine":"Redis","engine_version":"4.0",
+   "internal_version":null,
+   "charging_mode":0,
+   "capacity":1,
+   "capacity_minor":null,
+   "vpc_id":"e5d38406-43ca-447f-9564-90953f10313f",
+   "vpc_name":"vpc-testing",
+   "ip":"192.168.1.144",
+   "domainName":"redis-f1da146b-f567-411a-a4c2-276fb831ca28.dcs.com",
+   "domain_name":"redis-f1da146b-f567-411a-a4c2-276fb831ca28.dcs.com",
+   "readonlyDomainName":null,
+   "readonly_domain_name":null,
+   "port":6379,
+   "status":"RUNNING",
+   "freeze_scene":null,
+   "created_at":"2021-04-18T18:55:43.509Z",
+   "update_at":"2021-04-18T18:56:06.519Z",
+   "error_code":null,
+   "user_id":"e96cb82994ef49648c2bfad79455b0ef",
+   "user_name":"lboka",
+   "maintain_begin":"02:00:00",
+   "maintain_end":"06:00:00",
+   "no_password_access":"false",
+   "access_user":null,
+   "enable_publicip":false,
+   "publicip_id":null,
+   "publicip_address":null,
+   "enable_ssl":false,
+   "service_upgrade":false,
+   "service_task_id":"",
+   "enterprise_project_id":null,
+   "security_group_id":null,
+   "tags":[],
+   "subnet_id":"a2c02283-2e2d-45f5-a9a0-7a8fb8d0d0a7",
+   "product_type":"generic",
+   "cpu_type":"x86_64",
+   "storage_type":"DRAM",
+   "task_status":null,
+   "launched_at":"2021-04-18T18:56:06.532Z",
+   "is_free":null,
+   "libos":false,
+   "cache_mode":"single",
+   "available_zones":["eu-de-02"],
+   "az_codes":["eu-de-02"],
+   "backend_addrs":null,
+   "crr_role":null,
+   "cloud_service_type_code":"otc.service.type.dcs",
+   "cloud_resource_type_code":"otc.resource.type.dcs3",
+   "inquery_spec_code":"redis.single.xu1.large.1",
+   "support_slow_log_flag":null,
+   "ipv6":null,
+   "enable_ipv6":false,
+   "description":"robot test-cases",
+   "db_number":0,
+   "features":{
+   "support_acl":true
+   },
+   "product_id":"redis.single.xu1.large.1-h",
+   "security_group_name":null,
+   "subnet_name":"subnet-testing",
+   "order_id":null,
+   "subnet_cidr":"192.168.1.0/24",
+   "task":null,
+   "instance_backup_policy":null,
+   "enterprise_project_name":null,
+   "sharding_count":0
+}
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

Specified instance queried successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312006.html b/docs/dcs/api-ref/dcs-api-0312006.html new file mode 100644 index 00000000..47b0febd --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312006.html @@ -0,0 +1,521 @@ + + +

Querying All DCS Instances of a Tenant

+

Function

This API is used to query DCS instances of a tenant, and allows you to specify query criteria.

+
+

URI

GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

start

+

Integer

+

No

+

Start number for querying DCS instances. It cannot be lower than 1.

+

By default, the start number is 1.

+

limit

+

Integer

+

No

+

Number of DCS instances displayed on each page.

+

Minimum value: 1

+

Maximum value: 2000

+

If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page.

+

name

+

String

+

No

+

DCS instance name.

+

id

+

String

+

No

+

Instance ID.

+

status

+

String

+

No

+

DCS instance status. For details about status, see DCS Instance Statuses.

+

ip

+

String

+

No

+

IP address for connecting to the DCS instance

+

isExactMatchName

+

String

+

No

+

An indicator of whether to perform an exact or fuzzy match based on instance name.

+

Options:

+
  • true: exact match
  • false: fuzzy match
+

Default value: false.

+

tags

+

Array of Objects

+

No

+

Query based on the instance tag key and value. {key} indicates the tag key, and {value} indicates the tag value.

+

To query instances with multiple tag keys and values, separate key-value pairs with commas (,).

+
+
+
+

Example

+
GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&isExactMatchName=false
+
+

Request

Request parameters

+

None

+

Example request

+

None

+
+

Response

Response parameters

+
Table 2 describes the response parameters. +
+ + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

instances

+

Array

+

Array of DCS instance details.

+

instance_num

+

Integer

+

Number of DCS instances.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Parameter description of the instance array

Parameter

+

Type

+

Description

+

name

+

String

+

DCS instance name.

+

engine

+

String

+

Cache engine.

+

capacity

+

Integer

+

Cache capacity.

+

Unit: GB.

+

ip

+

String

+

IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.

+

domainName

+

String

+

Domain name of the instance.

+

port

+

Integer

+

Port number of the cache node.

+

status

+

String

+

Cache instance status. For details about status, see DCS Instance Statuses.

+

max_memory

+

Integer

+

Overall memory size.

+

Unit: MB.

+

used_memory

+

Integer

+

Size of the used memory.

+

Unit: MB.

+

instance_id

+

String

+

DCS instance ID.

+

resource_spec_code

+

String

+

Resource specifications.

+

For example:

+
  • dcs.single_node: indicates a DCS instance in single-node mode.
  • dcs.master_standby: indicates a DCS instance in master/standby mode.
  • dcs.cluster: indicates a DCS instance in cluster mode.
+

engine_version

+

String

+

Cache engine version.

+

internal_version

+

String

+

Internal DCS version.

+

charging_mode

+

Integer

+

Billing mode. 0: pay-per-use.

+

capacity_minor

+

String

+

Small-scale cache capacity. Unit: GB.

+

vpc_id

+

String

+

VPC ID.

+

vpc_name

+

String

+

VPC name.

+

created_at

+

String

+

Time at which the DCS instance is created. For example, 2017-03-31T12:24:46.297Z.

+

error_code

+

String

+

Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see Error Codes.

+

user_id

+

String

+

User ID.

+

user_name

+

String

+

Username.

+

maintain_begin

+

String

+

Time at which the maintenance time window starts. Format: hh:mm:ss.

+

maintain_end

+

String

+

Time at which the maintenance time window ends. Format: hh:mm:ss.

+

no_password_access

+

String

+

An indicator of whether a DCS instance can be accessed in password-free mode.

+
  • true: indicates that a DCS instance can be accessed without a password.
  • false: indicates that a DCS instance can be accessed only after password authentication.
+

access_user

+

String

+

Username used for accessing a DCS instance with password authentication.

+

enable_publicip

+

Boolean

+

An indicator of whether public access is enabled for a DCS Redis instance.

+
  • true: enabled.
  • false: disabled.
+

publicip_address

+

String

+

Elastic IP address bound to a DCS Redis instance.

+

The parameter value is null if public access is disabled.

+

publicip_id

+

String

+

ID of the elastic IP address bound to a DCS Redis instance.

+

The parameter value is null if public access is disabled.

+

enable_ssl

+

Boolean

+

An indicator of whether to enable SSL for public access to a DCS Redis instance.

+
  • true: enabled.
  • false: disabled.
+

service_upgrade

+

Boolean

+

An indicator of whether an upgrade task has been created for a DCS instance.

+
  • true: yes.
  • false: no.
+

service_task_id

+

String

+

Upgrade task ID.

+
  • If the value of service_upgrade is set to true, the value of this parameter is the ID of the upgrade task.
  • If the value of service_upgrade is set to false, the value of this parameter is empty.
+

security_group_id

+

String

+

Security group name.

+

tags

+

Array of Objects

+

Instance tag key and value.

+

spec_code

+

String

+

Product specification code.

+

domain_name

+

String

+

Domain name of the instance.

+

readonlyDomainName

+

String

+

Read-only domain name.

+

readonly_domain_name

+

String

+

Read-only domain name.

+

freeze_scene

+

String

+

Scenario where the instance is frozen.

+

update_at

+

String

+

Update time. For example, 2017-03-31T12:24:46.297Z.

+

subnet_id

+

String

+

Subnet ID.

+
+
+

Example response

+
{"instances":[
+{
+       "max_memory":2048,
+       "used_memory":1,
+       "instance_id":"add1eee3-eaad-4975-a8d7-8cf853460e3d",
+       "name":"lboka-single-4",
+       "resource_spec_code":"redis.single.xu1.large.2",
+       "spec_code":"redis.single.xu1.large.2",
+       "engine":"Redis",
+       "engine_version":"4.0",
+       "internal_version":null,
+       "charging_mode":0,
+       "capacity":2,
+       "capacity_minor":null,
+       "vpc_id":"9d3938d4-d622-48f3-ab62-23f8ff8b7830",
+       "vpc_name":null,
+       "ip":"192.168.1.91",
+       "domainName":"redis-add1eee3-eaad-4975-a8d7-8cf853460e3d.dcs.com",
+       "domain_name":"redis-add1eee3-eaad-4975-a8d7-8cf853460e3d.dcs.com",
+       "readonlyDomainName":null,
+       "readonly_domain_name":null,
+       "port":6379,
+       "status":"RUNNING",
+       "freeze_scene":null,
+       "created_at":"2021-04-18T13:36:44.144Z",
+       "update_at":"2021-04-18T13:37:10.575Z",
+       "error_code":null,
+       "user_id":"e96cb82994ef49648c2bfad79455b0ef",
+       "user_name":"lboka",
+       "maintain_begin":"02:00:00",
+       "maintain_end":"06:00:00",
+       "no_password_access":"false",
+       "access_user":null,
+       "enable_publicip":false,
+       "publicip_id":null,
+       "publicip_address":null,
+       "enable_ssl":false,
+       "service_upgrade":false,
+       "service_task_id":"",
+       "security_group_id":null,
+       "tags":null,
+       "subnet_id":"fd47ed9c-78a9-44c5-a712-06d251381e04"},
+   ],
+"instance_num":1
+}
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

All DCS instances of the tenant queried successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312007.html b/docs/dcs/api-ref/dcs-api-0312007.html new file mode 100644 index 00000000..7f6a3e00 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312007.html @@ -0,0 +1,182 @@ + + +

Modifying Information About a DCS Instance

+

Function

This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, and security group.

+
+

URI

PUT /v1.0/{project_id}/instances/{instance_id}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

name

+

String

+

No

+

DCS instance name.

+

An instance name can contain 4 to 64 characters, including letters, digits, underscores (_), and hyphens (-), and must start with a letter.

+

description

+

String

+

No

+

Brief description of the DCS instance.

+

A brief description supports up to 1024 characters.

+
NOTE:

"\" is defined as an escape character in the queue description. If you need to enter a backward slash (\) or a double quotation mark (") in the queue description, enter \\ or \".

+
+

instance_backup_policy

+

Object

+

No

+

Backup policy.

+

This parameter is available for master/standby and cluster DCS instances. For details, see Table 3 and Table 4.

+

maintain_begin

+

String

+

No

+

Time at which the maintenance time window starts.

+

Format: hh:mm:ss.

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
  • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
  • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_begin is left blank, parameter maintain_end is also blank.
+

maintain_end

+

String

+

No

+

Time at which the maintenance time window ends.

+

Format: hh:mm:ss.

+
  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
+
  • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
  • Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank.
+

security_group_id

+

String

+

No

+

Security group ID.

+

The value can be obtained from the VPC console or the API.

+

This parameter is supported only by DCS Redis 3.0 instances.

+
+
+
+

Example request

+

Request URL:

+
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
+ +
+

Response

Response parameters

+

None

+

Example response

+

None

+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

204

+

DCS instance modified successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312008.html b/docs/dcs/api-ref/dcs-api-0312008.html new file mode 100644 index 00000000..299bf99b --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312008.html @@ -0,0 +1,75 @@ + + +

Deleting a Single DCS Instance

+

Function

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

+
+

URI

DELETE /v1.0/{project_id}/instances/{instance_id}

+
Table 1 describes the parameter. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

Instance ID.

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+

Request URL:

+
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
+
+

Response

Response parameters

+

None

+

Example response

+

None

+
+

Status Code

Table 2 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 2 Status code

Status Code

+

Description

+

204

+

DCS instances deleted successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312009.html b/docs/dcs/api-ref/dcs-api-0312009.html new file mode 100644 index 00000000..d9178e8e --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312009.html @@ -0,0 +1,169 @@ + + +

Batch Deleting DCS Instances

+

Function

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

+
+

URI

DELETE /v1.0/{project_id}/instances?allFailure={allFailure}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

allFailure

+

String

+

No

+

An indicator of whether all DCS instances failed to be created will be deleted. Options:

+

Options:

+
  • true: all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty.
  • false or other values: The DCS instances specified by the instances parameter in the API request will be deleted.
+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

instances

+

Array

+

No

+

IDs of DCS instances to be deleted.

+

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

+

A maximum of 50 instances can be deleted at a time.

+
+
+
+

Request URL:

+
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure}
+

Example request with allFailure set to false:

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

Response

Response parameters

+
If the value of the allFailure parameter in the URI is false, an empty response is then returned. If the value of the allFailure parameter in the URI is true, a response containing the parameter in Table 3 is returned. +
+ + + + + + + + + +
Table 3 Parameter description

Parameter

+

Type

+

Description

+

results

+

Array

+

For details about how to delete an instance, see Table 4.

+
+
+
+ +
+ + + + + + + + + + + + + +
Table 4 results parameter description

Parameter

+

Type

+

Description

+

instance

+

String

+

DCS instance ID.

+

result

+

String

+

Instance deletion result. Options: success and failed

+
+
+

Example response

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

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + + + + +
Table 5 Status codes

Status Code

+

Description

+

200

+

DCS instances deleted successfully.

+

204

+

DCS instances that failed to be created are cleared successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312010.html b/docs/dcs/api-ref/dcs-api-0312010.html new file mode 100644 index 00000000..deccec5e --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312010.html @@ -0,0 +1,115 @@ + + +

Scaling Up a DCS Instance

+

Function

This API is used to scale up a DCS Redis instance in the Running state.

+
+

URI

POST /v1.0/{project_id}/instances/{instance_id}/extend

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

Instance ID.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

new_capacity

+

Integer

+

Yes

+

New specification (memory space) of the DCS instance. The new specification to which the DCS instance will be scaled up must be greater than the current specification. Unit: GB.

+

spec_code

+

String

+

Yes

+

DCS instance specification code.

+

This parameter is optional for DCS Redis 3.0 instances.

+

This parameter is mandatory for DCS Redis 4.0 and Redis 5.0 instances.

+
+
+
+

Example request

+ + +
+

Response

Response parameters

+

None

+

Example response

+

None

+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

204

+

Scale-up task submitted successfully.

+
+
+
+
+
+
+
Parent topic: Lifecycle Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312013.html b/docs/dcs/api-ref/dcs-api-0312013.html new file mode 100644 index 00000000..e165f940 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312013.html @@ -0,0 +1,13 @@ + + +

Parameter Management APIs

+
+
+ +
+ diff --git a/docs/dcs/api-ref/dcs-api-0312014.html b/docs/dcs/api-ref/dcs-api-0312014.html new file mode 100644 index 00000000..f8aa6fcf --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312014.html @@ -0,0 +1,202 @@ + + +

Querying Statistics of All Running Instances

+

Function

This API is used to query the statistics of all DCS instances that are in the Running state.

+
+

URI

GET /v1.0/{project_id}/instances/statistic

+
Table 1 describes the parameter. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/statistic
+
+

Response

Response parameters

+
Table 2 describes the response parameter. +
+ + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

statistics

+

Array

+

Statistics of all instances in the Running state. For details, see Table 3.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 statistics parameter description

Parameter

+

Type

+

Description

+

keys

+

Integer

+

Number of cached data records

+

instance_id

+

String

+

DCS instance ID

+

used_memory

+

Integer

+

Size of the used memory in MB

+

max_memory

+

Integer

+

Overall memory size in MB

+

cmd_get_count

+

Integer

+

Number of times the GET command is run

+

cmd_set_count

+

Integer

+

Number of times the SET command is run

+

used_cpu

+

String

+

Percentage of CPU usage

+

input_kbps

+

String

+

Incoming traffic (kbit/s) of the DCS instance

+

output_kbps

+

String

+

Outgoing traffic (kbit/s) of the DCS instance

+
+
+
Example response
{
+    "statistics" : [{
+            "keys" : 0,
+            "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a",
+            "used_memory" : 0,
+            "max_memory" : 460,
+            "cmd_get_count" : 0,
+            "cmd_set_count" : 0,
+            "used_cpu" : "0.0",
+            "input_kbps" : "0.0",
+            "output_kbps" : "0.0"
+        }, {
+            "keys" : 0,
+            "instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac",
+            "used_memory" : 0,
+            "max_memory" : 460,
+            "cmd_get_count" : 0,
+            "cmd_set_count" : 0,
+            "used_cpu" : "0.0",
+            "input_kbps" : "0.0",
+            "output_kbps" : "0.0"
+        }, {
+            "keys" : 0,
+            "instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207",
+            "used_memory" : 0,
+            "max_memory" : 460,
+            "cmd_get_count" : 0,
+            "cmd_set_count" : 0,
+            "used_cpu" : "0.0",
+            "input_kbps" : "0.03",
+            "output_kbps" : "1.19"
+        }, {
+            "keys" : 0,
+            "instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba",
+            "used_memory" : 0,
+            "max_memory" : 6963,
+            "cmd_get_count" : 0,
+            "cmd_set_count" : 0,
+            "used_cpu" : "0.0",
+            "input_kbps" : "0.0",
+            "output_kbps" : "0.0"
+        }
+    ]
+}
+
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

Statistics of all instances queried successfully.

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

Querying Configuration Parameters

+

Function

This API is used to query the configuration parameters of a DCS instance.

+
+

URI

GET /v1.0/{project_id}/instances/{instance_id}/configs

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

ID of the instance to be queried.

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
+
+

Response

Response parameters

+
Table 2 describes the response parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

status

+

String

+

Current status of a DCS instance.

+

instance_id

+

String

+

DCS instance ID.

+

redis_config

+

Array

+

Array of configuration items of the DCS instance. For details, see Table 3.

+

config_status

+

String

+

DCS instance status that is being modified or has been modified. Options:

+
  • UPDATING
  • FAILURE
  • SUCCESS
+

config_time

+

String

+

Time at which the DCS instance is operated on. For example, 2017-03-31T12:24:46.297Z.

+

cluster_v1

+

Boolean

+

Instance type. If true is returned, the instance is a Proxy Cluster DCS Redis 3.0 instance. If false is returned, the instance is not a Proxy Cluster DCS Redis 3.0 instance.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 redis_config parameter description

Parameter

+

Type

+

Description

+

description

+

String

+

Configuration item description.

+

param_id

+

String

+

Configuration parameter ID. For the possible values, see the Parameter ID column in Table 4.

+

param_name

+

String

+

Configuration parameter name. For the possible values, see the Parameter Name column in Table 4.

+

param_value

+

String

+

Configuration parameter value.

+

default_value

+

String

+

Default value of the configuration parameter. For the possible values, see the Default Value column in Table 4.

+

value_type

+

String

+

Type of the configuration parameter value. For the possible values, see the Value Type column in Table 4.

+

value_range

+

String

+

Range of the configuration parameter value. For the possible values, see the Value Range column in Table 4.

+

node_role

+

String

+

If null or empty is returned, the node is a default node, that is, the Redis Server node. If proxy is returned, the node is a proxy node.

+
+
+

Table 4 describes the configuration parameters of a DCS instance.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Configuration parameters of a DCS instance

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

1

+

timeout

+

Integer

+

Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.

+

0–7200 seconds

+

0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

volatile-lfu

+

allkeys-lfu

+

noeviction or volatile-lru

+

The value range and default value depend on the instance version and type.

+

3

+

hash-max-ziplist-entries

+

Integer

+

When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

512

+

4

+

hash-max-ziplist-value

+

Integer

+

When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

64

+

5

+

list-max-ziplist-entries

+

Integer

+

When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.

+

1–10,000

+

512

+

6

+

list-max-ziplist-value

+

Integer

+

When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.

+

1–10,000

+

64

+

7

+

set-max-intset-entries

+

Integer

+

When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.

+

1–10,000

+

512

+

8

+

zset-max-ziplist-entries

+

Integer

+

When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.

+

1–10,000

+

128

+

9

+

zset-max-ziplist-value

+

Integer

+

When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.

+

1–10,000

+

64

+

10

+

latency-monitor-threshold

+

IntegerInteger

+

The minimum amount of latency that will be logged as latency spikes

+

If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.

+

By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.

+

0–86,400,000 ms

+

0

+

11

+

maxclients

+

Integer

+

The maximum number of clients allowed to be concurrently connected to a DCS instance.

+

1000–50,000

+

10,000

+

12

+

reserved-memory

+

Integer

+

Reserved memory, which is the number of megabytes reserved for the backend to perform internal processing such as persistence and master/standby replication.

+

This parameter is available only for master/standby instances.

+

The size of the reserved memory can be adjusted, but must be in the value range described in the next column. For more information about maximum available memory of each instance type, see Distributed Cache Service User Guide.

+

0% to 50% of maximum memory space initially available to the instance and below the current free memory space. Unit: MB.

+

0

+

13

+

notify-keyspace-events

+

String

+

Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.

+

If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.

+

K: Keyspace events, published with the __keyspace@__ prefix

+

E: Keyevent events, published with the __keyevent@__ prefix

+

g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME

+

$: String commands

+

l: List commands

+

s: Set commands

+

h: Hash commands

+

z: Sorted set commands

+

x: Expired events (events generated every time a key expires)

+

e: Evicted events (events generated when a key is evicted for maxmemory)

+

For more information, see the following note.

+

Ex

+

14

+

repl-backlog-size

+

Integer

+

The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.

+

16,384–1,073,741,824

+

1,048,576

+

15

+

repl-backlog-ttl

+

Integer

+

The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.

+

0–604,800

+

3600

+

16

+

appendfsync

+

String

+

Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.

+

Redis calls fsync() in one of the following ways:

+

no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.

+

always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.

+

everysec

+

17

+

appendonly

+

String

+

Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.

+

yes,no

+

yes

+

18

+

slowlog-log-slower-than

+

Integer

+

Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.

+

0–1,000,000

+

10,000

+

19

+

slowlog-max-len

+

Integer

+

The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.

+

0–1000

+

128

+

20

+

lua-time-limit

+

Integer

+

The maximum time allowed for executing a Lua script, in milliseconds.

+

100–5000

+

5000

+

21

+

repl-timeout

+

Integer

+

Replication timeout, in seconds.

+

30–3600

+

60

+

22

+

proto-max-bulk-len

+

Integer

+

The maximum size (in bytes) of a single element request.

+

1,048,576–536,870,912

+

536,870,912

+

23

+

master-read-only

+

String

+

Sets the instance to be read-only. All write operations will fail.

+

yes,no

+

no

+

24

+

client-output-buffer-slave-soft-limit

+

Integer

+

Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.

+

0–134,217,728

+

13,421,772

+

25

+

client-output-buffer-slave-hard-limit

+

Integer

+

Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.

+

0–134,217,728

+

13,421,772

+

26

+

client-output-buffer-limit-slave-soft-seconds

+

Integer

+

Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.

+

0–60

+

60

+

30

+

reserved-memory-percent

+

Integer

+

Percentage of memory reserved for non-cache memory usage.

+

0–80

+

0

+
+
+

Table 5, Table 6, Table 7, Table 8, Table 9, and Table 10 describe the configuration parameters of different DCS instances.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Configuration parameters of a single-node DCS Redis 3.0 instance

Instance Type

+

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

Single-node Redis 3.0

+

1

+

timeout

+

Integer

+

Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.

+

0–7200 seconds

+

0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

noeviction

+

3

+

hash-max-ziplist-entries

+

Integer

+

When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

512

+

4

+

hash-max-ziplist-value

+

Integer

+

When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

64

+

5

+

list-max-ziplist-entries

+

Integer

+

When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.

+

1–10,000

+

512

+

6

+

list-max-ziplist-value

+

Integer

+

When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.

+

1–10,000

+

64

+

7

+

set-max-intset-entries

+

Integer

+

When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.

+

1–10,000

+

512

+

8

+

zset-max-ziplist-entries

+

Integer

+

When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.

+

1–10,000

+

128

+

9

+

zset-max-ziplist-value

+

Integer

+

When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.

+

1–10,000

+

64

+

10

+

latency-monitor-threshold

+

Integer

+

The minimum amount of latency that will be logged as latency spikes

+

If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.

+

By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.

+

0–86,400,000 ms

+

0

+

13

+

notify-keyspace-events

+

String

+

Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.

+

If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.

+

K: Keyspace events, published with the __keyspace@__ prefix

+

E: Keyevent events, published with the __keyevent@__ prefix

+

g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME

+

$: String commands

+

l: List commands

+

s: Set commands

+

h: Hash commands

+

z: Sorted set commands

+

x: Expired events (events generated every time a key expires)

+

e: Evicted events (events generated when a key is evicted for maxmemory)

+

For more information, see the note below the table.

+

Ex

+

18

+

slowlog-log-slower-than

+

Integer

+

Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.

+

0–1,000,000

+

10,000

+

19

+

slowlog-max-len

+

Integer

+

The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.

+

0–1000

+

128

+

30

+

reserved-memory-percent

+

Integer

+

Percentage of memory reserved for non-cache memory usage.

+

0–80

+

0

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Configuration parameters of a master/standby DCS Redis 3.0 instance

Instance Type

+

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

Master/standby Redis 3.0

+

1

+

timeout

+

Integer

+

Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.

+

0–7200 seconds

+

0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

noeviction

+

3

+

hash-max-ziplist-entries

+

Integer

+

When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

512

+

4

+

hash-max-ziplist-value

+

Integer

+

When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

64

+

5

+

list-max-ziplist-entries

+

Integer

+

When the number of entries in lists is less than the value of this parameter, lists are encoded using ziplist to save memory.

+

1–10,000

+

512

+

6

+

list-max-ziplist-value

+

Integer

+

When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using ziplist to save memory.

+

1–10,000

+

64

+

7

+

set-max-intset-entries

+

Integer

+

When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.

+

1–10,000

+

512

+

8

+

zset-max-ziplist-entries

+

Integer

+

When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.

+

1–10,000

+

128

+

9

+

zset-max-ziplist-value

+

Integer

+

When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.

+

1–10,000

+

64

+

10

+

latency-monitor-threshold

+

Integer

+

The minimum amount of latency that will be logged as latency spikes

+

If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.

+

By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.

+

0–86,400,000 ms

+

0

+

13

+

notify-keyspace-events

+

String

+

Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.

+

If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.

+

K: Keyspace events, published with the __keyspace@__ prefix

+

E: Keyevent events, published with the __keyevent@__ prefix

+

g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME

+

$: String commands

+

l: List commands

+

s: Set commands

+

h: Hash commands

+

z: Sorted set commands

+

x: Expired events (events generated every time a key expires)

+

e: Evicted events (events generated when a key is evicted for maxmemory)

+

For more information, see the following note.

+

Ex

+

14

+

repl-backlog-size

+

Integer

+

The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.

+

16,384–1,073,741,824

+

1,048,576

+

15

+

repl-backlog-ttl

+

Integer

+

The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.

+

0–604,800

+

3600

+

16

+

appendfsync

+

String

+

Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.

+

Redis calls fsync() in one of the following ways:

+

no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.

+

always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.

+

everysec

+

17

+

appendonly

+

String

+

Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.

+

yes,no

+

yes

+

18

+

slowlog-log-slower-than

+

Integer

+

Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.

+

0–1,000,000

+

10,000

+

19

+

slowlog-max-len

+

Integer

+

The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.

+

0–1000

+

128

+

30

+

reserved-memory-percent

+

Integer

+

Percentage of memory reserved for non-cache memory usage.

+

0–80

+

0

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Configuration parameters of a Proxy Cluster DCS Redis 3.0 instance

Instance Type

+

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

Proxy Cluster Redis 3.0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

volatile-lru

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Configuration parameters of a single-node DCS Redis 4.0 or 5.0 instance

Instance Type

+

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

Single-node Redis 4.0 or 5.0

+

1

+

timeout

+

Integer

+

Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.

+

0–7200 seconds

+

0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

volatile-lfu

+

allkeys-lfu

+

volatile-lru

+

3

+

hash-max-ziplist-entries

+

Integer

+

When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

512

+

4

+

hash-max-ziplist-value

+

Integer

+

When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

64

+

7

+

set-max-intset-entries

+

Integer

+

When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.

+

1–10,000

+

512

+

8

+

zset-max-ziplist-entries

+

Integer

+

When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.

+

1–10,000

+

128

+

9

+

zset-max-ziplist-value

+

Integer

+

When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.

+

1–10,000

+

64

+

10

+

latency-monitor-threshold

+

Integer

+

The minimum amount of latency that will be logged as latency spikes

+

If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.

+

By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.

+

0–86,400,000 ms

+

0

+

11

+

maxclients

+

Integer

+

The maximum number of clients allowed to be concurrently connected to a DCS instance.

+

1000–50,000

+

10,000

+

13

+

notify-keyspace-events

+

String

+

Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.

+

If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.

+

K: Keyspace events, published with the __keyspace@__ prefix

+

E: Keyevent events, published with the __keyevent@__ prefix

+

g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME

+

$: String commands

+

l: List commands

+

s: Set commands

+

h: Hash commands

+

z: Sorted set commands

+

x: Expired events (events generated every time a key expires)

+

e: Evicted events (events generated when a key is evicted for maxmemory)

+

For more information, see the following note.

+

Ex

+

18

+

slowlog-log-slower-than

+

Integer

+

Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.

+

0–1,000,000

+

10,000

+

19

+

slowlog-max-len

+

Integer

+

The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.

+

0–1000

+

128

+

20

+

lua-time-limit

+

Integer

+

The maximum time allowed for executing a Lua script, in milliseconds.

+

100–5000

+

5000

+

22

+

proto-max-bulk-len

+

Integer

+

The maximum size (in bytes) of a single element request.

+

1,048,576–536,870,912

+

536,870,912

+

23

+

master-read-only

+

String

+

Sets the instance to be read-only. All write operations will fail.

+

yes,no

+

no

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 Configuration parameters of a master/standby DCS Redis 4.0 or 5.0 instance

Instance Type

+

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

Master/standby Redis 4.0 or 5.0

+

1

+

timeout

+

Integer

+

Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.

+

0–7200 seconds

+

0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

volatile-lfu

+

allkeys-lfu

+

volatile-lru

+

3

+

hash-max-ziplist-entries

+

Integer

+

When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

512

+

4

+

hash-max-ziplist-value

+

Integer

+

When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

64

+

7

+

set-max-intset-entries

+

Integer

+

When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.

+

1–10,000

+

512

+

8

+

zset-max-ziplist-entries

+

Integer

+

When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.

+

1–10,000

+

128

+

9

+

zset-max-ziplist-value

+

Integer

+

When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.

+

1–10,000

+

64

+

10

+

latency-monitor-threshold

+

Integer

+

The minimum amount of latency that will be logged as latency spikes

+

If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.

+

By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.

+

0–86,400,000 ms

+

0

+

11

+

maxclients

+

Integer

+

The maximum number of clients allowed to be concurrently connected to a DCS instance.

+

1000–50,000

+

10,000

+

13

+

notify-keyspace-events

+

String

+

Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.

+

If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.

+

K: Keyspace events, published with the __keyspace@__ prefix

+

E: Keyevent events, published with the __keyevent@__ prefix

+

g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME

+

$: String commands

+

l: List commands

+

s: Set commands

+

h: Hash commands

+

z: Sorted set commands

+

x: Expired events (events generated every time a key expires)

+

e: Evicted events (events generated when a key is evicted for maxmemory)

+

For more information, see the note below the table.

+

Ex

+

14

+

repl-backlog-size

+

Integer

+

The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.

+

16,384–1,073,741,824

+

1,048,576

+

15

+

repl-backlog-ttl

+

IntegerInteger

+

The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.

+

0–604,800

+

3600

+

16

+

appendfsync

+

String

+

Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.

+

Redis calls fsync() in one of the following ways:

+

no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.

+

always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.

+

everysec

+

17

+

appendonly

+

String

+

Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.

+

yes,no

+

yes

+

18

+

slowlog-log-slower-than

+

Integer

+

Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.

+

0–1,000,000

+

10,000

+

19

+

slowlog-max-len

+

Integer

+

The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.

+

0–1000

+

128

+

20

+

lua-time-limit

+

Integer

+

The maximum time allowed for executing a Lua script, in milliseconds.

+

100–5000

+

5000

+

21

+

repl-timeout

+

Integer

+

Replication timeout, in seconds.

+

30–3600

+

60

+

22

+

proto-max-bulk-len

+

Integer

+

The maximum size (in bytes) of a single element request.

+

1,048,576–536,870,912

+

536,870,912

+

23

+

master-read-only

+

String

+

Sets the instance to be read-only. All write operations will fail.

+

yes,no

+

no

+

24

+

client-output-buffer-slave-soft-limit

+

Integer

+

Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.

+

0–134,217,728

+

13,421,772

+

25

+

client-output-buffer-slave-hard-limit

+

Integer

+

Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.

+

0–134,217,728

+

13,421,772

+

26

+

client-output-buffer-limit-slave-soft-seconds

+

Integer

+

Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.

+

0–60

+

60

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Configuration parameters of a Redis Cluster DCS Redis 4.0 or 5.0 instance

Instance Type

+

Parameter ID

+

Parameter Name

+

Type

+

Description

+

Value Range

+

Default Value

+

Redis 4.0 or 5.0 Redis cluster

+

1

+

timeout

+

Integer

+

Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled.

+

0–7200 seconds

+

0

+

2

+

maxmemory-policy

+

String

+

How Redis will select what to remove when maxmemory is reached.

+

For details about key eviction, see the Redis official website.

+

volatile-lru

+

allkeys-lru

+

volatile-random

+

allkeys-random

+

volatile-ttl

+

noeviction

+

volatile-lfu

+

allkeys-lfu

+

volatile-lru

+

3

+

hash-max-ziplist-entries

+

Integer

+

When the number of entries in hashes is less than the value of this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

512

+

4

+

hash-max-ziplist-value

+

Integer

+

When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using ziplist to save memory.

+

1–10,000

+

64

+

7

+

set-max-intset-entries

+

Integer

+

When a set is composed entirely of strings and the number of integers does not exceed the length threshold indicated by this parameter, the set is encoded using intset to save memory.

+

1–10,000

+

512

+

8

+

zset-max-ziplist-entries

+

Integer

+

When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure.

+

1–10,000

+

128

+

9

+

zset-max-ziplist-value

+

Integer

+

When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using ziplist to save memory.

+

1–10,000

+

64

+

10

+

latency-monitor-threshold

+

Integer

+

The minimum amount of latency that will be logged as latency spikes

+

If this parameter is set to 0, latency monitoring is disabled. If this parameter is set to a value greater than 0, all events blocking the server for a time greater than the configured value will be logged.

+

By running the LATENCY command, you can perform operations related to latency monitoring, such as obtaining statistical data, and configuring and enabling latency monitoring. For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/.

+

0–86,400,000 ms

+

0

+

11

+

maxclients

+

Integer

+

The maximum number of clients allowed to be concurrently connected to a DCS instance.

+

1000–50,000

+

10,000

+

13

+

notify-keyspace-events

+

String

+

Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified.

+

If the parameter value contains multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications.

+

K: Keyspace events, published with the __keyspace@__ prefix

+

E: Keyevent events, published with the __keyevent@__ prefix

+

g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME

+

$: String commands

+

l: List commands

+

s: Set commands

+

h: Hash commands

+

z: Sorted set commands

+

x: Expired events (events generated every time a key expires)

+

e: Evicted events (events generated when a key is evicted for maxmemory)

+

For more information, see the note below the table.

+

Ex

+

14

+

repl-backlog-size

+

Integer

+

The replication backlog size in bytes. The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected.

+

16,384–1,073,741,824

+

1,048,576

+

15

+

repl-backlog-ttl

+

Integer

+

The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value 0 indicates that the backlog is never released.

+

0–604,800

+

3600

+

16

+

appendfsync

+

String

+

Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt.

+

Redis calls fsync() in one of the following ways:

+

no: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance.

+

always: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. everysec: fsync() is called once per second. This mode provides a compromise between safety and performance.

+

everysec

+

17

+

appendonly

+

String

+

Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure.

+

yes,no

+

yes

+

18

+

slowlog-log-slower-than

+

Integer

+

Redis uses the slow log to record queries that exceed a specified execution time. slowlog-log-slower-than is the maximum time allowed, in microseconds, for command execution. If this threshold is exceeded, Slow Log will record the command.

+

0–1,000,000

+

10,000

+

19

+

slowlog-max-len

+

Integer

+

The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command.

+

0–1000

+

128

+

20

+

lua-time-limit

+

Integer

+

The maximum time allowed for executing a Lua script, in milliseconds.

+

100–5000

+

5000

+

21

+

repl-timeout

+

Integer

+

Replication timeout, in seconds.

+

30–3600

+

60

+

22

+

proto-max-bulk-len

+

Integer

+

The maximum size (in bytes) of a single element request.

+

1,048,576–536,870,912

+

536,870,912

+

23

+

master-read-only

+

String

+

Sets the instance to be read-only. All write operations will fail.

+

yes,no

+

no

+

24

+

client-output-buffer-slave-soft-limit

+

Integer

+

Soft limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the soft limit and continuously remains above the limit for the time specified by the client-output-buffer-limit-slave-soft-seconds parameter, the client is disconnected.

+

0–134,217,728

+

13,421,772

+

25

+

client-output-buffer-slave-hard-limit

+

Integer

+

Hard limit (in bytes) on the output buffer of replica clients. Once the output buffer exceeds the hard limit, the client is immediately disconnected.

+

0–134,217,728

+

13,421,772

+

26

+

client-output-buffer-limit-slave-soft-seconds

+

Integer

+

Number of seconds that the output buffer remains above client-output-buffer-slave-soft-limit before the client is disconnected.

+

0–60

+

60

+
+
+

More about the notify-keyspace-events parameter:

+
  • Allowed characters are K, E, KE, A, g, l, s, h, z, x, e, and $. The parameter value must contain either K or E.
  • A is an alias for g$lshzxe and cannot be used together with any of the characters in g$lshzxe.
  • For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events.
+
+
Example response
{
+    "status": "RUNNING",
+    "instance_id": "c08fdc6e-5c25-4185-ab57-c0a5529b727f",
+    "redis_config": [
+        {
+            "description": "How Redis will select what to remove when maxmemory is reached, You can select among five behaviors: volatile-lru : remove the key with an expire set using an LRU algorithm allkeys-lru : remove any key according to the LRU algorithm volatile-random: remove a random key with an expire set allkeys-random: remove a random key, any key volatile-ttl : remove the key with the nearest expire time (minor TTL) noeviction : don't expire at all, just return an error on write operations",
+            "param_id": 2,
+            "param_name": "maxmemory-policy",
+            "param_value": "noeviction",
+            "default_value": "noeviction",
+            "value_type": "String",
+            "value_range": "volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction"
+        },
+        {
+            "description": "Hashes are encoded using a memory efficient data structure when they have a small number of entries",
+            "param_id": 3,
+            "param_name": "hash-max-ziplist-entries",
+            "param_value": "512",
+            "default_value": "512",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "Hashes are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
+            "param_id": 4,
+            "param_name": "hash-max-ziplist-value",
+            "param_value": "64",
+            "default_value": "64",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "Lists are encoded using a memory efficient data structure when they have a small number of entries",
+            "param_id": 5,
+            "param_name": "list-max-ziplist-entries",
+            "param_value": "512",
+            "default_value": "512",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "Lists are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
+            "param_id": 6,
+            "param_name": "list-max-ziplist-value",
+            "param_value": "64",
+            "default_value": "64",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers.",
+            "param_id": 7,
+            "param_name": "set-max-intset-entries",
+            "param_value": "512",
+            "default_value": "512",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "Sorted sets are encoded using a memory efficient data structure when they have a small number of entries",
+            "param_id": 8,
+            "param_name": "zset-max-ziplist-entries",
+            "param_value": "128",
+            "default_value": "128",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "Sorted sets are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
+            "param_id": 9,
+            "param_name": "zset-max-ziplist-value",
+            "param_value": "64",
+            "default_value": "64",
+            "value_type": "Integer",
+            "value_range": "1-10000"
+        },
+        {
+            "description": "Close the connection after a client is idle for N seconds (0 to disable)",
+            "param_id": 1,
+            "param_name": "timeout",
+            "param_value": "0",
+            "default_value": "0",
+            "value_type": "Integer",
+            "value_range": "0-7200"
+        },
+        {
+            "description": "Only events that run in more time than the configured latency-monitor-threshold will be logged as latency spikes. If latency-monitor-threshold is set to 0, latency monitoring is disabled. If latency-monitor-threshold is set to a value greater than 0, all events blocking the server for a time equal to or greater than the configured latency-monitor-threshold will be logged.",
+            "param_id": 10,
+            "param_name": "latency-monitor-threshold",
+            "param_value": "0",
+            "default_value": "0",
+            "value_type": "Integer",
+            "value_range": "0-86400000"
+        },
+        {
+            "description": "The total memory, in bytes, reserved for non-data usage.",
+            "param_id": 12,
+            "param_name": "reserved-memory",
+            "param_value": "0",
+            "default_value": "0",
+            "value_type": "Integer",
+            "value_range": "0-6553"
+        },
+        {
+            "description": "Redis can notify Pub or Sub clients about events happening in the key space",
+            "param_id": 13,
+            "param_name": "notify-keyspace-events",
+            "param_value": null,
+            "default_value": null,
+            "value_type": "regular",
+            "value_range": "([KE]+([A]|[g$lshzxe]+)){0,11}"
+        }
+    ],
+    "config_status": "SUCCESS",
+    "config_time": ""
+}
+
+
+

Status Code

Table 11 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 11 Status code

Status Code

+

Description

+

200

+

Instance configurations queried successfully.

+
+
+
+
+
+
+
Parent topic: Parameter Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312016.html b/docs/dcs/api-ref/dcs-api-0312016.html new file mode 100644 index 00000000..e7ed9400 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312016.html @@ -0,0 +1,240 @@ + + +

Querying DCS Instance Status

+

Function

This API is used to query the number of instances in different states.

+
+

URI

GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

includeFailure

+

String

+

No

+

An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options:

+
  • true: The number of DCS instances that failed to be created will be returned to the API caller.
  • false or others: The number of DCS instances that failed to be created will not be returned to the API caller.
+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?includeFailure=true
+
+

Response

Response parameters

+
Table 2 describes the response parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

creating_count

+

Integer

+

Number of instances that are being created.

+

deleting_count

+

Integer

+

Number of instances that are being deleted.

+

running_count

+

Integer

+

Number of running instances.

+

error_count

+

Integer

+

Number of abnormal instances.

+

restarting_count

+

Integer

+

Number of instances that are being restarted.

+

createfailed_count

+

Integer

+

Number of instances that fail to be created.

+

extending_count

+

Integer

+

Number of instances that are being scaled up.

+

upgrading_count

+

Integer

+

Number of instances that are being upgraded.

+

paying_count

+

Integer

+

Number of instances for which payment is in progress.

+

migrating_count

+

Integer

+

Number of instances on which data migration is in progress.

+

flushing_count

+

Integer

+

Number of instances whose data is being cleared.

+

closed_count

+

Integer

+

Number of instances that have been stopped.

+

starting_count

+

Integer

+

Number of instances that are being started.

+

closing_count

+

Integer

+

Number of instances that are being stopped.

+

restoring_count

+

Integer

+

Number of instances for which data restoration is in progress.

+
+
+
+

Example response

+

+
{"memcached":{
+    "paying_count":0,
+    "migrating_count":0,
+    "error_count":0,
+    "restarting_count":0,
+    "createfailed_count":0,
+    "flushing_count":0,
+    "closed_count":0,
+    "extending_count":0,
+    "creating_count":0,
+    "starting_count":0,
+    "closing_count":0,
+    "running_count":0,
+    "upgrading_count":0,
+    "restoring_count":0
+   },
+"paying_count":0,
+"migrating_count":0,
+"error_count":0,
+"restarting_count":0,
+"createfailed_count":0,
+"flushing_count":0,
+"redis":{
+   "paying_count":0,
+   "migrating_count":0,
+   "error_count":0,
+   "restarting_count":0,
+   "createfailed_count":0,
+   "flushing_count":0,
+   "closed_count":0,
+   "extending_count":2,
+   "creating_count":0,
+   "starting_count":0,
+   "closing_count":0,
+   "running_count":1,
+   "upgrading_count":0,
+   "restoring_count":0
+   },
+"closed_count":0,
+"extending_count":2,
+"creating_count":0,
+"starting_count":0,
+"closing_count":0,
+"running_count":1,
+"upgrading_count":0,
+"restoring_count":0} 
+}
+
+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

200

+

Quantities of DCS instances in different statuses queried successfully.

+
+
+
+
+
+
+
Parent topic: Instance Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312017.html b/docs/dcs/api-ref/dcs-api-0312017.html new file mode 100644 index 00000000..94ba2f3d --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312017.html @@ -0,0 +1,150 @@ + + +

Modifying Configuration Parameters

+

Function

You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.

+
+

URI

PUT /v1.0/{project_id}/instances/{instance_id}/configs

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

ID of the instance to be modified.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

redis_config

+

Array

+

Yes

+

Array of configuration items of the DCS instance.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 redis_config parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

param_id

+

String

+

Yes

+

Configuration item ID.

+

param_name

+

String

+

Yes

+

Configuration item name.

+

param_value

+

String

+

Yes

+

Value of the configuration item.

+
+
+

For possible values of parameters in Table 3, see Table 4.

+

Example request

+ + +
+

Response

Response parameters

+

None

+

Example response

+

None

+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

204

+

DCS instance configurations modified successfully.

+
+
+
+
+
+
+
Parent topic: Parameter Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312018.html b/docs/dcs/api-ref/dcs-api-0312018.html new file mode 100644 index 00000000..af96347c --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312018.html @@ -0,0 +1,160 @@ + + +

Restarting DCS Instances or Clearing DCS Instance Data

+

Function

This API is used to restart a running DCS instance.

+

Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.

+
+

URI

PUT /v1.0/{project_id}/instances/status

+
Table 1 describes the parameter. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

action

+

String

+

Yes

+

Action performed on DCS instances. Options: restart, and flush.

+
NOTE:

Only DCS Redis 4.0 and 5.0 instances can be flushed.

+
+

instances

+

Array

+

Yes

+

List of DCS instance IDs.

+
+
+
+

Example request

+ + +
+

Response

Response parameters

+
Table 3 describes the response parameter. +
+ + + + + + + + + +
Table 3 Parameter description

Parameter

+

Type

+

Description

+

results

+

Array

+

Indicates the result of instance modification.

+
+
+
+ +
+ + + + + + + + + + + + + +
Table 4 results parameter description

Parameter

+

Type

+

Description

+

instance

+

String

+

DCS instance ID.

+

result

+

String

+

Instance modification result. Options: success or failed

+
+
+
Example response
{
+    "results": [
+        {
+            "result": "success",
+            "instance": "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
+        }
+    ]
+}
+
+
+

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

Successfully restarted DCS instance or cleared DCS instance data.

+
+
+
+
+
+
+
Parent topic: Instance Management APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312019.html b/docs/dcs/api-ref/dcs-api-0312019.html new file mode 100644 index 00000000..2a16da38 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312019.html @@ -0,0 +1,178 @@ + + +

Changing the Password of a DCS Instance

+

Function

This API is used to change the password of a DCS instance.

+
+

URI

PUT /v1.0/{project_id}/instances/{instance_id}/password

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

old_password

+

String

+

Yes

+

Old password.

+

new_password

+

String

+

Yes

+

New password.

+

Password complexity requirements:

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

Example request

+ + +
+

Response

Response parameters

+
Table 3 describes the response parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Parameter description

Parameter

+

Type

+

Description

+

result

+

String

+

An indicator of whether the password is successfully changed: Options:

+
  • Success: Password changed successfully.
  • passwordFailed: The old password is incorrect.
  • Locked: This account has been locked.
  • Failed: Failed to change the password.
+

message

+

String

+

Result of password change.

+

retry_times_left

+

String

+

Number of remaining password attempts. If the old password is incorrect, the value of this parameter is not null.

+

lock_time

+

String

+

Account lockout duration. If the old password is incorrect or the account is locked, the value of this parameter is not null.

+

lock_time_left

+

String

+

Remaining time before the account is unlocked. If the account is locked, the value of this parameter is not null.

+
+
+
+
Example response
//Change password success.
+{
+    "result" : "Success",
+    "message" : "Modify DCSInstance password success.",
+    "retry_times_left" : "5",
+    "lock_time" : "0",
+    "lock_time_left" : "0"
+}
+//Change password failed.
+{
+    "result" : "passwordFailed",
+    "message" : "verify password failed.",
+    "retry_times_left" : "4",
+    "lock_time" : "5",
+    "lock_time_left" : "5"
+}
+
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

Password changed successfully.

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

Backing Up a DCS Instance

+

Function

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

+

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

+
+
+

URI

POST /v1.0/{project_id}/instances/{instance_id}/backups

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

remark

+

String

+

No

+

Description of DCS instance backup.

+
+
+
+

Example request

+ + +
+

Response

Response parameters

+
Table 3 describes the response parameter. +
+ + + + + + + + + +
Table 3 Parameter description

Parameter

+

Type

+

Description

+

backup_id

+

String

+

ID of the backup record

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

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

Backup task created successfully.

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

Restoring a DCS Instance

+

Function

This API is used to restore a specified DCS instance.

+

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

+
+
+

URI

POST /v1.0/{project_id}/instances/{instance_id}/restores

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID.

+
+
+
+
+

Request

Request parameters

+
Table 2 describes the request parameters. +
+ + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

remark

+

String

+

No

+

Description of DCS instance restoration

+

backup_id

+

String

+

Yes

+

ID of the backup record

+
+
+
+

Example request

+
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores
+
{
+    "remark":"restore instance",
+    "backup_id":"8ba256cb-e5ac-44f6-a3da-c03d8f0e5029"
+}
+
+
+

Response

Response parameters

+
Table 3 describes the response parameter. +
+ + + + + + + + + +
Table 3 Parameter description

Parameter

+

Type

+

Description

+

restore_id

+

String

+

ID of the restoration record

+
+
+
+
Example response
{
+    "restore_id": "a6155972-800c-4170-a479-3231e907d2f6"
+}
+
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

Restoration task created successfully.

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

Querying DCS Instance Backup Records

+

Function

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

+
+

URI

GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID.

+

start

+

Integer

+

No

+

Start sequence number of the backup record that is to be queried. By default, this parameter is set to 1.

+

limit

+

Integer

+

No

+

Number of backup records displayed on each page. The minimum value of this parameter is 1. If this parameter is not set, 10 backup records are displayed on each page by default.

+

beginTime

+

String

+

No

+

Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

+

endTime

+

String

+

No

+

End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
+
+

Response

Response parameters

+
Table 2 describes the response parameters. +
+ + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

backup_record_response

+

Array

+

Array of the backup records. For details about backup_record_response, see Table 3.

+

total_num

+

Integer

+

Number of obtained backup records.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 backup_record_response parameter description

Parameter

+

Type

+

Description

+

status

+

String

+

Backup status. Options:

+
  • waiting: DCS instance restoration is waiting to begin.
  • backuping: DCS instance backup is in progress.
  • succeed: DCS instance backup succeeded.
  • failed: DCS instance backup failed.
  • expired: The backup file expires.
  • deleted: The backup file has been deleted manually.
+

remark

+

String

+

Description of DCS instance backup

+

period

+

String

+

Time segment in which DCS instance backup was performed

+

progress

+

String

+

Backup progress

+

size

+

Long

+

Size of the backup file. Unit: byte.

+

instance_id

+

String

+

DCS instance ID

+

backup_id

+

String

+

ID of the backup record

+

created_at

+

String

+

Time at which the backup task is created

+

updated_at

+

String

+

Time at which DCS instance backup is completed

+

execution_at

+

String

+

Time at which the backup starts.

+

backup_type

+

String

+

Backup type. Options:

+
  • manual: manual backup
  • auto: automatic backup
+

backup_name

+

String

+

Name of the backup record

+

backup_format

+

String

+

Backup format.

+

error_code

+

String

+

Error code returned if DCS instance backup fails. For details about error codes, see Table 4.

+

is_support_restore

+

String

+

An indicator of whether restoration is supported. Options: TRUE or FALSE.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Error codes returned in case of a backup or restoration failure

Error Code

+

Description

+

dcs.08.0001

+

Failed to start the backup and restore tool.

+

dcs.08.0002

+

Operation timed out.

+

dcs.08.0003

+

Failed to delete bucket.

+

dcs.08.0004

+

Failed to obtain AK/SK.

+

dcs.08.0005

+

Failed to create bucket.

+

dcs.08.0006

+

Failed to obtain backup file size.

+

dcs.08.0007

+

Data synchronization failed during instance restoration.

+

dcs.08.0008

+

Automatic backup of the instance cannot start because the instance is running other jobs.

+
+
+

Example response

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

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

DCS instance backup records queried successfully.

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

Querying DCS Instance Restoration Records

+

Function

This API is used to query the restoration records of a specified DCS instance.

+
+

URI

GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID.

+

start

+

Integer

+

No

+

Start sequence number of the restoration record to be queried. By default, this parameter is set to 1.

+

limit

+

Integer

+

No

+

Number of restoration records displayed on each page. The minimum value of this parameter is 1. If this parameter is not specified, 10 restoration records are displayed on each page by default.

+

beginTime

+

String

+

No

+

Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

+

endTime

+

String

+

No

+

End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}
+
+

Response

Response parameters

+
Table 2 describes the response parameters. +
+ + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

restore_record_response

+

Array

+

Array of the restoration records.

+

total_num

+

Integer

+

Number of obtained backup records.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 restore_record_response parameter description

Parameter

+

Type

+

Description

+

status

+

String

+

Restoration status

+
  • waiting: DCS instance restoration is waiting to begin.
  • restoring: DCS instance restoration is in progress.
  • succeed: DCS instance restoration succeeded.
  • failed: DCS instance restoration failed.
+

progress

+

String

+

Restoration progress

+

restore_id

+

String

+

ID of the restoration record

+

backup_id

+

String

+

ID of the backup record

+

restore_remark

+

String

+

Description of DCS instance restoration

+

backup_remark

+

String

+

Description of DCS instance backup

+

created_at

+

String

+

Time at which the restoration task is created

+

updated_at

+

String

+

Time at which DCS instance restoration completed

+

restore_name

+

String

+

Name of the restoration record

+

backup_name

+

String

+

Name of the backup record

+

sourceInstanceID

+

String

+

Source instance ID.

+

sourceInstanceName

+

String

+

Source instance name.

+

error_code

+

String

+

Error code returned if DCS instance restoration fails. For details about error codes, see Table 4.

+
+
+
Example response
{
+    "restore_record_response": [
+        {
+            "status": "succeed",
+            "progress": "100.00",
+            "restore_id": "a6155972-800c-4170-a479-3231e907d2f6",
+            "backup_id": "f4823e9e-fe9b-4ffd-be79-4e5d6de272bb",
+            "restore_remark": "doctest",
+            "backup_remark": null,
+            "created_at": "2017-07-18T21:41:20.721Z",
+            "updated_at": "2017-07-18T21:41:35.182Z",
+            "restore_name": "restore_20170718214120",
+            "backup_name": "backup_20170718000002",
+            "sourceInstanceId":"dcb96c22-fd6f-41c0-88b5-544784558dd9",
+            "sourceInstanceName":"Test-DCS-MS-3-f79a983f",
+            "error_code": null
+        }
+    ],
+    "total_num": 1
+}
+
+
+

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 4 Status code

Status Code

+

Description

+

200

+

DCS instance restoration record queried successfully.

+
+
+
+
+
+
+
Parent topic: Backup and Restoration APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312024.html b/docs/dcs/api-ref/dcs-api-0312024.html new file mode 100644 index 00000000..36f03360 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312024.html @@ -0,0 +1,104 @@ + + +

Deleting Backup Files

+

Function

This API is used to delete the files backed up by a DCS instance.

+
+

URI

DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}

+
Table 1 describes the parameters. +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+

instance_id

+

String

+

Yes

+

DCS instance ID

+

backup_id

+

String

+

Yes

+

ID of the backup record

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
+
+

Response

Response parameters

+

Table 2 describes the response parameters.

+ +
+ + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

message

+

String

+

Result of deleting the backup file

+
+
+

Example response

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

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

200

+

Backup file deleted successfully.

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

Instance Management APIs

+ +

+
+ +
+ +
+ diff --git a/docs/dcs/api-ref/dcs-api-0312036.html b/docs/dcs/api-ref/dcs-api-0312036.html new file mode 100644 index 00000000..2593d32e --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312036.html @@ -0,0 +1,227 @@ + + +

Querying the Quota of a Tenant

+

Function

This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions.

+
+

URI

GET /v1.0/{project_id}/quota

+
Table 1 describes the parameter. +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

project_id

+

String

+

Yes

+

Project ID.

+
+
+
+
+

Request

Request parameters

+

None

+

Example request

+

None

+
+

Response

Response parameters

+
Table 2 describes the response parameters. +
+ + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

quotas

+

Object

+

Yes

+

Quota information. For details, see Table 3.

+
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 quotas parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

resources

+

Array

+

Yes

+

List of quotas. For details, see Table 4.

+

resource_user

+

Object

+

Yes

+

Information about a resource tenant For details, see Table 5.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 resources parameter description

Parameter

+

Type

+

Description

+

quota

+

Integer

+

Maximum number of instances that can be created and maximum allowed total memory.

+

used

+

Integer

+

Number of created instances and used memory.

+

type

+

String

+

Values:

+
  • instances: indicates the instance quota.
  • ram: indicates the memory quota.
+

unit

+

String

+

Resource unit.

+
  • When type is set to instance, no value is returned.
  • When type is set to ram, GB is returned.
+

max

+

Integer

+
  • Indicates the maximum limit of instance quota when type is set to instance.
  • Indicates the maximum limit of memory quota when type is set to ram.
+

min

+

Integer

+
  • Indicates the minimum limit of instance quota when type is set to instance.
  • Indicates the minimum limit of memory quota when type is set to ram.
+
+
+ +
+ + + + + + + + + + + + + +
Table 5 resource_user parameter description

Parameter

+

Type

+

Description

+

tenant_id

+

String

+

Resource tenant ID

+

tenant_name

+

String

+

Resource tenant name

+
+
+
Example response
{
+    "quotas": {
+        "resources": [
+            {
+                "quota": 10,
+                "used": 3,
+                "type": "instance",
+                "min": 1,
+                "max": 10,
+                "unit": null
+            },
+            {
+                "quota": 800,
+                "used": 22,
+                "type": "ram",
+                "min": 1,
+                "max": 800,
+                "unit": "GB"
+            }
+        ],
+        "resource_user": {
+            "tenant_id": "836152f9838a44089f40f3cf6fd432bf",
+            "tenant_name": "op_svc_dcs_003"
+        }
+    }
+}
+
+
+

Status Code

Table 6 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 6 Status code

Status Code

+

Description

+

200

+

Tenant quota queried successfully.

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

Other APIs

+
+
+ +
+ diff --git a/docs/dcs/api-ref/dcs-api-0312039.html b/docs/dcs/api-ref/dcs-api-0312039.html new file mode 100644 index 00000000..424778cd --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312039.html @@ -0,0 +1,148 @@ + + +

Querying AZ Information

+

Function

This API is used to query the ID of the AZ where a DCS instance resides.

+
+

URI

GET /v1.0/availableZones

+
+

Request

Request parameters

+

None

+

Example request

+

None

+
+

Response

Response parameters

+
Table 1 describes the response parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Description

+

regionId

+

String

+

Region ID.

+

available_zones

+

Array

+

Array of AZs. For details, see Table 2.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description of the available_zones array

Parameter

+

Type

+

Description

+

id

+

String

+

AZ ID.

+

code

+

String

+

AZ code.

+

name

+

String

+

AZ name.

+

port

+

String

+

Port number of the AZ.

+

resource_availability

+

String

+

An indicator of whether there are available Redis 3.0 resources in the AZ.

+
  • true: There are available resources in the AZ.
  • false: There are no available resources in the AZ.
+

resource_availability_dcs2

+

String

+

An indicator of whether there are available Redis 4.0 and 5.0 resources in the AZ.

+
  • true: There are available resources in the AZ.
  • false: There are no available resources in the AZ.
+
+
+

Example response

+
+
{
+    "regionId": "XXXXXX",
+    "available_zones": [
+        {
+            "id": "f84448fd537f46078dd8bd776747f573",
+            "code": "XXXXXX",
+            "name": "XXXXXX",
+            "port": "8003",
+            "resource_availability": "true"
+        },
+        {
+            "id": "12c47a78666b4e438cd0c692b9860387",
+            "code": "XXXXXX",
+            "name": "XXXXXX",
+            "port": "8002",
+            "resource_availability": "true"
+        },
+        {
+            "id": "0725858e0d26434f9aa3dc5fc40d5697",
+            "code": "XXXXXX",
+            "name": "XXXXXX",
+            "port": "8009",
+            "resource_availability": "true"
+        }
+    ]
+}
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

200

+

AZ information queried successfully.

+
+
+
+
+
+
+
Parent topic: Other APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0312040.html b/docs/dcs/api-ref/dcs-api-0312040.html new file mode 100644 index 00000000..73523dad --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312040.html @@ -0,0 +1,396 @@ + + +

Querying Service Specifications

+

Function

This API is used to query the product ID (parameter product_id) which indicates the specifications of the DCS service you created.

+
+

URI

GET /v1.0/products

+
+

Request

Request parameters

+

None

+

Example request

+

None

+
+

Response

Response parameters

+
Table 1 describes the response parameters. +
+ + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Description

+

products

+

Array

+

List of specifications of the DCS service to which you can subscribe.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 products parameter description

Parameter

+

Type

+

Description

+

product_id

+

String

+

Product ID used to differentiate DCS specifications.

+

spec_code

+

String

+

DCS instance specification code. Options:

+
  • dcs.single_node
  • dcs.master_standby
  • dcs.cluster
  • redis.ha.xu1.tiny.r4.512
  • redis.ha.xu1.tiny.r2.128
  • redis.cluster.xu1.large.r5.4
  • redis.ha.xu1.tiny.r4.256
  • redis.ha.xu1.tiny.r2.512
  • redis.cluster.xu1.large.r1.32
  • redis.cluster.xu1.large.r4.768
  • redis.ha.xu1.large.r3.2
  • redis.single.xu1.large.64
  • redis.cluster.xu1.large.r5.8
  • redis.ha.xu1.large.r3.32
  • redis.cluster.xu1.large.r2.8
  • redis.ha.xu1.large.r4.1
  • redis.ha.xu1.tiny.r2.256
  • redis.cluster.xu1.large.r4.1024
  • redis.ha.xu1.large.r5.16
  • redis.cluster.xu1.large.r4.32
  • redis.ha.xu1.large.r5.24
  • redis.ha.xu1.large.r4.64
  • redis.cluster.xu1.large.r2.1024
  • redis.ha.xu1.large.r2.48
  • redis.ha.xu1.large.r2.24
  • redis.ha.xu1.large.r5.64
  • redis.ha.xu1.tiny.r5.512
  • redis.ha.xu1.large.r3.8
  • redis.cluster.xu1.large.r1.768
  • redis.ha.xu1.large.r3.24
  • redis.cluster.xu1.large.r3.512
  • redis.ha.xu1.large.r3.1
  • redis.cluster.xu1.large.r4.4
  • redis.cluster.xu1.large.r1.24
  • redis.ha.xu1.large.r4.2
  • redis.cluster.xu1.large.r5.192
  • redis.single.xu1.large.16
  • redis.cluster.xu1.large.r3.1024
  • redis.ha.xu1.large.r4.24
  • redis.cluster.xu1.large.r2.48
  • redis.ha.xu1.large.r2.1
  • redis.ha.xu1.large.r3.48
  • redis.single.xu1.large.4
  • redis.cluster.xu1.large.r4.48
  • redis.cluster.xu1.large.r3.768
  • redis.ha.xu1.tiny.r4.128
  • redis.ha.xu1.large.r5.1
  • redis.cluster.xu1.large.r2.96
  • redis.cluster.xu1.large.r3.4
  • redis.cluster.xu1.large.r1.128
  • redis.single.xu1.large.2
  • redis.ha.xu1.tiny.r3.128
  • redis.cluster.xu1.large.r2.512
  • redis.cluster.xu1.large.r3.8
  • redis.cluster.xu1.large.r4.128
  • redis.cluster.xu1.large.r3.96
  • redis.ha.xu1.large.r4.8
  • redis.ha.xu1.large.r5.48
  • redis.single.xu1.large.8
  • redis.cluster.xu1.large.r2.24
  • redis.cluster.xu1.large.r1.4
  • redis.cluster.xu1.large.r5.32
  • redis.cluster.xu1.large.r1.64
  • redis.cluster.xu1.large.r4.96
  • redis.single.xu1.tiny.256
  • redis.cluster.xu1.large.r5.128
  • redis.cluster.xu1.large.r2.16
  • redis.cluster.xu1.large.r4.8
  • redis.cluster.xu1.large.r4.512
  • redis.cluster.xu1.large.r1.384
  • redis.cluster.xu1.large.r5.768
  • redis.cluster.xu1.large.r3.256
  • redis.cluster.xu1.large.r1.256
  • redis.cluster.xu1.large.r4.64
  • redis.cluster.xu1.large.r5.256
  • redis.cluster.xu1.large.r4.384
  • redis.ha.xu1.tiny.r5.128
  • redis.cluster.xu1.large.r3.24
  • redis.cluster.xu1.large.r4.192
  • redis.cluster.xu1.large.r1.96
  • redis.ha.xu1.large.r2.2
  • redis.single.xu1.large.24
  • redis.ha.xu1.large.r4.4
  • redis.cluster.xu1.large.r1.1024
  • redis.ha.xu1.large.r2.16
  • redis.ha.xu1.large.r4.16
  • redis.cluster.xu1.large.r5.96
  • redis.cluster.xu1.large.r5.384
  • redis.cluster.xu1.large.r3.16
  • redis.ha.xu1.large.r3.16
  • redis.ha.xu1.large.r4.32
  • redis.ha.xu1.tiny.r5.256
  • redis.single.xu1.large.32
  • redis.ha.xu1.large.r5.2
  • redis.cluster.xu1.large.r1.16
  • redis.cluster.xu1.large.r2.384
  • redis.cluster.xu1.large.r2.192
  • redis.cluster.xu1.large.r1.48
  • redis.ha.xu1.large.r5.8
  • redis.cluster.xu1.large.r5.16
  • redis.cluster.xu1.large.r3.128
  • redis.ha.xu1.large.r3.4
  • redis.cluster.xu1.large.r1.192
  • redis.cluster.xu1.large.r3.384
  • redis.cluster.xu1.large.r2.4
  • redis.ha.xu1.large.r2.4
  • redis.single.xu1.tiny.128
  • redis.cluster.xu1.large.r1.512
  • redis.ha.xu1.large.r2.64
  • redis.cluster.xu1.large.r2.128
  • redis.cluster.xu1.large.r2.768
  • redis.cluster.xu1.large.r5.64
  • redis.cluster.xu1.large.r3.48
  • redis.single.xu1.tiny.512
  • redis.cluster.xu1.large.r5.48
  • redis.ha.xu1.large.r4.48
  • redis.cluster.xu1.large.r4.24
  • redis.ha.xu1.large.r5.4
  • redis.ha.xu1.large.r2.8
  • redis.ha.xu1.large.r3.64
  • redis.cluster.xu1.large.r2.64
  • redis.cluster.xu1.large.r2.32
  • redis.cluster.xu1.large.r4.16
  • redis.cluster.xu1.large.r4.256
  • redis.single.xu1.large.1
  • redis.cluster.xu1.large.r1.8
  • redis.cluster.xu1.large.r3.32
  • redis.single.xu1.large.48
  • redis.cluster.xu1.large.r5.1024
  • redis.cluster.xu1.large.r3.192
  • redis.cluster.xu1.large.r2.256
  • redis.ha.xu1.tiny.r3.256
  • redis.cluster.xu1.large.r5.24
  • redis.ha.xu1.tiny.r3.512
  • redis.cluster.xu1.large.r5.512
  • redis.ha.xu1.large.r5.32
  • redis.cluster.xu1.large.r3.64
  • redis.ha.xu1.large.r2.32
  • redis.ha.xu1.large.p2.16
  • redis.ha.xu1.large.p2.32
  • redis.ha.xu1.large.p2.64
  • redis.ha.xu1.large.p2.8
  • redis.ha.xu1.large.p3.16
  • redis.ha.xu1.large.p3.32
  • redis.ha.xu1.large.p3.64
  • redis.ha.xu1.large.p3.8
  • redis.ha.xu1.large.p4.16
  • redis.ha.xu1.large.p4.32
  • redis.ha.xu1.large.p4.64
  • redis.ha.xu1.large.p4.8
  • redis.ha.xu1.large.p5.16
  • redis.ha.xu1.large.p5.32
  • redis.ha.xu1.large.p5.64
  • redis.ha.xu1.large.p5.8
  • redis.ha.xu1.large.p6.16
  • redis.ha.xu1.large.p6.32
  • redis.ha.xu1.large.p6.64
  • redis.ha.xu1.large.p6.8
+

cache_mode

+

String

+

DCS instance type. Options:

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

product_type

+

String

+

Edition of DCS for Redis.

+

cpu_type

+

String

+

CPU architecture.

+

storage_type

+

String

+

Storage type.

+

details

+

Array of Object

+

Details of the specifications. Table 3 describes the parameters in this array.

+

engine

+

String

+

Cache engine.

+

engine_versions

+

String

+

Cache engine version.

+

spec_details

+

String

+

DCS specifications. The value subjects to the returned specifications.

+

spec_details2

+

String

+

Detailed DCS specifications, including the maximum number of connections and maximum memory size.

+

charging_type

+

String

+

Billing mode. Value: Hourly.

+

price

+

Double

+

Price of the DCS service to which you can subscribe. (This parameter has been abandoned.)

+

currency

+

String

+

Currency.

+

prod_type

+

String

+

Product type.

+

Options: instance and obs_space.

+

cloud_service_type_code

+

String

+

Cloud service type code.

+

cloud_resource_type_code

+

String

+

Cloud resource type code.

+

flavors

+

Array

+

AZs with available resources. Table 4 describes the parameters in this array.

+

billing_factor

+

String

+

Billing item.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 details parameter description

Parameter

+

Type

+

Description

+

capacity

+

String

+

Specification (total memory) of the DCS instance.

+

max_bandwidth

+

String

+

Maximum bandwidth supported by the specification.

+

max_clients

+

String

+

Maximum number of clients supported by the specification, which is usually equal to the maximum number of connections.

+

max_connections

+

String

+

Maximum number of connections supported by the specification.

+

max_in_bandwidth

+

String

+

Maximum inbound bandwidth supported by the specification, which is usually equal to the maximum bandwidth.

+

max_memory

+

String

+

Maximum available memory.

+

tenant_ip_count

+

String

+

Number of tenant IP addresses corresponding to the specifications.

+

sharding_num

+

String

+

Number of shards supported by the specifications.

+

proxy_num

+

String

+

Number of proxies supported by Proxy Cluster instances of the specified specifications. If the instance is not a Proxy Cluster instance, the value of this parameter is 0.

+

db_number

+

String

+

Number of DBs of the specifications.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 flavors parameter description

Parameter

+

Type

+

Description

+

capacity

+

String

+

Specification (total memory) of the DCS instance.

+

unit

+

String

+

Memory unit.

+

available_zones

+

Array

+

AZ ID.

+
+
+

Example response

+

+
	{
+		"product_id": "dcs.master_standby-h",
+		"spec_code": "dcs.master_standby",
+		"cache_mode": "ha",
+		"product_type": "generic",
+		"cpu_type": "x86_64",
+		"storage_type": "DRAM",
+		"details": {
+			"capacity": 2,
+			"max_memory": 1.5,
+			"max_connections": 10000,
+			"max_clients": 5000,
+			"max_bandwidth": 512,
+			"max_in_bandwidth": 42,
+			"tenant_ip_count": 3,
+			"sharding_num": 1,
+			"proxy_num": 0,
+			"db_number": 256
+		},
+		"engine": "redis",
+		"engine_versions": "3.0",
+		"spec_details": "[{\"mem\":\"2,4,8,16,32,64\"}]",
+		"spec_details2": "[{\"capacity\":2,\"max_memory\":1.5,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":512,\"max_in_bandwidth\":42,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":4,\"max_memory\":3.2,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":1536,\"max_in_bandwidth\":64,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":8,\"max_memory\":6.4,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":1536,\"max_in_bandwidth\":64,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":16,\"max_memory\":12.8,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":3072,\"max_in_bandwidth\":85,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":32,\"max_memory\":25.6,\"max_connections\":10000,\"max_clients\":5000,\"max_bandwidth\":3072,\"max_in_bandwidth\":85,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256},{\"capacity\":64,\"max_memory\":51.2,\"max_connections\":12000,\"max_clients\":5000,\"max_bandwidth\":5120,\"max_in_bandwidth\":128,\"tenant_ip_count\":3,\"sharding_num\":1,\"proxy_num\":0,\"db_number\":256}]",
+		"charging_type": "Hourly",
+		"price": 0.0,
+		"currency": "",
+		"prod_type": "instance",
+		"cloud_service_type_code": "XXXX",
+		"cloud_resource_type_code": "XXXX",
+		"flavors": [{
+			"capacity": "2",
+			"unit": "GB",
+			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"]
+		},
+		{
+			"capacity": "4",
+			"unit": "GB",
+			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"]
+		},
+		{
+			"capacity": "8",
+			"unit": "GB",
+			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"]
+		},
+		{
+			"capacity": "16",
+			"unit": "GB",
+			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"]
+		},
+		{
+			"capacity": "32",
+			"unit": "GB",
+			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"]
+		},
+		{
+			"capacity": "64",
+			"unit": "GB",
+			"available_zones": ["882f6e449e3245dbb8c1c0fafa494c89",
+			"ae04cf9d61544df3806a3feeb401b204",
+			"d573142f24894ef3bd3664de068b44b0"]
+		}],
+		"billing_factor": "Duration"
+	}
+
+

Status Code

Table 5 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 5 Status code

Status Code

+

Description

+

200

+

Service specifications queried successfully.

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

Querying Maintenance Time Window

+

Function

The API is used to query the start time and end time of the maintenance time window.

+
+

URI

GET /v1.0/instances/maintain-windows

+
+

Request

Request parameters

+

None

+

Example request

+

None

+
+

Response

Response parameters

+
Table 1 describes the response parameters. +
+ + + + + + + + + +
Table 1 Parameter description

Parameter

+

Type

+

Description

+

maintain_windows

+

Array

+

List of supported maintenance time windows.

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 maintain_windows parameter description

Parameter

+

Type

+

Description

+

seq

+

Integer

+

Sequence number of the maintenance time window.

+

begin

+

String

+

Start time of the maintenance time window.

+

end

+

String

+

End time of the maintenance time window.

+

default

+

Boolean

+

An indicator of whether the maintenance time window is set to the default time segment.

+
+
+
Example response
{
+    "maintain_windows": [
+        {
+            "seq": 1,
+            "begin": "22",
+            "end": "02",
+            "default": false
+        },
+        {
+            "seq": 2,
+            "begin": "02",
+            "end": "06",
+            "default": true
+        },
+        {
+            "seq": 3,
+            "begin": "06",
+            "end": "10",
+            "default": false
+        },
+        {
+            "seq": 4,
+            "begin": "10",
+            "end": "14",
+            "default": false
+        },
+        {
+            "seq": 5,
+            "begin": "14",
+            "end": "18",
+            "default": false
+        },
+        {
+            "seq": 6,
+            "begin": "18",
+            "end": "22",
+            "default": false
+        }
+    ]
+}
+
+
+

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

+ +
+ + + + + + + +
Table 3 Status code

Status Code

+

Description

+

200

+

Successfully queried the maintenance time window.

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

Appendix

+
+
+ +
+ diff --git a/docs/dcs/api-ref/dcs-api-0312043.html b/docs/dcs/api-ref/dcs-api-0312043.html new file mode 100644 index 00000000..b35e2e01 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0312043.html @@ -0,0 +1,321 @@ + + +

Status Codes

+

Table 1 describes the status codes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Status codes

Status Code

+

Name

+

Description

+

100

+

Continue

+

The server has received the initial part of the request and the client should continue to send the remaining part.

+

This provisional response informs the client that part of the request has been received and has not yet been rejected by the server.

+

101

+

Switching Protocols

+

The requester has asked the server to switch protocols and the server has agreed to do so. The target protocol must be more advanced than the source protocol.

+

For example, the current HTTP protocol is switched to a later version of HTTP.

+

201

+

Created

+

The request has been fulfilled, resulting in the creation of a new resource.

+

202

+

Accepted

+

The request has been accepted for processing, but the processing has not been completed.

+

203

+

Non-Authoritative Information

+

The server successfully processed the request, but is returning information that may be from another source.

+

204

+

NoContent

+

The server has successfully processed the request, but does not return any content.

+

The status code is returned in response to an HTTP OPTIONS request.

+

205

+

Reset Content

+

The server successfully processed the request, but is not returning any content.

+

206

+

Partial Content

+

The server has successfully processed a part of the GET request.

+

300

+

Multiple Choices

+

There are multiple options for the requested resource. For example, this code could be used to present a list of resource characteristics and addresses from which the client such as a browser may choose.

+

301

+

Moved Permanently

+

This and all future requests should be permanently directed to the given URI indicated in this response.

+

302

+

Found

+

The requested resource was temporarily moved.

+

303

+

See Other

+

The response to the request can be found under a different URI, and should be retrieved using a GET or POST method.

+

304

+

Not Modified

+

The requested resource has not been modified. In such case, there is no need to retransmit the resource since the client still has a previously downloaded copy.

+

305

+

Use Proxy

+

The requested resource is available only through a proxy.

+

306

+

Unused

+

This HTTP status code is no longer used.

+

400

+

BadRequest

+

The request is invalid.

+

The client should modify the request instead of re-initiating it.

+

401

+

Unauthorized

+

The authentication information is incorrect or invalid.

+

402

+

Payment Required

+

Reserved for future use.

+

403

+

Forbidden

+

The request is rejected.

+

The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

+

404

+

NotFound

+

The requested resource could not be found.

+

The client should modify the request instead of re-initiating it.

+

405

+

MethodNotAllowed

+

A request method is not supported for the requested resource.

+

The client should modify the request instead of re-initiating it.

+

406

+

Not Acceptable

+

The server could not fulfil the request according to the content characteristics of the request.

+

407

+

Proxy Authentication Required

+

This code is similar to 401, but indicates that the client must first authenticate itself with the proxy.

+

408

+

Request Time-out

+

The server timed out waiting for the request.

+

The client may re-initiate the request without modifications at any later time.

+

409

+

Conflict

+

The request cannot be processed due to a conflict.

+

This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.

+

410

+

Gone

+

The requested resource is no longer available.

+

The requested resource has been deleted permanently.

+

411

+

Length Required

+

The server refused to process the request because the request does not specify the length of its content.

+

412

+

Precondition Failed

+

The server does not meet one of the preconditions that the requester puts on the request.

+

413

+

Request Entity Too Large

+

The request is larger than the server is willing or able to process. The server may close the connection to prevent the client from continuing the request. If the server temporarily cannot process the request, the response will contain a Retry-After header field.

+

414

+

Request-URI Too Large

+

The URI provided was too long for the server to process.

+

415

+

Unsupported Media Type

+

The server does not support the media type in the request.

+

416

+

Requested range not satisfiable

+

The requested range is invalid.

+

417

+

Expectation Failed

+

The server fails to meet the requirements of the Expect request-header field.

+

422

+

UnprocessableEntity

+

The request was well-formed but was unable to be followed due to semantic errors.

+

429

+

TooManyRequests

+

The client has sent more requests than its rate limit is allowed within a given amount of time, or the server has received more requests than it is able to process within a given amount of time. In this case, it is advisable for the client to re-initiate requests after the time specified in the Retry-After header of the response expires.

+

500

+

InternalServerError

+

The server is able to receive the request, but it could not understand the request.

+

501

+

Not Implemented

+

The server does not support the requested function.

+

502

+

Bad Gateway

+

The server was acting as a gateway or proxy and received an invalid request from a remote server.

+

503

+

ServiceUnavailable

+

The requested service is invalid.

+

It is advisable for the client to modify the request instead of re-initiating the request.

+

504

+

ServerTimeout

+

The server could not return a timely response. The response will reach the client only if the request carries a timeout parameter.

+

505

+

HTTP Version not supported

+

The server does not support the HTTP protocol version used in the request.

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

Error Codes

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

Status Code

+

Error Code

+

Error Message

+

Description

+

Solution

+

400

+

111400002

+

Invalid project ID format.

+

Invalid project ID format.

+

Check whether the request parameters are valid.

+

400

+

111400004

+

Empty request body.

+

Empty request body.

+

Check whether the request parameters are valid.

+

400

+

111400005

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400007

+

The selected cache engine type is not supported.

+

The selected cache engine type is not supported.

+

Check whether the request parameters are valid.

+

400

+

111400008

+

The selected cache engine version is not supported.

+

The selected cache engine version is not supported.

+

Check whether the request parameters are valid.

+

400

+

111400009

+

Invalid product ID in the request.

+

Invalid product ID in the request.

+

Check whether the request parameters are valid.

+

400

+

111400010

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400011

+

DCS instance description cannot exceed 1024 characters.

+

DCS instance description cannot exceed 1024 characters.

+

Check whether the request parameters are valid.

+

400

+

111400012

+

Invalid capacity parameter in the request.

+

Invalid capacity parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

111400013

+

Invalid vpc_id in the request.

+

Invalid vpc_id in the request.

+

Check whether the request parameters are valid.

+

400

+

111400014

+

Invalid security_group_id in the request.

+

Invalid security_group_id in the request.

+

Check whether the request parameters are valid.

+

400

+

111400016

+

Invalid subnet_id in the request.

+

Invalid subnet_id in the request.

+

Check whether the request parameters are valid.

+

400

+

111400017

+

This DCS instance job task is still running.

+

A background task associated with this instance is running.

+

Try again later.

+

400

+

111400018

+

This subnet must exist in the VPC.

+

This subnet must exist in the VPC.

+

Check whether the request parameters are valid.

+

400

+

111400019

+

The password does not meet complexity requirements.

+

The password does not meet complexity requirements.

+

Check whether the request parameters are valid.

+

400

+

111400020

+

DHCP must be enabled for this subnet.

+

DHCP must be enabled for this subnet.

+

Check whether DHCP has been enabled.

+

400

+

111400021

+

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

+

Invalid isAutoRenew in the request. It must be either 0 or 1.

+

Check whether the request parameters are valid.

+

400

+

111400022

+

Engine does not match the product id.

+

The cache engine does not match the product ID.

+

Check whether the request parameters are valid.

+

400

+

111400026

+

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

+

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

+

Try again later or contact technical support.

+

400

+

111400027

+

This operation is not supported on this node.

+

The current node does not support this operation.

+

Try again later or contact technical support.

+

400

+

111400035

+

DCS instance quota of the tenant is insufficient.

+

DCS instance quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

111400036

+

Memory quota of the tenant is insufficient.

+

Memory quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

111400037

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400038

+

The periodNum parameter in the request must be an integer.

+

The periodNum parameter in the request must be an integer.

+

Check whether the request parameters are valid.

+

400

+

111400039

+

The quota limit has been reached.

+

The quota limit has been reached.

+

Check whether the request parameters are valid.

+

400

+

111400042

+

This AZ does not exist.

+

This AZ does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400045

+

This DCS instance is already unfrozen.

+

The instance is not frozen and cannot be unfrozen.

+

Check whether the request parameters are valid.

+

400

+

111400046

+

This security group does not exist.

+

This security group does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400047

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400048

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400053

+

the upgrade instance version equals to current version.

+

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

+

Check whether the request parameters are valid.

+

400

+

111400054

+

the selected available zone quota not enough.

+

The DCS resources in the selected AZ are not sufficient.

+

Select another AZ or contact technical support.

+

400

+

111400060

+

This DCS instance name already exists.

+

This instance name already exists.

+

Check whether the request parameters are valid.

+

400

+

111400061

+

Invalid instance ID format.

+

Invalid instance ID format.

+

Check whether the request parameters are valid.

+

400

+

111400062

+

Invalid {0} parameter in the request.

+

Invalid parameter {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

111400063

+

Invalid {0} parameter in the request.

+

Invalid parameter {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

111400064

+

The action parameter in the request restart.

+

The action parameter in the request must be restart.

+

Check whether the request parameters are valid.

+

400

+

111400065

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400066

+

Invalid value of the configure parameter {0}.

+

Invalid configuration parameter {0}.

+

Check whether the request parameters are valid.

+

400

+

111400067

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400068

+

This VPC does not exist.

+

This VPC does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400070

+

Invalid task ID format.

+

Invalid task ID format.

+

Check whether the request parameters are valid.

+

400

+

111400072

+

Invalid saveDays instance backup policy parameter in the request.

+

The value of the instance backup parameter saveDays in the request must be in the range from 1 to 7.

+

Check whether the request parameters are valid.

+

400

+

111400073

+

Invalid backupType instance backup policy parameter in the request.

+

The value of the instance backup parameter backupType in the request must be either auto or manual.

+

Check whether the request parameters are valid.

+

400

+

111400074

+

Invalid periodType instance backup policy parameter in the request.

+

The value of the instance backup parameter periodType in the request must be weekly.

+

Check whether the request parameters are valid.

+

400

+

111400075

+

Invalid backupAt instance backup policy parameter in the request.

+

The value of the instance backup parameter backupAt in the request cannot be null or undefined.

+

Check whether the request parameters are valid.

+

400

+

111400076

+

Invalid beginAt instance backup policy parameter in the request.

+

The value of the instance backup parameter beginAt in the request must be in the 00:00–00:00 format.

+

Check whether the request parameters are valid.

+

400

+

111400080

+

Instance password verify failed.

+

Invalid password for accessing the selected DCS instance.

+

Check whether the request parameters are valid.

+

400

+

111400086

+

only master standby instance is support this action

+

This operation is allowed only for master/standby DCS instances.

+

Operation not allowed.

+

400

+

111400087

+

the backup record status is err when restore this instance

+

The restore operation is allowed only when the backup task is in the Succeeded state.

+

Try again later or contact technical support.

+

400

+

111400094

+

the system is not support dcs job.

+

The system does not support the background task function.

+

Operation not allowed.

+

400

+

111400095

+

the system is not support backup and restore.

+

The system does not support the backup and restoration function.

+

Operation not allowed.

+

400

+

111400096

+

the instance is backuping.

+

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

+

Try again later.

+

400

+

111400097

+

the instance is restoring.

+

Restoring the DCS instance... Please try again later.

+

Try again later.

+

400

+

111400098

+

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

+

The value of the remark parameter cannot exceed 128 characters long.

+

Check whether the request parameters are valid.

+

400

+

111400099

+

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

+

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

+

Try again later.

+

400

+

111400100

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400102

+

The system is not support resize.

+

Scale-up is not supported.

+

Operation not allowed.

+

400

+

111400103

+

The system is not support resize.

+

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

+

Check whether the request parameters are valid.

+

400

+

111400104

+

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

+

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

+

Try again later or contact technical support.

+

400

+

111400105

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

111400106

+

The value of maintain time illegal.

+

Invalid maintenance time window.

+

Check whether the request parameters are valid.

+

400

+

111400108

+

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

+

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

+

Try again later or contact technical support.

+

400

+

111400111

+

the instance is restarting.

+

Restarting the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400113

+

the instance is extending.

+

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

+

Try again later or contact technical support.

+

400

+

111400114

+

the instance is configuring.

+

Modifying instance configuration... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400115

+

the instance is changing the password.

+

Changing instance password... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400116

+

the instance is upgrading.

+

Upgrading the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400117

+

the instance is rollbacking the version.

+

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

+

Try again later or contact technical support.

+

400

+

111400118

+

the instance is creating.

+

Creating the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400119

+

Query Bill Sample failed

+

This DCS instance does not exist.

+

Check whether the request parameters are valid.

+

400

+

111400120

+

the instance is Freezing.

+

Freezing the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

111400800

+

Invalid {0} in the request.

+

Invalid parameter {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

111400843

+

The no_password_access parameter is missing or its value is invalid.

+

Parameter no_password_access is missing or invalid.

+

Check whether the request parameters are valid.

+

400

+

111400844

+

The access_user parameter is missing or its value is invalid.

+

Parameter access_user is missing or invalid.

+

Check whether the request parameters are valid.

+

400

+

111400845

+

The password parameter is missing or its value is invalid.

+

Parameter password is missing or invalid.

+

Check whether the request parameters are valid.

+

400

+

111400849

+

The request parameter new_password should not exist.

+

Request parameter new_password should not exist.

+

Check whether the request parameters are valid.

+

400

+

111400850

+

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

+

This operation is not supported when password-free access is enabled for the instance.

+

Reset the instance password.

+

400

+

DCS. 4855

+

Master standby swap is not supported.

+

Master/Standby switchover is not supported.

+

Operation not allowed.

+

400

+

DCS.1004

+

Project ID does not match the token.

+

Project ID does not match the token.

+

Check whether the request parameters are valid.

+

400

+

DCS.4002

+

Invalid project ID format.

+

Invalid project ID format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4004

+

Empty request body.

+

Empty request body.

+

Check whether the request parameters are valid.

+

400

+

DCS.4005

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4007

+

The selected cache engine type is not supported.

+

The selected cache engine edition is not supported.

+

Check whether the request parameters are valid.

+

400

+

DCS.4008

+

The selected cache engine version is not supported.

+

The selected cache engine version is not supported.

+

Check whether the request parameters are valid.

+

400

+

DCS.4009

+

Invalid product ID in the request.

+

Invalid product ID in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4010

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4011

+

DCS instance description cannot exceed 1024 characters.

+

DCS instance description cannot exceed 1024 characters.

+

Check whether the request parameters are valid.

+

400

+

DCS.4012

+

Invalid capacity parameter in the request.

+

Invalid capacity parameter in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4013

+

Invalid vpc_id in the request.

+

Invalid vpc_id in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4014

+

Invalid security_group_id in the request.

+

Invalid security_group_id in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4016

+

Invalid subnet_id in the request.

+

Invalid subnet_id in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4017

+

This DCS instance job task is still running.

+

A background task associated with this instance is running.

+

Try again later.

+

400

+

DCS.4018

+

This subnet must exist in the VPC.

+

This subnet must exist in the VPC.

+

Check whether the request parameters are valid.

+

400

+

DCS.4019

+

The password does not meet complexity requirements.

+

The password does not meet complexity requirements.

+

Check whether the request parameters are valid.

+

400

+

DCS.4020

+

DHCP must be enabled for this subnet.

+

DHCP must be enabled for this subnet.

+

Check whether DHCP has been enabled.

+

400

+

DCS.4021

+

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

+

Invalid isAutoRenew in the request. It must be either 0 or 1.

+

Check whether the request parameters are valid.

+

400

+

DCS.4022

+

Engine does not match the product id.

+

The cache engine does not match the product ID.

+

Check whether the request parameters are valid.

+

400

+

DCS.4026

+

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

+

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

+

Try again later or contact technical support.

+

400

+

DCS.4027

+

This operation is not supported on this node.

+

The specified operation is not supported on the current node.

+

Try again later or contact technical support.

+

400

+

DCS.4035

+

DCS instance quota of the tenant is insufficient.

+

DCS instance quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

DCS.4036

+

Memory quota of the tenant is insufficient.

+

Memory quota of the tenant is insufficient.

+

Contact technical support.

+

400

+

DCS.4037

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4038

+

The periodNum parameter in the request must be an integer.

+

The periodNum parameter in the request must be an integer.

+

Check whether the request parameters are valid.

+

400

+

DCS.4039

+

The quota limit has been reached.

+

The quota limit has been reached.

+

Check whether the request parameters are valid.

+

400

+

DCS.4042

+

This AZ does not exist.

+

This AZ does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4045

+

This DCS instance is already unfrozen.

+

The instance is not frozen and cannot be unfrozen.

+

Try again later or contact technical support.

+

400

+

DCS.4046

+

This security group does not exist.

+

The specified security group does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4047

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4048

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4049

+

The instance status is not running.

+

The instance status is not running.

+

Contact technical support.

+

400

+

DCS.4053

+

the upgrade instance version equals to current version.

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4054

+

the selected available zone quota not enough.

+

The DCS resources in the selected AZ are not sufficient.

+

Select another AZ or contact technical support.

+

400

+

DCS.4060

+

This DCS instance name already exists.

+

This instance name already exists.

+

Check whether the request parameters are valid.

+

400

+

DCS.4061

+

Invalid instance ID format.

+

Invalid instance ID format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4062

+

Invalid {0} parameter in the request.

+

Invalid parameter {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4063

+

Invalid {0} parameter in the request.

+

Invalid parameter {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4064

+

The action parameter in the request must be restart.

+

The action parameter in the request must be restart.

+

Check whether the request parameters are valid.

+

400

+

DCS.4065

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4066

+

Invalid value of the configure parameter {0}.

+

Invalid configuration parameter {0}.

+

Check whether the request parameters are valid.

+

400

+

DCS.4067

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4068

+

This VPC does not exist.

+

This VPC does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4070

+

Invalid task ID format.

+

Invalid task ID format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4072

+

Invalid saveDays instance backup policy parameter in the request.

+

The value of the instance backup parameter saveDays in the request must be in the range from 1 to 7.

+

Check whether the request parameters are valid.

+

400

+

DCS.4073

+

Invalid backupType instance backup policy parameter in the request.

+

The value of the instance backup parameter backupType in the request must be either auto or manual.

+

Check whether the request parameters are valid.

+

400

+

DCS.4074

+

Invalid periodType instance backup policy parameter in the request.

+

The value of the instance backup parameter periodType in the request must be weekly.

+

Check whether the request parameters are valid.

+

400

+

DCS.4075

+

Invalid backupAt instance backup policy parameter in the request.

+

The value of the instance backup parameter backupAt in the request cannot be null or undefined.

+

Check whether the request parameters are valid.

+

400

+

DCS.4076

+

Invalid beginAt instance backup policy parameter in the request.

+

The value of the instance backup parameter beginAt in the request must be in the 00:00–00:00 format.

+

Check whether the request parameters are valid.

+

400

+

DCS.4080

+

Instance password verify failed.

+

Invalid instance password.

+

Check whether the request parameters are valid.

+

400

+

DCS.4086

+

only master standby instance is support this action

+

This operation is allowed only for master/standby DCS instances.

+

Operation not allowed.

+

400

+

DCS.4087

+

the backup record status is err when restore this instance

+

The restore operation is allowed only when the backup task is in the Succeeded state.

+

Try again later or contact technical support.

+

400

+

DCS.4094

+

the system is not support dcs job.

+

The system does not support the background task function.

+

Operation not allowed.

+

400

+

DCS.4095

+

the system is not support backup and restore.

+

The system does not support the backup and restoration function.

+

Operation not allowed.

+

400

+

DCS.4096

+

the instance is backuping.

+

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

+

Try again later or contact technical support.

+

400

+

DCS.4097

+

the instance is restoring.

+

Restoring the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4098

+

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

+

The value of the remark parameter cannot exceed 128 characters long.

+

Check whether the request parameters are valid.

+

400

+

DCS.4099

+

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

+

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

+

Try again later.

+

400

+

DCS.4100

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4102

+

The system is not support resize.

+

Scale-up is not supported.

+

Operation not allowed.

+

400

+

DCS.4103

+

The system is not support resize.

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4104

+

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

+

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

+

Try again later or contact technical support.

+

400

+

DCS.4105

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4106

+

The value of maintain time illegal.

+

Invalid maintenance time window.

+

Check whether the request parameters are valid.

+

400

+

DCS.4108

+

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

+

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

+

Try again later or contact technical support.

+

400

+

DCS.4111

+

the instance is restarting.

+

Restarting the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4113

+

the instance is extending.

+

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

+

Try again later or contact technical support.

+

400

+

DCS.4114

+

the instance is configuring.

+

Modifying instance configuration... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4115

+

the instance is changing the password.

+

Changing instance password... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4116

+

the instance is upgrading.

+

Upgrading the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4117

+

the instance is rollbacking the version.

+

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

+

Try again later or contact technical support.

+

400

+

DCS.4118

+

the instance is creating.

+

Creating the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4119

+

Query Bill Sample failed

+

This DCS instance does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4120

+

the instance is Freezing.

+

Freezing the DCS instance... Please try again later.

+

Try again later or contact technical support.

+

400

+

DCS.4800

+

Invalid {0} in the request.

+

Invalid parameter {0} in the request.

+

Check whether the request parameters are valid.

+

400

+

DCS.4843

+

The no_password_access parameter is missing or its value is invalid.

+

Parameter no_password_access is missing or invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4844

+

The access_user parameter is missing or its value is invalid.

+

Parameter access_user is missing or invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4845

+

The password parameter is missing or its value is invalid.

+

Parameter password is missing or invalid.

+

Check whether the request parameters are valid.

+

400

+

DCS.4849

+

The request parameter new_password should not exist.

+

Request parameter new_password should not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4850

+

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

+

This operation is not supported when password-free access is enabled for the instance.

+

Check whether the request parameters are valid.

+

400

+

DCS.4875

+

Create replication number exceed max number limit.

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4879

+

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

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4911

+

The network ip insufficient.

+

The subnet does not have sufficient IP addresses.

+

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

+

400

+

DCS.4918

+

Instance bigkey analyze is running.

+

The big key analysis is in progress.

+

Try again later.

+

400

+

DCS.4919

+

Does not support bigkey analyze.

+

Big key analysis is not supported.

+

Operation not allowed.

+

400

+

DCS.4930

+

The request param node_list is invalid

+

Invalid node_list parameter in the parameter.

+

Check whether the request parameters are valid.

+

400

+

DCS.4931

+

Node is not replica, can't delete.

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4935

+

Only one slave replication has dns ip, can not delete

+

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

+

Check whether the request parameters are valid.

+

400

+

DCS.4936

+

The master node cannot be deleted

+

The master node cannot be deleted.

+

Check whether the request parameters are valid.

+

400

+

DCS.4937

+

Only has one slave node,can not delete

+

Retain at least one replica in addition to the master.

+

Check whether the request parameters are valid.

+

400

+

DCS.4939

+

The param slave_priority_weight is invalid.

+

Invalid slave_priority_weight parameter in the parameter.

+

Check whether the request parameters are valid.

+

400

+

DCS.4941

+

The hotkey id does not exist.

+

The hot key analysis task ID does not exist.

+

Check whether the request parameters are valid.

+

400

+

DCS.4942

+

The bigkey id does not exist.

+

The big key analysis task ID does not exist.

+

Check whether the request parameters are valid.

+

401

+

111401001

+

Invalid token.

+

Invalid token.

+

Check whether the request parameters are valid.

+

401

+

111401002

+

Token expired.

+

The token has expired.

+

Check whether the request parameters are valid.

+

401

+

111401003

+

No token in the request.

+

The token is missing.

+

Check whether the request parameters are valid.

+

401

+

111401004

+

Project ID does not match the token.

+

Project ID does not match the token.

+

Check whether the request parameters are valid.

+

401

+

DCS.1001

+

Invalid token.

+

Invalid token.

+

Check whether the request parameters are valid.

+

401

+

DCS.1002

+

Token expired.

+

The token has expired.

+

Check whether the request parameters are valid.

+

401

+

DCS.1003

+

No token in the request.

+

The token is missing.

+

Check whether the request parameters are valid.

+

401

+

DCS.1004

+

Project ID does not match the token.

+

Project ID does not match the token.

+

Check whether the request parameters are valid.

+

403

+

111403002

+

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

+

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

+

Check whether the request parameters are valid.

+

403

+

111403003

+

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

+

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

+

Check whether the request parameters are valid.

+

403

+

DCS.2007

+

Policy does not allow {} to be performed.

+

Insufficient permissions.

+

Check whether the account has the required operation permissions.

+

403

+

DCS.3002

+

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

+

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

+

Check whether the request parameters are valid.

+

403

+

DCS.3003

+

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

+

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

+

Check whether the request parameters are valid.

+

404

+

111404001

+

The requested URL does not exist.

+

The requested URL does not exist.

+

Check whether the request parameters are valid.

+

404

+

111404022

+

This DCS instance does not exist.

+

This DCS instance does not exist.

+

Check whether the request parameters are valid.

+

404

+

111404023

+

This DCS order does not exist.

+

The order does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.4001

+

The requested URL does not exist.

+

The requested URL does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.4022

+

This DCS instance does not exist.

+

This DCS instance does not exist.

+

Check whether the request parameters are valid.

+

404

+

DCS.4023

+

This DCS order does not exist.

+

The order does not exist.

+

Check whether the request parameters are valid.

+

405

+

111405001

+

This request method is not allowed.

+

The request method is not allowed.

+

Check whether the request parameters are valid.

+

405

+

DCS.5001

+

This request method is not allowed.

+

The request method is not allowed.

+

Check whether the request parameters are valid.

+

500

+

111400069

+

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

+

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

+

Try again later.

+

500

+

111400101

+

Delete instance backup file failed.

+

Failed to delete the instance backup files.

+

Contact technical support.

+

500

+

111400842

+

job execution status failed.

+

Failed to run the task.

+

Contact technical support.

+

500

+

111500000

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500006

+

+

Failed to submit Job for background execution.

+

Failed to submit Job for background execution.

+

Contact technical support.

+

500

+

111500017

+

+

Failed to save instance information.

+

Failed to save instance information.

+

Contact technical support.

+

500

+

111500020

+

vm add port fail

+

A port fails to be added for the VM.

+

Contact technical support.

+

500

+

111500024

+

+

Query instance failed.

+

The instance fails to be queried.

+

Contact technical support.

+

500

+

111500031

+

create instance fail

+

Failed to create the DCS instance.

+

Contact technical support.

+

500

+

111500032

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500037

+

query order info fail

+

Failed to query the order details.

+

Try again later or contact technical support.

+

500

+

111500041

+

No resource tenant available.

+

No resource tenant available.

+

Try again later or contact technical support.

+

500

+

111500044

+

update resource status fail

+

Failed to update the status of the DCS instance.

+

Try again later or contact technical support.

+

500

+

111500053

+

+

No instance node found.

+

No instance node found.

+

Contact technical support.

+

500

+

111500054

+

+

Generate a password error.

+

Failed to generate a password.

+

Contact technical support.

+

500

+

111500070

+

Internal service error.

+

Parameter modification failed.

+

Contact technical support.

+

500

+

111500071

+

Failed to create instance backup strategy.

+

The instance backup policy fails to be created.

+

Contact technical support.

+

500

+

111500077

+

Query instance backup strategy failed.

+

The instance backup policy fails to be queried.

+

Contact technical support.

+

500

+

111500078

+

Query backup record failed.

+

The backup record fails to be queried.

+

Contact technical support.

+

500

+

111500079

+

+

Query restore record failed.

+

The restoration record fails to be queried.

+

Contact technical support.

+

500

+

111500082

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500083

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500085

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500090

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500092

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

111500104

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DCS. 5094

+

Master standby swap failed.

+

Master/Standby switchover failed.

+

Contact technical support.

+

500

+

DCS.4069

+

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

+

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

+

Try again later.

+

500

+

DCS.4101

+

Delete instance backup file failed.

+

Failed to delete the instance backup files.

+

Contact technical support.

+

500

+

DCS.4842

+

job execution status failed.

+

Failed to run the task.

+

Contact technical support.

+

500

+

DCS.5000

+

The system is busy. Please try again later.

+

System busy. Try again later.

+

Contact technical support.

+

500

+

DCS.5006

+

Job submit failed

+

Failed to submit the task.

+

Contact technical support.

+

500

+

DCS.5006

+

Submit job failed.

+

Failed to submit the task.

+

Contact technical support.

+

500

+

DCS.5017

+

Failed to save instance information.

+

Failed to save the instance information.

+

Contact technical support.

+

500

+

DCS.5020

+

vm add port fail

+

A port fails to be added for the VM.

+

Contact technical support.

+

500

+

DCS.5024

+

Query instance failed.

+

The instance fails to be queried.

+

Contact technical support.

+

500

+

DCS.5031

+

create instance fail

+

Failed to create the DCS instance.

+

Contact technical support.

+

500

+

DCS.5032

+

Failed to create order.

+

Failed to create the order number.

+

Contact technical support.

+

500

+

DCS.5037

+

query order info fail

+

Failed to query the order details.

+

Contact technical support.

+

500

+

DCS.5041

+

No resource tenant available.

+

No resource tenant available.

+

Contact technical support.

+

500

+

DCS.5044

+

update resource status fail

+

Failed to update the status of the DCS instance.

+

Contact technical support.

+

500

+

DCS.5053

+

Instance node not found.

+

The specified instance node is not found.

+

Contact technical support.

+

500

+

DCS.5054

+

Failed to generate password.

+

The password fails to be generated.

+

Contact technical support.

+

500

+

DCS.5070

+

Internal service error.

+

Internal service error.

+

Contact technical support.

+

500

+

DCS.5071

+

Failed to create instance backup strategy.

+

The instance backup policy fails to be created.

+

Contact technical support.

+

500

+

DCS.5077

+

Query instance backup strategy failed

+

The instance backup policy fails to be queried.

+

Contact technical support.

+

500

+

DCS.5077

+

Query instance failed.

+

The instance fails to be queried.

+

Contact technical support.

+

500

+

DCS.5078

+

Query backup record failed.

+

The backup record fails to be queried.

+

Contact technical support.

+

500

+

DCS.5079

+

Query group node failed.

+

Failed to query the node.

+

Contact technical support.

+

500

+

DCS.5081

+

Query instance group information failed.

+

Failed to query the instance shard information.

+

Contact technical support.

+

500

+

DCS.5082

+

Failed to register resource tenant backup user.

+

The resource tenant backup user fails to be registered.

+

Contact technical support.

+

500

+

DCS.5083

+

Failed to save backup user.

+

The backup user fails to be saved.

+

Contact technical support.

+

500

+

DCS.5085

+

Query instance whitelist failed.

+

Failed to query the instance whitelist.

+

Contact technical support.

+

500

+

DCS.5090

+

Failed to save backup information.

+

The backup information fails to be saved.

+

Contact technical support.

+

500

+

DCS.5091

+

Do not support create small spec instance.

+

Small-specification instances cannot be created.

+

Contact technical support.

+

500

+

DCS.5092

+

Failed to get master node.

+

The master node of a master/standby instance cannot be found.

+

Contact technical support.

+

500

+

DCS.5095

+

The script execution failed and needs to be retried.

+

The script fails to be executed and needs to be executed again.

+

Contact technical support.

+

500

+

DCS.5104

+

Failed to modify order.

+

Failed to modify the order.

+

Contact technical support.

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

Obtaining a Project ID

+

Obtaining a Project ID on the Console

A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.

+

The following procedure describes how to obtain a project ID:

+
  1. Sign up and log in to the management console.
  2. Click the username and choose My Credential from the drop-down list.

    On the My Credential page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

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

DCS Instance Statuses

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 DCS instance statuses

State

+

Description

+

CREATING

+

Creating is the status before the Running state.

+

CREATEFAILED

+

The DCS instance failed to be created.

+

RUNNING

+

The instance is running properly.

+

Only instances in the Running state can provide in-memory cache service.

+

ERROR

+

The instance is not running properly.

+

RESTARTING

+

The instance is being restarted.

+

EXTENDING

+

The instance is being scaled up.

+

RESTORING

+

The instance data is being restored.

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

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Change history

Released On

+

What's New

+

2022-10-12

+

Modified the following content:

+ +

2022-08-04

+

Modified the following content:

+ +

2022-07-13

+

Modified the following content:

+
  • Changed the JSON parameter type to Object.
  • Changed the Enum parameter type to String.
  • Added parameters cluster_v1 and node_role in section Querying Configuration Parameters.
+

2022-04-11

+

Modified the following content:

+

Added the spec_code parameter in section Scaling Up a DCS Instance.

+

2021-06-30

+

Modified the following content:

+ +

2021-04-14

+

Modified the following content:

+ + +

2020-09-30

+

Modified the following content:

+
  • Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs.
  • Added description about creating DCS Redis 4.0 and 5.0 instances in section Creating a DCS Instance.
  • Optimized Error Codes.
+

2020-06-16

+

Modified the following content:

+

Added error codes such as 111400102 in section Error Codes.

+

2020-03-25

+

Modified the following content:

+ +

2019-04-17

+

Accepted in OTC-4.0/Agile.

+

2019-03-30

+

Modified the following content:

+ +

2018-04-17

+

Modified the following content:

+ +

2018-03-16

+

Modified the following content:

+
  • Added description about the Redis-specific parameter notify-keyspace-events, and deleted description about the Redis-specific parameter maxclients. For details, see Querying Configuration Parameters.
  • Changed instance password complexity rules.
+

2017-11-08

+
Modified the following content:
  • Provided support for DCS instances in the cluster mode.
  • Changed instance password complexity rules.
+
+

Added the following content:

+ +

2017-05-30

+

Modified the following content:

+
  • Optimized instance query.
  • Provided a list of DCS error codes.
+
Added the following content:
  • Batch deletion of DCS instances
  • Redis-specific parameter latency-monitor-threshold
+
+

2017-04-05

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0417001.html b/docs/dcs/api-ref/dcs-api-0417001.html new file mode 100644 index 00000000..5f1446f9 --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0417001.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

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 one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

DCS APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details on how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/dcs/api-ref/dcs-api-0514003.html b/docs/dcs/api-ref/dcs-api-0514003.html new file mode 100644 index 00000000..488b1e6c --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0514003.html @@ -0,0 +1,15 @@ + + + +

Data Migration APIs

+ +

+
+ +
+ +
+ diff --git a/docs/dcs/api-ref/dcs-api-0514004.html b/docs/dcs/api-ref/dcs-api-0514004.html new file mode 100644 index 00000000..614756bb --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0514004.html @@ -0,0 +1,394 @@ + + +

Creating a Data Migration Task

+

Function

This API is used to create a data migration task.

+
+

Constraints

None

+
+

URI

POST /v2/{project_id}/migration-task

+ +
+ + + + + + + + + + + +
Table 1 URI parameter

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+

Request

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

task_name

+

Yes

+

String

+

Name of the migration task.

+

description

+

No

+

String

+

Description of the migration task.

+

migration_type

+

Yes

+

String

+

Mode of the migration.

+

Options:

+
  • backupfile_import: indicates importing backup files.
  • online_migration: indicates migrating data online.
+

migration_method

+

Yes

+

String

+

Type of the migration.

+

Options:

+
  • full_amount_migration: indicates a full migration.
  • incremental_migration: indicates an incremental migration.
+

backup_files

+

No

+

BackupFilesBody Object

+

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

+

network_type

+

No

+

String

+

Type of the network for communication between the source and destination Redis when the migration mode is online data migration.

+

Options:

+
  • vpc
  • vpn
+

source_instance

+

No

+

SourceInstanceBody Object

+

Source Redis information. This parameter is mandatory when the migration mode is online data migration.

+

target_instance

+

Yes

+

TargetInstanceBody Object

+

Destination Redis instance information.

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

Parameter

+

Mandatory

+

Type

+

Description

+

file_source

+

No

+

String

+

Data source. Currently, only OBS buckets are supported. The value is self_build_obs.

+

bucket_name

+

Yes

+

String

+

OBS bucket name.

+

files

+

Yes

+

Array of Files Objects

+

List of backup files to be imported.

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

Parameter

+

Mandatory

+

Type

+

Description

+

file_name

+

Yes

+

String

+

Name of a backup file.

+

size

+

No

+

String

+

File size in bytes.

+

update_at

+

No

+

String

+

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

addrs

+

Yes

+

String

+

Source Redis name (specified in the source_instance parameter).

+

password

+

No

+

String

+

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

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

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Destination Redis instance ID (mandatory in the target_instance parameter).

+

name

+

No

+

String

+

Destination Redis instance name (specified in the target_instance parameter).

+

password

+

No

+

String

+

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

+
+
+
+

Response

If the status code is 200, the following parameters are returned:

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Parameter description

Parameter

+

Type

+

Description

+

id

+

String

+

ID of the migration task.

+

name

+

String

+

Name of the migration task.

+

status

+

String

+

Migration task status. The value can be:

+
  • SUCCESS: Migration succeeded.
  • FAILED: Migration failed.
  • MIGRATING: Migration is in progress.
  • TERMINATED: Migration has been stopped.
  • TERMINATING: Migration is being stopped.
  • RUNNING: The migration task has been created and is waiting to be executed.
  • CREATING: The migration task is being created.
  • FULLMIGRATING: Full migration is in progress.
  • INCRMIGEATING: Incremental migration is in progress.
  • ERROR: faulty
  • DELETED: faulty
  • RELEASED: automatically released
  • MIGRATION_SUCCESS: The migration is successful, and resources are to be cleared.
  • MIGRATION_FAILED: The migration failed, and resources are to be cleared.
+
+
+
+

Example Request

+
+

Example Response

If the status code is 200, the data migration task is successfully created.

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

Status Code

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

Status Code

+

Description

+

200

+

Data migration task created successfully.

+

400

+

Invalid request.

+

500

+

Internal service error.

+
+
+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Data Migration APIs
+
+
+ diff --git a/docs/dcs/api-ref/dcs-api-0514005.html b/docs/dcs/api-ref/dcs-api-0514005.html new file mode 100644 index 00000000..315a89de --- /dev/null +++ b/docs/dcs/api-ref/dcs-api-0514005.html @@ -0,0 +1,20 @@ + + +

Backup and Restoration APIs

+

+
+
+ +
+ diff --git a/docs/dcs/api-ref/en-us_image_0216824199.jpg b/docs/dcs/api-ref/en-us_image_0216824199.jpg new file mode 100644 index 00000000..b0e263d9 Binary files /dev/null and b/docs/dcs/api-ref/en-us_image_0216824199.jpg differ diff --git a/docs/dcs/api-ref/public_sys-resources/ExpandCollapse.js b/docs/dcs/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..116ddaab --- /dev/null +++ b/docs/dcs/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/dcs/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/dcs/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/dcs/api-ref/public_sys-resources/commonltr.css b/docs/dcs/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/dcs/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/dcs/api-ref/public_sys-resources/commonltr_print.css b/docs/dcs/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/dcs/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/dcs/api-ref/public_sys-resources/commonrtl.css b/docs/dcs/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..f261da75 --- /dev/null +++ b/docs/dcs/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/dcs/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/dcs/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/dcs/api-ref/public_sys-resources/delta.gif b/docs/dcs/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/deltaend.gif b/docs/dcs/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/dcs/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/dcs/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-caution.gif b/docs/dcs/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-danger.gif b/docs/dcs/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-huawei.gif b/docs/dcs/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-note.gif b/docs/dcs/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-notice.gif b/docs/dcs/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-tip.gif b/docs/dcs/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/icon-warning.gif b/docs/dcs/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/dcs/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/dcs/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/dcs/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/dcs/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/dcs/api-ref/public_sys-resources/popup.js b/docs/dcs/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..a550862e --- /dev/null +++ b/docs/dcs/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/dcs/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/dcs/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/dcs/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/dcs/api-ref/topic_300000009.html b/docs/dcs/api-ref/topic_300000009.html new file mode 100644 index 00000000..fc289737 --- /dev/null +++ b/docs/dcs/api-ref/topic_300000009.html @@ -0,0 +1,13 @@ + + +

Network Security

+
+
+ +
+