Obtaining metadata of a private provider version
Function
ShowPrivateProviderVersionMetadata
You can use this API to obtain the private provider version metadata.
-
Please refer to the ShowPrivateProviderVersionMetadataResponseBody for specific returned response.
-
If both provider_name and provider_id are provided, RFS verifies whether they match. If provider_id does not match the current private provider ID, 400 is returned.
URI
GET /v1/private-providers/{provider_name}/versions/{provider_version}/metadata
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
provider_name |
Yes |
String |
Private provider name. The name is unique within its domain (domain_id) and region.Only letters, digits, and hyphens (-) are allowed. The name only supports starting and ending with lowercase English and numbers. |
provider_version |
Yes |
String |
Private provider version. The version number follows the Semantic Version and is customized by the user. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
provider_id |
No |
String |
Unique ID of a private provider. It is a UUID generated by RFS when a private provider is created. Private provider names are unique only at one specific time, so you can create a private provider named helloWorld and another private provider with the same name after deleting the first one. For parallel development in a team, users may want to ensure that the private provider they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each private provider is different and does not change with updates. If the provider_id value is different from the current private provider ID, 400 is returned. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Client-Request-Id |
Yes |
String |
Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
provider_id |
String |
Unique ID of a private provider. It is a UUID generated by RFS when a private provider is created. Private provider names are unique only at one specific time, so you can create a private provider named helloWorld and another private provider with the same name after deleting the first one. For parallel development in a team, users may want to ensure that the private provider they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each private provider is different and does not change with updates. If the provider_id value is different from the current private provider ID, 400 is returned. |
provider_name |
String |
Private provider name. The name is unique within its domain (domain_id) and region. Only letters, digits, and hyphens (-) are allowed. The name only supports starting and ending with lowercase English and numbers. Following the HCL best practices, provider name is recommended to be the local name of the private provider defined in the template. CreatePrivateProvider API also uses "huawei.com/private-provider" as the fixed prefix and returns the provider_source value in the form of "huawei.com/private-provider/{provider_name}". For more details on the use of provider_name and provider_source in templates, see the API description of CreatePrivateProvider API. |
provider_version |
String |
Private provider version. The version number follows the Semantic Version and is customized by the user. |
version_description |
String |
The Description of the private provider version. It can be used by users to identify and manage private provider versions. Note: The private provider version is immutable, so the description cannot be updated. If it needs to be updated, please delete private provider version and rebuild it. |
function_graph_urn |
String |
Uniform resource identifier for FunctionGraph methods, it can be used to uniquely identify FunctionGraph methods. Only supports the function graph urns in the same region as RFS. If provided in other regions, 400 is returned. For more detail about this parameter, please refer to the official documentation: https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0102.html |
create_time |
String |
Time when a private provider version is created. It uses a UTC (YYYY-MM-DDTHH:mm:ss.SSSZ) format, for example, 1970-01-01T00:00:00.000Z. |
provider_source |
String |
When users use private providers and define required_providers information in the template, they need to specify the source using provider_source value. Provider source is spliced in the form of "huawei.com/private-provider/{provider_name}". For more details on the use of provider_name and provider_source in templates, see the API description of CreatePrivateProvider. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error messages returned by service when permission is denied. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error messages returned by service when permission is denied. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error messages returned by service when permission is denied. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error messages returned by service when permission is denied. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error messages returned by service when permission is denied. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
details |
Array of Detail objects |
Detailed error messages returned by service when permission is denied. |
Example Requests
-
Obtain metadata of a specified private provider version.
GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0/metadata
-
Obtain metadata of a specified private provider version and check whether the provided private provider ID matches the current private provider.
GET https://{endpoint}/v1/private-providers/my-hello-world-provider-name/versions/1.0.0/metadata?provider_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3
Example Responses
Status code: 200
Private provider version metadata obtained.
{ "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" }
Status Codes
Status Code |
Description |
---|---|
200 |
Private provider version metadata obtained. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
The user does not have the permission to call this API. |
404 |
The private provider or private provider version does not exist. |
429 |
Too frequent requests. |
500 |
Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot