/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/afmcos/reconcile: POST

Reconciles objects between local cache and cloud object storage for an AFM fileset in an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}/filesets/{fileset}/afmcos/reconcile request reconciles objects between the local cache and cloud object storage for an AFM fileset. To run this request, you must have the RBAC permission for the post action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/afmcos/reconcile resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/afmcos/reconcile

where

{filesystem}: Specifies the name of the file system.
{fileset}: Specifies the name of the AFM fileset.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/optional
filesystem	The name of the filesystem.	Required.
fileset	The name of the AFM fileset.	Required.
reconcile_objects	The body of the request that contains the reconcile parameters and options. `{ "add_policy": "string", "evict_reconcile": false, "list_policy": false, "path_for_reconcile": "string", "policy_path": "string", "remove_policy": false }`	Required.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `X-StorageScaleDomain`.	Optional.

Request data

The request body contains the reconcile parameters in JSON format:

{
  "add_policy": "string",
  "evict_reconcile": false,
  "list_policy": false,
  "path_for_reconcile": "string",
  "policy_path": "string",
  "remove_policy": false
}

Response data

200: A successful response and reconcile operation is completed.

{
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

202: The request has been accepted for processing, but the processing has not been completed.

{
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example reconciles objects for the test-mos-fset-mu fileset in the fs1 file system:

Request data:

curl -X 'POST' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs1/filesets/test-mos-fset-mu/afmcos/reconcile' \
  -H 'accept: application/json' \
  -H 'authorization: Basic cm9vdDpXZWxjb21lMmlibTEyM0A=' \
  -H 'Content-Type: application/json' \
  -d '{
  "add_policy": "",
  "evict_reconcile": true,
  "list_policy": false,
  "path_for_reconcile": "/gpfs/fs1/test-mos-fset-mu",
  "policy_path": "",
  "remove_policy": false
}'

Response data:

{
	"name":  "MTo5OWMxNzAyMS05NmQzLTQ4OWYtOWI2OC0xMTk5MmRiM2MzNTE=",
	"metadata":  {
		"@type":  "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id":  "MTo5OWMxNzAyMS05NmQzLTQ4OWYtOWI2OC0xMTk5MmRiM2MzNTE=",
		"operation_details":  {
			"@type":  "type.googleapis.com/afmcosctl.v3.ReconcileFilesetObjectsRequest",
			"filesystem":  "fs1",
			"fileset":  "test-mos-fset-mu",
			"reconcile_objects":  {
				"path_for_reconcile":  "/gpfs/fs1/test-mos-fset-mu",
				"policy_path":  "",
				"add_policy":  "",
				"remove_policy":  false,
				"list_policy":  false,
				"evict_reconcile":  true,
				"nodelete_reconcile":  false,
				"noshowbytes_reconcile":  false,
				"metadata_reconcile":  false
			}
		},
		"status":  "RUNNING",
		"check_point":  "",
		"request_time":  "2026-04-08T06:24:38.784774754Z",
		"completion_time":  null,
		"last_update_time":  "2026-04-08T06:24:38.785370860Z",
		"output":  "",
		"domain_ids":  [
			0
		]
	},
	"done":  false
}