Delete a Private Module Version
Function
Delete a Private Module Version (DeletePrivateModuleVersion)
This API deletes a private module version.
-
If both module_name and module_id are provided, RFS checks whether they match. If module name does not match the current private module ID, error code 400 is returned.
** Please use with caution. **
URI
DELETE /v1/private-modules/{module_name}/versions/{module_version}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
module_name |
Yes |
String |
Name of a private module. The name is unique within its domain (domain_id) and region. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name is case-sensitive and must start with a letter. |
module_version |
Yes |
String |
Module version number. Each version number can be defined by following the semantic versioning format. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
module_id |
No |
String |
Unique ID of a private module. It is a UUID generated by RFS when a module is created. Private module names are unique only at a specific time, so you can create a private module named HelloWorld and another private module with the same name after deleting the first one. For parallel development, team members may want to ensure that they are operating the private module they created, not the one with the same name created by other members after deleting the previous one. To avoid this mismatch, check the ID, since RFS ensures each private module has a unique ID that does not change with updates. If the module_id differs from the current module ID, error code 400 is returned. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Client-Request-Id |
Yes |
String |
A unique request ID is specified by a user to locate a request. UUID is recommended. |
Response Parameters
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error information. It is returned by the service when the "permission denied" error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error information. It is returned by the service when the "permission denied" error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error information. It is returned by the service when the "permission denied" error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error information. It is returned by the service when the "permission denied" error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error information. It is returned by the service when the "permission denied" error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error information. It is returned by the service when the "permission denied" error occurs. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
Private module version deleted successfully. No content returned. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
The user does not have the permission to call this API. |
404 |
The module or module version does not exist. |
429 |
Too frequent requests. |
500 |
Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot