333 lines
45 KiB
ReStructuredText
333 lines
45 KiB
ReStructuredText
:original_name: dcs-api-0312044.html
|
||
|
||
.. _dcs-api-0312044:
|
||
|
||
Error Codes
|
||
===========
|
||
|
||
Failure Responses
|
||
-----------------
|
||
|
||
If an error occurs in API calling, HTTP status code 4xx or 5xx is returned. **FailMessage** is used as the response body to describe the cause of an error.
|
||
|
||
Response Message (v1.0)
|
||
-----------------------
|
||
|
||
.. table:: **Table 1** FailMessage parameter description
|
||
|
||
+-----------+--------+-----------+-------------------------------------------------------------------------------------------+
|
||
| Parameter | Type | Mandatory | Description |
|
||
+===========+========+===========+===========================================================================================+
|
||
| error | Object | Yes | Error description. For details, see :ref:`Table 2 <dcs-api-0312044__table9232115644314>`. |
|
||
+-----------+--------+-----------+-------------------------------------------------------------------------------------------+
|
||
|
||
.. _dcs-api-0312044__table9232115644314:
|
||
|
||
.. table:: **Table 2** Failure response parameter description
|
||
|
||
+-----------+--------+------------------------------------------------------------------------------+
|
||
| Parameter | Type | Description |
|
||
+===========+========+==============================================================================+
|
||
| code | String | Error code. For details, see :ref:`Table 4 <dcs-api-0312044__table4581796>`. |
|
||
+-----------+--------+------------------------------------------------------------------------------+
|
||
| message | String | Error information. |
|
||
+-----------+--------+------------------------------------------------------------------------------+
|
||
|
||
Example Response (v1.0)
|
||
-----------------------
|
||
|
||
.. code-block:: text
|
||
|
||
{
|
||
"error": {
|
||
"code": "111404022",
|
||
"message": "This DCS instance does not exist."
|
||
}
|
||
}
|
||
|
||
Response (v2)
|
||
-------------
|
||
|
||
.. table:: **Table 3** Failure response parameter description
|
||
|
||
+------------+--------+------------------------------------------------------------------------------+
|
||
| Parameter | Type | Description |
|
||
+============+========+==============================================================================+
|
||
| error_code | String | Error code. For details, see :ref:`Table 4 <dcs-api-0312044__table4581796>`. |
|
||
+------------+--------+------------------------------------------------------------------------------+
|
||
| error_msg | String | Detailed error information. |
|
||
+------------+--------+------------------------------------------------------------------------------+
|
||
|
||
Example Response (v2)
|
||
---------------------
|
||
|
||
.. code-block:: text
|
||
|
||
{
|
||
"error_code": "DCS.8001",
|
||
"error_msg": "fail to get order id."
|
||
}
|
||
|
||
Error Code
|
||
----------
|
||
|
||
:ref:`Table 4 <dcs-api-0312044__table4581796>` lists common DCS error codes.
|
||
|
||
.. _dcs-api-0312044__table4581796:
|
||
|
||
.. table:: **Table 4** Error codes
|
||
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| Status Code | Error Code | Error Message |
|
||
+=============+============+==========================================================================================================================================+
|
||
| 400 | 111400002 | Invalid project ID format. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400004 | Empty request body. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400005 | The message body contains invalid characters or is not in JSON format. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400007 | The selected cache engine edition is not supported. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400008 | The selected cache engine version is not supported. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400009 | Invalid product ID in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400010 | Invalid DCS instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400011 | DCS instance description cannot exceed 1024 characters. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400012 | Invalid capacity parameter in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400013 | Invalid **vpc_id** in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400014 | Invalid **security_group_id** in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400016 | Invalid **subnet_id** in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400017 | A background task associated with this instance is running. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400018 | This subnet must exist in the VPC. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400019 | The password does not meet complexity requirements. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400020 | DHCP must be enabled for this subnet. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400021 | Invalid **isAutoRenew** in the request. It must be either **0** or **1**. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400022 | The cache engine does not match the product ID. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400026 | This operation is not allowed when the DCS instance is in the current state. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400027 | The current node does not support this operation. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400035 | DCS instance quota of the tenant is insufficient. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400036 | Memory quota of the tenant is insufficient. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400037 | The **instanceParams** parameter in the request contains invalid characters or is not in JSON format. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400038 | The **periodNum** parameter in the request must be an integer. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400039 | Your quota has been reached. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400042 | This AZ does not exist. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400046 | This security group does not exist. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400047 | The **periodType** parameter in the request must be either **2** or **3**. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400048 | The security group must have both outbound and inbound rules with protocols set to **ANY**. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400051 | The package for upgrading the DCS instance to the target version was not found. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400052 | The DCS instance to be upgraded must be in the **Running** state. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400053 | The **targetVersion** parameter in the request cannot be the same as the source version. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400054 | The DCS quota in the selected AZ has been reached. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400060 | This instance name already exists. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400061 | Invalid instance ID format. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400062 | Invalid parameter **{0}** in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400063 | Invalid parameter **{0}** in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400064 | The **action** parameter in the request must be **start**, **stop**, or **restart**. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400065 | The **instances** parameter in the request cannot be a null value or left unspecified. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400066 | Invalid configuration parameter **{0}**. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400067 | The **available_zones** parameter in the request must be an array that contains only one AZ ID. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400068 | This VPC does not exist. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400070 | Invalid task ID format. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400072 | The value of the instance backup parameter **saveDays** in the request must be between 1 and 7. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400073 | The value of the instance backup parameter **backupType** in the request must be either auto or manual. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400074 | The value of the instance backup parameter **periodType** in the request must be weekly. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400075 | The value of the instance backup parameter **backupAt** in the request cannot be null or undefined. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400076 | The value of the instance backup parameter **beginAt** in the request must be in the 00:00–00:00 format. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400080 | Invalid password for accessing the selected DCS instance. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400086 | This operation is allowed only for master/standby DCS instances. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400087 | The restore operation is allowed only when the backup task is in the **Succeeded** state. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400094 | The system does not support the background task function. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400095 | Backup and restoration are not supported. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400096 | Backing up the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400097 | Restoring the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400098 | The value of the **remark** parameter cannot exceed 128 characters long. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400099 | DCS instances in the **Creating**, **Restarting**, or **Deleting** state cannot be deleted. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400100 | The number of instance IDs in an instances array cannot exceed 50. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400102 | Scale-up is not supported. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400103 | The capacity to which the DCS instance is scaled up must be greater than the original capacity. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400105 | The value of **reserved-memory** cannot be greater than the free memory size of this DCS instance. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400106 | Invalid maintenance time window. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400111 | Restarting the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400113 | Scaling up the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400114 | Modifying instance configuration... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400115 | Changing instance password... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400116 | Upgrading the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400117 | Rolling back the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400118 | Creating the DCS instance... Please try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400119 | This DCS instance does not exist. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 400 | 111400800 | Invalid parameter **{0}** in the request. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 401 | 111401001 | Invalid token. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 401 | 111401002 | Expired token. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 401 | 111401003 | Missing token. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 401 | 111401004 | Project ID does not match the token. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 403 | 111403002 | This tenant has read permissions only and cannot perform this operation. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 403 | 111403003 | This role does not have the permissions to perform this operation. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 404 | 111404001 | The requested URL does not exist. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 404 | 111404022 | This DCS instance does not exist. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 405 | 111405001 | This request method is not allowed. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111400069 | Another user is modifying configuration parameters of the DCS instance. Try again later. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111400101 | Failed to delete the instance backup files. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111400842 | Job execution failed. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500000 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500006 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500017 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500020 | Failed to add a port for the ECS. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500023 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500024 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500025 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500031 | Failed to create the DCS instance. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500032 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500041 | No resource tenant available. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500044 | Failed to update the status of the DCS instance. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500051 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500052 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500053 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500054 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500070 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500071 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500077 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500078 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500079 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500081 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500082 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500083 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500084 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500085 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500088 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500089 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500090 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500091 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500092 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500093 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500094 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500095 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500104 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500106 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500801 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500802 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500810 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500814 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500815 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500816 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| 500 | 111500820 | Internal service error. |
|
||
+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------+
|