Root Schema : instance-responsem
Type: object
Information about the Oracle SOA Cloud Service instance.
Show Source
-
activityLogs:
array activityLogs
Activity logs for the service instance.
-
adminHostName:
string
Host name of the Administration Server for this service instance.
-
allAssociations:
object allAssociations
Groups information about one or more Database Cloud Service database deployments associated with this Oracle SOA Cloud Service instance. The object can also include information about the Oracle SOA Cloud Service clone instances that this service instance is required for, or the Oracle SOA Cloud Service source instance that this clone instance is dependent on.
-
attributes:
object attributes
Information about service instance attributes.
-
backup:
object backup
Information about service instance backup operations.
-
components:
object components
Groups details about the WLS component and the OTD component (if provisioned).
-
computeSiteName:
string
Location where the service instance is provisioned.
-
creationDate:
string
Date and time the Oracle SOA Cloud Service instance was created.
-
creator:
string
Name of the user account that was used to create the Oracle SOA Cloud Service instance.
-
domainName:
string
Identity domain ID for the Oracle SOA Cloud Service account.
-
edition:
string
The Oracle WebLogic Server software edition that was provisioned on this service instance. For example, SE
, EE
, or SUITE
.
-
editionDisplayName:
string
Display name of the WebLogic Server software edition. For example, Enterprise Edition
.
-
FMW_ROOT:
string
The URL of the Fusion Middleware Control console.
-
keyComponentInstance:
string
Components key to the operation of this service instance. The value is WLS
.
-
metaVersion:
string
-
meteringFrequency:
string
Metering frequency. For example: HOURLY
or MONTHLY
-
meteringFrequencyDisplayName:
string
Display name of metering frequency. For example: Monthly
.
-
OTD_ROOT:
string
The URL of the OTD console.
-
region:
string
Region where the service instanced is provisioned.
-
releaseVersion:
string
The specific Oracle WebLogic Server software binaries in use. For example:
12.2.1.3.x
.
Note:This value is updated when the service instance is patched.
-
serviceDescription:
string
Free-form text that was provided about this service instance when it was created.
-
serviceId:
integer
ID of the Oracle SOA Cloud Service instance.
-
serviceLevel:
string
Service level. For example: PAAS
or BASIC
-
serviceLevelDisplayName:
string
Display name of the service level. For example, Oracle SOA Cloud Service.
-
serviceName:
string
Name given to this service instance when it was created.
-
serviceStateDisplayName:
string
State of the service instance. For example, READY
. See state
for the list of possible values.
-
serviceType:
string
Type of this service instance. For Oracle SOA Cloud Service instances, the value is SOA
.
-
serviceVersion:
string
The Oracle WebLogic Server software release that was provisioned on this service instance. For example: 12cRelease212
, 12cRelease2
, 12cR3
, 11gR1
, or 11g
-
state:
string
Current state of this Oracle SOA Cloud Service instance. Values are:
NEW
- The service instance was just created.INITIALIZING
- The service instance is being created, some resources may be created or started.READY
- The service instance is created and ready for use.CONFIGURING
- The service instance is being configured and may be unavailable for other operations.TERMINATING
- The service instance is being deleted or scheduled for removal.STOPPING
- The service instance is being stopped, including all service resources.STOPPED
- The service instance is stopped.STARTING
- The service instance is being started.DISABLING
- The service instance is being disabled.DISABLED
- The service instance is disabled.TERMINATED
- The service instance is deleted.
-
subscription:
string
Subscription type. For example: HOURLY
or MONTHLY
-
totalSSDStorage:
integer
-
WLS_ROOT:
string
The URL of the WebLogic Server Administration console.
{
"required":[
"activityLogs",
"adminHostName",
"attributes",
"allAssociations",
"backup",
"computeSiteName",
"creator",
"creationDate",
"components",
"domainName",
"edition",
"editionDisplayName",
"keyComponentInstance",
"metaVersion",
"meteringFrequency",
"meteringFrequencyDisplayName",
"FMW_ROOT",
"WLS_ROOT",
"OTD_ROOT",
"region",
"releaseVersion",
"serviceDescription",
"serviceId",
"serviceLevel",
"serviceLevelDisplayName",
"serviceName",
"serviceStateDisplayName",
"serviceType",
"serviceVersion",
"state",
"subscription",
"totalSSDStorage"
],
"description":"Information about the Oracle SOA Cloud Service instance.",
"properties":{
"adminHostName":{
"type":"string",
"description":"Host name of the Administration Server for this service instance."
},
"activityLogs":{
"type":"array",
"description":"Activity logs for the service instance.",
"items":{
"description":"Activity log details, including messages.",
"properties":{
"activityLogId":{
"type":"integer",
"description":"ID of the activity log."
},
"serviceName":{
"type":"string",
"description":"Name given to this service instance when it was created."
},
"serviceType":{
"type":"string",
"description":"Type of this service instance. For Oracle SOA Cloud Service instances, the value is <code>soa</code>."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain for the Oracle SOA Cloud Service account."
},
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"jobId":{
"type":"integer",
"description":"Job ID for the operation.<p><b>Note:</b> This value may be set to No Job Submitted temporarily, just prior to being submitted for processing."
},
"startDate":{
"type":"string",
"description":"Date and time the operation started."
},
"endDate":{
"type":"string",
"description":"Date and time the operation ended."
},
"status":{
"type":"string",
"description":"Final status of the operation. Example status messages include: <code>NEW</code>, <code>RUNNING</code>, <code>SUCCEED</code>, and <code>FAILED</code>"
},
"operationId":{
"type":"integer",
"description":"ID of the operation."
},
"operationType":{
"type":"string",
"description":"Operation type. For example: <code>RESTORE</code>, <code>BACKUP</code>, <code>START_SERVICE</code>, <code>STOP_SERVICE</code>, and so on"
},
"summaryMessage":{
"type":"string",
"description":"Summary of the activity."
},
"initiatedBy":{
"type":"string",
"description":"Name of the user who initiated the operation."
},
"messages":{
"type":"array",
"description":"Messages related to the activity.",
"items":{
"type":"object",
"description":"Date and details of messages.",
"properties":{
"activityDate":{
"type":"string",
"description":"Date and time the activity was logged."
},
"message":{
"type":"string",
"description":"Details of the activity."
}
}
}
}
}
}
},
"attributes":{
"type":"object",
"description":"Information about service instance attributes.",
"properties":{
"FMW_ROOT":{
"type":"object",
"description":"Fusion Middleware Control Console details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Open Fusion Middleware Control Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL of the Fusion Middleware Control console. For example: <code>https://10.xxx.xxx.xx:7002/em</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the Fusion Middleware Control console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
},
"BACKUP_DESTINATION":{
"type":"object",
"description":"Service instance backup details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Backup Destination</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the type of backup configured for this service instance. For example: <code>BOTH</code> or <code>NONE</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value. For example: <code>BOTH</code> or <code>NONE</code>"
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"cloudStorageContainer":{
"type":"object",
"description":"Object storage container details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Cloud Storage Container</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the name of the object storage container or bucket for storing service instance backups."
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the name of the object storage container or bucket."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"customPayload":{
"type":"object",
"description":"AppToCloud payload.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>AppToCloud Payload</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>CUSTOM_PAYLOAD</code>."
},
"value":{
"type":"string",
"description":"Attribute value is location of the the Model Metadata Override JSON file."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"CONTENT_ROOT":{
"type":"object",
"description":"Application content details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL for application content."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"jdkVersion":{
"type":"object",
"description":"JDK details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>JDK</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the version of JAVA installed. For example: <code>1.8.0_144</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value. For example: <code>1.8.0_144</code>"
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"OTD_ROOT":{
"type":"object",
"description":"Local load balancer details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open Load Balancer Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL of the OTD console. For example: <code>https://10.xxx.xxx.xxx:8989</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the OTD console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
},
"SAMPLE_ROOT":{
"type":"object",
"description":"Sample application details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open Sample Application</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the sample service URL, if the sample application was deployed when the service instance was provisioned."
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the sample service URL."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"WLS_ROOT":{
"type":"object",
"description":"WebLogic Server Console details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open WebLogic Server Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value, which is the URL of the WebLogic Server Administration console. For example: <code>https://10.xxx.xx.xx:7002/console</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the WebLogic Server Administration console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
}
}
},
"allAssociations":{
"type":"object",
"description":"Groups information about one or more Database Cloud Service database deployments associated with this Oracle SOA Cloud Service instance. The object can also include information about the Oracle SOA Cloud Service clone instances that this service instance is required for, or the Oracle SOA Cloud Service source instance that this clone instance is dependent on.",
"properties":{
"toAssociations":{
"type":"array",
"description":"Contains information about the Database Cloud Service database deployment that is required for infrastruture schema, and one or more optional database deployments for application schema.<p>Information about the Oracle SOA Cloud Service source instance and the source Database Cloud Service database deployment clone are included if this SOA Cloud Service instance is a clone.",
"items":{
"$ref":"#/definitions/associations-details"
}
},
"fromAssociations":{
"type":"array",
"description":"Contains information about an Oracle SOA Cloud Service instance clone if this SOA Cloud Service instance is the source instance for clones.",
"items":{
"$ref":"#/definitions/associations-details"
}
}
}
},
"backup":{
"type":"object",
"description":"Information about service instance backup operations.",
"properties":{
"operationInProgress":{
"type":"object",
"description":"Details about backup operations currently in progress.",
"items":{
"type":"string",
"description":"The object is empty if there are no operations in progress."
}
},
"lastBackupDate":{
"type":"string",
"description":"The date and the time of the last successful backup operation."
},
"lastFailedBackupDate":{
"type":"string",
"description":"The date and the time of the last failed backup operation."
}
}
},
"computeSiteName":{
"type":"string",
"description":"Location where the service instance is provisioned."
},
"creator":{
"type":"string",
"description":"Name of the user account that was used to create the Oracle SOA Cloud Service instance."
},
"creationDate":{
"type":"string",
"description":"Date and time the Oracle SOA Cloud Service instance was created."
},
"components":{
"type":"object",
"description":"Groups details about the WLS component and the OTD component (if provisioned).",
"properties":{
"WLS":{
"type":"object",
"description":"Details about the WLS component.",
"properties":{
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"componentId":{
"type":"integer",
"description":"ID of this component of this service instance."
},
"state":{
"type":"string",
"description":"State of the component. Values are:<ul><li><code>NEW</code> - The component was just created.</li><li><code>INITIALIZING</code> - The component is being created, some resources may be created or started.</li><li><code>READY</code> - The component is created and ready for use.</li><li><code>CONFIGURING</code> - The component is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The component is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The component is being stopped.</li><li><code>STOPPED</code> - The component is stopped.</li><li><code>STARTING</code> - The component is being started.</li><li><code>DISABLING</code> - The component is being disabled.</li><li><code>DISABLED</code> - The component is disabled.</li><li><code>TERMINATED</code> - The component is deleted.</li></ul>"
},
"version":{
"type":"string",
"description":"Oracle WebLogic Server software release that was provisioned on this service instance. For example: <code>12.1.3.0.x</code>"
},
"componentType":{
"type":"string",
"description":"Type of the component. Value is <code>WLS</code>."
},
"creationDate":{
"type":"string",
"description":"Date and time this component was created."
},
"instanceName":{
"type":"string",
"description":"Value is <code>WLS</code>."
},
"instanceRole":{
"type":"string",
"description":"Value is <code>NONE</code>."
},
"attributes":{
"type":"object",
"description":"WLS component attribute details.",
"properties":{
"upperStackProductName":{
"type":"object",
"description":"Attributes of the Fusion Middleware (Upper Stack) product to be installed or installed on the service instance.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. The value is <code>Fusion Middleware</code>."
},
"type":{
"type":"string",
"description":"Attribute type. This value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value of the Fusion Middleware (Upper Stack) product to be installed or installed."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is either <code>false</code> or <code>true</code>."
}
}
}
}
},
"vmInstances":{
"type":"object",
"description":"Groups details about WLS VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-wls":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of this object (<code>vm-wls</code>) is actually the host name, for example, <code>exampleinstance-wls-1</code>, <code>exampleinstance-wls-2</code>, and so on.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-wls-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>ExampleInstance wls 1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence Managed Servers (datagrid server).</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
},
"adminHostName":{
"type":"string",
"description":"Host name of the administration server."
},
"hosts":{
"type":"object",
"description":"Groups details about all hosts that are running in the service instance for the WLS component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (WLS component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific user host (WLS component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-wls-2</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"VM ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name. For example: <code>exampleinstance-wls-2</code>"
},
"label":{
"type":"string",
"description":"Label associated with this host. For example: <code>ExampleInstance wls 2</code>"
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence (data grid) servers.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host. For example: <code>oc3</code>"
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
},
"servers":{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
}
}
},
"clusters":{
"type":"object",
"description":"Groups details about clusters in the domain by cluster name. Each cluster is a JSON object element.",
"properties":{
"cluster-name":{
"type":"object",
"description":"Details about a specific cluster.<p>Note that the label of this object (<code>cluster-name</code>) is actually the cluster name. For example: <code>ExampleCluster</code>, <code>ExampleI_cluster</code>, <code>datagridCluster</code>",
"properties":{
"clusterId":{
"type":"integer",
"description":"ID of this cluster."
},
"clusterName":{
"type":"string",
"description":"Cluster name. For example: <code>ExampleCluster</code>"
},
"clusterType":{
"type":"string",
"description":"Value is always <code>PAAS</code> for a WebLogic logical cluster."
},
"creationDate":{
"type":"string",
"description":"Date and time the cluster was created."
},
"profile":{
"type":"string",
"description":"Identifies service specific cluster and server information. Details include:<ul><li>Cluster type - <code>APPLICATION_CLUSTER</code> or <code>CACHING_CLUSTER</code></li><li>Shape - Compute shape used by nodes of this cluster</li><li>Whether this cluster is accessible from the public network (<code>external</code> value is <code>true</code> if accessible)</li></ul>"
},
"paasServers":{
"type":"object",
"description":"Groups details about managed servers that are members of this cluster. Each server is a JSON object element.",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
},
"displayName":{
"type":"string",
"description":"Value is <code>WebLogic</code>."
}
}
},
"OTD":{
"type":"object",
"description":"Details about the OTD component.",
"properties":{
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"componentId":{
"type":"integer",
"description":"ID of this component of this service instance."
},
"state":{
"type":"string",
"description":"State of the component. Values are:<ul><li><code>NEW</code> - The component was just created.</li><li><code>INITIALIZING</code> - The component is being created, some resources may be created or started.</li><li><code>READY</code> - The component is created and ready for use.</li><li><code>CONFIGURING</code> - The component is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The component is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The component is being stopped.</li><li><code>STOPPED</code> - The component is stopped.</li><li><code>STARTING</code> - The component is being started.</li><li><code>DISABLING</code> - The component is being disabled.</li><li><code>DISABLED</code> - The component is disabled.</li><li><code>TERMINATED</code> - The component is deleted.</li></ul>"
},
"version":{
"type":"string",
"description":"Oracle Traffic Director software version. For example, <code>11.1.1.9</code>."
},
"componentType":{
"type":"string",
"description":"Type of the component. Value is <code>OTD</code>."
},
"creationDate":{
"type":"string",
"description":"Date and time this component was created."
},
"instanceName":{
"type":"string",
"description":"Name of this componenet instance. Value is <code>OTD</code>."
},
"instanceRole":{
"type":"string",
"description":"Value is <code>NONE</code>."
},
"attributes":{
"type":"object",
"description":"OTD component attribute details.",
"properties":{
"PRIV_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT_ENABLED":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>BOOLEAN</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This indicates if the listener port is enabled."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This indicates if the listener port is enabled."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"PRIV_SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"ADMIN_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the administration port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the administration port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
}
},
"vmInstances":{
"type":"object",
"description":"Groups details about OTD VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-otd":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of the object (<code>vm-otd</code>) is actually the host name, for example, <code>exampleinstance-lb-1</code>.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-lb-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>exampleinstance-lb-1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running OTD Admin and the local load balancer server.</li><li><code>NODE_VM</code> - This node is running the second local load balancer server.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
},
"adminHostName":{
"type":"string",
"description":"Host name of the administration server."
},
"hosts":{
"type":"object",
"description":"Groups details about hosts that are running in the service instance for the OTD component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (OTD component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific host (OTD component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-lb-1</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name."
},
"label":{
"type":"string",
"description":"Label associated with this host."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example: <code>ADMIN_SERVER</code>, <code>NODE_VM</code>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>OTD</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
}
}
}
}
}
}
},
"displayName":{
"type":"string",
"description":"Value is <code>Oracle Load Balancer</code>."
}
}
}
}
},
"domainName":{
"type":"string",
"description":"Identity domain ID for the Oracle SOA Cloud Service account."
},
"edition":{
"type":"string",
"description":"The Oracle WebLogic Server software edition that was provisioned on this service instance. For example, <code>SE</code>, <code>EE</code>, or <code>SUITE</code>."
},
"editionDisplayName":{
"type":"string",
"description":"Display name of the WebLogic Server software edition. For example, <code>Enterprise Edition</code>."
},
"keyComponentInstance":{
"type":"string",
"description":"Components key to the operation of this service instance. The value is <code>WLS</code>."
},
"metaVersion":{
"type":"string",
"description":"Current version for the service definition (schema) used by this service instance."
},
"meteringFrequency":{
"type":"string",
"description":"Metering frequency. For example: <code>HOURLY</code> or <code>MONTHLY</code>"
},
"meteringFrequencyDisplayName":{
"type":"string",
"description":"Display name of metering frequency. For example: <code>Monthly</code>."
},
"FMW_ROOT":{
"type":"string",
"description":"The URL of the Fusion Middleware Control console."
},
"WLS_ROOT":{
"type":"string",
"description":"The URL of the WebLogic Server Administration console."
},
"OTD_ROOT":{
"type":"string",
"description":"The URL of the OTD console."
},
"region":{
"type":"string",
"description":"Region where the service instanced is provisioned."
},
"releaseVersion":{
"type":"string",
"description":"The specific Oracle WebLogic Server software binaries in use. For example: <code>12.2.1.3.x</code>.<p><b>Note:</b>This value is updated when the service instance is patched. "
},
"serviceDescription":{
"type":"string",
"description":"Free-form text that was provided about this service instance when it was created."
},
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"serviceLevel":{
"type":"string",
"description":"Service level. For example: <code>PAAS</code> or <code>BASIC</code>"
},
"serviceLevelDisplayName":{
"type":"string",
"description":"Display name of the service level. For example, Oracle SOA Cloud Service."
},
"serviceName":{
"type":"string",
"description":"Name given to this service instance when it was created."
},
"serviceStateDisplayName":{
"type":"string",
"description":"State of the service instance. For example, <code>READY</code>. See <code>state</code> for the list of possible values."
},
"serviceType":{
"type":"string",
"description":"Type of this service instance. For Oracle SOA Cloud Service instances, the value is <code>SOA</code>."
},
"serviceVersion":{
"type":"string",
"description":"The Oracle WebLogic Server software release that was provisioned on this service instance. For example: <code>12cRelease212</code>, <code>12cRelease2</code>, <code>12cR3</code>, <code>11gR1</code>, or <code>11g</code>"
},
"state":{
"type":"string",
"description":"Current state of this Oracle SOA Cloud Service instance. Values are:<ul><li><code>NEW</code> - The service instance was just created.</li><li><code>INITIALIZING</code> - The service instance is being created, some resources may be created or started.</li><li><code>READY</code> - The service instance is created and ready for use.</li><li><code>CONFIGURING</code> - The service instance is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service instance is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service instance is being stopped, including all service resources.</li><li><code>STOPPED</code> - The service instance is stopped.</li><li><code>STARTING</code> - The service instance is being started.</li><li><code>DISABLING</code> - The service instance is being disabled.</li><li><code>DISABLED</code> - The service instance is disabled.</li><li><code>TERMINATED</code> - The service instance is deleted.</li></ul>"
},
"subscription":{
"type":"string",
"description":"Subscription type. For example: <code>HOURLY</code> or <code>MONTHLY</code>"
},
"totalSSDStorage":{
"type":"integer",
"description":"SSD Storage."
}
}
}
Nested Schema : activityLogs
Type: array
Activity logs for the service instance.
Show Source
{
"type":"array",
"description":"Activity logs for the service instance.",
"items":{
"description":"Activity log details, including messages.",
"properties":{
"activityLogId":{
"type":"integer",
"description":"ID of the activity log."
},
"serviceName":{
"type":"string",
"description":"Name given to this service instance when it was created."
},
"serviceType":{
"type":"string",
"description":"Type of this service instance. For Oracle SOA Cloud Service instances, the value is <code>soa</code>."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain for the Oracle SOA Cloud Service account."
},
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"jobId":{
"type":"integer",
"description":"Job ID for the operation.<p><b>Note:</b> This value may be set to No Job Submitted temporarily, just prior to being submitted for processing."
},
"startDate":{
"type":"string",
"description":"Date and time the operation started."
},
"endDate":{
"type":"string",
"description":"Date and time the operation ended."
},
"status":{
"type":"string",
"description":"Final status of the operation. Example status messages include: <code>NEW</code>, <code>RUNNING</code>, <code>SUCCEED</code>, and <code>FAILED</code>"
},
"operationId":{
"type":"integer",
"description":"ID of the operation."
},
"operationType":{
"type":"string",
"description":"Operation type. For example: <code>RESTORE</code>, <code>BACKUP</code>, <code>START_SERVICE</code>, <code>STOP_SERVICE</code>, and so on"
},
"summaryMessage":{
"type":"string",
"description":"Summary of the activity."
},
"initiatedBy":{
"type":"string",
"description":"Name of the user who initiated the operation."
},
"messages":{
"type":"array",
"description":"Messages related to the activity.",
"items":{
"type":"object",
"description":"Date and details of messages.",
"properties":{
"activityDate":{
"type":"string",
"description":"Date and time the activity was logged."
},
"message":{
"type":"string",
"description":"Details of the activity."
}
}
}
}
}
}
}
Nested Schema : allAssociations
Type: object
Groups information about one or more Database Cloud Service database deployments associated with this Oracle SOA Cloud Service instance. The object can also include information about the Oracle SOA Cloud Service clone instances that this service instance is required for, or the Oracle SOA Cloud Service source instance that this clone instance is dependent on.
Show Source
-
fromAssociations(optional):
array fromAssociations
Contains information about an Oracle SOA Cloud Service instance clone if this SOA Cloud Service instance is the source instance for clones.
-
toAssociations(optional):
array toAssociations
Contains information about the Database Cloud Service database deployment that is required for infrastruture schema, and one or more optional database deployments for application schema.
Information about the Oracle SOA Cloud Service source instance and the source Database Cloud Service database deployment clone are included if this SOA Cloud Service instance is a clone.
{
"type":"object",
"description":"Groups information about one or more Database Cloud Service database deployments associated with this Oracle SOA Cloud Service instance. The object can also include information about the Oracle SOA Cloud Service clone instances that this service instance is required for, or the Oracle SOA Cloud Service source instance that this clone instance is dependent on.",
"properties":{
"toAssociations":{
"type":"array",
"description":"Contains information about the Database Cloud Service database deployment that is required for infrastruture schema, and one or more optional database deployments for application schema.<p>Information about the Oracle SOA Cloud Service source instance and the source Database Cloud Service database deployment clone are included if this SOA Cloud Service instance is a clone.",
"items":{
"$ref":"#/definitions/associations-details"
}
},
"fromAssociations":{
"type":"array",
"description":"Contains information about an Oracle SOA Cloud Service instance clone if this SOA Cloud Service instance is the source instance for clones.",
"items":{
"$ref":"#/definitions/associations-details"
}
}
}
}
Nested Schema : attributes
Type: object
Information about service instance attributes.
Show Source
{
"type":"object",
"description":"Information about service instance attributes.",
"properties":{
"FMW_ROOT":{
"type":"object",
"description":"Fusion Middleware Control Console details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Open Fusion Middleware Control Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL of the Fusion Middleware Control console. For example: <code>https://10.xxx.xxx.xx:7002/em</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the Fusion Middleware Control console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
},
"BACKUP_DESTINATION":{
"type":"object",
"description":"Service instance backup details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Backup Destination</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the type of backup configured for this service instance. For example: <code>BOTH</code> or <code>NONE</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value. For example: <code>BOTH</code> or <code>NONE</code>"
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"cloudStorageContainer":{
"type":"object",
"description":"Object storage container details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Cloud Storage Container</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the name of the object storage container or bucket for storing service instance backups."
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the name of the object storage container or bucket."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"customPayload":{
"type":"object",
"description":"AppToCloud payload.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>AppToCloud Payload</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>CUSTOM_PAYLOAD</code>."
},
"value":{
"type":"string",
"description":"Attribute value is location of the the Model Metadata Override JSON file."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"CONTENT_ROOT":{
"type":"object",
"description":"Application content details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL for application content."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"jdkVersion":{
"type":"object",
"description":"JDK details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>JDK</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the version of JAVA installed. For example: <code>1.8.0_144</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value. For example: <code>1.8.0_144</code>"
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"OTD_ROOT":{
"type":"object",
"description":"Local load balancer details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open Load Balancer Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL of the OTD console. For example: <code>https://10.xxx.xxx.xxx:8989</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the OTD console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
},
"SAMPLE_ROOT":{
"type":"object",
"description":"Sample application details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open Sample Application</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the sample service URL, if the sample application was deployed when the service instance was provisioned."
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the sample service URL."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
},
"WLS_ROOT":{
"type":"object",
"description":"WebLogic Server Console details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open WebLogic Server Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value, which is the URL of the WebLogic Server Administration console. For example: <code>https://10.xxx.xx.xx:7002/console</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the WebLogic Server Administration console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
}
}
}
Nested Schema : backup
Type: object
Information about service instance backup operations.
Show Source
{
"type":"object",
"description":"Information about service instance backup operations.",
"properties":{
"operationInProgress":{
"type":"object",
"description":"Details about backup operations currently in progress.",
"items":{
"type":"string",
"description":"The object is empty if there are no operations in progress."
}
},
"lastBackupDate":{
"type":"string",
"description":"The date and the time of the last successful backup operation."
},
"lastFailedBackupDate":{
"type":"string",
"description":"The date and the time of the last failed backup operation."
}
}
}
Nested Schema : components
Type: object
Groups details about the WLS component and the OTD component (if provisioned).
Show Source
{
"type":"object",
"description":"Groups details about the WLS component and the OTD component (if provisioned).",
"properties":{
"WLS":{
"type":"object",
"description":"Details about the WLS component.",
"properties":{
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"componentId":{
"type":"integer",
"description":"ID of this component of this service instance."
},
"state":{
"type":"string",
"description":"State of the component. Values are:<ul><li><code>NEW</code> - The component was just created.</li><li><code>INITIALIZING</code> - The component is being created, some resources may be created or started.</li><li><code>READY</code> - The component is created and ready for use.</li><li><code>CONFIGURING</code> - The component is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The component is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The component is being stopped.</li><li><code>STOPPED</code> - The component is stopped.</li><li><code>STARTING</code> - The component is being started.</li><li><code>DISABLING</code> - The component is being disabled.</li><li><code>DISABLED</code> - The component is disabled.</li><li><code>TERMINATED</code> - The component is deleted.</li></ul>"
},
"version":{
"type":"string",
"description":"Oracle WebLogic Server software release that was provisioned on this service instance. For example: <code>12.1.3.0.x</code>"
},
"componentType":{
"type":"string",
"description":"Type of the component. Value is <code>WLS</code>."
},
"creationDate":{
"type":"string",
"description":"Date and time this component was created."
},
"instanceName":{
"type":"string",
"description":"Value is <code>WLS</code>."
},
"instanceRole":{
"type":"string",
"description":"Value is <code>NONE</code>."
},
"attributes":{
"type":"object",
"description":"WLS component attribute details.",
"properties":{
"upperStackProductName":{
"type":"object",
"description":"Attributes of the Fusion Middleware (Upper Stack) product to be installed or installed on the service instance.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. The value is <code>Fusion Middleware</code>."
},
"type":{
"type":"string",
"description":"Attribute type. This value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value of the Fusion Middleware (Upper Stack) product to be installed or installed."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is either <code>false</code> or <code>true</code>."
}
}
}
}
},
"vmInstances":{
"type":"object",
"description":"Groups details about WLS VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-wls":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of this object (<code>vm-wls</code>) is actually the host name, for example, <code>exampleinstance-wls-1</code>, <code>exampleinstance-wls-2</code>, and so on.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-wls-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>ExampleInstance wls 1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence Managed Servers (datagrid server).</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
},
"adminHostName":{
"type":"string",
"description":"Host name of the administration server."
},
"hosts":{
"type":"object",
"description":"Groups details about all hosts that are running in the service instance for the WLS component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (WLS component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific user host (WLS component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-wls-2</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"VM ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name. For example: <code>exampleinstance-wls-2</code>"
},
"label":{
"type":"string",
"description":"Label associated with this host. For example: <code>ExampleInstance wls 2</code>"
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence (data grid) servers.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host. For example: <code>oc3</code>"
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
},
"servers":{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
}
}
},
"clusters":{
"type":"object",
"description":"Groups details about clusters in the domain by cluster name. Each cluster is a JSON object element.",
"properties":{
"cluster-name":{
"type":"object",
"description":"Details about a specific cluster.<p>Note that the label of this object (<code>cluster-name</code>) is actually the cluster name. For example: <code>ExampleCluster</code>, <code>ExampleI_cluster</code>, <code>datagridCluster</code>",
"properties":{
"clusterId":{
"type":"integer",
"description":"ID of this cluster."
},
"clusterName":{
"type":"string",
"description":"Cluster name. For example: <code>ExampleCluster</code>"
},
"clusterType":{
"type":"string",
"description":"Value is always <code>PAAS</code> for a WebLogic logical cluster."
},
"creationDate":{
"type":"string",
"description":"Date and time the cluster was created."
},
"profile":{
"type":"string",
"description":"Identifies service specific cluster and server information. Details include:<ul><li>Cluster type - <code>APPLICATION_CLUSTER</code> or <code>CACHING_CLUSTER</code></li><li>Shape - Compute shape used by nodes of this cluster</li><li>Whether this cluster is accessible from the public network (<code>external</code> value is <code>true</code> if accessible)</li></ul>"
},
"paasServers":{
"type":"object",
"description":"Groups details about managed servers that are members of this cluster. Each server is a JSON object element.",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
},
"displayName":{
"type":"string",
"description":"Value is <code>WebLogic</code>."
}
}
},
"OTD":{
"type":"object",
"description":"Details about the OTD component.",
"properties":{
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"componentId":{
"type":"integer",
"description":"ID of this component of this service instance."
},
"state":{
"type":"string",
"description":"State of the component. Values are:<ul><li><code>NEW</code> - The component was just created.</li><li><code>INITIALIZING</code> - The component is being created, some resources may be created or started.</li><li><code>READY</code> - The component is created and ready for use.</li><li><code>CONFIGURING</code> - The component is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The component is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The component is being stopped.</li><li><code>STOPPED</code> - The component is stopped.</li><li><code>STARTING</code> - The component is being started.</li><li><code>DISABLING</code> - The component is being disabled.</li><li><code>DISABLED</code> - The component is disabled.</li><li><code>TERMINATED</code> - The component is deleted.</li></ul>"
},
"version":{
"type":"string",
"description":"Oracle Traffic Director software version. For example, <code>11.1.1.9</code>."
},
"componentType":{
"type":"string",
"description":"Type of the component. Value is <code>OTD</code>."
},
"creationDate":{
"type":"string",
"description":"Date and time this component was created."
},
"instanceName":{
"type":"string",
"description":"Name of this componenet instance. Value is <code>OTD</code>."
},
"instanceRole":{
"type":"string",
"description":"Value is <code>NONE</code>."
},
"attributes":{
"type":"object",
"description":"OTD component attribute details.",
"properties":{
"PRIV_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT_ENABLED":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>BOOLEAN</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This indicates if the listener port is enabled."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This indicates if the listener port is enabled."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"PRIV_SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"ADMIN_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the administration port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the administration port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
}
},
"vmInstances":{
"type":"object",
"description":"Groups details about OTD VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-otd":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of the object (<code>vm-otd</code>) is actually the host name, for example, <code>exampleinstance-lb-1</code>.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-lb-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>exampleinstance-lb-1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running OTD Admin and the local load balancer server.</li><li><code>NODE_VM</code> - This node is running the second local load balancer server.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
},
"adminHostName":{
"type":"string",
"description":"Host name of the administration server."
},
"hosts":{
"type":"object",
"description":"Groups details about hosts that are running in the service instance for the OTD component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (OTD component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific host (OTD component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-lb-1</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name."
},
"label":{
"type":"string",
"description":"Label associated with this host."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example: <code>ADMIN_SERVER</code>, <code>NODE_VM</code>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>OTD</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
}
}
}
}
}
}
},
"displayName":{
"type":"string",
"description":"Value is <code>Oracle Load Balancer</code>."
}
}
}
}
}
Nested Schema : items
Type: object
Activity log details, including messages.
Show Source
{
"description":"Activity log details, including messages.",
"properties":{
"activityLogId":{
"type":"integer",
"description":"ID of the activity log."
},
"serviceName":{
"type":"string",
"description":"Name given to this service instance when it was created."
},
"serviceType":{
"type":"string",
"description":"Type of this service instance. For Oracle SOA Cloud Service instances, the value is <code>soa</code>."
},
"identityDomain":{
"type":"string",
"description":"Name of the identity domain for the Oracle SOA Cloud Service account."
},
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"jobId":{
"type":"integer",
"description":"Job ID for the operation.<p><b>Note:</b> This value may be set to No Job Submitted temporarily, just prior to being submitted for processing."
},
"startDate":{
"type":"string",
"description":"Date and time the operation started."
},
"endDate":{
"type":"string",
"description":"Date and time the operation ended."
},
"status":{
"type":"string",
"description":"Final status of the operation. Example status messages include: <code>NEW</code>, <code>RUNNING</code>, <code>SUCCEED</code>, and <code>FAILED</code>"
},
"operationId":{
"type":"integer",
"description":"ID of the operation."
},
"operationType":{
"type":"string",
"description":"Operation type. For example: <code>RESTORE</code>, <code>BACKUP</code>, <code>START_SERVICE</code>, <code>STOP_SERVICE</code>, and so on"
},
"summaryMessage":{
"type":"string",
"description":"Summary of the activity."
},
"initiatedBy":{
"type":"string",
"description":"Name of the user who initiated the operation."
},
"messages":{
"type":"array",
"description":"Messages related to the activity.",
"items":{
"type":"object",
"description":"Date and details of messages.",
"properties":{
"activityDate":{
"type":"string",
"description":"Date and time the activity was logged."
},
"message":{
"type":"string",
"description":"Details of the activity."
}
}
}
}
}
}
Nested Schema : messages
Type: array
Messages related to the activity.
Show Source
{
"type":"array",
"description":"Messages related to the activity.",
"items":{
"type":"object",
"description":"Date and details of messages.",
"properties":{
"activityDate":{
"type":"string",
"description":"Date and time the activity was logged."
},
"message":{
"type":"string",
"description":"Details of the activity."
}
}
}
}
Nested Schema : items
Type: object
Date and details of messages.
Show Source
{
"type":"object",
"description":"Date and details of messages.",
"properties":{
"activityDate":{
"type":"string",
"description":"Date and time the activity was logged."
},
"message":{
"type":"string",
"description":"Details of the activity."
}
}
}
Nested Schema : fromAssociations
Type: array
Contains information about an Oracle SOA Cloud Service instance clone if this SOA Cloud Service instance is the source instance for clones.
Show Source
{
"type":"array",
"description":"Contains information about an Oracle SOA Cloud Service instance clone if this SOA Cloud Service instance is the source instance for clones.",
"items":{
"$ref":"#/definitions/associations-details"
}
}
Nested Schema : toAssociations
Type: array
Contains information about the Database Cloud Service database deployment that is required for infrastruture schema, and one or more optional database deployments for application schema.
Information about the Oracle SOA Cloud Service source instance and the source Database Cloud Service database deployment clone are included if this SOA Cloud Service instance is a clone.
Show Source
{
"type":"array",
"description":"Contains information about the Database Cloud Service database deployment that is required for infrastruture schema, and one or more optional database deployments for application schema.<p>Information about the Oracle SOA Cloud Service source instance and the source Database Cloud Service database deployment clone are included if this SOA Cloud Service instance is a clone.",
"items":{
"$ref":"#/definitions/associations-details"
}
}
Nested Schema : associations-details
Type: object
Show Source
-
associationName(optional):
string
Association name. Values include:
INFRA_DB
- The association is to a Database Cloud Service database deployment that is required for the infrastructure schema.APP_DB
- The association is to a Database Cloud Service database deployment for application schema.CLONE_FROM
- The association is to the source SOA Cloud Service instance if this service instance is a clone. The association is from an Oracle SOA Cloud Service instance clone if this service instance is the source for clones.
-
associationType(optional):
string
Type of association. Values include:
DEPENDS_ON
- This service instance depends on the instance in the association.REQUISITE_OF
- This service instance is required for the instance in the association.
-
destServiceName(optional):
string
The service instance associated with this service instance. For example, the INFRA_DB
Database Cloud Service database deployment or the source SOA Cloud Service instance of a clone.
-
destServiceType(optional):
string
Type of service instance in destServiceName
. For example, SOA
for an Oracle SOA Cloud Service instance or DBaaS
or a Database Cloud Service database deployment.
-
displayName(optional):
string
-
sourceServiceName(optional):
string
A service instance clone of this service instance.
-
sourceServiceType(optional):
string
Type of service instance in sourceServiceName
. Value is SOA
for a service instance clone.
{
"properties":{
"associationName":{
"type":"string",
"description":"Association name. Values include:<ul><li><code>INFRA_DB</code> - The association is to a Database Cloud Service database deployment that is required for the infrastructure schema.</li><li><code>APP_DB</code> - The association is to a Database Cloud Service database deployment for application schema.</li><li><code>CLONE_FROM</code> - The association is to the source SOA Cloud Service instance if this service instance is a clone. The association is from an Oracle SOA Cloud Service instance clone if this service instance is the source for clones.</li></ul>"
},
"associationType":{
"type":"string",
"description":"Type of association. Values include:<ul><li><code>DEPENDS_ON</code> - This service instance depends on the instance in the association.</li><li><code>REQUISITE_OF</code> - This service instance is required for the instance in the association.</li></ul>"
},
"displayName":{
"type":"string",
"description":"Same as <code>associationName</code>."
},
"destServiceName":{
"type":"string",
"description":"The service instance associated with this service instance. For example, the <code>INFRA_DB</code> Database Cloud Service database deployment or the source SOA Cloud Service instance of a clone."
},
"destServiceType":{
"type":"string",
"description":"Type of service instance in <code>destServiceName</code>. For example, <code>SOA</code> for an Oracle SOA Cloud Service instance or <code>DBaaS</code> or a Database Cloud Service database deployment."
},
"sourceServiceName":{
"type":"string",
"description":"A service instance clone of this service instance."
},
"sourceServiceType":{
"type":"string",
"description":"Type of service instance in <code>sourceServiceName</code>. Value is <code>SOA</code> for a service instance clone."
}
}
}
Nested Schema : BACKUP_DESTINATION
Type: object
Service instance backup details.
Show Source
{
"type":"object",
"description":"Service instance backup details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Backup Destination</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the type of backup configured for this service instance. For example: <code>BOTH</code> or <code>NONE</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value. For example: <code>BOTH</code> or <code>NONE</code>"
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
}
Nested Schema : cloudStorageContainer
Type: object
Object storage container details.
Show Source
{
"type":"object",
"description":"Object storage container details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Cloud Storage Container</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the name of the object storage container or bucket for storing service instance backups."
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the name of the object storage container or bucket."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
}
Nested Schema : CONTENT_ROOT
Type: object
Application content details.
Show Source
{
"type":"object",
"description":"Application content details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL for application content."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
}
Nested Schema : customPayload
Type: object
AppToCloud payload.
Show Source
{
"type":"object",
"description":"AppToCloud payload.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>AppToCloud Payload</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>CUSTOM_PAYLOAD</code>."
},
"value":{
"type":"string",
"description":"Attribute value is location of the the Model Metadata Override JSON file."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
}
Nested Schema : FMW_ROOT
Type: object
Fusion Middleware Control Console details.
Show Source
{
"type":"object",
"description":"Fusion Middleware Control Console details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label. Value is <code>Open Fusion Middleware Control Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL of the Fusion Middleware Control console. For example: <code>https://10.xxx.xxx.xx:7002/em</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the Fusion Middleware Control console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
}
Nested Schema : jdkVersion
Type: object
JDK details.
Show Source
{
"type":"object",
"description":"JDK details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>JDK</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the version of JAVA installed. For example: <code>1.8.0_144</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value. For example: <code>1.8.0_144</code>"
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
}
Nested Schema : OTD_ROOT
Type: object
Local load balancer details.
Show Source
{
"type":"object",
"description":"Local load balancer details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open Load Balancer Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the URL of the OTD console. For example: <code>https://10.xxx.xxx.xxx:8989</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the OTD console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
}
Nested Schema : SAMPLE_ROOT
Type: object
Sample application details.
Show Source
{
"type":"object",
"description":"Sample application details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open Sample Application</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value is the sample service URL, if the sample application was deployed when the service instance was provisioned."
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the sample service URL."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>false</code>."
}
}
}
Nested Schema : WLS_ROOT
Type: object
WebLogic Server Console details.
Show Source
{
"type":"object",
"description":"WebLogic Server Console details.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. Value is <code>Open WebLogic Server Console</code>."
},
"type":{
"type":"string",
"description":"Type of the attribute value. Value is <code>URL</code>."
},
"value":{
"type":"string",
"description":"Attribute value, which is the URL of the WebLogic Server Administration console. For example: <code>https://10.xxx.xx.xx:7002/console</code>"
},
"displayValue":{
"type":"string",
"description":"Attribute display value, which is the URL of the WebLogic Server Administration console."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is <code>true</code>."
}
}
}
Nested Schema : operationInProgress
Type: object
Details about backup operations currently in progress.
Show Source
{
"type":"object",
"description":"Details about backup operations currently in progress.",
"items":{
"type":"string",
"description":"The object is empty if there are no operations in progress."
}
}
Nested Schema : OTD
Type: object
Details about the OTD component.
Show Source
{
"type":"object",
"description":"Details about the OTD component.",
"properties":{
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"componentId":{
"type":"integer",
"description":"ID of this component of this service instance."
},
"state":{
"type":"string",
"description":"State of the component. Values are:<ul><li><code>NEW</code> - The component was just created.</li><li><code>INITIALIZING</code> - The component is being created, some resources may be created or started.</li><li><code>READY</code> - The component is created and ready for use.</li><li><code>CONFIGURING</code> - The component is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The component is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The component is being stopped.</li><li><code>STOPPED</code> - The component is stopped.</li><li><code>STARTING</code> - The component is being started.</li><li><code>DISABLING</code> - The component is being disabled.</li><li><code>DISABLED</code> - The component is disabled.</li><li><code>TERMINATED</code> - The component is deleted.</li></ul>"
},
"version":{
"type":"string",
"description":"Oracle Traffic Director software version. For example, <code>11.1.1.9</code>."
},
"componentType":{
"type":"string",
"description":"Type of the component. Value is <code>OTD</code>."
},
"creationDate":{
"type":"string",
"description":"Date and time this component was created."
},
"instanceName":{
"type":"string",
"description":"Name of this componenet instance. Value is <code>OTD</code>."
},
"instanceRole":{
"type":"string",
"description":"Value is <code>NONE</code>."
},
"attributes":{
"type":"object",
"description":"OTD component attribute details.",
"properties":{
"PRIV_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT_ENABLED":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>BOOLEAN</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This indicates if the listener port is enabled."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This indicates if the listener port is enabled."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"PRIV_SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"ADMIN_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the administration port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the administration port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
}
},
"vmInstances":{
"type":"object",
"description":"Groups details about OTD VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-otd":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of the object (<code>vm-otd</code>) is actually the host name, for example, <code>exampleinstance-lb-1</code>.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-lb-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>exampleinstance-lb-1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running OTD Admin and the local load balancer server.</li><li><code>NODE_VM</code> - This node is running the second local load balancer server.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
},
"adminHostName":{
"type":"string",
"description":"Host name of the administration server."
},
"hosts":{
"type":"object",
"description":"Groups details about hosts that are running in the service instance for the OTD component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (OTD component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific host (OTD component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-lb-1</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name."
},
"label":{
"type":"string",
"description":"Label associated with this host."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example: <code>ADMIN_SERVER</code>, <code>NODE_VM</code>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>OTD</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
}
}
}
}
}
}
},
"displayName":{
"type":"string",
"description":"Value is <code>Oracle Load Balancer</code>."
}
}
}
Nested Schema : WLS
Type: object
Details about the WLS component.
Show Source
{
"type":"object",
"description":"Details about the WLS component.",
"properties":{
"serviceId":{
"type":"integer",
"description":"ID of the Oracle SOA Cloud Service instance."
},
"componentId":{
"type":"integer",
"description":"ID of this component of this service instance."
},
"state":{
"type":"string",
"description":"State of the component. Values are:<ul><li><code>NEW</code> - The component was just created.</li><li><code>INITIALIZING</code> - The component is being created, some resources may be created or started.</li><li><code>READY</code> - The component is created and ready for use.</li><li><code>CONFIGURING</code> - The component is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The component is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The component is being stopped.</li><li><code>STOPPED</code> - The component is stopped.</li><li><code>STARTING</code> - The component is being started.</li><li><code>DISABLING</code> - The component is being disabled.</li><li><code>DISABLED</code> - The component is disabled.</li><li><code>TERMINATED</code> - The component is deleted.</li></ul>"
},
"version":{
"type":"string",
"description":"Oracle WebLogic Server software release that was provisioned on this service instance. For example: <code>12.1.3.0.x</code>"
},
"componentType":{
"type":"string",
"description":"Type of the component. Value is <code>WLS</code>."
},
"creationDate":{
"type":"string",
"description":"Date and time this component was created."
},
"instanceName":{
"type":"string",
"description":"Value is <code>WLS</code>."
},
"instanceRole":{
"type":"string",
"description":"Value is <code>NONE</code>."
},
"attributes":{
"type":"object",
"description":"WLS component attribute details.",
"properties":{
"upperStackProductName":{
"type":"object",
"description":"Attributes of the Fusion Middleware (Upper Stack) product to be installed or installed on the service instance.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. The value is <code>Fusion Middleware</code>."
},
"type":{
"type":"string",
"description":"Attribute type. This value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value of the Fusion Middleware (Upper Stack) product to be installed or installed."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is either <code>false</code> or <code>true</code>."
}
}
}
}
},
"vmInstances":{
"type":"object",
"description":"Groups details about WLS VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-wls":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of this object (<code>vm-wls</code>) is actually the host name, for example, <code>exampleinstance-wls-1</code>, <code>exampleinstance-wls-2</code>, and so on.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-wls-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>ExampleInstance wls 1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence Managed Servers (datagrid server).</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
},
"adminHostName":{
"type":"string",
"description":"Host name of the administration server."
},
"hosts":{
"type":"object",
"description":"Groups details about all hosts that are running in the service instance for the WLS component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (WLS component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific user host (WLS component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-wls-2</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"VM ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name. For example: <code>exampleinstance-wls-2</code>"
},
"label":{
"type":"string",
"description":"Label associated with this host. For example: <code>ExampleInstance wls 2</code>"
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence (data grid) servers.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host. For example: <code>oc3</code>"
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
},
"servers":{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
}
}
},
"clusters":{
"type":"object",
"description":"Groups details about clusters in the domain by cluster name. Each cluster is a JSON object element.",
"properties":{
"cluster-name":{
"type":"object",
"description":"Details about a specific cluster.<p>Note that the label of this object (<code>cluster-name</code>) is actually the cluster name. For example: <code>ExampleCluster</code>, <code>ExampleI_cluster</code>, <code>datagridCluster</code>",
"properties":{
"clusterId":{
"type":"integer",
"description":"ID of this cluster."
},
"clusterName":{
"type":"string",
"description":"Cluster name. For example: <code>ExampleCluster</code>"
},
"clusterType":{
"type":"string",
"description":"Value is always <code>PAAS</code> for a WebLogic logical cluster."
},
"creationDate":{
"type":"string",
"description":"Date and time the cluster was created."
},
"profile":{
"type":"string",
"description":"Identifies service specific cluster and server information. Details include:<ul><li>Cluster type - <code>APPLICATION_CLUSTER</code> or <code>CACHING_CLUSTER</code></li><li>Shape - Compute shape used by nodes of this cluster</li><li>Whether this cluster is accessible from the public network (<code>external</code> value is <code>true</code> if accessible)</li></ul>"
},
"paasServers":{
"type":"object",
"description":"Groups details about managed servers that are members of this cluster. Each server is a JSON object element.",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
},
"displayName":{
"type":"string",
"description":"Value is <code>WebLogic</code>."
}
}
}
Nested Schema : attributes
Type: object
OTD component attribute details.
Show Source
{
"type":"object",
"description":"OTD component attribute details.",
"properties":{
"PRIV_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT_ENABLED":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>BOOLEAN</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This indicates if the listener port is enabled."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This indicates if the listener port is enabled."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"PRIV_SECURE_LISTENER_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
},
"ADMIN_PORT":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the administration port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the administration port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
}
}
Nested Schema : hosts
Type: object
Groups details about hosts that are running in the service instance for the OTD component.
Show Source
{
"type":"object",
"description":"Groups details about hosts that are running in the service instance for the OTD component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (OTD component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific host (OTD component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-lb-1</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name."
},
"label":{
"type":"string",
"description":"Label associated with this host."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example: <code>ADMIN_SERVER</code>, <code>NODE_VM</code>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>OTD</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
}
}
}
}
}
}
}
Nested Schema : vmInstances
Type: object
Groups details about OTD VM instances by host name. Each VM instance is a JSON object element.
This object will be deprecated in the near future. The properties host
and userHosts
contain the same information as vmInstances
, and more.
Show Source
-
vm-otd(optional):
object vm-otd
Details about a specific VM instance.
Note that the label of the object (vm-otd
) is actually the host name, for example, exampleinstance-lb-1
.
{
"type":"object",
"description":"Groups details about OTD VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-otd":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of the object (<code>vm-otd</code>) is actually the host name, for example, <code>exampleinstance-lb-1</code>.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-lb-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>exampleinstance-lb-1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running OTD Admin and the local load balancer server.</li><li><code>NODE_VM</code> - This node is running the second local load balancer server.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
}
Nested Schema : ADMIN_PORT
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the administration port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the administration port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
Nested Schema : LISTENER_PORT
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
Nested Schema : LISTENER_PORT_ENABLED
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>BOOLEAN</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This indicates if the listener port is enabled."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This indicates if the listener port is enabled."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
Nested Schema : PRIV_LISTENER_PORT
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
Nested Schema : PRIV_SECURE_LISTENER_PORT
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the privileged secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the privileged secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
Nested Schema : SECURE_LISTENER_PORT
Type: object
Show Source
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The attribute label in the user interface."
},
"type":{
"type":"string",
"description":"Attribute type. This value will be <code>INTEGER</code>."
},
"value":{
"type":"string",
"description":"Attribute value. This is the secure listener port."
},
"displayValue":{
"type":"string",
"description":"The display value of the attribute value. This is the secure listener port."
},
"isKeyBinding":{
"type":"boolean",
"description":"This value will be <code>false</code>."
}
}
}
Nested Schema : userHosts
Type: object
Groups details about user hosts by host name (OTD component). Each host is a JSON object element.
Show Source
-
host-name(optional):
object host-name
Details about a specific host (OTD component).
Note that the label of this object (host-name
) is actually the host name. For example: exampleinstance-lb-1
{
"type":"object",
"description":"Groups details about user hosts by host name (OTD component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific host (OTD component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-lb-1</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name."
},
"label":{
"type":"string",
"description":"Label associated with this host."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example: <code>ADMIN_SERVER</code>, <code>NODE_VM</code>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>OTD</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
}
}
}
}
}
Nested Schema : host-name
Type: object
Details about a specific host (OTD component).
Note that the label of this object (host-name
) is actually the host name. For example: exampleinstance-lb-1
Show Source
{
"type":"object",
"description":"Details about a specific host (OTD component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-lb-1</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name."
},
"label":{
"type":"string",
"description":"Label associated with this host."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example: <code>ADMIN_SERVER</code>, <code>NODE_VM</code>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>OTD</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
}
}
}
Nested Schema : vm-otd
Type: object
Details about a specific VM instance.
Note that the label of the object (vm-otd
) is actually the host name, for example, exampleinstance-lb-1
.
Show Source
{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of the object (<code>vm-otd</code>) is actually the host name, for example, <code>exampleinstance-lb-1</code>.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-lb-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>exampleinstance-lb-1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running OTD Admin and the local load balancer server.</li><li><code>NODE_VM</code> - This node is running the second local load balancer server.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
Nested Schema : attributes
Type: object
WLS component attribute details.
Show Source
{
"type":"object",
"description":"WLS component attribute details.",
"properties":{
"upperStackProductName":{
"type":"object",
"description":"Attributes of the Fusion Middleware (Upper Stack) product to be installed or installed on the service instance.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. The value is <code>Fusion Middleware</code>."
},
"type":{
"type":"string",
"description":"Attribute type. This value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value of the Fusion Middleware (Upper Stack) product to be installed or installed."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is either <code>false</code> or <code>true</code>."
}
}
}
}
}
Nested Schema : clusters
Type: object
Groups details about clusters in the domain by cluster name. Each cluster is a JSON object element.
Show Source
-
cluster-name(optional):
object cluster-name
Details about a specific cluster.
Note that the label of this object (cluster-name
) is actually the cluster name. For example: ExampleCluster
, ExampleI_cluster
, datagridCluster
{
"type":"object",
"description":"Groups details about clusters in the domain by cluster name. Each cluster is a JSON object element.",
"properties":{
"cluster-name":{
"type":"object",
"description":"Details about a specific cluster.<p>Note that the label of this object (<code>cluster-name</code>) is actually the cluster name. For example: <code>ExampleCluster</code>, <code>ExampleI_cluster</code>, <code>datagridCluster</code>",
"properties":{
"clusterId":{
"type":"integer",
"description":"ID of this cluster."
},
"clusterName":{
"type":"string",
"description":"Cluster name. For example: <code>ExampleCluster</code>"
},
"clusterType":{
"type":"string",
"description":"Value is always <code>PAAS</code> for a WebLogic logical cluster."
},
"creationDate":{
"type":"string",
"description":"Date and time the cluster was created."
},
"profile":{
"type":"string",
"description":"Identifies service specific cluster and server information. Details include:<ul><li>Cluster type - <code>APPLICATION_CLUSTER</code> or <code>CACHING_CLUSTER</code></li><li>Shape - Compute shape used by nodes of this cluster</li><li>Whether this cluster is accessible from the public network (<code>external</code> value is <code>true</code> if accessible)</li></ul>"
},
"paasServers":{
"type":"object",
"description":"Groups details about managed servers that are members of this cluster. Each server is a JSON object element.",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
}
Nested Schema : hosts
Type: object
Groups details about all hosts that are running in the service instance for the WLS component.
Show Source
{
"type":"object",
"description":"Groups details about all hosts that are running in the service instance for the WLS component.",
"properties":{
"userHosts":{
"type":"object",
"description":"Groups details about user hosts by host name (WLS component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific user host (WLS component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-wls-2</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"VM ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name. For example: <code>exampleinstance-wls-2</code>"
},
"label":{
"type":"string",
"description":"Label associated with this host. For example: <code>ExampleInstance wls 2</code>"
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence (data grid) servers.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host. For example: <code>oc3</code>"
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
},
"servers":{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
}
}
}
Nested Schema : vmInstances
Type: object
Groups details about WLS VM instances by host name. Each VM instance is a JSON object element.
This object will be deprecated in the near future. The properties host
and userHosts
contain the same information as vmInstances
, and more.
Show Source
-
vm-wls(optional):
object vm-wls
Details about a specific VM instance.
Note that the label of this object (vm-wls
) is actually the host name, for example, exampleinstance-wls-1
, exampleinstance-wls-2
, and so on.
{
"type":"object",
"description":"Groups details about WLS VM instances by host name. Each VM instance is a JSON object element.<p>This object will be deprecated in the near future. The properties <code>host</code> and <code>userHosts</code> contain the same information as <code>vmInstances</code>, and more.",
"properties":{
"vm-wls":{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of this object (<code>vm-wls</code>) is actually the host name, for example, <code>exampleinstance-wls-1</code>, <code>exampleinstance-wls-2</code>, and so on.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-wls-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>ExampleInstance wls 1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence Managed Servers (datagrid server).</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}
}
}
Nested Schema : upperStackProductName
Type: object
Attributes of the Fusion Middleware (Upper Stack) product to be installed or installed on the service instance.
Show Source
{
"type":"object",
"description":"Attributes of the Fusion Middleware (Upper Stack) product to be installed or installed on the service instance.",
"properties":{
"displayName":{
"type":"string",
"description":"Attribute label in the user interface. The value is <code>Fusion Middleware</code>."
},
"type":{
"type":"string",
"description":"Attribute type. This value is <code>STRING</code>."
},
"value":{
"type":"string",
"description":"Attribute value of the Fusion Middleware (Upper Stack) product to be installed or installed."
},
"displayValue":{
"type":"string",
"description":"Attribute display value."
},
"isKeyBinding":{
"type":"boolean",
"description":"Value is either <code>false</code> or <code>true</code>."
}
}
}
Nested Schema : cluster-name
Type: object
Details about a specific cluster.
Note that the label of this object (cluster-name
) is actually the cluster name. For example: ExampleCluster
, ExampleI_cluster
, datagridCluster
Show Source
{
"type":"object",
"description":"Details about a specific cluster.<p>Note that the label of this object (<code>cluster-name</code>) is actually the cluster name. For example: <code>ExampleCluster</code>, <code>ExampleI_cluster</code>, <code>datagridCluster</code>",
"properties":{
"clusterId":{
"type":"integer",
"description":"ID of this cluster."
},
"clusterName":{
"type":"string",
"description":"Cluster name. For example: <code>ExampleCluster</code>"
},
"clusterType":{
"type":"string",
"description":"Value is always <code>PAAS</code> for a WebLogic logical cluster."
},
"creationDate":{
"type":"string",
"description":"Date and time the cluster was created."
},
"profile":{
"type":"string",
"description":"Identifies service specific cluster and server information. Details include:<ul><li>Cluster type - <code>APPLICATION_CLUSTER</code> or <code>CACHING_CLUSTER</code></li><li>Shape - Compute shape used by nodes of this cluster</li><li>Whether this cluster is accessible from the public network (<code>external</code> value is <code>true</code> if accessible)</li></ul>"
},
"paasServers":{
"type":"object",
"description":"Groups details about managed servers that are members of this cluster. Each server is a JSON object element.",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
Nested Schema : paasServers
Type: object
Groups details about managed servers that are members of this cluster. Each server is a JSON object element.
Show Source
{
"type":"object",
"description":"Groups details about managed servers that are members of this cluster. Each server is a JSON object element.",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
Nested Schema : server-name
Type: object
Details about a specific server.
Note that the label of this object (server-name
) is actually the server name. For example: ExampleI_server_2
Show Source
{
"type":"object",
"description":"Details about a specific server.<p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Server name. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Server type. For example: <code>MS</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"creationDate":{
"type":"string",
"description":"Date and time the server was created."
},
"attributes":{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
Nested Schema : attributes
Type: object
Attribute details of a specific server.
Show Source
{
"type":"object",
"description":"Attribute details of a specific server.",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
Nested Schema : userHosts
Type: object
Groups details about user hosts by host name (WLS component). Each host is a JSON object element.
Show Source
-
host-name(optional):
object host-name
Details about a specific user host (WLS component).
Note that the label of this object (host-name
) is actually the host name. For example: exampleinstance-wls-2
{
"type":"object",
"description":"Groups details about user hosts by host name (WLS component). Each host is a JSON object element.",
"properties":{
"host-name":{
"type":"object",
"description":"Details about a specific user host (WLS component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-wls-2</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"VM ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name. For example: <code>exampleinstance-wls-2</code>"
},
"label":{
"type":"string",
"description":"Label associated with this host. For example: <code>ExampleInstance wls 2</code>"
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence (data grid) servers.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host. For example: <code>oc3</code>"
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
},
"servers":{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
}
}
Nested Schema : host-name
Type: object
Details about a specific user host (WLS component).
Note that the label of this object (host-name
) is actually the host name. For example: exampleinstance-wls-2
Show Source
{
"type":"object",
"description":"Details about a specific user host (WLS component). <p>Note that the label of this object (<code>host-name</code>) is actually the host name. For example: <code>exampleinstance-wls-2</code>",
"properties":{
"vmId":{
"type":"integer",
"description":"VM ID of this host."
},
"id":{
"type":"integer",
"description":"ID of this host."
},
"uuid":{
"type":"string",
"description":"Unique identifier of this host."
},
"hostName":{
"type":"string",
"description":"DNS host name. For example: <code>exampleinstance-wls-2</code>"
},
"label":{
"type":"string",
"description":"Label associated with this host. For example: <code>ExampleInstance wls 2</code>"
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence (data grid) servers.</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"state":{
"type":"string",
"description":"State of the host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
},
"shapeId":{
"type":"string",
"description":"The compute shape of the host. For example: <code>oc3</code>"
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this host contains an administration server, <code>false</code> otherwise."
},
"servers":{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
}
}
Nested Schema : servers
Type: object
Details about a server (WLS component).
Show Source
{
"type":"object",
"description":"Details about a server (WLS component).",
"properties":{
"server-name":{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
}
}
Nested Schema : server-name
Type: object
Details about a specific server instance.
Note that the label of this object (server-name
) is actually the server name. For example: ExampleI_server_2
Show Source
{
"type":"object",
"description":"Details about a specific server instance. <p>Note that the label of this object (<code>server-name</code>) is actually the server name. For example: <code>ExampleI_server_2</code>",
"properties":{
"serverId":{
"type":"integer",
"description":"ID of this server."
},
"serverName":{
"type":"string",
"description":"Name of this server. For example: <code>ExampleI_server_2</code>"
},
"serverType":{
"type":"string",
"description":"Type of server. For example: <code>MS</code>, <code>ADMIN</code>"
},
"serverRole":{
"type":"string",
"description":"For Oracle SOA Cloud Service service instances, this value is <code>SOA_ROLE</code>."
},
"state":{
"type":"string",
"description":"State of the server. Values are:<ul><li><code>NEW</code> - The server was just created.</li><li><code>INITIALIZING</code> - The server is being created, some resources may be created or started.</li><li><code>READY</code> - The server is created and ready for use.</li><li><code>CONFIGURING</code> - The server is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The server is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The server is being stopped.</li><li><code>STOPPED</code> - The server is stopped.</li><li><code>STARTING</code> - The server is being started.</li><li><code>DISABLING</code> - The server is being disabled.</li><li><code>DISABLED</code> - The server is disabled.</li><li><code>TERMINATED</code> - The server is deleted.</li></ul>"
},
"creationDate":{
"type":"string",
"description":"Time and date the server was created."
},
"serverStateDisplayName":{
"type":"string",
"description":"State of the server."
},
"attributes":{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
}
}
Nested Schema : attributes
Type: object
Details of server attributes (WLS component).
Show Source
{
"type":"object",
"description":"Details of server attributes (WLS component).",
"properties":{
"heap_size":{
"type":"string",
"description":"Heap size of the Managed Server."
},
"heap_start":{
"type":"string",
"description":"Initial heap size."
},
"additional_jvm_args":{
"type":"string",
"description":"One or more Managed Server JVM arguments separated by a space."
},
"cluster":{
"type":"string",
"description":"Cluster that this Managed Server is a member of."
},
"ccsr":{
"type":"string",
"description":"Name of the Coherence cluster (the system-level <code>CoherenceClusterSystemResource</code>) that the WLS cluster (application or caching) is associated with. Default value is <code>DataGridConfig</code>."
},
"max_perm_size":{
"type":"string",
"description":"Maximum Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"perm_size":{
"type":"string",
"description":"Initial Permanent Generation (PermGen) space in heap memory for a Managed Server JVM."
},
"ssl_port":{
"type":"string",
"description":"SSL port number."
},
"port":{
"type":"string",
"description":"Port number."
},
"server_type":{
"type":"string",
"description":"Server type. For example: <code>WLS</code>, <code>DG</code>"
},
"template":{
"type":"string",
"description":"Cluster template for the server. For example: <code>ExampleI_cluster_Template</code>, <code>DataGridServer-Template</code>"
},
"role":{
"type":"string",
"description":"Server role. For example: <code>managed</code>"
}
}
}
Nested Schema : vm-wls
Type: object
Details about a specific VM instance.
Note that the label of this object (vm-wls
) is actually the host name, for example, exampleinstance-wls-1
, exampleinstance-wls-2
, and so on.
Show Source
{
"type":"object",
"description":"Details about a specific VM instance.<p>Note that the label of this object (<code>vm-wls</code>) is actually the host name, for example, <code>exampleinstance-wls-1</code>, <code>exampleinstance-wls-2</code>, and so on.",
"properties":{
"hostName":{
"type":"string",
"description":"DNS host name. For example, <code>exampleinstance-wls-1</code>."
},
"label":{
"type":"string",
"description":"Label associated with this host. For example, <code>ExampleInstance wls 1</code>."
},
"ipAddress":{
"type":"string",
"description":"IP address of this host. Not all hosts are accessible from the public Internet."
},
"publicIpAddress":{
"type":"string",
"description":"Public accessible IP address."
},
"usageType":{
"type":"string",
"description":"Purpose of this host. For example:<ul><li><code>ADMIN_SERVER</code> - This node is running the WebLogic Administration Server and the first Managed Server.</li><li><code>MANAGED_SERVER</code> - This node is running a Managed Server.</li><li><code>DG_SERVER</code> - This node is running one or more Coherence Managed Servers (datagrid server).</li></ul>"
},
"role":{
"type":"string",
"description":"Similar to <code>usageType</code>."
},
"state":{
"type":"string",
"description":"State of this host. Values are:<ul><li><code>NEW</code> - The service resource was just created.</li><li><code>INITIALIZING</code> - The service resource is being created, some resources may be created or started.</li><li><code>READY</code> - The service resource is created and ready for use.</li><li><code>CONFIGURING</code> - The service resource is being configured and may be unavailable for other operations.</li><li><code>TERMINATING</code> - The service resource is being deleted or scheduled for removal.</li><li><code>STOPPING</code> - The service resource is being stopped.</li><li><code>STOPPED</code> - The service resource is stopped.</li><li><code>STARTING</code> - The service resource is being started.</li><li><code>DISABLING</code> - The service resource is being disabled.</li><li><code>DISABLED</code> - The service resource is disabled.</li><li><code>TERMINATED</code> - The service resource is deleted.</li></ul>"
},
"shapeId":{
"type":"string",
"description":"Compute shape of this node."
},
"totalStorage":{
"type":"integer",
"description":"Total megabytes of block storage used by this host."
},
"creationDate":{
"type":"string",
"description":"Time and date the host was created."
},
"componentType":{
"type":"string",
"description":"Type of component. For example: <code>WLS</code>"
},
"isAdminNode":{
"type":"boolean",
"description":"<code>true</code> if this VM instance (node) contains an administration server, <code>false</code> otherwise."
},
"vmStateDisplayName":{
"type":"string",
"description":"State of the host."
}
}
}