Obtaining the policy of a private hook version

ShowPrivateHookVersionPolicy

You can use this API to obtain the private hook version policy.

If the private hook version policy is successfully obtained, the download link for the private hook version policy (OBS presigned URL, valid for 5 minutes) is returned in temporary redirection mode. Most clients automatically redirect and download the private hook version policy.
If automatic redirection is not performed, refer to the HTTP redirection rule and manually download the private hook version policy.

GET /v1/private-hooks/{hook_name}/versions/{hook_version}/policies

**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.
hook_version	Yes	String	Private hook version. The version number follows the Semantic Version and is customized by the user.

**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, 400 is returned.

**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.

Status code: 307

**Table 4** Response header parameters
Parameter	Type	Description
Location	String	HTTP redirect header. The client can use this header to redirect to a download link for the private hook version policy (OBS presigned URL, valid for 5 minutes).

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 429

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

Status code: 500

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

Obtaining the policy of a private hook version

GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions/0.0.1/policies

Obtaining the policy of a 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/policies?hook_id=d3e79f29-1b5c-44b2-8236-d609a59a634e

None

Status Code	Description
307	Private hook version policy obtained. Temporary redirect.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
404	1.The private hook does not exist. 2.The private hook version does not exist.
429	Too frequent requests.
500	Internal server error.