更新私有模块元数据
功能介绍
更新私有模块元数据（UpdatePrivateModuleMetadata）
更新当前私有模块的元数据信息
-
目前只支持更新私有模块的描述
-
如果需要创建新的版本，请调用CreatePrivateModuleVersion
-
更新为增量更新，即如果某个参数不提供，则保持原始值
-
如果请求中没有需要被更新的参数，则返回400。注意：即使更新原始值和目标值一致也被认为是有效更新
-
更新后私有模块的更新时间（update_time）也会被更新
-
如果module_name和module_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PATCH /v1/private-modules/{module_name}/metadata
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
module_name |
是 |
String |
私有模块（private-module）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Client-Request-Id |
是 |
String |
用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
module_description |
否 |
String |
私有模块（private-module）的描述。可用于客户识别被管理的私有模块。如果想要更新私有模块的描述，可以通过UpdatePrivateModuleMetadata API。 |
|
module_id |
否 |
String |
私有模块（private-module）的唯一Id。 此Id由资源编排服务在生成模块的时候生成，为UUID。 由于私有模块名仅在同一时间下唯一，即允许用户先生成一个叫HelloWorld的私有模块，删除，再重新创建一个同名私有模块。 对于团队并行开发，用户可能希望确保，当前我操作的私有模块就是我以为的那个，而不是其他队友删除后创建的同名私有模块。因此，使用Id就可以做到强匹配。 资源编排服务保证每次创建的私有模块所对应的Id都不相同，更新不会影响Id。如果给予的module_id和当前模块的Id不一致，则返回400 |
响应参数
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码 |
|
error_msg |
String |
响应消息 |
|
encoded_authorization_message |
String |
包含有关未经授权请求的信息。 |
|
details |
Array of Detail objects |
权限拒绝时服务返回的详细错误信息。 |
请求示例
更新当前局点用户的私有模块的元数据
PATCH https://{endpoint}/v1/private-modules/{module_name}/metadata
{
"module_description" : "My First Hello World Module Description",
"module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
204 |
更新私有模块元数据成功，无数据返回 |
|
400 |
用户请求非法 |
|
401 |
用户身份认证失败 |
|
403 |
用户无权限调用此API |
|
404 |
模块不存在 |
|
429 |
请求数量过多 |
|
500 |
服务器内部错误 |
