获取私有provider元数据
功能介绍
获取私有provider元数据(ShowPrivateProviderMetadata)
获取某个私有provider的元数据信息
-
具体返回的信息见ShowPrivateProviderMetadataResponseBody,如果想查看私有provider下全部provider版本,请调用ListPrivateProviderVersions。
-
如果provider_name和provider_id同时存在,则资源编排服务会检查是否两个匹配,如果不匹配则会返回400。
URI
GET /v1/private-providers/{provider_name}/metadata
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
provider_name |
是 |
String |
私有provider(private-provider)的名称。此名字在domain_id+region下应唯一,可以使用小写英文、数字、中划线。仅支持以小写英文、数字开头结尾。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
provider_id |
否 |
String |
私有provider的唯一Id,由资源编排服务随机生成,为UUID。 由于私有provider名称仅仅在同一时间下唯一,即用户允许先生成一个叫helloword的私有provider,删除,再重新创建一个同名私有provider。 对于团队并行开发,用户可能希望确保,当前我操作的私有provider就是我以为的那个,而不是由其他队友删除后创建的同名私有provider。 因此,使用ID就可以做到强匹配。资源编排服务保证每次创建私有provider所对应的Id都不相同。 如果给予的provider_id和当前私有provider的Id不一致,则返回400。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Client-Request-Id |
是 |
String |
用户指定的,对于此请求的唯一Id,用于定位某个请求,推荐使用UUID |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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_description |
String |
私有provider(private-provider)的描述。可用于客户识别被管理的私有provider。 |
provider_source |
String |
用户使用私有provider,在Terraform模板中定义required_providers信息时,需要指明的source参数。 该参数按照“huawei.com/private-provider/{provider_name}”的形式拼接。关于provider_name和provider_source字段在模板中的使用细节,详见创建私有Provider的API描述。 |
provider_agency_urn |
String |
自定义provider所绑定的IAM委托URN,provider_agency_name和provider_agency_urn最多只能提供一个。 |
provider_agency_name |
String |
自定义provider所绑定的IAM委托名称,provider_agency_name和provider_agency_urn最多只能提供一个。 |
create_time |
String |
私有provider(private-provider)的生成时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 |
update_time |
String |
私有provider(private-provider)的更新时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z。 |
状态码: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 |
权限拒绝时服务返回的详细错误信息。 |
请求示例
-
获取私有provider元数据
GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name
-
获取私有provider元数据,并提供provider ID以校验是否与当前私有provider匹配
GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name?provider_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2
响应示例
状态码:200
获取私有provider元数据成功
{ "provider_name" : "my-hello-world-provider-name", "provider_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3", "provider_source" : "huawei.com/private-provider/my-hello-world-provider-name", "provider_description" : "my first hello world private provider", "create_time" : "1970-01-01T00:00:00.000Z", "update_time" : "1970-01-01T00:00:00.000Z" }
状态码
状态码 |
描述 |
---|---|
200 |
获取私有provider元数据成功 |
400 |
用户请求非法 |
401 |
用户身份认证失败 |
403 |
用户无权限调用此API |
404 |
私有provider不存在 |
429 |
请求数量过多 |
500 |
服务器内部错误 |