Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Check the (external) storage usage by the Synapse system.  You must be an administrator to perform these actions.

Get aggregated totals

Aggregate Aggregated over any combination of dimensions listed in StorageUsageDimension (see StorageUsageDimension in Synapse Entity Types) except for USER_ID and ENTITY_ID which are provided via separate APIs.  For the list of aggregating dimensions, see Synapse Entity Types.  For example, the following command lists storage usage by content type and storage provider:

...

Code Block
languagebash
curl -i -H sessionToken:<token> -H Accept:application/json https://repo-staging.sagebase.org/repo/v1/admin/storageSummary/perUser

Example response body listing the top 3 users:

Code Block
languagebash
{
    "summaryList": [
        {
            "aggregatedCount": 35204, 
            "aggregatedSize": 283329626902, 
            "dimensionList": [
                {
                    "dimension": "USER_ID", 
                    "value": "273975"
                }
            ]
        }, 
        {
            "aggregatedCount": 458, 
            "aggregatedSize": 227459357704, 
            "dimensionList": [
                {
                    "dimension": "USER_ID", 
                    "value": "342024"
                }
            ]
        }, 
        {
            "aggregatedCount": 179, 
            "aggregatedSize": 66928683678, 
            "dimensionList": [
                {
                    "dimension": "USER_ID", 
                    "value": "274010"
                }
            ]
        },
        ...
    ]
}

Get usage by entities

Lists the aggregated usage by entities in descending order of 'aggregatedSize':

Code Block
languagebash
curl -i -H sessionToken:<token> -H Accept:application/json https://repo-staging.sagebase.org/repo/v1/admin/storageSummary/perEntity

Example response body listing the top 3 entities:

Code Block
languagebash
{
    "summaryList": [
        {
            "aggregatedCount": 1, 
            "aggregatedSize": 5210220350, 
            "dimensionList": [
                {
                    "dimension": "NODE_ID", 
                    "value": "317475"
                }
            ]
        }, 
        {
            "aggregatedCount": 1, 
            "aggregatedSize": 4670860925, 
            "dimensionList": [
                {
                    "dimension": "NODE_ID", 
                    "value": "1113803"
                }
            ]
        }, 
        {
            "aggregatedCount": 2, 
            "aggregatedSize": 4235837739, 
            "dimensionList": [
                {
                    "dimension": "NODE_ID", 
                    "value": "4494"
                }
            ]
        }, 
        ...
    ]
}