Showing metadata of a private hook

Function

ShowPrivateHookMetadata

You can use this API to show the private hook metadata.

Please refer to the ShowPrivateHookMetadataResponseBody 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}/metadata

**Table 1** Path Parameters
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.

**Table 2** Query Parameters
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

**Table 3** Request header 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

**Table 4** Response body parameters
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_description	String	Description of a private hook. It can be used by customers to identify their own private hooks. You can update the description of the private hook by calling UpdatePrivateHook API.
default_version	String	Private hook default version. The version number follows the Semantic Version and is customized by the user.
configuration	configuration object	Private hook configuration. It can specify the target stack where the private hook takes effect and the behavior of the stack after the private hook verification fails. You can use UpdatePrivateHook API to update private hook configuration.
create_time	String	Time when a private hook is created. It uses a UTC (YYYY-MM-DDTHH:mm:ss.SSSZ) format, for example, 1970-01-01T00:00:00.000Z.
update_time	String	Time when a private hook is updated. It uses a UTC (YYYY-MM-DDTHH:mm:ss.SSSZ) format, for example, 1970-01-01T00:00:00.000Z.

**Table 5** configuration
Parameter	Type	Description
target_stacks	String	Specifies the target stack where the private hook takes effect. The value can be NONE or ALL. NONE: Specifies that this private hook will not be applied to any stacks. ALL: Specifies that the private hook will be applied to all stacks under the account.
failure_mode	String	Specifies the behavior when the private hook validation fails. Valid values are FAIL or WARN. FAIL: Specifies that if this private hook validation fails, the stack will stop deploying, and the stack status will be updated to DEPLOYMENT_FAILED. WARN: Specifies that if this private hook validation fails, only a warning message will be displayed through the stack events, but it will not affect the deployment of the stack.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Response code
error_msg	String	Response message

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Response code
error_msg	String	Response message

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Response code
error_msg	String	Response message

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Response code
error_msg	String	Response message

Status code: 429

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Response code
error_msg	String	Response message

Status code: 500

**Table 11** Response body parameters
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/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/metadata?hook_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2
```

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_description" : "my first hello world private hook",
  "default_version" : "1.2.3",
  "configuration" : {
    "target_stacks" : "NONE",
    "failure_mode" : "WARN"
  },
  "create_time" : "1970-01-01T00:00:00.000Z",
  "update_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 does not exist.
429	Too frequent requests.
500	Internal server error.