更新时间:2025-08-11 GMT+08:00

获取私有provider版本元数据

功能介绍

获取私有provider版本元数据(ShowPrivateProviderVersionMetadata)

获取某个私有provider版本的元数据信息

  • 具体返回信息见ShowPrivateProviderVersionMetadataResponseBody

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

URI

GET /v1/private-providers/{provider_name}/versions/{provider_version}/metadata

表1 路径参数

参数

是否必选

参数类型

描述

provider_name

String

私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。

provider_version

String

provider的版本号。版本号遵循语义化版本号(Semantic Version),为用户自定义

表2 Query参数

参数

是否必选

参数类型

描述

provider_id

String

私有provider的唯一Id,由资源编排服务随机生成,为UUID。

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

对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。

因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。

如果给予的provider_id和当前私有provider的Id不一致,则返回400。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

String

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

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

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

provider_name

String

私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。

按照HCL最佳实践,该名称推荐为在模板中定义的provider的本地名称(local_name)。

创建私有Provider(CreatePrivateProvider)API 还会以 “huawei.com/private-provider”为固定前缀,并以“huawei.com/private-provider/{provider_name}”的形式返回provider_source字段。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。

provider_version

String

provider的版本号。版本号必须遵循语义化版本号(Semantic Version),为用户自定义

version_description

String

私有provider版本(provider version)的描述。可用于客户识别并管理私有provider的版本。注意:provider版本为不可更新(immutable),所以该字段不可更新,如果需要更新,请删除后重建

function_graph_urn

String

FunctionGraph方法的统一资源标识,用于唯一标识的FunctionGraph方法。当前只支持和RFS同region的function_graph_urn,如果给予了关于其他region的,会报错400。

关于该参数的详细解释,请参考官方文档:https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0102.html

create_time

String

私有provider(private-provider)版本的生成时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。

provider_source

String

用户使用私有provider,在Terraform模板中定义required_providers信息时,需要指明的source参数。

该参数按照“huawei.com/private-provider/{provider_name}”的形式拼接。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。

状态码: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

响应消息

请求示例

  • 获取私有provider指定版本的元数据信息

    GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0/metadata
  • 获取私有provider指定版本的元数据信息,并提供provider id以校验是否与当前私有provider匹配

    GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0/metadata?provider_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3

响应示例

状态码:200

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

{
  "provider_name" : "my-hello-world-provider-name",
  "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
  "provider_version" : "3.7.10",
  "version_description" : "my first hello world private provider version",
  "create_time" : "1970-01-01T00:00:00.000Z",
  "function_graph_urn" : "urn:fss:cn-north-7:b61dfe3154de4282787126568d5040f:function:default:myFG:latest",
  "provider_source" : "huawei.com/private-provider/my-hello-world-provider-name"
}

状态码

状态码

描述

200

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

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

私有provider或者私有provider版本号不存在

429

请求数量过多

500

服务器内部错误