get /ego/v1/activity/{id}

Path parameters

Return type

Example data

{
  "memorylocklimit" : "memorylocklimit",
  "filelimit" : "filelimit",
  "nofilelimit" : "nofilelimit",
  "environments" : [ "environments", "environments" ],
  "standardoutput" : "standardoutput",
  "allocationid" : "allocationid",
  "starttime" : "starttime",
  "activityspecification" : {
    "umask" : "umask",
    "stdoutfile" : "stdoutfile",
    "environments" : [ {
      "example_key" : "example_key"
    }, {
      "example_key" : "example_key"
    } ],
    "rlimitfsize" : 2,
    "rlimitdata" : 3,
    "rlimitrss" : 7,
    "rlimitnofile" : 4,
    "precmdstdoutfile" : "precmdstdoutfile",
    "stderrfile" : "stderrfile",
    "rlimitcpu" : 9,
    "rlimitcore" : 7,
    "precmdtimeout" : 5,
    "precommand" : "precommand",
    "precmdstderrfile" : "precmdstderrfile",
    "postcmdexitstatus" : 6,
    "executionuser" : "executionuser",
    "postcmdstdoutfile" : "postcmdstdoutfile",
    "executioncwd" : "executioncwd",
    "command" : "command",
    "rlimitstack" : 1,
    "postcmdtimeout" : 1,
    "precmdexitstatus" : 5,
    "precmdexitreason" : "precmdexitreason",
    "postcmdstderrfile" : "postcmdstderrfile",
    "postcommand" : "postcommand",
    "postcmdexitreason" : "postcmdexitreason",
    "executionhost" : "executionhost",
    "rlimitas" : 2
  },
  "cpulimit" : "cpulimit",
  "aslimit" : "aslimit",
  "clientname" : "clientname",
  "datalimit" : "datalimit",
  "exitstatus" : 0,
  "id" : "id",
  "state" : "state",
  "inforeportedbyjobmonitor" : "inforeportedbyjobmonitor",
  "corelimit" : "corelimit",
  "exitreason" : "exitreason",
  "stacklimit" : "stacklimit",
  "executionuser" : "executionuser",
  "endtime" : "endtime",
  "consumername" : "consumername",
  "command" : "command",
  "cwd" : "cwd",
  "runtimeinformation" : {
    "jmpid" : 5,
    "uid" : 1,
    "pempid" : 1,
    "gid" : 1,
    "jmpgid" : 9,
    "jmpempid" : 9,
    "rrusage" : {
      "mem" : 8,
      "npids" : 6,
      "swap" : 9,
      "utime" : 6,
      "gpumetrics" : [ {
        "gpumemusage" : 5.94489560761401580890606055618263781070709228515625,
        "gpuutilization" : 6,
        "gpudeviceindex" : 6
      }, {
        "gpumemusage" : 5.94489560761401580890606055618263781070709228515625,
        "gpuutilization" : 6,
        "gpudeviceindex" : 6
      } ],
      "stime" : 3,
      "nthreads" : 2,
      "npgids" : 1,
      "gpudevicenum" : 6
    },
    "pgid" : 7,
    "srusage" : {
      "maxrss" : 7.143538047012306,
      "idrss" : 6.519180951018382,
      "msgrcv" : 3.2588565619047607,
      "nsignals" : 4.078845849666752,
      "utime" : 3.353193347011243,
      "nswap" : 7.740351818741173,
      "minflt" : 4.652396432933246,
      "stime" : 3.0937452626664474,
      "msgsnd" : 5.533258397034986,
      "exutime" : 4.258773108174356,
      "majflt" : 8.969578798196912,
      "inblock" : 3.0205796992916243,
      "isrss" : 0.10263654006109402,
      "oublock" : 3.0576100241049344,
      "ioch" : 7.04836565559697,
      "nvcsw" : 0.2025324113236393,
      "ismrss" : 7.058770351582356,
      "ixrss" : 0.8851374739011653,
      "nivcsw" : 6.628464275087742
    },
    "pid" : 6,
    "jmpempgid" : 6,
    "pempgid" : 4
  },
  "processid" : "processid",
  "name" : "name",
  "rsslimit" : "rsslimit",
  "jobmonitorcommand" : "jobmonitorcommand",
  "resourcename" : "resourcename",
  "dockercontainergroupinfo" : {
    "totalnumberofdockercontainer" : 1,
    "dockernetworkinfo" : "dockernetworkinfo"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the activity information. ActivityInfo

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The activity with the specified ID was not found.

500

An unexpected error occurred while retrieving the activity information.

get /ego/v1/activity/{id}/dockercontainers

Path parameters

Return type

Example data

[ {
  "errormessage" : "errormessage",
  "diskio" : 1.4658129805029452,
  "publishedports" : "publishedports",
  "memory" : 6.027456183070403,
  "name" : "name",
  "id" : "id",
  "cputime" : 0
}, {
  "errormessage" : "errormessage",
  "diskio" : 1.4658129805029452,
  "publishedports" : "publishedports",
  "memory" : 6.027456183070403,
  "name" : "name",
  "id" : "id",
  "cputime" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the Docker container information for the activity.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The activity with the specified ID was not found.

500

An unexpected error occurred while trying to get the Docker container information for the activity.

post /ego/v1/activity

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "id" : "id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

The activity is started successfully. ActivityInfoCreateResponse

400

The start request is missing values or contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

500

An unexpected error occurred while starting the activity.

delete /ego/v1/activity/{id}

Path parameters

Query parameters

Responses

204

Successfully terminated the activity.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The activity with the specified ID was not found.

500

An unexpected error occurred while terminating the activity.

get /ego/v1/auth/logon

Request headers

Return type

Example data

{
  "csrftoken" : "csrftoken"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successful response that contains the CSRF token. CSRFToken

401

Authentication error. The request was denied.

500

An unexpected error occurred.

post /ego/v1/auth/renew

Request body

Request headers

Return type

Example data

{
  "csrftoken" : "csrftoken"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successful response that contains the renewed CSRF token. CSRFToken

401

Authentication error. The request was denied.

500

An unexpected error occurred.

post /ego/v1/consumers/{consumerPath}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "rebalance" : true,
  "allowedgroups" : [ "allowedgroups", "allowedgroups" ],
  "executionuser" : "executionuser",
  "roles" : [ "roles", "roles" ],
  "name" : "name",
  "reclamationtime" : 0,
  "users" : [ "users", "users" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ],
  "allowedusers" : [ "allowedusers", "allowedusers" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully created the new consumer. ConsumerResponseObject

400

Bad request. The consumer details might be invalid.

401

Authentication error. The request was denied.

500

An unexpected error occurred while creating a new consumer.

get /ego/v1/consumers

Query parameters

Return type

Example data

[ {
  "path" : "path",
  "name" : "name"
}, {
  "path" : "path",
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the consumer list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the consumer list.

get /ego/v1/consumers/{consumerPath}

Path parameters

Return type

Example data

{
  "rebalance" : true,
  "allowedgroups" : [ "allowedgroups", "allowedgroups" ],
  "executionuser" : "executionuser",
  "roles" : [ "roles", "roles" ],
  "name" : "name",
  "reclamationtime" : 0,
  "users" : [ "users", "users" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ],
  "allowedusers" : [ "allowedusers", "allowedusers" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the consumer information. ConsumerWithUserAndRoles

401

Authentication error. The request was denied.

404

The consumer is not found.

500

An unexpected error occurred while retrieving the consumer details.

put /ego/v1/consumers/{consumerPath}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "rebalance" : true,
  "allowedgroups" : [ "allowedgroups", "allowedgroups" ],
  "executionuser" : "executionuser",
  "roles" : [ "roles", "roles" ],
  "name" : "name",
  "reclamationtime" : 0,
  "users" : [ "users", "users" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ],
  "allowedusers" : [ "allowedusers", "allowedusers" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully modified the consumer. ConsumerResponseObject

400

Bad request. The consumer details might be invalid.

401

Authentication error. The request was denied.

404

The consumer is not found.

409

A resource group in the consumer details does not belong to the parent of the specified consumer.

500

An unexpected error occurred while modifying the consumer.

delete /ego/v1/consumers/{consumerPath}

Path parameters

Query parameters

Responses

204

Successfully removed the consumer.

401

Authentication error. The request was denied.

404

The consumer is not found.

409

The consumer cannot be removed while it has resource allocations.

500

An unexpected error occurred while removing the consumer.

post /deployment/v1

Query parameters

Form parameters

Responses

201

Successfully added the service package at the specified consumer.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

500

An unexpected error occurred while adding the service package.

post /deployment/v1/copyfile/{os}

Path parameters

Query parameters

Form parameters

Responses

201

Successfully added the service package at the specified consumer.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

500

An unexpected error occurred while adding the service package.

delete /deployment/v1/{consumerPath}

Path parameters

Query parameters

Responses

204

Successfully deleted the service package.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The service package with the specified name and consumer was not found.

409

Cannot delete a service package while a deployment is in progress.

500

An unexpected error occurred while deleting the service package.

put /deployment/v1/deploy

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Responses

204

Successfully triggered deploying (pushing) the service package to the specified targets.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The service package with the specified name and consumer was not found.

409

A conflicting deployment or undeployment is already in progress.

500

An unexpected error occurred while deploying the service package.

get /deployment/v1/*

Request headers

Query parameters

Return type

Example data

[ {
  "size" : 0,
  "consumerpath" : "consumerpath",
  "name" : "name",
  "updatetime" : 6
}, {
  "size" : 0,
  "consumerpath" : "consumerpath",
  "name" : "name",
  "updatetime" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service package list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while trying to get the service package list.

get /deployment/v1/status/{packageName}

Path parameters

Request headers

Query parameters

Return type

Example data

[ {
  "name" : "name",
  "status" : "status"
}, {
  "name" : "name",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the host deployment status.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The service package with the specified name was not found.

416

An index is out of range.

500

An unexpected error occurred while trying to get host deployment status.

get /deployment/v1/{consumerPath}

Path parameters

Request headers

Query parameters

Return type

Example data

[ {
  "size" : 0,
  "consumerpath" : "consumerpath",
  "name" : "name",
  "updatetime" : 6
}, {
  "size" : 0,
  "consumerpath" : "consumerpath",
  "name" : "name",
  "updatetime" : 6
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service package list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while trying to get the service packages list.

put /deployment/v1/undeploy

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Responses

204

Successfully triggered undeploying (pushing) the service package from the specified targets.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

404

The service package with the specified name and consumer was not found.

409

A conflicting deployment or undeployment is already in progress.

500

An unexpected error occurred while undeploying the service package.

get /ego/v1/entitlements

Return type

Example data

{
  "sym" : "sym",
  "ego" : "ego",
  "cws" : "cws",
  "lsf" : "lsf"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the list of entitlements in the cluster. EntitlementStatus

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the entitlement list.

get /ego/v1/hosts/{hostname}

Path parameters

Return type

Example data

{
  "hostname" : "hostname",
  "attributes" : [ {
    "name" : "name",
    "value" : "value"
  }, {
    "name" : "name",
    "value" : "value"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the host resource. Host

401

Authentication error. The request was denied.

404

The host resource is not found.

500

An unexpected error occurred while retrieving the host resource.

get /ego/v1/hosts

Request headers

Query parameters

Return type

Example data

[ {
  "hostname" : "hostname",
  "attributes" : [ {
    "name" : "name",
    "value" : "value"
  }, {
    "name" : "name",
    "value" : "value"
  } ]
}, {
  "hostname" : "hostname",
  "attributes" : [ {
    "name" : "name",
    "value" : "value"
  }, {
    "name" : "name",
    "value" : "value"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the host list.

400

Bad request. The request might contain invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the host list.

get /ego/v1/logs/system/{hostname}/{filename}

Path parameters

Request headers

Query parameters

Return type

Example data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• text/plain

Responses

200

Successfully retrieved the log file. String

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The host or file is not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the log.

get /ego/v1/logs/service/{servicename}/{serviceinstanceid}/{filename}

Path parameters

Request headers

Query parameters

Return type

Example data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• text/plain

Responses

200

Successfully retrieved the log file. String

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The host or file is not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the log.

get /ego/v1/logs/service/{servicename}/{serviceinstanceid}

Path parameters

Request headers

Query parameters

Return type

Example data

[ {
  "date" : "date",
  "size" : 0,
  "name" : "name"
}, {
  "date" : "date",
  "size" : 0,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the log list for the service instance.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the log list.

get /ego/v1/logs/system/{hostname}

Path parameters

Request headers

Query parameters

Return type

Example data

[ {
  "date" : "date",
  "size" : 0,
  "name" : "name"
}, {
  "date" : "date",
  "size" : 0,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the log list on the host.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the log list.

post /ego/v1/mdsplans

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "planname" : "planname",
  "consumers" : [ "consumers", "consumers" ],
  "resourcemetrics" : [ "resourcemetrics", "resourcemetrics" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully created the multidimensional resource plan. MDSPlan

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

409

A multidimensional resource plan with the same name already exists.

500

An unexpected error occurred while creating the multidimensional resource plan.

delete /ego/v1/mdsplans/{mdsPlanName}

Path parameters

Query parameters

Responses

204

Successfully deleted the multidimensional resource plan.

401

Authentication error. The request was denied.

404

The multidimensional resource plan with the specified name was not found.

500

An unexpected error occurred while deleting the multidimensional resource plan.

get /ego/v1/mdsplans/xml

Request headers

Return type

Example data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• text/plain

Responses

200

Successfully exported the XML of all existing multidimensional resource plans. String

400

Bad request. The request contains unsupported values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

500

An unexpected error occurred while exporting the XML of the multidimensional resource plans.

get /ego/v1/mdsplans/xml/{mdsPlanName}

Path parameters

Request headers

Return type

Example data

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• text/plain

Responses

200

Successfully exported the XML of a single existing multidimensional resource plan. String

400

Bad request. The request contains unsupported values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

500

An unexpected error occurred while exporting the XML of the multidimensional resource plan.

get /ego/v1/mdsplans

Request headers

Query parameters

Return type

Example data

[ {
  "planname" : "planname",
  "consumers" : [ "consumers", "consumers" ],
  "resourcemetrics" : [ "resourcemetrics", "resourcemetrics" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ]
}, {
  "planname" : "planname",
  "consumers" : [ "consumers", "consumers" ],
  "resourcemetrics" : [ "resourcemetrics", "resourcemetrics" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the multidimensional resource plans.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

403

Forbidden. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the multidimensional resource plan.

get /ego/v1/mdsplans/{mdsPlanName}

Path parameters

Return type

Example data

{
  "planname" : "planname",
  "consumers" : [ "consumers", "consumers" ],
  "resourcemetrics" : [ "resourcemetrics", "resourcemetrics" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the multidimensional resource plan. MDSPlan

401

Authentication error. The request was denied.

404

The requested multidimensional resource plan is not found.

500

An unexpected error occurred while retrieving the multidimensional resource plan.

put /ego/v1/mdsplans/xml/{mdsPlanName}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Query parameters

Form parameters

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully imported the XML of the multidimensional resource plan to update the existing multidimensional resource plan.

400

Bad request. The request contains unsupported values.

401

Authentication error. The request was denied.

404

The requested multidimensional resource plan is not found.

409

The multidimensional resource plan name in the request URL does not match the name of the multidimensional resource plan in the request body.

500

An unexpected error occurred while importing the XML of the multidimensional resource plan.

post /ego/v1/mdsplans/xml

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Query parameters

Form parameters

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully imported the XML of the multidimensional resource plan.

400

Bad request. The request contains unsupported values.

401

Authentication error. The request was denied.

409

A multidimensional resource plan with the same name already exists.

500

An unexpected error occurred while importing the XML of the multidimensional resource plan.

put /ego/v1/mdsplans/{mdsPlanName}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "planname" : "planname",
  "consumers" : [ "consumers", "consumers" ],
  "resourcemetrics" : [ "resourcemetrics", "resourcemetrics" ],
  "resourcegroups" : [ "resourcegroups", "resourcegroups" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully modified the multidimensional resource plan. ModifyMDSPlan

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The requested multidimensional resource plan is not found.

409

The multidimensional resource plan name in the request URL does not match the name of the multidimensional resource plan in the request body.

500

An unexpected error occurred while modifying the multidimensional resource plan.

get /ego/v1/packages

Return type

Example data

{
  "hostsInfo" : [ {
    "hostName" : "hostName",
    "collectTime" : "collectTime",
    "moduleList" : [ {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    }, {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    } ],
    "activeList" : [ {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    }, {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    } ],
    "patchList" : [ {
      "patchName" : "patchName",
      "linkto" : "linkto",
      "buildno" : "buildno",
      "version" : "version"
    }, {
      "patchName" : "patchName",
      "linkto" : "linkto",
      "buildno" : "buildno",
      "version" : "version"
    } ],
    "cStatus" : "cStatus"
  }, {
    "hostName" : "hostName",
    "collectTime" : "collectTime",
    "moduleList" : [ {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    }, {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    } ],
    "activeList" : [ {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    }, {
      "linkto" : "linkto",
      "moduleName" : "moduleName",
      "version" : "version"
    } ],
    "patchList" : [ {
      "patchName" : "patchName",
      "linkto" : "linkto",
      "buildno" : "buildno",
      "version" : "version"
    }, {
      "patchName" : "patchName",
      "linkto" : "linkto",
      "buildno" : "buildno",
      "version" : "version"
    } ],
    "cStatus" : "cStatus"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the list of packages in the cluster. ClusterPackageInfo

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the package list.

post /ego/v1/resourcegroups

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "resourcerequirement" : "resourcerequirement",
  "resourceplan" : "resourceplan",
  "hosts" : [ {
    "hostname" : "hostname"
  }, {
    "hostname" : "hostname"
  } ],
  "name" : "name",
  "description" : "description",
  "numresourcemetrics" : 1,
  "totalslots" : 0,
  "type" : "static",
  "slotexpression" : "slotexpression",
  "numhosts" : 6,
  "schedulerpluginname" : "schedulerpluginname",
  "resourcemetrics" : [ {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  }, {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully created the resource group. ResourceGroup

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

409

A resource group with the same name already exists.

500

An unexpected error occurred while creating the resource group.

get /ego/v1/resourcegroups

Request headers

Query parameters

Return type

Example data

[ {
  "resourcerequirement" : "resourcerequirement",
  "resourceplan" : "resourceplan",
  "hosts" : [ {
    "hostname" : "hostname"
  }, {
    "hostname" : "hostname"
  } ],
  "name" : "name",
  "description" : "description",
  "numresourcemetrics" : 1,
  "totalslots" : 0,
  "type" : "static",
  "slotexpression" : "slotexpression",
  "numhosts" : 6,
  "schedulerpluginname" : "schedulerpluginname",
  "resourcemetrics" : [ {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  }, {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  } ]
}, {
  "resourcerequirement" : "resourcerequirement",
  "resourceplan" : "resourceplan",
  "hosts" : [ {
    "hostname" : "hostname"
  }, {
    "hostname" : "hostname"
  } ],
  "name" : "name",
  "description" : "description",
  "numresourcemetrics" : 1,
  "totalslots" : 0,
  "type" : "static",
  "slotexpression" : "slotexpression",
  "numhosts" : 6,
  "schedulerpluginname" : "schedulerpluginname",
  "resourcemetrics" : [ {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  }, {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the resource group list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the resource group list.

get /ego/v1/resourcegroups/{groupName}/members

Path parameters

Request headers

Return type

Example data

[ {
  "hostname" : "hostname",
  "freeslots" : 6,
  "numslots" : 0
}, {
  "hostname" : "hostname",
  "freeslots" : 6,
  "numslots" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the host list of the resource group.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The resource group with the specified name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the host list of the resource group.

get /ego/v1/resourcegroups/{groupName}

Path parameters

Return type

Example data

{
  "resourcerequirement" : "resourcerequirement",
  "resourceplan" : "resourceplan",
  "hosts" : [ {
    "hostname" : "hostname"
  }, {
    "hostname" : "hostname"
  } ],
  "name" : "name",
  "description" : "description",
  "numresourcemetrics" : 1,
  "totalslots" : 0,
  "type" : "static",
  "slotexpression" : "slotexpression",
  "numhosts" : 6,
  "schedulerpluginname" : "schedulerpluginname",
  "resourcemetrics" : [ {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  }, {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the resource group. ResourceGroup

401

Authentication error. The request was denied.

404

The requested resource group is not found.

500

An unexpected error occurred while retrieving the resource group.

put /ego/v1/resourcegroups/{groupName}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "resourcerequirement" : "resourcerequirement",
  "resourceplan" : "resourceplan",
  "hosts" : [ {
    "hostname" : "hostname"
  }, {
    "hostname" : "hostname"
  } ],
  "name" : "name",
  "description" : "description",
  "numresourcemetrics" : 1,
  "totalslots" : 0,
  "type" : "static",
  "slotexpression" : "slotexpression",
  "numhosts" : 6,
  "schedulerpluginname" : "schedulerpluginname",
  "resourcemetrics" : [ {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  }, {
    "name" : "name",
    "free" : "free",
    "allocated" : "allocated"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully modified the resource group. ResourceGroup

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The requested resource group is not found.

409

The resource group name in the request URL does not match the name of the resource group in the request body.

500

An unexpected error occurred while modifying the resource group.

delete /ego/v1/resourcegroups/{groupName}

Path parameters

Query parameters

Responses

204

Successfully deleted the resource group.

401

Authentication error. The request was denied.

404

The resource group with the specified name was not found.

500

An unexpected error occurred while deleting the resource group.

post /ego/v1/roles

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "roles4assignment" : "roles4assignment",
  "roleid" : "roleid",
  "rolename" : "rolename",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "changeable" : 0,
  "usertype" : 6,
  "permissionlist" : [ "permissionlist", "permissionlist" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

Successfully added the role. RBACRoleResponse

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while adding the role.

post /ego/v1/roles/assignments/usergroups

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "addedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully added the user group role. RBACAddUserRoleInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while adding the user group role.

post /ego/v1/roles/assignments/users

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "addedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully added the user role. RBACAddUserRoleInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while adding the user role.

delete /ego/v1/roles/{rolename}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Responses

204

Successfully deleted the role.

400

Bad request. The request contains invalid values.

404

The role with the specified role name was not found.

500

An unexpected error occurred while deleting the role.

delete /ego/v1/roles/assignments/usergroups

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "removedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully deleted the user group role. RBACAssignmentForDelete

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while deleting the user group role.

delete /ego/v1/roles/assignments/users

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "removedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully deleted the user role. RBACAssignmentForDelete

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while deleting the user role.

get /ego/v1/roles/permissions

Request headers

Return type

Example data

[ {
  "component" : "component",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "id" : "id",
  "baseid" : "baseid",
  "object" : "object"
}, {
  "component" : "component",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "id" : "id",
  "baseid" : "baseid",
  "object" : "object"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the permission list.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the permission list.

get /ego/v1/roles/assignments/users

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the role-user assignment list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the role-user assignment list.

get /ego/v1/roles/assignments/usergroups

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the role-user group assignment list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the role-user group assignment list.

get /ego/v1/roles

Request headers

Return type

Example data

[ {
  "roles4assignment" : "roles4assignment",
  "roleid" : "roleid",
  "rolename" : "rolename",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "changeable" : 0,
  "usertype" : 6,
  "permissionlist" : [ "permissionlist", "permissionlist" ]
}, {
  "roles4assignment" : "roles4assignment",
  "roleid" : "roleid",
  "rolename" : "rolename",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "changeable" : 0,
  "usertype" : 6,
  "permissionlist" : [ "permissionlist", "permissionlist" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the role list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred retrieving the role list.

get /ego/v1/roles/assignments/usernames

Request headers

Query parameters

Return type

Example data

[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the filtered user list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the user list.

get /ego/v1/roles/{rolename}

Path parameters

Return type

Example data

{
  "roles4assignment" : "roles4assignment",
  "roleid" : "roleid",
  "rolename" : "rolename",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "changeable" : 0,
  "usertype" : 6,
  "permissionlist" : [ "permissionlist", "permissionlist" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the role. RBACRoleResponse

401

Authentication error. The request was denied.

404

The role with the specified role name was not found.

500

An unexpected error occurred while retrieving the role.

get /ego/v1/roles/{rolename}/assignments/users

Path parameters

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the assigned user list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The role with the specified role name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the assigned user list.

get /ego/v1/roles/{rolename}/assignments/usergroups

Path parameters

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the assigned user group list.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The role with the specified role name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the assigned user group list.

put /ego/v1/roles/{rolename}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "roles4assignment" : "roles4assignment",
  "roleid" : "roleid",
  "rolename" : "rolename",
  "contexttypes" : "contexttypes",
  "description" : "description",
  "changeable" : 0,
  "usertype" : 6,
  "permissionlist" : [ "permissionlist", "permissionlist" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully updated the role. RBACRoleResponse

400

Bad request. The request contains invalid values.

404

The role with the specified role name was not found.

500

An unexpected error occurred while updating the role.

put /ego/v1/roles/permissions

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

[ {
  "addedpermissionlist" : [ {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  }, {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  } ],
  "removedpermissionlist" : [ {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  }, {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  } ]
}, {
  "addedpermissionlist" : [ {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  }, {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  } ],
  "removedpermissionlist" : [ {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  }, {
    "enforced" : "enforced",
    "roles4assignment" : "roles4assignment",
    "rolename" : "rolename",
    "description" : "description",
    "permissionlist" : [ "permissionlist", "permissionlist" ]
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully updated the role permissions.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while updating the role permissions.

put /ego/v1/roles/assignments/usergroups

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "addedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ],
  "removedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully updated the user group role. RBACUpdateUserRoleInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while updating the user group role.

put /ego/v1/roles/assignments/users

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "addedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ],
  "removedroleassignment" : [ {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  }, {
    "rolename" : "rolename",
    "context" : "context",
    "username" : "username"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully updated the user role. RBACUpdateUserRoleInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while updating the user role.

post /ego/v1/servicegroups

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "srvgrpname" : "srvgrpname",
  "servicenames" : [ "servicenames", "servicenames" ],
  "description" : "description"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

Successfully retrieved the service group. ServiceGroupInfoForCreate

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

409

A service group with the specified service group name already exists.

500

An unexpected error occurred while creating the service group.

delete /ego/v1/servicegroups/{groupName}

Path parameters

Query parameters

Responses

204

Successfully deleted the service group.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The service group with the specified service group name was not found.

500

An unexpected error occurred while deleting the service group.

get /ego/v1/servicegroups

Request headers

Return type

Example data

[ {
  "srvgrpname" : "srvgrpname",
  "servicenames" : [ "servicenames", "servicenames" ],
  "usage" : {
    "mem" : 6.0274563,
    "coresused" : 0.8008282,
    "diskrate" : 5.962134,
    "iorate" : 1.4658129
  },
  "description" : "description"
}, {
  "srvgrpname" : "srvgrpname",
  "servicenames" : [ "servicenames", "servicenames" ],
  "usage" : {
    "mem" : 6.0274563,
    "coresused" : 0.8008282,
    "diskrate" : 5.962134,
    "iorate" : 1.4658129
  },
  "description" : "description"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service group list.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the service group list.

get /ego/v1/servicegroups/{groupName}

Path parameters

Return type

Example data

{
  "srvgrpname" : "srvgrpname",
  "servicenames" : [ "servicenames", "servicenames" ],
  "usage" : {
    "mem" : 6.0274563,
    "coresused" : 0.8008282,
    "diskrate" : 5.962134,
    "iorate" : 1.4658129
  },
  "description" : "description"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service group. ServiceGroupInfo

401

Authentication error. The request was denied.

404

The service group with the specified service group name was not found.

500

An unexpected error occurred while retrieving the service group.

put /ego/v1/servicegroups/{groupName}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "srvgrpname" : "srvgrpname",
  "servicenames" : [ "servicenames", "servicenames" ],
  "description" : "description"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully modified the service group. ServiceGroupInfoForCreate

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The service group with the specified service group name was not found.

409

The service group name that is specified in the URL does not match the service group name that is specified in the body of the request.

500

An unexpected error occurred while modifying the service group.

put /ego/v1/services/dynamicconfig/{name}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Return type

Example data

{
  "maxinstancesperslot" : 1,
  "resourcegroup" : "resourcegroup",
  "resourcerequirement" : "resourcerequirement",
  "instancetoslotratio" : "instancetoslotratio",
  "description" : "description",
  "basevirtualip" : "basevirtualip",
  "type" : "type",
  "maxinstances" : 6,
  "dependencies" : [ "dependencies", "dependencies" ],
  "affinityrequirements" : {
    "affinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ],
    "antiaffinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ]
  },
  "netmask" : "netmask",
  "mininstances" : 0,
  "mdsproperties" : {
    "service" : "service",
    "type" : "hard"
  },
  "name" : "name",
  "starttype" : "AUTOMATIC",
  "maxrestarts" : 5,
  "consumer" : "consumer"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully modified the service. ServiceInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The service with the specified name is not found.

409

A service property that cannot be dynamically changed was specified.

500

An unexpected error occurred while registering the service.

get /ego/v1/services/instances

Request headers

Query parameters

Return type

Example data

[ {
  "activityid" : 1,
  "resourcegroup" : "resourcegroup",
  "hostname" : "hostname",
  "logpath" : "logpath",
  "sequencenum" : 0,
  "processid" : 6,
  "usage" : {
    "disk" : 3.6160767,
    "mem" : 2.302136,
    "coresused" : 5.637377,
    "io" : 7.0614014,
    "diskrate" : 2.027123,
    "iorate" : 9.301444,
    "cputime" : 5
  },
  "servicename" : "servicename",
  "state" : "state",
  "starttime" : "starttime",
  "userinfo" : "userinfo",
  "virtualip" : "virtualip"
}, {
  "activityid" : 1,
  "resourcegroup" : "resourcegroup",
  "hostname" : "hostname",
  "logpath" : "logpath",
  "sequencenum" : 0,
  "processid" : 6,
  "usage" : {
    "disk" : 3.6160767,
    "mem" : 2.302136,
    "coresused" : 5.637377,
    "io" : 7.0614014,
    "diskrate" : 2.027123,
    "iorate" : 9.301444,
    "cputime" : 5
  },
  "servicename" : "servicename",
  "state" : "state",
  "starttime" : "starttime",
  "userinfo" : "userinfo",
  "virtualip" : "virtualip"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service instances.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the service instances.

get /ego/v1/services

Request headers

Query parameters

Return type

Example data

[ {
  "numinstances" : 6,
  "numstartinginstances" : 1,
  "numholdinginstances" : 5,
  "usage" : {
    "mem" : 2.027123,
    "coresused" : 3.6160767,
    "diskrate" : 7.386282,
    "iorate" : 4.145608
  },
  "allocationid" : 0,
  "type" : "type",
  "numrunninginstances" : 5,
  "numunknowninstances" : 2,
  "numfinishedinstances" : 7,
  "name" : "name",
  "state" : "state",
  "consumer" : "consumer",
  "numerrorinstances" : 9
}, {
  "numinstances" : 6,
  "numstartinginstances" : 1,
  "numholdinginstances" : 5,
  "usage" : {
    "mem" : 2.027123,
    "coresused" : 3.6160767,
    "diskrate" : 7.386282,
    "iorate" : 4.145608
  },
  "allocationid" : 0,
  "type" : "type",
  "numrunninginstances" : 5,
  "numunknowninstances" : 2,
  "numfinishedinstances" : 7,
  "name" : "name",
  "state" : "state",
  "consumer" : "consumer",
  "numerrorinstances" : 9
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service list.

401

Authentication error. The request was denied.

404

The service with the specified service name was not found.

500

An unexpected error occurred while retrieving the service list.

get /ego/v1/services/{name}

Path parameters

Return type

Example data

{
  "maxinstancesperslot" : 1,
  "resourcegroup" : "resourcegroup",
  "resourcerequirement" : "resourcerequirement",
  "instancetoslotratio" : "instancetoslotratio",
  "description" : "description",
  "basevirtualip" : "basevirtualip",
  "type" : "type",
  "maxinstances" : 6,
  "dependencies" : [ "dependencies", "dependencies" ],
  "affinityrequirements" : {
    "affinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ],
    "antiaffinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ]
  },
  "netmask" : "netmask",
  "mininstances" : 0,
  "mdsproperties" : {
    "service" : "service",
    "type" : "hard"
  },
  "name" : "name",
  "starttype" : "AUTOMATIC",
  "maxrestarts" : 5,
  "consumer" : "consumer"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service. ServiceInfo

401

Authentication error. The request was denied.

404

The service with the specified service name was not found.

500

An unexpected error occurred while retrieving the service.

get /ego/v1/services/{name}/instances/{sequenceNum}

Path parameters

Return type

Example data

{
  "activityid" : 1,
  "resourcegroup" : "resourcegroup",
  "hostname" : "hostname",
  "logpath" : "logpath",
  "sequencenum" : 0,
  "processid" : 6,
  "usage" : {
    "disk" : 3.6160767,
    "mem" : 2.302136,
    "coresused" : 5.637377,
    "io" : 7.0614014,
    "diskrate" : 2.027123,
    "iorate" : 9.301444,
    "cputime" : 5
  },
  "servicename" : "servicename",
  "state" : "state",
  "starttime" : "starttime",
  "userinfo" : "userinfo",
  "virtualip" : "virtualip"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service instance. ServiceInstanceInfo

401

Authentication error. The request was denied.

404

The service with the specified service name was not found, or the instance with the specified sequence number was not found.

500

An unexpected error occurred while retrieving the service instance.

get /ego/v1/services/{name}/instances

Path parameters

Query parameters

Return type

Example data

[ {
  "activityid" : 1,
  "resourcegroup" : "resourcegroup",
  "hostname" : "hostname",
  "logpath" : "logpath",
  "sequencenum" : 0,
  "processid" : 6,
  "usage" : {
    "disk" : 3.6160767,
    "mem" : 2.302136,
    "coresused" : 5.637377,
    "io" : 7.0614014,
    "diskrate" : 2.027123,
    "iorate" : 9.301444,
    "cputime" : 5
  },
  "servicename" : "servicename",
  "state" : "state",
  "starttime" : "starttime",
  "userinfo" : "userinfo",
  "virtualip" : "virtualip"
}, {
  "activityid" : 1,
  "resourcegroup" : "resourcegroup",
  "hostname" : "hostname",
  "logpath" : "logpath",
  "sequencenum" : 0,
  "processid" : 6,
  "usage" : {
    "disk" : 3.6160767,
    "mem" : 2.302136,
    "coresused" : 5.637377,
    "io" : 7.0614014,
    "diskrate" : 2.027123,
    "iorate" : 9.301444,
    "cputime" : 5
  },
  "servicename" : "servicename",
  "state" : "state",
  "starttime" : "starttime",
  "userinfo" : "userinfo",
  "virtualip" : "virtualip"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service instances.

401

Authentication error. The request was denied.

404

The service with the specified service name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the service instances.

get /ego/v1/services/{name}/profile

Path parameters

Return type

Example data

{
  "maxinstancesperslot" : 0,
  "networkpolicy" : {
    "virtualipsettings" : {
      "netmask" : "netmask",
      "basevirtualip" : "basevirtualip"
    }
  },
  "needcredential" : true,
  "instancetoslotratio" : "instancetoslotratio",
  "controlpolicy" : {
    "servicefailoverfencings" : [ {
      "logpath" : "logpath",
      "attribute" : {
        "name" : "name",
        "type" : "type",
        "value" : "value"
      },
      "activityspecification" : {
        "container" : {
          "diskiolimit" : [ {
            "operation" : "operation",
            "device" : "device",
            "value" : 4
          }, {
            "operation" : "operation",
            "device" : "device",
            "value" : 4
          } ],
          "memoryswaplimit" : 1,
          "memorylimit" : 7,
          "networkclassid" : "networkclassid",
          "cpulimit" : 2,
          "type" : "type",
          "priorityclass" : 1
        },
        "umask" : "umask",
        "jobmonitor" : "jobmonitor",
        "controlwaitperiod" : "controlwaitperiod",
        "rlimits" : [ {
          "rlimit" : 5,
          "rlimittype" : "rlimittype",
          "rlimitname" : "rlimitname"
        }, {
          "rlimit" : 5,
          "rlimittype" : "rlimittype",
          "rlimitname" : "rlimitname"
        } ],
        "executionuser" : "executionuser",
        "jobcontroller" : "jobcontroller",
        "command" : {
          "stdoutfile" : "stdoutfile",
          "stderrfile" : "stderrfile",
          "value" : "value"
        },
        "cleanupcommand" : "cleanupcommand",
        "docker" : {
          "containers" : [ {
            "image" : "image",
            "cpushares" : 7,
            "executionuser" : "executionuser",
            "readyconditions" : {
              "readycheckscript" : "readycheckscript",
              "requiredcontainerports" : [ 4, 4 ],
              "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
            },
            "volumes" : [ {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            }, {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            } ],
            "cpuset" : "cpuset",
            "extraparameter" : "extraparameter",
            "command" : "command",
            "dependencies" : [ {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            }, {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            } ],
            "privileged" : "privileged",
            "publishedports" : [ {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            }, {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            } ],
            "entrypoint" : "entrypoint",
            "impersonatemode" : "merge",
            "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
            "name" : "name",
            "memorylimit" : 1,
            "gracefulstop" : "gracefulstop",
            "environmentvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "imageregistryurl" : "imageregistryurl",
            "shortrunning" : "shortrunning"
          }, {
            "image" : "image",
            "cpushares" : 7,
            "executionuser" : "executionuser",
            "readyconditions" : {
              "readycheckscript" : "readycheckscript",
              "requiredcontainerports" : [ 4, 4 ],
              "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
            },
            "volumes" : [ {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            }, {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            } ],
            "cpuset" : "cpuset",
            "extraparameter" : "extraparameter",
            "command" : "command",
            "dependencies" : [ {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            }, {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            } ],
            "privileged" : "privileged",
            "publishedports" : [ {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            }, {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            } ],
            "entrypoint" : "entrypoint",
            "impersonatemode" : "merge",
            "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
            "name" : "name",
            "memorylimit" : 1,
            "gracefulstop" : "gracefulstop",
            "environmentvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "imageregistryurl" : "imageregistryurl",
            "shortrunning" : "shortrunning"
          } ],
          "sharedproperties" : {
            "volumes" : [ {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            }, {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            } ],
            "environmentvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "startuptimeout" : 6,
            "stoptimeout" : 1,
            "network" : {
              "externalscriptvariables" : [ {
                "name" : "name",
                "value" : "value"
              }, {
                "name" : "name",
                "value" : "value"
              } ],
              "dnssearchdomain" : [ "dnssearchdomain", "dnssearchdomain" ],
              "dnsserver" : [ "dnsserver", "dnsserver" ],
              "podname" : "podname",
              "sdnname" : [ "sdnname", "sdnname" ],
              "networktype" : "bridge"
            }
          }
        },
        "inactivityperiod" : "inactivityperiod",
        "cleanupfinishwaitperiod" : "cleanupfinishwaitperiod",
        "postcommand" : {
          "stdoutfile" : "stdoutfile",
          "stderrfile" : "stderrfile",
          "value" : "value",
          "timeout" : 9
        },
        "workingdirectory" : "workingdirectory",
        "environmentvariables" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ],
        "jobmonitormaxupdateinterval" : 3,
        "defaulturl" : "defaulturl",
        "precommand" : {
          "stdoutfile" : "stdoutfile",
          "stderrfile" : "stderrfile",
          "value" : "value",
          "timeout" : 7
        }
      }
    }, {
      "logpath" : "logpath",
      "attribute" : {
        "name" : "name",
        "type" : "type",
        "value" : "value"
      },
      "activityspecification" : {
        "container" : {
          "diskiolimit" : [ {
            "operation" : "operation",
            "device" : "device",
            "value" : 4
          }, {
            "operation" : "operation",
            "device" : "device",
            "value" : 4
          } ],
          "memoryswaplimit" : 1,
          "memorylimit" : 7,
          "networkclassid" : "networkclassid",
          "cpulimit" : 2,
          "type" : "type",
          "priorityclass" : 1
        },
        "umask" : "umask",
        "jobmonitor" : "jobmonitor",
        "controlwaitperiod" : "controlwaitperiod",
        "rlimits" : [ {
          "rlimit" : 5,
          "rlimittype" : "rlimittype",
          "rlimitname" : "rlimitname"
        }, {
          "rlimit" : 5,
          "rlimittype" : "rlimittype",
          "rlimitname" : "rlimitname"
        } ],
        "executionuser" : "executionuser",
        "jobcontroller" : "jobcontroller",
        "command" : {
          "stdoutfile" : "stdoutfile",
          "stderrfile" : "stderrfile",
          "value" : "value"
        },
        "cleanupcommand" : "cleanupcommand",
        "docker" : {
          "containers" : [ {
            "image" : "image",
            "cpushares" : 7,
            "executionuser" : "executionuser",
            "readyconditions" : {
              "readycheckscript" : "readycheckscript",
              "requiredcontainerports" : [ 4, 4 ],
              "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
            },
            "volumes" : [ {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            }, {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            } ],
            "cpuset" : "cpuset",
            "extraparameter" : "extraparameter",
            "command" : "command",
            "dependencies" : [ {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            }, {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            } ],
            "privileged" : "privileged",
            "publishedports" : [ {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            }, {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            } ],
            "entrypoint" : "entrypoint",
            "impersonatemode" : "merge",
            "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
            "name" : "name",
            "memorylimit" : 1,
            "gracefulstop" : "gracefulstop",
            "environmentvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "imageregistryurl" : "imageregistryurl",
            "shortrunning" : "shortrunning"
          }, {
            "image" : "image",
            "cpushares" : 7,
            "executionuser" : "executionuser",
            "readyconditions" : {
              "readycheckscript" : "readycheckscript",
              "requiredcontainerports" : [ 4, 4 ],
              "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
            },
            "volumes" : [ {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            }, {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            } ],
            "cpuset" : "cpuset",
            "extraparameter" : "extraparameter",
            "command" : "command",
            "dependencies" : [ {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            }, {
              "satisfy" : "satisfy",
              "keep" : "keep",
              "servicename" : "servicename",
              "type" : "type",
              "autostart" : "autostart"
            } ],
            "privileged" : "privileged",
            "publishedports" : [ {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            }, {
              "protocol" : "protocol",
              "port" : "port",
              "ip" : "ip",
              "hostport" : "hostport"
            } ],
            "entrypoint" : "entrypoint",
            "impersonatemode" : "merge",
            "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
            "name" : "name",
            "memorylimit" : 1,
            "gracefulstop" : "gracefulstop",
            "environmentvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "imageregistryurl" : "imageregistryurl",
            "shortrunning" : "shortrunning"
          } ],
          "sharedproperties" : {
            "volumes" : [ {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            }, {
              "envname" : "envname",
              "permission" : "permission",
              "value" : "value",
              "hostpath" : "hostpath"
            } ],
            "environmentvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "startuptimeout" : 6,
            "stoptimeout" : 1,
            "network" : {
              "externalscriptvariables" : [ {
                "name" : "name",
                "value" : "value"
              }, {
                "name" : "name",
                "value" : "value"
              } ],
              "dnssearchdomain" : [ "dnssearchdomain", "dnssearchdomain" ],
              "dnsserver" : [ "dnsserver", "dnsserver" ],
              "podname" : "podname",
              "sdnname" : [ "sdnname", "sdnname" ],
              "networktype" : "bridge"
            }
          }
        },
        "inactivityperiod" : "inactivityperiod",
        "cleanupfinishwaitperiod" : "cleanupfinishwaitperiod",
        "postcommand" : {
          "stdoutfile" : "stdoutfile",
          "stderrfile" : "stderrfile",
          "value" : "value",
          "timeout" : 9
        },
        "workingdirectory" : "workingdirectory",
        "environmentvariables" : [ {
          "name" : "name",
          "value" : "value"
        }, {
          "name" : "name",
          "value" : "value"
        } ],
        "jobmonitormaxupdateinterval" : 3,
        "defaulturl" : "defaulturl",
        "precommand" : {
          "stdoutfile" : "stdoutfile",
          "stderrfile" : "stderrfile",
          "value" : "value",
          "timeout" : 7
        }
      }
    } ],
    "blockhostexitvalues" : [ 2, 2 ],
    "heartbeatinterval" : "heartbeatinterval",
    "starttype" : "AUTOMATIC",
    "maxrestarts" : 5,
    "servicefailoverfencingrwaitperiod" : "servicefailoverfencingrwaitperiod",
    "hostfailoverinterval" : "hostfailoverinterval",
    "maxmissedheartbeats" : 5,
    "dependencies" : [ {
      "satisfy" : "satisfy",
      "keep" : "keep",
      "servicename" : "servicename",
      "type" : "type",
      "autostart" : "autostart"
    }, {
      "satisfy" : "satisfy",
      "keep" : "keep",
      "servicename" : "servicename",
      "type" : "type",
      "autostart" : "autostart"
    } ]
  },
  "description" : "description",
  "priority" : 1,
  "type" : "type",
  "version" : "version",
  "maxinstances" : "maxinstances",
  "maxinstancesperhost" : 6,
  "impersonate" : "impersonate",
  "mininstances" : "mininstances",
  "name" : "name",
  "collectusage" : true,
  "allocationspecification" : {
    "consumerid" : "consumerid",
    "resourcespecification" : {
      "resourcegroupname" : "resourcegroupname",
      "resourcerequirement" : "resourcerequirement",
      "affinityrequirements" : {
        "affinities" : [ {
          "resourceplanname" : "resourceplanname",
          "resourcemetrics" : [ {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          }, {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          } ]
        }, {
          "resourceplanname" : "resourceplanname",
          "resourcemetrics" : [ {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          }, {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          } ]
        } ],
        "antiaffinities" : [ {
          "resourceplanname" : "resourceplanname",
          "resourcemetrics" : [ {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          }, {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          } ]
        }, {
          "resourceplanname" : "resourceplanname",
          "resourcemetrics" : [ {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          }, {
            "metricname" : "metricname",
            "metricvalue" : "metricvalue"
          } ]
        } ]
      },
      "mdsproperties" : {
        "service" : "service",
        "type" : "hard"
      },
      "resourcetype" : "resourcetype"
    }
  },
  "activitydescriptions" : [ {
    "logpath" : "logpath",
    "attribute" : {
      "name" : "name",
      "type" : "type",
      "value" : "value"
    },
    "activityspecification" : {
      "container" : {
        "diskiolimit" : [ {
          "operation" : "operation",
          "device" : "device",
          "value" : 4
        }, {
          "operation" : "operation",
          "device" : "device",
          "value" : 4
        } ],
        "memoryswaplimit" : 1,
        "memorylimit" : 7,
        "networkclassid" : "networkclassid",
        "cpulimit" : 2,
        "type" : "type",
        "priorityclass" : 1
      },
      "umask" : "umask",
      "jobmonitor" : "jobmonitor",
      "controlwaitperiod" : "controlwaitperiod",
      "rlimits" : [ {
        "rlimit" : 5,
        "rlimittype" : "rlimittype",
        "rlimitname" : "rlimitname"
      }, {
        "rlimit" : 5,
        "rlimittype" : "rlimittype",
        "rlimitname" : "rlimitname"
      } ],
      "executionuser" : "executionuser",
      "jobcontroller" : "jobcontroller",
      "command" : {
        "stdoutfile" : "stdoutfile",
        "stderrfile" : "stderrfile",
        "value" : "value"
      },
      "cleanupcommand" : "cleanupcommand",
      "docker" : {
        "containers" : [ {
          "image" : "image",
          "cpushares" : 7,
          "executionuser" : "executionuser",
          "readyconditions" : {
            "readycheckscript" : "readycheckscript",
            "requiredcontainerports" : [ 4, 4 ],
            "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
          },
          "volumes" : [ {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          }, {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          } ],
          "cpuset" : "cpuset",
          "extraparameter" : "extraparameter",
          "command" : "command",
          "dependencies" : [ {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          }, {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          } ],
          "privileged" : "privileged",
          "publishedports" : [ {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          }, {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          } ],
          "entrypoint" : "entrypoint",
          "impersonatemode" : "merge",
          "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
          "name" : "name",
          "memorylimit" : 1,
          "gracefulstop" : "gracefulstop",
          "environmentvariables" : [ {
            "name" : "name",
            "value" : "value"
          }, {
            "name" : "name",
            "value" : "value"
          } ],
          "imageregistryurl" : "imageregistryurl",
          "shortrunning" : "shortrunning"
        }, {
          "image" : "image",
          "cpushares" : 7,
          "executionuser" : "executionuser",
          "readyconditions" : {
            "readycheckscript" : "readycheckscript",
            "requiredcontainerports" : [ 4, 4 ],
            "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
          },
          "volumes" : [ {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          }, {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          } ],
          "cpuset" : "cpuset",
          "extraparameter" : "extraparameter",
          "command" : "command",
          "dependencies" : [ {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          }, {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          } ],
          "privileged" : "privileged",
          "publishedports" : [ {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          }, {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          } ],
          "entrypoint" : "entrypoint",
          "impersonatemode" : "merge",
          "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
          "name" : "name",
          "memorylimit" : 1,
          "gracefulstop" : "gracefulstop",
          "environmentvariables" : [ {
            "name" : "name",
            "value" : "value"
          }, {
            "name" : "name",
            "value" : "value"
          } ],
          "imageregistryurl" : "imageregistryurl",
          "shortrunning" : "shortrunning"
        } ],
        "sharedproperties" : {
          "volumes" : [ {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          }, {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          } ],
          "environmentvariables" : [ {
            "name" : "name",
            "value" : "value"
          }, {
            "name" : "name",
            "value" : "value"
          } ],
          "startuptimeout" : 6,
          "stoptimeout" : 1,
          "network" : {
            "externalscriptvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "dnssearchdomain" : [ "dnssearchdomain", "dnssearchdomain" ],
            "dnsserver" : [ "dnsserver", "dnsserver" ],
            "podname" : "podname",
            "sdnname" : [ "sdnname", "sdnname" ],
            "networktype" : "bridge"
          }
        }
      },
      "inactivityperiod" : "inactivityperiod",
      "cleanupfinishwaitperiod" : "cleanupfinishwaitperiod",
      "postcommand" : {
        "stdoutfile" : "stdoutfile",
        "stderrfile" : "stderrfile",
        "value" : "value",
        "timeout" : 9
      },
      "workingdirectory" : "workingdirectory",
      "environmentvariables" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "jobmonitormaxupdateinterval" : 3,
      "defaulturl" : "defaulturl",
      "precommand" : {
        "stdoutfile" : "stdoutfile",
        "stderrfile" : "stderrfile",
        "value" : "value",
        "timeout" : 7
      }
    }
  }, {
    "logpath" : "logpath",
    "attribute" : {
      "name" : "name",
      "type" : "type",
      "value" : "value"
    },
    "activityspecification" : {
      "container" : {
        "diskiolimit" : [ {
          "operation" : "operation",
          "device" : "device",
          "value" : 4
        }, {
          "operation" : "operation",
          "device" : "device",
          "value" : 4
        } ],
        "memoryswaplimit" : 1,
        "memorylimit" : 7,
        "networkclassid" : "networkclassid",
        "cpulimit" : 2,
        "type" : "type",
        "priorityclass" : 1
      },
      "umask" : "umask",
      "jobmonitor" : "jobmonitor",
      "controlwaitperiod" : "controlwaitperiod",
      "rlimits" : [ {
        "rlimit" : 5,
        "rlimittype" : "rlimittype",
        "rlimitname" : "rlimitname"
      }, {
        "rlimit" : 5,
        "rlimittype" : "rlimittype",
        "rlimitname" : "rlimitname"
      } ],
      "executionuser" : "executionuser",
      "jobcontroller" : "jobcontroller",
      "command" : {
        "stdoutfile" : "stdoutfile",
        "stderrfile" : "stderrfile",
        "value" : "value"
      },
      "cleanupcommand" : "cleanupcommand",
      "docker" : {
        "containers" : [ {
          "image" : "image",
          "cpushares" : 7,
          "executionuser" : "executionuser",
          "readyconditions" : {
            "readycheckscript" : "readycheckscript",
            "requiredcontainerports" : [ 4, 4 ],
            "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
          },
          "volumes" : [ {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          }, {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          } ],
          "cpuset" : "cpuset",
          "extraparameter" : "extraparameter",
          "command" : "command",
          "dependencies" : [ {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          }, {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          } ],
          "privileged" : "privileged",
          "publishedports" : [ {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          }, {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          } ],
          "entrypoint" : "entrypoint",
          "impersonatemode" : "merge",
          "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
          "name" : "name",
          "memorylimit" : 1,
          "gracefulstop" : "gracefulstop",
          "environmentvariables" : [ {
            "name" : "name",
            "value" : "value"
          }, {
            "name" : "name",
            "value" : "value"
          } ],
          "imageregistryurl" : "imageregistryurl",
          "shortrunning" : "shortrunning"
        }, {
          "image" : "image",
          "cpushares" : 7,
          "executionuser" : "executionuser",
          "readyconditions" : {
            "readycheckscript" : "readycheckscript",
            "requiredcontainerports" : [ 4, 4 ],
            "requiredcontainerprocesses" : [ "requiredcontainerprocesses", "requiredcontainerprocesses" ]
          },
          "volumes" : [ {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          }, {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          } ],
          "cpuset" : "cpuset",
          "extraparameter" : "extraparameter",
          "command" : "command",
          "dependencies" : [ {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          }, {
            "satisfy" : "satisfy",
            "keep" : "keep",
            "servicename" : "servicename",
            "type" : "type",
            "autostart" : "autostart"
          } ],
          "privileged" : "privileged",
          "publishedports" : [ {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          }, {
            "protocol" : "protocol",
            "port" : "port",
            "ip" : "ip",
            "hostport" : "hostport"
          } ],
          "entrypoint" : "entrypoint",
          "impersonatemode" : "merge",
          "impersonateusernames" : [ "impersonateusernames", "impersonateusernames" ],
          "name" : "name",
          "memorylimit" : 1,
          "gracefulstop" : "gracefulstop",
          "environmentvariables" : [ {
            "name" : "name",
            "value" : "value"
          }, {
            "name" : "name",
            "value" : "value"
          } ],
          "imageregistryurl" : "imageregistryurl",
          "shortrunning" : "shortrunning"
        } ],
        "sharedproperties" : {
          "volumes" : [ {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          }, {
            "envname" : "envname",
            "permission" : "permission",
            "value" : "value",
            "hostpath" : "hostpath"
          } ],
          "environmentvariables" : [ {
            "name" : "name",
            "value" : "value"
          }, {
            "name" : "name",
            "value" : "value"
          } ],
          "startuptimeout" : 6,
          "stoptimeout" : 1,
          "network" : {
            "externalscriptvariables" : [ {
              "name" : "name",
              "value" : "value"
            }, {
              "name" : "name",
              "value" : "value"
            } ],
            "dnssearchdomain" : [ "dnssearchdomain", "dnssearchdomain" ],
            "dnsserver" : [ "dnsserver", "dnsserver" ],
            "podname" : "podname",
            "sdnname" : [ "sdnname", "sdnname" ],
            "networktype" : "bridge"
          }
        }
      },
      "inactivityperiod" : "inactivityperiod",
      "cleanupfinishwaitperiod" : "cleanupfinishwaitperiod",
      "postcommand" : {
        "stdoutfile" : "stdoutfile",
        "stderrfile" : "stderrfile",
        "value" : "value",
        "timeout" : 9
      },
      "workingdirectory" : "workingdirectory",
      "environmentvariables" : [ {
        "name" : "name",
        "value" : "value"
      }, {
        "name" : "name",
        "value" : "value"
      } ],
      "jobmonitormaxupdateinterval" : 3,
      "defaulturl" : "defaulturl",
      "precommand" : {
        "stdoutfile" : "stdoutfile",
        "stderrfile" : "stderrfile",
        "value" : "value",
        "timeout" : 7
      }
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json
• text/xml

Responses

200

Successfully retrieved the service profile. For more informaion about the profile schema of XML responses, search for the "Service profile reference" topic in the IBM documentation. ServiceDefinition

401

Authentication error. The request was denied.

404

The service with the specified service name was not found.

500

An unexpected error occurred while retrieving the service profile.

get /ego/v1/services/{name}/state

Path parameters

Return type

Example data

{
  "numinstances" : 6,
  "numstartinginstances" : 1,
  "numholdinginstances" : 5,
  "usage" : {
    "mem" : 2.027123,
    "coresused" : 3.6160767,
    "diskrate" : 7.386282,
    "iorate" : 4.145608
  },
  "allocationid" : 0,
  "type" : "type",
  "numrunninginstances" : 5,
  "numunknowninstances" : 2,
  "numfinishedinstances" : 7,
  "name" : "name",
  "state" : "state",
  "consumer" : "consumer",
  "numerrorinstances" : 9
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the service. ServiceStateInfo

401

Authentication error. The request was denied.

404

The service with the specified service name was not found.

500

An unexpected error occurred while retrieving the service.

put /ego/v1/services/{name}

Path parameters

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json
• text/xml

Request body

Query parameters

Return type

Example data

{
  "maxinstancesperslot" : 1,
  "resourcegroup" : "resourcegroup",
  "resourcerequirement" : "resourcerequirement",
  "instancetoslotratio" : "instancetoslotratio",
  "description" : "description",
  "basevirtualip" : "basevirtualip",
  "type" : "type",
  "maxinstances" : 6,
  "dependencies" : [ "dependencies", "dependencies" ],
  "affinityrequirements" : {
    "affinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ],
    "antiaffinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ]
  },
  "netmask" : "netmask",
  "mininstances" : 0,
  "mdsproperties" : {
    "service" : "service",
    "type" : "hard"
  },
  "name" : "name",
  "starttype" : "AUTOMATIC",
  "maxrestarts" : 5,
  "consumer" : "consumer"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully modified the service. ServiceInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The service with the specified name is not found.

409

A service property that cannot be dynamically changed was specified.

500

An unexpected error occurred while registering the service.

post /ego/v1/services

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json
• text/xml

Request body

Query parameters

Return type

Example data

{
  "maxinstancesperslot" : 1,
  "resourcegroup" : "resourcegroup",
  "resourcerequirement" : "resourcerequirement",
  "instancetoslotratio" : "instancetoslotratio",
  "description" : "description",
  "basevirtualip" : "basevirtualip",
  "type" : "type",
  "maxinstances" : 6,
  "dependencies" : [ "dependencies", "dependencies" ],
  "affinityrequirements" : {
    "affinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ],
    "antiaffinities" : [ {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    }, {
      "resourceplanname" : "resourceplanname",
      "resourcemetrics" : [ {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      }, {
        "metricname" : "metricname",
        "metricvalue" : "metricvalue"
      } ]
    } ]
  },
  "netmask" : "netmask",
  "mininstances" : 0,
  "mdsproperties" : {
    "service" : "service",
    "type" : "hard"
  },
  "name" : "name",
  "starttype" : "AUTOMATIC",
  "maxrestarts" : 5,
  "consumer" : "consumer"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully registered the service. ServiceInfo

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

409

A service with the specified service name already exists.

500

An unexpected error occurred while registering the service.

put /ego/v1/services/instances/operations

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Responses

204

Successfully initiated service operations on the service instance.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The service with the specified name is not found.

409

The service instance is not in a valid state for the specified operation.

500

An unexpected error occurred while trying to operate the service instance.

501

The operation that is specified is not implemented for this service instance.

put /ego/v1/services/operations

Consumes

This API call consumes the following media types via the Content-Type request header:

• application/json

Request body

Query parameters

Responses

204

Successfully initiated service operations on the services.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

404

The service with the specified name is not found.

409

The service is not in a valid state for the specified operation.

500

An unexpected error occurred while trying to operate the service.

501

The operation that is specified is not implemented for this service.

delete /ego/v1/services/{name}

Path parameters

Query parameters

Responses

204

Successfully unregistered the service.

401

Authentication error. The request was denied.

404

The service with the specified name is not found.

409

The service was not unregistered.

500

An unexpected error occurred while unregistering the service.

get /ego/v1/usergroups

Request headers

Return type

Example data

[ {
  "groupmemberlist" : [ "groupmemberlist", "groupmemberlist" ],
  "groupid" : "groupid",
  "description" : "description",
  "groupname" : "groupname"
}, {
  "groupmemberlist" : [ "groupmemberlist", "groupmemberlist" ],
  "groupid" : "groupid",
  "description" : "description",
  "groupname" : "groupname"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the user group list.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the user group list.

get /ego/v1/usergroups/{groupname}/permissions

Path parameters

Request headers

Return type

Example data

[ {
  "contexttypes" : "contexttypes",
  "context" : "context",
  "id" : "id"
}, {
  "contexttypes" : "contexttypes",
  "context" : "context",
  "id" : "id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the permissions that are assigned to the user group.

401

Authentication error. The request was denied.

404

The user group with the specified role name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the permissions assigned to the user group.

get /ego/v1/usergroups/{groupname}/assignments/roles

Path parameters

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the roles that are assigned to the user group.

401

Authentication error. The request was denied.

404

The user group with the specified role name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the roles assigned to a user group.

get /ego/v1/usergroups/assignments/roles

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the role-user group assignment list.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the role-user group assignment list.

post /ego/v1/users

Request body

Query parameters

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

Successfully added the user.

400

Bad request. The request contains invalid values.

401

Authentication error. The request was denied.

500

An unexpected error occurred while adding the role.

get /ego/v1/users

Request headers

Return type

Example data

[ {
  "description" : "description",
  "groups" : "groups",
  "username" : "username"
}, {
  "description" : "description",
  "groups" : "groups",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the user list.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the user list.

get /ego/v1/users/{username}/permissions

Path parameters

Request headers

Return type

Example data

[ {
  "contexttypes" : "contexttypes",
  "context" : "context",
  "id" : "id"
}, {
  "contexttypes" : "contexttypes",
  "context" : "context",
  "id" : "id"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the permissions that are assigned to the user.

401

Authentication error. The request was denied.

404

The user with the specified role name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the permissions assigned to the user.

get /ego/v1/users/{username}/assignments/roles

Path parameters

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the roles that are assigned to the user.

401

Authentication error. The request was denied.

404

The user with the specified role name was not found.

416

An index is out of range.

500

An unexpected error occurred while retrieving the roles assigned to a user.

get /ego/v1/users/assignments/roles

Request headers

Return type

Example data

[ {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
}, {
  "rolename" : "rolename",
  "context" : "context",
  "username" : "username"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

200

Successfully retrieved the role-user assignment list.

401

Authentication error. The request was denied.

416

An index is out of range.

500

An unexpected error occurred while retrieving the role-user assignment list.