2 エンティティ

次の各項では、RESTリソースが動作するデータ・モデルについて説明します。これらのデータ・モデルは、RESTリソースでやりとりされる情報を記述したものです。

この項でのこれらのデータ・モデルの説明には、各データ・フィールドに適用される制約の説明が含まれます。

データ・フィールドの制約

コンフィデンシャル: この値が暗号化され、GETメソッドによって返されないことを指定します。更新するために、POSTで指定することは可能です。
不変: このフィールドの内容は、作成中に1回書込み可能であり、その後は変更できません。
Null以外: このフィールドに値を指定する必要があることを指定します。
読取り専用: この値は、GETによって読取り可能ですが、POST中は無視されることを指定します。

AssociatePartitions

AssociatePartitionsエンティティには、相互に関連付ける2つのパーティションの名前および任意のプロパティが含まれます。

AssociatePartitionsエンティティのプロパティは、次のとおりです。

partition1Name

関連付ける一方のパーティションの名前。

タイプ: string

partition1RuntimeName

関連付ける一方のパーティションのランタイム名。

タイプ: string

partition2Name

関連付ける他方のパーティションの名前。

タイプ: string

partition2RuntimeName

関連付ける他方のパーティションのランタイム名。

タイプ: string

properties

任意のプロパティ。jdbcSystemResourceプロパティおよびjdbcSystemResourceOverrideプロパティが含まれる場合があります。

タイプ: 配列

Deprovision

Deprovisionエンティティは、テナント・リソース(パーティション)、PDBおよびサービスの論理コンテナを表します。

Deprovisionエンティティのプロパティは、次のとおりです。

orchestration

オーケストレーションから環境を作成します。

タイプ: オーケストレーション

制約: 不変

DissociatePartitions

DissociatePartitionsエンティティには、関連付けを解除する2つのパーティションの名前および任意のプロパティが含まれます。

DissociatePartitionsエンティティのプロパティは、次のとおりです。

partition1Name

関連付けを解除する一方のパーティションの名前。

タイプ: string

partition1RuntimeName

関連付けを解除する一方のパーティションのランタイム名。

タイプ: string

partition2Name

関連付けを解除する他方のパーティションの名前。

タイプ: string

partition2RuntimeName

関連付けを解除する他方のパーティションのランタイム名。

タイプ: string

properties

任意のプロパティ。jdbcSystemResourceプロパティおよびjdbcSystemResourceOverrideプロパティが含まれる場合があります。

タイプ: 配列

Environment

Environmentエンティティには環境名が含まれ、テナント・リソース(パーティション)、PDBおよびサービスの論理コンテナを表します。

Environmentエンティティのプロパティは、次のとおりです。

name

環境の名前

タイプ: string

制約: 不変

orchestration

オーケストレーションから環境を作成します。

タイプ: オーケストレーション

制約: 不変

EnvironmentPartition

EnvironmentPartitionエンティティには、名前およびランタイム名が含まれ、環境に追加された論理パーティションを表します。

EnvironmentPartitionエンティティのプロパティは、次のとおりです。

name

パーティションの名前。

タイプ: string

制約: 不変

runtimeName

パーティションが存在するランタイムの名前。

タイプ: string

制約: 不変

MigratePartition

MigratePartitionエンティティには、ランタイム名、フェーズおよび任意のプロパティが含まれます。

MigratePartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

制約: 不変

runtimeName

パーティションが存在するランタイムの名前。

タイプ: string

制約: 不変

Orchestration

Orchestrationエンティティには、環境を作成するための名前および引数が含まれます。

Orchestrationエンティティのプロパティは、次のとおりです。

args

任意のプロパティ。ランタイムへの接続に必要なユーザー名およびパスワードが含まれる場合があります。

タイプ: 配列

name

環境の名前

タイプ: string

制約: 不変

PDB

PDBエンティティには、名前、ID、ステータスおよび作成日が含まれます。

PDBエンティティのプロパティは、次のとおりです。

creationDate

PDBの作成日。

タイプ: string

制約: 読取り専用

id

PDBのID。

タイプ: string

制約: 不変

name

PDBの名前。

タイプ: string

制約: 不変

status

PDBのステータス。(未使用。将来使用するために予約済)

タイプ: string

制約: 不変

Property

Propertyエンティティは名前付きプロパティを保持し、値には、文字列、機密文字列またはプロパティのリストを指定できます。

Propertyエンティティのプロパティは、次のとおりです。

confidentialValue

プロパティの機密文字列値。

タイプ: string

properties

プロパティのプロパティ値。

タイプ: 配列

制約: 不変

values

プロパティの文字列値。

タイプ: 配列

QuiescePartition

QuiescePartitionエンティティには、静止処理の任意のプロパティが含まれます。

QuiescePartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

QuiesceRuntime

QuiesceRuntimeエンティティには、静止処理のフェーズおよび任意のプロパティが含まれます。

QuiesceRuntimeエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

RegisterPlugin

RegisterPluginエンティティには、サーバー・ファイル・システムにおけるJavaアーカイブの名前および相対パスが含まれます。

RegisterPluginエンティティのプロパティは、次のとおりです。

name

プラグインの名前。

タイプ: string

制約: 不変

path

プラグインが含まれるjarファイルの、サーバーに対して相対的なパス名。

タイプ: string

RestartPartition

RestartPartitionエンティティには、パーティションを再起動するための任意のプロパティが含まれます。

RestartPartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

Runtime

Runtimeエンティティには、物理ランタイムの名前、タイプ、ホストおよびポートが含まれます。また、任意のプロパティを含めることもできます。

Runtimeエンティティのプロパティは、次のとおりです。

hostName

ランタイムのホスト名。

タイプ: string

制約: 不変

name

ランタイムの名前。

タイプ: string

制約: 不変

port

ランタイムのポート。

タイプ: string

制約: 不変

properties

任意のプロパティ。ランタイムへの接続に必要なユーザー名およびパスワードが含まれる場合があります。

タイプ: 配列

制約: 不変

protocol

ランタイムのプロトコル。

タイプ: string

制約: 不変

type

ランタイムのタイプ。

タイプ: string

制約: 不変

RuntimePartition

RuntimePartitionsエンティティには、物理ランタイムのパーティションの名前およびIDが含まれます。また、任意のプロパティを含めることもできます。

RuntimePartitionエンティティのプロパティは、次のとおりです。

id

パーティションのID。

タイプ: string

制約: 読取り専用

name

パーティションの名前。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

type

パーティションのタイプ。(未使用。将来使用するために予約済)

タイプ: string

制約: 読取り専用

ScaleRuntime

ScaleRuntimeエンティティには、スケール変更処理の係数および任意のプロパティが含まれます。

ScaleRuntimeエンティティのプロパティは、次のとおりです。

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

scaleFactor

スケール係数の数値。

タイプ: string

制約: 不変

Service

Serviceエンティティには、環境の名前、タイプおよび環境への参照が含まれます。

Serviceエンティティのプロパティは、次のとおりです。

environmentRef

サービスの環境名。

タイプ: string

制約: 不変

identityDomain

サービスのアイデンティティ・ドメイン。

タイプ: string

制約: 不変

name

サービスの名前。

タイプ: string

制約: 不変

topLevelDir

サービスの最上位レベルのディレクトリ。

タイプ: string

twoTask

サービスの2つのタスク。

タイプ: string

type

サービスのタイプ。

タイプ: string

制約: 不変

uuid

サービスの汎用一意識別子。

タイプ: string

制約: 不変

StartPartition

StartPartitionエンティティには、処理を開始するための任意のプロパティが含まれます。

StartPartitionエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

StartRuntime

StartRuntimeエンティティには、起動処理のフェーズおよび任意のプロパティが含まれます。

StartRuntimeエンティティのプロパティは、次のとおりです。

phase

フェーズ。

タイプ: string

制約: 不変

properties

プラグインに渡された任意のプロパティ。

タイプ: 配列

Task

Taskエンティティには、タスクのステータスが含まれます。

Taskエンティティのプロパティは、次のとおりです。

error

タスク・エラー(ある場合)。

タイプ: string

制約: 読取り専用

progress

タスクの進捗。

タイプ: string

制約: 読取り専用

status

タスク・ステータス。

タイプ: string

制約: 読取り専用

Tenant

Tenantエンティティには、テナントの最上位レベルのディレクトリ、IDおよび名前が含まれます。

Tenantエンティティのプロパティは、次のとおりです。

id

テナントのID。

タイプ: string

制約: 不変

name

テナントの名前。

タイプ: string

制約: 不変

topLevelDir

テナントのパーティションにおける最上位レベルのディレクトリ。

タイプ: string

uuid

テナントの汎用一意識別子。

タイプ: string

制約: 不変

Version

Versionエンティティでは、ライフサイクル・リソースのバージョンが記述されます。

Versionエンティティのプロパティは、次のとおりです。

isLatest

これがデフォルト・バージョンの場合True。

タイプ: ブール

制約: 読取り専用

lifecycle

タイプ: string

state

このバージョンのライフサイクル: activeまたはdeprecated

タイプ: string

制約: 読取り専用

version

このバージョンの名前。

タイプ: string

制約: 読取り専用