forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
353 lines
14 KiB
JSON
353 lines
14 KiB
JSON
[
|
|
{
|
|
"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"
|
|
}
|
|
] |