Delete a private hook version
Function
DeletePrivateHookVersion
This API deletes a private hook version.
-
The default version can only be deleted by calling DeletePrivateHook API. All other versions except the default one can be deleted using this API.
-
If both hook_name and hook_id are provided, RFS verifies whether they match. If hook_id does not match the current private hook ID, 400 is returned.
Please use with caution.
URI
DELETE /v1/private-hooks/{hook_name}/versions/{hook_version}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
hook_name |
Yes |
String |
Private hook name. The name is unique within its domain (domain_id) and region. It can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-). The first character must be a Chinese or English character. It is case sensitive. We recommend users to use a three-part namespace for naming: {custom-hook-name}-{hook application context}-hook. |
hook_version |
Yes |
String |
Private hook version. The version number follows the Semantic Version and is customized by the user. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
hook_id |
No |
String |
Unique ID of a private hook. It is an UUID generated by RFS when a private hook is created. Private hook names are unique only at one specific time, so you can create a private hook named helloWorld and another private hook with the same name after deleting the first one. For parallel development in a team, users may want to ensure that the private hook they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each private hook is different and does not change with updates. If the hook_id value is different from the current private hook ID, 400 is returned. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Client-Request-Id |
Yes |
String |
Unique request ID. It is specified by a user and is used 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 |
Status code: 401
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 |
Status code: 404
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 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code |
error_msg |
String |
Response message |
Example Requests
-
Delete a specified private hook version
DELETE https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions/0.0.1
-
Delete a specified private hook version and check whether the provided private hook ID matches the current private hook
DELETE https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions/0.0.1?hook_id=d3e79f29-1b5c-44b2-8236-d609a59a634e
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
Private hook version deleted successfully. No content returned. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
1.The user is not allowed to delete the default version. 2.The user does not have the permission to call this API. |
404 |
The private hook or private hook 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