Showing metadata of a private hook version
Function
ShowPrivateHookVersionMetadata
You can use this API to show the private hook version metadata.
-
Please refer to the ShowPrivateHookVersionMetadataResponseBody for specific returned response.
-
If both hook_name and hook_id are provided, RFS checks whether they match. If hook name does not match the current private hook ID, error code 400 is returned.
URI
GET /v1/private-hooks/{hook_name}/versions/{hook_version}/metadata
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, error code 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: 200
Parameter |
Type |
Description |
---|---|---|
hook_name |
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_id |
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, error code 400 is returned. |
hook_version |
String |
Private hook version. The version number follows the Semantic Version and is customized by the user. |
hook_version_description |
String |
Description of the private hook version. It can be used by users to identify and manage private hook versions. Note: The private hook version is immutable, so the description cannot be updated. If it needs to be updated, please delete private hook version and rebuild it. |
create_time |
String |
Time when a private hook version is created. It uses a UTC (YYYY-MM-DDTHH:mm:ss.SSSZ) format, for example, 1970-01-01T00:00:00.000Z. |
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
-
Show metadata of a specified private hook version
GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions/0.0.1/metadata
-
Show metadata of a specified private hook version and check whether the provided private hook ID matches the current private hook
GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions/0.0.1/metadata?hook_id=d3e79f29-1b5c-44b2-8236-d609a59a634e
Example Responses
Status code: 200
Private hook version metadata showed.
{ "hook_name" : "my-hello-world-hook-name", "hook_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "hook_version" : "1.2.3", "hook_version_description" : "my first hello world private hook version", "create_time" : "1970-01-01T00:00:00.000Z" }
Status Codes
Status Code |
Description |
---|---|
200 |
Private hook version metadata showed. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
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