Versions Compared

Old Version 8

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version Current

changes.mady.by.user Owen Nichols

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: automatically generated from 1.14.0 by update-management-wiki.sh

...

GET /management/v1/regions

list regions

Query parameters

group (optional)
Query Parameter -- group
id (optional)
Query Parameter -- id

Return type

ClusterManagementListResult_Region_RuntimeRegionInfo

Example data

Content-Type: application/json
{
  "result" : [ {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  }, {
    "groups" : [ {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    }, {
      "configuration" : {
        "expirations" : [ {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        }, {
          "action" : "DESTROY",
          "type" : "ENTRY_TIME_TO_LIVE",
          "timeInSeconds" : 1
        } ],
        "redundantCopies" : 5,
        "eviction" : {
          "entryCount" : 0,
          "objectSizer" : {
            "initProperties" : {
              "key" : { }
            },
            "className" : "className"
          },
          "action" : "LOCAL_DESTROY",
          "type" : "ENTRY_COUNT",
          "memorySizeMb" : 6
        },
        "keyConstraint" : "keyConstraint",
        "name" : "name",
        "valueConstraint" : "valueConstraint",
        "type" : "PARTITION",
        "diskStoreName" : "diskStoreName",
        "group" : "group"
      },
      "runtimeInfo" : [ {
        "entryCount" : 5,
        "memberName" : "memberName"
      }, {
        "entryCount" : 5,
        "memberName" : "memberName"
      } ]
    } ],
    "id" : "id"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListResult_Region_RuntimeRegionInfo

401

Unauthorized

403

Forbidden

404

Not Found

...

RestoreRedundancy Operation

GET /management/v1/operations/restoreRedundancy/{id}

get restore-redundancy

Path parameters

id (required)
Path Parameter -- id

Return type

ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

Example data

Content-Type: application/json
{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "reassignPrimaries" : true,
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "regionResults" : {
      "key" : {
        "configuredRedundancy" : 6,
        "regionName" : "regionName",
        "actualRedundancy" : 0,
        "status" : "SATISFIED"
      }
    },
    "underRedundancyRegionResults" : { },
    "zeroRedundancyRegionResults" : { },
    "totalPrimaryTransferTime" : 1,
    "totalPrimaryTransfersCompleted" : 5,
    "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
    "success" : true,
    "satisfiedRedundancyRegionResults" : { },
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

401

Unauthorized

403

Forbidden

404

Not Found

...

GET /management/v1/operations/restoreRedundancy

list restore-redundancy

Return type

ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults

Example data

Content-Type: application/json
{
  "result" : [ {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "reassignPrimaries" : true,
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "regionResults" : {
        "key" : {
          "configuredRedundancy" : 6,
          "regionName" : "regionName",
          "actualRedundancy" : 0,
          "status" : "SATISFIED"
        }
      },
      "underRedundancyRegionResults" : { },
      "zeroRedundancyRegionResults" : { },
      "totalPrimaryTransferTime" : 1,
      "totalPrimaryTransfersCompleted" : 5,
      "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
      "success" : true,
      "satisfiedRedundancyRegionResults" : { },
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  }, {
    "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "throwable" : {
      "localizedMessage" : "localizedMessage",
      "stackTrace" : [ {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      }, {
        "fileName" : "fileName",
        "nativeMethod" : true,
        "methodName" : "methodName",
        "className" : "className",
        "lineNumber" : 4
      } ],
      "suppressed" : [ null, null ],
      "message" : "message"
    },
    "operationId" : "operationId",
    "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "operation" : {
      "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
      "reassignPrimaries" : true,
      "includeRegions" : [ "includeRegions", "includeRegions" ],
      "operator" : "operator"
    },
    "statusMessage" : "statusMessage",
    "operationResult" : {
      "regionResults" : {
        "key" : {
          "configuredRedundancy" : 6,
          "regionName" : "regionName",
          "actualRedundancy" : 0,
          "status" : "SATISFIED"
        }
      },
      "underRedundancyRegionResults" : { },
      "zeroRedundancyRegionResults" : { },
      "totalPrimaryTransferTime" : 1,
      "totalPrimaryTransfersCompleted" : 5,
      "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
      "success" : true,
      "satisfiedRedundancyRegionResults" : { },
      "statusMessage" : "statusMessage"
    },
    "statusCode" : "OK"
  } ],
  "links" : { "self" : "uri" },
  "statusMessage" : "statusMessage",
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementListOperationsResult_RestoreRedundancyRequest_RestoreRedundancyResults

401

Unauthorized

403

Forbidden

404

Not Found

...

POST /management/v1/operations/restoreRedundancy

start restore-redundancy

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RestoreRedundancyRequest (required)
Body Parameter -- operation

Return type

ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

Example data

Content-Type: application/json
{
  "operationStart" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "throwable" : {
    "localizedMessage" : "localizedMessage",
    "stackTrace" : [ {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    }, {
      "fileName" : "fileName",
      "nativeMethod" : true,
      "methodName" : "methodName",
      "className" : "className",
      "lineNumber" : 4
    } ],
    "suppressed" : [ null, null ],
    "message" : "message"
  },
  "operationId" : "operationId",
  "operationEnd" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "operation" : {
    "excludeRegions" : [ "excludeRegions", "excludeRegions" ],
    "reassignPrimaries" : true,
    "includeRegions" : [ "includeRegions", "includeRegions" ],
    "operator" : "operator"
  },
  "statusMessage" : "statusMessage",
  "operationResult" : {
    "regionResults" : {
      "key" : {
        "configuredRedundancy" : 6,
        "regionName" : "regionName",
        "actualRedundancy" : 0,
        "status" : "SATISFIED"
      }
    },
    "underRedundancyRegionResults" : { },
    "zeroRedundancyRegionResults" : { },
    "totalPrimaryTransferTime" : 1,
    "totalPrimaryTransfersCompleted" : 5,
    "includedRegionsWithNoMembers" : [ "includedRegionsWithNoMembers", "includedRegionsWithNoMembers" ],
    "success" : true,
    "satisfiedRedundancyRegionResults" : { },
    "statusMessage" : "statusMessage"
  },
  "statusCode" : "OK"
}

Responses

200

OK ClusterManagementOperationResult_RestoreRedundancyRequest_RestoreRedundancyResults

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

...

Models

AutoSerializer

portable (optional)
Boolean
patterns (optional)
array[String]

...

ClusterManagementGetResult_GatewayReceiver_GatewayReceiverInfo

links (optional)
Links
result (optional)
EntityInfo_GatewayReceiver_GatewayReceiverInfo_GatewayReceiverInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementGetResult_Index_IndexInfo

links (optional)
Links
result (optional)
EntityInfo_Index_IndexInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementGetResult_

Index

Member_

IndexInfo

MemberInformation

links (optional)
Links
result (optional)
EntityInfo_IndexMember_IndexInfoMemberInformation
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementGetResult_

Member

Pdx_

MemberInformation

PdxInfo

links (optional)
Links
result (optional)
EntityInfo_MemberPdx_MemberInformationPdxInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementGetResult_

Pdx

Region_

PdxInfo

RuntimeRegionInfo

links (optional)
Links
result (optional)
EntityInfo_PdxRegion_PdxInfoRuntimeRegionInfo
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
ClusterManagementGetResult

ClusterManagementListOperationsResult_

Region

RebalanceOperation_

RuntimeRegionInfo

RebalanceResult

links (optional)
Links
result (optional)
EntityInfoarray[ClusterManagementOperationResult_RegionRebalanceOperation_RuntimeRegionInfoRebalanceResult]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementListOperationsResult_

RebalanceOperation

RestoreRedundancyRequest_

RebalanceResult

RestoreRedundancyResults

links (optional)
Links
result (optional)
array[ClusterManagementOperationResult_RebalanceOperationRestoreRedundancyRequest_RebalanceResultRestoreRedundancyResults]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

...

ClusterManagementListResult_Region_RuntimeRegionInfo

links (optional)
Links
result (optional)
array[EntityInfo_Region_RuntimeRegionInfo]
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String

ClusterManagementOperationResult_RebalanceOperation_RebalanceResult

links (optional)
Links
operation (optional)
RebalanceOperation
operationEnd (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String
operationResult (optional)
RebalanceResult
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
throwable (optional)
Throwable

ClusterManagementOperationResult_

RebalanceOperation

RestoreRedundancyRequest_

RebalanceResult

RestoreRedundancyResults

links (optional)
Links
operation (optional)
RebalanceOperation RestoreRedundancyRequest
operationEnd (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
operationId (optional)
String
operationResult (optional)
RebalanceResult RestoreRedundancyResults
operationStart (optional)
String
example: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
statusCode (optional)
String
Enum:
OK
ILLEGAL_ARGUMENT
UNAUTHENTICATED
UNAUTHORIZED
ENTITY_EXISTS
ENTITY_NOT_FOUND
ERROR
FAIL_TO_PERSIST
ACCEPTED
IN_PROGRESS
statusMessage (optional)
String
throwable (optional)
Throwable

...

Region

diskStoreName (optional)
String
eviction (optional)
Eviction
expirations (optional)
array[Expiration]
group (optional)
String
keyConstraint (optional)
String
name (optional)
String
redundantCopies (optional)
Integer format: int32
type (optional)
String
Enum:
PARTITION
PARTITION_PERSISTENT
PARTITION_PROXY
REPLICATE
REPLICATE_PERSISTENT
REPLICATE_PROXY
LEGACY
valueConstraint (optional)
String

RegionRedundancyStatus

actualRedundancy (optional)
Integer format: int32
configuredRedundancy (optional)
Integer format: int32
regionName (optional)
String
status (optional)
String
Enum:
SATISFIED
NOT_SATISFIED
NO_REDUNDANT_COPIES

RestoreRedundancyRequest

excludeRegions (optional)
array[String]
includeRegions (optional)
array[String]
operator (optional)
String
reassignPrimaries (optional)
Boolean

RestoreRedundancyResults

includedRegionsWithNoMembers (optional)
array[String]
regionResults (optional)
map[String, RegionRedundancyStatus]
satisfiedRedundancyRegionResults (optional)
map[String, RegionRedundancyStatus]
statusMessage (optional)
String
success (optional)
Boolean
totalPrimaryTransferTime (optional)
Long format: int64
totalPrimaryTransfersCompleted (optional)
Integer format: int32
underRedundancyRegionResults (optional)
map[String, RegionRedundancyStatus]
zeroRedundancyRegionResults (optional)
map[String, RegionRedundancyStatus]

RuntimeRegionInfo

entryCount (optional)
Long format: int64
memberName (optional)
String

...

Throwable

cause (optional)
Throwable
localizedMessage (optional)
String
message (optional)
String
stackTrace (optional)
array[StackTraceElement]
suppressed (optional)
array[Throwable]

v1_deployments_body

file
byte[] filePath format: binary