Removing File Paths
Function
This API is used to remove the file paths added for backup.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v3/{project_id}/agents/{agent_id}/remove-path
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
agent_id |
Yes |
String |
Agent ID |
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
remove_path |
Yes |
Array of strings |
Details of the paths to be removed |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
removed |
Array of strings |
List of the removed paths |
|
not_existed |
Array of strings |
List of the paths that are not existed |
Example Requests
Removing File Paths
POST https://{endpoint}/v3/{project_id}/agents/{agent_id}/remove-path
{
"remove_path" : [ "/tmp", "/home" ]
}
Example Responses
Status code: 200
OK
{
"removed" : [ "/tmp" ],
"not_existed" : [ "/home" ]
}
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