更新私有provider元数据

功能介绍

更新私有provider元数据（UpdatePrivateProviderMetadata）

更新当前私有provider的元数据信息

目前只支持更新私有provider的描述
如果需要创建新的版本，请调用CreatePrivateProviderVersion
更新为增量更新，即如果某个参数不提供，则保持原始值
如果请求中没有需要被更新的参数，则返回400。注意：即使更新原始值和目标值一致也被认为是有效更新
更新后私有provider的更新时间（update_time）也会被更新
如果provider_name和provider_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。

URI

PATCH /v1/private-providers/{provider_name}/metadata

表1 路径参数
参数	是否必选	参数类型	描述
provider_name	是	String	私有provider（private-provider）的名称。此名字在domain_id+region下应唯一，可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Client-Request-Id	是	String	用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID

表3 请求Body参数
参数	是否必选	参数类型	描述
provider_description	否	String	私有provider（private-provider）的描述。可用于客户识别被管理的私有provider。
provider_id	否	String	私有provider（private-provider）的唯一Id。此Id由资源编排服务在生成provider的时候生成，为UUID。由于私有provider名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有provider，删除，再重新创建一个同名私有provider。对于团队并行开发，用户可能希望确保，当前我操作的私有provider就是我以为的那个，而不是其他队友删除后创建的同名私有provider。因此，使用Id就可以做到强匹配。资源编排服务保证每次创建的私有provider所对应的Id都不相同，更新不会影响Id。如果给予的provider_id和当前provider的Id不一致，则返回400

响应参数

状态码：204

更新私有provider元数据成功

状态码：400

表4 响应Body参数
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

表5 Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

表7 Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

表9 Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

状态码：404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

**表11** Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

状态码：429

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

**表13** Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

状态码：500

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息
encoded_authorization_message	String	包含有关未经授权请求的信息。
details	Array of Detail objects	权限拒绝时服务返回的详细错误信息。

**表15** Detail
参数	参数类型	描述
error_code	String	响应码
error_msg	String	响应消息

请求示例

更新私有provider元数据

PATCH https://{endpoint}/v1/private-providers/my-hello-world-provider-name/metadata

{
  "provider_description" : "my first private provider"
}

更新私有provider元数据，并提供provider ID以校验是否与当前私有provider匹配

PATCH https://{endpoint}/v1/private-providers/my-hello-world-provider-name/metadata

{
  "provider_description" : "my first private provider",
  "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3"
}

响应示例

无

状态码

状态码	描述
204	更新私有provider元数据成功
400	用户请求非法
401	用户身份认证失败
403	用户无权限调用此API
404	私有provider不存在
429	请求数量过多
500	服务器内部错误