Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ File Backup/ Adding File Paths
Updated on 2024-12-20 GMT+08:00
View PDF
Share

Adding File Paths

Function

This API is used to add the file paths you want to back up from a client. Path validity will not be checked.

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}/agents/{agent_id}/add-path

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

agent_id

Yes

String

Client ID

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

add_path

Yes

Array of strings

Details of the paths to be added

exclude_path

No

Array of ExcludePath objects

Adding an excluded directory.

NOTE:

This feature is in the open beta test (OBT) phase and may be unavailable in some regions.
Table 4 ExcludePath

Parameter

Mandatory

Type

Description

path_name

No

String

Backup directory.

exclude_path_name

No

Array of strings

Excluded directory list

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

added

Array of strings

List of the added paths

existed

Array of strings

List of the existing paths

Example Requests

POST  https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/79bd9daa-884f-4f84-b8fe-235d58cd927d/add-path

{
  "add_path" : [ "/home/hcp", "/opt/workspace/" ],
  "exclude_path" : [ {
    "path_name" : "/home/hcp",
    "exclude_path_name" : [ "/home/hcp/1", "/home/hcp/2" ]
  }, {
    "path_name" : "/opt/workspace/",
    "exclude_path_name" : [ "/opt/workspace/1", "/opt/workspace/2" ]
  } ]
}

Example Responses

Status code: 200

OK

{
  "added" : [ "/opt/backup", "/var/log" ],
  "existed" : [ "/tmp/backup" ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: File Backup