Help Center> Cloud Backup and Recovery> API Reference> CBR APIs> Vaults> Associating Resources
View PDF

Associating Resources

Function

This API is used to associate resources with a vault.

URI

POST /v3/{project_id}/vaults/{vault_id}/addresources

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

vault_id

Yes

String

Vault ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Obtained by calling the corresponding IAM API. If the request is successfully processed, the value of X-Subject-Token included in the response header is the token value.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resources

Yes

Array of ResourceCreate objects

Resource list
Table 4 ResourceCreate

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. Possible values are as follows: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, and OS::Sfs::Turbo

name

No

String

Resource name

Minimum: 0

Maximum: 255
Table 5 ResourceExtraInfo

Parameter

Mandatory

Type

Description

exclude_volumes

No

Array of strings

ID of the disk that is excluded from the backup. This parameter is used only when there are VM disk backups.

include_volumes

No

Array of ResourceExtraInfoIncludeVolumes objects

Disk to be backed up
Table 6 ResourceExtraInfoIncludeVolumes

Parameter

Mandatory

Type

Description

id

Yes

String

EVS disk ID. Only UUID is supported.

os_version

No

String

OS type

Response Parameters

Status code: 200

Table 7 Response body parameters

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.

Parent topic: Vaults