Updating metadata of a private provider
Function
UpdatePrivateProviderMetadata
You can use this API to update the private provider metadata.
-
Currently, only the description of private providers can be updated.
-
If you need to create a new version, please call CreatePrivateProviderVersion API.
-
The update is an incremental update, meaning if a parameter is not provided, the original value will be retained.
-
If the request does not contain any parameters that need to be updated, 400 status code will be returned. Note: Even if the original value and the target value are the same, it is considered a valid update.
-
After the update, the update time of the private provider will also be updated.
-
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
PATCH /v1/private-providers/{provider_name}/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. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
provider_description |
No |
String |
Description of a private provider. It can be used by customers to identify their own private providers. |
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. |
Response Parameters
Status code: 204
Private provider metadata updated.
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
-
Update metadata of a specified private provider.
PATCH https://{endpoint}/v1/private-providers/my-hello-world-provider-name/metadata { "provider_description" : "my first private provider" }
-
Update metadata of a specified private provider and check whether the provided private provider ID matches the current private 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" }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
Private provider metadata updated. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
The user does not have the permission to call this API. |
404 |
The private provider 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