Associating Resources
Function
This API is used to associate resources with a vault.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v3/{project_id}/vaults/{vault_id}/addresources
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
vault_id |
Yes |
String |
Vault ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resources |
Yes |
Array of ResourceCreate objects |
Resource list Minimum length: 1 Maximum length: 256 Array Length: 1 - 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
extra_info |
No |
ResourceExtraInfo object |
Extra information of the resource |
id |
Yes |
String |
ID of the resource to be backed up |
type |
Yes |
String |
Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2 |
name |
No |
String |
Backup name Minimum: 0 Maximum: 255 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
exclude_volumes |
No |
Array of strings |
IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
add_resource_ids |
Array of strings |
List of resource IDs that have been added |
Example Requests
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/addresources { "resources" : [ { "extra_info" : { "exclude_volumes" : [ "bdef09bb-293f-446a-88a4-86e9f14408c4" ] }, "id" : "97595625-198e-4e4d-879b-9d53f68ba551", "type" : "OS::Nova::Server" } ] }
Example Responses
Status code: 200
OK
{ "add_resource_ids" : [ "97595625-198e-4e4d-879b-9d53f68ba551" ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
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