文档首页/ 资源编排服务 RFS/ API参考/ API/ 资源编排-Hook/ 获取私有hook版本的元数据
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

获取私有hook版本的元数据

功能介绍

获取私有hook版本的元数据（ShowPrivateHookVersionMetadata）

获取当前私有hook对应版本的元数据信息

  • 具体返回的信息见ShowPrivateHookVersionMetadataResponseBody。

  • 如果hook_name和hook_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

hook_name

是

String

私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

推荐用户使用三段命名空间：{自定义hook名称}-{hook应用场景}-hook。

hook_version

是

String

私有hook的版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义。
表2 Query参数

参数

是否必选

参数类型

描述

hook_id

否

String

私有hook（private-hook）的唯一Id。

此Id由资源编排服务在生成私有hook的时候生成，为UUID。

由于私有hook名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有hook，删除，再重新创建一个同名私有hook。

对于团队并行开发，用户可能希望确保，当前我操作的私有hook就是我认为的那个，而不是其他队友删除后创建的同名私有hook。因此，使用Id就可以做到强匹配。

资源编排服务保证每次创建的私有hook所对应的Id都不相同，更新不会影响Id。如果给予的hook_id和当前hook的Id不一致，则返回400。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

hook_name

String

私有hook的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

推荐用户使用三段命名空间：{自定义hook名称}-{hook应用场景}-hook。

hook_id

String

私有hook（private-hook）的唯一Id。

此Id由资源编排服务在生成私有hook的时候生成，为UUID。

由于私有hook名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有hook，删除，再重新创建一个同名私有hook。

对于团队并行开发，用户可能希望确保，当前我操作的私有hook就是我认为的那个，而不是其他队友删除后创建的同名私有hook。因此，使用Id就可以做到强匹配。

资源编排服务保证每次创建的私有hook所对应的Id都不相同，更新不会影响Id。如果给予的hook_id和当前hook的Id不一致，则返回400。

hook_version

String

私有hook的版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义。

hook_version_description

String

私有hook版本的描述。可用于客户识别创建私有hook的版本。注意：hook版本为不可更新（immutable），所以该字段不可更新，如果需要更新，请删除后重建。

create_time

String

私有Hook Version（private-hook-version）的生成时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表6 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表8 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表10 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表12 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 429

表13 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表14 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表16 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

请求示例

  • 获取私有hook版本元数据

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

  • 获取私有hook版本元数据，并提供hook ID以校验是否与当前私有hook匹配

    GET https://{endpoint}/v1/private-hooks/my-hello-world-hook-name/versions/0.0.1/metadata?hook_id=d3e79f29-1b5c-44b2-8236-d609a59a634e

响应示例

状态码： 200

获取私有hook版本元数据成功

{
  "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"
}

状态码

状态码

描述

200

获取私有hook版本元数据成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

1.私有hook不存在

2.私有hook版本不存在

429

请求数量过多

500

服务器内部错误
父主题： 资源编排-Hook