このマニュアルに記載されている仕様および製品に関する情報は、予告なしに変更されることがあります。このマニュアルに記載されている表現、情報、および推奨事項は、すべて正確であると考えていますが、明示的であれ黙示的であれ、一切の保証の責任を負わないものとします。このマニュアルに記載されている製品の使用は、すべてユーザー側の責任となります。
対象製品のソフトウェア ライセンスと限定保証は、製品に添付された『Information Packet』に記載されています。添付されていない場合には、代理店にご連絡ください。
Cisco が採用している TCP ヘッダー圧縮機能は、UNIX オペレーティング システムの UCB(University of California, Berkeley)のパブリック ドメイン バージョンとして、UCB が開発したプログラムを採用したものです。All rights reserved. Copyright © 1981, Regents of the University of California.
ここに記載されている他のいかなる保証にもよらず、各社のすべてのマニュアルおよびソフトウェアは、障害も含めて「現状のまま」として提供されます。シスコおよび上記代理店は、商品性、特定目的適合、および非侵害の保証、もしくは取り引き、使用、または商慣行から発生する保証を含み、これらに限定することなく、明示または暗黙のすべての保証を放棄します。
いかなる場合においても、シスコおよびその供給者は、このマニュアルの使用または使用できないことによって発生する利益の損失やデータの損傷をはじめとする、間接的、派生的、偶発的、あるいは特殊な損害について、あらゆる可能性がシスコまたはその供給者に知らされていても、それらに対する責任を一切負わないものとします。
このマニュアルで使用している IP アドレスおよび電話番号は、実際のアドレスおよび電話番号を示すものではありません。マニュアルの中の例、コマンド出力、ネットワーク トポロジ図、およびその他の図は、説明のみを目的として使用されています。説明の中に実際の IP アドレスおよび電話番号が使用されていたとしても、それは意図的なものではなく、偶然の一致によるものです。
この文書の印刷されたハード コピーおよび複製されたソフト コピーは、すべて管理対象外と見なされます。最新版については、現在のオンライン バージョンを参照してください。
シスコは世界各国 200 箇所にオフィスを開設しています。各オフィスの住所、電話番号、FAX 番号は当社の Web サイト(www.cisco.com/go/offices)をご覧ください。
Cisco および Cisco のロゴは、米国およびその他の国における Cisco およびその関係会社の登録商標を示します。シスコの商標の一覧については、https://www.cisco.com/c/en/us/about/legal/trademarks.html をご覧ください。記載されているサードパーティの商標は、それぞれの所有者に帰属します。「パートナー」という言葉が使用されていても、シスコと他社の間にパートナーシップ関係が存在することを意味するものではありません。(1721R)
© 2018-2023 Cisco Systems, Inc. All rights reserved.
API ガイドの新しい各リビジョンには、次の変更が含まれています。API がメジャー リリース間で大幅に変更された場合、または API ガイドの重大なエラーを修正する場合は、メジャー リリースごとに API ガイドの新しいリビジョンを投稿します。
このガイドは、Workload Optimization Manager ソフトウェアとの対話をスクリプト化し、Workload Optimization Manager と他のソフトウェアアプリケーションとの統合を開発するときに、Workload Optimization ManagerEST API を使用するのに役立ちます。
REST API は、HTTP の GET、POST、PUSH、および DELETE メソッドを介して、Workload Optimization Manager のデータと処理をリモートアクセスに公開します。
Workload Optimization Manager のユーザーインターフェースはこの API のクライアントであり、ユーザー インターフェースで公開されるすべての機能は API 呼び出しの結果です。API を理解するには、Workload Optimization Manager のユーザーインターフェイス、公開している機能、使用するデータ、サポートするユースケースに関する実用的な知識が必要です。ほとんどの場合、Workload Optimization Manager の動作の一部をスクリプト化する場合は、その動作の大部分をユーザーインターフェイス経由で実行できるはずです。そのコンテキストでこれらのユースケースをステップ実行すると、スクリプトの計画と実装に役立ちます。
REST API を最大限に活用するには、Workload Optimization Manager がその基礎となるデータを編成する方法と、さまざまな REST リソースがその組織にどのようにマッピングされるかを理解する必要があります。この導入セクションには、以下の基礎となるデータの説明が含まれています。
■ マーケットとそれらが環境を表す方法(19 ページの「マーケット」を参照)
■ プランとその使用方法の概要(21 ページの「プラン」を参照)
■ ワークロード配置ポリシーとその表現方法(23 ページの「ワークロード配置ポリシー」を参照)
■ 展開の予約とその設定方法(24 ページの「予約」を参照)
注:
このガイドは、REST API で考えられるすべての設定とデータペイロードに関する包括的なリファレンスではありません。多くのエンドポイントの説明には、API データオブジェクトのサンプルが含まれていますが、入力のすべての可能な組み合わせを説明することはできません。API の完全なリファレンスについては、このガイドと『Workload Optimization ManagerEST Swagger-UI』ドキュメントを併せて使用してください。詳細については、18 ページの「Workload Optimization ManagerEST API Swagger ドキュメント」を参照してください。
API で結果を確認する最も簡単な方法は、Swagger UI で呼び出しを試すことです。Swagger UI を使用するには、次の場所に移動します。
https://<Your_Workload Optimization Manager_IP>/swagger/external/index.html
Swagger UI を使用して、さまざまなエンドポイントに移動し、それらのメソッドを試すことができます。たとえば、ユーザーエンドポイントに移動すると、Workload Optimization Manager のインストールで指定されているすべてのユーザーのリストを取得できます。詳細については、18 ページの「Workload Optimization ManagerEST API Swagger ドキュメント」を参照してください。
最終的には、API を使用してデータを取得したり、アクションを実行したり、Workload Optimization Manager を他のプロセスと統合したりするスクリプトを実装することになります。API を使用するときは、次のことを知っておく必要があります。
■ 認証
■ URI の構造
■ 応答形式
■ Workload Optimization Manager API での時間
認証
API を使用するには、Workload Optimization Manager インスタンスに有効なユーザーアカウントが必要です。また、アカウントはさまざまな役割を持つ場合があることに注意してください。API は、ユーザーロールに有効なコマンドのみを実行します。たとえば、Workload Optimization Manager の推奨アクションを実行するには、アカウントに管理者、デプロイヤー、またはオートメータのロールが必要です。
API 呼び出しを行うには、認証トークンをリクエストし、呼び出しごとにそれを Workload Optimization Manager API に渡します。トークンリクエストは、認証用の Cookie を返します。このトークンを使用する一般的な方法は、Cookie をローカルに保存し、API 呼び出しで渡すことです。
例:curl -s -k -c /tmp/cookies -H 'accept: application/json' 'https://localhost/api/ v3/login?hateoas=true' -d 'username=administrator&password=password'
それから、ログインリクエストによって配信されるセッション Cookie を使用するために、各リクエストで -b cookie-filename パラメータを使用する必要があります。
もう 1 つのアプローチは、認証ヘッダーを取得して認証 Cookie を解析することです。それから、Cookie を含む各 API リクエストのヘッダーを作成できます。たとえば、token という名前の変数に値を格納するとします。次のように使用できます。
headers = {'cookie': token}
r = requests.get('https://10.10.123.456/api/v3/targets/specs', headers=headers, verify=False, stream=True)
注:より完全な説明については、API クックブックの 287 ページ、「認証レシピ」を参照してください。
URI の構造
Workload Optimization ManagerEST API を使用する際、クライアントが特定の REST リソースに対して HTTP リクエストを行います。Workload Optimization ManagerEST API は、以下の標準 HTTP メソッドをサポートします:
■ GET
エンティティまたはデータ オブジェクトのリストを取得し、個々のアイテムを取得します。
■ POST
Workload Optimization Manager 環境で新しいオブジェクトを作成するか、特定のクエリのフィルタを指定します。
■ PUT
既存のエンティティまたはオブジェクトを段階的に変更します。
■ DELETE
エンティティまたはオブジェクトを削除します。
Workload Optimization ManagerEST API リソースの基本的な URI 構造は次のとおりです:
https://<Your_Workload Optimization Manager_IP>/api/<API_version>/<resource_name>
たとえば、インストール内のユーザーを一覧表示する場合、次のようになります:
https://111.222.33.44/api/v3/users
応答形式
Workload Optimization ManagerEST API は、データを JSON オブジェクトとして返します。Workload Optimization Manager は、これらのオブジェクトをデータ転送オブジェクトまたは DTO と呼びます。DTO は、要求したデータを記述するキーと値のペアの配列で
す、つまりPOST または PUT の実行結果であるデータです。たとえば、Workload Optimization Manager のインストール用に定義されたユーザーに対して GET を実行すると、API は次のような DTO を返します。
[
{
Links
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/users/_4T_7kwY-Ed-WUKbEYSVIDw"
}
],
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw",
"displayName": "Administrator User",
"username": "administrator",
"roleUuid": "_4UAioQY-Ed-WUKbEYSVIDw",
"roleName": "administrator",
"loginProvider": "Local",
"type": "DedicatedCustomer",
"showSharedUserSC": false
}
]
この場合、DTO は 1 つのオブジェクトの配列です。つまり、この Workload Optimization Manager のインストールに対して定義されているユーザーアカウントは 1 つだけです。ユーザーオブジェクトは、このユーザーアカウントへの URL を提供するリンク 配列で始まります。その後、特定のユーザーアカウントを説明するプロパティが続きます。
ほとんどの場合、PUT または POST を実行するには、パラメータを渡し、DTO を介してオブジェクトを作成することに注意してください。これらの DTO は、関連する応答 DTO に似ていますが、同一ではありません。このユーザーアカウントの例では、応答 DTO にはユーザーアカウントのパスワードが含まれていませんが、アカウントを作成するための DTO にはパスワードが含まれている必要があります。
Swagger UI でさまざまな REST メソッドを試して、典型的な応答 DTO を確認できます。
Workload Optimization Manager API での時間
Workload Optimization ManagerEST API には、情報を作成またはフィルタリングするために開始時刻または終了時刻、あるいはその両方を必要とするリクエストが含まれています。時間は、次の 3 つの異なる形式で入力できます。
■ ISO 8601 の日付と時刻の形式
YYYY-MM-DDTHH:MM:SS. たとえば、2018-10-07T12:38:17
■ エポック時間
エポック時間は、1970 年 1 月 1 日の午前 0 時からの経過秒数として表されます。たとえば、1514764800 は 2018 年 1 月 1 日午前 12:00:00 UTC に対応します。
■ 相対時間
相対時間とは、呼び出しの実行時点を基準とした相対時間のことです。たとえば、開始時刻が -1w で終了時刻が -1d の場合、結果には、呼び出しが実行される 1 週間前から呼び出しが実行される前日までのエントリが含まれる必要があることを示します。相対時間の単位では大文字と小文字が区別されます。Workload Optimization Manager は、次の想定時間をサポートしています。
– m — 分
– h — 時間
– d — 日
– w — 週
– M — 月
– y — 年
Workload Optimization Manager API のページネーション
一部の API 呼び出しは、非常に大きなデータセットを返します。Workload Optimization Manager は、常にページネーション機能を使用することを推奨しています。これは、Workload Optimization Manager によって管理される大規模な環境では特に重要です。個々のリクエストの範囲とフィルタを介して、データを事前にフィルタすることができます。limit および x-next-cursor パラメータを使用すると、データを扱いやすいチャンクで返すことができます。
次に例を示します。
https://10.10.10.10/api/v3/markets/214075923753936/entities/stats?limit=5&ascending=true
上記のリクエストは、特定のマーケットのすべてのエンティティの統計を取得することです。limit=5 は、返されるデータの各ページに 5 つの結果が必要であることを示します。
返されたデータのヘッダーには、x-next-cursor:5 が含まれます。結果の次のページを取得するには、次のリクエストでカーソルを使用します。
https://10.10.10.10/api/v3/markets/214075923753936/entities/stats? cursor=5&limit=5&ascending=true
最終ページに到達すると、x-next-cursor は空になります。
リクエストに orderBy、limit、または cursor パラメータが含まれている場合、これらのパラメータのいずれかを使用すると、ページ分割された結果が返されます。
Swagger のドキュメントでさまざまな REST メソッドを試して、一般的な応答 DTO を確認できます。Workload Optimization Manager Swagger のドキュメントにアクセスするには、次の場所に移動します。
https://<Your_Workload Optimization Manager_IP>/swagger/external/index.html
このドキュメントでは、API のさまざまなエンドポイントのすべてのメソッドに関するドキュメントを提供する標準の Swagger-UI アプリケーションを使用します。このドキュメントには、呼び出しの説明、渡すパラメータのリスト、POST または PUSH する JSON ペイロードの説明、および応答で取得するペイロードが含まれています。JSON ペイロードの MODEL を表示すると、JSON 構造をナビゲートして、さまざまなオブジェクト フィールドの説明を表示できます。
API にアクセスするには、Swagger-UI で認証が必要です。Workload Optimization Manager にすでにログインしている場合は、ブラウザー セッションに現在の認証 Cookie があるはずです。Swagger-UI は、API 認証にこれと同じ Cookie を使用します。
各メソッドについて、Swagger ドキュメントには、Swagger-UI を介して呼び出しを設定して実行できる「試してみる」機能が含まれています。これにより、応答として次の情報が生成されます。
■ 呼び出しのための curl リクエスト
Swagger によって生成された curl コマンドは、お使いの環境で使用するためにいくつかの変更が必要になる場合があります(たとえば、引用符をエスケープしたり、HTTP URL を使用するために -k 修飾子を追加したりします)。
■ 呼び出しの標準 HTTP リクエスト
■ サーバーの応答コード
■ 応答本体 – API 呼び出しが返す JSON データ
■ 応答ヘッダー
注:SwaggerUI を使用して API 呼び出しを試行し、API 呼び出しがエラーを返した場合(たとえば、呼び出しで間違った構文が使用されている場合)、状況によっては SwaggerUI にエラーが表示されず、返されたデータのフィールドが空になります。
Workload Optimization Manager は、マーケットベースの分析を使用してワークロード管理を実行します。これを行うには、環境のモデルを構築し、各エンティティをマーケットの買い手と売り手として表します。このモデルには、名前付きのマーケットリソースを介してアクセスできます。
いつでも、Workload Optimization Manager アプライアンスは、メモリ内に多くのマーケットを持つことができます。アプライアンスの現在のマーケットのリストを取得するには、次の URL を実行します。
GET: /rest/markets
このリストは、メインのリアルタイムマーケットに加えて、呼び出し時にメモリ内にあるすべてのプランのマーケットを返します。グループ UUID を渡して、呼び出しの範囲を設定できることに注意してください。その場合、呼び出しは、渡されたグループを範囲に含むプランのマーケットのみを返します。
リアルタイムマーケットは、環境の分析とワークロード管理を実行します。リアルタイムマーケットを使用してエンティティにアクセスし、エンティティに関する現在または過去のデータを取得できます。
リアルタイムマーケットの displayName は Market です。このマーケットは常に RUNNING 状態でなければなりません。いかなる状況においても、API を使用してこのマーケットを停止しないでください。
Workload Optimization Manager は、ディスカバリーを実行して、管理するトポロジ(リアルタイムマーケットのエンティティのコレクション)にデータを取り込みます。このため、リアルタイムマーケットからエンティティを削除したり、リアルタイムマーケットにエンティティを追加したりしないように注意する必要があります。
リアルタイムマーケットでは、以下のような POST、PUT、および DELETE 呼び出しを安全に実行できます:
■ クエリーフィルタを投稿して、リアルタイムマーケットのアクション、通知、統計のフィルタ済みリストを取得
■ リアルタイムマーケットでの配置ポリシーを作成するための投稿
■ 削除して、リアルタイムマーケットから配置ポリシーを削除
■ リアルタイムマーケットの配置ポリシーを編集
■ リアルタイムマーケットにシナリオを投稿してプランを実行
リアルタイムマーケットに対してプランのシナリオを実行する場合、Workload Optimization Manager はリアルタイムマーケットのコピーを作成し、コピーをプランのシナリオに従って変更します。
注:
POST または DELETE メソッドを実行して、リアルタイムマーケットのトポロジを変更することができます。ただし、このことが必要となる可能性はほとんどありません。リアルタイムマーケットの変化は、Workload Optimization Manager が実行する分析に影響を与えることに注意してください。たとえば、リアルタイムマーケットから VM を削除すると、Workload Optimization Manager はその配置を管理できなくなります。VM は引き続き環境に存在しますが、Workload Optimization Manager によって管理されなくなります。ただし、この手法を使用して、特定のエンティティを Workload Optimization Manager で使用できないようにすることはできません。次の検出パスでは、Workload Optimization Manager は削除されたエンティティを再検出するので、リアルタイムマーケットに再び表示されます。
Workload Optimization Manager は、メモリー内のリアルタイムマーケット以外のマーケットを持つことができます。これらの他のマーケットはプランを表しています。
プランマーケットは、リアルタイムマーケットのスナップショットとして始まります。シナリオをリアルタイムマーケットに POST すると、Workload Optimization Manager は次の 2 つのことを行います:
■ リアルタイムマーケットのコピーを作成し、プランマーケットを作成します。このプランマーケットは、シナリオで宣言された変更を除いて、リアルタイムマーケットと同じです。たとえば、シナリオでプランの範囲が宣言されている場合、プランマーケットにはその範囲内のエンティティのみが含まれます。
■ これ以上意味のある改善が行われなくなるまで、このプランマーケットに対して経済サイクル(売買サイクル)を実行します。その時点で、計画の実行が完了します。
Workload Optimization Manager がプランマーケットを作成すると、そのマーケットは削除するまでメモリに残ることに注意してください。また、後でシナリオをプランマーケットに適用できることにも注意してください。これは、計画に基づいてプランを実行する方法です。ロジックフローは同じで、Workload Optimization Manager は、分析を実行するためにさらに別のプランマーケットを作成します。
社内利用プラン
Workload Optimization Manager は、GUI に表示するデータを生成する計画を定期的に実行します。クラスタキャパシティダッシュボードとプロジェクトクラスタリソースダッシュボードの両方に、定期的に実行されるプランによって生成されたデータが表示されます。
内部使用のプランマーケットでは、displayName にサブストリング _BasePlan が含まれます。いかなる理由があっても、これらのプランマーケットを変更しないでください。
ユーザー作成プラン
ユーザーは、環境内で what-if シナリオを実行する計画を作成でき、結果はプランマーケットとして保存されます。いつでも、各ユーザーアカウントは、複数のプランマーケットを Workload Optimization Manager インスタンスにロードできます。
プランマーケットは名前で識別します。プラン名には <PlanType><userName>_<arbitraryID> を付けて指定します。
有効なプラン名は、たとえば CLOUD_MIGRATION_cud_1493140514716 のようになります。このプランを所有しているユーザーを調べるには、ユーザーの名前を解析し、そのユーザーのアカウント情報を API に照会します。
プランマーケットを取得すると、応答には次のような情報が含まれます。
■ uuid:マーケットの識別子。
■ state:プラン計画が成功したかどうか。state としては、次のいずれかがあり得ます。
– CREATED
– READY_TO_START
– 実行中
– COPYING
– SUCCEEDED
– 停止中
– 停止済み
– USER_STOPPED
– 削除中
プランマーケットが実行中の間は、Workload Optimization Manager はまだプランの結果を計算しています。マーケットが停止したら、プランは実行済みで、このマーケットのデータにアクセスしてプランの結果を確認できます。実行中のプランを停止するために、マーケットに PUT 呼び出しを行うことができます。
プランマーケットの場合、リアルタイムマーケットで実行するのと同じ POST、PUT、および DELETE メソッドを実行できます。これには、以下が含まれます。
■ POST でクエリーフィルタを投稿して、プランマーケットのアクション、通知、および統計のフィルタ済みリストを取得
■ POST でプランマーケットでの配置ポリシーを作成
■ DELETE でプランマーケットから配置ポリシーを削除
■ PUT でプランマーケットでの配置ポリシーを編集
■ POST でプランマーケットにシナリオを投稿し、計画通りにプランを実行
プランマーケットでは、次のメソッドも安全に実行することができます。
■ DELETE でプランマーケットを削除
■ PUT でプランマーケット保存または停止
注:
GUI または API を介してプランマーケットを停止することができます。また、計算が完了する前にプランを停止することもできます。この場合、プランの結果は不完全になります。
プランとは、環境に加えられる可能性のある変更の結果を調査するシミュレーションまたは仮定のシナリオです。プランを実行するために、Workload Optimization Manager はリアルタイムマーケットのスナップショットコピーを作成し、そのスナップショットに変更を加えます。次に、経済スケジューリングエンジンを使用して、計画市場について分析を実行します。
API でプランを操作するには、GUI を介したプランに精通している必要があります。達成できるプランと、次のようなプランの設定を指定する方法を知っている必要があります。
■ プラン範囲
■ 環境内のワークロードの変更(VM の追加または削除)
■ 供給に関する変更(ハードウェアの追加、削除、または再構成)
■ 配置に関する変更(クラウドまたは別のクラスタへの移行)
■ 制約の変更
プランを作成するには、最初にプランのシナリオを指定します。これは、すべてのプラン設定を含むオブジェクトです。シナリオオブジェクトには一連の変更が含まれており、変更ごとに必要な設定が宣言されます。
シナリオを作成したら、それをマーケットにポストします。ほとんどの場合は、リアルタイムマーケットにポストします。シナリオをマーケットにポストすると、Workload Optimization Manager は次の 2 つのことを行います。
■ マーケットのコピーを作成し、プランマーケットを作成します。このプランマーケットは、シナリオで宣言された変更を除いて、元のマーケットと同じです。たとえば、シナリオでプランの範囲が宣言されている場合、プランマーケットにはその範囲内のエンティティのみが含まれます。
■ これ以上意味のある改善が行われなくなるまで、このプランマーケットに対して経済サイクル(売買サイクル)を実行します。この時点で、プランの実行が完了します。
プランマーケットの保存と削除
プランを実行すると、Workload Optimization Manager によって分析が実行され、結果が表示されます。また、ユーザーが後で結果を GUI にロードできるように、プランの結果をシリアル化して保存します。
注:
Workload Optimization Manager を更新すると、保存された計画結果のデータ形式が変更される場合があります。その場合、結果に矛盾点が生じます。Workload Optimization Manager を更新するたびに、保存するすべてのプランを再生成し、再度保存する必要があります。
API 経由でプランを削除するには、プランマーケットで DELETE メソッドを実行するだけです。
シナリオの作成
プランの最初のステップは、シナリオを作成することです。シナリオはプランとは完全に別のものであることに注意してください。シナリオを作成し、それをマーケットに POST してプランを作成します。ただし、シナリオはまだメモリに存在するので、必要に応じて別のマーケットに適用できます。たとえば、同じシナリオをさまざまな時間にリアルタイムマーケットに適用できます。
シナリオを作成するには、POST: /rest/scenarios/{name} メソッドを使用します。このメソッドは、次の 3 つのパラメータを取ります。
■ scope
グループ UUID の配列。複数のグループの範囲の場合、同じタイプのグループを指定する必要があります。
■ projection_days
予測シナリオの場合の、各予測期間をマークする日
■ input
シナリオのすべての設定を指定できる ScenarioApiInputDTO。
入力 パラメータである ScenarioApiInputDTO は、シナリオ設定を指定するために API に POST できるオブジェクトです。API には、シナリオを作成および削除するメソッドが含まれています。ほとんどの場合、必要なシナリオ設定を宣言するために変更を加えて ScenarioApiInputDTO を POST または PUT することによって、シナリオを作成します。API には、プロパティを URL で直接渡すことによって、これらの設定の多くを特定のシナリオに PUT するために使用できるメソッドが含まれていることに注意してください。ただし、これらの設定を ScenarioApiInputDTO で行うこともできます。この DTO の使用方法を学ぶことは、シナリオを作成および変更するための最も一貫した方法です。
シナリオを作成するときには、シナリオのすべての設定を ScenarioApiInputDTO に POST することができます。または、部分的なシナリオを作成してから、別の時点でシナリオに他の変更を PUT することもできます。
予測シナリオの作成
予測プランでは、将来のインフラストラクチャ要件を計算するため、環境は時間の経過に伴うワークロード要件の変化に対応できます。1 つの計画で、計画の範囲、将来のどの程度まで予測するか、およびどの時間単位で行うかを指定できます。たとえば、特定のデータセンターの 1 年先の要件を予測し、1 か月間隔で要件がどのように変化するかを示すことができます。
API を介して予測シナリオを作成するときは、今日から予測する日数の配列として予測期間を指定します。たとえば、今日は 0、今日から 30 日は 30、今日から 60 日は 60 などです。
予測プランのシナリオを作成するには:
■ シナリオの範囲を設定する
予測プランには、シナリオの範囲が必要です。
■ PROJECTION_PERIODS タイプの計画に変更を作成する
この変更により、必要な計画期間が日の配列として識別されます。
{
"changes":[
{
"type”:"PROJECTION_PERIODS",
"projectionDays":[0,30,60,90]
}
]
}
■ 特定の予測期間に繰り返す計画の変更については、その変更のprojectionDays 配列を指定します。この配列の項目は、PROJECTION_PERIODS の変更に指定したprojectionDaysと一致する必要があることに注意してください。
たとえば、最初の予測で "projectionDays":[0,30,60,90] を指定したとします。
– 有効:"projectionDays":[0,30,60,90]
– 有効:"projectionDays":[30,90]
– 無効:"projectionDays":[0,35,70,90]
このリストは、プランマーケットを対象とするプランシナリオを示しており、4 つの期間の予測を設定し、4 つの予測期間のうち 2 つの予測期間に 1 つの VM をインベントリに追加します。
{
"displayName":"My Projection", "changes": [
{
"type": "SCOPE",
"scope": [
{
"uuid": "5678a46e9716657be88b5e1217df91436e13e4ff", "className": "Group",
"entitiesCount": 2, "groupType": "VirtualMachine",
}
]
},
{
"type": "PROJECTION_PERIODS",
"projectionDays": [
0,
30,
60,
90
]
},
{
"type": "ADDED",
"targets": [
{
"uuid": "564d89f4-190b-de1b-cb28-3e2f2126ab48"
}
],
"value": "1", "projectionDays": [
30
]
}
]
}
プランの配置ポリシー
検出された配置ポリシーは有効または無効にすることができます。これは、異なる制約のセットがある場合に環境がどのように変化するかを確認するのに役立ちます。配置ポリシーはマーケットのコンテキストに存在することに注意してください。配置ポリシーを取得するには、それを含むマーケットにクエリーを実行します。プランの配置ポリシーを作成するには、ポリシーを作成してプランマーケットに追加します。
プランで配置ポリシーを有効または無効にする場合は、それをシナリオの変更として指定します。配置ポリシーはマーケットに存在するため、プランを実行するマーケットを知り、そのマーケットからポリシーを取得する必要があります。
たとえば、リアルタイムマーケットに対してプランを実行する場合は、次のようにします。
■ 必要なポリシーについてリアルタイムマーケットのクエリーを実施する
■ シナリオ変更オブジェクトでそのポリシーの UUID を指定する
■ シナリオ変更オブジェクト内で、ポリシーの有効化または無効化を指定する
■ シナリオが完成したら、リアルタイムマーケットにシナリオをPOSTする
プランを実行すると、Workload Optimization Manager が新しいプランマーケットを作成することに注意してください。このプランマーケットには配置ポリシーのコピーが含まれ、設定に応じて有効または無効になります。
ワークロード配置ポリシーは、Workload Optimization Manager が環境内のワークロードの配置を計算する方法に影響を与えるようにします。ポリシーは、特定のビジネスルールを適用して配置を制限することができ、境界を削除して、クラスタまたはデータセンターの境界を越えた配置計算を可能にすることができます。
配置ポリシーは、リアルタイムマーケットまたはプランマーケットのいずれかのマーケットのコンテキストに存在します。各マーケットには独自の配置ポリシーがあります。プランマーケットがリアルタイムマーケットの正確なコピーであっても、プランマーケットには独自の配置ポリシーがあり、それぞれに独自の UUID があります。
API を介して配置ポリシーを操作する前に、それらがユーザーインターフェイスでどのように機能するかを理解する必要があります。作成できる配置ポリシーのタイプと、それぞれのマーケット分析への影響を理解する必要があります。
API は次のタイプのポリシーをサポートします。
■ AT_MOST_N:プロバイダーグループの 1 つのメンバーで実行できるのは、最大でここに指定された数のコンシューマーのみです。これは、ポリシー オブジェクトの
キャパシティプロパティです。
■ BIND_TO_GROUP:コンシューマーは、プロバイダー グループのメンバーでのみ実行できます。
■ BIND_TO_COMPLEMENTARY_GROUP:コンシューマーは、プロバイダーグループのメンバーでは実行できません。
■ MUST_RUN_TOGETHER:これらのコンシューマーは、同じプロバイダーエンティティで実行する必要があります。
■ AT_MOST_N_BOUND:指定された数のコンシューマーのみがプロバイダーグループの単一のメンバーで実行でき、かつコンシューマーはプロバイダーグループのメンバーでのみ実行できます。
■ MERGE:指定されたクラスタのクラスタ境界を削除します。
■ BIND_TO_GROUP_AND_LICENSE:ライセンス グループを作成します。
ポリシーを取得すると、返されるオブジェクトには、ポリシーの種類、およびコンシューマー グループとプロバイダー グループが記述されます。ポリシーを作成するときに、完全なデータを提供する必要はありません。以下を提供します:
■ buyUuid:このポリシーのコンシューマーグループ。
■ sellerUuid:このポリシーのプロバイダーグループ。
■ type:ポリシーの種類。
■ policyName:このポリシーの表示名。
■ enabled:マーケットでポリシーを有効にするかどうか。true または false のいずれかです。
■ capacity:AT_MOST_N または AT_MOST_N_BOUND ポリシーの場合、プロバイダーエンティティで許可するコンシューマーの数。
■ mergeType:MERGE ポリシーの場合、マージするクラスタのタイプ。Cluster、StorageCluster、DesktopPools、または DataCenter のいずれかです。
■ mergeUuids:マージするグループ。グループ タイプは ``mergeType と一致する必要があります。たとえば、DON'T PLACE ポリシーを作成するには、次の inputDto をマーケットにポストします。
{
"buyerUuid": "f82dbbc2b3366052f3bc1ac8a68c9c06b0eb182a", "enabled": false,
"policyName": "PolicyFromApi",
"sellerUuid": "4a2f5f132ae690af147ccfd6ea9839e79da3db79", "type": "BIND_TO_COMPLEMENTARY_GROUP"
}
配置ポリシーを編集するには、指定されたポリシーに入力 Dto を PUT します。入力 Dto で必要な変更を指定します。
Workload Optimization Manager には、将来展開する予定の VM 用にリソースを予約する機能が含まれています。Workload Optimization Manager は、これらの VM の最適な配置を計算し、必要なホストとストレージリソースを予約します。
VM を予約するには、VM テンプレートを選択し、配置の制約を指定し、予約するインスタンスの数を設定してから、現在予約するか将来予約するかを指定する必要があります。予約された VM はまだ存在しないので、リアルタイムマーケットには参加しません。VM テンプレートは、予約済み VM ごとに次のようなリソース要件を指定します。
■ 各 VM に割り当てられたコンピューティングリソースとストレージリソース
■ 消費要素。これは、予約された VM が使用する、割り当てられた CPU、メモリ、またはストレージの割合です。
API を使用して予約を操作する前に、予約がユーザーインターフェイスからどのように機能するかを理解する必要があることに注意してください。API を使用すると、次のことを実行できます。
■ 予約一覧を取得する
■ 予約ワークロードの現在の配置を表示する
■ 予約を作成する
■ 現在の予約を取り消す
予約情報を取得する
現在の予約のリストを取得するには、/rest/reservations を実行します。これにより、すべてのアクティブな予約のリストが返されます。必要な予約の UUID がわかっている場合は、それを渡して、その予約だけのデータを取得できます。
各予約オブジェクトには次のものが含まれます。
■ 表示名
■ ステータス。次のいずれかです。
– DEPLOYING — Workload Optimization Managerがワークロードを展開しています
– DEPLOY_SUCCEEDED — ワークロードが正常に展開されました
– IN_PROGRESS — 配置計算が進行中
– PLACEMENT_SUCCEEDED — 新しい予約の場合、環境にはワークロードを配置するのに十分なリソースがあります。予約日を指定した場合、これはアクティブな予約になります
– PLACEMENT_FAILED — 新しく作成された予約の場合、環境にはワークロードを配置するためのリソースがありません。予約日を指定した場合、これは未処理の予約になります
– RETRYING — Workload Optimization Manager は、満たされていない予約のワークロードを配置しようとしています
■ 予約が作成された時間、展開する時間、期限切れになる時間
■ 予約済みワークロードの説明
■ ワークロードを展開するためにコピーされる物理ファイルと、オプションの配置制限を識別する展開プロファイル。
■ 予約によって確保されるコンピューティングリソースとストレージリソースの統計、たとえば、次のリストは、1 つの VM の予約を示しています。
{
"uuid": "_kWZHIDDmEeePgeXuo0RRbw", "displayName": "MyReservation", "count": 1,
"status": "PLACEMENT_SUCCEEDED",
"reserveDateTime": "Thu May 04 16:27:29 UTC 2017",
"expireDateTime": "Thu Aug 31 16:27:29 UTC 2017",
"deployDateTime": "Thu Aug 31 16:27:29 UTC 2017",
"reserveCount": 1, "demandEntities": [
{
"uuid": "_kWgb7TDmEeePgeXuo0RRbw", "displayName": "MyReservation_C0", "className": "VirtualMachine", "template": {
"uuid": "T423f548d-cadc-e525-6df4-1f90724cf696", "displayName": "vsphere-dc3.dev.mycorp.com::TMP-SUSE64", "className": "VirtualMachineProfile"
},
"deploymentProfile": {
"uuid": "_gHJ0ICXxEeePgeXuo0RRbw",
"displayName": "DEP-SUSE64",
"className": "ServiceCatalogItem"
},
"placements": { "computeResources": [
{
"stats": [
{
"name": "numOfCpu", "value": 1
},
{
"name": "cpuSpeed", "value": 2603
},
{
"name": "cpuConsumedFactor", "value": 0.5
},
{
"name": "memorySize", "value": 2097152
},
{
"name": "cpuConsumedFactor", "value": 0.75
},
{
"name": "ioThroughput", "value": 0
},
{
"name": "networkThroughput", "value": 0
}
],
"provider": {
"uuid": "Virtual_ESX_42381da5-12fa-1e82-2f1c-887419380d43", "displayName": "hp-esx21.corp.vmturbo.com",
"className": "PhysicalMachine"
}
}
],
"storageResources": [
{
"stats": [
{
"name": "diskSize", "value": 18432.363
},
{
"name": "diskIops", "value": 0
}
],
"provider": {
"uuid": "10545c15-7687ef26",
"displayName": "QS2:ESXDC3DS1", "className": "Storage"
}
}
]
}
}
]
}
予約の作成
予約を作成するには、次の予約を定義する入力 DTO を POST します。
■ action:The action type:RESERVATION
■ demandName:予約の表示名 — 追加されたワークロードの名前を指定しない場合、これが新しい VM のルート名になります
■ 配置パラメータ:
– constraintIDs:計算された配置に影響を与える配置ポリシーの UUID の配列
– count:配置するワークロードの数
– entityNames:配置された VM の名前の配列 — 配列の長さは count と等しくなければならない
– geographicRedundancy:true の場合、ワークロードを一意のホストに配置。それ以外の場合、Workload Optimization Manager は複数のワークロードを同じホストに配置できる
– templateID:このワークロードを配置するために使用するテンプレートの UUID — テンプレートには、deploymantParameters で指定するデプロイメントプロファイルへの参照が含まれている必要があることに注意
■ expireDateTime:Workload Optimization Manager がその日付までにすべてのワークロードを配置できない場合に予約をキャンセルする時期 — RESERVATION アクションの場合、Workload Optimization Manager はデプロイ時間をこの時間と同じになるように自動的に設定
■ ReserveDateTime:ワークロードの配置を計算して予約を作成する時間 — この時間は、予約を API に POST した時間より前にすることはできない
次のリストは、予約を作成する入力 DTO を示しています。4 つのワークロードを配置し、それぞれに特定の名前を付けます。
{
"action": "RESERVATION",
"demandName": "MyReservation", "expireDateTime": "2017-10-10T12:38:17+00:00",
"parameters": [
{
"deploymentParameters": {
"deploymentProfileID": "_c9CJMDDAEeePgeXuo0RRbw"
},
"placementParameters": { "geographicRedundancy": false, "count": 4,
"entityNames": [ "foo","bar","baz","bonk"
],
"templateID": "_UKsnkJkSEeCHcOXEhzJExA"
}
}
],
"reserveDateTime": "2017-05-04T18:22:12+00:00"
}
非同期配置計算
予約が POST されると、Workload Optimization Manager は、指定したワークロードの配置を計算するためのプランを実行します。予約のサイズによっては、かなりの時間がかかる場合があります。API は配置を非同期に計算します。スクリプトが予約に依存している場合は、次に進む前に予約が完了していることを確認する必要があります。
予約を実行すると、POST への応答に計算が進行中であることが示されます。
{
"uuid": "_0dPrYTDlEeePgeXuo0RRbw", "displayName": "MyReservation", "count": 4,
"status": "IN_PROGRESS",
"reserveDateTime": "Thu May 04 18:22:12 UTC 2017",
"expireDateTime": "Tue Oct 10 12:38:17 UTC 2017"
}
配置結果を調べるには、API が応答で提供する UUID を使用して予約を GET します。
テンプレートの使用
予約を作成するには、ワークロード要件を含むテンプレートを指定します。VM テンプレートは、VM で使用できる次のようなリソースを指定します。
■ VCPU
■ 仮想メモリ
■ ストレージ
■ ネットワークスループット
■ IOPS
■ IO スループット
テンプレートはユーザーが作成できますが、Workload Optimization Manager は、環境内の管理サービスによって作成されたテンプレートも検出することに注意してください。たとえば、ハイパーバイザまたはクラウドサービスプロバイダーは通常、独自のテンプレートを多数管理しており、Workload Optimization Manager はこれらも検出します。検出されたテンプレートは編集しないでください。
テンプレートが検出されたかどうかを確認するには、関心のあるテンプレートを GET して、discovered プロパティを探します。これは true または false になります。
REST API リソースにより、Workload Optimization Manager ソフトウェアへの完全なアクセスが可能になります。これは、Workload Optimization Manager 機能の完全なセットを公開する完全な API です。実際、製品のユーザーインターフェイスは、この API を使用する Workload Optimization Manager クライアントとして実装されています。
REST API リソースは SwaggerUI に記載されていますが、このセクションでは、API のより表現力豊かなリソースの詳細について説明します。
Workload Optimization ManagerEST SwaggerUI にアクセスするには、Web ブラウザを開いて次の操作を行います。
https://<Your_Workload Optimization Manager_IP>/swagger/external/index.html
ユーティリティリクエスト
Workload Optimization Manager API ガイドでは、ユーティリティリクエストはエンドポイント内のリクエストであり、環境に関する情報は返しませんが、他の呼び出しにメリットを提供します。たとえば、
https://10.10.10.10/api/v3/settings/ は、可能なすべての設定マネージャのリストを返すユーティリティリクエストです。この情報を使用してインスタンスの設定を見つけることができますが、/settings/ リクエスト自体はインスタンス固有の情報を提供しません。
Workload Optimization Manager は、しきい値を超えた後に応答するのではなく、運用条件を分析し、環境全体を望ましい状態に維持するためのアクションを常に推奨します。これらのアクションを実行すると(または Workload Optimization Manager に代行させると)、環境ではお客様のパフォーマンスを保証する運用条件を維持しながら、一方でリソースの効率的な使用率によりコストを最小限に抑えることができます。
アクションエンドポイントを使用すると、次のことができます。
■ 環境内のアクションの完全なリストまたはフィルタリングされたリストの取得
■ アクションの許可または拒否
■ 指定されたアクションに関連する統計の取得
■ 指定したアクションに関連する通知の受け取り
ユーティリティリクエストは、関連するリクエストの作成、inputDTO の組み立て、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
指定されたエンティティとアクションの有効な actionMode パラメータの取得
アクションエンドポイントには、指定されたエンティティとアクションタイプの actionMode パラメータの可能な値を示すユーティリティリクエストが含まれています。これらは、さまざまなアクション設定の可能性を設定または理解するために使用できます。
エンティティ/アクションタイプを指定するために、このリクエストは次のパラメータを取ります:
action_type |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加します。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動します。たとえば、ホスト間で VM を移動したり、ディスクアレイ間でデータストアを移動したりします。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。マーケットの状況によっては、分析は中断されたエンティティの再開を推奨することがあります。 これによって、それらを再びマーケット分析に含めます。 ■ ADD PROVIDER: これは START アクションと同等ですが、ストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨しています。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるのに、クラスタ間の移動が許可されていない場合、RECONFIGURE アクションを推奨することがあります。 ■ DELETE: これは SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合に、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合に、特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを削減するサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
entity_type |
■ BUSINESS_UNIT ■ CLOUD_SERVICE ■ コンテナ ■ データベース ■ DATABASE_SERVER ■ DATACENTER |
|
■ DISK_ARRAY ■ PHYSICAL_MACHINE ■ ストレージ ■ VIRTUAL_MACHINE ■ スイッチ ■ VIRTUAL_DATACENTER ■ シャーシ ■ STORAGE_CONTROLLER ■ IO_MODULE;IO モジュール ■ APPLICATION_SERVER ■ VIRTUAL_APPLICATION ■ ネットワーク ■ アプリケーション ■ コンテナ ■ CONTAINER_POD ■ LOGICAL_POOL ■ DPOD ■ VPOD ■ LOAD_BALANCER |
例:GET https://10.10.10.10/api/v3/actions/availablemodes? action_type=PROVISION&entity_type=PhysicalMachine
応答:文字列の配列。各文字列は、指定された組み合わせの有効な actionMode です。この例では、PROVISION アクションとPhysicalMachine エンティティです。空の応答本文は、通常、実用的な理由から、要求されたエンティティにそのタイプのアクションがないことを示します。たとえば、ネットワーク エンティティは MOVE アクションを持つことができません。
[
"RECOMMEND", "DISABLED", "MANUAL", "AUTOMATIC"
]
アクションのエントリポイントのリストの取得
アクションエンドポイントには、他のアクション関連のリクエストのエントリポイントを示すユーティリティリクエストが含まれています。これらは、特定のアクションに関連する UUID と詳細を見つけるために使用できます。
例:GET https://10.10.10.10/api/v3/actions
応答:LinkApiDTO オブジェクトの配列。各オブジェクトには、指定されたマーケット、エンティティ、またはグループのすべてのアクションを取得するための URL が含まれます。
{
"links":[
{
"rel":"Market actions", "href":"https://10.10.10.10/api/v3/markets/{uuid}/actions?ascending=true"
},
{
"rel":"Entity actions",
"href":"https://10.10.10.10/api/v3/entities/{uuid}/actions?ascending=false"
},
{
"rel":"Group actions", "href":"https://10.10.10.10/api/v3/groups/{uuid}/actions?ascending=true"
}
]
}
アクションリクエストは、Workload Optimization Manager アプライアンスでのアクションの受け入れ、拒否、フィルタリング、および調査を処理します。
リクエストの範囲内の 1 つ以上のエンティティがトポロジに存在しなくなった場合、そのようなエンティティの ActionApiDTO には、エンティティに関する最小限の情報が含まれます。
指定されたアクションの取得
指定されたアクション UUID について、作成時刻とターゲット エンティティ情報を含むアクションの詳細を取得します。
例:GET https://10.10.10.10/api/v3/actions/_6QsKkaNWEeiYWYj--U8W5g/details
応答:要求されたアクションの完全な ActionApiDTO:
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/actions/_6QsKkaNWEeiYWYj--U8W5g"
},
{
"rel":"self", "href":"https://10.10.10.10/api/v3/actions/2218532354592"
}
],
"uuid":"_6QsKkaNWEeiYWYj--U8W5g", "createTime":"2018-08-19T07:40:57-04:00",
"actionType":"MOVE", "actionState":"PENDING_ACCEPT", "actionMode":"MANUAL",
"details":"Move VirtualMachine Jboss-EAP-10.203 from dc17-host-01.mycorp.com to dc17-host-02.mycor p.com",
"importance":7.4150376, "target":{
"uuid":"421d8db4-3fc6-440b-0575-11383c020c6c",
"displayName":"Jboss-EAP-10.203", "className":"VirtualMachine", "aspects":{
"virtualMachineAspect":{ "os":"CentOS 4/5/6/7 (64-bit)", "connectedNetworks":[
{
"uuid":"34f9f5364cd843aa1fe99900621ee3b51a7dc6e5",
"displayName":"VM Network"
}
],
"numVCPUs":2, "ebsOptimized":false
}
},
"environmentType":"ONPREM"
},
"currentEntity":{
"uuid":"34313836-3333-5553-4537-33364e385146",
"displayName":"dc17-host-01.mycorp.com", "className":"PhysicalMachine", "environmentType":"ONPREM"
},
"newEntity":{
"uuid":"34313836-3333-5553-4537-33394e43424e",
"displayName":"dc17-host-02.mycorp.com", "className":"PhysicalMachine", "environmentType":"ONPREM"
},
"risk":{
"uuid":"_CizZoKN2EeiYWYj--U8W5g", "subCategory":"Efficiency Improvement",
"description":"dc17-host-01.mycorp.com can be suspended for efficiency", "severity":"MINOR",
"importance":0
}, "actionID":2218532354592
}
アクションのフィルタリングされたリストの取得
範囲 UUID を指定し、次の 1 つ以上の条件を使用して ActionApiInputDTO によってフィルタリングされたアクションのリストを取得します。
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: 指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 ■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するよう Workload Optimization Manager に指示しました。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモード。 |
actionStateList |
■ DISABLED: |
基準 |
説明 |
|
ポリシーが無効になっているアクション。 ■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 ■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: 1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にする。前のアクションが完了すると実行される。 |
actionTypeList |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加する。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動する。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外する。一時停止によってエンティティが環境から削除されることはないが、マーケットはそのエンティティを分析に含めない。マーケットの状況に基づいて、分析は中断されたエンティティの再開を推奨できます。 そしてそれらを再びマーケット分析に含める。 ■ ADD PROVIDER: これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨します。たとえば、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、 |
基準 |
説明 |
|
クラスタ間の移動が許可されていない場合、分析は RECONFIGURE を推奨することがある。 ■ DELETE: SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合に、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合に、特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを削減するサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false. true の場合、実行される前にアクションリストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false. true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstanc |
デフォルト:false. true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連するエンティティタイプとして VirtualMachine を指定した場合、要求には、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
基準 |
説明 |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
次のコモディティは、アクションの関連コモディティとして返品できる。
■ アクセス
■ ActionPermit
■ ActiveSessions
■ ApplicationCommodity
■ バルーニング
■ Biclique
■ BufferCommodity
■ BurstBalance
■ CPU
■ CPUAllocation
■ CPUProvisioned
■ ClusterCommodity
■ CollectionTime
■ Connection
■ 冷却
■ クーポン
■ CrossCloudMoveSvc
■ CrossClusterMoveSvc
■ DB キャッシュヒット率
■ DBMem
■ DISK_ARRAY_ACCESS
■ DSPMAccessCommodity
■ DataCenterCommodity
■ DatastoreCommodity
■ DrsSegmentationCommodity
■ Extent
■ フロー
■ FlowAllocation
■ HACommodity
■ HOST_LUN_ACCESS
■ ヒープ
■ ホットストレージ
■ IOThroughput
■ ImageCPU
■ ImageMem
■ ImageStorage
■ InstanceDiskSize
■ InstanceDiskType
■ LICENSE_ACCESS
■ LicenseCommodity
■ Mem
■ MemAllocation
■ MemProvisioned
■ Move
■ NetThroughput
■ NetworkCommodity
■ NetworkInterfaceCount
■ NetworkPolicy
■ NumDisk
■ NumberConsumers
■ NumberConsumersPM
■ NumberConsumersStorage
■ PORT_CHANNEL
■ PoolCPU
■ PoolMem
■ PoolStorage
■ 電源
■ ProcessingUnits
■ Q1VCPU
■ Q2VCPU
■ Q3VCPU
■ Q4VCPU
■ Q5VCPU
■ Q6VCPU
■ Q7VCPU
■ Q8VCPU
■ Q16VCPU
■ Q32VCPU
■ Q64VCPU
■ QNVCPU
■ ResponseTime
■ RightSizeDown
■ RightSizeSVC
■ RightSizeUp
■ SLACommodity
■ SameClusterMoveSvc
■ SegmentationCommodity
■ ServiceLevelCluster
■ SoftwareLicenseCommodity
■ 空白(スペース)
■ ストレージ
■ StorageAccess
■ StorageAllocation
■ StorageAmount
■ StorageClusterCommodity
■ StorageLatency
■ StorageProvisioned
■ スワッピング
■ TemplateAccess
■ TenancyAccess
■ スレッド
■ トランザクション
■ トランザクション ログ
■ 不明
■ VAppAccess
■ VCPU
■ VCPULimitQuota
■ VCPURequest
■ VCPURequestQuota
■ VDCCommodity
■ VMPMAccessCommodity
■ VMem
■ VMemLimitQuota
■ VMemRequest
■ VMemRequestQuota
■ VStorage
■ ゾーン
例:POST https://10.10.10.10/api/v3/actions
入力例:この例では、次の条件を満たすアクションのリストが返され、アクションの actionMode によってグループ化される。
■ 状態は PENDING_ACCEPT
■ オンプレミス環境の一部である
■ 仮想マシンのアクションである
■ Workload Optimization Manager のリアルタイムマーケットによって生成されたアクション
{
"actionInput":{
"actionStateList":[
"PENDING_ACCEPT"
],
"environmentType":"ONPREM", "groupBy":[
"actionModes"
]
},
"relatedType":"VirtualMachine", "scopes":[
"Market"
]
}
応答:指定された条件を満たす ActionApiDTO のリスト。
指定されたアクションの承認または拒否
このリクエストは、指定された UUID のアクションを受け入れるか拒否し、次のパラメータを受け取る。
パラメータ |
説明 |
action_UUID(必須) |
アクションの UUID。 |
accept(必須) |
true の場合、アクションを受け入れる。false の場合、アクションを拒否する。 |
例:POST https://10.10.10.10/api/v3/actions/_QJCzNd3JEeij-LI4LMEROw?accept=false
応答:アクションが受け入れられた場合は true。
GroupBy フィールド基準
POST リクエストを使用してアクションとアクション統計を照会する場合、統計をグループ化するために使用できる groupBy パラメータがあります。このパラメータの有効な値は、エンティティタイプによって異なります。エンティティごとの有効なオプションの完全なリストは次のとおりです:
注:
このフィールドを使用して inputDTO を送信する場合は、値のみが必要です。
例:"groupBy": "vmsByPMName"
{
"VirtualMachine":{ "criteria":[
{
"filterType":"vmsByName"
},
{
"filterType":"vmsByPMName"
},
{
"filterType":"vmsByStorage"
},
{
"filterType":"vmsByNetwork"
},
{
"filterType":"vmsByApplication"
},
{
"filterType":"vmsByDatabaseServer"
},
{
"filterType":"vmsByDatabaseServerVersion"
},
{
"filterType":"vmsByDC"
},
{
"filterType":"vmsByVDC"
},
{
"filterType":"vmsByDCnested"
},
{
"filterType":"vmsByNumCPUs"
},
{
"filterType":"vmsByMem"
},
{
"filterType":"vmsByGuestName"
},
{
"filterType":"vmsByAltName"
},
{
"filterType":"vmsByClusterName"
},
{
"filterType":"vmsByDiskArrayName"
},
{
"filterType":"vmsByLogicalPoolName"
},
{
"filterType":"vmsByProfileName"
},
{
"filterType":"vmsByTag"
},
{
"filterType":"vmsByState"
},
{
"filterType":"vmsByBusinessAccountUuid"
},
{
"filterType":"vmsByResourceGroupUuid"
}
]
},
"VirtualDataCenter":{ "criteria":[
{
"filterType":"vdcsByName"
},
{
"filterType":"vdcsByVDCName"
},
{
"filterType":"vdcsByTag"
},
{
"filterType":"vdcsByState"
}
]
},
"VirtualMachine":{ "criteria":[
{
"filterType":"pmsByName"
},
{
"filterType":"pmsByStorage"
},
{
"filterType":"pmsByNetwork"
},
{
"filterType":"pmsBySwitch"
},
{
"filterType":"pmsByNumVms"
},
{
"filterType":"pmsByDC"
},
{
"filterType":"pmsByMem"
},
{
"filterType":"pmsByNumCPUs"
},
{
"filterType":"pmsByVendorName"
},
{
"filterType":"pmsByCPUModel"
},
{
"filterType":"pmsByModel"
},
{
"filterType":"pmsByTimezone"
},
{
"filterType":"pmsByClusterName"
},
{
"filterType":"pmsByTag"
},
{
"filterType":"pmsByState"
}
]
},
"Storage":{
"criteria":[
{
"filterType":"storageByName"
},
{
"filterType":"storageByTag"
},
{
"filterType":"storageByVMs"
},
{
"filterType":"storageByDC"
},
{
"filterType":"storageByPMCluster"
},
{
"filterType":"storageByState"
}
]
},
"Application":{
"criteria":[
{
"filterType":"appsByName"
},
{
"filterType":"appsByTag"
}
]
},
"ApplicationComponent":{ "criteria":[
{
"filterType":"appSrvsByName"
}
]
},
"WebServer":{
"criteria":[
{
"filterType":"wbSrvsByName"
}
]
},
"BusinessApplication":{ "criteria":[
{
"filterType":"busAppsByName"
}
]
},
"Database":{
"criteria":[
{
"filterType":"databaseByName"
},
{
"filterType":"databaseByTag"
},
{
"filterType":"databaseByBusinessAccountUuid"
},
{
"filterType":"databaseByResourceGroupUuid"
}
]
},
"DatabaseServer":{ "criteria":[
{
"filterType":"databaseServerByName"
},
{
"filterType":"databaseServerByTag"
},
{
"filterType":"databaseServerByBusinessAccountUuid"
},
{
"filterType":"databaseServerByEngine"
},
{
"filterType":"databaseServerByEdition"
},
{
"filterType":"databaseServerByVersion"
}
]
},
"VirtualApplication":{ "criteria":[
{
"filterType":"vappsByName"
}
]
},
"Cluster":{
"criteria":[
{
"filterType":"clustersByName"
},
{
"filterType":"clustersByTag"
}
]
},
"DataCenter":{ "criteria":[
{
"filterType":"datacentersByName"
},
{
"filterType":"datacentersByTag"
}
]
},
"Group":{
"criteria":[
{
"filterType":"groupsByName"
},
{
"filterType":"groupsByTargetName"
}
]
},
"StorageCluster":{
"criteria":[
{
"filterType":"storageClustersByName"
}
]
},
"DiskArray":{
"criteria":[
{
"filterType":"diskarrayByName"
}
]
},
"Zone":{
"criteria":[
{
"filterType":"zonsByName"
}
]
},
"Region":{
"criteria":[
{
"filterType":"regsByName"
}
]
},
"Network":{
"criteria":[
{
"filterType":"netsByName"
}
]
},
"LoadBalancer":{ "criteria":[
{
"filterType":"lbsByName"
}
]
},
"Chassis":{
"criteria":[
{
"filterType":"chasByName"
}
]
},
"IOModule":{
"criteria":[
{
"filterType":"ioModuleByName"
}
]
},
"StorageController":{
"criteria":[
{
"filterType":"storagecontrollerByName"
}
]
},
"DPod":{
"criteria":[
{
"filterType":"dpodByName"
}
]
},
"VPod":{
"criteria":[
{
"filterType":"vpodByName"
}
]
},
"LogicalPool":{
"基準":[
{
"filterType":"logicalPoolByName"
}
]
},
"Switch":{
"criteria":[
{
"filterType":"switchByName"
}
]
},
"Container":{
"criteria":[
{
"filterType":"containersByName"
},
{
"filterType":"containersByVMName"
}
]
},
"ContainerPod":{
"criteria":[
{
"filterType":"containerpodsByName"
},
{
"filterType":"containerpodsByVMName"
}
]
},
"ServiceEntity":{
"criteria":[
{
"filterType":"workloadByBusinessAccountUuid"
},
{
"filterType":"workloadByResourceGroupUuid"
}
]
},
"Workload":{
"criteria":[
{
"filterType":"workloadByBusinessAccountUuid"
},
{
"filterType":"workloadByResourceGroupUuid"
}
]
},
"ResourceGroup":{
"criteria":[
{
"filterType":"resourceGroupByName"
},
{
"filterType":"resourceGroupByUuid"
},
{
"filterType":"resourceGroupByBusinessAccountUuid"
},
{
"filterType":"resourceGroupByTag"
}
]
},
"BusinessAccount":{
"criteria":[
{
"filterType":"businessAccountByName"
},
{
"filterType":"businessAccountByUuid"
},
{
"filterType":"subBusinessAccountOfUuid"
},
{
"filterType":"businessAccountValidationStatus"
},
{
"filterType":"businessAccountTargetName"
},
{
"filterType":"businessAccountCloudProvider"
}
]
},
"BillingFamily":{
"criteria":[
{
"filterType":"billingFamilyByName"
}
]
},
"ViewPod":{
"criteria":[
{
"filterType":"viewPodByName"
}
]
},
"DesktopPool":{
"criteria":[
{
"filterType":"desktopPoolByName"
},
{
"filterType":"desktopPoolByViewPod"
}
]
},
"BusinessUser":{
"criteria":[
{
"filterType":"businessUserByName"
},
{
"filterType":"businessUserByDesktopPool"
}
]
}
}
管理エンドポイントは、さまざまな管理機能を実行できるようにするリクエストのコレクションです。管理エンドポイントを使用するには、管理者ユーザーとして Workload Optimization Manager にログインする必要があります。
管理エンドポイントを使用すると、次のことができます。
■ 環境で使用するために既存の構成ファイルをロードする
■ 診断をローカルにエクスポートし、サポートに送信する
■ プロキシ設定を取得または設定する
■ 環境のさまざまなコンポーネントのログ レベルを取得または設定する
■ 現在の製品バージョン情報を取得する
■ 更新を確認して、Workload Optimization Manager アプライアンスに適用する
現在のバージョンの取得
インスタンスが実行している Workload Optimization Manager パッケージのバージョンを取得します。[check_for_updates] パラメータを true に設定して、利用可能なアップデートをさらにチェックします。
このリクエストは、次のパラメータを取ります:
check_for_updates |
バージョン情報を返す前に、利用可能なアップデートを確認します。デフォルト:false. |
例:GET https://10.10.10.10/api/v3/admin/versions?check_for_updates=true
応答:現在のバージョンと利用可能な更新に関する詳細を説明する ProductVersionDTO。最新バージョンの Workload Optimization Manager を実行している場合、更新値は "No Updates Available\n" になります。
{
"versionInfo": "Turbonomic Operations Manager 6.1.7 (Build 20180813223950000)\nvmt-platfor m-6.1.7-20180813223950000.i586
...,
"updates": "Available Packages\nvmt-bundle.i586 6.2.0-20180817180112000 vmturbo\nvmt-config.x86_64
...,
"marketVersion": 2
}
診断のエクスポート
Workload Optimization Manager に問題が発生した場合は、サポートエンジニアが診断データのエクスポートを要求する場合があります。要求に応じて、データをエクスポートし、サポートエンジニアに送信することができます。
例:POST https://10.10.10.10/api/v3/admin/exports
応答:成功した場合は true、エクスポートの作成中にエラーが発生した場合は false。エクスポート ファイルは /tmp に保存されます。
インスタンス上のディレクトリに、bkp- で始まるファイル名を付けます。
外部構成ファイルのロード
一部の問題の診断に役立つように、サポートエンジニアが Workload Optimization Manager アプライアンスにコンフィギュレーション ファイルをロードするように求める場合があります。このリクエストは、プロセスをガイドするサポート エンジニアと協力している場合にのみ使用してください。サポート エンジニアは、必要なパラメータを使用して、ロードする構成ファイルの種類とそのファイルの内容を指定します。
例:POST https://10.10.10.10/api/v3/admin/configfiles?config_type=TOPOLOGY&topology=abc
応答:成功した場合は true、較正のアップロード中にエラーが発生した場合は false。
プロキシの取得と設定
プロキシの現在の状態とプロキシの詳細(有効な場合)を取得します。
例:GET https://10.10.10.10/api/v3/admin/httpproxy
応答:プロキシの詳細を記述する HttpProxyDTO。プロキシが設定されていない場合、このリクエストは
"isProxyEnabled":false を返します。
{
"isProxyEnabled":true, "proxyHost":"10.10.111.1", "userName":"UserName", "password":"PW"
}
プロキシを設定するには、HttpProxyDTO を渡します。プロキシをすぐにアクティブにする場合は、必ず "isProxyEnabled":true を含めます。
例:POST https://10.10.10.10/api/v3/admin/httpproxy
httpProxyDTO の例:
{
"isProxyEnabled":true, "proxyHost":"10.10.111.1", "portNumber":"33128", "userName":"ProxyUser", "password":"Password"
}
応答:成功した場合は true、プロキシの設定中にエラーが発生した場合は false。
コンポーネントごとのログ レベルの取得と設定
Workload Optimization Manager のプラットフォームのさまざまなコンポーネントに対して、ロギングのレベルを設定できます。すべてのコンポーネントで、デフォルトのロギングレベルは INFO です。ロギングのレベルを詳細にすればするほど、ログ ファイルの保存に必要なディスク領域が急激に増えることに注意してください。通常、これらの設定は、Workload Optimization Manager のサポートエンジニアとの作業中にのみ、変更するものです。
使用可能なログ レベルは(詳細度の低いものから順に)、INFO、WARN、DEBUG、および TRACE です。
例:GET https://10.10.10.10/api/v3/admin/logginglevels
応答:現在のログ レベル設定に関する詳細を含む LoggingApiDTO:
{
"componentLoggingLevel":{
"拡張機能":"INFO",
"Analysis":"INFO",
"Discovery":"INFO",
"API":"INFO",
"Presentation":"INFO", "Abstraction":"INFO", "Monitoring":"INFO"
}
}
特定のコンポーネントのログレベルを設定するには、コンポーネントとログレベルを含む部分的な LoggingApiDTO を渡します。
例:POST https://10.10.10.10/api/v3/admin/logginglevels
例:LoggingApiDTO:
{
"componentLoggingLevel":{
"Extension":"WARN"
}
}
応答:成功すると、応答本文で入力を返します。
ビジネスユニットは、パブリッククラウド ターゲットのアカウントとサブスクリプションのモデル化、およびクラウドの予算と価格調整のために使用されるコンテナオブジェクトです。
Workload Optimization Manager API の businessunits エンドポイントを使用すると、次のことができます。
■ 指定されたビジネスユニットについて、次のリストを取得します。
– ビジネスユニット内のエンティティに関連するすべてのアクション
– クラウドサービスと料金モデル
– ビジネスユニットに属するすべてのエンティティ
– 価格調整
– 関連する(親、兄弟、または子の)ビジネスユニット
– ビジネスユニット内のエンティティに関する統計
– テンプレートは以下で使用できます。
■ 指定されたビジネスユニットのサプライチェーンの取得
■ ビジネスユニットの作成
■ ビジネスユニットの編集
■ 価格調整の編集
■ ビジネスユニットの削除
ビジネスユニットは、次に説明する 3 つのタイプのいずれかです:
予算 |
予算があり、子が含まれる可能性のあるビジネスユニット。 |
ディスカウント率 |
割引があり、子が含まれる可能性のあるビジネスユニット。 |
DISCOVERED |
Workload Optimization Manager インスタンスによって検出されたビジネスユニット。これらのビジネスユニットは、検出されたターゲット上のものを除き、編集または削除しないでください。 |
ビジネスユニットの取得
Workload Optimization Manager インスタンスで作成または検出されたすべてのビジネスユニットのリストを取得します。このリクエストは、次のパラメータを取ります:
type |
返すビジネスユニットのタイプ。[ BUDGET, DISCOUNT, DISCOVERED ] |
cloud_type |
ビジネスユニットを返すクラウドプロバイダー。[ AWS, AZURE, GCP ] |
has_parent |
親ビジネスユニットを持つビジネスユニットのみを返すかどうか。デフォルト:false。true の場合、親ビジネスユニットの存在に関係なく、関連するすべてのビジネスユニットが返されます。 |
例:GET https://10.10.10.10/api/v3/businessunits?type=DISCOVERED&cloud_type=AWS
応答:選択された条件を満たす BusinessUnitApiDTO のリスト。この場合は、検出された、AWS 環境の一部であるビジネスユニット。
[
{
"uuid": "323871187550",
"displayName": "Product Trust", "className": "BusinessAccount", "environmentType": "CLOUD", "master": false, "hasRelatedTarget": true, "budget": {
"value": 0
},
"businessUnitType": "DISCOVERED", "cloudType": "AWS",
"targets": [
{
"uuid": "_6glgQEEhEemQ645gSx8RYw", "displayName": "PT-AWS",
"type": "AWS"
}
],
"costPrice": 0, "severity": "Critical", "membersCount": 80, "memberType": "Workload", "related": {
"rateCard": null, "priceAdjustment": null
},
"resourceGroupsCount": 0
},
{
"uuid": "001844731978",
"displayName": "Advanced Engineering", "className": "BusinessAccount", "environmentType": "CLOUD",
"master": false, "hasRelatedTarget": false, "budget": {
"value": 0
},
"businessUnitType": "DISCOVERED", "cloudType": "AWS",
"costPrice": 0, "severity": "Normal", "membersCount": 0, "memberType": "Workload", "related": {
"rateCard": null, "priceAdjustment": null
},
"resourceGroupsCount": 0
},
{
"uuid": "192821421245",
"displayName": "Development", "className": "BusinessAccount", "environmentType": "CLOUD", "master": true, "hasRelatedTarget": true, "budget": {
"value": 0
},
"businessUnitType": "DISCOVERED", "cloudType": "AWS", "childrenBusinessUnits": [
"631949720430",
"001844731978",
"323871187550"
],
"targets": [
{
"uuid": "_cBVj0MvWEeiFJej-UwMSGg", "displayName": "engineering.aws.amazon.com", "type": "AWS"
}
],
"costPrice": 0, "severity": "Critical", "membersCount": 80, "memberType": "Workload", "related": {
"rateCard": null, "priceAdjustment": null
},
"resourceGroupsCount": 0
},
{
"uuid": "631949720430",
"displayName": "Turbonomic SaaS",
"className": "BusinessAccount", "environmentType": "CLOUD", "master": false, "hasRelatedTarget": false, "budget": {
"value": 0
},
"businessUnitType": "DISCOVERED", "cloudType": "AWS",
"costPrice": 0, "severity": "Normal", "membersCount": 0, "memberType": "Workload", "related": {
"rateCard": null, "priceAdjustment": null
},
"resourceGroupsCount": 0
}
]
ビジネスユニットの削除
ビジネスユニットを削除するには、リクエストでビジネスユニットの UUID を渡します。DISCOVERED ビジネスユニットは削除できないことに注意してください。
例:DELETE https://10.10.10.10/api/v3/ businessunits/49d50ac3f8adbfe649d53e72c42dd9428d1d3835
応答:コード 200 の応答は、正常に削除されたことを示します。
指定されたビジネスユニットのクラウドサービスと価格設定モデルのペアを取得する
各クラウドサービスのクラウドサービス名と価格モデルを取得します。
例:GET https://10.10.10.10/api/v3/businessunits/192821421245/cloudservices
応答:ビジネス ユニットが利用できる各クラウド サービスを表す CloudServicePricingModelApiDTO のリスト:
[
{
"uuid": "aws::631949720430::CS::AWSCloudTrail", "displayName": "AWS CloudTrail", "pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::631949720430::CS::AmazonCloudWatch", "displayName": "AWS CloudWatch",
"pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::192821421245::CS::AWSDeveloperSupport", "displayName": "AWS Developer Support", "pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::001844731978::CS::AmazonDynamoDB", "displayName": "AWS DynamoDB",
"pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::631949720430::CS::AmazonEC2",
"displayName": "AWS EC2", "pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::001844731978::CS::AmazonEKS",
"displayName": "AWS EKS", "pricingModel": "ON_DEMAND"
},
...
]
指定されたビジネスユニットに関連する価格調整の取得
指定されたビジネスユニットに影響する価格調整を取得します。
例:GET https://10.10.10.10/api/v3/businessunits/192821421245/priceadjustments
応答:調整後の修正された価格を示す BusinessUnitPriceAdjustmentApiDTO のリスト:
[
{
"servicePriceAdjustments": [
{
"uuid": "aws::192821421245::CS::AmazonCloudWatch", "displayName": "AWS CloudWatch",
"pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::192821421245::CS::AWSDeveloperSupport", "displayName": "AWS Developer Support", "pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::192821421245::CS::AmazonDynamoDB", "displayName": "AWS DynamoDB",
"pricingModel": "ON_DEMAND"
},
{
"uuid": "aws::192821421245::CS::AmazonEC2",
"displayName": "AWS EC2", "pricingModel": "ON_DEMAND", "templateDiscounts": [
{
"uuid": "aws::VMPROFILE::g3.16xlarge", "displayName": "g3.16xlarge", "family": "g3",
"pricesPerDatacenter": [
{
"uuid": "aws::ap-southeast-1::DC::ap-southeast-1", "displayName": "aws-Asia Pacific (Singapore)", "price": 6.68
},
{
"uuid": "aws::us-west-2::DC::us-west-2", "displayName": "aws-US West (Oregon)", "price": 4.56
},
{
"uuid": "aws::ca-central-1::DC::ca-central-1", "displayName": "aws-Canada (Central)", "price": 5.664
},
{
"uuid": "aws::eu-west-1::DC::eu-west-1", "displayName": "aws-EU (Ireland)", "price": 4.84
},
{
"uuid": "aws::eu-west-3::DC::eu-west-3", "displayName": "aws-EU (パリ)", "price": 0
},
{
"uuid": "aws::ap-northeast-1::DC::ap-northeast-1", "displayName": "aws-Asia Pacific (Tokyo)", "price": 6.32
},
{
"uuid": "aws::eu-central-1::DC::eu-central-1", "displayName": "aws-EU (Frankfurt)",
"price": 5.7
},
{
"uuid": "aws::ap-south-1::DC::ap-south-1", "displayName": "aws-Asia Pacific (Mumbai)", "price": 0
},
{
"uuid": "aws::ap-northeast-2::DC::ap-northeast-2", "displayName": "aws-Asia Pacific (Seoul)", "price": 0
},
{
"uuid": "aws::us-east-1::DC::us-east-1", "displayName": "aws-US East (N. Virginia)", "price": 4.56
},
{
"uuid": "aws::us-west-1::DC::us-west-1", "displayName": "aws-US West (N. California)", "price": 6.136
},
{
"uuid": "aws::sa-east-1::DC::sa-east-1", "displayName": "aws-South America (Sao Paulo)", "price": 0
},
{
"uuid": "aws::ap-southeast-2::DC::ap-southeast-2", "displayName": "aws-Asia Pacific (Sydney)", "price": 7.016
},
{
"uuid": "aws::us-east-2::DC::us-east-2", "displayName": "aws-US East (Ohio)", "price": 4.56
},
{
"uuid": "aws::eu-north-1::DC::eu-north-1", "displayName": "aws-EU (Stockholm)", "price": 0
},
{
"uuid": "aws::eu-west-2::DC::eu-west-2", "displayName": "aws-EU (London)", "price": 0
}
]
},
{
"uuid": "aws::VMPROFILE::p3.8xlarge", "displayName": "p3.8xlarge", "family": "p3", "pricesPerDatacenter": [
{
"uuid": "aws::ap-southeast-1::DC::ap-southeast-1", "displayName": "aws-Asia Pacific (Singapore)", "price": 16.936
},
{
"uuid": "aws::us-west-2::DC::us-west-2", "displayName": "aws-US West (Oregon)", "price": 12.24
},
{
"uuid": "aws::ca-central-1::DC::ca-central-1", "displayName": "aws-Canada (Central)", "price": 13.464
},
{
"uuid": "aws::eu-west-1::DC::eu-west-1", "displayName": "aws-EU (Ireland)", "price": 13.22
},
{
"uuid": "aws::eu-west-3::DC::eu-west-3",
"displayName": "aws-EU (Paris)", "price": 0
},
{
"uuid": "aws::ap-northeast-1::DC::ap-northeast-1", "displayName": "aws-Asia Pacific (Tokyo)", "price": 6.32
},
{
"uuid": "aws::eu-central-1::DC::eu-central-1", "displayName": "aws-EU (Frankfurt)",
"price": 15.292
},
{
"uuid": "aws::ap-south-1::DC::ap-south-1", "displayName": "aws-Asia Pacific (Mumbai)", "price": 0
},
{
"uuid": "aws::ap-northeast-2::DC::ap-northeast-2", "displayName": "aws-Asia Pacific (Seoul)", "price": 16.936
},
...
]
}
]
}
]
}
]
指定されたビジネスユニットの価格調整の編集
指定されたビジネスユニットの価格調整を編集するには、BusinessUnitPriceAdjustmentApiDTO に修正された情報を送信します(この例では、割引率を 25 から 50 に変更します)。
例:PUT https://10.10.10.10/api/v3/businessunits/ c0acb428d7b447a5d51f9888d2b6660b5fa5225f
入力例:
{
"name": "Daltest1", "priceAdjustment": {
"type": "DISCOUNT",
"value": 50
},
"childrenBusinessUnits": [ "192821421245"
],
"businessUnitType": "DISCOUNT",
"uuid": "c0acb428d7b447a5d51f9888d2b6660b5fa5225f"
}
応答:修正された値を含む完全な BusinessUnitPriceAdjustmentApiDTO:
{
"uuid": "c0acb428d7b447a5d51f9888d2b6660b5fa5225f", "displayName": "Daltest1",
"className": "BusinessAccount", "environmentType": "CLOUD", "discount": 50, "priceAdjustment": {
"type": "DISCOUNT",
"value": 50
},
"master": false, "hasRelatedTarget": false, "budget": {
"value": 0
},
"businessUnitType": "DISCOUNT", "cloudType": "AWS", "childrenBusinessUnits": [
"192821421245"
],
"costPrice": 0, "severity": "Normal", "membersCount": 0, "memberType": "Workload", "related": {
"rateCard": null, "priceAdjustment": {
"uuid": "c0acb428d7b447a5d51f9888d2b6660b5fa5225f", "displayName": "Daltest1",
"className": "BusinessAccount"
}
},
"resourceGroupsCount": 0
}
ビジネスユニットが利用できるテンプレートの取得
指定されたビジネスユニットで使用可能な各テンプレートに関する詳細を取得します。
例:GET https://10.10.10.10/api/v3/businessunits/192821421245/templates
応答:指定されたビジネス ユニットで使用可能なテンプレートを表す TemplateApiDTO のリスト:
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/templates/B4166E9F-589B-357D-AC74-0A534B53CE85"
}
],
"uuid": "B4166E9F-589B-357D-AC74-0A534B53CE85",
"displayName": "db.x1e.32xlarge", "className": "DatabaseServerProfile", "price": 0,
"model": "db.x1e.32xlarge", "dbEngine": "Oracle", "dbEdition": "Enterprise", "computeResources": [
{
"stats": [
{
"name": "numOfCpu", "value": 128
},
{
"name": "cpuSpeed",
"units": "MHz", "value": 384000
},
{
"name": "ioThroughputSize", "units": "MB/s",
"value": 546.875
},
{
"name": "memorySize", "units": "MB", "value": 3997696
}
]
}
],
"storageResources": [
{
"stats": [
{
"name": "diskSize",
"units": "GB", "value": 3840
},
{
"name": "diskIops", "value": 35000
}
]
}
],
"deploymentProfile": {
"uuid": "5C57DCA5-72AB-34BF-A22D-06719D13182E",
"displayName": "DEP-RDB-'ap-northeast-1'", "className": "ServiceCatalogItem",
"deployParameters": [
{
"targetType": "AWS", "providers": [
{
"provider": { "discoveredBy": {
"uuid": "_RRn00PMSEeisB7K_chUWVw", "displayName": "vmturbodev.aws.amazon.com", "type": "AWS"
}
}
}
]
}
]
},
"discovered": true
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/templates/aws::VMPROFILE::g3.16xlarge"
}
],
"uuid": "aws::VMPROFILE::g3.16xlarge", "displayName": "g3.16xlarge", "className": "VirtualMachineProfile", "description": "g3.16xlarge", "computeResources": [
{
"stats": [
{
"name": "ioThroughputSize", "units": "MB/s",
"value": 1750
},
{
"name": "networkThroughputSize", "units": "MB/s",
"value": 2500
},
{
"name": "numOfCpu", "value": 64
},
{
"name": "cpuSpeed",
"units": "MHz", "value": 6664.6587
},
{
"name": "cpuConsumedFactor",
"units": "%", "value": 50
},
{
"name": "memorySize", "units": "MB", "value": 499712
},
{
"name": "memoryConsumedFactor", "units": "%",
"value": 75
},
{
"name": "ioThroughput", "units": "MB/s", "value": 0
},
{
"name": "networkThroughput", "units": "MB/s",
"value": 0
}
]
}
],
"storageResources": [
{
"stats": [
{
"name": "diskSize",
"units": "GB", "value": 976562.5
},
{
"name": "diskIops", "value": 20000
},
{
"name": "diskConsumedFactor", "units": "%",
"value": 100
}
]
}
],
"deploymentProfile": {
"uuid": "aws::us-east-1::DP::DEP-fake-us-east-1", "displayName": "DEP-fake-us-east-1",
"className": "ServiceCatalogItem", "deployParameters": [
{
"targetType": "AWS", "providers": [
{
"provider": { "discoveredBy": {
"uuid": "_RRn00PMSEeisB7K_chUWVw", "displayName": "vmturbodev.aws.amazon.com", "type": "AWS"
}
}
}
]
}
]
},
"discovered": true, "family": "g3"
},
...
]です
エンティティは、Workload Optimization Manager が管理するトポロジ内のオブジェクトです。たとえば、VM、ホスト、データストア、アプリケーションはすべてエンティティです。Workload Optimization Manager は、ターゲットを介してエンティティを検出し、リソースの使用状況を監視および分析し、エンティティの配置、構成、または状態を変更するためのアクションを推奨します。
各マーケットは一連のエンティティを管理します。マーケットの UUID を使用して、そのマーケットで管理されているエンティティのリストを取得できます。エンティティごとに、購入および販売するリソース、リソースの購入元のプロバイダー、エンティティのアクション、およびその他の関連情報を含む、完全な範囲のデータを取得できます。
同時に複数のマーケットがメモリに存在する可能性があることに注意してください — Workload Optimization Manager はリアルタイムマーケットを維持します。メモリにはプランマーケットが存在する場合もあります。マーケットエンティティにアクセスするときは、次の点に注意してください。
■ リアルタイムマーケットのエンティティは、物理環境の現在の状態を反映します
■ リアルタイムマーケットでエンティティを追加または削除しないでください。
■ プランマーケットのエンティティは、マーケットが作成されたときからの環境のスナップショットを反映します
■ プランマーケットは、物理環境のサブセットに範囲を限定できます
■ プランマーケットでエンティティを追加または削除できます
エンティティとマーケットに関する興味深い点 — プランマーケットには、リアルタイムマーケットによって管理されるエンティティもを含めることができます。これらのエンティティは、両方のマーケットで同じ統計を持っています。Workload Optimization Manager は、両方のマーケットでこれらのエンティティの分析を個別に実行します。
Workload Optimization Manager API のエンティティエンドポイントを使用すると、エンティティのリストを取得できます(エンティティを含むマーケットまたはグループから)。個々のエンティティについては、次のものを取得できます。
■ エンティティのアクションと関連データ
■ エンティティに割り当てられた制約
■ エンティティの制約を通じて、エンティティの利用可能なプロバイダーとコンシューマーを取得します。
■ エンティティが属するグループ
■ 通知と通知データ
■ このエンティティに影響するワークロード配置ポリシー
■ このエンティティに影響する自動化ポリシー
■ エンティティの統計
■ このエンティティと直接結び付くエンティティのサプライチェーン
■ エンティティに定義されているタグ
このエンドポイントには、特定の操作の開始時間と終了時間への参照が含まれています。有効な時間形式を含む詳細については、Workload Optimization Manager API の「時間」(17 ページ) を参照してください。
ユーティリティリクエストは、関連するリクエストの作成、inputDTO のアセンブル、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
エンティティのエントリポイントのリストの取得
エンティティエンドポイントには、エンティティのリストを取得するために使用できるエントリポイントを示すユーティリティリクエストが含まれています。これらは、特定のエンティティに関連する UUID と詳細を見つけるために使用できます。
例:GET https://10.10.10.10/api/v3/entities
応答:Link オブジェクトの配列。各オブジェクトには、指定されたマーケット、エンティティ、またはグループのすべてのポリシーを取得するための URL が含まれます。
{
"links":[
{
"rel":"Market actions", "href":"https://10.10.10.10/api/v3/markets/{uuid}/entities"
},
{
"rel":"Group actions", "href":"https://10.10.10.10/api/v3/groups/{uuid}/entities"
}
]
}
単一のエンティティのエントリポイントのリストの取得
エンティティ UUID をエンティティエンドポイントに渡すと、エンティティの説明に加えて、統計、制約、アクションなどのエンティティデータのエントリポイントのリストを取得します。
例:GET https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073
応答:Link オブジェクトの配列。各オブジェクトには、エンティティの情報を取得するための URL が含まれます。
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073?include_aspects=f
alse"
},
{
"rel": "To Stats",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/stats"
},
{
"rel": "Entity notifications",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/notifications"
},
{
"rel": "Entity actions",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/actions?ascendi ng=false"
},
{
"rel": "To Constraints",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/policies"
},
{
"rel": "To Settings",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/settings?inclu de_settingspolicies=false"
},
{
"rel": "To Entity List",
"href": "https://10.10.10.10/api/v3/entities"
}
],
...
}
エンティティの取得
エンティティのリストを取得するには、それらのエンティティを含むオブジェクトから始めます。これは通常、マーケットまたはグループです。UUID を介して個々のエンティティを操作します — エンティティのリストから、操作できる UUID のリストが得られます。
注:
グループを操作するときは、グループ内のエンティティのリストはグループメンバーのリストと同じではないことに注意してください。ホストクラスタのグループを想定します。その場合、エンティティのリストはそれらのクラスタ内のすべてのホストになり、グループメンバーはクラスタのリストに加えて各クラスタ内のすべてのホストになります。詳細については、「グループエンドポイント」(91ページ)を参照してください。
例:GET https://10.10.10.10/api/v3/groups/_BZbFsWXUEemoItN1K8jw3Q/entities
応答:EntityApiDTO のリスト。
[
{
"links": [
...
],
"uuid": "azure::VM::2ffc038a-7af3-4d23-86a9-211da2e4d433", "displayName": "e47f9c97-b44d-4461-be02-0304b97e201e", "className": "VirtualMachine",
"priceIndex": 1.0067123, "state": "ACTIVE",
"severity": "Critical",
"costPrice": 0.64534247, "discoveredBy": {
"uuid": "_-S8GgFYoEemHGIeet0BOnQ",
"displayName": "758ad253-cbf5-4b18-8863-3eed0825bf07", "type": "Azure"
},
"remoteId": "azure::VM::2ffc038a-7af3-4d23-86a9-211da2e4d433", "providers": [
{
"uuid": "azure::ST::eastus2-managed_premium", "displayName": "azure-eastus2-Managed Premium", "className": "Storage"
},
{
"uuid": "azure::eastus2::PM::eastus2", "displayName": "azure-eastus2", "className": "PhysicalMachine"
}
],
"consumers": [
{
"uuid": "azure::APP::2ffc038a-7af3-4d23-86a9-211da2e4d433", "displayName": "GuestLoad [e47f9c97-b44d-4461-be02-0304b97e201e]", "className": "Application"
}
],
"template": {
"uuid": "azure::VMPROFILE::Standard_DS13_v2", "displayName": "Standard_DS13_v2", "discovered": false,
"enableMatch": false
},
"environmentType": "CLOUD", "tags": {
"instance_group": [ "diego_cell"
]
}
},
{
...
}
]
エンティティに関連するアクションの取得
エンティティ UUID を指定し、アクション UUID を指定しない場合、エンティティの現在のすべてのアクションの ActionApiDTO のリストが返されます。エンティティ UUID とアクション UUID の両方を指定すると、指定されたアクションの ActionApiDTO が返されます。
このリクエストは、次のパラメータを取ります:
entity_Uuid |
アクションが返されるエンティティの UUID。 |
action_Uuid |
取得するアクションの UUID – 単一のアクションを取得するために必要です。 |
カーソル |
追加の結果を取得するために後続の呼び出しを行う場合、これは、このメソッドへの最後の呼び出しによって返されたカーソルです。 |
limit |
返される最大アイテム数。正の整数でなければなりません。設定されていない場合、サーバーはデフォルト(20)を使用します。 |
order-by |
結果を並べ替えるフィールド。[ creation_date, name, risk_category, savings, severity ]. |
昇順 |
デフォルト:true。false の場合、結果は降順になります。 |
例:
■ 渡されたエンティティのアクションのリストを取得します:GET https://10.10.10.10/api/v3/entities/
420b1eeb-6190- a9d2-6436-4327ad3ac073/actions?order_by=severity&ascending=true
■ エンティティの単一のアクションを取得します:GET https://10.10.10.10/api/v3/entities/420b1eeb-6190- a9d2-6436-4327ad3ac073/actions/9223304219064809841
応答:指定されたエンティティの現在のアクションを表す ActionApiDTO のリスト、または指定されたアクションの単一の ActionApiDTO。次のリストは、配列にラップされた ActionApiDTO のリストを示しています。
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/9223304219106592017"
},
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/2560158594896"
}
],
"uuid": "9223304219106592017", "createTime": "2019-04-23T10:41:37-04:00",
"actionType": "RIGHT_SIZE", "actionState": "PENDING_ACCEPT", "actionMode": "MANUAL",
"details": "Scale down VMem for VirtualMachine vEOS-4 from 2 GB to 623 MB", "importance": 0,
"target": {
"uuid": "420b1eeb-6190-a9d2-6436-4327ad3ac073", "displayName": "vEOS-4",
"className": "VirtualMachine", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"aspects": { "virtualMachineAspect": {
"os": "Other 2.6.x Linux (32-bit)", "connectedNetworks": [
{
"uuid": "d2da5316adfff0bf779652bbe7eb76c3307c2ab5",
"displayName": "Infrastructure"
},
{
"uuid": "bbef68e6ee0e76ba2c82960012b4ba563b78fdbb", "displayName": "vmnet4"
},
{
"uuid": "d59c5e7e738ad9d2e2cb45aac5fe0073d36b49fb", "displayName": "vmnet6"
},
{
"uuid": "96a42a4d438d1336e8d2c6962c976d889792af8a", "displayName": "vmnet8"
},
{
"uuid": "067bc9d882e9681c55d964295e43134711520145",
"displayName": "vmnet57"
},
{
"uuid": "05b0ce5abc5cecc4104b26514b11618d77818c6d", "displayName": "vmnet59"
}
],
"numVCPUs": 1、
"type": "VMEntityAspectApiDTO"
}
},
"environmentType": "ONPREM"
},
"currentEntity": {
"uuid": "_3vIfwmXVEemoItN1K8jw3Q", "className": "VMem"
},
"newEntity":{
"uuid": "_5fnl82XVEemoItN1K8jw3Q", "className": "VMem",
"aspects": { "virtualMachineAspect": {
"os": "Linux (Free)",
"type": "VMEntityAspectApiDTO"
}
}
},
"currentValue": "2097152.0",
"newValue": "637952.0",
"resizeToValue": "637952.0", "risk": {
"uuid": "_5fr3YWXVEemoItN1K8jw3Q", "subCategory": "Efficiency Improvement",
"description": "Underutilized VMem in Virtual Machine 'vEOS-4'", "severity": "MINOR",
"importance": 0, "reasonCommodity": "VMem"
},
"stats": [
{
"name": "costPrice", "filters": [
{
"type": "savingsType", "value": "savings"
}
],
"units": "$", "value": 69.58008
}
],
"currentLocation": {
"uuid": "98e12595449d993db8861c1f94c8f86ba277f17b", "displayName": "Cloud",
"className": "DataCenter"
},
"newLocation": {
"uuid": "98e12595449d993db8861c1f94c8f86ba277f17b", "displayName": "Cloud",
"className": "DataCenter"
},
"actionID": 2560158594896
},
...
]です
エンティティに関連するアクションのフィルタリングされたリストの取得
マーケット UUID を指定し、次の 1 つ以上の条件を使用して ActionApiInputDTO によってフィルタリングされたアクションのリストを取得します。
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: 指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 ■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するようWorkload Optimization Managerに指示したことを示します。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモードです。 |
actionStateList |
■ DISABLED: ポリシーが無効になっているアクションです。 |
基準 |
説明 |
|
■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 ■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: 1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にする。前のアクションが完了すると実行される。 |
actionTypeList |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加する。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動する。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外する。一時停止によってエンティティが環境から削除されることはないが、マーケットはそのエンティティを分析に含めない。マーケットの状況に基づいて、分析は中断されたエンティティの再開を推奨できます。 中断されたエンティティを再開します。これには、それらを再びマーケット分析に含めます。 ■ ADD PROVIDER: これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨します。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨することがあります。 ■ DELETE: |
基準 |
説明 |
|
SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合に、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合に、特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを削減するサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false. true の場合、実行される前にアクションリストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false。 true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstanc |
デフォルト:false。 true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連するエンティティタイプとして VirtualMachine を指定した場合、要求には、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
このリクエストは、次のパラメータを取ります:
entity_Uuid |
アクションが返されるマーケットの UUID。 |
カーソル |
追加の結果を取得するために後続の呼び出しを行う場合、これは、このメソッドへの最後の呼び出しによって返されたカーソル。 |
limit |
返される最大アイテム数。正の整数でなければならない。設定されていない場合、サーバーはデフォルト(20)を使用する。 |
order-by |
結果を並べ替えるフィールド:[ creation_date, name, risk_category, savings, severity ]. |
昇順 |
デフォルト:true。false の場合、結果は降順になります。 |
例:POST https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/ actions?order_by=severity&ascending=true
入力例:この例では、次の条件を満たすアクションのリストが、アクションの
actionMode で返され、重大度順にグループ分けされます。
■ 状態は PENDING_ACCEPT
■ オンプレミス環境の一部である
■ 仮想マシンのアクションである
{
"actionInput":{ "actionStateList":[
"PENDING_ACCEPT"
],
"environmentType":"ONPREM", "groupBy":[
"actionModes"
]
},
"relatedType":"VirtualMachine", "scopes":[
"Market"
]
}
応答:指定された条件を満たす ActionApiDTO のリスト。
エンティティのアクションのフィルタリングされたリストの統計の取得
参照エンドポイント:アクション(29 ページ)参照エンドポイント:統計(233 ページ)
渡されたエンティティの現在のアクションのフィルタリングされたリストの統計のリストを取得します。返される統計には、アクションの数、総貯蓄/投資、アクションの影響を受けるエンティティの数が含まれます。エンティティ UUID に加えて、次の 1 つ以上の基準を使用して ActionApiInputDTO を提供します。
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: 指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 |
基準 |
説明 |
|
■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するようWorkload Optimization Managerに指示したことを示します。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモードです。 |
actionStateList |
■ DISABLED: ポリシーが無効になっているアクション。 ■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 ■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: 1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にします。前のアクションが完了すると実行されます。 |
actionTypeList |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加します。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動します。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。マーケットの状況に基づいて、分析は中断されたエンティティの再開を推奨し、再びマーケット分析に含めることがあります。 ■ ADD PROVIDER: |
基準 |
説明 |
|
これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE:: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨します。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨することがあります。 ■ DELETE: SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合に、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合に、特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを減らすサイズ変更。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false. true の場合、実行される前にアクションリストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false. true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstanc |
デフォルト:false。 true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連エンティティとして VirtualMachine を指定 |
基準 |
説明 |
|
した場合タイプの場合、リクエストには、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
例:POST https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/ actions/stats
入力例:重大度順に、アクションの actionMode によってグループ化された、次の条件を満たすアクションの統計のリストを取得します。
■ 状態は PENDING_ACCEPT
■ オンプレミス環境の一部
■ 仮想マシンのアクション
■ Workload Optimization Manager のリアルタイムマーケットによって生成されたアクション
{
"actionInput":{ "actionStateList":[
"PENDING_ACCEPT"
],
"environmentType":"ONPREM", "groupBy":[
"actionModes"
]
},
"relatedType":"VirtualMachine"
}
応答:フィルタリングされたアクションに関する統計を集計する StatSnapshotApiDTO のリスト。
[
{
"date": "2019-04-24T03:56:34-04:00",
"統計情報": [
{
"name": "numActions", "values": {
"max": 1,
"min": 1,
"avg": 1,
"total": 1
},
"value": 1
},
{
"name": "costPrice", "filters": [
{
"type": "property", "value": "savings"
}
],
"units": "$", "values": {
"max": 69.77539,
"max": 69.77539,
"avg": 69.77539,
"total": 69.77539
},
"value": 69.77539
},
{
"name": "numEntities", "values": {
"max": 1,
"min": 1,
"avg": 1,
"total": 1
},
"value": 1
}
]
}
]
エンティティの配置に関する制約を取得する
エンティティを配置する場所を計算するとき、Workload Optimization Manager は、環境内に存在する可能性のある配置制約を考慮します。たとえば、Merge Cluster ポリシーが有効でない限り、VM の配置は同じクラスタ内のホストに制限されます。
この呼び出しは、指定されたエンティティのこれらの制約を説明する ConstraintApiDTO オブジェクトを取得します。このオブジェクトのデータは、ユーザーインターフェイスに表示される [配置制約(Placement Constraints)] ビューに相当します。このビューを表示するには、
単一のエンティティのポリシー ビューにドリルダウンします。このビューでは、エンティティに関連するプロバイダーとコンシューマーを表示できます。関連するエンティティごとにビューを開いて、エンティティの潜在的な配置を制限する制約を表示することもできます。また、このビューでは、さまざまな配置オプションをテストできます。(さまざまな配置オプションのテストについては、「要素の制約内での配置オプションの検査」(62ページ)を参照してください)。
同じように、ConstraintApiDTO には、現在の配置関係と、ユーザーが行う可能性のある変更を記述するデータ オブジェクトが含まれています。DTO は、各コンシューマーまたはプロバイダーにオブジェクトの配列を提供します。各オブジェクト内では:
■ 関係は、エンティティがプロバイダー(購入)であるか、コンシューマー(売却)であるかを示す
■ relatedEntities は、現在のコンシューマーまたはプロバイダーを表す
■ PlacementOptions は、現在の制約を(ポリシーのマージまたは他の手段を介して)削除する場合に、この関係に利用できる他の配置を示す
例:GET https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/ constraints
応答:このリストは、関連するエンティティと配置オプションのサブセットを示しています:
[
{
"relation": "bought", "entityType": "PhysicalMachine", "relatedEntities": [
{
"links": [
{
ects=false"
}
],
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/30333436-3638-5355-4532-313159335631?include_asp
"uuid": "30333436-3638-5355-4532-313159335631",
"displayName": "hp-dl571.dev.mycorp.com", "className": "PhysicalMachine", "priceIndex": 6.577457,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "host-30", "environmentType": "ONPREM"
}
],
"numPotentialEntities": 1, "placementOptions": [
{
"constraintType": "ClusterCommodity", "scope": {
"uuid": "17fe23bc346750d62dce8ba4274fa99b4739975f", "displayName": "Cloud\\Physical"
},
"target": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g",
"displayName": "vCenter:vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"numPotentialEntities": 3,
"key": "Cluster::17fe23bc346750d62dce8ba4274fa99b4739975f"
},
{
"constraintType": "NetworkCommodity", "scope": {
"displayName": "NetworkCommodity/vEOS-4"
},
"numPotentialEntities": 2,
"key": "DistributedVirtualPortgroup::vmnet4"
},
{
"constraintType": "DatastoreCommodity", "scope": {
"uuid": "5a822e24-584bce98-ecb2-441ea15e2534",
"displayName": "SCIO:ESXDC11DS2"
},
"target": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g",
"displayName": "vCenter:vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"numPotentialEntities": 2,
"key": "Storage::5a822e24-584bce98-ecb2-441ea15e2534"
},
{
"constraintType": "DatastoreCommodity", "scope": {
"uuid": "98e12595449d993db8861c1f94c8f86ba277f17b", "displayName": "Cloud"
},
"target": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g",
"displayName": "vCenter:vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"numPotentialEntities": 7,
"key": "DataCenter::98e12595449d993db8861c1f94c8f86ba277f17b"
}
]
},
{
"relation": "sold", "entityType": "Application",
...
}
]
要素の制約内での配置オプションの検査
エンティティの配置を制限する特定の制約内では、通常、配置のための多くのオプションがあります。現在の配置は数ある中の 1 つに過ぎません。
エンティティ制約の取得については、「エンティティの配置に関する制約の取得」(62ページ)を参照してください。
エンティティの制約を取得すると、ConstraintApiDTO には、そのエンティティのプロバイダーへの他の配置オプションと、他のコンシューマーをエンティティに配置するオプションが含まれます。このセクションの呼び出しは、これらの配置オプションを渡し、結果として生じる制約の変更を満たすそれぞれのプロバイダーまたはコンシューマーを返します。
この呼び出しを行うことは、ユーザーインターフェイスで [他の配置オプションを検索(Find More Placement Options)] をクリックすることと同じです。これをユーザーインターフェイスで確認するには、範囲を 1 つのエンティティに設定し、[ポリシー(POLICIES)] タブを表示して、[配置制約(Placement Constraints)] セクションまで下にスクロールします。次に、調査するプロバイダーの横にある [制約(Constraints)] をクリックし、[その他の配置オプションを検索(Find More Placements Options)] をクリックします。
例:POST https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/ constraints/entities
入力例:この例では、検査しているエンティティの ConstraintApiDTO からコピーした 2 つの配置オプションを渡します。ConstraintApiDTO の各配置オプションには、constraintType と key が含まれていることに注意してください。配置オプションを渡す場合、これらだけが必要なフィールドです。この例では、ClusterCommodity 制約と
DatastoreCommodity 制約 を渡します。
{
"relation": "bought",
"placementOptions": [
{
"constraintType": "ClusterCommodity",
"key": "Cluster::17fe23bc346750d62dce8ba4274fa99b4739975f"
},
{
"constraintType": "DatastoreCommodity",
"key": "Storage::5a822e24-584bce98-ecb2-441ea15e2534"
}
]
}
応答:(上に)投稿したデータでは、クラスタコモディティには 3 つの潜在的なエンティティがあり、データストアコモディティには 2 つの潜在的なエンティティがあります。応答は、これら 3 つの潜在的なプロバイダーエンティティの共通部分 - 2 つのホストを戻します。
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/30343835-3638-584d-5131-323530394e39?include_aspec ts=false"
}
],
"uuid": "30343835-3638-584d-5131-323530394e39",
"displayName": "hp-dl569.dev.mycorp.com", "className": "PhysicalMachine", "priceIndex": 1.031998,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "host-3323", "environmentType": "ONPREM"
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/30333436-3638-5355-4532-313159335631?include_aspec ts=false"
}
],
"uuid": "30333436-3638-5355-4532-313159335631",
"displayName": "hp-dl571.dev.mycorp.com", "className": "PhysicalMachine", "priceIndex": 6.916899,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "host-30", "environmentType": "ONPREM"
}
]
エンティティのグループメンバーシップの取得
Groups エンドポイントは、特定のグループに含まれるエンティティを示します。/entities/{entity_Uuid}/groups 呼び出しは、特定のエンティティがどのグループに属しているかを示します。この呼び出しは、次の 2 つのモードで行うことができます:
■ 関係パスを含める
このモードでは、エンティティとの売買関係にあるグループのみが結果に含まれます。たとえば、VM エンティティには、データセンターおよびホストクラスタとの関係がある場合があります。この呼び出しは、データセンター、ホストクラスタ、および VM 自体のエントリを返します。
■ 関係パスを含めない
このモードでは、呼び出しは渡されたエンティティをメンバーエンティティとして含むすべてのグループを返します。これは、検出されたすべてのグループや作成したカスタムグループを含む、多数のグループになる可能性があります。結果には、買い/売りの関係は示されていません。
このリクエストは、次のパラメータを取ります:
entity_Uuid |
アクションが返されるエンティティの UUID。 |
path |
デフォルト:false。true の場合、結果には関連グループのみが含まれ、該当する場合は各グループのプロバイダーとコンシューマーが表示されます。 |
例:
■ すべてのグループ(path = false):GET https://10.10.10.10/api/v3/entities/420b1eeb-6190- a9d2-6436-4327ad3ac073/groups?path=false
■ 関連グループの売買のみ(path = true):GET https://10.10.10.10/api/v3/ entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/groups?path=true
応答:関連するグループのリスト。デフォルト(path = false)の場合、これはグループ オブジェクトの配列を返します。
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_lSlr0GddEemDFcIzuV5wcQ?include_aspects=false"
}
],
"uuid": "_lSlr0GddEemDFcIzuV5wcQ", "displayName": "CUD_Vm_Group_vEOS", "className": "Group", "environmentType": "ONPREM", "entitiesCount": 5,
"membersCount": 5, "groupType": "VirtualMachine", "severity": "Normal",
"isStatic": true, "logicalOperator": "OR", "activeEntitiesCount": 3
},
...
]です
エンティティに影響する設定ポリシーの取得
この呼び出しは、指定されたエンティティに対して有効なすべての自動化ポリシーの SettingsPolicyApiDTO の配列を返します。1 つのエンティティは複数のグループに属することが可能なため、同じ設定に対して異なる値を設定するポリシーを持つ場合があることに注意してください。その場合、最も保守的な設定が有効になります。この呼び出しによって返されるデータは、この場合に優先される設定を反映していません。この呼び出しは、ユーザーインターフェイスに表示される内容を反映しているだけです。
例:GET https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/ settingspolicies
応答:エンティティに有効な SettingsPolicyApiDTO の配列。
[
{
"uuid": "_i-QuUGXUEemoItN1K8jw3Q", "displayName": "CUD_VM_AUTOMATION_POLICY", "entityType": "VirtualMachine",
"scopes": [
{
"uuid": "_BZbFsWXUEemoItN1K8jw3Q", "displayName": "CUD_VM_Group", "groupType": "VirtualMachine", "isStatic": true, "logicalOperator": "AND"
}
],
"settingsManagers": [
{
"uuid": "automationmanager", "displayName": "Action Mode Settings", "category": "Automation",
"settings": [
{
"uuid": "startVM", "displayName": "Start", "value": "MANUAL",
"defaultValue": "RECOMMEND", "valueType": "STRING", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automated", "value": "AUTOMATIC"
}
],
"entityType": "VirtualMachine", "sourceGroupName": "Global"
}
]
}
],
「無効」: false、「readOnly」: false、「デフォルト」: false
}
]
エンティティの統計の取得
参照エンドポイント:統計 (233 ページ)
指定されたエンティティのすべての統計を取得します。このリクエストは、次のパラメータを取ります:
entity_uuid |
統計が返されるエンティティ。 |
q |
Workload Optimization Manager により内部的に使用されます。 |
例:GET https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/stats
応答:リアルタイムマーケットの統計を表す StatSnapshotApiDTO のリスト。
[
{
"displayName": "AdityaReplica", "date": "2019-04-24T20:09:46-04:00",
"statistics": [
{
"name": "priceIndex", "relatedEntityType": "VirtualMachine", "values": {
"max": 1.01,
"min": 1.01,
"avg": 1.01,
"total": 1.01
},
"value": 1.01
},
{
"displayName": "CPUProvisioned/AdityaReplica",
"name": "CPUProvisioned", "capacity": {
"max": |
3120000, |
"min": |
3120000, |
"avg": |
3120000, |
"total": 3120000
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "bought"
}
],
"units": "MHz", "values": {
"max": |
5200, |
"min": |
5200, |
"avg": |
5200, |
"total": 5200
},
「値」: 5200
},
{
"displayName": "スワッピング/AdityaReplica", "name": "スワッピング",
"capacity": {
"max": |
40000000, |
"min": |
40000000, |
"avg": |
40000000, |
"total": 40000000
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "bought"
}
],
"units": "bit/sec", "values": {
"max": 0,
"min": 0,
"avg": 0,
"total": 0
},
"value": 0
},
{
"displayName": "NumDisk/AdityaReplica", "name": "NumDisk",
"capacity": {
"max": 2147483650,
"min": 2147483650,
"avg": 2147483650,
"total": 2147483650
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "bought"
}
],
"values": {
"max": 1,
"min": 1,
"avg": 1,
"total": 1
},
"value": 1
},
...
]
}
]
エンティティの統計のフィルタリングされたリストの取得
ユーザーが作成した StatPeriodApiInputDTO によってフィルタ処理された統計のリストを取得します。この要求の入力を構成する基準の詳細については、https://<Your_Workload Optimization Manager_IP>/swagger/external/ index.html にあるこの要求の Swagger ドキュメントを参照してください。
例:POST https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/stats
入力例:この入力は、指定されたエンティティの VMem、VCPU、および VStorage 統計の値を返します。最初にキー、次に relatedEntity、次に virtualDisk の順に並べられます。
{
統計情報
{
"name": "VMem", "groupBy": [
"key", "relatedEntity", "virtualDisk"
]
},
{
"name": "VCPU",
"groupBy": [
"key", "relatedEntity", "virtualDisk"
]
},
{
"name": "VStorage", "groupBy": [
"key", "relatedEntity", "virtualDisk"
]
}
]
}
応答:マーケットのフィルタ処理された統計を表す StatSnapshotApiDTO の配列。
[
{
"displayName": "vEOS-4",
"date": "2019-04-25T17:57:02-04:00",
「統計情報」: [
{
"displayName": "vEOS-4",
"name": "VCPU",
"capacity": {
"max": 2663,
"min": 2663,
"avg": 2663,
"total": 2663
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "virtualDisk", "value": ""
},
{
"type": "key", "value": null
},
{
"type": "relation",
"value": "sold"
}
],
「関連エンティティ」: {
"uuid": "c0849b50a2cce61f57ea0e49e2199503e82f3f54", "displayName": "GuestLoad[vEOS-4]",
"className": "Application"
},
"units": "MHz", "values": {
"max": 143,
"min": 91.47,
"avg": 91.47,
"total": 91.47
},
"value": 91.47
},
{
"displayName": "vEOS-4",
"name": "VMem", "capacity": {
"max": 2097152,
"min": 2097152,
"avg": 2097152,
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "virtualDisk", "value": ""
},
{
"type": "key", "value": null
},
{
"type": "relation",
"value": "sold"
}
],
"relatedEntity": {
"uuid": "c0849b50a2cce61f57ea0e49e2199503e82f3f54", "displayName": "GuestLoad[vEOS-4]",
"className": "Application"
},
"units": "KB", "values": {
"max": 188740,
"min": 130022,
"avg": 130022,
"total": 130022
},
"value": 130022
}
]
}
]
エンティティのサプライチェーンの取得
Workload Optimization Manager は、お客様の環境を購入者や販売者のマーケットとしてモデル化します。検出したエンティティを、これらのエンティティ間の売買関係を表すサプライチェーンにマッピングします。
ユーザーインターフェイスでは、ホームページのデフォルト ビューにグローバル サプライチェーンが表示されます。範囲を変更して、単一のエンティティへの関係のサプライチェーンにドリルダウンできます。これは、API を介してエンティティのサプライチェーンを取得した場合の結果と同じです。返されるデータは、渡されたエンティティの範囲を表す SupplyChainApiDTO です。
サプライチェーンはエンティティタイプの層を示し、深さはサプライチェーンレベルのどこに特定の層があるかを示します。エンティティのサプライチェーンを取得すると、エンティティで depth = 0 であることがわかります。エンティティより上の層の深さは負です。たとえば、VM が depth = 0 の場合、VM から消費するアプリケーションは depth = -1 になります。同様に、VM へのプロバイダーの深さは正です。たとえば、VM にリソースを提供するストレージは depth = 1 で、ストレージをホストするディスクアレイは depth = 2 になります。
サプライチェーンリクエストは、次のパラメータを取ります:
entity_uuid |
サプライチェーンの範囲を設定するエンティティ。 |
タイプ |
サプライチェーンに含めるエンティティタイプの文字列の配列。これを空白のままにすると、呼び出しはこのエンティティの完全なサプライチェーンを返します。タイプを指定すると、返されるサプライチェーンにはそれらのタイプのみが含まれます。このルールは、範囲を設定するエンティティ(entity_uuid)にも適用されることに注意してください。そのエンティティのタイプを含めない場合、supplu チェーンは、リクエストの範囲を設定しても、そのエンティティを含めません。 |
entity_states |
文字列の配列。サプライチェーンを制限して、指定された状態のエンティティのみを含めます。エンティティの状態には、次のものがあります: ■ ACTIVE:エンティティはリソースを積極的に消費している ■ EVACUATED:すべてのコンシューマーがエンティティから移動され、一時停止または終了できる ■ FAILOVER:エンティティはフェールオーバー用に予約されており、マーケットに参加しない ■ IDLE:エンティティの電源がオフになっており、マーケットのリソースを積極的に消費していない ■ LAUNCH:エンティティが起動している ■ MAINTENANCE:エンティティはメンテナンスモード ■ NOT_MONITORED:Workload Optimization Manager は現在、エンティティを監視していない ■ QUEUED:1 つのターゲットに対して 10 を超えるアクションが実行されており、このエンティティはキューに保留中のアクションを持っている ■ RESOURCE_ALLOCATION:内部的に使用 ■ RESOURCE_RELEASE:内部的に使用 ■ SUSPEND:エンティティはサスペンドモード ■ SUSPEND_PENDING:エンティティは一時停止の準備を行っているか、そのタイプで次に一時停止するエンティティである ■ TERMINATE_PENDING:エンティティは終了の準備を行っているか、そのタイプで次に終了するエンティティである ■ 不明:Workload Optimization Manager はエンティティの現在の状態を取得できない |
environment_type |
サプライチェーンを特定の環境タイプに限定します。環境タイプを指定しない場合、サプライチェーンにはすべての環境が含まれます。これは HYBRID と同じです。環境タイプは次のとおりです: ■ ハイブリッド ■ クラウド ■ ONPREM |
detail_type |
サプライチェーンで必要な詳細レベル。次のいずれかになります。 ■ compact:サプライチェーンアイテムに関する最小限の詳細 ■ entity:サプライチェーンアイテムには、エンティティの完全な説明が含まれます。 ■ aspects:サプライチェーンアイテムにはアスペクトも含まれます(エンティティと共に保存されたメタデータ) |
正常性 |
サプライチェーン内のエンティティに健康状態の概要を含めるかどうか。デフォルトでは false。 |
例:GET https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/ supplychains? types=VirtualMachine&types=Storage&types=DiskArray&detail_type=compact&health=true
この例では、VM、ストレージ、ディスクアレイを含む次の設定で、VM エンティティのサプライチェーンを取得します:
■ VM、そのストレージ、ディスクアレイのみを含める
■ コンパクトな詳細を表示する
■ エンティティの健全性を表示する
応答:フィルタリングされたリクエストの SupplyChainApiDTO:
{
"seMap": { "VirtualMachine": {
"depth": 0,
"entitiesCount": 1, "healthSummary": {
"Normal": 1
},
"stateSummary": { "ACTIVE": 1
},
"connectedProviderTypes": [
"PhysicalMachine", "Storage", "VirtualDataCenter"
],
"connectedConsumerTypes": [ "Application"
],
"instances": {
"420b1eeb-6190-a9d2-6436-4327ad3ac073": {
"links": [
{
spects=false"
}
],
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073?include_a
"uuid": "420b1eeb-6190-a9d2-6436-4327ad3ac073", "displayName": "vEOS-4",
"className": "VirtualMachine", "priceIndex": 1.1463195, "state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "vm-100", "environmentType": "ONPREM"
}
}
},
"Storage": {
"depth": 1,
"entitiesCount": 2, "healthSummary": {
"Normal": 2
},
"stateSummary": { "ACTIVE": 2
},
"connectedProviderTypes": [ "DiskArray"
],
"connectedConsumerTypes": [ "PhysicalMachine", "VirtualMachine"
],
"instances": {
"5a822e24-584bce98-ecb2-441ea15e2534": {
"links": [
{
spects=false"
}
],
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/5a822e24-584bce98-ecb2-441ea15e2534?include_a
"uuid": "5a822e24-584bce98-ecb2-441ea15e2534", "displayName": "SCIO:ESXDC11DS2",
"className": "Storage", "priceIndex": 1.2797012, "state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "datastore-2357", "environmentType": "ONPREM", "tags": {
"Datastore_DC11": [ "True"
]
}
},
"9bd4ee88-99c64661": {
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/9bd4ee88-99c64661?include_aspects=false"
}
],
"uuid": "9bd4ee88-99c64661", "displayName": "QS1:NFSShare", "className": "Storage", "priceIndex": 20000,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_gOQEYEaREemB8r4uTzazvA", "displayName": "vsphere-dc5.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "datastore-1411", "environmentType": "ONPREM", "tags": {
"DimStor": [ "DimStorTag"
],
"Datastore_DC11": [ "True"
],
"Test_Tag": [ "MyStorageTag"
]
}
}
}
},
"DiskArray":{
"depth": 2,
"entitiesCount": 2, "healthSummary": {
"Normal": 2
},
"stateSummary": {
"ACTIVE": 2
},
"connectedConsumerTypes": [
"Storage"
],
"instances": {
"DiskArray-9bd4ee88-99c64661": {
"links": [
{
alse"
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/DiskArray-9bd4ee88-99c64661?include_aspects=f
}
],
"uuid": "DiskArray-9bd4ee88-99c64661", "displayName": "DiskArray-QS1:NFSShare", "className": "DiskArray",
"priceIndex": 0, "state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_oQ2aIEG1EemgjaEqcE-BJw", "displayName": "vsphere-dc13.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "datastore-982", "environmentType": "ONPREM"
},
"DiskArray-5a822e24-584bce98-ecb2-441ea15e2534": {
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/DiskArray-5a822e24-584bce98-ecb2-441ea15e2534? include_aspects=false"
}
],
"uuid": "DiskArray-5a822e24-584bce98-ecb2-441ea15e2534", "displayName": "DiskArray-SCIO:ESXDC11DS2",
"className": "DiskArray", "priceIndex": 0,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "datastore-2357", "environmentType": "ONPREM"
}
}
}
}
}
エンティティのタグを取得する
Workload Optimization Manager は、環境内のさまざまなエンティティに割り当てられているタグとタグ値を検出します。この呼び出しは、渡すエンティティのタグと値のセットを返します。
例:GET https://10.10.10.10/api/v3/entities/9bd4ee88-99c64661/tags
応答:渡されたエンティティの TagApiDTO。これにより、値が文字列の配列であるキー/値のペアの配列が得られます。
[
{
"key": "Datastore_DC11", "values": [
"True"
]
},
{
"key": "Test_Tag", "values": [
"MyStorageTag"
]
},
{
"key": "DimStor", "values": [
"DimStorTag"
]
}
]
グループは、Workload Optimization Manager が 1 つの単位として操作できるエンティティ(物理マシン、コンテナ、クラスタ、またはその他のグループなど)のコレクションです。グループの最も一般的な用途は、チャートでの表示または計画での処理の範囲を設定し、環境のサブセットの統計を取得することです。
このエンドポイントには、特定の操作の開始時間と終了時間への参照が含まれています。有効な時間形式を含む詳細については、Workload Optimization Managerr API の「時間」(17 ページ)を参照してください。
Workload Optimization Manager API のグループ エンドポイントを使用すると、次のことができます。
■ Workload Optimization Manager アプライアンスのすべてのグループのリストの取得
■ グループの作成
■ グループの編集
■ データを削除する
■ 指定されたグループのアクションのリストの取得
■ 指定されたグループ内のエンティティのリストの取得
■ 指定したグループの親グループの取得
■ 指定されたグループのメンバーのリストの取得
■ 指定したグループの通知のリストの取得
■ 指定したグループの設定一覧の取得
■ 指定されたグループのポリシーのリストの取得
■ 指定したグループの統計を取得する
■ 指定されたグループに関連するサプライチェーンの取得
■ 指定したグループに属するタグの取得
グループの種類とクラス名
Workload Optimization Manager は、グループの目的の検索と理解の両方を支援するために、次のグループクラス名によってアプライアンス上のエンティティを細分化します。
クラス名 |
説明 |
フォルダ |
これらはユーザーインターフェイスにフォルダとして表示されます。視覚的に整理するためのものです。検出されたフォルダは、vCenter フォルダ構造など、ターゲットのフォルダ構造を表します。さらに、Workload Optimization Manager は vCenter Server リソース プールを検出し、それらをフォルダにグループ化します。 |
グループ |
Workload Optimization Manager は、検出されたエンティティを標準グループに配置し、ユーザーは静的または動的メンバーシップを持つ独自のグループを作成できます。 |
参照グループ |
RefGroup は、グループのグループ(たとえば、ハイパーバイザターゲットを構成する PM クラスタ グループのグループ)、または関係によって定義されたグループにすることができます。たとえば、組み込みグループ PMsByDatacenter は、データセンターとホスト間の関係を反映する RefGroup です。 |
クラスタ / StorageCluster |
検出されたクラスタに対応するグループ。 |
クラス名 |
説明 |
DiscoveredGroup |
対象サービスによって定義されるグループ。たとえば、Workload Optimization Manager は、vCenter Server で定義された DRS ドメインを検出できます。 |
マーケットグループ |
そのエンティティタイプのインフラストラクチャコストに基づくグループ。これらのグループは、Workload Optimization Manager ポリシーのインフラストラクチャコスト設定に基づいています。 |
StaticMetaGroup / RefMetaGroup / MetaGroup |
Workload Optimization Manager によって内部的に使用されるグループです。これらはどのような方法でも変更しないでください。 |
さらに、各グループには、そのグループに含まれるメンバーのタイプを識別する groupType があります。ユーザーインターフェイスまたは API を使用してグループを作成する場合、複数のタイプのメンバーを追加できないことに注意してください。さまざまなグループ タイプには次のものがあります:
グループタイプ |
説明 |
Cluster |
クラスタのグループ。たとえば、「Development」という名前を含むすべての PM クラスタのグループを作成できます。 |
ServiceEntity |
Workload Optimization Manager が検出または作成するグループ用に予約されている内部グループ タイプ。グループには 1 つのタイプのメンバーしか含まれないことに注意してください。 |
エンティティ タイプ(Entity Type) |
■ BUSINESS_UNIT ■ CLOUD_SERVICE ■ コンテナ ■ データベース ■ DATABASE_SERVER ■ DATACENTER ■ DISK_ARRAY ■ PHYSICAL_MACHINE ■ ストレージ ■ VIRTUAL_MACHINE ■ スイッチ ■ VIRTUAL_DATACENTER ■ シャーシ ■ STORAGE_CONTROLLER ■ IO_MODULE; IO モジュール ■ APPLICATION_SERVER ■ VIRTUAL_APPLICATION ■ ネットワーク ■ アプリケーション ■ コンテナ ■ CONTAINER_POD ■ LOGICAL_POOL ■ DPOD ■ VPOD ■ LOAD_BALANCER |
さまざまなグループ タイプを理解すると、必要なグループを見つけるのに役立ちます。特定のグループの名前がわかっている場合は、返されたリストでその名前のグループに絞り込むことができます。または、Workload Optimization Manager が検出したすべてのクラスタをステップスルーする場合は、Cluster または StorageCluster の className ですべてのエントリをフィルタ処理できます。
グループフィルタタイプ
Workload Optimization Manager は、正規表現と filterType を使用してグループを構築します。filterType は、正規表現が一致する基準です。たとえば、pmsByName の filterType は、物理マシンの表示名に正規表現を適用します。
このパラメータで使用できるオプションは、グループを構成するエンティティによって異なります。
Entity |
filterType オプション |
VirtualMachine |
■ vmsByName ■ vmsByPMName ■ vmsByStorage ■ vmsByNetwork ■ vmsByApplication ■ vmsByDatabaseServer ■ vmsByDatabaseServerVersion ■ vmsByDC ■ vmsByVDC ■ vmsByDCnested ■ vmsByNumCPUs ■ vmsByMem ■ vmsByGuestName ■ vmsByAltName ■ vmsByClusterName ■ vmsByDiskArrayName ■ vmsByLogicalPoolName ■ vmsByTag ■ vmsByState ■ vmsByBusinessAccountUuid ■ vmsByResourceGroupUuid |
VIRTUAL_DATACENTER |
■ vdcsByName ■ vdcsByVDCName ■ vdcsByTag ■ vdcsByState |
PhysicalMachine |
■ pmsByName ■ pmsByStorage ■ pmsByNetwork ■ pmsBySwitch ■ pmsByNumVms ■ pmsByDC ■ pmsByMem ■ pmsByNumCPUs ■ pmsByVendorName ■ pmsByCPUModel ■ pmsByModel ■ pmsByTimezone ■ pmsByClusterName ■ pmsByTag ■ pmsByState |
ストレージ |
■ storageByName |
Entity |
filterType オプション |
|
■ storageByTag ■ storageByVMs ■ storageByDC ■ storageByPMCluster ■ storageByState ■ volumeByDeletable |
アプリケーション コンポーネント |
■ appSrvsByName ■ appsByName |
Web サーバー |
■ wbSrvsByName |
ビジネスアプリケーション |
■ busAppsByName |
データベース |
■ databaseByName ■ databaseByTag ■ databaseByBusinessAccountUuid ■ databaseByResourceGroupUuid |
DatabaseServer |
■ databaseServerByName ■ databaseServerByTag ■ databaseServerByBusinessAccountUuid ■ databaseServerByEngine ■ databaseServerByEdition ■ databaseServerByVersion |
VirtualApplication |
■ vappsByName |
Cluster |
■ clustersByName ■ clustersByTag |
DataCenter |
■ datacentersByName ■ datacentersByTag |
グループ |
■ groupsByName |
StorageCluster |
■ storageClustersByName |
DiskArray |
■ diskarrayByName |
ゾーン |
■ zonsByName |
[リージョン(Region)] |
■ regsByName |
ネットワーク |
■ netsByName |
ロードバランサ |
■ lbsByName |
シャーシ |
■ chasByName |
StorageController |
■ storagecontrollerByName |
DPod |
■ dpodByName |
VPod |
■ vpodByName |
LogicalPool |
■ logicalPoolByName |
スイッチ |
■ switchByName |
コンテナ |
■ containersByName |
Entity |
filterType オプション |
|
■ containersByPodName ■ containersByVMName ■ containersByNamespace ■ containerSpecsByName |
ContainerPod |
■ containerPodsByName ■ containerPodsByNamespace ■ containerPodsByVMName |
ServiceEntity |
注:ServiceEntity タイプのグループは、複数のエンティティタイプを持つ唯一のグループであり、クラウド ターゲット専用に使用されます。 ■ workloadByBusinessAccountUuid ■ workloadByResourceGroupUuid |
ワークロード |
■ workloadByBusinessAccountUuid ■ workloadByResourceGroupUuid ■ workloadControllersByName ■ workloadControllersByNamespace ■ workloadControllersByKind ■ ResourceGroup ■ resourceGroupByName ■ resourceGroupByUuid ■ resourceGroupByBusinessAccountUuid |
BusinessAccount |
■ businessAccountByName ■ businessAccoutByUuid ■ subBusinessAccountOfUuid ■ businessAccountValidationStatus ■ businessAccountTargetName ■ businessAccountCloudProvider |
BillingFamily |
■ billingFamilyByName |
ViewPod |
■ viewPodByName |
DesktopPool |
■ desktopPoolByName ■ desktopPoolByViewPod |
BusinessUser |
■ businessUserByDesktopPool ■ businessUserByName ■ businessUserByViewPod |
Cloud-Specific Filters |
■ computeTiersByName ■ computeTiersByMem ■ databaseTiersByName ■ databaseTiersByDBMem ■ databaseServerTiersByName ■ databaseServerTiersByVMem |
検出されたリソースグループの場合、グループメンバーは複数のターゲットによって検出される可能性があることに注意してください。その場合、Workload Optimization Manager API は、グループの単一のターゲットを返します。
グループリクエストのページネーション
グループデータをリクエストすると、API はページネーションを使用してデータのサブセットを返します。データを扱いやすいチャンクで確実に取得できるように、可能な場合は常にページネーションを使用する必要があります。返されたデータのページネーションを行うには、limit、orderBy、および cursor パラメータで、API によるデータのページネーション方法を制御します。これらのリクエストに limit を指定しない場合、API はデータをレコードのデフォルトの制限に合わせてページネーションを行います:
■ GET /groups
■ GET /グループ/<groupId>/メンバー
■ GET /グループ/<groupId>/エンティティ
limit を設定せずにスクリプトでこれらのリクエストを行う場合、返されたデータのページネーション カーソルを確認する必要があります。
ページネーションに関する一般的な情報については、Workload Optimization Manager API の「ページネーション」(18ページ)を参照してください。
グループのリストの取得
Workload Optimization Manager アプライアンス上のすべてのグループのリストを取得します。これには、カスタム グループに加えて、Workload Optimization Manager の内部グループとデフォルトグループ、およびターゲットから検出されたグループが含まれます。
例:GET https://10.10.10.10/api/v3/groups
応答:アプライアンスのマーケットを表す MarketApiDTO のリスト。
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_S4k98SFQEd-S4dn3K4_SSA?include_aspects=false"
}
],
"uuid": "_S4k98SFQEd-S4dn3K4_SSA", "displayName": "Datacenters", "className": "Group", "environmentType": "ONPREM", "entitiesCount": 12,
"membersCount": 12, "groupType": "DataCenter", "severity": "Critical", "isStatic": false, "logicalOperator": "AND", "activeEntitiesCount": 44
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_S4k94SFQEd-S4dn3K4_SSA?include_aspects=false"
}
],
"uuid": "_S4k94SFQEd-S4dn3K4_SSA", "displayName": "Chassis", "className": "Group",
"environmentType": "ONPREM", "entitiesCount": 2,
"membersCount": 1, "groupType": "Chassis", "severity": "Normal", "isStatic": false, "logicalOperator": "AND", "activeEntitiesCount": 2
},
...
]
グループの作成
Workload Optimization Manager でグループを作成するには、GroupApiDTO に groupType と isStatic を指定します。動的グループ(isStatis = false)の場合は、以下の criteriaList 情報も含めます:
caseSensitive |
true の場合、正規表現は大文字と小文字を区別して評価されます。 |
expType |
文字列の場合、許容値は EQ および NEQ (等しい、等しくない)です。整数の場合、GT、LT、GTE、LTE (それぞれ、より大きい、より小さい、以上、以下)を追加で使用できます。 |
expVal |
正規表現の値。 |
filterType |
使用可能なオプションの完全なリストについては、グループフィルタタイプを参照してください。 |
静的グループの場合:
■ memberUuidList のグループのメンバーである各エンティティの UUID を提供する
■ criteriaList パラメータは提供しないこと
例:POST https://10.10.10.10/api/v3/groups/
名前が「AJ」で始まる VM の動的グループの作成を示す入力例:
{
"isStatic": false, "displayName": "Dallas-Dynamic", "memberUuidList": [], "criteriaList": [
{
"expType": "EQ",
"expVal": "AJ.*", "filterType": "vmsByName", "caseSensitive": false
}
],
"groupType": "VirtualMachine"
}
応答:
{
"uuid": "_4L0PcE9SEemD69d9a0uLJQ", "displayName": "Dallas-Dynamic", "className": "Group",
"environmentType": "ONPREM", "entitiesCount": 1,
"membersCount": 1, "groupType": "VirtualMachine", "severity": "Major", "isStatic": false, "logicalOperator": "AND", "criteriaList": [
{
"expVal": "AJ.*",
"expType": "EQ", "filterType": "vmsByName", "caseSensitive": false
}
],
"activeEntitiesCount": 1
}
ホストの静的グループの作成を示す入力例:
{
"isStatic": true, "displayName": "Dallas-Static", "memberUuidList": [
"4C4C4544-0042-5A10-804A-B1C04F384331", "4C4C4544-004A-3610-8057-C8C04F464331",
"Virtual_ESX_42381e13-4256-64bb-f554-d17798ddb2ba"
],
"criteriaList": [], "groupType": "PhysicalMachine"
}
応答:
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_vn_u0FJ0EemD69d9a0uLJQ?include_aspects=false"
}
],
"uuid": "_vn_u0FJ0EemD69d9a0uLJQ", "displayName": "Dallas-Static", "className": "Group", "environmentType": "ONPREM", "entitiesCount": 3,
"membersCount": 3,
"groupType": "PhysicalMachine", "severity": "Critical", "isStatic": true, "logicalOperator": "OR", "activeEntitiesCount": 3
}
グループの編集
ユーザーが作成したグループを編集するには、完全な GroupApiDTO を、このリクエストへの入力として、変更とともに送信します。
例:PUT https://10.10.10.10/api/v3/groups/_Y6BL4FDQEemD69d9a0uLJQ
入力例:変更された GroupApiDTO。この場合、expVal パラメータが変更されています。
{
"isStatic": false, "displayName": "Dallas-Host", "memberUuidList": [], "criteriaList": [
{
"expType": "EQ", "expVal": "hp*change",
"filterType": "pmsByName", "caseSensitive": false
}
],
"groupType": "PhysicalMachine", "logicalOperator": "AND"
}
応答:変更を反映する完全な GroupApiDTO:
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_Y6BL4FDQEemD69d9a0uLJQ?include_aspects=false"
}
],
"uuid": "_Y6BL4FDQEemD69d9a0uLJQ", "displayName": "Dallas-Host", "className": "Group", "environmentType": "ONPREM", "entitiesCount": 0,
"membersCount": 0,
"groupType": "PhysicalMachine", "severity": "Normal", "isStatic": false, "logicalOperator": "AND", "criteriaList": [
{
"expVal": "hp*change", "expType": "EQ", "filterType": "pmsByName", "caseSensitive": false
}
],
"activeEntitiesCount": 0
}
グループの削除
ユーザーが作成したグループを削除するには、リクエストの URL でグループの UUID を渡します。
例:DELETE https://10.10.10.10/api/v3/groups/_vn_u0FJ0EemD69d9a0uLJQ
応答:コード 200 の応答は、正常に削除されたことを示します。
グループに関連するアクションの取得
指定されたグループのエンティティに関連するアクションのリストを取得します。単一のアクションを取得するには、要求にアクションの UUID を含めます。このリクエストは、次のパラメータを取ります:
group_Uuid |
アクションが返されるグループの UUID。 |
カーソル |
追加の結果を取得するために後続の呼び出しを行う場合、これは、このメソッドへの最後の呼び出しによって返されたカーソルです。 |
limit |
返される最大アイテム数。正の整数でなければなりません。設定されていない場合、サーバーはデフォルト(20)を使用します。 |
order-by |
結果を並べ替えるフィールド。[ creation_date, name, risk_category, savings, severity ]. |
昇順 |
デフォルト:true。false の場合、結果は降順になります。 |
例:
すべてのアクション:GET https://10.10.10.10/api/v3/groups/421dd4ce-a4c1-231a-71e7-64fbf598bc65/ actions?limit=50&order_by=creation_date&ascending=true
単一のアクション:GET https://10.10.10.10/api/v3/groups/421dd4ce-a4c1-231a-71e7-64fbf598bc65/ actions/_pJg98EQaEemD69d9a0uLJQ
応答:指定されたグループに関連する ActionApiDTO のリスト:
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/_pJg98EQaEemD69d9a0uLJQ"
},
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/2560158594896"
}
],
"uuid": "_pJg98EQaEemD69d9a0uLJQ", "createTime": "2019-03-11T12:28:03-04:00",
"actionType": "RIGHT_SIZE", "actionState": "PENDING_ACCEPT", "actionMode": "MANUAL",
"details": "Scale down Memory reservation for Virtual Machine 'AJ_Test' from 2 GB to 1 GB", "importance": 0,
"target": {
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine", "aspects": {
"virtualMachineAspect": {
"os": "CentOS 4/5/6/7 (64-bit)", "ip": [
"10.10.10.107"
],
"connectedNetworks": [
{
"uuid": "34f9f5364cd843aa1fe99900621ee3b51a7dc6e5", "displayName": "VM Network"
}
],
"numVCPUs": 1, "ebsOptimized": false
}
},
"environmentType": "ONPREM"
},
"currentEntity": {
"uuid": "_pJlPYUQaEemD69d9a0uLJQ", "className": "Mem"
},
"newEntity": {
"uuid": "_pJlPYUQaEemD69d9a0uLJQ", "className": "Mem"
"aspects": { "virtualMachineAspect": {
"os": "Linux (Free)", "ebsOptimized": false
}
}
},
"currentValue": "2097152.0",
"newValue": "1048576.0",
"resizeToValue": "1048576.0", "risk": {
"uuid": "_pL_qMEQaEemD69d9a0uLJQ", "subCategory": "Efficiency Improvement",
"description": "Underutilized Memory reservation", "severity": "MINOR",
"importance": 0
},
"currentLocation": {
"uuid": "cdcd967d1e08d20936c3aa9a0879c635214c79ee", "displayName": "ACM",
"className": "DataCenter"
},
"newLocation": {
"uuid": "cdcd967d1e08d20936c3aa9a0879c635214c79ee", "displayName": "ACM",
"className": "DataCenter"
},
"actionID": 2500817580000
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/_XdP4EEQ8EemD69d9a0uLJQ"
},
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/2501049335840"
}
],
"uuid": "_XdP4EEQ8EemD69d9a0uLJQ", "createTime": "2019-03-11T16:29:28-04:00",
"actionType": "RIGHT_SIZE", "actionState": "PENDING_ACCEPT", "actionMode": "MANUAL",
"details": "Remove VMem limit for VirtualMachine AJ_Test to maximize efficiency", "importance": 0,
"target": {
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine", "aspects": {
"virtualMachineAspect": {
"os": "CentOS 4/5/6/7 (64-bit)", "ip": [
"10.10.10.107"
],
"connectedNetworks": [
{
"uuid": "34f9f5364cd843aa1fe99900621ee3b51a7dc6e5", "displayName": "VM Network"
}
],
"numVCPUs": 1, "ebsOptimized": false
}
},
"environmentType": "ONPREM"
},
"currentEntity": {
"uuid": "_XdP4EkQ8EemD69d9a0uLJQ", "className": "VMem"
},
"newEntity": {
"uuid": "_Xnq_YUQ8EemD69d9a0uLJQ", "className": "VMem",
"aspects": { "virtualMachineAspect": {
"os": "Linux (Free)", "ebsOptimized": false
}
}
},
"currentValue": "2097152.0",
"newValue": "0.0",
"resizeToValue": "0.0", "risk": {
"uuid": "_XnuCsUQ8EemD69d9a0uLJQ", "subCategory": "Efficiency Improvement",
"description": "VMem congestion in Virtual Machine 'AJ_Test'", "severity": "MAJOR",
"reasonCommodity": "VMem", "importance": 0
},
"currentLocation": {
"uuid": "cdcd967d1e08d20936c3aa9a0879c635214c79ee", "displayName": "ACM",
"className": "DataCenter"
},
"newLocation": {
"uuid": "cdcd967d1e08d20936c3aa9a0879c635214c79ee", "displayName": "ACM",
"className": "DataCenter"
},
"actionID": 2501049335840
}
]
グループ内のエンティティの取得
グループに含まれるすべてのエンティティを取得します。
注:この要求は、ネストされたグループの内容を返しません。グループのグループを表示するには、groups/membersリクエストを使用します。
しました。
例:GET https://10.10.10.10/api/v3/groups/_4L0PcE9SEemD69d9a0uLJQ/entities
応答:指定されたグループ内のエンティティを表す EntityApiDTO のリスト。
[
{
Links
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/_pJg98EQaEemD69d9a0uLJQ"
},
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/actions/2560158594896"
}
],
"uuid": "_pJg98EQaEemD69d9a0uLJQ", "createTime": "2019-03-11T12:28:03-04:00",
"actionType": "RIGHT_SIZE", "actionState": "PENDING_ACCEPT", "actionMode": "MANUAL",
"details": "Scale down Memory reservation for Virtual Machine 'AJ_Test' from 2 GB to 1 GB", "importance": 0,
"target": {
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine", "aspects": {
"virtualMachineAspect": {
"os": "CentOS 4/5/6/7 (64-bit)", "ip": [
"10.10.10.107"
],
"connectedNetworks": [
{
"uuid": "34f9f5364cd843aa1fe99900621ee3b51a7dc6e5", "displayName": "VM Network"
}
],
"numVCPUs": 1, "ebsOptimized": false
}
},
"environmentType": "ONPREM"
},
"currentEntity": {
"uuid": "_pJlPYUQaEemD69d9a0uLJQ", "className": "Mem"
},
"newEntity": {
"uuid": "_pLCA40QaEemD69d9a0uLJQ", "className": "Mem",
"aspects": { "virtualMachineAspect": {
"os": "Linux (Free)", "ebsOptimized": false
}
}
},
"currentValue": "2097152.0",
"newValue": "1048576.0",
"resizeToValue": "1048576.0", "risk": {
"uuid": "_pL_qMEQaEemD69d9a0uLJQ", "subCategory": "Efficiency Improvement",
"description": "Underutilized Memory reservation", "severity": "MINOR",
"importance": 0
},
"currentLocation": {
"uuid": "cdcd967d1e08d20936c3aa9a0879c635214c79ee", "displayName": "ACM",
"className": "DataCenter"
},
"newLocation": {
"uuid": "cdcd967d1e08d20936c3aa9a0879c635214c79ee", "displayName": "ACM",
"className": "DataCenter"
},
"actionID": 2500817580000
}
]
グループの親グループの取得
指定されたグループについて、指定されたグループが属するグループがあれば取得します。
注:Workload Optimization Manager には、「My Groups」と呼ばれるユーザー作成グループのデフォルトの親グループが含まれています。このグループは変更または削除しないでください。
このリクエストは、次のパラメータを取ります:
group_Uuid |
アクションが返されるグループの UUID。 |
path |
デフォルト:false。true の場合、このリクエストは、親グループを、親グループを取得するためにトラバースされたグループとともに返します。ネストされていないグループの場合、これは、入力した ID のグループとその親グループを返します。 |
例:GET https://10.10.10.10/api/v3/groups/_4L0PcE9SEemD69d9a0uLJQ/groups?path=true
応答:グループと親グループを表す GroupApiDTO のリスト。
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_S4k94SFQEd-S4dn3K4_SSA?include_aspects=false"
}
],
"uuid": "_S4k98SFQEd-S4dn3K4_SSA", "displayName": "My Groups", "className": "Group", "environmentType": "ONPREM", "entitiesCount": 12,
"membersCount": 3, "groupType": "ServiceEntity", "severity": "Major", "isStatic": false, "logicalOperator": "AND", "activeEntitiesCount": 1
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/groups/_4L0PcE9SEemD69d9a0uLJQ?include_aspects=false"
}
],
"uuid": "_4L0PcE9SEemD69d9a0uLJQ", "displayName": "Dallas-Dynamic",
"className": "Group", "environmentType": "ONPREM", "entitiesCount": 1,
"membersCount": 1, "groupType": "VirtualMachine", "severity": "Major", "isStatic": false, "logicalOperator": "AND", "criteriaList": [
{
"expVal": "AJ.*",
"expType": "EQ", "filterType": "vmsByName", "caseSensitive": false
}
],
"activeEntitiesCount": 1
}
]
グループのメンバーの取得
グループのすべてのメンバーを取得します。
注:このリクエストは、ネストされたグループとそれぞれのメンバーエンティティを返します。指定されたグループのエンティティのみを取得するには、groups/entities リクエストを使用します。
例:GET https://10.10.10.10/api/v3/groups/_4L0PcE9SEemD69d9a0uLJQ/members
応答:グループのメンバーを表す serviceEntityApiDTO のリスト:
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/183b37c68211668aecd36eadcdce9110ebc58f85?include_asp ects=false"
}
],
"uuid": "183b37c68211668aecd36eadcdce9110ebc58f85", "displayName": "Olga",
"className": "VirtualDataCenter", "priceIndex": 1,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_h3Km4Bs3EemMFrqlXNi1yQ", "displayName": "vsphere-dc23.corp.vmturbo.com", "type": "vCenter"
},
"remoteId": "resgroup-96", "environmentType": "ONPREM"
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/2332ba0f9dc14c07f11adb38e12df43c4bc8ca56?include_asp ects=false"
}
],
"uuid": "2332ba0f9dc14c07f11adb38e12df43c4bc8ca56", "displayName": "olga_do_not_touch_1",
"className": "VirtualDataCenter", "priceIndex": 1,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_FJwg0EzHEemaXZFqO1sC0g", "displayName": "vsphere-dc11.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "resgroup-1088", "environmentType": "ONPREM"
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/6668eb0940bf970d24eb13279b31a52f3c44a91f?include_asp ects=false"
}
],
"uuid": "6668eb0940bf970d24eb13279b31a52f3c44a91f", "displayName": "Gilad",
"className": "VirtualDataCenter", "priceIndex": 1,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_lj_tkH39EeiKy53b3GBglA", "displayName": "vsphere-dc5.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "resgroup-1953", "environmentType": "ONPREM"
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/20b9e0acf4c6f7d5b00f744d1dc954616095f1f2?include_asp ects=false"
}
],
"uuid": "20b9e0acf4c6f7d5b00f744d1dc954616095f1f2", "displayName": "ACM",
"className": "VirtualDataCenter", "priceIndex": 1,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_lj_tkH39EeiKy53b3GBglA", "displayName": "vsphere-dc5.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "resgroup-v1946", "environmentType": "ONPREM"
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/56e6cfd2bc88ef5675df9dc3e06796ceb8b6e301?include_asp ects=false"
}
],
"uuid": "56e6cfd2bc88ef5675df9dc3e06796ceb8b6e301", "displayName": "olga_do_not_touch_7",
"className": "VirtualDataCenter", "priceIndex": 1,
"state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_GRNtoNu0Eeilt9UDtI29QA", "displayName": "vsphere-dc7.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "resgroup-1066", "environmentType": "ONPREM"
}
]
グループの設定を取得する
指定されたグループのグローバル設定とユーザーが変更した設定の両方を取得します。単一の設定を取得するには、リクエスト URL の一部として設定 UUID を渡します。このリクエストは、次のパラメータを取ります:
group_Uuid |
設定が返されるグループの Uuid |
include_settingspolices |
デフォルト:false。true の場合、設定に加えて、指定されたグループに影響する設定ポリシーを返します。 |
例:GET https://10.10.10.10/api/v3/groups/_WvaGkOBjEeierZ9b1bxmgg/settings? include_settingspolicies=false
応答:設定を表す SettingsManagerApiDTO のリスト、または指定されたグループの設定と設定ポリシー:
[
{
"uuid": "appsettingsmanager", "displayName": "Application Discovery", "category": "AppDiscovery",
"settings": [
{
"uuid": "Username", "displayName": "Username", "value": "",
"defaultValue": "", "valueType": "STRING", "entityType": "VirtualMachine", "sourceGroupName": "Global"
},
{
"uuid": "Password", "displayName": "Password", "value": "",
"defaultValue": "", "valueType": "STRING", "entityType": "VirtualMachine", "sourceGroupName": "Global"
},
...
},
{
"uuid": "controlmanager", "displayName": "Action Workflow", "category": "Automation", "settings": [
{
"uuid": "moveVMWorkflow", "displayName": "ワークフローの移動", "value": "",
"defaultValue": "", "valueType": "STRING", "entityType": "VirtualMachine", "sourceGroupName": "Global"
}
]
}
...
}
グループの指定設定を編集する
指定されたグループの指定された設定を編集します。このリクエストは、次のパラメータを取ります:
group_Uuid |
設定を編集するグループの Uuid |
settingsManager_Uuid |
設定を編集する設定マネージャの Uuid |
setting_Uuid |
変更する設定のUuid |
例:PUT https://10.10.10.10/api/v3/groups/_WvaGkOBjEeierZ9b1bxmgg/settings/ appsettingsmanager/Retry_Interval
入力例:
設定の新しい値:
{
"value": "61"
}
応答:変更された値を使用して、指定された設定を表す ServiceEntityApiDTO:
{
"uuid": "Retry_Interval", "displayName": "Retry Interval [mins]", "value": "61",
"defaultValue": "60.0", "valueType": "NUMERIC", "min": 0,
"max": 50000,
"entityType": "VirtualMachine", "sourceGroupName": "A_Few_ACM_VMs"
}
グループの設定ポリシーを取得する
指定されたグループの設定ポリシーを取得します。
例:
応答:
グループの統計の取得
指定されたグループのすべての統計を取得します:
注:
クラスタの統計を取得する場合、/groups エンドポイントを使用すると、該当するすべてのクラスタエンティティの集計された統計が返されます。エンティティごとの個々の統計については、/stats エンドポイントを使用します。
一部の統計は、特定の範囲でのみ有効です。それらを含まない範囲の特定の統計をリクエストすると、API はデータを返しません。たとえば、numVMs 統計はマーケット範囲とクラスタ範囲でのみ有効です。API は、他の範囲をクエリするときに応答から numVMs データを省略します。
例:https://10.10.10.10/api/v3/groups/_WvaGkOBjEeierZ9b1bxmgg/stats
応答:指定されたグループの統計を表す StatSnapshotApiDTO のリスト:
[
{
"displayName": "A_Few_ACM_VMs", "date": "2019-03-31T17:11:35-04:00",
"統計情報": [
{
"displayName": "(multiple)", "name": "priceIndex",
"values": {
"max": 1.44,
"min": 1.03,
"avg": 1.19,
"total": 4.77
},
"value": 1.19
},
{
"displayName": "(multiple)", "name": "Q1VCPU",
"capacity": {
"max": 20000,
"min": 20000,
"avg": 20000,
"total": 60000
},
"reserved": {
"max": 10000,
"min": 10000,
"avg": 10000,
"total": 30000
},
"filters": [
{
}
],
...
}
"type": "relation",
"value": "bought"
...
]
}
グループの統計のフィルタリングされたリストの取得
指定されたグループの統計のフィルタリングされたリストを取得します。POST や応答の例を含む、フィルタリングされた統計リストの作成の詳細については、「統計エンドポイントでのフィルタリングされた統計」(233ページ)を参照してください。
例:POST https://10.10.10.10/api/v3/groups/_WvaGkOBjEeierZ9b1bxmgg/stats
入力例:
{
"endDate": "-1d",
"startDate": "-1w", "statistics": [
{
"filters": [
{
"type": "relation",
"value": "bought"
}
]
}
]
}
応答:指定されたグループの統計を表す StatSnapshotApiDTO のリスト:
[
{
"displayName": "A_Few_ACM_VMs", "date": "2019-03-24T00:00:00-04:00",
"統計情報": [
{
"name": "Mem", "capacity": {
"max": |
134214448, |
"min": |
134214448, |
"avg": |
134214448, |
"total": 1073715580
},
"filters": [
{
"type": "relation",
"value": "bought"
}
],
"units": "KB", "values": {
"max": 2073084,
"min": 679782.1,
"avg": 1124840.4,
"total": 4499361.5
},
"value": 1124840.4
},
{
"name": "MemAllocation", "capacity": {
"max": |
504346624, |
"min": |
504346624, |
"avg": |
504346624, |
"total": 4034772990
},
"filters": [
{
"type": "relation",
"value": "bought"
}
],
"units": "KB", "values": {
"max": |
2073084, |
"min": |
679782.1, |
"avg": |
1124840.4, |
"total": 4499361.5
},
"value": 1124840.4
},
{
"name": "Q1VCPU",
"capacity": {
"max": 20000,
"min": 20000,
"avg": 20000,
"total": 120000
},
"filters": [
{
"type": "relation",
"value": "bought"
}
],
"values": {
"max": 90,
"min": 14,
"avg": 41.08,
"total": 123.23
},
"value": 41.08
}
...
]
}
]
エンティティのサプライチェーンの取得
次のパラメータの 1 つ以上を使用して、このリクエストによって返されるサプライチェーンをフィルタリングできます。
パラメータ |
説明 |
market_Uuid |
サプライチェーンが返されるマーケットの UUID |
タイプ |
サプライチェーンが返されるエンティティタイプ。次から選択します。 ■ BUSINESS_UNIT ■ CLOUD_SERVICE ■ コンテナ ■ データベース ■ DATABASE_SERVER ■ DATACENTER ■ DISK_ARRAY ■ PHYSICAL_MACHINE ■ ストレージ ■ VIRTUAL_MACHINE ■ スイッチ ■ VIRTUAL_DATACENTER |
パラメータ |
説明 |
|
■ シャーシ ■ STORAGE_CONTROLLER ■ IO_MODULE; IO モジュール ■ APPLICATION_SERVER ■ VIRTUAL_APPLICATION ■ ネットワーク ■ アプリケーション ■ コンテナ ■ CONTAINER_POD ■ LOGICAL_POOL ■ DPOD ■ VPOD ■ LOAD_BALANCER |
entity_states |
指定された状態のエンティティのみを返します。次から選択します。 ■ ACTIVE: エンティティはリソースを積極的に消費しています。 ■ EVACUATED: エンティティは一時停止の準備ができています。マーケットに参加しませんが、SUSPEND アクションを生成しません。 注:この状態は SUSPEND 状態を置き換えるものですが、有効にするには追加の構成が必要です。Workload Optimization Manager は、この状態を有効にすることを推奨していません。 ■ FAILOVER: このエンティティはフェールオーバー用に予約されており、マーケットに参加しません。 ■ IDLE: エンティティはパワーオフになっており、マーケットのリソースを積極的に消費していません。 ■ LAUNCH: エンティティは開始しています。 ■ MAINTENANCE: エンティティはメンテナンスモードです。 ■ NOT_MONITORED: エンティティは現在、Workload Optimization Manager によって監視されていません。 ■ QUEUED: エンティティは、ある状態から別の状態に変化する過程にあります。
注:この状態は Workload Optimization Manager の内部的なもので、UI には表示されませんが、エンティティの状態が変化しているちょうどその瞬間に呼び出しが実行された場合、API 応答に表示される場合があります。 ■ RESOURCE_ALLOCATION: クラウドエンティティを作成しています。 ■ RESOURCE_RELEASE: クラウドエンティティを削除しています。 ■ SUSPEND: エンティティが一時停止されているか、ゲスト OS がスリープ、スタンバイ、または一時停止状態です。エンティティは環境から削除されませんが、マーケットの決定には使用されません。マーケットの状況に基づいて、一時停止されたエンティティを開始し、マーケットに再び追加する場合があります。 ■ SUSPEND_PENDING: |
パラメータ |
説明 |
|
エンティティは一時停止の準備を行っているか、またはそのタイプで次に一時停止するエンティティです。 ■ TERMINATE_PENDING: エンティティは削除中です。 ■ UNKNOWN: Workload Optimization Manager は、エンティティの現在の状態を取得できません。これは、ハイパーバイザに対し、エンティティの状態が DISCONNECTED、ORPHANED、または INVALID であると報告されたときに発生します。. |
environment_type |
指定された環境タイプのエンティティに影響を与えるアクションのみを返します。[ CLOUD、HYBRID、ONPREM ]。 |
detail_type |
返されたサプライチェーンの各アイテムについて返された詳細レベル。[ compact、entity、aspects ]。 |
正常性 |
返されたサプライチェーンの正常性の簡単な要約を返します。 |
例:GET https://10.10.10.10/api/v3/groups/_WvaGkOBjEeierZ9b1bxmgg/supplychains? types=PhysicalMachine&entity_states=ACTIVE&entity_states=SUSPEND&entity_states=
MAINTENANCE&envir
応答:指定されたグループのサプライチェーンを表す SupplychainApiDTO:
"seMap": { "PhysicalMachine": {
"depth": 1,
"entitiesCount": 3、"healthSummary": {
"Minor": 1,
"Normal": 2
},
"stateSummary": { "ACTIVE": 3
},
"connectedProviderTypes": [
"DataCenter",
"Storage"
],
"instances": {
"34313836-3333-5553-4537-33364e385146": {
"links": [
{
spects=false"
}
],
"rel": "self",
"href": "https://10.10.10.10/api/v3/entities/34313836-3333-5553-4537-33364e385146?include_a
"uuid": "34313836-3333-5553-4537-33364e385146",
"displayName": "dc17-host-01.dev.mycorp.com", "className": "PhysicalMachine",
"priceIndex": 3.2925103, "state": "ACTIVE",
"severity": "Normal", "discoveredBy": {
"uuid": "_yXCEIF6hEeiNCKdg4ZVvVQ",
"displayName": "vsphere-dc17.dev.mycorp.com", "type": "vCenter"
},
"remoteId": "host-621", "environmentType": "ONPREM"
},
...
}
}
}
}
GroupBy フィールド基準
POST リクエストを使用してアクションとアクション統計を照会する場合、統計をグループ化するために使用できる groupBy パラメータがあります。このパラメータの有効な値は、エンティティタイプによって異なります:
注:
このフィールドを使用して inputDTO を送信する場合は、値のみが必要です。
例:"groupBy": "vmsByPMName"
{
"VirtualMachine":{
"criteria":[
{
"filterType":"vmsByName"
},
{
"filterType":"vmsByPMName"
},
{
"filterType":"vmsByStorage"
},
{
"filterType":"vmsByNetwork"
},
{
"filterType":"vmsByApplication"
},
{
"filterType":"vmsByDatabaseServer"
},
{
"filterType":"vmsByDatabaseServerVersion"
},
{
"filterType":"vmsByDC"
},
{
"filterType":"vmsByVDC"
},
{
"filterType":"vmsByDCnested"
},
{
"filterType":"vmsByNumCPUs"
},
{
"filterType":"vmsByMem"
},
{
"filterType":"vmsByGuestName"
},
{
"filterType":"vmsByAltName"
},
{
"filterType":"vmsByClusterName"
},
{
"filterType":"vmsByDiskArrayName"
},
{
"filterType":"vmsByLogicalPoolName"
},
{
"filterType":"vmsByProfileName"
},
{
"filterType":"vmsByTag"
},
{
"filterType":"vmsByState"
},
{
"filterType":"vmsByBusinessAccountUuid"
},
{
"filterType":"vmsByResourceGroupUuid"
}
]
},
"VirtualDataCenter":{
"criteria":[
{
"filterType":"vdcsByName"
},
{
"filterType":"vdcsByVDCName"
},
{
"filterType":"vdcsByTag"
},
{
"filterType":"vdcsByState"
}
]
},
"PhysicalMachine":{
"criteria":[
{
"filterType":"pmsByName"
},
{
"filterType":"pmsByStorage"
},
{
"filterType":"pmsByNetwork"
},
{
"filterType":"pmsBySwitch"
},
{
"filterType":"pmsByNumVms"
},
{
"filterType":"pmsByDC"
},
{
"filterType":"pmsByMem"
},
{
"filterType":"pmsByNumCPUs"
},
{
"filterType":"pmsByVendorName"
},
{
"filterType":"pmsByCPUModel"
},
{
"filterType":"pmsByModel"
},
{
"filterType":"pmsByTimezone"
},
{
"filterType":"pmsByClusterName"
},
{
"filterType":"pmsByTag"
},
{
"filterType":"pmsByState"
}
]
},
"Storage":{
"criteria":[
{
"filterType":"storageByName"
},
{
"filterType":"storageByTag"
},
{
"filterType":"storageByVMs"
},
{
"filterType":"storageByDC"
},
{
"filterType":"storageByPMCluster"
},
{
"filterType":"storageByState"
}
]
},
"Application":{
"criteria":[
{
"filterType":"appsByName"
},
{
"filterType":"appsByTag"
}
]
},
"ApplicationComponent":{ "criteria":[
{
"filterType":"appSrvsByName"
}
]
},
"WebServer":{
"criteria":[
{
"filterType":"wbSrvsByName"
}
]
},
"BusinessApplication":{ "criteria":[
{
"filterType":"busAppsByName"
}
]
},
"Database":{
"criteria":[
{
"filterType":"databaseByName"
},
{
"filterType":"databaseByTag"
},
{
"filterType":"databaseByBusinessAccountUuid"
},
{
"filterType":"databaseByResourceGroupUuid"
}
]
},
"DatabaseServer":{
"criteria":[
{
"filterType":"databaseServerByName"
},
{
"filterType":"databaseServerByTag"
},
{
"filterType":"databaseServerByBusinessAccountUuid"
},
{
"filterType":"databaseServerByEngine"
},
{
"filterType":"databaseServerByEdition"
},
{
"filterType":"databaseServerByVersion"
}
]
},
"VirtualApplication":{
"criteria":[
{
"filterType":"vappsByName"
}
]
},
"Cluster":{
"criteria":[
{
"filterType":"clustersByName"
},
{
"filterType":"clustersByTag"
}
]
},
"DataCenter":{
"criteria":[
{
"filterType":"datacentersByName"
},
{
"filterType":"datacentersByTag"
}
]
},
"Group":{
"criteria":[
{
"filterType":"groupsByName"
},
{
"filterType":"groupsByTargetName"
}
]
},
"StorageCluster":{
"criteria":[
{
"filterType":"storageClustersByName"
}
]
},
"DiskArray":{
"criteria":[
{
"filterType":"diskarrayByName"
}
]
},
"Zone":{
"criteria":[
{
"filterType":"zonsByName"
}
]
},
"Region":{
"criteria":[
{
"filterType":"regsByName"
}
]
},
"Network":{
"criteria":[
{
"filterType":"netsByName"
}
]
},
"LoadBalancer":{
"criteria":[
{
"filterType":"lbsByName"
}
]
},
"Chassis":{
"criteria":[
{
"filterType":"chasByName"
}
]
},
"IOModule":{
"criteria":[
{
"filterType":"ioModuleByName"
}
]
},
"StorageController":{
"criteria":[
{
"filterType":"storagecontrollerByName"
}
]
},
"DPod":{
"criteria":[
{
"filterType":"dpodByName"
}
]
},
"VPod":{
"criteria":[
{
"filterType":"vpodByName"
}
]
},
"LogicalPool":{
"criteria":[
{
"filterType":"logicalPoolByName"
}
]
},
"Switch":{
"criteria":[
{
"filterType":"switchByName"
}
]
},
"Container":{
"criteria":[
{
"filterType":"containersByName"
},
{
"filterType":"containersByVMName"
}
]
},
"ContainerPod":{
"criteria":[
{
"filterType":"containerpodsByName"
},
{
"filterType":"containerpodsByVMName"
}
]
},
"ServiceEntity":{
"criteria":[
{
"filterType":"workloadByBusinessAccountUuid"
},
{
"filterType":"workloadByResourceGroupUuid"
}
]
},
"Workload":{
"criteria":[
{
"filterType":"workloadByBusinessAccountUuid"
},
{
"filterType":"workloadByResourceGroupUuid"
}
]
},
"ResourceGroup":{
"criteria":[
{
"filterType":"resourceGroupByName"
},
{
"filterType":"resourceGroupByUuid"
},
{
"filterType":"resourceGroupByBusinessAccountUuid"
},
{
"filterType":"resourceGroupByTag"
}
]
},
"BusinessAccount":{
"criteria":[
{
"filterType":"businessAccountByName"
},
{
"filterType":"businessAccountByUuid"
},
{
"filterType":"subBusinessAccountOfUuid"
},
{
"filterType":"businessAccountValidationStatus"
},
{
"filterType":"businessAccountTargetName"
},
{
"filterType":"businessAccountCloudProvider"
}
]
},
"BillingFamily":{
"criteria":[
{
"filterType":"billingFamilyByName"
}
]
},
"ViewPod":{
"criteria":[
{
"filterType":"viewPodByName"
}
]
},
"DesktopPool":{
"criteria":[
{
"filterType":"desktopPoolByName"
},
{
"filterType":"desktopPoolByViewPod"
}
]
},
"BusinessUser":{
"criteria":[
{
"filterType":"businessUserByName"
},
{
"filterType":"businessUserByDesktopPool"
}
]
}
}
製品ライセンスによって、使用できる製品機能と、Workload Optimization Manager で管理できるワークロードの数が決まります。管理できるワークロード数を増やす場合には、Workload Optimization Manager のインストールにライセンスをさらに追加できます。複数のライセンスを使用する場合は、すべてが同じ機能セットをサポートする必要があることに注意してください。
どのような場合でも、営業担当者に連絡して、正しいライセンスを取得していること、およびライセンスを適切にインストールする方法を知っていることを確認する必要があります。
ライセンスエンドポイントを使用すると、次のことができます:
■ ライセンスサマリーの取得
■ Workload Optimization Manager アプライアンスに現在追加されているライセンスのリストの取得
■ ライセンスの追加
■ ライセンスの削除
ライセンスの取得
ライセンスのリストの取得。複数のライセンスを持つインスタンスの場合、ライセンス/サマリー リクエストは、ライセンスされたワークロードの合計を返します。たとえば、それぞれ 10,000 ワークロードに対して 2 つのライセンスがある場合、/licenses リクエストは両方の LicenseApiDTO をリストとして返します。/licenses/summary 呼び出しは、合計された 1 つの LicenseApiDTO を返します。これは、20,0000 ワークロードのキャパシティがあることを示します。
例:
■ ライセンスのリスト:GET https://10.10.10.10/api/v3/licenses
■ ライセンスサマリー:GET https://10.10.10.10/api/v3/licenses/summary
ライセンスの追加
Workload Optimization Manager のインストールにライセンスを追加します。オプションで、dryRun パラメータを指定できます。true に設定すると、ライセンスファイルは検証されますが、アプライアンスには適用されません。
注:
このリクエストには、入力としてマルチパートファイルが必要です。この要件により、この要求を Swagger から直接実行することはできません。
例:POST https://10.10.10.10/api/v3/licenses?file=%5Bobject%20File%5D&dryRun=true
ライセンスの削除
Workload Optimization Manager のインストールからライセンスを削除します。ライセンスを削除すると、ライセンスされたワークロードキャパシティが現在の使用量を下回る場合があります。この場合、より多くのワークロードキャパシティが利用可能になるまで、ターゲットを追加することはできません。
例:DELETE https://10.10.10.10/api/v3/licenses/_I_WVcJtWEeiGEs_doVlDOw
現時点では、ログエンドポイントは実装されていません。
Workload Optimization Manager は、マーケットベースの分析を使用してワークロード管理を実行します。これを行うには、環境のモデルを構築し、各エンティティをマーケットの買い手と売り手として表します。このモデルには、名前付きのマーケットリソースを介してアクセスできます。マーケットには 2 つのタイプがあります:
■ リアルタイムマーケット
リアルタイムマーケットは、環境の分析とワークロード管理を実行します。リアルタイムマーケットを使用してエンティティにアクセスし、エンティティに関する現在または過去のデータを取得できます。
リアルタイムマーケットの displayName は Market です。このマーケットは常に RUNNING 状態でなければなりません。API を使用してこのマーケットを止めようとしないでください。
Workload Optimization Manager は、検出を実行して、管理するトポロジ(リアルタイムマーケットのエンティティのコレクション)にデータを取り込みます。このため、リアルタイムマーケットでは、エンティティの追加または削除 API を使用しないでください。
■ プランマーケット
プランマーケットは、リアルタイムマーケットのスナップショットとして始まります。シナリオをリアルタイムマーケットに POST すると、Workload Optimization Manager がリアルタイムマーケットのコピーを作成して、プランマーケットを作成します。このプランマーケットは、シナリオで宣言された変更を除いて、リアルタイムマーケットと同じです。たとえば、シナリオでプランの範囲が宣言されている場合、プランマーケットにはその範囲内のエンティティのみが含まれます。
Workload Optimization Manager は、これ以上意味のある改善が行われなくなるまで、このプランマーケットに対して経済サイクル (売買サイクル) を実行します。この時点で、プランの実行が完了します。
Workload Optimization Manager がプランマーケットを作成すると、そのマーケットは削除するまでメモリに残ることに注意してください。また、後でシナリオをプランマーケットに適用できることにも注意してください。これは、計画に基づいてプランを実行する方法です。同じロジックフローで、Workload Optimization Manager は、分析を実行するためにさらに別のプランマーケットを作成します。
このエンドポイントには、特定の操作の開始時間と終了時間への参照が含まれています。有効な時間形式を含む詳細については、Workload Optimization Manager API の「時間」(17 ページ) を参照してください。
Workload Optimization Manager API の market エンドポイントを使用すると、次のことができます:
■ マーケットのリストを取得する
■ プランマーケットを保存または停止する
■ プランマーケットを削除する
■ プランマーケットに配置されていないエンティティを表示する
■ 特定のマーケットのアクション、エンティティ、通知、ポリシー、予約、および統計のフィルタリングされたリストとフィルタリングされていないリストを取得する
■ リアルタイムマーケットでの配置ポリシーの取得、編集、削除
主要マーケットのステータスの決定
Workload Optimization Manager インスタンスを再起動すると、リアルタイムマーケットが環境のトポロジの初期化とロードを完了する前に、UI と API が使用可能になる場合があります。マーケットのステータスを確認するには、マーケットの UUID を指定して GET /markets/market_uuid リクエストを実行します。
マーケットに関する情報が返された場合は、初期化されています。リアルタイムマーケットが初期化されていない場合、次の応答が返されます。
{
"type":400,
"exception":"com.vmturbo.api.exceptions.OperationFailedException: Infrastructure is not controlled yet. Could not get market.",
"message":"Infrastructure is not controlled yet. Could not get market."
}
マーケットのリストを取得する
Workload Optimization Manager アプライアンスに現在保存されているすべてのマーケットを返します。単一のマーケットの詳細を取得するには、リクエストにマーケットの UUID を含めます。
注:
マーケットには、マーケットの displayName があります。このマーケットはリアルタイムマーケットです。API を使用してこのマーケットにエンティティを直接追加または削除したり、このマーケットで STOP アクションを実行したりしないでください。
例:
■ すべてのマーケット:GET https://10.10.10.10/api/v3/markets
■ 単一のマーケット:GET https://10.10.10.10/api/v3/markets/_0x3OYUglEd-gHc4L513yOA
応答:アプライアンスのマーケットを表す MarketApiDTO のリスト。
[
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/markets/_0x3OYUglEd-gHc4L513yOA"
}
],
"uuid":"_0x3OYUglEd-gHc4L513yOA", "displayName":"Market", "className":"Market", "state":"RUNNING",
"unplacedEntities":false, "environmentType":"HYBRID"
},
...
]です
プランマーケットの停止または保存
トラブルシューティングのために、実行に時間がかかっている、または完了していないように見えるプランマーケットを、停止または保存することが必要な場合があります。これらの操作は、リアルタイムマーケットでは使用しないでください。手動で停止されたプランマーケットには、不完全なデータが含まれている可能性があることに注意してください。
このリクエストは、次のパラメータを取ります:
market_Uuid |
停止または保存されるマーケットの UUID。 |
動作 |
マーケットで実行する操作。[ stop, save ] |
例:POST https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw?operation=stop
応答:指定されたマーケットの MarketApiDTO で、その状態が STOPPING であることを示しています。
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw"
},
{
"rel": "Market notifications",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw/notifications"
},
{
"rel": "Market actions",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw"
},
{
"rel": "To Entities",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw/entities"
},
{
"rel": "To Constraints",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw/entities"
},
{
"rel": "To Reservations",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw/reservations"
},
{
"rel": "To Statistics",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw/stats"
},
{
"rel": "To Unplaced Entities",
"href": "https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw/unplacedentities"
},
{
"rel": "To Market List",
"href": "https://10.10.10.10/api/v3/entities"
}
],
"uuid": "_NO8_sCi_EemDHtuQzfdzxw",
"displayName": "ADD_WORKLOAD_administrator_1549313730114", "className": "Market",
"state": "STOPPING",
"scenario": {
"uuid": "2452690315520",
"displayName": "Add Workload 1", "owners": [],
"type": "ADD_WORKLOAD"
},
"unplacedEntities": false,
"runDate": "2019-02-04T15:55:30-05:00",
"environmentType": "ONPREM"
}
プランマーケットの削除
プランマーケットを削除すると、マーケットエンティティが、アクション、通知、エンティティ、ポリシー、予約などのすべてのトポロジリンクとともに削除されます。この操作は永続的です。プランマーケットを削除するには、リクエストでマーケットの UUID を渡します。
このリクエストは、次のパラメータを取ります:
market_Uuid |
削除されるマーケットの UUID。 |
例:DELETE https://10.10.10.10/api/v3/markets/_NO8_sCi_EemDHtuQzfdzxw
応答:指定されたマーケットの MarketApiDTO で、その状態が DELETING であることを示しています。
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/markets/2452692215536"
}
],
"uuid":"2452692215536",
"displayName":"ADD_WORKLOAD_administrator_1549313730114", "className":"Market",
"state":"DELETING",
"scenario":{
"uuid":"2452692204928",
"displayName":"Add Workload 1", "owners":[
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/users/_4T_7kwY-Ed-WUKbEYSVIDw"
}
],
"uuid":"_4T_7kwY-Ed-WUKbEYSVIDw", "displayName":"Administrator User", "username":"administrator", "roleUuid":"_4UAioQY-Ed-WUKbEYSVIDw", "roleName":"administrator", "loginProvider":"Local", "type":"DedicatedCustomer", "showSharedUserSC":false
}
],
"type":"ADD_WORKLOAD"
},
"saved":true,
"unplacedEntities":false, "runDate":"2019-02-04T15:55:30-05:00",
"runCompleteDate":"2019-02-04T15:57:26-05:00",
"environmentType":"ONPREM"
}
マーケットのアクションのフィルタリングされたリストの取得
マーケット UUID を指定し、次の 1 つ以上の条件を使用して ActionApiInputDTO によってフィルタリングされたアクションのリストを取得します。
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: 指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 ■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するようWorkload Optimization Manager に指示したことを示します。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモードです。 |
actionStateList |
■ DISABLED: ポリシーが無効になっているアクション。 ■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 ■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: 1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にします。前のアクションが完了すると実行されます。 |
actionTypeList |
■ START: |
基準 |
説明 |
|
エンティティを開始し、Workload Optimization Manager マーケットに追加します。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動します。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。マーケットの状況に基づいて、分析は、 中断されたエンティティの再開を推奨し、再びマーケット分析に含めることがあります。 ■ ADD PROVIDER: これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE:: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨します。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨することがあります。 ■ DELETE: これは SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合、これは特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを減らすサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false. true の場合、実行される前にアクションリストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false。 true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: |
基準 |
説明 |
|
クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstanc |
デフォルト:false。 true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連するエンティティタイプとして VirtualMachine を指定した場合、要求には、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
このリクエストは、次のパラメータを取ります:
market_Uuid |
アクションが返されるマーケットの UUID。 |
カーソル |
追加の結果を取得するために後続の呼び出しを行う場合、これは、このメソッドへの最後の呼び出しによって返されたカーソルです。 |
limit |
返される最大アイテム数。正の整数でなければなりません。設定されていない場合、サーバーはデフォルト(20)を使用します。 |
order-by |
結果を並べ替えるフィールド。[ creation_date, name, risk_category, savings, severity ]。 |
昇順 |
デフォルト:true。false の場合、結果は降順になります。 |
例:POST https://10.10.10.10/api/v3/markets/Market/actions? order_by=severity&ascending=true
入力例:この例では、次の条件を満たすアクションのリストが返され、
actionMode で返され、重大度順にグループ分けされます。
■ 状態は PENDING_ACCEPT
■ オンプレミス環境の一部である
■ 仮想マシンのアクション
■ Workload Optimization Manager のリアルタイムマーケットによって生成されたアクション
{
"actionInput":{
"actionStateList":[
"PENDING_ACCEPT"
],
"environmentType":"ONPREM", "groupBy":[
"actionModes"
]
},
"relatedType":"VirtualMachine", "scopes":[
"Market"
]
}
応答:指定された条件を満たす ActionApiDTO のリスト。
{
..
"uuid": "_qFuM8CiOEemDHtuQzfdzxw", "createTime": "2019-02-04T10:07:58-05:00",
"actionType": "RIGHT_SIZE", "actionState": "PENDING_ACCEPT", "actionMode": "MANUAL",
"details": "Scale VirtualMachine 8f0e3136-b259-43e5-41f8-0d2c64c62acc from Standard_B2ms to Standar d_E2s_v3",
"importance": 0
...
}
マーケットのアクションのフィルタリングされたリストの統計を取得する
参照エンドポイント:アクション(29 ページ)参照エンドポイント:統計(233 ページ)
フィルタ処理されたアクションのリストの統計のリストを取得します。返される統計には、アクションの数、総貯蓄/投資、アクションの影響を受けるエンティティの数が含まれます。マーケット UUID に加えて、次の条件の 1 つ以上を使用して ActionApiInputDTO を提供します:
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: 指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 ■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するようWorkload Optimization Managerに指示しました。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモード。 |
actionStateList |
■ DISABLED: ポリシーが無効になっているアクション。 ■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 |
基準 |
説明 |
|
■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: 1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にします。前のアクションが完了すると実行されます。 |
actionTypeList |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加します。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動します。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。マーケットの状況に基づいて、分析は、中断されたエンティティの再開を推奨し、再びマーケット分析に含めることがあります。 ■ ADD PROVIDER: これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE:: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨します。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨することがあります。 ■ DELETE: SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: |
基準 |
説明 |
|
予約機能を使用する場合、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合、これは特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを減らすサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false。 true の場合、実行される前にアクション リストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false。 true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstance |
デフォルト:false。 true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連するエンティティタイプとして VirtualMachine を指定した場合、要求には、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
例:POST https://10.10.10.10/api/v3/actions
入力例:この例では、次の条件を満たすアクションのリストが、アクションの actionMode で返され、重大度順にグループ分けされます。
■ 状態は PENDING_ACCEPT
■ オンプレミス環境の一部である
■ 仮想マシンのアクションである
■ Workload Optimization Manager のリアルタイムマーケットによって生成されたアクション
{
"actionInput":{
"actionStateList":[
"PENDING_ACCEPT"
],
"environmentType":"ONPREM", "groupBy":[
"actionModes"
]
},
"relatedType":"VirtualMachine", "scopes":[
"Market"
]
}
応答:フィルタリングされたアクションに関する統計を含む StatSnapshotApiDTO のリスト。
[
{
"date":"2019-02-05T14:40:08-05:00",
"statistics": [
{
"name":"numActions", "values":{
"max":268,
"min":268,
"avg":268, "total":268
},
"value":268
},
{
"name": "costPrice", "filters": [
{
"type":"property", "value":"savings"
}
],
"units":"$", "values":{
"max":24100,
"min":24100,
"avg":24100,
"total":24100
},
"value":24100
},
...
]
}
]
マーケット内のすべてのエンティティの取得
指定されたマーケットのすべてのエンティティのリストを取得します。このリクエストは、プランマーケットで使用されるエンティティのリストを取得するために使用できます。
例:GET https://10.10.10.10/api/v3/markets/2452692215536/entities
応答:グループのメンバーを表す ServiceEntityApiDTO のリスト:この場合、realtimeMarketRefrence というタイトルの属性があることに注意してください。これは、これらがプラン マーケットからのエンティティであるためです。
[
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/entities/_QQVtEyi_EemDHtuQzfdzxw?include_aspects=false"
}
],
"uuid":"_QQVtEyi_EemDHtuQzfdzxw", "displayName":"osp-master-2", "className":"VirtualMachine", "priceIndex":3.6063216, "state":"ACTIVE",
"severity":"Normal", "realtimeMarketReference":{
"uuid":"42000c5d-9ae5-44f0-252c-daabbb423a86"
},
"environmentType":"ONPREM"
},
...
]です
マーケット内のエンティティの統計の取得
参照エンドポイント:統計(233 ページ)
指定されたマーケットのエンティティに関連する統計を取得します。たとえば、このリクエストを使用して、プランマーケットのエンティティの最終的に計算された統計を表示できます。POST と応答の例を含む、フィルタリングされた統計リストの作成の詳細については、「統計エンドポイントでのフィルタリングされた統計」(233ページ)を参照してください。
マーケット内の特定のエンティティグループの統計の取得
参照エンドポイント:統計(233 ページ)
参照エンドポイント:グループ(91 ページ)
指定されたマーケットのエンティティの特定のグループに関連する統計を取得します。たとえば、このリクエストを使用して、プランマーケットのホスト グループの最終的に計算された統計を表示できます。POST と応答の例を含む、フィルタリングされた統計リストの作成の詳細については、「統計エンドポイントでのフィルタリングされた統計」(233ページ)を参照してください。
マーケットのポリシーを取得する
指定されたマーケットに影響を与える現在のすべてのポリシーのリストを返します。プランマーケットの場合、これは、プラン構成で作成、有効化、無効化、または変更したポリシーのリストです。リアルタイムマーケットの場合、これはアプライアンスで現在利用可能なポリシーのリストです。単一のポリシーを取得するには、リクエストにポリシーの UUID を含めます。
例:
■ すべてのポリシー:GET https://10.10.10.10/api/v3/markets/2481646239616/policies
■ 単一のポリシー:
GET https://10.10.10.10/api/v3/markets/2481646239616/policies/_z3LKSTk0EemeycL7hWgJNw
応答:要求されたポリシーを表す PolicyApiDTO のリスト。
[
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/policies/_z3LxVzk0EemeycL7hWgJNw"
}
],
"uuid":"_z3LxVzk0EemeycL7hWgJNw", "displayName":"DalTestPolMerge", "type":"MERGE",
"name":"DalTestPolMerge", "enabled":true, "commodityType":"ClusterCommodity", "mergeType":"Cluster", "mergeGroups":[
{
"uuid":"91ff08749fd278925d73b61b0f0f69d79c99fc3a", "displayName":"PMs_Beta DC6\\Cluster-1", "className":"Group", "groupType":"PhysicalMachine",
"isStatic":true, "logicalOperator":"AND"
},
{
"uuid":"8c17d8e79c3db85ed5d3868de622cb89187849ce", "displayName":"PMs_Beta DC6\\Cluster-2", "className":"Group", "groupType":"PhysicalMachine",
"isStatic":true, "logicalOperator":"AND"
}
]
},
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/policies/_z3LKSTk0EemeycL7hWgJNw"
}
],
"uuid":"_z3LKSTk0EemeycL7hWgJNw",
"displayName":"CommSegmentation/SegmentManager 4T_7kwY-Ed-WUKbEYSVIDw_1551123454966", "type":"MUST_RUN_TOGETHER",
"name":"CommSegmentation/SegmentManager 4T_7kwY-Ed-WUKbEYSVIDw_1551123454966", "enabled":false,
"capacity":1000000000, "commodityType":"DrsSegmentationCommodity", "consumerGroup":{
"uuid":"_z2M57Dk0EemeycL7hWgJNw",
"displayName":"Buyers-Group-GROUP-DRS-KTG-rule/DC13-Cluster/vsphere-dc13.dev.mycorp.com", "className":"DiscoveredGroup",
"groupType":"VirtualMachine", "isStatic":true, "logicalOperator":"AND"
},
"providerGroup":{
"uuid":"_z2M57zk0EemeycL7hWgJNw",
"displayName":"Sellers-Group-GROUP-DRS-KTG-rule/DC13-Cluster/vsphere-dc13.dev.mycorp.com", "className":"DiscoveredGroup",
"groupType":"PhysicalMachine", "isStatic":true, "logicalOperator":"AND"
}
},
...
]
マーケットの配置ポリシーの削除
ポリシーとマーケットの UUID を指定して、指定されたポリシーを削除します。インポートされたポリシーを削除しても、インポート元のターゲットの次の検出サイクルの後に再表示されることに注意してください。インポートされたポリシーを削除するには、ターゲットで直接削除します。
例:DELETE https://10.10.10.10/api/v3/markets/2481646239616/policies/
_z3LxVzk0EemeycL7hWgJNw
応答:削除要求が成功すると、応答コード 200 が返されます。
マーケットの予約を取得する
指定されたマーケットの現在のすべての予約のリストを返します。リアルタイムマーケットの場合、これはアプライアンスで現在アクティブな予約のリストです。
例:GET https://10.10.10.10/api/v3/markets/Market/reservations
応答:現在の予約を表す DemandReservationApiDTO のリスト。
[
{
"uuid":"_I6z38Tk8EemeycL7hWgJNw", "displayName":"DalRes2",
"count":1,
"status":"RESERVED",
"reserveDateTime":"Mon Feb 25 15:30:07 EST 2019",
"expireDateTime":"Mon Mar 25 08:29:54 EDT 2019",
"deployDateTime":"Tue Mar 26 08:29:54 EDT 2019", "reserveCount":1,
"deployCount":0, "demandEntities":[
{
"uuid":"_JEZRwTk8EemeycL7hWgJNw", "displayName":"DalRes2_C0", "className":"VirtualMachine", "template":{
"uuid":"T-ef47f3dbdde39f888052332cbe7d0cf2", "displayName":"AVG:PMs_ACM\\ACM Cluster for last 10 days", "className":"VirtualMachineProfile"
},
"placements": { "computeResources": [
{
"stats":[
{
"name":"numOfCpu", "value":2
},
{
"name":"cpuSpeed",
"units":"MHz", "value":5320
},
{
"name":"cpuConsumedFactor", "units":"%", "value":4.2516437
},
{
"name":"memorySize", "units":"MB", "value":6631
},
{
"name":"memoryConsumedFactor", "units":"%",
"value":46.328953
},
{
"name":"ioThroughput", "units":"MB/s", "value":0.05301181
},
{
"name":"networkThroughput", "units":"MB/s", "value":0.103116125
}
],
"provider":{
"uuid":"30333436-3638-5355-4532-313159335631",
"displayName":"hp-dl571.dev.mycorp.com", "className":"PhysicalMachine"
}
}
],
"storageResources":[
{
"stats":[
{
"name":"diskSize",
"units":"GB", "value":92.468285
},
{
"name":"diskIops", "value":1.6827557
}
],
"provider":{
"uuid":"5a822e24-584bce98-ecb2-441ea15e2534", "displayName":"SCIO:ESXDC11DS2", "className":"Storage"
}
}
]
}
}
]
}
]
マーケットでのシナリオの実行
リアルタイムマーケットでシナリオを実行すると、シナリオの結果を示すプランマーケットが作成されます。プランマーケットの 2 番目のシナリオを実行する場合、それは「計画上のプラン」の実行と呼ばれます。これは、すでにプラン実行の結果であるマーケットでプランの新しい構成を実行します。
例:POST https://10.10.10.10/api/v3/markets/Market/scenarios/2452690315520? ignore_constraints=false
応答:市場の新しい状態を示す MarketApiDTO - 成功した場合、COPYING。
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw"
},
{
"rel":"Market notifications", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/notifications"
},
{
"rel":"Market actions", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/actions?ascending=true"
},
{
"rel":"To Entities", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/entities"
},
{
"rel":"To Constraints", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/policies"
},
{
"rel":"To Reservations", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/reservations"
},
{
"rel":"To Statistics", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/stats"
},
{
"rel":"To Unplaced Entities", "href":"https://10.10.10.10/api/v3/markets/_ps_iUDlBEemeycL7hWgJNw/unplacedentities"
},
{
"rel":"To Market List", "href":"https://10.10.10.10/api/v3/markets"
}
],
"uuid":"_ps_iUDlBEemeycL7hWgJNw", "displayName":"API_Plan_Market", "className":"Market", "state":"COPYING",
"scenario":{
"uuid":"2452690315520",
"displayName":"Add Workload 1", "owners":[
], "type":"ADD_WORKLOAD"
},
"unplacedEntities":false, "runDate":"2019-02-25T16:09:34-05:00",
"environmentType":"ONPREM"
}
マーケットの統計を取得する
指定されたマーケットに関する統計を取得します。この呼び出しを使用して、リアルタイムマーケットの統計を表示したり、シナリオが適用された後にプランマーケットで結果の統計を表示したりできます。
例:GET https://10.10.10.10/api/v3/markets/Market/stats
応答:リアルタイムマーケットの統計を表す StatSnapshotApiDTO のリスト。
[
{
"displayName":"PMs",
"date":"2019-02-23T00:00:00-05:00",
"statistics":[
{
"name":"CPUHeadroom", "capacity":{
"max":8610,
"min":0,
"avg":1602.22,
"total":14420
},
"units":"VM", "values":{
"max":8595,
"min":0,
"avg":1571.44,
"total":14143
},
"value":1571.44
},
{
"name":"CPUExhaustion", "units":"Day", "values":{
"max":2147483650,
"min":0, "avg":2147483650, "total":2147483650
}, "value":2147483650
},
...
...
]です
マーケットのフィルタリングされた統計リストの取得
参照エンドポイント:統計 (233 ページ)
このリクエストに inputDTO として渡す必要がある StatPeriodApiInputDTO の基準によってフィルタリングされた、指定されたマーケットに関する統計のリストを取得します。POST と応答の例を含む、フィルタリングされた統計リストの作成の詳細については、「統計エンドポイントでのフィルタリングされた統計」(233ページ)を参照してください。
例:
入力例:
応答:マーケットのフィルタ処理された統計を表す StatSnapshotApiDTO の配列。
マーケットのサプライチェーンを取得する
次のパラメータの 1 つ以上を使用して、このリクエストによって返されるサプライチェーンをフィルタリングできます。
パラメータ |
説明 |
market_Uuid |
サプライチェーンが返されるマーケットの UUID |
タイプ |
サプライチェーンが返されるエンティティタイプ。次から選択します。 ■ BUSINESS_UNIT ■ CLOUD_SERVICE ■ コンテナ ■ データベース ■ DATABASE_SERVER ■ DATACENTER ■ DISK_ARRAY ■ PHYSICAL_MACHINE ■ ストレージ ■ VIRTUAL_MACHINE ■ スイッチ ■ VIRTUAL_DATACENTER ■ シャーシ ■ STORAGE_CONTROLLER ■ IO_MODULE; IO モジュール ■ APPLICATION_SERVER ■ VIRTUAL_APPLICATION ■ ネットワーク ■ アプリケーション ■ コンテナ ■ CONTAINER_POD ■ LOGICAL_POOL ■ DPOD ■ VPOD ■ LOAD_BALANCER |
entity_states |
指定された状態のエンティティのみを返します。次から選択します。 ■ ACTIVE: エンティティはリソースを積極的に消費しています。 ■ EVACUATED: エンティティは一時停止の準備ができています。マーケットに参加しませんが、SUSPEND アクションを生成しません。 注:この状態は SUSPEND 状態を置き換えるものですが、有効にするには追加の構成が必要です。Workload Optimization Manager は、この状態を有効にすることを推奨していません。 ■ FAILOVER: このエンティティはフェールオーバー用に予約されており、マーケットに参加しません。 ■ IDLE: エンティティはパワーオフになっており、マーケットのリソースを積極的に消費していません。 ■ LAUNCH: エンティティは開始しています。 ■ MAINTENANCE: |
パラメータ |
説明 |
|
エンティティはメンテナンスモードです。 ■ NOT_MONITORED: エンティティは現在、Workload Optimization Manager によって監視されていません。 ■ QUEUED: エンティティは、ある状態から別の状態に変化する過程にあります。
注:この状態は Workload Optimization Manager の内部的なもので、UI には表示されませんが、エンティティの状態が変化しているちょうどその瞬間に呼び出しが実行された場合、API 応答に表示される場合があります。 ■ RESOURCE_ALLOCATION: クラウドエンティティを作成しています。 ■ RESOURCE_RELEASE: クラウドエンティティを削除しています。 ■ SUSPEND: エンティティが一時停止されているか、ゲスト OS がスリープ、スタンバイ、または一時停止状態です。エンティティは環境から削除されませんが、マーケットの決定には使用されません。マーケットの状況に基づいて、一時停止されたエンティティを開始し、マーケットに再び追加する場合があります。 ■ SUSPEND_PENDING: エンティティは一時停止の準備を行っているか、またはそのタイプで次に一時停止するエンティティです。 ■ TERMINATE_PENDING: エンティティは削除中です。 ■ UNKNOWN: Workload Optimization Manager は、エンティティの現在の状態を取得できません。これは、ハイパーバイザに対し、エンティティの状態が DISCONNECTED、ORPHANED、または INVALID であると報告されたときに発生します。 |
environment_type |
指定された環境タイプのエンティティに影響を与えるアクションのみを返します。[ CLOUD, HYBRID, ONPREM ]. |
detail_type |
返されたサプライチェーンの各アイテムについて返された詳細レベル。[ compact、entity、aspects ]。 |
正常性 |
返されたサプライチェーンの正常性の簡単な要約を返します。 |
例:GET https://10.10.10.10/api/v3/markets/Market/supplychains?types=VirtualMachine& entity_states=RESOURCE_ALLOCATION&entity_states=ACTIVE&environment_type=ONPREM&detail_type=aspec
応答:基準を満たすエンティティを表す SupplychainApiDTO。上記の例では、ONPREM 環境で ACTIVE または RESOURCE_ALLOCATION 状態の仮想マシンを含むサプライチェーンと、ヘルスチェックがリクエストの最後に含まれます。
{
"seMap":{
"VirtualMachine":{
"depth":-1, "entitiesCount":335, "healthSummary":{
"Major":6,
"Minor":148, "Normal":181
},
"stateSummary":{ "ACTIVE":335
},
"connectedProviderTypes":[ "PhysicalMachine", "Storage", "VirtualDataCenter"
],
"connectedConsumerTypes":[
"Application"
],
"instances":{
"421edc7a-761d-9a79-9378-7140caecd50f":{
"links":[
{
lude_aspects=false"
}
"rel":"self",
"href":"https://10.10.10.10/api/v3/entities/421edc7a-761d-9a79-9378-7140caecd50f?inc
],
"uuid":"421edc7a-761d-9a79-9378-7140caecd50f", "displayName":"vm-max-test-netapp", "className":"VirtualMachine", "priceIndex":1.0070138,
"state":"ACTIVE",
"severity":"Normal", "discoveredBy":{
"uuid":"_8c98wBwnEem2J-ksdl1CgA", "displayName":"vsphere-dc7.dev.mycorp.com", "type":"vCenter"
},
"remoteId":"vm-281", "aspects":{
"virtualMachineAspect":{
"os":"SUSE Linux Enterprise 11 (64-bit)", "connectedNetworks":[
{
"uuid":"7d6d67a50cfe1979797de159220841a37a55a50c", "displayName":"VM network"
}
],
"numVCPUs":1, "ebsOptimized":false
}
},
]です
...
...
...
}
"environmentType":"ONPREM"
} ...
配置されていないエンティティ
Workload Optimization Manager でプランを実行すると、ワークロードを追加したり、インフラストラクチャを削除したりできます – 残りのリソースがワークロードに対して十分でない場合、エンティティは「配置されない」可能性があります。Workload Optimization Manager は、配置されていないワークロードの配列を提供します。
注:例は後ほど公開されます。
以前に実行されたプランマーケットを見つける
Workload Optimization Manager の UI では、プランが 1 つのアイテムのように見えますが、実際にはそうではありません。プランは 2 つの部分で構成されます。
■ プランの構成オプションを表すシナリオプラン構成の詳細については、「シナリオ」(163ページ)を参照してください。
■ シナリオの実行時に作成されるプランマーケット – これには、プラン後のマーケットの状態を構成するアクション、通知などが含まれます。
プランマーケットを発見する最も簡単な方法は、GET https://10.10.10.10/api/v3/markets を実行し、主要な市場を無視することです。メインマーケットの DTO エントリは次のようになります。
{
"uuid":"777777",
"displayName":"Market", "className":"Market",
"state":"RUNNING",
"stateProgress":100, "unplacedEntities":false, "environmentType":"HYBRID"
}
リクエストが返す他のマーケットはプランマーケットです。プランマーケットの DTO は次のようになります。
{
"uuid":"214172431889696",
"displayName":"Add Workload 2", "className":"Market", "state":"SUCCEEDED",
"stateProgress":100, "scenario":{
"uuid":"214172431885856"、
"displayName":"Add Workload 2", "owners":[
{
"uuid":"2993567556912"、
"showSharedUserSC":false
}
]
...
}
最も外側の uuid パラメータと displayName パラメータは、プラン マーケットの UUID と表示名です。state フィールドには、計画実行の結果が表示されます。SUCCEEDED は計画が正常に終了したことを意味し、FAILED は計画の実行が終了しなかったことを意味します。通常は、ユーザーによってキャンセルされたためです。
プラン自体のシナリオ パラメータには、マーケットで使用されているシナリオに関する情報が含まれています。内部の uuid と displayName は、シナリオの UUID と表示名であり、このシナリオを使用して作成されたすべての市場を表示するために使用できることに注意してください。
最後に、上記の /markets 呼び出しとその戻りを繰り返し、各マーケットを調べてシナリオの UUID(この場合は 214172431889696)を比較すると、シナリオが実行された回数と、またその実行結果を含む各マーケットを確認できます。
通知は、Workload Optimization Manager インスタンスからのシステムメッセージとマーケットメッセージです。
このエンドポイントには、特定の操作の開始時間と終了時間への参照が含まれています。有効な時間形式を含む詳細については、Workload Optimization Manager API の「時間」(17 ページ)を参照してください。
通知エンドポイントを使用すると、次のことができます。
■ すべての通知の取得
■ 通知のフィルタリングされたリストの取得
■ 指定した通知に関連するアクションの取得
通知カテゴリ
Workload Optimization Manager インスタンスからの各通知は、次の特定のカテゴリに属します。
■ ディスカバリ
■ モニタリング
■ 制御
■ 調停
■ ヘルスチェック
■ InterAppliance
■ MarketAction
■ MarketProblem
■ プレゼンテーション
■ 展開
■ セキュリティ
通知の取得
システムおよびマーケットレベルの通知のリストを取得します。通知のリストの場合、API は LogEntryApiDTO の配列を返します。各 LogEntryApiDTO には、通知の時刻、状態、重大度、重要度など、通知に関する詳細が含まれます。単一の通知を取得するには、リクエストに通知の UUID を含めます。
このリクエストは、次のパラメータを取ります:
start_time |
通知の履歴範囲の開始時刻。 |
end_time |
通知の履歴範囲の終了時刻。 |
category |
返される通知のカテゴリ。[Discovery, Monitoring, Control, Mediation, Healthcheck, InterAppliance, MarketAction, MarketProblem, Presentation, Deploy, Security] |
カーソル |
追加の結果を取得するために後続の呼び出しを行う場合、これは、このメソッドへの最後の呼び出しによって返されたカーソルです。 |
limit |
返される最大アイテム数。正の整数でなければなりません。設定されていない場合、サーバーはデフォルト(20)を使用します。 |
order-by |
結果を並べ替えるフィールド。この値は、応答で見つかった任意のフィールドにすることができます。 |
昇順 |
デフォルト:true。false の場合、結果は降順になります。 |
例:
■ すべての通知(パラメータなし):GET https://10.10.10.10/api/v3/notifications
■ すべての通知(パラメータ):GET https://10.10.10.10/api/v3/notifications? start_time=1237056032&end_time=1238056032&limit=100&order_by=name&ascending=true
■ 単一の通知:GET https://10.10.10.10/api/v3/notifications/_5wcf4J5WEeinZ-6Uu4soUw
応答:
[
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/notifications/_5wcf4J5WEeinZ-6Uu4soUw"
}
],
"uuid":"_5wcf4J5WEeinZ-6Uu4soUw", "logActionTime":1534095671518,
"targetSE":"Hyper-V:hp-cluster.corp.mycorp.com", "category":"Discovery", "subCategory":"Validation",
"description":"Validation of target hp-cluster.corp.mycorp.com failed", "shortDescription":"Validation Failed",
"state":"NOTIFY",
"severity":"MAJOR", "importance":0
},
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/notifications/_sQ7xUJ5XEeinZ-6Uu4soUw"
}
],
"uuid":"_sQ7xUJ5XEeinZ-6Uu4soUw", "logActionTime":1534096010470,
"targetSE":"Hyper-V:hp-cluster.corp.mycorp.com", "category":"Discovery", "subCategory":"Discovery",
"description":"Could not get domain for the 'hp-cluster.corp.mycorp.com' target", "shortDescription":"Discovery failed",
"state":"NOTIFY",
"severity":"MAJOR", "importance":0
},
...
]です
ポリシーは、Workload Optimization Manager がリソース割り当てを分析する方法、リソースステータスを表示する方法、およびアクションを推奨または実行する方法を制御するビジネスルールを設定します。ポリシーには次の 2 種類があります:
■ 配置ポリシー
ワークロードの配置の決定を変更するには、Workload Optimization Manager はそのマーケットを有効なワークロードの配置が含まれているセグメントに分割します。Workload Optimization Manager は、環境内のターゲットによって定義されている配置ルールを検出します。また、ユーザー独自のセグメントを作成することもできます。
■ 自動化ポリシー
Workload Optimization Manager は、自動化ポリシーを使用して分析とその結果のアクションを導きます。これらのポリシーでは、アクションの自動化、オーケストレーション、および制約(運用、使用、およびスケーリングの制約)を指定できます。
Workload Optimization Manager には、分析と制御から最良の結果が得られると考えられるデフォルト設定で出荷されています。環境の一部の範囲では、これらの設定を変更する必要がある場合があります。たとえば、その範囲に対するアクションの自動化の変更や、使用率の制約の変更が必要な場合があります。
ターゲットとして設定するハイパーバイザには、それら独自の配置ポリシーを含めることができます。Workload Optimization Manager によってこれらの配置ポリシーがインポートされ、ユーザーは必要に応じて有効にしたり、無効にしたりできます。デフォルトでは、Workload Optimization Manager はインポートされた配置ポリシーを有効にします。
ポリシーエンドポイントを使用すると、次のことができます。
■ ポリシーの API エントリポイントを取得する
■ 特定のポリシーの詳細を表示する
ユーティリティリクエストは、関連するリクエストの作成、inputDTO のアセンブル、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
ポリシーエンドポイントには、ポリシー関連のリクエストのエントリポイントを示すユーティリティリクエストが含まれています。これらは、特定のポリシーに関連する UUID と詳細を見つけるために使用できます。
例:GET https://10.10.10.10/api/v3/policies
応答:Link オブジェクトの配列。各オブジェクトには、指定されたマーケット、エンティティ、またはグループのすべてのポリシーを取得するための URL が含まれます。
{
"links":[
{
"rel":"Market actions", "href":"https://10.10.10.10/api/v3/markets/{uuid}/entities"
},
{
"rel":"Entity policies", "href":"https://10.10.10.10/api/v3/entities/{uuid}/policies"
},
{
"rel":"Group policies", "href":"https://10.10.10.10/api/v3/groups/{uuid}/policies"
}
],
"enabled":false
}
指定されたポリシーの詳細の取得
単一のポリシーリクエストは、指定されたポリシーの UUID に基づいて、そのポリシーの詳細を取得します。特定の範囲に影響するポリシーを取得した後にこれを使用して、それらのポリシーの詳細を表示できます。
例:GET https://10.10.10.10/api/v3/policies/104:domain-c7:10.10.111.111
応答:ポリシーのプロバイダーのグループ情報を含む、ポリシーに関する詳細を説明する PolicyApiDTO。
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/policies/104:domain-c7:10.10.111.111"
}
],
"uuid":"104:domain-c7:10.10.111.111",
"displayName":"GROUP-DRS-LN-rule/Cluster1/10.10.111.111", "type":"BIND_TO_GROUP",
"name":"GROUP-DRS-LN-rule/Cluster1/10.10.111.111", "enabled":true,
"capacity":1000000000, "commodityType":"DrsSegmentationCommodity", "consumerGroup":{
"uuid":"7843e134bab4fb841b9cb7dd98ef04acf1f36f7b",
"displayName":"Buyers-Group-GROUP-DRS-vmGroup1/Cluster1/10.10.111.111", "className":"DiscoveredGroup",
"groupType":"VirtualMachine", "isStatic":true, "logicalOperator":"AND"
},
"providerGroup":{
"uuid":"597a35089bfe405291911f3191cf24234d4713d1",
"displayName":"Sellers-Group-GROUP-DRS-hostGrp1/Cluster1/10.10.111.111", "className":"DiscoveredGroup",
"groupType":"PhysicalMachine", "isStatic":true, "logicalOperator":"AND"
}
}
ポリシーの作成
ポリシーは、特定のマーケット(プランマーケットまたはリアルタイムマーケット)向けに作成されます。ポリシー作成の詳細については、マーケット(126ページ)エンドポイントを参照してください。
ユーティリティリクエストは、関連するリクエストの作成、inputDTO のアセンブル、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
価格表エンドポイントには、サンプルのレート表ファイルと RateCardApiDTO が含まれています。このサンプルにアクセスするには:
1. GET https://10.10.10.10/api/v3/pricelists リクエストを実行し、価格表を見つけます。
その displayName は Sample Azure Rate Card で始まります。
2. このレート表の UUID を記録します。
3. https://10.10.10.10/api/v3/pricelists/{uuid_from_step_2}/export リクエストを実行し、レスポンスボディとなるファイルをダウンロードします。
価格表エンドポイントは、現時点では実装されていません。
Workload Optimization Manager は、予約を使用して、将来ワークロードを展開するために必要になるリソースを保存します。Workload Optimization Manager は、これらのワークロードの最適な配置を計算し、さまざまなホストおよびストレージエンティティがそれらのワークロードをサポートするために必要とするリソースを予約します。たとえば、1 月 1 日の時点で、Workload Optimization Manager に、1 月 7 日に 100 のワークロードに必要なリソースを予約するように指示できます。
Workload Optimization Manager API の予約エンドポイントを使用すると、次のことができます。
■ 予約一覧を取得する
■ 予約を作成する
■ 特定の予約に関する情報を取得する
■ 予約を取り消す
予約状態
予約は次のいずれかの状態になります:
■ 将来
予約は現在の日付以降に発生するように設定されています。
■ 初期
予約を作成中です。予約開始時間に発生します。
■ 進行中(INPROGRESS)
予約リクエストはマーケットプロバイダーに送信され、結果を待っています。
■ 無効(INVALID)
このエラー状態は、予約が準備ができていないマーケットに配置された場合(たとえば、マーケットコンポーネントが再開された場合)、または予約で使用された制約またはテンプレートの 1 つが、予約の作成から開始日までの間に削除された場合に発生します。
■ PLACEMENT_FAILED
予約は完了しましたが、すべてのエンティティを配置するのに十分なリソースがありませんでした。
■ 予約済み(RESERVED)
予約が完了し、必要なすべてのリソースを取得できました。
■ 未履行(UNFULFILLED)
予約はデータベースに追加されましたが、まだマーケットに送信されていません。
製品での予約
[ワークロード配置(Workload Placement)] ページで、予約を設定して、将来のワークロードの展開に必要なリソースを保存できます。Workload Optimization Manager は、インテリジェントなワークロード管理を使用して、
これらのワークロードの最適な配置を計算し、さまざまなホストおよびストレージエンティティがそれらのワークロードをサポートするために必要とするリソースを予約します。
製品で予約を作成するときは、VM テンプレート、制約(範囲、ポリシー、ネットワーク)を選択してから、予約に名前、仮想マシン数、開始日と終了日を指定します。
予約を取る
予約のリストの場合、API は DemandReservationApiDTO のリストを返します。各 DemandReservationApiDTO には、予約済みインスタンスのエンティティ情報、デプロイされる数、および現在のステータスが含まれます。特定の予約の DTO を取得するには、要求に UUID を含めます。
このリクエストは、次のパラメータを取ります:
Status |
指定されたステータスの予約のみを返します。[ PLACEMENT_SUCCEEDED, PLACEMENT_FAILED, UNFULFILLED, RESERVED, DEPLOY_FAILED, DEPLOY_SUCCEEDED, FUTURE ] |
例:
■ ステータスが PLACEMENT_SUCCEEDED のすべての予約:
GET https://10.10.10.10/api/v3/reservations?status=PLACEMENT_SUCCEEDED
■ 単一の予約:
GET https://10.10.10.10/api/v3/reservations/_TszrkcwHEei7A9DOcc4f1g
応答:
[
{
"uuid": "215446856141616",
"displayName": "MyReservation", "count": 1,
"status": "RESERVED",
"reserveDateTime": "2022-11-01T13:28:00Z", "expireDateTime": "2022-12-01T14:28:00Z", "constraintInfos": [
{
"uuid": "74635127126226",
"constraintType": "DATA_CENTER"
}
],
"reservationDeployed": false, "mode": "NO_GROUPING",
"grouping": "NONE", "demandEntities": [
{
"template": {
"uuid": "215364307544240",
"displayName": "headroomVM", "className": "VirtualMachineProfile"
},
"placements": {
"computeResources": [
{
"stats": [ ...
Stats for CPU, CPUProvisioned, Mem, MemProvisioned, IOThroughput, NetThroughput
... ],
"provider": {
"uuid": "74635127126242",
"displayName": "hp-dl3111.eng.vmturbo.com", "className": "PhysicalMachine"
},
"linkedResources": [
{
"uuid": "285741371272387",
"displayName": "DC13/Physical Hosts_Cluster2 - Intel"
}
]
}
],
"storageResources": [
{
"stats": [ ...
Stats for StorageProvisioned, StorageAmount, StorageAccess
... ],
"provider": {
"uuid": "74635124839222",
"displayName": "QSGRID01:DC1314Shared", "className": "Storage"
}
}
]
}
}
]
}
]
Creating a Placement Reservation
配置予約を作成するには、このリクエストへの入力として、完了した DemandReservationApiInputDTO を POST します。DTO は、予約タイプ、使用するテンプレート、配置またはネットワーク ポリシーなどの制約の UUID、および予約のその他の属性を指定します。
例:POST https://10.10.10.10/api/v3/reservations
テンプレートの 2 つのインスタンスの予約を実行する inputDTO の例:
{
"demandName": "MyReservation1", "action": "RESERVATION", "mode": "NO_GROUPING",
"grouping": "NONE",
"reserveDateTime": "2022-11-01T21:03:22Z", "expireDateTime": "2022-12-01T21:03:22Z", "parameters": [
{
"placementParameters": {
"count": 2,
"templateID": "215364307544240",
"entityNames": [
"MyRes1_VM1", "MyRes1_VM2"
],
"constraintIDs": [ "285815619396128"
]
}
}
]
}
応答:配置試行のステータスを含む DemandReservationApiDTO。この予約のステータスは FUTURE であることに注意してください。Workload Optimization Manager が予約を実行し、予約済み VM の配置に成功すると、placement フィールドには 2 つの VM のホストとストレージプロバイダーの説明が含まれます。
{
"uuid": "215447101807136",
"displayName": "MyReservation", "count": 2,
"status": "FUTURE",
"reserveDateTime": "2022-11-01T21:03:22Z", "expireDateTime": "2022-12-01T21:03:22Z", "constraintInfos": [
{
"uuid": "285815619396128",
"constraintType": "POLICY"
}
],
"reservationDeployed": false, "mode": "NO_GROUPING",
"grouping": "NONE", "demandEntities": [
{
"template": {
"uuid": "215364307544240",
"displayName": "headroomVM", "className": "VirtualMachineProfile"
},
"placements": {}
},
{
"template": {
"uuid": "215364307544240",
"displayName": "headroomVM", "className": "VirtualMachineProfile"
},
"placements": {}
}
]
}
予約を取り消す
指定された予約を削除し、その予約に関連付けられているすべての予約済みリソースを削除します。これにより、削除された予約に関連する保留中の展開も削除されます。
例:DELETE https://10.10.10.10/api/v3/reservations/_i-FLwdLiEeiuY7KDiLoLWg
応答:削除要求が成功すると、応答コード 200 が返されます。
予約のカスタマイズ
予約を作成するには、配置ポリシー(150ページ)、テンプレート(271ページ)、範囲制約、およびネットワーク制約に精通している必要があります。
注:
ネットワーク制約を使用して、ワークロードの配置を Workload Optimization Manager が環境内で検出したネットワークに制限します。
このリクエストは、DemandReservationApiInputDTO の次のパラメータを取ります:
demandName
予約の表示名 — 予約されたワークロードの名前を指定しない場合、それらはすべて、数字のサフィックスが付いたルート名として取得されます。たとえば、MyReservation1、MyReservation2 などです。
action
アクション タイプ:これは常に RESERVATION です。
reserveDateTime
ワークロードの配置を計算して予約を作成する時間 — この時間は、予約を API に POST した時間より前にすることはできません。
expireDateTime
予約をキャンセルする日時。この時点で、Workload Optimization Manager は予約を削除します。予約済みのリソースを利用するには、この時間までに実際の VM を予約済みの場所にデプロイする必要があります。
パラメータ
PlacementParametersDTO とそれ自体で構成される DemandReservationParametersDTO および
DeploymentParametersDTO。
完成した DemandReservationParametersDTO を渡すために、次のパラメータを使用して PlacementParametersDTO を作成します。
count
この予約のワークロードの数
templateID
配置に必要なワークロードの作成に使用されるテンプレートの UUID
entityNames
配置されたワークロードの名前。複数のワークロードを予約するために数字のサフィックスが付加される
constraintIDs
予約が従う範囲、グループ、およびポリシーまたはネットワーク制約の UUID
たとえば、次の POST は、73365042986774 の UUID を持つ特定の仮想データセンターと 73365048169751 の UUID を持つネットワークを範囲とする 10 個の VM の予約を作成します。entityNames (VM の名前の配列)が指定されていないため、Workload Optimization Manager は VM 名を生成します。
{
"action":"RESERVATION",
"demandName":"DalReservation", "reserveDateTime":"2020-03-11T15:44:41Z", "expireDateTime":"2020-04-11T15:44:41Z", "parameters":[
{
"placementParameters":{
"count":"10", "templateID":"214103358655713",
"constraintIDs":[
"73365042986774",
"73365048169751"
]
}
}
]
}
予約を作成するときに、予約済み VM のアフィニティルールを指定して、予約内のすべての VM が同じクラスタにデプロイされるようにすることができます。アフィニティを指定しない場合、VM は予約の範囲内のクラスタにデプロイされます。これらの設定はオプションですが、アフィニティを指定する場合は、両方の設定に互換性のある値を指定する必要があります。
これらの設定は、予約に設定した他の制約を尊重します。たとえば、クラスタのグループに予約の範囲を設定すると、クラスタ アフィニティルールを使用して、Workload Optimization Manager はその範囲から 1 つのクラスタを選択し、すべての VM をそのクラスタに配置しようとします。
予約のアフィニティを指定するには、次のように宣言します:
■ mode (オプション):次のいずれかになります:
– AFFINITY - 同じクラスタの予約済みの VM をグループ化します。grouping パラメータは CLUSTER に設定する必要があります。要求された VM をホストできるクラスタがない場合、予約は UNFULLFILLED になります。
– NO_GROUPING 同じクラスタの予約済みの VM をグループ化しません。grouping パラメータは NONE に設定する必要があります。
■ grouping (オプション):次のいずれかになります:
– CLUSTER - 予約済み VM をグループ化します。mode パラメータは CLUSTER に設定する必要があります。
– NONE - 予約済み VM をグループ化しません。mode パラメータは NO_GOUPING に設定する必要があります。
{
"demandName": "MyReservation1", "action": "RESERVATION", "mode": "AFFINITY",
"grouping": "CLUSTER",
...
}
予約情報を取得する
現在の予約のリストを取得するには、GET https://10.10.10.10/api/v3/reservations リクエストを実行します。これにより、すべてのアクティブな予約のリストが返されます。取得したい予約の UUID がわかっている場合は、それを渡してその予約のデータを取得できます。
各予約オブジェクトには次の記述があります:
■ 表示名
■ Status — 次のいずれかです:
– IN_PROGRESS — 配置計算が進行中
– PLACEMENT_SUCCEEDED — 新しい予約の場合、環境にはワークロードを配置するのに十分なリソースがあり、予約日を指定した場合、これはアクティブな予約になる
– PLACEMENT_FAILED — 新しく作成された予約で、環境にワークロードを配置するためのリソースが不足しており、予約日を指定した場合、これは未処理の予約になる
– RETRYING — Workload Optimization Manager は、まだ満たされていない予約のワークロードを配置しようとしています
■ 予約が作成された時刻と期限切れの時刻
■ 予約済みワークロードの説明
■ 予約によって確保されるコンピューティングリソースとストレージリソースの統計。
たとえば、次のリストは、1 つの VM の予約が成功したことを示しています:
{
"uuid":"_kWZHIDDmEeePgeXuo0RRbw", "displayName":"MyReservation", "count":1, "status":"PLACEMENT_SUCCEEDED",
"reserveDateTime":"Thu May 04 16:27:29 UTC 2017",
"expireDateTime":"Thu Aug 31 16:27:29 UTC 2017",
"deployDateTime":"Thu Aug 31 16:27:29 UTC 2017", "reserveCount":1,
"demandEntities":[
{
"uuid":"_kWgb7TDmEeePgeXuo0RRbw", "displayName":"MyReservation_C0", "className":"VirtualMachine", "template":{
"uuid":"T423f548d-cadc-e525-6df4-1f90724cf696", "displayName":"vsphere-dc3.dev.mycorp.com::TMP-SUSE64", "className":"VirtualMachineProfile"
},
"placements":{
"computeResources":[
{
"stats":[
{
"name":"numOfCpu", "value":1
},
{
"name":"cpuSpeed", "value":2603
},
{
"name":"cpuConsumedFactor", "value":0.5
},
{
"name":"memorySize", "value":2097152
},
{
"name":"memoryConsumedFactor", "value":0.75
},
{
"name":"ioThroughput", "value":0
},
{
"name":"networkThroughput", "value":0
}
],
"provider":{
"uuid":"Virtual_ESX_42381da5-12fa-1e82-2f1c-887419380d43", "displayName":"hp-esx21.corp.vmturbo.com", "className":"PhysicalMachine"
}
}
],
"storageResources":[
{
"stats":[
{
"name":"diskSize", "value":18432.363
},
{
"name":"diskIops", "value":0
}
],
"provider":{
"uuid":"10545c15-7687ef26",
"displayName":"QS2:ESXDC3DS1", "className":"Storage"
}
}
]
}
}
]
}
予約の作成
予約を作成するには、次の予約を定義する入力 DTO を POST します:
■ action:アクションタイプ:RESERVATION
■ demandName:予約の表示名 — 追加されたワークロードの名前を指定しない場合、これが新しい VM のルート名
■ placementParameters:
– constraintIDs:計算された配置に影響を与える配置ポリシーの UUID の配列
– count:配置するワークロードの数
– entityNames:配置された VM の名前の配列 — 配列の長さは count と等しくなければならない
– geographicRedundancy:true の場合、ワークロードを一意のホストに配置。それ以外の場合、Workload Optimization Manager は複数のワークロードを同じホストに配置できる
– templateID:このワークロードを配置するために使用するテンプレートの UUID — テンプレートには、deploymantParameters で指定するデプロイメントプロファイルへの参照が含まれている必要があることに注意
■ expireDateTime:Workload Optimization Manager がその日付までにすべてのワークロードを配置できない場合に予約をキャンセルする時期 — RESERVATION アクションの場合、Workload Optimization Manager はデプロイ時間をこの時間と同じになるように自動的に設定
■ ReserveDateTime:ワークロードの配置を計算して予約を作成する時間 — この時間は、予約を API に POST した時間より前にすることはできない
次のリストは、予約を作成する入力 DTO を示しています。4 つのワークロードを配置し、それぞれに特定の名前を付けます。
{
"action": "RESERVATION",
"demandName": "MyReservation", "expireDateTime": "2017-10-10T12:38:17+00:00",
"parameters": [
{
"deploymentParameters": {
"deploymentProfileID": "_c9CJMDDAEeePgeXuo0RRbw"
},
"placementParameters": {
"geographicRedundancy": false, "count": 4,
"entityNames": [
"foo","bar","baz","bonk"
],
"templateID": "_UKsnkJkSEeCHcOXEhzJExA"
}
}
],
"reserveDateTime": "2017-05-04T18:22:12+00:00"
}
Workload Optimization Manager の分析では、AWS リザーブドインスタンスおよび Azure リザーブド VM インスタンスを利用して、最適なワークロードの配置を計算し、クラウド上での導入に最適なコストを提示します。
Workload Optimization Manager API の予約済みインスタンス エンドポイントを使用すると、次のことができます:
■ 単一の予約済みインスタンスまたは環境に存在する予約済みインスタンスのリストを取得
■ 予約済みインスタンスに関連する統計を取得
予約済みインスタンスの取得
予約済みインスタンスのリストとして、API は ReservedInstanceApiDTO の配列を返します。各 ReservedInstanceApiDTO には、検証ステータス、ターゲットのタイプとカテゴリ、入力フィールドの名前と値が含まれます。単一の予約済みインスタンスを取得するには、予約済みインスタンスの UUID をリクエストに含めます。
このリクエストは、次のパラメータを取ります:
scope |
指定された範囲内の予約済みインスタンスのみを返します。これは、エンティティまたはターゲットのグループの範囲にすることができます。たとえば、単一の AWS ターゲットのリザーブドインスタンスを表示するには、ここでそのターゲットの UUID を使用します。 |
例:
■ すべての予約インスタンス:GET https://10.10.10.10/api/v3/reservedinstances
■ 指定された範囲の予約済みインスタンス:GET https://10.10.10.10//api/v3/reservedinstances? scope=_zeCtIMAVEei2-fP3xzx1Fw
応答:
[
{
"uuid": "aws::eu-west-1::RI::a0643140-85d7-4c5e-a7ba-4ec2fc47bb76", "displayName": "i3.large",
"className": "ReservedInstance"、
"テンプレート": {
"uuid": "aws::VMPROFILE::i3.large", "displayName": "i3.large", "discovered": false,
"family": "i3"
},
"platform": "LINUX",
"type": "STANDARD",
"location": {
"uuid": "aws::eu-west-1::DC::eu-west-1", "displayName": "aws-EU (Ireland)"
},
"accountId": "19265476245", "targetId": "_zeCtIMAVEei2-fP3xzx1Fw", "masterAccountId": "194356375", "term": {
"units": "Year", "values": {
"max": 1,
"min": 1,
"avg": 1,
"total": 1
},
"value": 1
},
"payment": "PARTIAL_UPFRONT",
"onDemandPrice": {
"units": "$/h", "values": {
"max": 0.172,
"min": 0.172,
"avg": 0.172,
"total": 0.172
},
"value": 0.172
},
"costPrice": {
"units": "$/h", "values": {
"max": 0.11193608,
"min": 0.11193608,
"avg": 0.11193608,
"total": 0.11193608
},
"value": 0.11193608
},
"coupons": {
"capacity": {
"max": 16,
"min": 16,
"avg": 16
},
"units": "RICoupon", "values": {
"max": 0,
"min": 0,
"avg": 0,
"total": 0
},
"value": 0
},
"totalCoupons": 0、
"expDate": "Sat Apr 06 19:11:19 EDT 2019"、
"instanceCount": 1、"tenancy": "DEFAULT"、"upFrontCost": 490、
"actualHourlyCost": 0.0560000017285347、
"effectiveHourlyCost": 0.11193607478789543
},
...
]
予約済みインスタンスの対象となるエンティティを取得する
予約済みインスタンスの UUID を指定すると、API は予約済みインスタンスによってカバーされるエンティティのリストを返します。このリクエストは、次のパラメータを取ります:
reservedInstance_Uuid |
予約済みインスタンスの UUID。 |
例:GET https://10.10.10.10/api/v3/reservedinstances/1234/coveredEntities
応答:指定された RI によってカバーされるエンティティを記述する BaseApiDTO の配列。
[
{
"uuid":"73943736161360"、
"displayName":"pyaus", "className":"VirtualMachine"
},
{
"uuid":"73812178348464"、
"displayName":"ptaub807disabled", "className":"VirtualMachine"
},
{
"uuid":"73746051159552"、
"displayName":"pyaus", "className":"VirtualMachine"
}
]
現時点では、ロールエンドポイントは実装されていません。
計画のシナリオを実行するために、Workload Optimization Manager はリアルタイムの市場のスナップショットコピーを作成し、そのスナップショットをシナリオに従って変更します。次に、経済スケジューリングエンジンを使用して、計画市場について分析を実行します。シナリオでは、ワークロードの変更、ハードウェアリソースの追加や削除、クラスタ境界や配置ポリシーなどの制約の変更または排除によって、スナップショットマーケットを変更できます。
計画を実行すると、Workload Optimization Manager は、市場が実現できる最適な条件に到達するまで、継続的に計画市場を分析します。市場が実現できる最適な条件に到達すると、経済スケジューリングエンジンは、ワークロードによって要求されたリソースに対してより良い価格を見つけることができなくなり、その時点で計画の実行が停止して、目的の状態として計画の結果が表示されます。
結果の表示には、ホストとデータストア間のワークロードの分布、および目的の結果を得るために計画が実行したアクションのリストが含まれます。
たとえば、クラスタに仮想マシンを追加するシナリオがあるとします。計画を実行するために、Workload Optimization Manager は現在の市場のスナップショットを取得し、指定されたクラスタに VM を追加します。次に、Workload Optimization Manager は計画市場で分析を実行します。これにより、サプライ チェーン内の各エンティティは、必要なリソースに対して、常により良い価格を探します。リソースは、使用率が低いサプライヤから検索されます。この分析は、すべてのリソースが最適な価格で提供されるまで続きます。
結果には、物理マシンを一時停止してコンピューティングリソースを削減した場合でも、環境にワークロードを追加できることが示される場合があります。推奨されるアクションは、オフラインで実行できるホスト、および残りのホスト間で仮想マシンを分散する方法を示します。
シナリオで行う設定は、ユーザーインターフェイスで行うことができるプラン設定に対応しています。これには、以下が含まれます。
■ プラン範囲
■ ワークロードの変更(VM またはコンテナの追加、削除、または置換)
■ 供給の変更(PM の追加、削除、交換または保管)
■ 配置ポリシーとその他の制約を有効/無効にする
■ アクションモードの変更
■ 供給のプロビジョニングを有効/無効にする
■ ワークロードのサイズ変更を有効/無効にする
Workload Optimization Manager API のシナリオエンドポイントを使用すると、次のことができます。
■ インスタンスのシナリオのリストを取得する
■ シナリオの作成
■ 特定のシナリオに関連するマーケットのリストを取得する
シナリオの取得
GET /シナリオ リクエストを実行すると、API は次のフィールドを含む ScenarioApiDTO を返します:
■ uuid
このシナリオの一意の識別子。
■ displayName
デフォルトでは、Workload Optimization Manager はシナリオ タイプに一致する表示名を作成します。PUT リクエストを使用して、作成後にシナリオの名前を変更できます。
■ 所有者
シナリオを使用できるユーザーアカウントの配列。現在、これは常にシナリオを作成したユーザーです。
■ type
シナリオのタイプ。ユーザーが GUI でシナリオを作成した場合、これは、ユーザーがプランウィザードから選択した特定のタイプと一致します。
■ scope
プランの範囲を指定する範囲 オブジェクトの配列。
■ projectionDays
計画をどのくらい先まで予測するかを指定する日数の配列。たとえば、[30, 60, 120] の値は、それぞれ 1、2、および 4 か月後の予測を返します。
■ topologyChange
プラン範囲内のエンティティセットへの追加または削除の配列。
■ loadChanges
プラン範囲内のエンティティのさまざまなグループの使用率に対する変更の配列。
■ configChanges
プラン範囲内のエンティティのさまざまなグループの構成変更の配列。
■ changes - 非推薦
プランを実行する前にマーケットに変更を加えるシナリオ設定の配列。
例:GET https://10.10.10.10/api/v3/scenarios?show_all=false
Response:
{
"uuid": "214704587455872",
"displayName": "Migrate to Public Cloud 1_CLOUD_MIGRATION CONSUMPTION", "type": "CLOUD_MIGRATION",
"scope": [
{
"uuid": "73935388327649",
"displayName": "aws-EU (Frankfurt)", "className": "Region"
}
],
"projectionDays": [
0
],
"topologyChanges": {
"migrateList": [
{
"projectionDay": 0, "source": {
"uuid": "285041726554576",
"displayName": "不明"
},
"destination": {
"uuid": "73935388327649",
"displayName": "aws-EU (Frankfurt)", "className": "Region",
"state": "ACTIVE",
"severity": "Minor", "discoveredBy": {
"uuid": "73935444966640",
"displayName": "testmachine", "category": "Public Cloud", "type": "AWS",
"readonly": false
},
"severityBreakdown": {
"MINOR": 1
},
"numRelatedVMs": 2, "environmentType": "CLOUD", "vendorIds": {
"vmturboamp": "aws::eu-central-1::DC::eu-central-1"
}
},
"sources": [
{
"uuid": "285041726554576",
"displayName": "Unknown"
}
],
"destinations": [
{
"uuid": "73935388327649",
"displayName": "aws-EU (Frankfurt)", "className": "Region",
"state": "ACTIVE",
"severity": "Minor", "discoveredBy": {
"uuid": "73935444966640",
"displayName": "testmachine", "category": "Public Cloud", "type": "AWS",
"readonly": false
},
"重大度の内訳": {
"マイナー": 1
},
"numRelatedVMs": 2, "environmentType": "CLOUD", "vendorIds": {
"vmturboamp": "aws::eu-central-1::DC::eu-central-1"
}
}
],
"destinationEntityType": "VirtualMachine", "removeNonMigratingWorkloads": true
}
]
},
"loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"configChanges": {
"addPolicyList": [], "removePolicyList": [], "automationSettingList": [], "removeConstraintList": [], "riSettingList": [
{
"uuid": "ri.aws.preferredOfferingClass", "displayName": "Type",
"value": "STANDARD",
"valueObjectType": "String"
},
{
"uuid": "ri.aws.preferredPaymentOption", "displayName": "Payment",
"value": "ALL_UPFRONT",
"valueObjectType": "String"
},
{
"uuid": "ri.aws.preferredOfferingClass", "displayName": "Type",
"value": "YEARS_1", "valueObjectType": "String"
}
],
"osMigrationSettingList": [
{
"uuid": "linuxTargetOs", "displayName": "linuxTargetOs", "value": "LINUX", "valueObjectType": "String"
},
{
"uuid": "linuxByol", "displayName": "linuxByol", "value": "false", "valueObjectType": "String"
},
{
"uuid": "rhelTargetOs", "displayName": "rhelTargetOs", "value": "RHEL", "valueObjectType": "String"
},
{
"uuid": "linuxByol", "displayName": "linuxByol", "value": "false", "valueObjectType": "String"
},
{
"uuid": "rhelTargetOs", "displayName": "rhelTargetOs", "value": "RHEL", "valueObjectType": "String"
},
{
"uuid": "linuxByol", "displayName": "linuxByol", "value": "false", "valueObjectType": "String"
},
{
"uuid": "windowsTargetOs", "displayName": "windowsTargetOs", "value": "WINDOWS",
"valueObjectType": "String"
},
{
"uuid": "linuxByol", "displayName": "linuxByol", "value": "false", "valueObjectType": "String"
},
{
"uuid": "selectedMigrationProfileOption", "displayName": "selectedMigrationProfileOption", "value": "MATCH_SOURCE_TO_TARGET_OS",
"valueObjectType": "String"
},
{
"uuid": "matchToSource", "displayName": "matchToSource", "value": "true", "valueObjectType": "String"
}
],
"includedCoupons": {
"includedCouponOidsList": [], "iswhiteList": true
},
"subscription": {
"uuid": "73935382668544",
"displayName": "EngineeringSample", "className": "BusinessAccount", "accountId": "323871187550",
"master": false, "cloudType": "AWS",
"riSupported": false, "hasRelatedTarget": false
}
}
}
シナリオの作成
シナリオを作成するには、シナリオ DTO ブレークダウン(168 ページ)を参照してください。 完全な ScenarioApiDTO の例については、「シナリオ構成の例」(180ページ)を参照してください。
シナリオの削除
指定されたシナリオを削除します。シナリオを使用して作成したプランマーケットは削除されないことに注意してください。
例:DELETE https://10.10.10.10/api/v3/scenarios/ xwWYAE3EeiNKPbzHdETIA
応答:削除要求が成功すると、応答コード 200 が返されます。
シナリオ DTO の概要
シナリオ DTO は、プランのセットアップと実行に使用する構成設定を組み立てます。計画を実行するには、シナリオをマーケットに POST します。ほとんどのプランでは、これはリアルタイムマーケットになります。プランオーバープランの場合、これは最初のシナリオから作成されたマーケットになります。
次に、Workload Optimization Manager は、シナリオとマーケットの状態の組み合わせに基づいてプランを実行します。これらの構成設定は、いくつかのグループのいずれかに分類されます。
名前(DTO) |
説明 |
構成の変更(ConfigChangesApiDTO) |
配置ポリシーの追加と削除、制約の削除、自動化設定、OS 移行設定、予約インスタンス設定、および関連するビジネスユニットの提供。 |
変更の読み込み(LoadChangesApiDTO) |
現在および最大の使用率の値、およびピークのベースライン値の変更。 |
時間ベースのトポロジ変更(TimeBasedTopologyChangesApiDTO) |
予約済み VM を含め、履歴ワークロードを定期的に追加する設定環境 |
トポロジの変更(TopologyChangesApiDTO) |
ワークロードを追加、削除、置換、移行するための設定、または圧力軽減プランのクラスタを指定するための設定。 |
DTO 構成の変更
ScenarioApiDTO の configChanges パラメータにあるシナリオ構成の変更により、次のタスクを実行できます:
パラメータ |
説明 |
addPolicyList |
このプランのために生成されたマーケットに配置ポリシーを追加します。 |
automationSettingList |
利用可能な自動化プラン設定の 1 つを変更します:VM サイズ、ホスト プロビジョニング/サスペンド、およびストレージ プロビジョニング/サスペンドのいずれか。 |
osMigrationSettingList |
Migrate to Cloud プランの場合、このパラメータには、ソースとターゲットの OS プラットフォーム、およびそれらの BYOL(Bring Your Own License)ステータスが含まれます。 |
パラメータ |
説明 |
removeConstraintList |
この計画のために生成されたマーケットから制約を削除します。 |
removePolicyList |
このプランのために生成されたマーケットから配置ポリシーを削除します。 |
riSettingList |
予約済みクラウドインスタンスに関する情報を追加します。 |
サブスクリプション |
ビジネスユニットをプランに関連付けます。 |
配置ポリシーの追加と削除
プランを実行しているときに、特定のポリシーが有効になっている場合といない場合、または新しいポリシーが存在する場合に、環境がどのように見えるかを確認したい場合があります。現在のポリシーの UUID または新しいポリシーの PolicyApiDTO を渡すことで、これらの変更の効果を確認できます。
入力例(現在のポリシー):
"addPolicyList": [
{
"uuid": "_VnNS0CsqEemvEL3szcXU1Q",
"uuid": "522a3317-39f5-1a97-3b53-d725927a6ae8",
"uuid": "52672058-a93b-d0a9-bbd9-5acd33f27882"
}
]
入力例(新しいポリシー):
"addPolicyList": [
{
"capacity": null, "consumerGroup": {
"uuid": "8c17d8e79c3db85ed5d3868de622cb89187849ce", "displayName": "PMs_Beta DC6\\Cluster-2", "className": "Group",
"groupType": "PhysicalMachine", "isStatic": true, "logicalOperator": "AND"
},
"enabled": true, "mergeGroups": null, "mergeType": null,
"name": "DalTestPolMerge", "displayName": "DalTestPolMerge", "providerGroup": {
"uuid": "91ff08749fd278925d73b61b0f0f69d79c99fc3a", "displayName": "PMs_Beta DC6\\Cluster-1", "className": "Group",
"groupType": "PhysicalMachine", "isStatic": true, "logicalOperator": "AND"
},
"type": "MERGE",
"uuid": ""
}
]
プラン自動化設定の設定
プランの自動化設定を使用して、VM のサイズ変更、ホストのプロビジョニング/一時停止、およびストレージのプロビジョニング/一時停止が有効または無効になっている場合のシナリオの影響を確認します。
入力例:
"automationSettingList":[
{
"uuid":"resize",
"displayName":"Resize for VMS disabled", "value":"false", "entityType":"VirtualMachine"
},
{
"uuid":"provisionPM",
"displayName":"Provision for PHYSICALMACHINES disabled", "value":"false",
"entityType":"PhysicalMachine"
},
{
"uuid":"suspendPM",
"displayName":"Suspend for PHYSICALMACHINES disabled", "value":"false",
"entityType":"PhysicalMachine"
},
{
"uuid":"provisionDS", "displayName":"Provision for STS disabled", "value":"false",
"entityType":"Storage"
},
{
"uuid":"suspendDS", "displayName":"Suspend for STS enabled", "value":"true",
"entityType":"Storage"
}
]
さらに、これらの設定を使用して、CPU および MEM のプロビジョニングされた値などの操作上の制約を調整できます。
入力例:
"automationSettingList":[
{
"uuid":"capacity_MemProvisioned", "displayName":"Mem Overprovisioned Percentage", "value":"9876.0",
"defaultValue":"1000.0", "categories":[
"utilizationThresholds"
],
"valueType":"NUMERIC",
"min":1, "max":1000000,
"entityType":"PhysicalMachine"、"sourceGroupName":"グローバル"
}
クラウド予約済みインスタンス情報の提供
Workload Optimization Manager を使用すると、シナリオに固有の RI 価格情報をアップロードできます。
入力例:
"riSettingList": [
{
"uuid": "preferredTerm", "displayName": "Term", "value": "YEARS_1", "entityType": "YEARS_1"
},
{
"uuid": "preferredPaymentOption", "displayName": "Payment", "value": "PARTIAL_UPFRONT",
"entityType": "PARTIAL_UPFRONT"
},
{
"uuid": "preferredOfferingClass", "displayName": "Type",
"value": "STANDARD",
"entityType": "STANDARD"
},
{
"uuid": "preferredCoverage", "displayName": "Coverage", "value": "80",
"entityType": "80"
},
{
"uuid": "riCoverageOverride", "displayName": "RI Coverage Override", "value": "false",
"entityType": "false"
}
]
制約の削除
計画を実行するとき、特定の制約がある場合とない場合の環境がどのようになるかを確認することが必要な場合があります。たとえば、仮想マシンのグループが環境の任意のクラスタへの移動を許可されている場合などです。
制約を削除するには、その UUID を知っている必要があります。このエンティティの制約のリストを取得するには、制約を削除するエンティティに対して /entities/ENTITY_UUID/constraints リクエストを実行します。
removeConstraintList
{
"constraintType":"ClusterCommodity", "projectionDay":0,
"target":{
"uuid":"a6d365f4fbf03fb9a2e8cdb29e38045e31cee41b", "displayName":"Beta DC6_vm", "className":"VirtualMachine"
}
}
]
Migrate to Cloud プランの OS 移行設定の設定
Migrate to Cloud プランを実行するときに、カスタム OS 移行設定を使用することが必要になる場合があります。OS マッピングと、マッピング内の各 OS の BYOL(Bring Your Own License)ステータスの両方を指定できます。
入力例:
"osMigrationSettingList":[
{
"uuid":"linuxTargetOs", "displayName":"linuxTargetOs", "value":"LINUX"
},
{
"uuid":"linuxByol", "displayName":"linuxByol", "value":"true"
},
{
"uuid":"rhelTargetOs", "displayName":"rhelTargetOs", "value":"RHEL"
},
{
"uuid":"rhelByol", "displayName":"rhelByol", "value":"false"
},
{
"uuid":"slesTargetOs", "displayName":"slesTargetOs", "value":"WINDOWS"
},
{
"uuid":"slesByol", "displayName":"slesByol", "value":"true"
},
{
"uuid":"windowsTargetOs", "displayName":"windowsTargetOs", "value":"WINDOWS"
},
{
"uuid":"windowsByol",
"displayName":"windowsByol", "value":"true"
},
{
"uuid":"showMatchSourceToTargetOsOption", "displayName":"showMatchSourceToTargetOsOption", "value":"true"
},
{
"uuid":"showByolOption", "displayName":"showByolOption", "value":"false"
},
{
"uuid":"showCustomOsOption", "displayName":"showCustomOsOption", "value":"true"
},
{
"uuid":"matchToSource", "displayName":"matchToSource", "value":"false"
},
{
"uuid":"selectedMigrationProfileOption", "displayName":"selectedMigrationProfileOption", "value":"CUSTOM_OS"
}
]
シナリオ DTO ロード変更
ScenarioApiDTO の loadChanges パラメータにあるシナリオの負荷の変更により、ワークロードの使用率が変更され、次の値を変更できるようになります:
パラメータ |
説明 |
baselineDate |
履歴データを使用して計画を実行する必要がある場合は、使用するデータの日付。 |
maxUtilizationList |
プラン内のエンティティグループの最大使用率の値を変更します。 |
peakBaselineList |
プラン内のエンティティグループのピークベースライン値を変更します。 |
utilizationList |
プラン内のエンティティグループの使用率の値を変更します。 |
ベースライン日付変更の入力例:
"baselineDate": 1552622400000
エンティティグループの使用率変更の入力例:
"utilizationList": [
{
"percentage": -12,
"projectionDay": 0, "target": {
"displayName": "Global Environment", "uuid": "Market"
}
}
]
エンティティグループの最大使用率変更の入力例:
"maxUtilizationList": [
{
"maxPercentage": 82,
"projectionDay": 0, "target": {
"displayName": "All On-prem Hosts", "className": "Group",
"uuid": "_PE0v-YEUEee_hYfzgV9uYg"
}
},
{
"maxPercentage": 85,
"projectionDay": 0, "target": {
"displayName": "ACM_datastore", "className": "Group",
"uuid": "c31a6f99f4409700115fc61fca71e5449ad68700"
}
},
{
"maxPercentage": 77,
"projectionDay": 0, "target": {
"displayName": "Beta DC6_datastore", "className": "Group",
"uuid": "5544c35ed3d7fc0d33879d3457c219d7e40fc176"
}
}
]
}
シナリオ DTO 時間ベースのトポロジ変更
ScenarioApiDTO の timebasedTopologyChanges パラメータにあるシナリオの時間ベースのトポロジ変更は、次のような時間依存のトポロジ変更をシナリオに加えます:
パラメータ |
説明 |
addHistoryVMs |
true の場合、Workload Optimization Manager は、前月にリアルタイムマーケットに追加されたワークロードに等しいワークロードを毎月シナリオに追加します。 |
パラメータ |
説明 |
includeReservation |
true の場合、ワークロード最適化マネージャは現在の予約を取得し、シナリオの実行時にそれらのリソース使用率を反映します。 |
VM 使用量履歴の追加と VM 予約の組み込みの入力例:
"timebasedTopologyChanges": [
{
"addHistoryVMs": "true", "includeReservation": "true"
}
]
シナリオ DTO トポロジの変更
ScenarioApiDTO の topologyChanges パラメータにあるシナリオ トポロジの変更により、シナリオに次のようなトポロジ変更が行われます:
パラメータ |
説明 |
addList |
プラン構成の一部として環境に追加するエンティティのリスト。 |
migrateList |
プラン構成の一部として、あるプロバイダーのセットから別のセットに移動するエンティティのリスト。 |
relievePressureList |
圧力解放プランにおける、ソースクラスタとターゲットクラスタ。 |
removeList |
プラン構成の一部として環境から削除されるエンティティのリスト。 |
replaceList |
プラン構成の一部として、環境内のエンティティとそれらを置き換えるテンプレートのリスト。 |
ワークロードの追加
シナリオにワークロードを追加すると、環境内の VM またはコンテナの密度が増加した場合の影響がシミュレートされます。VM グループまたは個々の VM の複数のコピーを追加できます。
入力例:
"addList": [
{
"count": 3, "projectionDays": [
0
],
"target": {
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine"
}
},
{
"count": 10, "projectionDays": [
0
],
"target": {
"uuid": "421e503d-d0c0-75f9-8cce-79421924a90d", "displayName": "olg_test",
"className": "VirtualMachine"
}
},
{
"count": 5, "projectionDays": [
0
],
"target": {
"uuid": "420f1840-297f-5a39-9543-b72046b9126f",
"displayName": "opensuse_with_stress_template", "className": "VirtualMachine"
}
},
{
"count": 1, "projectionDays": [
0
],
"target": {
"uuid": "53523c9a4c5d67962a96f90f59456b0c3e72aca0", "displayName": "Development67_vm",
"className": "VirtualMachine"
}
}
]
ワークロードのクラウドへの移行
Workload Optimization Manager には、オンプレミスのワークロードのクラウドへの移行、またはあるクラウドのワークロードの別のクラウドへ移行をシミュレートする特別なプランが含まれています。この計画は、最適なテンプレート(最も適切なコンピューティングリソース)と、ワークロードをホストするリージョンを選択することにより、クラウドに関するコストを最適化することに重点を置いています。分析によって、予約済みインスタンス(RI)に適したオンプレミスのワークロードが検出された場合は、それらのテンプレートに移行することを推奨します。また、より大きい RI キャパシティを購入することも推奨します。移行する仮想マシンのグループ(ソース)ごとに、移行先を指定する必要があります。
入力例:
"migrateList": [
{
"projectionDay": 0, "source": {
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "VirtualMachine", "severity": "Major"
},
"destination": {
"uuid": "GROUP-PMsByTargetType_Azure", "displayName": "PMs_Azure", "className": "PhysicalMachine"
}
},
{
"projectionDay": 0, "source": {
"uuid": "fe23c8642efc5ad2ed4fa1cc502dfb179b8dc9d2", "displayName": "Development DC1_vm",
"className": "VirtualMachine", "severity": "Major"
},
"destination": {
"uuid": "GROUP-PMsByTargetType_Azure", "displayName": "PMs_Azure", "className": "PhysicalMachine"
}
},
{
"projectionDay": 0, "source": {
"uuid": "f0e26cb417d8143173270b7f01c7213e027cd9e5", "displayName": "Development DC7_vm",
"className": "VirtualMachine", "severity": "Major"
},
"destination": {
"uuid": "GROUP-PMsByTargetType_Azure", "displayName": "PMs_Azure", "className": "PhysicalMachine"
}
}
]
圧力解放
このパラメータを使用すると圧力緩和(Alleviate Pressure)プランが作成され、負荷のかかるクラスタまたはホットクラスタから、より多くのヘッドルームを有するクラスタへワークロードを移行する方法を確認できます。
入力例:
"relievePressureList": [
{
"projectionDay": 0, "sources": [
{
"uuid": "11c63ebd77647e7b9c9fb85dd2d4c77464cbeac2", "displayName": "DC13\\DC13-Cluster",
"className": "Cluster"
}
],
"destinations": [
{
"uuid": "57a4026a69ba4b46ebc430cb62d5c55eeea00695", "displayName": "DC13\\Physical Hosts_Cluster2 - Intel", "className": "Cluster"
}
]
}
]
ワークロードの削除
シナリオ構成でワークロードを削除すると、環境内の VM またはコンテナの密度が低下した場合の影響がシミュレートされます。VM グループや個々の VM を削除できます。
入力例:
"removeList": [
{
"projectionDay": 0, "target": {
"uuid": "5E4F6056-8783-45BC-9070-35CF09457E98"、
"displayName": "AH-TestHyperV-VM001", "className": "VirtualMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "421d62c2-964a-0f4f-32cb-ec4cec9e26db", "displayName": "Anshuman_MidServer", "className": "VirtualMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "421e048b-f66b-539c-f743-7dcc7b40943b", "displayName": "Gilad_XL_Storage_Testing - Pure-1", "className": "VirtualMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "421e9199-7159-04f2-29fc-6a501f44d1be",
"displayName": "Gilad_XL_Storage_Testing - Pure-2", "className": "VirtualMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "421d9ec6-ab97-84d0-4b12-2db88ae43e2a", "displayName": "MS-SQLServer-3",
"className": "VirtualMachine"
}
}
]
ワークロードの置き換え
ワークロードを置き換える場合は、変更する VM またはコンテナ(ターゲット)を 1 つ以上選択してから、その場所で使用するテンプレートを選択します。
入力例:
"replaceList": [
{
"projectionDay": 0, "target": {
"uuid": "421ef003-e152-5a25-6e03-19698340cd01",
"displayName": "centos_imp_7", "className": "VirtualMachine", "severity": "Minor"
},
"template": {
"uuid": "_wIBz8Jj4EeC6nYMiQT1jqA", "displayName": "Microsoft_SQL2008-small", "className": "VirtualMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "42001807-bc8f-b144-8ff6-eb0d0d32cc7a", "displayName": "cheuk-OpsMgr-172.113", "className": "VirtualMachine",
"severity": "Minor"
},
"template": {
"uuid": "_wIBz8Jj4EeC6nYMiQT1jqA", "displayName": "Microsoft_SQL2008-small", "className": "VirtualMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4211806a-65f2-8be1-1015-a4abe1a2ab6f", "displayName": "dim-dc13amd-6.2.7_01", "className": "VirtualMachine",
"severity": "Minor"
},
"template": {
"uuid": "_wIBz8Jj4EeC6nYMiQT1jqA", "displayName": "Microsoft_SQL2008-small", "className": "VirtualMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "42008beb-264e-b0f6-2295-f3443e4ce7d6", "displayName": "enOpenShiftInfra1", "className": "VirtualMachine",
"severity": "Minor"
},
"template": {
"uuid": "_wIBz8Jj4EeC6nYMiQT1jqA", "displayName": "Microsoft_SQL2008-small", "className": "VirtualMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "420036f6-27c3-0252-439d-e23bcff63d02",
"displayName": "enOpenShiftInfra2", "className": "VirtualMachine", "severity": "Minor"
},
"template": {
"uuid": "_wIBz8Jj4EeC6nYMiQT1jqA", "displayName": "Microsoft_SQL2008-small", "className": "VirtualMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4200ba09-71eb-3084-026e-1770c23abaa4", "displayName": "enOpenshiftDNS",
"className": "VirtualMachine", "severity": "Minor"
},
"template": {
"uuid": "_wIBz8Jj4EeC6nYMiQT1jqA", "displayName": "Microsoft_SQL2008-small", "className": "VirtualMachineProfile"
}
}
]
基本的なシナリオの POST と応答
ほとんどのシナリオは、複数の構成変更で構成されています。ただし、UI には、プラン タイプに基づいたカスタム構成の開始点がいくつかあります。
Workload Optimization Manager は、/scenarios エンドポイントを介して API で同じ開始点を提供し、POST 呼び出しとサーバー応答の次のリストを提供します。
次の例は、1 つの目的を達成するように簡略化されています。次の例と組み合わせて選択できるオプションは他にもたくさんあります。
ワークロード POST を追加します:
{
"configChanges": {
"addPolicyList": [],
"automationSettingList": [], "removeConstraintList": [], "removePolicyList": [], "riSettingList": [], "osMigrationSettingList": [], "subscription": {}
},
"displayName": "Add Workload- Basic", "loadChanges": {
"loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [ 0
],
"scope": [
{
"uuid": "Market",
"displayName": "Global Environment", "className": "Market"
}
],
"topologyChanges": {
"addList": [
{
"count": 50, "projectionDays": [
0
],
"target": {
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine"
}
}
],
"migrateList": [],
"removeList": [],
"replaceList": [], "relievePressureList": []
},
"type": "ADD_WORKLOAD"
}
応答:
{
"uuid": "2502057162928",
"displayName": "Add Workload- Basic", "owners": [
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "ADD_WORKLOAD",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
],
"projectionDays": [
0
],
"topologyChanges": {
"addList": [
{
"projectionDays": [
0
],
"target": {
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine"
},
"count": 50
}
]
},
"loadChanges": {},
"configChanges": {}, "changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [ 0
]
},
{
"index": 3, "type": "ADDED",
"description": "50 AJ_Test", "targets": [
{
"uuid": "421dd4ce-a4c1-231a-71e7-64fbf598bc65", "displayName": "AJ_Test",
"className": "VirtualMachine", "severity": "Major"
}
],
"value": "50", "projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
Decommission Hosts POST:
{
"configChanges": {
"addPolicyList": [], "automationSettingList": [
{
"uuid": "provisionPM",
"displayName": "PROVISION for PHYSICALMACHINES disabled", "value": "false",
"entityType": "PhysicalMachine"
}
],
"removeConstraintList": [], "removePolicyList": [], "riSettingList": [], "osMigrationSettingList": [], "subscription": {}
},
"displayName": "Decommission Hosts- Basic", "loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [
0
],
"scope": [
{
"uuid": "Market",
"displayName": "Global Environment", "className": "Market"
}
],
"topologyChanges": {
"addList": [],
"migrateList": [], "removeList": [
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
"displayName": "dell-pe1944.corp.vmturbo.com", "className": "PhysicalMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
"displayName": "dell-pe1953.corp.vmturbo.com", "className": "PhysicalMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
"displayName": "dell-pe1954.corp.vmturbo.com", "className": "PhysicalMachine"
}
}
],
"replaceList": [], "relievePressureList": []
},
"type": "DECOMMISSION_HOST"
}
応答:
{
"uuid": "2502061312640",
"displayName": "Decommission Hosts- Basic", "owners": [
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "DECOMMISSION_HOST",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
],
"projectionDays": [
0
],
"topologyChanges": {
"removeList": [
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
"displayName": "dell-pe1944.corp.vmturbo.com", "className": "PhysicalMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
"displayName": "dell-pe1953.corp.vmturbo.com", "className": "PhysicalMachine"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
"displayName": "dell-pe1954.corp.vmturbo.com", "className": "PhysicalMachine"
}
}
]
},
"loadChanges": {}, "configChanges": {
"automationSettingList": [
{
"uuid": "provisionPM", "displayName": "Provision", "value": "false", "defaultValue": "RECOMMEND", "valueType": "STRING", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automated",
"value": "AUTOMATIC"
}
],
"entityType": "PhysicalMachine", "sourceGroupName": "Global"
}
]
},
"changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [
0
]
},
{
"index": 3, "type": "REMOVED",
"description": "dell-pe1944.corp.vmturbo.com", "targets": [
{
"uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
"displayName": "dell-pe1944.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
}
],
"value": "1", "projectionDays": [
0
]
},
{
"index": 4, "type": "REMOVED",
"description": "dell-pe1953.corp.vmturbo.com", "targets": [
{
"uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
"displayName": "dell-pe1953.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
}
],
"value": "1", "projectionDays": [
0
]
},
{
"index": 5, "type": "REMOVED",
"description": "dell-pe1954.corp.vmturbo.com", "targets": [
{
"uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
"displayName": "dell-pe1954.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
}
],
"value": "1", "projectionDays": [
0
]
},
{
"index": 6,
"type": "SET_ACTION_SETTING",
"description": "Provision for PhysicalMachine disabled", "targets": [
{
"uuid": "PhysicalMachine"
}
],
"value": "PhysicalMachine", "enable": false,
"name": "provision", "projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
Migrate to Cloud POST:
{
"configChanges": {
"addPolicyList": [], "automationSettingList": [], "removeConstraintList": [], "removePolicyList": [],
"riSettingList": [], "osMigrationSettingList": [], "subscription": {}
},
"displayName": "Migrate to Public Cloud- Basic", "loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [
0
],
"scope": [
{
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"groupType": "VirtualMachine", "className": "Group"
},
{
"uuid": "_lRrTYB--EeewItqBJctLGw", "displayName": "All Cloud Zones", "groupType": "PhysicalMachine", "className": "Group"
}
],
"topologyChanges": {
"addList": [], "migrateList": [
{
"projectionDay": 0, "source": {
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "VirtualMachine"
},
"destination": {
"uuid": "_lRrTYB--EeewItqBJctLGw", "displayName": "All Cloud Zones", "className": "PhysicalMachine"
}
}
],
"removeList": [
{
"projectionDay": 0, "target": {
"uuid": "_nuoxwETSEemi-4wSMHOOWA", "displayName": "All VMs In All Cloud Zones", "className": "VirtualMachine"
}
}
],
"replaceList": [],
"relievePressureList": []
},
"type": "CLOUD_MIGRATION"
}
応答:
{
"uuid": "2502081867536",
"displayName": "Migrate to Public Cloud- Basic", "loadChanges": {
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "CLOUD_MIGRATION"
"scope": [
{
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "Group", "groupType": "VirtualMachine", "isStatic": true, "logicalOperator": "AND"
},
{
"uuid": "_lRrTYB--EeewItqBJctLGw", "displayName": "All Cloud Zones", "className": "PhysicalMachine"
"groupType": "PhysicalMachine", "isStatic": true, "logicalOperator": "AND"
}
],
"projectionDays": [
0
],
"topologyChanges": {
"removeList": [
{
"projectionDay": 0, "target": {
"uuid": "_nuoxwETSEemi-4wSMHOOWA", "displayName": "All VMs In All Cloud Zones", "className": "Group"
}
}
],
"移行リスト": [
{
"projectionDay": 0, "source": {
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "Group"
},
"destination": {
"uuid": "_lRrTYB--EeewItqBJctLGw", "displayName": "All Cloud Zones", "className": "Group"
}
}
]
},
"loadChanges": {}, "configChanges": {
"osMigrationSettingList": [
{
"uuid": "matchToSource", "value": "true"
}
]
},
"changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "Group", "entitiesCount": 83, "groupType": "VirtualMachine", "severity": "Major", "logicalOperator": "AND"
},
{
"uuid": "_lRrTYB--EeewItqBJctLGw", "displayName": "All Cloud Zones", "className": "Group"
"entitiesCount": 78,
"groupType": "PhysicalMachine", "severity": "Normal", "logicalOperator": "AND"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [
0
]
},
{
"index": 3, "type": "REMOVED",
"description": "All VMs In All Cloud Zones", "targets": [
{
"uuid": "_nuoxwETSEemi-4wSMHOOWA",
"displayName": "すべてのクラウド ゾーンのすべての VM",
"className": "グループ",
"entitiesCount": 154, "groupType": "VirtualMachine", "severity": "Major", "logicalOperator": "AND"
}
],
"value": "1", "projectionDays": [
0
]
},
{
"index": 4,
"type": "MIGRATION",
"description": "Migrate [ACM_vm] to All Cloud Zones", "targets": [
{
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "Group", "entitiesCount": 83, "groupType": "VirtualMachine", "severity": "Major", "logicalOperator": "AND"
},
{
"uuid": "_lRrTYB--EeewItqBJctLGw", "displayName": "All Cloud Zones", "className": "Group", "entitiesCount": 78,
"groupType": "PhysicalMachine", "severity": "Normal", "logicalOperator": "AND"
}
],
"projectionDays": [
0
]
},
{
"index": 5,
"type": "SET_TARGET_OS",
"targets": [
{
"uuid": "4656c0ba6b976d05d1a9470ee673672022e8e926", "displayName": "ACM_vm",
"className": "Group", "entitiesCount": 83, "groupType": "VirtualMachine", "severity": "Major", "logicalOperator": "AND"
}
],
"projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
Optimize Cloud POST:
{
"configChanges": {
"addPolicyList": [], "automationSettingList": [
{
"uuid": "resize",
"displayName": "resize for VMS enabled", "value": "true",
"entityType": "VirtualMachine"
}
],
"removeConstraintList": [], "removePolicyList": [], "riSettingList": [
{
"uuid": "preferredOfferingClass", "displayName": "Type",
"value": "STANDARD",
"entityType": "STANDARD"
},
{
"uuid": "preferredTerm", "displayName": "Term", "value": "YEARS_3", "entityType": "YEARS_3"
},
{
"uuid": "preferredPaymentOption", "displayName": "Payment", "value": "ALL_UPFRONT",
"entityType": "ALL_UPFRONT"
},
{
"uuid": "preferredCoverage", "displayName": "Coverage",
"value": "80",
"entityType": "80"
},
{
"uuid": "riCoverageOverride", "displayName": "RI Coverage Override", "value": "false",
"entityType": "false"
}
],
"osMigrationSettingList": [], "subscription": {}
},
"displayName": "Optimize Cloud- Basic", "loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [
0
],
"scope": [
{
"uuid": "GROUP-PMsByTargetType_AWS", "displayName": "PMs_AWS", "groupType": "PhysicalMachine", "className": "Group"
}
],
"topologyChanges": {
"addList": [],
"migrateList": [],
"removeList": [],
"replaceList": [], "relievePressureList": []
},
"type": "OPTIMIZE_CLOUD"
}
応答:
{
"uuid": "2502117573632",
"displayName": "Optimize Cloud- Basic", "owners": [
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "OPTIMIZE_CLOUD",
"scope": [
{
"uuid": "be95c99fc2a2195ac896204766a52d0e141818a6", "displayName": "PMs_AWS",
"className": "Group", "groupType": "PhysicalMachine", "isStatic": true, "logicalOperator": "AND"
}
],
"projectionDays": [
0
],
"topologyChanges": {}, "loadChanges": {}, "configChanges": {
"automationSettingList": [
{
"uuid": "resize", "displayName": "resize", "value": "true"
}
],
"riSettingList": [
{
"uuid": "preferredPaymentOption", "displayName": "Payment", "value": "ALL_UPFRONT",
"defaultValue": "ALL_UPFRONT", "valueType": "STRING", "options": [
{
"label": "ALL_UPFRONT", "value": "ALL_UPFRONT"
},
{
"label": "PARTIAL_UPFRONT", "value": "PARTIAL_UPFRONT"
},
{
"label": "NO_UPFRONT", "value": "NO_UPFRONT"
}
],
"sourceGroupName": "Global"
},
{
"uuid": "preferredTerm", "displayName": "Term", "value": "YEARS_3", "defaultValue": "YEARS_1", "valueType": "STRING", "options": [
{
"label": "YEARS_1", "value": "YEARS_1"
},
{
"label": "YEARS_3", "value": "YEARS_3"
}
],
"sourceGroupName": "Global"
},
{
"uuid": "preferredCoverage", "displayName": "Coverage", "value": "80",
"defaultValue": "80", "valueType": "NUMERIC", "min": 0,
"max": 100, "sourceGroupName": "Global"
},
{
"uuid": "riCoverageOverride", "displayName": "RI Coverage Override", "value": "false",
"defaultValue": "false", "valueType": "BOOLEAN", "sourceGroupName": "Global"
},
{
"uuid": "preferredOfferingClass", "displayName": "Type",
"value": "STANDARD",
"defaultValue": "STANDARD", "valueType": "STRING", "options": [
{
"label": "STANDARD", "value": "STANDARD"
},
{
"label": "CONVERTIBLE", "value": "CONVERTIBLE"
}
],
"sourceGroupName": "Global"
}
]
},
"changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "be95c99fc2a2195ac896204766a52d0e141818a6", "displayName": "PMs_AWS",
"className": "Group", "entitiesCount": 50, "groupType": "PhysicalMachine", "severity": "Normal", "logicalOperator": "AND"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [
0
]
},
{
"index": 3, "type": "ENABLED",
"description": "Resize enabled", "targets": [],
"enable": true, "projectionDays": [
0
]
},
{
"index": 4,
"type": "RI_SETTINGS",
"targets": [
{
"uuid": "preferredPaymentOption|ALL_UPFRONT"
},
{
"uuid": "preferredTerm|YEARS_3"
},
{
"uuid": "preferredCoverage|80"
},
{
"uuid": "riCoverageOverride|false"
},
{
"uuid": "preferredOfferingClass|STANDARD"
}
],
"projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
On-Prem Workload Migration (Cluster to Cluster) POST:
{
"configChanges": {
"addPolicyList": [],
"automationSettingList": [], "removeConstraintList": [], "removePolicyList": [], "riSettingList": [], "osMigrationSettingList": [], "subscription": {}
},
"displayName": "On-Prem Workload Migration 1", "loadChanges": {
"utilizationList": []、"maxUtilizationList": []
},
"projectionDays": [
0
],
"scope": [
{
"uuid": "3e47ff3351f3247367c00c08fdc5bb974695c443", "displayName": "DC23-Datacenter\\DC23-cluster1", "groupType": "PhysicalMachine",
"className": "Cluster"
}
],
"topologyChanges": {
"addList": [
{
"count": 1, "projectionDays": [
0
],
"target": {
"uuid": "67d24a6f265151876e87f39475fb4ee4b4170098",
"displayName": "AvailabilitySet::ARSEN-AVS-NCUS", "className": "VirtualMachine"
}
}
],
"migrateList": [],
"removeList": [],
"replaceList": [], "relievePressureList": []
},
"type": "WORKLOAD_MIGRATION"
}
応答:
{
"uuid": "2502063893936",
"displayName": "On-Prem Workload Migration- Basic", "loadChanges": {
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "WORKLOAD_MIGRATION",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
],
"projectionDays": [
0
],
"topologyChanges": {
"addList": [
{
"projectionDays": [
0
],
"target": {
"uuid": "a6d365f4fbf03fb9a2e8cdb29e38045e31cee41b", "displayName": "Beta DC6_vm",
"className": "Group"
},
"count": 1
}
]
},
"loadChanges": {},
"configChanges": {}, "changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [ 0
]
},
{
"index": 3, "type": "ADDED",
"description": "1 Beta DC6_vm", "targets": [
{
"uuid": "a6d365f4fbf03fb9a2e8cdb29e38045e31cee41b", "displayName": "Beta DC6_vm",
"className": "Group", "entitiesCount": 56, "groupType": "VirtualMachine", "severity": "Major", "logicalOperator": "AND"
}
],
"value": "1", "projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
Hardware Refresh
{
"configChanges": {
"addPolicyList": [], "automationSettingList": [], "removeConstraintList": [], "removePolicyList": [], "riSettingList": [], "osMigrationSettingList": [], "subscription": {}
},
"displayName": "Hardware Refresh- Basic", "loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [ 0
],
"scope": [
{
"uuid": "Market",
"displayName": "Global Environment", "className": "Market"
}
],
"topologyChanges": {
"addList": [],
"migrateList": [],
"removeList": []、"replaceList": [
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
"displayName": "dell-pe1944.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
"displayName": "dell-pe1953.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
"displayName": "dell-pe1954.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "Virtual_ESX_4238e933-3923-8334-37fe-3aec8fbd046f", "displayName": "hp-esx22.dev.mycorp.com",
"className": "PhysicalMachine",
"severity": "Critical"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
}
],
"relievePressureList": []
},
"type": "RECONFIGURE_HARDWARE"
}
応答:
{
"uuid": "2502070918448",
"displayName": "Hardware Refresh- Basic", "owners": [
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "RECONFIGURE_HARDWARE",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
],
"projectionDays": [ 0
],
"topologyChanges": {
"replaceList": [
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
"displayName": "dell-pe1944.corp.vmturbo.com", "className": "PhysicalMachine"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
},
{
"projectionDay": 0,
"target": {
"uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
"displayName": "dell-pe1953.corp.vmturbo.com",
"className": "PhysicalMachine"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
"displayName": "dell-pe1954.corp.vmturbo.com",
"className": "PhysicalMachine"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
},
{
"projectionDay": 0, "target": {
"uuid": "Virtual_ESX_4238e933-3923-8334-37fe-3aec8fbd046f", "displayName": "hp-esx22.dev.mycorp.com",
"className": "PhysicalMachine"
},
"template": {
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
}
]
},
"loadChanges": {},
"configChanges": {}, "changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [
0
]
},
{
"index": 3,
"type": "REPLACED",
"description": "Replace [dell-pe1944.corp.vmturbo.com, dell-pe1953.corp.vmturbo.com, dell-pe1954.c orp.vmturbo.com, hp-esx... with HP_DL580 G7",
"targets": [
{
"uuid": "4C4C4544-0042-5A10-804A-B1C04F384331",
"displayName": "dell-pe1944.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
},
{
"uuid": "4C4C4544-004A-3610-8057-C8C04F464331",
"displayName": "dell-pe1953.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
},
{
"uuid": "4C4C4544-0059-4D10-8030-B3C04F464331",
"displayName": "dell-pe1954.corp.vmturbo.com", "className": "PhysicalMachine",
"severity": "Critical"
},
{
"uuid": "Virtual_ESX_4238e933-3923-8334-37fe-3aec8fbd046f", "displayName": "hp-esx22.dev.mycorp.com",
"className": "PhysicalMachine", "severity": "Critical"
},
{
"uuid": "_juCtwJkfEeCX4rLBy_KD2g", "displayName": "HP_DL580 G7", "className": "PhysicalMachineProfile"
}
],
"value": "0", "projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
Alleviate Pressure POST:
{
"configChanges": {
"addPolicyList": [], "automationSettingList": [], "removeConstraintList": [], "removePolicyList": [], "riSettingList": [], "osMigrationSettingList": [], "subscription": {}
},
"displayName": "Alleviate Pressure- Basic", "loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [ 0
],
"scope": [
{
"uuid": "11c63ebd77647e7b9c9fb85dd2d4c77464cbeac2", "displayName": "DC13\\DC13-Cluster",
"className": "Cluster"
},
{
"uuid": "57a4026a69ba4b46ebc430cb62d5c55eeea00695", "displayName": "DC13\\Physical Hosts_Cluster2 - Intel", "className": "Cluster"
}
],
"topologyChanges": {
"addList": [],
"migrateList": [],
"removeList": [],
"replaceList": [], "relievePressureList": [
{
"projectionDay": 0, "sources": [
{
"uuid": "11c63ebd77647e7b9c9fb85dd2d4c77464cbeac2", "displayName": "DC13\\DC13-Cluster",
"className": "Cluster"
}
],
"destinations": [
{
"uuid": "57a4026a69ba4b46ebc430cb62d5c55eeea00695", "displayName": "DC13\\Physical Hosts_Cluster2 - Intel", "className": "Cluster"
}
]
}
]
},
"タイプ": "ALLEVIATE_PRESSURE"
}
応答:
{
"uuid": "2531404249984",
"displayName": "On-Prem Workload Migration 1", "owners": [
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "WORKLOAD_MIGRATION",
"scope": [
{
"uuid": "3e47ff3351f3247367c00c08fdc5bb974695c443", "displayName": "DC23-Datacenter\\DC23-cluster1", "className": "Cluster",
"groupType": "PhysicalMachine", "isStatic": true, "logicalOperator": "AND"
}
],
"projectionDays": [
0
],
"topologyChanges": {
"addList": [
{
"projectionDays": [
0
],
"target": {
"uuid": "67d24a6f265151876e87f39475fb4ee4b4170098",
"displayName": "AvailabilitySet::ARSEN-AVS-NCUS", "className": "DiscoveredGroup"
},
"count": 1
}
]
},
"loadChanges": {},
"configChanges": {}, "changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "3e47ff3351f3247367c00c08fdc5bb974695c443",
"displayName": "DC23-Datacenter\\DC23-cluster1", "className": "Cluster",
"entitiesCount": 3, "groupType": "PhysicalMachine", "severity": "Critical", "logicalOperator": "AND"
}
]
},
{
"index": 2,
"type": "PROJECTION_PERIODS",
"projectionDays": [
0
]
},
{
"index": 3, "type": "ADDED",
"description": "1 AvailabilitySet::ARSEN-AVS-NCUS", "targets": [
{
"uuid": "67d24a6f265151876e87f39475fb4ee4b4170098",
"displayName": "AvailabilitySet::ARSEN-AVS-NCUS", "className": "DiscoveredGroup",
"entitiesCount": 3, "groupType": "VirtualMachine", "severity": "Critical", "logicalOperator": "AND"
}
],
"value": "1", "projectionDays": [
0
]
}
],
"timebasedTopologyChanges": {}
}
現在の環境の最適化
カスタム構成なしでプランを実行すると、現在のすべてのポリシーと制約を考慮して、現在の環境が最適化されます。
POST:
{
"configChanges": {
"addPolicyList": [], "automationSettingList": [], "removeConstraintList": [], "removePolicyList": [], "riSettingList": [], "osMigrationSettingList": [],
"subscription": {}
},
"displayName": "Custom- No Config", "loadChanges": {
"utilizationList": [], "maxUtilizationList": []
},
"projectionDays": [], "scope": [
{
"uuid": "Market",
"displayName": "Global Environment", "className": "Market"
}
],
"topologyChanges": {
"addList": [],
"migrateList": [],
"removeList": [],
"replaceList": [], "relievePressureList": []
},
"type": "CUSTOM"
}
応答:
{
"uuid": "2502119526800",
"displayName": "Custom- No Config", "loadChanges": {
{
"uuid": "_4T_7kwY-Ed-WUKbEYSVIDw", "username": "administrator", "showSharedUserSC": false
}
],
"type": "CUSTOM",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
],
"changes": [
{
"index": 1, "type": "SCOPE",
"scope": [
{
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
}
]
}
]
}
将来の負荷プラン
将来の負荷プランは、アクティブな VM からのコモディティを取得してパッシブまたは低ワークロードの VM に適用し、これらのパッシブ VM がアクティブになった場合の環境への影響をシミュレートする、一種のプランです。たとえば、ディザスタリカバリ VM が過去のピーク値で強制的に実行された場合の、環境への影響を調査することができます。この場合、コモディティが使用される実稼働 VM がアクティブ VM であり、現在アイドル状態のディザスタリカバリ VM がパッシブ VM です。
現在、将来の負荷プランには 2 つのタイプがあります。
■ PEAKOFPEAKS
ピークオブピークの将来の負荷プランでは、パッシブ VM 内にアクティブ VM のすべてのコモディティを複製し、同時に過去のピーク使用率に到達させて、プランの結果で環境への影響を判断します。
■ カスタム
カスタムの将来の負荷プランでは、パッシブ VM 内にアクティブ VM のすべてのコモディティを複製し、同時に現在の使用率に到達させて、プランの結果で環境への影響を判断します。
両方の将来の負荷プランのセットアップと構成では、type パラメータの内容のみが異なり、他のすべての手順は同じです。
シナリオで行う設定は、ユーザーインターフェイスで行うことができるプラン設定に対応しています。これには、以下が含まれます。
■ プラン範囲
■ ワークロードの変更(VM またはコンテナの追加、削除、または置換)
■ 供給の変更(PM の追加、削除、交換または保管)
■ 配置ポリシーとその他の制約を有効/無効にする
■ アクションモードの変更
■ 供給のプロビジョニングを有効/無効にする
■ ワークロードのサイズ変更を有効/無効にする
将来の負荷の前提条件
将来の負荷プランを実行するには、プランに含めるエンティティの統計を取得する必要があります。通常、これは POST /markets/market_uuid/entities/stats リクエストを使用して、startDate および scopes パラメータを使用して行われます。
統計取得の入力例:
{
"period": {
"startDate": 1237056032
},
"scopes": [
"4223ae0c-c99b-f6ca-c1ef-3f367bdf5528", "4223bb37-0090-f332-0140-cc3cce7b3735",
"4223dc55-78f2-2cd7-9abf-b09b1be835b4", "42231932-83af-10d9-f0cd-26c8a08a9e18", "422374a3-2c64-b613-a9a7-1f900a2314b4"
]
}
呼び出しが完了したら、応答全体をコピーします。Swagger を使用している場合は、応答の横にある [ダウンロード(Download)] ボタンをクリックして、ファイルの内容をコピーします。
将来の負荷プランの実行
ScenarioApiDTO を作成すると、作成したシナリオの uuid が応答に含まれます。この uuid をマーケットの uuid とともに使用して、POST /markets/market_uuid/scenarios/ scenario_uuid リクエストで(通常はリアルタイムマーケット)に対して計画を実行します。
ピークオブピークプランの表示
プランを実行すると、作成されたプランマーケットの uuid が応答に含まれることに注意してください。結果は、GET /markets/market_uuid リクエストを使用して表示できます。
Workload Optimization Manager のスケジュールで、特定のイベントが発生する可能性がある特定の時間範囲を指定します。Workload Optimization Manager は現在、ポリシーが特定のアクションを実行できる時間枠、または分析やアクションの生成に影響を与える設定をポリシーが変更する時間枠を設定するために、範囲を指定したポリシーにスケジュールを使用しています。
注:サイズ変更アクションのスケジュール期間を設定する際、Workload Optimization Manager がスケジュール済みの時間中にアクションを実行するようにするには、そのスケジュール済みのポリシーに対して [Enforce Non Disruptive Mode]の設定をオフにする必要があります。グローバルポリシーの設定をオフにした場合も、スケジュール済みのポリシーの設定をオフにする必要があります。そうしないと、Workload Optimization Manager はサイズ変更アクションを実行しません。
スケジュールエンドポイントを使用すると、次のことができます:
■ すべてのスケジュールのリストを取得する
■ 指定されたスケジュールを取得する
■ 新しいスケジュールを作成する
■ スケジュールの編集
■ ライセンスを削除する
■ 指定されたスケジュールを使用してすべてのポリシーを表示する
スケジュールの取得
スケジュールのリストを取得します。スケジュールのリストの場合、API は ScheduleApiDTO の配列を返します。各 ScheduleApiDTO には、開始時刻と終了時刻、日付、繰り返しなど、スケジュールに関する詳細が含まれます。単一のスケジュールを取得するには、リクエストに通知の UUID を含めます。
例:
■ すべてのスケジュール:GET https://10.10.10.10/api/v3/schedules
■ 単一のスケジュール:GET https://10.10.10.10/api/v3/schedules/284466929277824
応答:
[
{
"uuid": "284466927892512",
"displayName": "DalSched1",
"startTime": "2020-02-29T16:30",
"endTime": "2020-02-29T19:30",
"recurrence": {
"type": "WEEKLY",
"daysOfWeek": [
"Mon",
"Fri"
],
"interval": 1
},
"timeZone": "America/Denver", "nextOccurrence": "2020-03-02T16:30:00", "nextOccurrenceTimestamp": 1583191800000
},
{
"uuid": "284466929277824",
"displayName": "DalSched2", "startTime": "2020-02-29T16:30", "endTime": "2020-02-29T17:45",
"recurrence": {
"type": "MONTHLY",
"daysOfMonth": [
5
],
"interval": 3
},
"timeZone": "America/Denver", "nextOccurrence": "2020-03-02T16:30:00", "nextOccurrenceTimestamp": 1583191800000
}
]
スケジュールの追加
Workload Optimization Manager でスケジュールを作成するには、有効な ScheduleApiDTO を指定する必要があります。
例:POST https://10.10.10.10/api/v3/schedules
2019 年 12 月 20 日に始まり、終了日がなく、金曜日の 0000 から 0400 の時間帯に毎週実行されるスケジュールを示す入力例:
{
"displayName":"DallasSched", "endTime":"2019-12-20T04:00", "startTime":"2019-12-20T00:00",
"timeZone":"America/Denver", "recurrence":{
"type":"WEEKLY",
"interval":1, "daysOfWeek":[
"Fri"
]
}
}
スケジュールを使用したポリシーの取得
スケジュール ID を指定して、そのスケジュールに関連付けられているポリシーを取得します。
例:GET https://10.10.10.10/api/v3/schedules/284466929277824/settingsPolicy
応答:指定されたスケジュールを使用するポリシーを表す SettingspolicyApiDTO の配列。
[
{
"uuid": "284466929430656",
"displayName": "DalStorage", "entityType": "Storage", "scopes": [
{
"uuid": "284460958528132",
"displayName": "HawthorneHC_datastore", "isStatic": true,
"logicalOperator": "AND"
}
],
"settingsManagers": [
{
"uuid": "automationmanager", "displayName": "Action Mode Settings", "category": "Automation",
"settings": [
{
"uuid": "サスペンド", "displayName": "サスペンド", "value": "MANUAL",
"defaultValue": "MANUAL", "valueType": "STRING", "valueObjectType": "String", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automated", "value": "AUTOMATIC"
}
],
"entityType": "Storage"
}
]
}
],
"schedule": {
"uuid": "284466929277824",
"displayName": "DalSched2", "startTime": "2020-02-29T16:30", "endTime": "2020-02-29T17:45",
"recurrence": {
"type": "MONTHLY",
"daysOfMonth": [
5
],
"interval": 3
},
"timeZone": "America/Denver", "nextOccurrence": "2020-03-02T16:30:00", "nextOccurrenceTimestamp": 1583191800000
},
"disabled": false, "readOnly": false, "default": false
}
]
スケジュールを作成するときは、複数のタイミング基準を設定できます。以下は、高度なタイミングの例を含むスケジュールです。基本的なスケジュールについては、スケジュールエンドポイント(209 ページ)を参照してください。
特定の日の隔週スケジュール
このスケジュールは、"type": "WEEKLY" および "interval": 2 フィールドにより、隔週実行に設定されます。さらに、
daysOfWeek 配列での指定により、このスケジュールは月曜日、水曜日、および金曜日にアクティブになります。
InputDTO:
{
"displayName":"Schedule1", "endDate":"2020-07-10",
"endTime":"2020-05-06T19:30", "startTime":"2020-05-06T15:30",
"timeZone":"America/Denver", "recurrence":{
"type":"WEEKLY",
"interval":2, "daysOfWeek":[
"Mon",
"Wed", "Fri"
]
}
}
このスケジュールの API 応答:
{
"uuid":"284559431391120",
"displayName":"DallasTest", "endDate":"2020-07-10", "startTime":"2020-05-06T15:30", "endTime":"2020-05-06T19:30",
"recurrence":{
"type":"WEEKLY",
"daysOfWeek":[
"Mon",
"Wed", "Fri"
],
"interval":2
},
"timeZone":"America/Denver", "nextOccurrence":"2020-05-06T15:30:00", "nextOccurrenceTimestamp":1588800600000
}
月の特定の週を含む 6 か月ごとのスケジュール
このスケジュールは、"type":"MONTHLY" および "interval":6 フィールドで示されているように、6 か月ごとに実行されるように設定されています。daysOfWeek 配列は、このスケジュールは水曜日にアクティブになること、"weekOfTheMonth":2 は、このスケジュールが月の第 2 週にのみ実行されることを示します。
このスケジュールは 2020 年 5 月 5 日に作成されたものです。API 応答のタイムスタンプを人間が読める日付に変換すると、次の実行は 2020 年 5 月 13 日水曜日の午後 3 時 30 分、つまり 5 月の第 2 水曜日であることがわかります。
Input DTO:
{
"displayName":"DallasTest2", "endDate":"2020-10-19",
"endTime":"2020-05-06T19:15", "startTime":"2020-05-06T15:30",
"timeZone":"America/Denver", "recurrence":{
"type":"MONTHLY",
"interval":6, "daysOfWeek":[
"Wed"
],
"weekOfTheMonth":[ 2
]
}
}
このスケジュールの API 応答:
{
"uuid":"284559434037456",
"displayName":"DallasTest2", "endDate":"2020-10-19", "startTime":"2020-05-06T15:30", "endTime":"2020-05-06T19:15",
"recurrence":{
"type":"MONTHLY",
"daysOfWeek":[
"Wed"
],
"weekOfTheMonth":[ 2
],
"interval":6
},
"timeZone":"America/Denver", "nextOccurrence":"2020-05-13T15:30:00", "nextOccurrenceTimestamp":1589405400000
}
特定のスケジュールにアタッチされたポリシーの取得
スケジュールを使用しているポリシーを確認するには、https://10.10.10.10/api/v3/schedules/
{schedule_UUID}/settingsPolicy リクエストを使用します。
応答:指定されたスケジュールを使用するポリシーを表す SettingspolicyApiDTO の配列。その詳細も含まれています。
[
{
"uuid": "284466929430656",
"displayName": "DalStorage", "entityType": "Storage", "scopes": [
{
"uuid": "284460958528132",
"displayName": "HawthorneHC_datastore", "isStatic": true,
"logicalOperator": "AND"
}
],
"settingsManagers": [
{
"uuid": "automationmanager", "displayName": "Action Mode Settings", "category": "Automation",
"settings": [
{
"uuid": "suspend", "displayName": "Suspend",
"value": "MANUAL",
"defaultValue": "MANUAL", "valueType": "STRING", "valueObjectType": "String", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automatic", "value": "AUTOMATIC"
}
],
"entityType": "Storage"
}
]
}
],
"schedule": {
"uuid": "284466929277824",
"displayName": "DalSched2", "startTime": "2020-02-29T16:30", "endTime": "2020-02-29T17:45",
"recurrence": {
"type": "MONTHLY",
"daysOfMonth": [
5
],
"interval": 3
},
"timeZone": "America/Denver", "nextOccurrence": "2020-05-05T16:30:00", "nextOccurrenceTimestamp": 1588717800000
},
"disabled": false, "readOnly": false, "default": false
}
]
検索は、Workload Optimization Manager マーケットに参加するエンティティに対して実行されるクエリです。検索の最も一般的な用途は、特定のオブジェクト、サービスエンティティ、または特性を共有するエンティティのグループを見つけることです。
オブジェクト およびエンティティ は、Workload Optimization Manager トポロジの異なるアイテムを参照します。Workload Optimization Manager API の検索エンドポイントを使用すると、次のことができます。
■ 詳細検索やグループ構築で使用するための基準を取得する
■ Workload Optimization Manager 環境内のオブジェクトに関する詳細情報を取得する
ユーティリティリクエストは、関連するリクエストの作成、inputDTO の組み立て、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
検索エンドポイントには、Workload Optimization Manager のサプライチェーン内のエンティティタイプごとに、検索に使用できるさまざまな基準を示すユーティリティリクエストと、指定された基準のオプションを示す 2 つ目のユーティリティリクエストが含まれています。その後、この情報を使用して、より詳細なグループの検索条件を構築できます。
使用可能な filterTypes は、検索を構成するエンティティによって異なります:
Entity |
filterType オプション |
VirtualMachine |
■ vmsByName ■ vmsByPMName ■ vmsByStorage ■ vmsByNetwork ■ vmsByApplication ■ vmsByDatabaseServer ■ vmsByDatabaseServerVersion ■ vmsByDC ■ vmsByVDC ■ vmsByDCnested ■ vmsByNumCPUs ■ vmsByMem ■ vmsByGuestName ■ vmsByAltName ■ vmsByClusterName ■ vmsByDiskArrayName ■ vmsByLogicalPoolName ■ vmsByTag ■ vmsByState ■ vmsByBusinessAccountUuid ■ vmsByResourceGroupUuid |
VirtualDataCenter |
■ vdcsByName ■ vdcsByVDCName ■ vdcsByTag ■ vdcsByState |
PhysicalMachine |
■ pmsByName ■ pmsByStorage ■ pmsByNetwork |
Entity |
filterType オプション |
|
■ pmsBySwitch ■ pmsByNumVms ■ pmsByDC ■ pmsByMem ■ pmsByNumCPUs ■ pmsByVendorName ■ pmsByCPUModel ■ pmsByModel ■ pmsByTimezone ■ pmsByClusterName ■ pmsByTag ■ pmsByState |
ストレージ |
■ storageByName ■ storageByTag ■ storageByVMs ■ storageByDC ■ storageByPMCluster ■ storageByState ■ volumeByDeletable |
アプリケーション コンポーネント |
■ appSrvsByName ■ appsByName |
Web サーバー |
■ wbSrvsByName |
ビジネスアプリケーション |
■ busAppsByName |
データベース |
■ databaseByName ■ databaseByTag ■ databaseByBusinessAccountUuid ■ databaseByResourceGroupUuid |
DatabaseServer |
■ databaseServerByName ■ databaseServerByTag ■ databaseServerByBusinessAccountUuid ■ databaseServerByEngine ■ databaseServerByEdition ■ databaseServerByVersion |
VirtualApplication |
■ vappsByName |
Cluster |
■ clustersByName ■ clustersByTag |
DataCenter |
■ datacentersByName |
Entity |
filterType オプション |
|
■ datacentersByTag |
グループ |
■ groupsByName |
StorageCluster |
■ storageClustersByName |
DiskArray |
■ diskarrayByName |
ゾーン |
■ zonsByName |
[リージョン(Region)] |
■ regsByName |
ネットワーク |
■ netsByName |
ロードバランサ |
■ lbsByName |
シャーシ |
■ chasByName |
StorageController |
■ storagecontrollerByName |
DPod |
■ dpodByName |
VPod |
■ vpodByName |
LogicalPool |
■ logicalPoolByName |
スイッチ |
■ switchByName |
コンテナ |
■ containersByName ■ containersByPodName ■ containersByVMName ■ containersByNamespace ■ containerSpecsByName |
ContainerPod |
■ containerPodsByName ■ containerPodsByNamespace ■ containerPodsByVMName |
ServiceEntity |
注:ServiceEntity タイプのグループは、複数のエンティティタイプを持つ唯一のグループであり、クラウドターゲット専用に使用されます。 ■ workloadByBusinessAccountUuid ■ workloadByResourceGroupUuid |
ワークロード |
■ workloadByBusinessAccountUuid ■ workloadByResourceGroupUuid ■ workloadControllersByName ■ workloadControllersByNamespace ■ workloadControllersByKind ■ ResourceGroup ■ resourceGroupByName ■ resourceGroupByUuid ■ resourceGroupByBusinessAccountUuid |
BusinessAccount |
■ businessAccountByName ■ businessAccoutByUuid ■ subBusinessAccountOfUuid ■ businessAccountValidationStatus ■ businessAccountTargetName |
Entity |
filterType オプション |
|
■ businessAccountCloudProvider |
BillingFamily |
■ billingFamilyByName |
ViewPod |
■ viewPodByName |
DesktopPool |
■ desktopPoolByName ■ desktopPoolByViewPod |
BusinessUser |
■ businessUserByDesktopPool ■ businessUserByName ■ businessUserByViewPod |
クラウド固有のフィルタ |
■ computeTiersByName ■ computeTiersByMem ■ databaseTiersByName ■ databaseTiersByDBMem ■ databaseServerTiersByName ■ databaseServerTiersByVMem |
例:GET https://10.10.10.10/api/v3/groups
応答:エンティティタイプで区切られたフィルタ条件の配列。たとえば、仮想マシンエンティティのフィルタ条件は次のようになります:
"VirtualMachine": {
"criteria": [
{
"inputType": "*", "elements": "displayName",
"filterCategory": "property", "filterType": "vmsByName"
},
{
"inputType": "*",
"elements": "HostedBy:displayName", "filterCategory": "entity", "filterType": "vmsByPMName"
},
{
"inputType": "*",
"elements": "LayeredOver:Storage:displayName", "filterCategory": "entity",
"filterType": "vmsByStorage"
},
{
"inputType": "*",
"elements": "LayeredOver:Network:displayName", "filterCategory": "entity",
"filterType": "vmsByNetwork"
},
{
"inputType": "*",
"elements": "Hosts:Application:displayName", "filterCategory": "entity",
"filterType": "vmsByApplication"
},
{
"inputType": "*",
"elements": "HostedBy:PhysicalMachine:HostedBy:DataCenter:displayName", "filterCategory": "entity",
"filterType": "vmsByDC"
},
{
"inputType": "*",
"elements": "LayeredOver:VirtualDataCenter:displayName", "filterCategory": "entity",
"filterType": "vmsByVDC"
},
{
"inputType": "*",
"elements": "AllMemberOf:VirtualDataCenter:displayName", "filterCategory": "entity",
"filterType": "vmsByDCnested"
},
{
"inputType": "#",
"elements": "ExtendedBy:VMTopoExt:numCpus", "filterCategory": "property",
"filterType": "vmsByNumCPUs"
},
{
"inputType": "#",
"elements": "Commodities:VMem:capacity", "filterCategory": "property", "filterType": "vmsByMem"
},
{
"inputType": "*",
"elements": "ExtendedBy:VMTopoExt:guestName", "filterCategory": "property",
"filterType": "vmsByVDC"
},
{
"inputType": "*",
"elements": "ExtendedBy:VMTopoExt:altName", "filterCategory": "property",
"filterType": "vmsByVDC"
},
{
"inputType": "*",
"elements": "HostedBy:PhysicalMachine:MemberOf:Cluster:displayName", "filterCategory": "entity",
"filterType": "vmsByClusterName"
},
{
"inputType": "*",
"elements": "LayeredOver:Storage:LayeredOver:DiskArray:displayName", "filterCategory": "entity",
"filterType": "vmsByClusterName"
},
{
"inputType": "*",
"elements": "LayeredOver:Storage:LayeredOver:DiskArray:displayName", "filterCategory": "entity",
"filterType": "vmsByLogicalPoolName"
},
{
"inputType": "*",
"elements": "tags", "filterCategory": "property", "filterType": "vmsByTag"
},
{
"inputType": "*",
"elements": "state", "filterCategory": "property", "filterType": "vmsByState"
},
{
"inputType": "*",
"elements": "belongsTo:uuid", "filterCategory": "entity", "filterType": "vmsByBusinessAccountUuid"
},
{
"inputType": "*",
"elements": "MemberOf:ResourceGroup:uuid", "filterCategory": "entity",
"filterType": "vmsByResourceGroupUuid"
}
]
}
基準のオプションの取得
特定の検索条件とエンティティタイプについて、可能な値を取得できます。たとえば、特定のホスト グループのすべてのタグを取得したり、特定の仮想マシングループの使用可能な状態オプションを表示したりすることができます。このリクエストは、次のパラメータを取ります:
criteria_key |
オプションを取得する基準。現在、Workload Optimization Manager は [ state, tags ] という基準キーを受け入れます:そのほかにも結果を返す入力がありますが、内部または早期アクセスと見なされるべきものなので、それらに依存したスクリプトは作成しないでください。 |
スコープ |
基準値を取得する範囲の UUID。たとえば、特定のクラスタ内の仮想マシンのすべてのタグを取得するには、クラスタの UUID をここに入力します。 |
entity_type |
状態またはタグのオプションが返されるエンティティ。たとえば、scopes がクラスタの UUID と共に渡され、このパラメータが VirtualMachine の値と共に渡された場合、リクエストはそのクラスタ内の各仮想マシンのオプションを返します。 |
order-by |
結果を並べ替えるフィールド。[ creation_date, name, risk_category, savings, severity ]。 |
昇順 |
デフォルト:true。false の場合、結果は降順になります。 |
environment_type |
指定された環境タイプのオブジェクトのみを返します。[ Cloud, Hybrid, Onprem ] |
例:GET https://10.10.10.10/api/v3/search/criteria/state/options? scopes=7c8d50fae46c09b68b00916411469770304226b4&entity_type=VirtualMachine
応答:使用可能なオプションを含む CriteriaOptionApiDTO。たとえば、以下の応答は、UUID が渡されたクラスタ上のすべての仮想マシンがアクティブまたはアイドル状態のいずれかであることを示しています。
[
{
"value": "ACTIVE"
},
{
"value": "IDLE"
}
]
UUID によるオブジェクト情報の取得
Workload Optimization Manager 環境内のオブジェクトに関する詳細情報を取得する
オブジェクト とエンティティ は、Workload Optimization Manager トポロジの異なるアイテムを参照します。
注:
検索の場合、API は返されたデータをページネーションします。ページネーション制限を指定しない場合、API はデフォルトの制限 100 に設定されたページを返します。ページネーション制限として最大 500 を設定できます。設定を行わず、検索結果に 100 を超えるエントリが含まれている場合、結果はページ分割されます。スクリプトは、検索結果を処理するときに常にページネーションカーソルをチェックする必要があります。
Workload Optimization Manager の cr.yaml ファイルで、これらの設定のデフォルトと最大値を変更することができます。次のエントリを見つけます。
■ apiPaginationDefaultLimit
■ apiPaginationMaxLimit
objectType パラメータに Group の値を設定すると、応答には、グループ化を実行するエンティティに関連するオブジェクトが含まれます。たとえば、リソースグループとクラスタはどちらもグループ化を実行し、応答に含まれます。
検索をさらに絞り込むには、group_type パラメータの値を含めます。このパラメータは、検索するグループのメンバーシップを示します。たとえば、objectType が Group で group_type が VirtualMachine で検索すると、現在の範囲内の仮想マシンのすべてのグループが返されます。
例:https://10.10.10.10/api/v3/search/Market
応答:取得したオブジェクトに関する情報を含む DTO。この例では、取得されたアイテムは次のようなリアルタイムマーケットです:
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/markets/_0x3OYUglEd-gHc4L513yOA"
}
],
"uuid": "_0x3OYUglEd-gHc4L513yOA", "displayName": "Market", "className": "Market"
"state": "RUNNING",
"unplacedEntities": false、"environmentType": "HYBRID"
}
注:
このリクエストを行うとき、groupBy パラメータを使用して結果を並べ替えることができます。/search エンドポイントは、groupBy パラメータの使用率の値をサポートしていません。この値を使用すると、API は結果を displayName 順に返します。
設定エンドポイントを使用して、さまざまな設定マネージャの設定を変更できます。たとえば、actionscriptmanager を使用してアクション スクリプトの設定を変更し、automationmanager を使用してインスタンスの自動化設定を変更できます。
Workload Optimization Manager API の設定エンドポイントを使用すると、次のことができます。
■ 利用可能な設定マネージャと設定のリストを取得する
■ 設定を編集する
設定マネージャのリスト
変更可能な設定マネージャは次のとおりです。
■ actionscriptmanager
アクションスクリプトの使用に関連する設定が含まれています。
■ automationmanager
環境内のエンティティのアクションモードに関連する設定が含まれています。
■ cloudsavingsmanager
クラウドエンティティの実行保持に関連する設定が含まれています。
■ clusterHeadroomConfig
システムによって生成されたヘッドルーム プランに関連する設定が含まれています。
■ コントロールマネージャー
環境内で生成されたアクションのネイティブアクション処理を置き換えるワークフローに関連する設定が含まれています。
■ emailmanager
SMTP 電子メール通知に関連する設定が含まれています。
■ hcisettingsmanager
ハイパーコンバージドインフラストラクチャの管理に関連する設定が含まれています。
■ marketsettingsmanager
マーケット分析に関連する設定が含まれています。
■ osmigrationmanager
クラウドエンティティのオペレーティングシステムの移行に関連する設定が含まれています。
■ persistencemanager
統計保持データとレポートに関連する設定が含まれています。
■ reservedinstancemanager
予約済みインスタンスに関連する設定が含まれています。
■ storagesettingsmanager
ストレージエンティティの統計と分析に関連する設定が含まれています。
■ telemetrymanager
テレメトリのオプトインと利用規約に関連する設定が含まれています。
■
各設定マネージャの詳細については、GET https://10.10.10.10/api/v3/settings リクエストを実行してください。
ユーティリティリクエストは、関連するリクエストの作成、inputDTO の組み立て、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
設定エンドポイントには、各設定マネージャと使用可能な設定を表示するユーティリティリクエストが含まれています。
例:GET https://10.10.10.10/api/v3/settings/
応答:SettingsManagerApiDTO の配列。各オブジェクトは設定マネージャであり、そのマネージャの設定が含まれています。
指定された設定マネージャの現在の設定を取得する
指定された設定マネージャの現在の設定を取得します。このリクエストは、更新前に特定の設定マネージャの設定を確認するためによく使用されます。
例:GET https://10.10.10.10/api/v3/settings/automationmanager
応答:指定された設定マネージャの設定を表す SettingApiDTO のリスト:
[
{
"uuid": "startVM", "displayName": "Start", "value": "MANUAL",
"defaultValue": "RECOMMEND", "valueType": "STRING", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automated", "value": "AUTOMATIC"
}
],
"entityType": "VirtualMachine", "sourceGroupName": "Global"
},
{
"uuid": "startPM",
"displayName": "Start", "value": "RECOMMEND",
"defaultValue": "RECOMMEND",
"valueType": |
"STRING", |
"options": [ |
|
{ |
|
"label": |
"Disabled", |
"value": |
"DISABLED" |
}, |
|
{ |
|
"label": |
"Recommend", |
"value": |
"RECOMMEND" |
}, |
|
{ |
|
"label": |
"Manual", |
"value": |
"MANUAL" |
}, |
|
{ |
|
"label": |
"Automated", |
"value": |
"AUTOMATIC" |
} |
|
], |
|
"entityType": "PhysicalMachine", "sourceGroupName": "Global"
},
{
"uuid": "startDS", "displayName": "Start", "value": "RECOMMEND",
"defaultValue": "RECOMMEND",
"valueType": |
"STRING", |
"options": [ |
|
{ |
|
"label": |
"Disabled", |
"value": |
"DISABLED" |
}, |
|
{ |
|
"label": |
"Recommend", |
"value": |
"RECOMMEND" |
}, |
|
{ |
|
"label": |
"Manual", |
"value": |
"MANUAL" |
}, |
|
{ |
|
"label": |
"Automated", |
"value": |
"AUTOMATIC" |
} |
|
], |
|
"entityType": "Storage", "sourceGroupName": "Global"
},
...
]
設定の編集
設定を編集するには、このリクエストのボディ部に新しい値を渡します。このリクエストは、次のパラメータを取ります:
settingsManager_Uuid |
設定が変更される設定マネージャの UUID。 |
setting_uuid |
値が変更される設定。 |
例:PUT https://10.10.10.10/api/v3/settings/automationmanager/moveVM
入力例:SettingApiDTO。この場合、値は MANUAL から RECOMMEND に変更されています:
{
"uuid": "moveVM", "displayName": "Move", "value": "RECOMMEND",
"defaultValue": "MANUAL", "valueType": "STRING", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automated", "value": "AUTOMATIC"
}
],
"entityType": "VirtualMachine", "sourceGroupName": "Global"
}
応答: 変更を反映する SettingApiDTO:
{
"uuid": "moveVM", "displayName": "Move", "value": "RECOMMEND",
"defaultValue": "MANUAL", "valueType": "STRING", "options": [
{
"label": "Disabled", "value": "DISABLED"
},
{
"label": "Recommend", "value": "RECOMMEND"
},
{
"label": "Manual",
"value": "MANUAL"
},
{
"label": "Automated", "value": "AUTOMATIC"
}
],
"entityType": "VirtualMachine", "sourceGroupName": "Global"
}
設定ポリシーは、エンティティに適用される設定のコレクションです。Workload Optimization Manager には、エンティティのタイプごとにデフォルトのポリシーがあります。これらのグローバルデフォルトはエンティティの基本設定であり、作成する設定ポリシーではデフォルトへの差分を指定します。グローバルポリシーを編集できることに注意してください。
カスタム設定ポリシーを作成するときは、ポリシーに影響を与えるエンティティの 1 つ以上のグループである範囲をそれに割り当てます。これらのポリシーでは、デフォルトとは異なる設定のみを指定します。
グローバルなデフォルト ポリシーとカスタム ポリシーに加えて、Workload Optimization Manager は、特別な設定が必要なグループを検出し、それらのグループのポリシーを作成します。たとえば、Workload Optimization Manager が Azure 可用性セットと AWS 自動スケーリング グループを検出すると、それらのグループの設定ポリシーを生成し、グループの一貫したサイズ変更を有効にします。
設定ポリシーエンドポイントを使用すると、次のことができます。
■ 環境内の設定ポリシーのリストを取得する
■ 単一の設定ポリシーの詳細を取得する
■ 設定ポリシーを作成する
■ 設定ポリシーを編集する
■ 設定ポリシーを削除する
設定ポリシーの取得
この呼び出しは、環境内のすべての設定ポリシーの SettingsPolicyApiDTO の配列を返します。エンティティタイプを渡して、リストをそれらのタイプのポリシーに限定したり、リストをデフォルトポリシーのみに限定したりできます。
このリクエストは、次のパラメータを取ります:
only_defaults |
これが true の場合、呼び出しはデフォルト設定ポリシーのみを取得 |
entity_type |
設定ポリシーのリストを制限する 1 つ以上のエンティティタイプ |
例:
■ すべての設定ポリシーを取得:GET https://10.10.10.10/api/v3/settingspolicies
■ すべてのデフォルトの設定ポリシーを取得:GET https://10.10.10.10/api/v3/settingspolicies? only_defaults=true
■ VM とホストの設定ポリシーを取得:GET https://10.10.10.10/api/v3/settingspolicies? entity_type=VirtualMachine&entity_type=PhysicalMachine
■ 単一の設定ポリシーを取得(ポリシー Uuid を渡す):GET https://10.10.10.10/api/v3/settingspolicies/
aVDEwGegEemDFcIzuV5wcQ
応答:SettingsPolicyApiDTO の配列。このリストは、コンテナ エンティティの設定ポリシーを示しています。
[
{
"uuid": "_vyMHEDnSEemHXrxYkw9y2Q", "displayName": "Container defaults", "entityType": "Container", "settingsManagers": [
{
"uuid": "marketsettingsmanager", "displayName": "Operational Constraints", "category": "Analysis",
"settings": [
{
"uuid": "usedIncrement_Container_VMEM",
"displayName": "Increment constant for Container VMem [MB]", "value": "64.0",
"defaultValue": "64.0", "categories": [
"resizeRecommendationsConstants"
],
"valueType": "NUMERIC", "min": 0,
"max": 10000000,
"entityType": "Container", "sourceGroupName": "Global"
},
{
"uuid": "usedIncrement_Container_VCPU",
"displayName": "Increment constant for Container VCPU [MHz]", "value": "100.0",
"defaultValue": "100.0", "categories": [
"resizeRecommendationsConstants"
],
"valueType": "NUMERIC", "min": 0,
"max": 1000000,
"entityType": "Container", "sourceGroupName": "Global"
},
{
"uuid": "enforceConsistentResizingContainer", "displayName": "Consistent Resizing", "value": "false",
"defaultValue": "false", "categories": [
"resizeRecommendationsConstants"
],
"valueType": "BOOLEAN", "entityType": "Container", "sourceGroupName": "Global"
},
{
"uuid": "resizeTargetUtilization_Container", "displayName": "Resize Target Utilization", "value": "0.0",
"defaultValue": "0.0", "valueType": "NUMERIC", "min": 0,
"max": 100,
"entityType": "Container", "sourceGroupName": "Global"
}
]
},
...
}
]
設定ポリシーの作成
設定ポリシーを作成するには、次の手順を実行する必要があります。
■ ポリシー名を指定します。
■ マーケットでポリシーを有効にするか無効にするかを指定します。
■ ポリシー範囲を設定する – 特定のエンティティタイプの 1 つ以上のグループを指定します。これにより、ポリシーのエンティティタイプが決まります。
■ 設定したいものについては、適切な設定マネージャを指定してから、設定/値のペアの配列を指定します。
■ 必要に応じて、ポリシーのスケジュール ウィンドウまたはアクション実行スケジュールを指定します。
ポリシーの範囲を設定するには、グループ Uuid を含むオブジェクトの配列を提供します。これらのオブジェクトは、実質的に GroupApiDTO を簡略化したものです。グループはすべて同じタイプのエンティティ用である必要があることに注意してください。これにより、設定ポリシーのエンティティタイプを指定します。Groups エンドポイントを使用して、範囲内に必要なグループの Uuid 値を取得します。たとえば、範囲を単一の VM グループに設定するには、次の範囲オブジェクトを使用します。
"scopes": [
{
"uuid": "_lSlr0GddEemDFcIzuV5wcQ"
}
]
実際に設定を行うには、SettingsManagerApiDTO の配列を提供します。それぞれに、作成する設定の配列が含まれています。特定のエンティティタイプのすべての設定を表示する方法については、ユーザーインターフェイスを参照してください。選択できる設定マネージャは次のとおりです:
■ actionscriptmanager
アクション スクリプトの使用に関連する設定が含まれています。
■ automationmanager
環境内のエンティティのアクションモードに関連する設定が含まれています。
■ cloudsavingsmanager
クラウドエンティティの実行保持に関連する設定が含まれています。
■ clusterHeadroomConfig
システムによって生成されたヘッドルーム プランに関連する設定が含まれています。
■ controlmanager
環境内で生成されたアクションのネイティブ アクション処理を置き換えるワークフローに関連する設定が含まれています。
■ emailmanager
SMTP 電子メール通知に関連する設定が含まれています。
■ hcisettingsmanager
ハイパーコンバージドインフラストラクチャの管理に関連する設定が含まれています。
■ marketsettingsmanager
マーケット分析に関連する設定が含まれています。
■ osmigrationmanager
クラウドエンティティのオペレーティングシステムの移行に関連する設定が含まれています。
■ persistencemanager
統計保持データとレポートに関連する設定が含まれています。
■ reservedinstancemanager
予約済みインスタンスに関連する設定が含まれています。
■ storagesettingsmanager
ストレージエンティティの統計と分析に関連する設定が含まれています。
■ telemetrymanager
テレメトリのオプトインと利用規約に関連する設定が含まれています。
■
たとえば、VM の起動アクションを AUTOMATED に設定し、VCPU の最大数を 16 に設定するには、次を使用します。
settingsManagers 配列:
"settingsManagers": [
{
"uuid": "automationmanager", "settings": [
{
"uuid": "startVM", "value": "AUTOMATIC"
}
]
},
{
"uuid": "marketsettingsmanager", "settings": [
{
"uuid": "resizeVcpuMaximum_VM", "value": 16
}
]
}
]
設定ポリシーがいつ有効になるかを決定するスケジュールウィンドウを設定できます。そのためには、スケジュールの詳細に ScheduleApiDTO を提供します。これに含まれているものとしては、次のものがあります:開始日と終了日および開始時刻と終了時刻。
■ 開始日と終了日。
■ 開始時刻および終了時刻。
■ スケジュールの繰り返しのためのオプションの RecurrenceApiDTO。これを指定しない場合は、1 回限りのスケジュールウィンドウの指定となります。
たとえば、これを使用して、毎週土曜日と日曜日の午前 12 時 30 分から午前 7 時 30 分に終了する「永続的な」スケジュール ウィンドウ(2099 年まで期限切れにならない)を指定できます。
"schedule": {
"startDate": "2019-04-28T00:30:00-04:00", "endDate": "2099-12-31T07:30:00-05:00", "startTime": "2019-04-28T00:30:00-04:00", "endTime": "2019-04-28T07:30:00-04:00",
"recurrence": {
"type": "WEEKLY",
"daysOfWeek": [
"Sat",
"Sun"
]
}
ポリシー レベルのスケジュール、アクション実行命令、およびアクション実行スケジュールを持つポリシーの完全なデータペイロードの例は次のとおりです。
{
"disabled":false, "entityType":"VirtualMachine", "displayName":"TestPol", "scopes":[
{
"uuid":"285041619454560"
}
],
"settingsManagers":[
{
"uuid":"automationmanager", "displayName":"Action Mode Settings", "category":"Automation",
"settings": [
{
"uuid":"storageMove", "value":"RECOMMEND",
"valueType":"STRING", "valueObjectType":"String", "defaultValue":"RECOMMEND", "entityType":"VirtualMachine", "displayName":"Storage Move", "options":[
{
"label":"Disabled", "value":"DISABLED"
},
{
"label":"Recommend", "value":"RECOMMEND"
},
{
"label":"External Approval", "value":"EXTERNAL_APPROVAL"
},
{
"label":"Manual",
"value":"MANUAL"
},
{
"label":"Automatic", "value":"AUTOMATIC"
}
]
},
{
"uuid":"storageMoveExecutionSchedule", "value":"285088800975856",
"valueType":"LIST", "valueObjectType":"String", "entityType":"VirtualMachine",
"displayName":"Execution window for Storage Move action"
}
]
}
],
"schedule":{
"uuid":"285088797821136",
"displayName":"TestSched", "endTime":"2021-05-24T16:00", "startTime":"2021-05-24T14:30",
"timeZone":"America/Chicago", "recurrence":{
"type":"MONTHLY",
"interval":1, "daysOfMonth":[
1
]
}
}
}
例:上記のペイロードを使用した POST https://10.10.10.10/api/v3/settingspolicies
応答:作成した設定ポリシー。この応答を使用して、ポリシー Uuid を取得します。
設定ポリシーの編集
設定ポリシーを編集するには、新しいデータセットを設定ポリシーエンドポイントにプッシュします。これを行う最善の方法は、編集する SettingsPolicyApiDTO をコピーし、その DTO に変更を加えてから、DTO を API にプッシュすることです。範囲からポリシーを削除するには、SettingsPolicyApiDTO を渡し、reset_defaults=true をパラメータとして渡します。
このリクエストは、次のパラメータを取ります:
settingsPolicy_Uuid |
編集するポリシーの Uuid |
reset-defaults |
ポリシーをデフォルトにリセットするために使用できるブール値。reset_defaults=true の場合、ポリシーを削除し、その範囲をデフォルトにリセットします。この設定を使用する場合は、空のオブジェクト {} をデータ ペイロードとして渡します。 |
例:
■ SettingsPolicyApiDTO をコピーして、それにいくつかの変更を加え、それを次のペイロードで渡します:PUSH https://10.10.10.10/api/v3/settingspolicies/_2-CbQGoNEemyOoIvFZyv1A? reset_defaults=false
■ ポリシーを削除します(したがって、ペイロードとして空のオブジェクトを渡します):PUSH https://10.10.10.10/api/v3/settingspolicies/_2-CbQGoNEemyOoIvFZyv1A? reset_defaults=true
応答:変更された SettingsPolicyApiDTO。
設定ポリシーの削除
指定された設定ポリシーを削除します。
例:DELETE https://10.10.10.10/api/v3/settingspolicies/_aV5ucGoTEemyOoIvFZyv1A
応答:成功の場合はコード 200。
Statistics Overview
統計は、環境を継続的に分析しているときに Workload Optimization Manager が検出する情報です。最も一般的な用途は、特定の時間枠で特定の統計を見ることです。
Workload Optimization Manager API の統計エンドポイントを使用すると、次のことができます:
■ 他のエンドポイントの統計リクエストのリストを取得する
■ 特定の時間枠でフィルタリングされた統計のリストを取得する
■ 指定されたエンティティの統計のリストを取得する
■ 指定されたエンティティの統計のフィルタリングされたリストを取得する
統計のタイミング
ヘッドルームとキャパシティ計画に関連する統計は、午前 0 時のタイムスタンプで、毎日 Workload Optimization Manager データベースに書き込まれます。その他の統計は、10 分単位で収集され、データベースに保存されます。ヘッドルームとアクティブに監視されている情報の両方を含む統計のグループを取得する場合、返されるタイムスタンプには、各統計の最終書き込み日が反映されます。
ユーティリティリクエストは、関連するリクエストの作成、inputDTO の組み立て、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
統計エンドポイントには、統計関連のリクエストの一般的なエントリポイントを示すユーティリティリクエストが含まれています。これらは、特定のエンティティまたはグループの統計を取得するために使用できます。
例:GET https://10.10.10.10/api/v3/stats
応答:Link オブジェクトの配列。各オブジェクトには、指定された UUID、エンティティ、またはグループのすべての統計を取得するための URL が含まれます。
エンティティの統計の取得
指定されたエンティティのすべての統計を取得します。このリクエストは、次のパラメータを取ります:
entity_uuid |
統計が返されるエンティティ。 |
q |
Workload Optimization Manager により内部的に使用されます。 |
注:
クラスタの統計を取得する場合、/groups エンドポイントを使用すると、該当するすべてのクラスタエンティティの集計された統計が返されます。エンティティごとの個々の統計については、/stats エンドポイントを使用します。
一部の統計は、特定の範囲でのみ有効です。それらを含まない範囲の特定の統計を要求すると、API はデータを返しません。たとえば、numVMs 統計はマーケット範囲とクラスタ範囲でのみ有効です。API は、他の範囲をクエリするときに応答から numVMs データを省略します。
例:https://10.10.10.10/api/v3/stats/423f26a7-1132-df1c-64e2-8a040480b046
応答:リアルタイムマーケットの統計を表す StatSnapshotApiDTO のリスト。
[
{
"displayName": "AdityaReplica", "date": "2019-04-24T20:09:46-04:00",
統計情報
{
"name": "priceIndex", "relatedEntityType": "VirtualMachine", "values": {
"max": 1.01,
"min": 1.01,
"avg": 1.01,
"total": 1.01
},
"value": 1.01
},
{
"displayName": "CPUProvisioned/AdityaReplica", "name": "CPUProvisioned",
"capacity": {
"max": 3120000,
"min": 3120000,
"avg": 3120000,
"total": 3120000
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "bought"
}
],
"units": "MHz", "values": {
"max": 5200,
"min": 5200,
"avg": 5200,
"total": 5200
},
"value": 5200
},
{
"displayName": "Swapping/AdityaReplica", "name": "Swapping",
"capacity": {
"max": 40000000,
"min": 40000000,
"avg": 40000000,
"total": 40000000
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "bought"
}
],
"units": "bit/sec", "values": {
"max": 0,
"min": 0,
"avg": 0,
"total": 0
},
"value": 0
},
{
"displayName": "NumDisk/AdityaReplica", "name": "NumDisk",
"capacity": {
"max": 2147483650,
"min": 2147483650,
"avg": 2147483650,
"total": 2147483650
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "bought"
}
],
"values": {
"max": 1,
"min": 1,
"avg": 1,
"total": 1
},
"value": 1
},
...
]
}
]
フィルタリングされた統計リストの取得
ユーザーが作成した StatPeriodApiInputDTO によってフィルタ処理された統計のリストを取得します。この要求の入力を構成する基準の詳細については、https://<Your_Workload Optimization Manager_IP>/swagger/external/index.html にあるこの要求の Swagger ドキュメントを参照してください。
例:POST https://10.10.10.10/api/v3/stats/423f26a7-1132-df1c-64e2-8a040480b046
入力例: この入力は、指定されたエンティティの VMem、VCPU、および VStorage 統計の値を返します。最初にキー、次に relatedEntity、次に virtualDisk の順に並べられます。
{
統計情報
{
"name": "VMem", "groupBy": [
"key", "relatedEntity", "virtualDisk"
]
},
{
"name": "VCPU",
"groupBy": [
"key", "relatedEntity", "virtualDisk"
]
},
{
"name": "VStorage", "groupBy": [
"key", "relatedEntity", "virtualDisk"
]
}
]
}
応答:マーケットのフィルタ処理された統計を表す StatSnapshotApiDTO のリスト:
[
{
"displayName": "AdityaReplica", "date": "2019-04-24T20:28:06-04:00",
統計情報
{
"displayName": "AdityaReplica",
"name": "VMem", "capacity": {
"max": 1048576,
"min": 1048576,
"avg": 1048576,
"total": 1048576
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "virtualDisk", "value": ""
},
{
"type": "key", "value": null
},
{
"type": "relation",
"value": "sold"
}
],
"relatedEntity": {
"uuid": "5d2f7b69eb3bf506089feba37d31b0c376b02e34", "displayName": "GuestLoad[AdityaReplica]", "className": "Application"
},
"units": "KB", "values": {
"max": 0,
"min": 0,
"avg": 0,
"total": 0
},
"value": 0
},
{
"displayName": "AdityaReplica", "name": "VCPU",
"capacity": {
"max": 5200,
"min": 5200,
"avg": 5200,
"total": 5200
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "virtualDisk", "value": ""
},
{
"type": "key", "value": null
},
{
"type": "relation",
"value": "sold"
}
],
"relatedEntity": {
"uuid": "5d2f7b69eb3bf506089feba37d31b0c376b02e34", "displayName": "GuestLoad[AdityaReplica]", "className": "Application"
},
"units": "MHz", "values": {
"max": 19,
"min": 14.93,
"avg": 14.93,
"total": 14.93
},
"value": 14.93
}
]
}
]
指定された範囲内のすべてのオブジェクトの統計のフィルタ済みリストの取得
指定された範囲について、エンティティごとにフィルタ処理された統計のリストを取得します。入力で統計を提供しない場合、応答には各エンティティに関する基本情報が含まれます。この要求の入力を構成する基準の詳細については、https://<Your_Workload Optimization Manager_IP>/swagger/external/index.html にあるこのリクエストの Swagger ドキュメントを参照してください。
例:POST https://10.10.10.10/api/v3/stats?ascending=true
入力例:この入力は、リクエストの 5 日前からリクエストの 1 日前までのリアルタイム マーケットの各エンティティの VMem 値を返します。
{
"scopes": [ "Market"
],
"period": {
"startDate": "-5d",
"endDate": "-1d", "statistics": [
{
"name": "VMem"
}
]
},
"entityType": "VirtualMachine"
}
応答:指定された範囲のエンティティに対するフィルタ処理された統計を表す StatSnapshotApiDTO のリスト:
[
{
"uuid": "4200829c-1272-c0a4-2d17-55f2cc0ef1b4", "displayName": "vm-c67a1cdd-609e-4282-809c-e0def5cd0d7a", "className": "VirtualMachine",
"environmentType": "ONPREM", "stats": [
{
"displayName": "vm-c67a1cdd-609e-4282-809c-e0def5cd0d7a", "date": "2019-04-19T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
16777216, |
"min": |
16777216, |
"avg": |
16777216, |
"total": 33554432
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
1509949.5, |
"min": |
335544.3, |
"avg": |
587202.56, |
"total": 1174405.1
},
"value": 587202.56
}
]
},
{
"displayName": "vm-c67a1cdd-609e-4282-809c-e0def5cd0d7a", "date": "2019-04-20T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
16777216, |
"min": |
16777216, |
"avg": |
16777216, |
"total": 33554432
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
1509949.5, |
"min": |
369098.75, |
"avg": |
587202.56, |
"total": 1174405.1
},
"value": 587202.56
}
]
},
{
"displayName": "vm-c67a1cdd-609e-4282-809c-e0def5cd0d7a", "date": "2019-04-22T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
16777216, |
"min": |
16777216, |
"avg": |
16777216, |
"total": 33554432
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": 12582912,
"min": 0,
"avg": 452984.84,
"total": 905969.7
},
"value": 452984.84
}
]
},
{
"displayName": "vm-c67a1cdd-609e-4282-809c-e0def5cd0d7a", "date": "2019-04-23T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
16777216, |
"min": |
16777216, |
"avg": |
16777216, |
"total": 33554432
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": 838860.8,
"min": 0,
"avg": 167772.16,
"total": 335544.3
},
"value": 167772.16
}
]
}
]
},
{
"uuid": "39EBB726-41D9-4BC8-A41D-CA301854309C",
"displayName": "Gilad_OM-38071_SMB_VM2", "className": "VirtualMachine", "environmentType": "ONPREM"
},
{
"uuid": "97A3F420-B7AD-414D-A543-FD308AC774A6",
"displayName": "Gilad_VMM_Test_VM_2", "className": "VirtualMachine", "environmentType": "ONPREM"
},
{
"uuid": "4211f183-69a8-3676-3e53-0151365500ff",
"displayName": "james-ubuntu-dc13", "className": "VirtualMachine", "environmentType": "ONPREM", "stats": [
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-19T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": 1048576,
"min": 1048576,
"avg": 1048576,
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
83886.08, |
"min": |
8388.61, |
"avg": |
18874.37, |
"total": 37748.73
},
"value": 18874.37
}
]
},
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-20T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": 1048576,
"min": 1048576,
"avg": 1048576,
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
62914.56, |
"min": |
13631.49, |
"avg": |
18874.37, |
"total": 37748.73
},
"value": 18874.37
}
]
},
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-21T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
1048576, |
"min": |
1048576, |
"avg": |
1048576, |
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
73400.32, |
"min": |
11534.34, |
"avg": |
17825.79, |
"total": 35651.59
},
"value": 17825.79
}
]
},
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-22T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
1048576, |
"min": |
1048576, |
"avg": |
1048576, |
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
83886.08, |
"min": |
8388.61, |
"avg": |
19922.94, |
"total": 39845.89
},
"value": 19922.94
}
]
},
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-22T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
1048576, |
"min": |
1048576, |
"avg": |
1048576, |
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
73400.32, |
"min": |
3145.73, |
"avg": |
18874.37, |
"total": 37748.73
},
"value": 18874.37
}
]
}
]
},
{
"uuid": "421d2165-36cd-7f6a-3a43-08e09f6f4e0f", "displayName": "ACM-LexCorp-Control", "className": "VirtualMachine", "environmentType": "ONPREM",
"stats": [
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-19T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
2097152, |
"min": |
2097152, |
"avg": |
2097152, |
"total": 4194304
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB",
"values": {
"max": |
167772.16, |
"min": |
18874.37, |
"avg": |
37748.73, |
"total": 75497.47
},
"value": 37748.73
}
]
},
{
"displayName": "james-ubuntu-dc13", "date": "2019-04-19T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
2097152, |
"min": |
2097152, |
"avg": |
2097152, |
"total": 4194304
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
125829.12, |
"min": |
18874.37, |
"avg": |
37748.73, |
"total": 75497.47
},
"value": 37748.73
}
]
},
{
"displayName": "ACM-LexCorp-Control", "date": "2019-04-21T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": 2097152,
"min": 2097152,
"avg": 2097152,
"total": 4194304
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": |
104857.6, |
"min": |
20971.52, |
"avg": |
35651.59, |
"total": 71303.17
},
"value": 35651.59
}
]
},
{
"displayName": "ACM-LexCorp-Control", "date": "2019-04-21T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": |
2097152, |
"min": |
2097152, |
"avg": |
2097152, |
"total": 4194304
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": 272629.75,
"min": 20971.52,
"avg": 73400.32,
"total": 146800.64
},
"value": 73400.32
}
]
},
{
"displayName": "ACM-LexCorp-Control", "date": "2019-04-23T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": 2097152,
"min": 2097152,
"avg": 2097152,
"total": 4194304
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": 251658.23,
"min": 23068.67,
"avg": 79691.77,
"total": 159383.55
},
"value": 79691.77
}
]
}
]
},
{
"uuid": "420f3462-ca50-fedf-aa8f-223bd39b1852", "displayName": "shai-redhat",
"className": "VirtualMachine", "environmentType": "ONPREM", "stats": [
{
"displayName": "shai-redhat", "date": "2019-04-19T00:00:00-04:00",
統計情報
{
"name": "VMem", "capacity": {
"max": 1048576,
"min": 1048576,
"avg": 1048576,
"total": 2097152
},
"relatedEntityType": "VirtualMachine", "filters": [
{
"type": "relation",
"value": "sold"
}
],
"units": "KB", "values": {
"max": 20971.52,
"min": 0,
"avg": 1048.58,
"total": 2097.15
},
"value": 1048.58
}
]
},
...
]
}
]
複雑な統計クエリ
POST /stats リクエストを使用すると、さまざまな統計を取得できます。たとえば、これは Workload Optimization Manager UI によって作成された複雑なクエリです:
{
"statistics":[
{
"name":"CPU", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"CPU", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"NetThroughput", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"IOThroughput", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Q1VCPU",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Q2VCPU",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Q4VCPU",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Q8VCPU",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Q16VCPU",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Q32VCPU",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Ballooning", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Swapping", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"CPUProvisioned", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"MemProvisioned", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Flow",
"relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"FlowAllocation", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Cooling", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Power", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
},
{
"name":"Space", "relatedEntityType":"PhysicalMachine", "groupBy":[
"key", "virtualDisk"
],
"filters":[
{
"type":"relation",
"value":"sold"
}
]
}
]
}
前のリクエストはデータセンター範囲のコンテキストで行われるため、応答にはそのデータセンター内の各ホストの情報が含まれます。groupBy パラメータの virtualDisk 値により、すべての仮想ディスクが集約ではなく、個々の行項目として応答に表示されます。
さらに、呼び出し全体で見つかった "filters":[{"type":"relation","value":"sold"}] は、応答に、サプライチェーンの下位レベルから購入されたのではなく、これらのホストによって販売されたコモディティが含まれていることを示しています。
Workload Optimization Manager は、お客様の環境を購入者や販売者のマーケットとしてモデル化します。インストール用に設定したターゲットを使用して、環境内のさまざまなタイプのエンティティを検出します。ディスカバリはこれらのエンティティをサプライチェーンにマッピングします。このため Workload Optimization Manager はそれらをモニターし、サポートするワークロードを管理できます。たとえばハイパーバイザターゲットの場合、Workload Optimization Manager は VM、VM にリソースを提供するホストおよびデータストア、VM リソースを使用するアプリケーションを検出します。環境内のエンティティは、一部のエンティティがリソースを提供し、その他のエンティティが供給されたリソースを消費する、一連の供給と需要を形成します。
サプライチェーンエンドポイントを使用すると、次のことができます:
■ 環境内のエンティティに関連する完全またはフィルタリングされたサプライチェーンを取得する
■ 環境内のエンティティに関連するサプライチェーンの統計を取得する
指定されたエンティティのサプライチェーンを取得する
指定されたエンティティの完全なサプライチェーンを取得します。たとえば、仮想マシンの UUID が使用されている場合、その仮想マシンによってホストされているアプリケーション、それが消費するホストとデータストア、ホストが消費するクラスタまたはデータセンター、データストアが消費するディスクアレイとストレージコントローラなどが表示されます。
サプライチェーンでは、深さは、呼び出されたエンティティからのサプライチェーン内の距離を指します。たとえば、ホストの UUID が使用されている場合、そのホストから消費する仮想マシンの深さは -1 であり、それらの仮想マシンから消費するアプリケーションの深さは -2 であり、サプライチェーン内の他のホストは深さ 0、ホストのクラスタの深さは 1 になります。
例:GET https://10.10.10.10/api/v3/supplychains?uuids=Virtual_ESX_4238042f-7465- e92a-5c28-a7a929307247&health=false
応答:指定されたエンティティ(この場合はホスト)のサプライチェーンを表す SupplychainApiDTO。エンティティのインスタンスが 1 つだけの場合、Workload Optimization Manager はそのエンティティの詳細を返すことに注意してください。応答では、DPod エンティティとストレージコントローラ エンティティでこれを確認できます。
{
"seMap":{ "Application":{
"depth":-2, "entitiesCount":12, "stateSummary":{
"ACTIVE":5,
"SUSPEND":1,
"IDLE":6
}
}, "DPod":{
"depth":-1, "entitiesCount":1, "stateSummary":{
"ACTIVE":1
},
"instances":{ "c15cef94af07fccf19e303884592a4ef211764f1":{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/entities/c15cef94af07fccf19e303884592a4ef211764f1?inclu
de_aspects=false"
}
],
"uuid":"c15cef94af07fccf19e303884592a4ef211764f1", "displayName":"DPOD-data-mycorp", "className":"DPod",
"priceIndex":1e-12, "state":"ACTIVE",
"severity":"Normal", "environmentType":"ONPREM"
}
}
},
...
"StorageController":{ "depth":3, "entitiesCount":1, "stateSummary":{
"ACTIVE":1
},
"instances":{
"be89058c-e786-11e4-82ba-dfc30ffeb3ee":{ "links":[
{
spects=false"
}
"rel":"self",
"href":"https://10.10.10.10/api/v3/entities/be89058c-e786-11e4-82ba-dfc30ffeb3ee?include_a
],
"uuid":"be89058c-e786-11e4-82ba-dfc30ffeb3ee", "displayName":"dataontap-mycorp-cm1", "className":"StorageController", "priceIndex":20000,
"state":"ACTIVE",
"severity":"Normal", "discoveredBy":{
"uuid":"_adGLMJwFEei_xJ5Ai6-rnQ", "displayName":"data-cluster.eng.mycorp.com", "type":"NetApp"
},
"remoteId":"be89058c-e786-11e4-82ba-dfc30ffeb3ee"、"environmentType":"ONPREM"
}
}
}
}
}
指定されたサプライチェーン範囲の最上位にあるエンティティの配列を取得します。開始範囲をシードする UUID の配列を提供します。次に、要求は、消費者を持たないエンティティが見つかるまで、それらのシードエンティティからサプライチェーンを上方向にトラバースします。これらは、シードされた範囲のリーフエンティティです。
uuids |
リクエスト範囲をシードする UUID のリスト。たとえば、複数の VM に uuid を与えると、リクエストはリスト内のすべての VM からのすべてのリーフエンティティを検索します。グループの uuid を指定すると、リクエストはグループメンバーをエンティティのリストとして扱います。 |
filterEntityTypes |
リクエストから除外するエンティティタイプのリスト。任意の有効なエンティティクラス名を指定できます。リクエストは、フィルタリングされたエンティティでサプライチェーンのトラバースを停止します。たとえば、1 VM > 4 ApplicationComponent > 2 Service > 1 BusinessApplication から成長するサプライチェーンがあるとします。VM からのリクエストは、単一のビジネスアプリケーションを返します。BusinessApplication を除外すると、2 つの Service エンティティが返されます。Service を除外すると、4 つの ApplicationComponent エンティティが返されます。この呼び出しに関する Swagger のドキュメントには、有効な filterEntityType のリストが記載されていることに注意してください。 |
カーソル |
追加の結果を取得するために後続の呼び出しを行う場合、これは、このメソッドへの最後の呼び出しによって返されたカーソルです。 |
limit |
返される最大アイテム数。正の整数でなければなりません。設定されていない場合、サーバーはサービス固有の上限を提供します。 |
たとえば、Workload Optimization Manager のユーザーインターフェイスでは、"App [app]" という名前の BussinessApplication エンティティを検索できます。そのビジネス アプリケーションに範囲を設定すると、サプライチェーン内をクリックして名前空間エンティティを選択できます。エンティティ情報チャートを見つけて、ID 値をコピーします。これは、app 名前空間の uuid です。その名前空間のリーフ エンティティを取得すると、Workload Optimization Manager アプリケーションをサポートするすべての Service、ApplicationComponent、および BusinessApplication エンティティが表示されます。たとえば、次のサービス エントリは Hyper-V ターゲット コンポーネント用です:
{
"uuid": "74626820648480",
"displayName": "Service-app/mediation-hyperv",
"className": "Service"
}
ここで、シードされた範囲として VM グループを使用し、サプライチェーンでサービスエンティティ以上を除外するとします。
例:GET https://10.10.168.102/api/v3/supplychains/leafEntities?uuids=74626820647952&filterEntityTypes=Service
[
{
"uuid": "74699295824896",
"displayName": "App-app/cost-67b7b9bb4d-bl8kt/cost", "className": "Application Component"
},
{
"uuid": "74699295824908",
"displayName": "App-app/mediation-vmax-6cd7f4ff-nzqp6/mediation-vmax", "className": "Application Component"
},
{
"uuid": "74699295824897",
"displayName": "App-app/mediation-azurebilling-c585c846f-mvnl7/mediation-azurebilling", "className": "Application Component"
},
...
]です
サプライチェーンの統計の取得
ユーザーが作成した SupplyChainStatsApiInputDTO によってフィルタ処理された統計のリストを取得します。この要求の入力を構成する基準の詳細については、https://<Your_Workload Optimization Manager_IP>/swagger/external/index.html にあるこの要求の Swagger ドキュメントを参照してください。
例:POST https://10.10.168.102/api/v3/supplychains/stats
入力例:この入力は、指定された UUID(この場合はデータセンター)で実行されているアプリケーションの数を返します:
{
"uuids": [ "e27e5c2f85d91107ac3f26fd63d4478e808f590b"
],
"types": [ "Application"
],
"environmentType": "ONPREM"
}
応答:マーケットのフィルタ処理された統計を表す StatSnapshotApiDTO のリスト:
[
{
"date": "2019-05-01T17:45:42-04:00",
統計情報
{
"name": "entities",
"filters": [], "value": 25
}
]
}
]
タグの概要
タグは、環境を整理するために使用できるリソースに添付されたメタデータです。タグは、技術、自動化、ビジネス、またはセキュリティの目的でリソースのグループ化を示すために最もよく使用されます。
Workload Optimization Manager は、AWS、Azure、および vCenter リソースを検出します。タグエンドポイントを使用すると、次のことができます。
■ 利用可能なタグのリストを取得する
■ 指定されたタグに属するメンバーを取得する
さらに、エンティティ エンドポイントでタグ関連のリクエストを使用して、次のことを行うことができます:
■ エンティティにタグを割り当てる
■ エンティティに関連付けられたすべてのタグまたは単一のタグを削除する
タグリクエストのページネーション
タグデータをリクエストすると、API はページネーションを使用してデータのサブセットを返します。データを扱いやすいチャンクで確実に取得できるように、可能な場合は常にページネーションを使用する必要があります。返されたデータのページネーションを行うには、limit、orderBy、および cursor パラメータで、API によるデータのページネーション方法を制御します。これらのリクエストに limit を指定しない場合、API はデータをレコードのデフォルトの制限に合わせてページネーションを行います:
■ GET /tags
■ GET /タグ/<tagKey>/エンティティ
limit を設定せずにスクリプトでこれらのリクエストを行う場合、返されたデータのページネーション カーソルを確認する必要があります。
ページネーションに関する一般的な情報については、Workload Optimization Manager API の「ページネーション」(18ページ)を参照してください。
タグの取得
タグのリストの場合、API は TagApiDTO のリストを返します。各 TagApiDTO には、タグのキーと値のペアが含まれます。キーを使用して、タグに属するエンティティを表示できます。
例:https://10.10.10.10/api/v3/tags
応答:
[
{
"key":"owner", "values":[
"QA_Azure"
]
},
{
"key":"director",
"values":[
"p-bosh", "bosh-init"
]
},
...
]です
範囲、エンティティ、および環境によるタグのフィルタリング
指定された範囲、エンティティタイプ、環境のフィルタ処理されたタグのリストを取得します。たとえば、これを使用して、特定のクラスタ内のタグのみを検索したり、少なくとも 1 つの VM に影響するタグを検索したり、結果をクラウドエンティティのみに制限したりできます。このリクエストは、次のパラメータを受け入れます:
スコープ |
リクエストの範囲を表す UUID のリスト。たとえば、範囲として Market を指定すると、リアルタイムマーケット全体が検索されます。ホストの UUID を指定すると、そのホスト上のエンティティのみが応答に含まれます。 |
entity_type |
■ BUSINESS_UNIT ■ CLOUD_SERVICE ■ コンテナ ■ データベース ■ DATABASE_SERVER ■ DATACENTER ■ DISK_ARRAY ■ PHYSICAL_MACHINE ■ ストレージ ■ VIRTUAL_MACHINE ■ スイッチ ■ VIRTUAL_DATACENTER ■ シャーシ ■ STORAGE_CONTROLLER ■ IO_MODULE; IO モジュール ■ APPLICATION_SERVER ■ VIRTUAL_APPLICATION ■ ネットワーク ■ アプリケーション ■ コンテナ ■ CONTAINER_POD ■ LOGICAL_POOL ■ DPOD ■ VPOD ■ LOAD_BALANCER |
environment_type |
指定された環境タイプのエンティティからタグのみを返します。[ Cloud, Hybrid, Onprem ] |
例:GET https://10.10.10.10/api/v3/tags? scopes=Market&entity_type=VirtualMachine&environment_type=ONPREM
応答:タグ付きのリアルタイム マーケットでオンプレミスで実行されている VM のリスト。
指定されたタグのエンティティを取得する
指定されたタグを持つエンティティのリストを取得します。エンティティは、アプリケーション、物理マシン、VM、ストレージ、データセンターなど、Workload Optimization Manager が管理する環境内のデバイスです。この情報を使用して、指定されたタグを持つエンティティの場所、それらのエンティティに関連付けられている他のタグ、および各エンティティに関する詳細情報を確認できます。
例:GET https://10.10.10.10/api/v3/tags/owner/entities
応答:タグ所有者を持つエンティティのリスト:
[
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/entities/azure::VM::375ddfb4-3127-44eb-9088-3c7645212f81?inclu de_aspects=false"
}
],
"uuid":"azure::VM::375ddfb4-3127-44eb-9088-3c7645212f81",
"displayName":"oleg-westus2-unmanaged-std",
"className":"VirtualMachine",
"priceIndex":3.2109845,
"state":"ACTIVE",
"severity":"Normal",
"costPrice":0.024,
"discoveredBy":{
"uuid":"_GLpj4JwIEei_xJ5Ai6-rnQ",
"displayName":"mycorp.management.core.windows.net",
"type":"Azure"
},
"remoteId":"azure::VM::375ddfb4-3127-44eb-9088-3c7645212f81",
"template":{
"uuid":"azure::VMPROFILE::Basic_A0",
"displayName":"Basic_A0",
"discovered":false
},
"environmentType":"CLOUD",
"tags":{
"owner":[
"PT_Azure"
],
"AutoSuspend":[
"false"
]
}
},
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/entities/azure::VM::c94e96bf-975e-47da-8c52-7ac90161cc87?inclu de_aspects=false"
}
],
"uuid":"azure::VM::c94e96bf-975e-47da-8c52-7ac90161cc87", "displayName":"oleg-westus2-managed-avail-set-1",
"className":"VirtualMachine", "priceIndex":2.446491, "state":"ACTIVE",
"severity":"Normal", "costPrice":0.018, "discoveredBy":{
"uuid":"_GLpj4JwIEei_xJ5Ai6-rnQ", "displayName":"mycorp.management.core.windows.net", "type":"Azure"
},
"remoteId":"azure::VM::c94e96bf-975e-47da-8c52-7ac90161cc87", "template":{
"uuid":"azure::VMPROFILE::Standard_B1s", "displayName":"Standard_B1s", "discovered":false
},
"environmentType":"CLOUD", "tags":{
"owner":[
"PT_Azure"
],
"AutoSuspend":[
"false"
]
}
}
]
ターゲットは、仮想環境で管理機能を実行するサービスです。Workload Optimization Manager は、ターゲットを使用してワークロードをモニタリングし、環境内でアクションを実行します。
環境内のエンティティを検出するには、Workload Optimization Manager のインストールにさまざまなターゲットを追加します。次に、Workload Optimization Manager はこれらのターゲットを使用して、環境からデータを収集します。
Workload Optimization Manager は、プローブを使用してターゲットに接続し、そのエンティティを検出します。Workload Optimization Manager GUI は、ユーザーがさまざまなターゲット インスタンスを指定するためのフォームを提供します。プローブごとに異なる設定が必要になる場合があり、Workload Optimization Manager の異なるバージョンが異なるプローブ セットをサポートする可能性があることに注意してください。
これらのターゲットの詳細については、『ターゲット構成ガイド』の「ターゲット構成」を参照してください。ターゲットが Workload Optimization Manager とどのように対話するかを完全に理解せずにターゲットを変更しないでください。
Workload Optimization Manager API のターゲットエンドポイントを使用すると、次のことができます:
■ 環境に存在する単一のターゲットまたはターゲットのリストを取得する
■ Workload Optimization Manager インストールで使用可能なプローブのリストを取得する
■ ターゲットのアクションまたは統計を取得する
■ ターゲットによって検出されたワークフローを取得する
■ ターゲットの追加または編集
■ ターゲットでの検証または再検出のトリガー
■ ターゲットの削除
ユーティリティリクエストは、関連するリクエストの作成、inputDTO のアセンブル、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
ターゲット エンドポイントには、Workload Optimization Manager で使用可能な各ターゲットのプローブレジストリに必要な情報(必須の入力フィールド、想定されるターゲットタイプおよびカテゴリ値など)を示す specs と呼ばれるユーティリティリクエストが含まれています。
注:
特定の Workload Optimization Manager インストールで使用できるプローブのリストについては、組織のライセンス契約を確認してください。
例:GET https://10.10.10.10/api/v3/targets/specs
応答:TargetApiDTO オブジェクトの配列。各オブジェクトには入力フィールドの配列が含まれています。この例は、アプリケーションサーバーカテゴリの JVM プローブの 1 つのエントリを示しています。
[
{
[
...
{
"category":"Application Server", "identifyingFields":[
"nameOrAddress"
],
"inputFields":[
{
"displayName":"Scope/Address", "name":"nameOrAddress", "isMandatory":true, "isSecret":false, "valueType":"GROUP_SCOPE",
"description":"The group of VMs or the address of the JVM server"
},
{
"displayName":"Port Number", "name":"targetPort", "defaultValue":"1099", "isMandatory":true, "isSecret":false, "valueType":"NUMERIC",
"description":"The JMX port that connects with the JVM server"
},
{
"displayName":"Username", "name":"username", "isMandatory":true, "isSecret":false, "valueType":"STRING",
"description":"The JVM server JMX password, enter a space if the server has no security"
},
{
"displayName":"パスワード", "name":"パスワード",
"isMandatory":true, "isSecret":true, "valueType":"STRING",
"description":"The JVM server JMX port, enter a space if the server has no security"
}
],
"type":"JVM"
},
...
}
]
ターゲットリクエストは、Workload Optimization Manager アプライアンス上のターゲットの作成、構成、検証、再検出、および削除を処理します。
ターゲットリクエストのページネーション
ターゲットエンティティをリクエストすると、API はページネーションを使用してデータのサブセットを返します。データを扱いやすいチャンクで確実に取得できるように、可能な場合は常にページネーションを使用する必要があります。返されたデータのページネーションを行うには、limit、orderBy、および cursor パラメータで、API によるデータのページネーション方法を制御します。
limit をGET /ターゲット/<targetId>/エンティティ リクエストで指定しなかった場合、API はレコードのデフォルトの制限に合わせてデータのページネーションを行います。limit を設定せずにスクリプトでこれらのリクエストを行う場合、返されたデータのページネーションカーソルを確認する必要があります。
ページネーションに関する一般的な情報については、Workload Optimization Manager API の「ページネーション」(18ページ)を参照してください。
ターゲットの取得
ターゲットのリストの場合、API は TargetApiDTO オブジェクトの配列を返します。各 TargetApiDTO オブジェクトには、検証ステータス、ターゲットのタイプとカテゴリ、および入力フィールドの名前と値が含まれます。単一のターゲットを取得するには、リクエストにターゲットの UUID を含めます。
このリクエストは、次のパラメータを取ります:
environment_type |
指定された環境タイプのターゲットのみを返します。[ Cloud, Hybrid, Onprem ] |
例:
■ すべてのターゲット:GET https://10.10.10.10/api/v3/targets
■ 単一のターゲットGET https://10.10.10.10/api/v3/targets/ xwWYAE33eku7PbzHdETIA
応答:ターゲットの配列内の単一のエントリ。パスワードフィールドはシークレットであるため、応答にはパスワード値が含まれていないことに注意してください。
[
{
"uuid":" xwWYAE33eku7PbzHdETIA", "category":"Hypervisor", "type":"vCenter", "status":"Validated",
"lastValidated":"2018-06-26T14:25:08-04:00",
"inputFields":[
{
"displayName":"Address", "name":"address",
"value":"vsphere-demo.mycorp.com", "isMandatory":true, "isSecret":false, "valueType":"STRING",
"description":"IP or address of vCenter Server", "verificationRegex":".*"
},
{
"displayName":"Username", "name":"username", "value":"corp\\my.user", "isMandatory":true, "isSecret":false, "valueType":"STRING",
"description":"User name to use to connect to a target",
"verificationRegex":".*"
},
{
"displayName":"Password", "name":"password", "isMandatory":true,
"isSecret":true, "valueType":"STRING",
"description":"Password to use to connect to a target", "verificationRegex":".*"
}
]
ターゲットの追加
Workload Optimization Manager インストールにターゲットを追加します。完成した TargetApiDTO オブジェクトを inputDTO として渡す必要があります。追加するターゲットの TargetApiDTO の必須フィールドの詳細については、/targets/specs ユーティリティリクエストを実行してください。
例:POST https://10.10.10.10/api/v3/targets
inputDTO の例:
{
"category":"Hypervisor", "inputFields":[
{
"name":"username", "value":"corp\\my.name"
},
{
"name":"password", "value":"Octopath"
},
{
"name":"nameOrAddress",
"value":"10.10.10.10"
}
],
"type":"vCenter"
}
すべてのターゲットを再検出または検証する
環境内のすべてのターゲットの完全な再検出または検証を手動でトリガーします。これは、更新された Orchestrator ワークフローの表示など、毎日の完全な検出が実行されるまで、通常は反映されない複数の変更をすぐに確認するためによく行われます。
この呼び出しは、次のパラメータを取ります:
検証 |
true の場合、環境内のすべてのターゲットを検証します |
rediscover |
true の場合、環境内のすべてのターゲットで完全な再検出を実行します。 |
例:
■ 再検出:
POST https://10.10.10.10/api/v3/targets?validate=true
■ 検証:
POST https://10.10.10.10/api/v3/targets?rediscover=true
単一のターゲットを再検出または検証する
環境内の単一のターゲットの完全な再検出または検証を手動でトリガーします。これは、更新された Orchestrator ワークフローの表示など、毎日の完全な検出が実行されるまで、通常は反映されない変更をすぐに確認するためによく行われます。
この呼び出しは、次のパラメータを取ります:
検証 |
true の場合、指定されたターゲットを検証します |
rediscover |
true の場合、指定されたターゲットで完全な再検出を実行します。 |
例:
■ 再検出:https://10.10.10.10/api/v3/targets/ xwWYAE33eku7PbzHdETIA?rediscover=true
■ 検証:https://10.10.10.10/api/v3/targets/ xwWYAE33eku7PbzHdETIA?validate=true
応答:指定されたターゲットの TargetApiDTO オブジェクト:
{
"uuid":" xwWYAE3EeiNKPbzHdETIA", "category":"Hypervisor", "inputFields":[
...
],
"lastValidated":"2018-06-27T21:45:56-04:00",
"status":"Validated", "type":"vCenter"
}
ターゲット入力フィールドの編集
既存のターゲットの入力フィールドを編集し、変更された TargetApiDTO を入力として受け入れます。
注:最初に GET /targets/specs を使用してターゲットを GET して、そのターゲットに必要なフィールドを確認できます。変更された TargetApiDTO オブジェクトのすべての入力フィールドを渡す必要があることに注意してください。
例:PUT https://10.10.10.10/api/v3/targets/_HgzQ4CdCEeaUWYEyo3vsyw
単一ターゲットのユーザー名を編集する入力例:
[
{
"uuid":"_HgzQ4CdCEeaUWYEyo3vsyw", "category":"Hypervisor", "type":"vCenter", "status":"Validated", "lastValidated":1474575346109, "inputFields":[
{
"displayName":"Address", "name":"address", "value":"vsphere.mycorp.com", "isMandatory":true, "isSecret":false, "valueType":"STRING"
},
{
"displayName":"Username", "name":"username", "value":"corp\\my.name.changed", "isMandatory":true, "isSecret":false, "valueType":"STRING"
},
{
"displayName":"Password", "name":"password",
"value":"Octopath", "isMandatory":true, "isSecret":true
}
]
}
]
ターゲットの削除
指定されたターゲットを削除し、そのターゲットによって管理されているすべてのエンティティを削除します。これにより、削除されたターゲットに関連する保留中のアクションもすべて削除されます。
例:DELETE https://10.10.10.10/api/v3/targets/ xwWYAE3EeiNKPbzHdETIA
応答: 削除要求が成功すると、応答コード 200 が返されます。
指定されたターゲットに対するアクション
これらのリクエストは、レポートで使用するため、または特定のアクションを見つけるために、ターゲットごとにアクションの完全なリストまたはフィルタリングされたリストを取得します。
注:アクション UUID を取得したら、アクション エンドポイントからのリクエストを使用して、そのアクションへの変更を送信できます。
フィルタリングされていないアクションの配列を取得する
指定されたターゲットによって検出されたエンティティに関連付けられている、環境内の現在のアクションのリストを取得します。
例:GET https://10.10.10.10/api/v3/targets/xwWYAE3EeiNKPbzHdETIA/actions
フィルタリングされたアクションの配列を取得する
単一のターゲットによって検出されたアクションのフィルタ済みリストを取得します。次の条件を 1 つ以上含む inputDTO を渡します。
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: 指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 ■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するようWorkload Optimization Manager に指示したことを示します。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモード。 |
actionStateList |
■ DISABLED: ポリシーが無効になっているアクション。 ■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 ■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: |
基準 |
説明 |
|
1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にします。前のアクションが完了すると実行されます。 |
actionTypeList |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加します。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動します。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。マーケットの状況に基づいて、分析は、 中断されたエンティティの再開を推奨し、再びマーケット分析に含めることがあります。 ■ ADD PROVIDER: これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE:: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨します。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨できます。 ■ DELETE: SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合、これは特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを減らすサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false。 true の場合、実行される前にアクション リストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false。 |
基準 |
説明 |
|
true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstanc |
デフォルト:false。 true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連するエンティティタイプとして VirtualMachine を指定した場合、要求には、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
例:DELETE https://10.10.10.10/api/v3/targets/ xwWYAE3EeiNKPbzHdETIA
次の inputDto の例では、承認待ちのアクションをフィルタリングします。
{
"actionStateList":[ "PENDING_ACCEPT"
]
}
応答:PENDING_ACCEPT 状態にある、指定されたターゲットに適用可能なアクションの配列。
[
{
"links":[
{
"rel":"self", "href":"https://10.10.10.10/api/v3/actions/_uictIJuHEeics6ASgJ-kdg"
},
{
"rel":"self", "href":"https://10.10.10.10/api/v3/actions/2218532354592"
}
],
"uuid":"_uictIJuHEeics6ASgJ-kdg", "createTime":"2018-08-08T23:53:08-04:00",
"actionType":"RIGHT_SIZE", "actionState":"PENDING_ACCEPT", "actionMode":"MANUAL",
"details":"Scale down VMem for VirtualMachine btc-1 from 8 GB to 7 GB", "importance":0,
"target":{
"uuid":"4223dcd6-0b28-6ae6-1066-689912ced3a1", "displayName":"btc-1", "className":"VirtualMachine",
"aspects":{
"virtualMachineAspect":{
"os":"Other Linux (64-bit)", "connectedNetworks":[
{
"uuid":"74c91ba4fa390030f47f91e6e1ee77ff7b4db353", "displayName":"VM Network"
}
],
"numVCPUs":1, "ebsOptimized":false
}
},
"environmentType":"ONPREM"
},
"currentEntity":{
"uuid":"_ui4yAZuHEeics6ASgJ-kdg", "className":"VMem"
},
"newEntity":{
"uuid":"_ui4yA5uHEeics6ASgJ-kdg", "className":"VMem"
},
"currentValue":"8388608.0", "newValue":"7340032.0", "resizeToValue":"7340032.0", "risk":{
"uuid":"_ujB78ZuHEeics6ASgJ-kdg", "subCategory":"Efficiency Improvement",
"description":"Underutilized VMem in Virtual Machine 'btc-1'", "severity":"MINOR",
"reasonCommodity":"VMem", "importance":0
},
"stats":[
{
"name":"costPrice", "filters":[
{
"type":"savingsType", "value":"savings"
}
],
"units":"$", "value":50
}
],
"actionID":2204259249360
},
...
}
]
指定されたターゲットに対するエンティティ
指定されたターゲットによって検出されたエンティティのリストを取得します。これは、レポート、ダッシュボード、またはインベントリの目的で最も頻繁に使用されます。
エンティティの配列の取得
指定されたターゲットによって検出されたすべてのエンティティのリストを取得します。エンティティは、アプリケーション、物理マシン、VM、ストレージ、データセンターなど、Workload Optimization Manager が管理する環境内のデバイスです。
例:GET https://10.10.10.10/api/v3/targets/ xwWYAE3EeiNKPbzHdETIA/actions
応答:vCenter ターゲットに属する EntityApiDTO オブジェクトの配列:
[
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/entities/vsphere-mycorp.com-ResourcePool-resgroup-8?include_a spects=false"
}
],
"uuid":"vsphere-mycorp.com-ResourcePool-resgroup-8", "displayName":"Resources-Cluster1", "className":"VirtualDataCenter",
"priceIndex":1e-12, "state":"ACTIVE",
"severity":"Normal", "discoveredBy":{
"uuid":" xwWYAE3EeiNKPbzHdETIA", "displayName":"vsphere-mycorp.com", "type":"vCenter"
},
"remoteId":"resgroup-8", "environmentType":"ONPREM"
},
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/entities/vsphere-mycorp.com-GuestLo ad-421ddc94-8d0c-504a-62f5-493802e96d0a?include_aspects=false"
}
],
"uuid":"vsphere-mycorp.com-GuestLoad-421ddc94-8d0c-504a-62f5-493802e96d0a",
"displayName":"GuestLoad[Nexus1000V]", "className":"Application", "priceIndex":1,
"state":"ACTIVE",
"severity":"Normal", "discoveredBy":{
"uuid":" xwWYAE3EeiNKPbzHdETIA", "displayName":"vsphere-mycorp.com", "type":"vCenter"
},
"remoteId":"vm-51", "environmentType":"ONPREM"
},
...
}
]
Workload Optimization Manager は、テンプレートを使用して、リソースを予約して環境にワークロードをデプロイし、計画の需要または供給の変化を計算し、クラウド環境のワークロードを計算します。
テンプレートエンドポイントを使用すると、次のことができます。
■ Workload Optimization Manager アプライアンスで使用可能なテンプレートのリストを取得する
■ 対応 OSや CPU など、テンプレート作成に必要な情報を入手する
■ テンプレートの作成
■ テンプレートの編集と削除
ユーティリティリクエストは、関連するリクエストの作成、inputDTO のアセンブル、または特定の DTO の潜在的な値の表示に使用できるメタデータを提供します。
テンプレートエンドポイントには、詳細なテンプレートを作成するために使用されるいくつかのオプションフィールドの可能な値を示す、ユーティリティリクエストが含まれています。これらを使用して、サポートされているクラウド OS と CPU モデルを見つけることができます。
CPU モデルのリストの取得
有効な CPU モデルのリストを取得します。CPU モデルが指定されている場合、Workload Optimization Manager は、マーケットの決定において CPU のキャパシティをより正確に反映できます。
例:GET https://10.10.10.10/api/v3/templates/physicalmachine/cpumodels
結果: 各 CPU のコア、速度、および内部スケーリング係数を記述する CpuModelApiDTO のリスト。この情報は、TemplateApiInputDTO の一部として渡される場合、より詳細な CPU データを提供するために使用されます:
[
{
"numCores": 4,
"speed": 3500,
"scalingFactor": 1.116909571123129,
"modelName": "AMD A10 PRO-7800B"
},
{
"numCores": 4,
"speed": 3700,
"scalingFactor": 0.9745581799084503,
"modelName": "AMD A10 PRO-7850B"
},
...
{
"numCores": 8,
「速度」: 1415、
"scalingFactor": 1.1638948014750774,
"modelName": "UltraSPARC T2 Plus"
}
]
テンプレートリクエストは、Workload Optimization Manager アプライアンスでのテンプレートの作成、構成、編集、および削除を処理します。
テンプレートリストの取得
Workload Optimization Manager インスタンスで使用できるテンプレートリストを取得します。このリストには、基礎となるターゲットから検出されたテンプレートと、Workload Optimization Manager UI を介して作成されたテンプレートの両方が含まれます。特定のテンプレートを取得するには、リクエストの一部としてテンプレート UUID を渡します。
例:
■ すべてのテンプレート:GET https://10.10.10.10/api/v3/templates
■ 単一ターゲット:GET https://10.10.10.10/api/v3/templates/_v0Q70MpiEd-hypXfJzX8Wg
応答:TemplateApiDTO のリスト:
[
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/templates/_v0Q70MpiEd-hypXfJzX8Wg"
}
],
"uuid": "_v0Q70MpiEd-hypXfJzX8Wg", "displayName": "Small",
"className": "PhysicalMachineProfile", "price": 5000,
"computeResources": [
{
"stats": [
{
"name": "numOfCores", "value": 4
},
{
"name": "cpuSpeed",
"units": "MHz",
"value": 2992
},
{
"name": "ioThroughputSize", "units": "MB/s",
"value": 890
},
{
"name": "memorySize", "units": "MB", "value": 32759
},
{
"name": "networkThroughputSize", "units": "MB/s",
"value": 512
}
]
}
],
"infrastructureResources": [
{
"stats": [
{
"name": "powerSize", "value": 1
},
{
"name": "spaceSize", "value": 1
},
{
"name": "coolingSize", "value": 1
}
]
}
],
"discovered": false
},
{
"links": [
{
"rel": "self",
"href": "https://10.10.10.10/api/v3/templates/_v0Q70cpiEd-hypXfJzX8Wg"
}
],
"uuid": "_v0Q70cpiEd-hypXfJzX8Wg", "displayName": "Medium",
"className": "PhysicalMachineProfile", "price": 10000,
"computeResources": [
{
"stats": [
{
"name": "numOfCores", "value": 4
},
{
"name": "cpuSpeed",
"units": "MHz", "value": 2992
},
{
"name": "ioThroughputSize", "units": "MB/s",
"value": 1780
},
{
"name": "memorySize", "units": "MB", "value": 65519
},
{
"name": "networkThroughputSize", "units": "MB/s",
"value": 512
}
]
}
],
"infrastructureResources": [
{
"stats": [
{
"name": "powerSize", "value": 1
},
{
"name": "spaceSize", "value": 1
},
{
"name": "coolingSize", "value": 1
}
]
}
],
"discovered": false
},
...
]です
テンプレートの作成
環境で使用するテンプレートを作成します。完成した TemplateApiInputDTO を inputDTO として渡す必要があります。仮想マシン、物理マシン、ストレージ、およびコンテナのテンプレートを作成できます。
例:POST https://10.10.10.10/api/v3/templates
入力例:
テンプレートのタイプ |
入力例: |
コンテナ |
{ "computeResources":[ { "stats":[ { "name":"ioThroughput", "value":0 }, { "name":"networkThroughput", "value":0 }, { "name":"memorySize", "value":8192 }, { "name":"cpuSpeed", "value":1536 } ] } ], "storageResources":[ { "stats":[ { "name":"diskSize", "value":20 } ] } ], "className":"ContainerProfile"、"displayName":"ContainerTemplate1" } |
物理マシン |
{ "cpuModel":"AMD A10-5700", "computeResources":[ { "stats":[ |
テンプレートのタイプ |
入力例: |
|
{ "name":"ioThroughputSize", "value":1000 }, { "name":"networkThroughputSize", "value":1000 }, { "name":"memorySize", "value":8192 }, { "name":"numOfCores", "value":4 }, { "name":"cpuSpeed", "value":"3400" } ] } ], "price":0, "className":"PhysicalMachineProfile", "displayName":"HostTemplate1" } |
ストレージ |
{ "storageResources":[ { "stats":[ { "name":"diskIops", "value":250 }, { "name":"diskSize", "value":750 } ] } ], "price":0, "className":"StorageProfile", "displayName":"StorageTemplate1" } |
Virtual Machine |
|
テンプレートのタイプ |
入力例: |
|
{ "computeResources":[ { "stats":[ { "name":"ioThroughput", "value":0 }, { "name":"networkThroughput", "value":500 }, { "name":"memorySize", "value":4096 }, { "name":"memoryConsumedFactor", "value":70 }, { "name":"numOfCpu", "value":2 }, { "name":"cpuSpeed", "value":1024 }, { "name":"cpuConsumedFactor", "value":75 } ] } ], "storageResources":[ { "type":"disk", "stats":[ { "name":"diskIops", "value":50 }, { "name":"diskSize", "value":20 }, { "name":"diskConsumedFactor", "value":70 } ] } |
テンプレートのタイプ |
入力例: |
|
] } |
応答:作成されたテンプレートの TemplateApiInputDTO。この場合は、仮想マシンテンプレートです:
{
"uuid":"_lmaQoLUtEei5nORDMStFGA", "displayName":"VirtualMachineTemplate1", "className":"VirtualMachineProfile", "computeResources":[
{
"stats":[
{
"name":"numOfCpu", "value":2.0
},
{
"name":"cpuSpeed",
"units":"MHz", "value":1024.0
},
{
"name":"cpuConsumedFactor", "units":"%",
"value":75.0
},
{
"name":"memorySize", "units":"MB", "value":4096.0
},
{
"name":"memoryConsumedFactor", "units":"%",
"value":70.0
},
{
"name":"ioThroughput", "units":"MB/s", "value":0.0
},
{
"name":"networkThroughput", "units":"MB/s", "value":500.0
}
]
}
],
"storageResources":[
{
"stats":[
{
"name":"diskIops", "value":50.0
},
{
"name":"diskSize",
"units":"GB", "value":20.0
},
{
"name":"diskConsumedFactor", "units":"%",
"value":70.0
}
],
"type":"disk"
}
],
"deploymentProfile":{
"uuid":"_llbZMrUtEei5nORDMStFGA",
"displayName":"VirtualMachineTemplate1_DeploymentProfile", "className":"ServiceCatalogItem",
"deployParameters":[
{
"targetType":"vCenter", "providers":[
{
"provider":{ "uuid":"dfe657268310d8b128d441b2a34ec0721e72ee7e", "displayName":"Development DC7", "className":"DataCenter",
"discoveredBy":{
"uuid":"_OjF3UJwFEei_xJ5Ai6-rnQ", "displayName":"vsphere-dc7.mycorp.com", "type":"vCenter"
}
},
"parameters":[
{
"parameterType":"image", "properties":[
{
"name":"id", "value":"path/to/image"
}
]
}
]
}
]
}
]
},
"discovered":false
}
テンプレートの編集
テンプレート UUID と編集された DTO を指定して、ユーザーが作成したテンプレートを編集します。検出されたテンプレートを編集するには、それらが発生したターゲットでそれらを編集します。編集されたフィールドを含む完全な TemplateApiDTO を渡す必要があることに注意してください。
例:PUT https://10.10.10.10/api/v3/templates/_lmaQoLUtEei5nORDMStFGA
入力例:displayName と diskConsumedFactor の両方の値が変更されたことに注意してください:
{
"computeResources":[
{
"stats":[
{
"name":"ioThroughput", "value":0
},
{
"name":"networkThroughput", "value":500
},
{
"name":"memorySize", "value":4096
},
{
"name":"memoryConsumedFactor", "value":70
},
{
"name":"numOfCpu", "value":2
},
{
"name":"cpuSpeed", "value":1024
},
{
"name":"cpuConsumedFactor", "value":75
}
]
}
],
"storageResources":[
{
"type":"disk", "stats":[
{
"name":"diskIops", "value":50
},
{
"name":"diskSize", "value":20
},
{
"name":"diskConsumedFactor", "value":75
}
]
}
],
"className":"VirtualMachineProfile", "displayName":"VirtualMachineTemplate1_Modified", "deploymentProfileId":"_llbZMrUtEei5nORDMStFGA"
}
応答:送信された変更を反映する変更された TemplateApiDTO。
テンプレートの削除
指定されたテンプレートを削除します。関連付けられた展開プロファイルは削除されませんが、このテンプレートを使用するように既にスケジュールされている展開は成功しません。
例:DELETE https://10.10.10.10/api/v3/templates/_lmaQoLUtEei5nORDMStFGA
Workload Optimization Manager を使用すると、追加のアプリケーションデータを Workload Optimization Manager 独自のビジネスアプリケーション、ビジネストランザクション、およびサービスを作成できます。これは、Workload Optimization Manager のサプライチェーンに表示されるアプリケーションスタックにギャップがある場合に役立ちます。たとえば、AppDynamics や Dynatrace などのアプリケーション監視対象がない場合、サプライチェーンにビジネスアプリケーションは表示されません。この機能は、これらのギャップに対処します。
新しいアプリケーション エンティティを作成するときは、パフォーマンスを測定する既存の環境内で相互関連するアプリケーション エンティティとノードを識別します。これにより、Workload Optimization Manager は、サプライチェーンでそれらをリンクし、統合グループとして表すことができます。新しいアプリケーション エンティティのコンテキストでグループの全体的なパフォーマンスを監視し、個々のエンティティとノードにドリルダウンして詳細を確認できます。
Workload Optimization Manager API のトポロジ定義エンドポイントを使用すると、次のことができます。
■ 環境に存在する単一のトポロジ定義またはトポロジ定義のリストを取得する
■ トポロジ定義を作成する
■ トポロジ定義を編集する
■ トポロジ定義を削除する
トポロジ定義リクエストは、Workload Optimization Manager アプライアンスでのトポロジ定義の作成、構成、編集、および削除を処理します。
トポロジ定義の取得
トポロジ定義のリストの場合、API は TopologyDataDefinitionApiDTO の配列を返します。各 TopologyDataDefinitionApiDTO には、定義されたトポロジの UUID、エンティティタイプ、および接続属性が含まれます。単一のトポロジ定義を取得するには、トポロジ定義の UUID を要求に含めます。
例:
■ すべてのトポロジ定義:GET https://10.10.10.10/api/v3/topologydefinitions
■ 単一トポロジ定義:GET https://10.10.10.10/api/v3/topologydefinitions/284711321829968
応答:
{
"uuid":"284711313871856"、
"displayName":"Daltest1 App", "entityType":"BusinessApplication", "entityDefinitionData":{
"namePrefix":"Daltest1_", "entityType":"VirtualMachine", "generationAndConnectionAttribute":{
"expVal":"App",
"expType":"EQ", "filterType":"virtualMachinesByTag", "caseSensitive":true, "entityType":null, "singleLine":false
}
}
}
手動トポロジ定義の作成
手動トポロジ定義を作成するには、定義の entityType と、使用するエンティティへの手動マッピング データを提供する必要があります。次の入力 DTO を考慮して、手動トポロジ定義を作成します。
{
"entityType":"BusinessApplication", "entityDefinitionData":{
"manualConnectionData":{
"BusinessTransaction":{
"staticConnections":[
"73585155548499",
"73585155548500"
]
},
"Service":{
"staticConnections":[
"73585155548487",
"73585155608929"
]
},
"ApplicationComponent":{
"staticConnections":[
"73596151905427",
"73596151905425",
"73596151905428",
"73596151905429"
]
},
"VirtualMachine":{
"staticConnections":[
"73586657216608",
"73585300874097",
"73586657216576"
]
},
"DatabaseServer":{
"staticConnections":[
"73585314633044",
"73585314632869",
"73585314632946"
]
},
"Container":{
"staticConnections":[
"73585323455544",
"73582124234229",
"73585385438946"
]
},
"ContainerPod":{
"staticConnections":[
"73585334243044",
"73585314324535",
"73585314533256"
]
}
}
},
"displayName":"DalManualtest_"
}
entityDefinitionData の manualConnectionData パラメータでは、トポロジをインスタンス化する必要があるサプライ チェーンの各レベルに対して、関連するエンティティの UUID が提供されています。
作成は、必要に応じて単純にも複雑にもできます。たとえば、単純な手動トポロジは次のようになります。
{
"entityType":"BusinessTransaction", "entityDefinitionData":{
"manualConnectionData":{ "Service":{
"staticConnections":[
"73585155548487"
]
},
"Container":{
"staticConnections":[
"73596151905298"
]
}
}
},
"uuid":"284711514573216",
"displayName":"DalManualSimple"
}
自動トポロジ定義の作成
自動トポロジ定義を作成するには、定義の entityType と、動的グループメンバーシップを決定するために使用される正規表現を構成するデータを提供する必要があります。自動トポロジ定義を作成するために、次の入力 DTO を検討してください:
{
"entityType":"BusinessApplication", "entityDefinitionData":{
"entityType":"VirtualMachine", "namePrefix":"Daltest1_", "generationAndConnectionAttribute":{
"expType":"EQ",
"expVal":"App", "filterType":"vmsByTag", "caseSensitive":false
}
}
}
entityDefinitionData の generationAndConnectionAttribute パラメータには、正規表現を構成する情報が送信されます。この場合、タグ値が "App" に等しい任意の仮想マシンに一致します。
トポロジ定義の編集
既存のトポロジ定義の入力フィールドを編集し、変更された TopologyDataDefinitionApiDTO を入力として受け入れます。
注: GET /topologydefinition/UUID リクエストを使用して、最初にトポロジ定義を GET して、現在の構成を表示できます。変更されたフィールドだけでなく、TopologyDataDefinitionApiDTO のすべてのフィールドを渡す必要があることに注意してください。
編集が成功すると、変更された TopologyDataDefinitionApiDTO が返されます。
例:PUT https://10.10.10.10/api/v3/topologydefinitions
トポロジ定義の削除
指定されたトポロジ定義を削除し、作成されたすべてのエンティティを削除します。これにより、削除されたエンティティに関連する保留中のアクションも削除されます。
例:DELETE https://10.10.10.10/api/v3/topologydefinitions/284711321829968
応答:削除要求が成功すると、応答コード 200 が返されます。
Workload Optimization Manager インストールに追加すると、オーケストレータのターゲットは、環境内で変更を行うために複数のアクションを実行するワークフローを割り当てます。Workload Optimization Manager は、オーケストレータで定義したワークフローを検出します。その後で、ワークフローをアクションにマッピングする自動化ポリシーを設定できます。アクション モードが [手動(Manual)] または [自動(Automated)] の場合は、Workload Optimization Manager がアクションを推奨すると、マッピングされたワークフローを使用して実行するようにオーケストレータに指示します。
特定のオーケストレータターゲットの詳細については、『ターゲット構成ガイド』の「Orchestrator ターゲット」を参照してください。ワークフロー実行の詳細については、『ユーザーガイド』の「アクションのオーケストレーション」を参照してください。
ワークフローエンドポイントを使用すると、次のことができます。
■ すべてのワークフローのリストを取得する
■ 指定されたワークフローに関する詳細情報を取得する
ワークフローの取得
ワークフローのリストの場合、API は WorkflowApiDTO の配列を返します。各 WorkflowApiDTO オブジェクトには、説明やパラメータなど、そのワークフローに関する詳細情報が含まれます。単一のワークフローを取得するには、ワークフローの UUID をリクエストに含めます。
この呼び出しは、次のパラメータを取ります:
type |
ワークフローのタイプでリクエストをフィルタリングします。[ UCSD, AWS_Service_Catalog ] |
例:
■ すべてのワークフロー:GET https://10.10.10.10/api/v3/workflows
■ 単一ワークフロー:GET https://10.10.10.10/api/v3/workflows/UCSD-WF-ucsd.eng.mycorp.com-103
応答:
[
{
"links":[
{
"rel":"self",
"href":"https://10.10.10.10/api/v3/workflows/UCSD-WF-ucsd.eng.mycorp.com-103"
}
],
"uuid":"UCSD-WF-ucsd.eng.mycorp.com-103", "displayName":"APIC Container Delete Firewall Rule Action", "className":"Workflow",
"actionType":"NONE"、"パラメータ":[
{
"name":"APIC_TENANT_L4L7_EPG_ACE_IDENTITY",
"isMandatory":true,
"isSecret":false,
"specificValueType":
"ApicTenantL4L7EPGAceIdentity"
},
{
"name":"L4L7Identity", "isMandatory":true,
"isSecret":false, "specificValueType":"gen_text_input"
},
{
"name":"ACLName",
"isMandatory":true,
"isSecret":false, "specificValueType":"gen_text_input"
},
{
"name":"ACEName",
"isMandatory":true,
"isSecret":false, "specificValueType":"gen_text_input"
}
],
"discoveredBy":{
"uuid":" U1MIJv-Eei_xJ5Ai6-rnQ", "displayName":"ucsd.eng.mycorp.com", "type":"Cisco UCS Director"
}
],
...
}
]
特定のタイプのワークフローの取得
/api/v3/workflows リクエストに type パラメータを追加することで、特定のソースからのワークフローをフィルタリングできます。たとえば、この要求への応答は、UCS Director ターゲットを介して検出された WorkflowApiDTO の配列になります:
例:GET https://10.10.10.10/api/v3/workflows?type=UCSD
目的
Workload Optimization Manager クックブックは、API を使用して特定のタスクを実行し、Workload Optimization Manager API のベスト プラクティスを提示しながら、よくある質問に答えるのを支援することを目的としています。API ガイドのこのセクションは常に更新されているドキュメントです。
クックブック
各クックブックには、1 つ以上のレシピが含まれています。各レシピには、指定されたタスクを完了するために必要なすべての情報と、レシピの機能を示す基本的なスクリプトが含まれています。
■ Workload Optimization Manager API による認証(287ページ)
– エンティティのサブセットへの変更を確認する(290 ページ)
目標
API でログインした後に認証トークンを取得し、そのトークンを後続の API 呼び出しで使用すること。
API による認証
API を使用するには、Workload Optimization Manager インスタンスに有効なユーザーアカウントが必要です。また、アカウントはさまざまな役割を持つ場合があることに注意してください。API は、ユーザーロールに有効なコマンドのみを実行します。たとえば、Workload Optimization Manager の推奨アクションを実行するには、アカウントに管理者、デプロイヤー、またはオートメータのロールが必要です。
API 呼び出しを行うには、認証トークンを要求し、呼び出しごとにそれを Workload Optimization Manager API に渡します。トークン リクエストは、認証用の Cookie を返します。このトークンを使用する一般的な方法は、Cookie をローカルに保存し、API 呼び出しで渡すことです。
例:curl -s -k -c /tmp/cookies -H 'accept: application/json' 'https://localhost/api/ v3/login?hateoas=true' -d 'username=administrator&password=password'
それから、ログインリクエストによって配信されるセッション Cookie を使用するために、各リクエストで -b cookie-filename パラメータを使用する必要があります。
もう 1 つのアプローチは、認証ヘッダーを取得して認証 Cookie を解析することです。次に、Cookie を含む各 API リクエストのヘッダーを作成できます。たとえば、token という名前の変数に値を格納するとします。次のように使用できます。
headers = {'cookie': token}
r = requests.get('https://10.10.123.456/api/v3/targets/specs', headers=headers, verify=False, stream=True)
前提条件
認証トークンを取得するには、次の情報が必要です。
■ Workload Optimization Manager インスタンスの IP アドレス。.
■ ログインするユーザーのユーザー名とパスワード。
手順
認証トークンを取得するには:
1. API ペイロードを構築します。
入力本文は、myUsername と myPassword の代わりに資格情報を使用した次の形式の JSON である必要があります。
{'username': 'myUsername', 'password': 'myPassword'}
2. API リクエストを行います。
POST https://[INSTANCE_IP]/api/v3/login リクエストを使用し、前の手順で作成した入力本文を使用します。
3. 応答ヘッダーから認証トークンを取得します。ヘッダーの例:
{
'Server':'nginx',
'Date':'Mon, 01 Feb 2021 20:17:02 GMT',
'Content-Type':'application/json',
'Transfer-Encoding':'chunked',
'Connection':'keep-alive',
'Vary':'Accept-Encoding',
'Set-Cookie':'JSESSIONID=node0jzerbqte09pe1j29x6ypo92fh17.node0; Path=/; HTTPOnly; Secure',
'Expires':'Thu, 01 Jan 1970 00:00:00 GMT',
'X-Content-Type-Options':'nosniff',
'X-XSS-Protection':'1; mode=block',
'Strict-Transport-Security':'max-age=63072000; includeSubDomains',
'X-Frame-Options':'SAMEORIGIN',
'X-Turbo-Upstream':'API',
'Content-Encoding':'gzip'
}
認証トークンは、Set-Cookie ヘッダーの; で区切られた最初のトークンです。この例では、
JSESSIONID=node0jzerbqte09pe1j29x6ypo92fh17.node0 です。
後続の API リクエストでの認証トークンの使用
認証トークンを取得したら、そのトークンを使用して、さらに API リクエストを行うことができます。これを行うには、Cookie の名前とトークンの値を使用して、リクエストにヘッダーを含めます。例:
{'cookie': 'JSESSIONID=node0jzerbqte09pe1j29x6ypo92fh17.node0' }
スクリプト例
これらのリストは、Cookie から認証トークンを取得する関数と、関数を呼び出してトークン値を出力するスクリプトを示しています。
トークンを取得する関数:
この関数を呼び出すには、IP アドレス、ユーザー名、およびパスワードを引数として渡します。この関数は認証ペイロードを作成し、指定された Workload Optimization Manager インスタンスからトークンを要求します。次に、Set-Cookie ヘッダーの最初のトークンを解析し、その値を返します。
import json
import
requests
import urllib3
urllib3.disable_warnings()
def get_cookie(ip, username, password):
payload = {'username': username, 'password': password}
r = requests.post(f'https://{ip}/api/v3/login', data=payload, verify=False)
r.encoding = 'JSON'
rh = r.headers
token = rh['Set-Cookie'].split(';')[0]
return token
関数を呼び出すスクリプト:
スクリプトが use_login.py として保存されているとします。また、関数は ./login.py ファイルにあるとします。このスクリプトを呼び出すには、スクリプト ファイルの場所でシェルを開き、次のように入力します。
./use-login.py <My_IP_Address> <My_Username> <My_Pwd>
これは、Workload Optimization Manager の IP アドレス、ユーザー名、パスワードの 3 つの引数を取ります。スクリプトは、./login.py ファイルをインポートし、4 つの引数(スクリプト名と渡した 3 つの引数)をチェックします。次に、login.get_cookie() 関数を実行します。関数はトークンを返し、スクリプトはそれを出力します。
#!/usr/bin/env python3
import sys
import login
if len(sys.argv) != 4:
print("Incorrect arguments list.") sys.exit()
token = login.get_cookie(sys.argv[1], sys.argv[2], sys.argv[3]) print(f'TOKEN IS: {token}')
スクリプトの結果
このスクリプトの結果には、認証トークンが表示されます。
トークンは、JSESSIONID=node0jzerbqte09pe1j29x6ypo92fh17.node0 のようになります。
このクックブックでは、Workload Optimization Manager のプランマーケットについて説明します。このプランマーケットを解釈および解析することで、Workload Optimization Manager が特定のエンティティに対して特定のアクションを実行した方法と理由、リソース(使用済みおよび利用可能の両方)がどのように変化したかなどを、レシピがクックブックに追加されるにつれて、よりよく理解できるようになります。
注:Workload Optimization Manager の UI には、特定の計画構成オプションがあり、特定の目標を達成するための構成変更の基本セットを提示するために使用できます。たとえば、ワークロードの追加プランは、追加のワークロードがプロビジョニングされることを想定して事前構成されています。Workload Optimization Manager がこれらの構成を作成する方法を確認するには、シナリオの例(180 ページ)で UI プラン構成の DTO を表示します。
関連するエンドポイント
計画の結果を解釈するとき、データを取得して明確にするために、次のエンドポイントが一般的に使用されます。
■ アクション(29ページ):プランマーケットのアクションを取得すると、プランの実行中にどのエンティティが直接影響を受けたかを確認できます。
■ エンティティ(62 ページ):プランマーケットのエンティティを取得すると、プランに関連するエンティティの完全なリストを表示できます。
■ グループ(91ページ):プランマーケットのグループを取得すると、指定したグループ内のエンティティの UUID 情報をより簡単に取得できます。
■ 統計(233 ページ):プランマーケット全体、グループ、またはエンティティのマーケット統計を取得すると、プラン終了後にエンティティの使用状況の広範な概要を簡単に確認できます。
ユースケース索引
プランの結果クックブックには次のレシピがあります。
■ エンティティのサブセットへの変更の表示(290 ページ)
目標
プランを実行した後、特定のエンティティまたはエンティティグループに対するプランの影響を確認する必要がある場合があります。これにより、構成の変更がプラン エンティティのサブセットに与える影響をよりよく理解したり、Workload Optimization Manager が特定のアクションの推奨を行った理由を調べることができます。
たとえば、他の多くのエンティティと依存関係を共有する仮想マシンがあるとします。全体的な計画の結果とは別に、計画が特にこの VM にどのように影響するかを詳しく調べたい場合があります。
前提条件
指定されたエンティティへの変更を調査するには、次のことを知る必要があります。
■ 正常に完了したプランマーケットの UUID
この UUID を取得するには、シナリオをマーケットに POST したときに送信される API レスポンスから取得するか、
GET /markets リクエストを実行し、シナリオの名前に対応する名前のマーケットを見つけます。または、プランマーケットのシナリオ パラメータでシナリオの UUID を見つけることができます。state パラメーターの値が SUCCEEDED であることを確認します。たとえば、次の計画市場を作成したシナリオの UUID は 214410933912976 であり、計画市場自体の UUID は 214410933923968 です。
{
"uuid":"214410933923968",
"displayName":"Add Workload 2",
"className":"Market",
"state":"SUCCEEDED",
"stateProgress":100,
"scenario":{
"uuid":"214410933912976",
"displayName":"Optimize Cloud 2",
...
}
...
}
同じシナリオが複数の計画に適用されている場合は、計画の runDate パラメータが計画の実行予定時刻に対応していることを確認してください。
シナリオの作成と実行の詳細については、「シナリオ DTO ブレークダウン」(168ページ)を参照してください。
■ 検査するエンティティの UUID
プランマーケットのエンティティ UUID は、リアルタイムマーケットの対応するエンティティと同じです。つまり、UUID は、関連フィールド (エンティティの displayName など) のプランマーケットを検索するか、Workload Optimization Manager ユーザー インターフェースで検索してエンティティ UUID を見つけることができます。
API の検索エンドポイントを使用して、さまざまな条件でエンティティを検索することもできます。
関連するエンドポイント
計画の結果を解釈するとき、データを取得して明確にするために、次のエンドポイントが一般的に使用されます。
■ アクション(29ページ):プランマーケットのアクションを取得すると、プランの実行中にどのエンティティが直接影響を受けたかを確認できます。
■ エンティティ(62 ページ):プランマーケットのエンティティを取得すると、プランに関連するエンティティの完全なリストを表示できます。
■ グループ(91ページ):プランマーケットのグループを取得すると、指定したグループ内のエンティティの UUID 情報をより簡単に取得できます。
■ 統計(233 ページ):プランマーケット全体、グループ、またはエンティティのマーケット統計を取得すると、プラン終了後にエンティティの使用状況の広範な概要を簡単に確認できます。
手順
プラン エンティティの特定のサブセットに対する変更を調査するには、次の手順を実行します。
1. 調査する UUID のリストを取得します。
マーケット内のすべてのエンティティを取得するには:
markets/{market_uuid}/entities
プランの範囲が小さい場合は、これを使用してプラン内のすべてのエンティティを取得し、エンティティタイプや表示名などの他の属性の結果を反復処理できます。
マーケット/{market_uuid}/エンティティ
範囲が広い場合は、検索エンドポイントを使用して、特定の条件で VM を見つけることができます。これが機能するのは、プランマーケットとリアルタイムマーケットが同じエンティティに対して同じ UUID 値を使用するためです。たとえば、次の呼び出しは、名前に文字列 FOO が含まれるすべての VM を取得します。
https://10.10.123.456/api/v3/search?q=FOO&types=VirtualMachine&entity_types=VirtualMachine&query_typ e=CONTAINS
2. 計画アクションのリストを取得します。
プランマーケットに対して GET /markets/{market_Uuid}/actions を実行します。POST /markets/ を使用することもできます
{market_uuid}/actions は、特定のタイプまたは特定のリスク重大度のアクションのみを返すなど、高度なアクション クエリのフィルタを投稿します。
プラン アクションを取得する別の方法は、検索エンドポイントを使用することです。説明、コスト タイプ、またはその他のデータのテキストによって、返されるアクションを制限する検索パラメータを POST できます。たとえば、次の検索は VM 上のアクションのみを返します。
searchSpec = { "actionRelationTypeFilter": [
「なし」
],
"costType": "SAVING"、"descriptionQuery": {
"query": "仮想マシン",
"type": "CONTAINS",
"caseSensitive": "true"
},
"detailLevel": "標準"
}
上記のペイロードを使用すると、次の POST はプランから VM アクションを返します。
requests.post(f'https://{ip}/api/v3/markets/{marketUuid}/actions', headers=headers,
json = searchSpec、verify=False、stream=True)
3. API レスポンスを検索し、エンティティに関連するアクションを見つけます。
各アクションにはターゲット パラメータがあり、これには uuid があります。この UUID は、アクションが実行されたエンティティを識別します。これは、アクションのリストでエンティティを見つけるための最良の方法です。
指定されたターゲット > uuid 値を持つアクションがない場合、問題のエンティティに対してアクションは実行されませんでした。
注:GET /markets/{market_Uuid}/entities を使用して、検索している UUID がプランマーケットに存在することを確認できます。そうでない場合は、エンティティが計画の範囲に含まれていないか、エンティティがアイドル状態のワークロードと見なされていることを意味します。An idle workload shows no utilization, so the plan cannot determine optimal placement or what percentage of allocated resources that workload will require when it restarts.
4. 結果を分析する。
各アクションには、アクションの詳細、変更されたリソースの古い/新しい値、DELETE アクションの削除のレコードなど、ActionApiDTO データに詳細な情報が含まれています。
この DTO を検索し、重要なパラメータをメモします。(DTO リファレンスについては、ActionApiDTO(336 ページ)を参照してください)。
スクリプト例
次のスクリプトは、仮想マシンのアクションのリストを検索し、簡単に比較できるように、要求されたフィールドを返します。この場合、アクションの UUID、タイプ、状態、理由、リスクカテゴリ、およびリスクサブカテゴリが返され、エンティティの表示名、テンプレート UUID、および場所とペアにされます。
このスクリプトは簡単に拡張できます。たとえば、currentLocation > displayName が newLocation > displayName と等しい場合、VM の場所に関する変更が行われていないということであるため、これらのフィールドのいずれも表示しないように選択できます。これらの結果を使用して、さらに呼び出しを行うこともできます。たとえば、テンプレート UUID を使用して GET /templates/
{template_Uuid} リクエストを行い、サイズ変更アクションに使用されているテンプレートに関する詳細情報を返させることができます。
スクリプトはドット表記を使用して、検査するフィールドに名前を付けることに注意してください。これらのフィールドをネストされた Python ディクショナリ値に変換する getFieldFromDict 関数が含まれています。API は JSON データを返すため、このような関数は一般的に有用なユーティリティです。
#!/usr/bin/env python3
#
# コマンドライン引数:プラットフォーム IP、ユーザー名、パスワード, マーケット ID、VM ID をコンマ区切りの文字列(スペースなしで指定)# 例:./entity_changes.py 10.10.123.456 MyUser MyPwd 215426452602368
74635124762083,74635124762088,74635124762090
#
import json import requests import urllib3 import re
import sys
sys.path.append('../login') # これによりログインを可視化します... import login
#
# この関数は json のようなドット表記フィールドを取り、Python ディクショナリ値を返します。# これにより、表示したい DTO フィールドを指定しやすくなります。
#
def getFieldFromDict(field, dict):
fToks = field.split('.')
l = len(fToks) workingDict = dict
for item in fToks:
if item in workingDict:
ret = workingDict[item] else:
return "ITEM NOT IN OBJECT" l -= 1
if l == 0:
return ret else:
workingDict = ret return ret
#
# クエリしたいフィールドのリスト(ドット表記)#
RetrieveFields = [
"uuid", "actionType", "actionState", "details",
"currentEntity.displayName", "newEntity.displayName", "template.uuid", "risk.subCategory", "risk.description", "currentLocation.displayName", "newLocation.displayName"
]
#
# VM 上のアクションを取得するための検索仕様。#
searchSpec = {
"actionRelationTypeFilter":[
"NONE"
],
"costType":"SAVING", "descriptionQuery":{
"query":"Virtual Machine", "type":"CONTAINS",
"caseSensitive":"true"
},
"detailLevel":"STANDARD"
}
#
# 引数の数が正しいことを確認してください。#
if len(sys.argv) != 6:
print("Incorrect arguments list.") sys.exit()
#
# 引数を適切な名前の変数に取得し、認証も行います。#
ip = sys.argv[1] marketUuid = sys.argv[4]
ElemsToInspect = sys.argv[5].split(',')
token = login.get_cookie(ip, sys.argv[2], sys.argv[3]) headers = {'cookie':token}
#
# VM でのアクションのプランを検索します #
actions_r = requests.post(f'https://{ip}/api/v3/markets/{marketUuid}/actions', headers=headers, json = s earchSpec, verify=False, stream=True)
if actions_r.status_code != 200:
print(f'Market Request Status is {actions_r.status_code}.') sys.exit()
#
# コマンド ラインで渡すエンティティの 1 つを対象とするアクションごとに、# オブジェクトを解析し、フィールド値を表示します。
#
print("Plan Changes for Entity(ies):") print(sys.argv[5])
print("---------------------- ")
r_json = actions_r.json() for item in r_json:
target = item['target']
if 0 < ElemsToInspect.count(target["uuid"]):
print(f'VM ACTION:{target["displayName"]}')
for field in RetrieveFields:
val = getFieldFromDict(field, item) print(f' {field}:{val}')
スクリプトの結果
このスクリプトの結果には、各プランエンティティについて要求された情報が表示されます。
Plan Changes for Entity(ies):
74635124762083,74635124762088
VM ACTION:test-rosa-28tfg-worker-us-west-2a-5hr8j uuid:145057709553360
actionType:SCALE actionState:SUCCEEDED
details:Scale Virtual Machine test-rosa-28tfg-worker-us-west-2a-5hr8j from m5.xlarge to r5a.large in Advanced Engineering
currentEntity.displayName:m5.xlarge
newEntity.displayName:r5a.large template.uuid:74635137532084 risk.subCategory:Efficiency Improvement
risk.description:Underutilized VCPU, Net Throughput currentLocation.displayName:aws-US West (Oregon) newLocation.displayName:aws-US West (Oregon)
VM ACTION:test-rosa-28tfg-infra-us-west-2a-mw867 uuid:145057709553376
actionType:SCALE actionState:SUCCEEDED
details:Scale Virtual Machine test-rosa-28tfg-infra-us-west-2a-mw867 from r5.xlarge to r5a.xlarge in Advanced Engineering
currentEntity.displayName:r5.xlarge newEntity.displayName:r5a.xlarge template.uuid:74635137531741 risk.subCategory:Efficiency Improvement risk.description:Increase RI Utilization
currentLocation.displayName:aws-US West (Oregon) newLocation.displayName:aws-US West (Oregon)
エンティティのグループの変更を確認する
このスクリプトは簡単に変更して、各 UUID を知らなくても、特定のエンティティグループの変更を確認できます。
この変更を実行するには、GET /groups/{group_uuid}/entities リクエストの結果を使用します。結果の例:
[
{
"uuid":"73422419372894",
"displayName":"PT_RHEL", "className":"VirtualMachine", "priceIndex":4.33, "state":"ACTIVE",
"severity":"Normal",
"costPrice":0.24104111, "discoveredBy":{
"uuid":"73422416392368",
"displayName":"producttrust", "category":"Public Cloud", "type":"AWS", "readonly":false
},
...
},
{
"uuid":"73422419372988",
"displayName":"PT_Resize_Up_Target", "className":"VirtualMachine", "priceIndex":10074.822, "state":"ACTIVE",
"severity":"Normal", "costPrice":0.078387, "discoveredBy":{
"uuid":"73422416392368",
"displayName":"producttrust", "category":"Public Cloud", "type":"AWS", "readonly":false
},
...
},
{
"uuid":"73422419372921",
"displayName":"PT_Consistent_Scaling_VM_1", "className":"VirtualMachine", "priceIndex":100.357,
"state":"ACTIVE",
"severity":"Normal", "costPrice":0.0159137, "discoveredBy":{
"uuid":"73422416392368",
"displayName":"producttrust", "category":"Public Cloud", "type":"AWS", "readonly":false
},
...
}
]
この結果を使用して、見つかった各 UUID を使用するか、エンティティに基づいてフィルタリングすることができます。たとえば、グループを反復処理して、すべての VM エンティティの UUID を取得するには、次のようにします。
foreach (var entity in groupApiResponse)
{
if (entity["className"] == VirtualMachine)
{
Console.Writeline(entity["uuid"])
}
}
目標
エンティティの静的グループを作成します。
静的グループには、エンティティの固定セットが含まれています。この例では VM のグループを作成しますが、任意のエンティティタイプのグループを作成できます。
スクリプトは、表示名によってメンバーエンティティの一意の ID を取得し、それらをリストに追加して、グループメンバーを表示するために使用します。
スクリプトは、ペイロード データを作成するときに、グループタイプとエンティティタイプも設定します。次に、API を使用してグループを作成し、指定したエンティティがグループに含まれていることを確認します。
前提条件
静的グループを作成するには、次の情報が必要です。
■ グループ内のメンバーの表示名
■ このグループに使用するエンティティタイプ
■ Workload Optimization Manager インスタンスの IP アドレスとログイン資格情報
関連するエンドポイント
このレシピでは、次のエンドポイントを使用します。
POST /groups リクエストを使用してグループを作成し、GET /groups/{group_uuid} リクエストを使用してグループ メンバーシップを確認します。
GET /search リクエストを使用して、表示名からグループ メンバーの UUID を取得します。
スクリプト設定
スクリプトを設定するには、環境から次の値を指定します。
■ ip
Workload Optimization Manager インスタンスの IP アドレス。
■ ユーザー名
Workload Optimization Manager がAPI へのアクセスに使用するアカウントのユーザー名。
■ パスワード
Workload Optimization Manager がAPI へのアクセスに使用するアカウントのパスワード。
■ names_list
グループに追加するエンティティの表示名のリスト。エンティティはすべて同じタイプである必要があることに注意してください。複数のタイプのエンティティが指定されている場合、グループの作成は失敗します。
■ group_name
グループの表示名。この名前がユーザーインターフェイスに表示されます。
■ entity_type
グループとそのメンバーエンティティのエンティティタイプ。スクリプトは、グループ入力データの作成時にこれを使用し、エンティティの UUID の検索を実行するときにも使用します。
注:
現時点では、Workload Optimization Manager は、複数のエンティティタイプを持つグループの作成をサポートしていません。
認証
スクリプトの最初のステップは、Workload Optimization Manager インスタンスへのアクセスを認証し、認証トークンを取得して、後続の呼び出しで使用できるように保存することです。認証のために、このスクリプトは、ip、username、および password に設定した値を使用します。詳細については、「認証レシピ」(287ページ)を参照してください。
API リクエスト:https://{ip}/vmturbo/rest/login
UUID の取得
ログイン後、スクリプトはエンティティ名のリストを繰り返し処理し、それぞれを GET /search リクエストに渡します。返された EntityApiDTO を使用して、一致する各エンティティの UUID を取得します。
検索応答はエンティティオブジェクトの配列であり、各エンティティ オブジェクトにはエンティティの UUID が含まれています。スクリプトは、names_list で指定した表示名をループ処理し、名前ごとに個別の検索要求を実行します。各応答は、1 つの項目の配列である必要があります。スクリプトは、そのアイテムの uuid を group_members_uuids リストに追加します。
注:
UUID を取得する別の方法は、フィルタリングされた POST /search リクエストを実行することです。このスクリプトは、シンプルさのために、繰り返し GET /search を使用するようになっています。
サンプルリクエスト:GET https://10.10.10.10/api/v3/search? q=zrlinuxclone106&types=VirtualMachine&entityTypes=VirtualMachine
サンプルの返り値:
[
{
"uuid":"74011863734144",
"displayName":"zrlinuxclone106", "className":"VirtualMachine", "state":"ACTIVE",
"severity":"Critical", "discoveredBy":{
"uuid":"73935378522272",
"displayName":"vsphere-dc23.eng.vmturbo.com", "category":"Hypervisor",
"type":"vCenter", "readonly":false
},
"severityBreakdown":{ "CRITICAL":1
},
"providers":[
{
"uuid":"73935378875792",
"displayName":"hp-esx108.eng.vmturbo.com", "className":"PhysicalMachine"
},
{
"uuid":"73935378875736",
"displayName":"QS2_GRID01:DC23DS1", "className":"Storage"
},
{
"uuid":"73995333587472",
"displayName":"Resources-hp-esx108.eng.vmturbo.com", "className":"VirtualDataCenter"
}
],
"environmentType":"ONPREM", "vendorIds":{
"vsphere-dc23.eng.vmturbo.com":"vm-2844"
}
}
]
入力 DTO の構築とグループの作成
スクリプトがグループメンバーの UUID のリストを作成したら、必要なグループを説明する GroupApiDTO を作成できます。DTO には、次のプロパティの値が必要です:
■ isStatic:静的グループを作成する場合は true
■ displayName:group_name 変数に設定したグループ名
■ memberUuidList:スクリプトが作成した UUID 文字列の配列
■ criteriaList:静的グループの場合、空の配列を渡します
■ groupType:このグループのエンティティタイプ -- entity_type 変数に設定した値
取得した UUID と上記の情報を使用して、スクリプトは入力 GroupApiDTO(396 ページ)を構築します。このスクリプトは Python ディクショナリを作成し、POST /groups リクエストの入力本体部として渡します。
入力 DTO の例:
{
"isStatic":"true", "displayName":"TestGrp2", "memberUuidList":[
"74011863734144",
"73997881750336"
],
"criteriaList":[
],
"groupType":"VirtualMachine"
}
サンプル リクエスト:POST https://{ip}/api/v3/groups/
この要求に対する応答は、作成されたグループの GroupApiDTO になります。
サンプル応答:
{
"uuid":"285123335341792",
"displayName":"TestGrp2"、"className":"グループ"、
"membersCount":2, "entitiesCount":2, "groupType":"VirtualMachine", "severity":"CRITICAL", "environmentType":"ONPREM", "isStatic":true, "logicalOperator":"AND", "memberUuidList":[
"74011863734144",
"73997881750336"
],
"temporary":false, "activeEntitiesCount":1, "cloudType":"UNKNOWN", "memberTypes":[
"VirtualMachine"
],
"entityTypes":[
"VirtualMachine"
],
"groupClassName":"GroupApiDTO"
}
検証
グループが正常に作成されたことを確認するために、スクリプトは返された UUID を使用して、/groups エンドポイント経由でグループ データを取得します。リクエストでグループを取得する場合、返される DTO は、グループを作成するリクエストからの応答と同じである必要があります。
指定された UUID のグループが存在しない場合、API はリクエスト ステータス 404 を返し、Group not foundというメッセージを返します。
<Passed_UUID>。これは、スクリプトがグループの作成に失敗したことを示しています。
サンプル応答:https://{ip}/api/v3/groups/{group_uuid}
提供された応答のサブセットのみを使用することを選択できます。たとえば、このスクリプトは、各グループ メンバーの displayName と UUID を出力します。
サンプルスクリプト応答:
グループメンバー:
表示名:boao.min-spare OID:73997881750336
表示名:zrlinuxclone106 OID:74011863734144
スクリプト例
import json import requests import urllib3 import re
import sys
sys.path.append('../login') # これによりログインを可視化します...
import login
#
# 引数の数が正しいことを確認してください。
#
if len(sys.argv) != 7:
print("Incorrect arguments list.") sys.exit()
#
# 引数を適切な名前の変数に取得し、認証も行います。
#
ip = sys.argv[1] groupName = sys.argv[4] entityType = sys.argv[5]
entsListByName = sys.argv[6].split(',')
token = login.get_cookie(ip, sys.argv[2], sys.argv[3]) authHeader = {'cookie':token}
#
# entsListByName のエンティティの UUID を取得します
#
memberIds = []
for name in entsListByName:
response = requests.get( f'https://{ip}/api/v3/search?q={name}&types={entityType}&entity_types={entityType}&query_type=EXACT', headers=authHeader, verify=False)
if response.status_code == 200:
response_json = json.loads(response.text) memberIds.append(response_json[0]['uuid'])
if response.status_code != 200:
print(f'Search Request Status for {name} is {response.status_code}.')
#
# ペイロードオブジェクトを組み立ててグループを作成します。
#
group_input_dto = {} group_input_dto['isStatic'] = 'true' group_input_dto['displayName'] = groupName group_input_dto['memberUuidList'] = memberIds
group_input_dto['criteriaList'] = [] group_input_dto['groupType'] = entityType
#
# グループ を作成します。
#
response = requests.post(f'https://{ip}/api/v3/groups', json=group_input_dto, headers=authHeader, verif y=False, stream=True)
if response.status_code != 200:
print(f'Create Group failed. StatusCode:{response.status_code}\n{response.text}') sys.exit()
groupResponse_json = json.loads(response.text) groupId = groupResponse_json['uuid']
#
# グループを検査します#
groupCheck_response = requests.get(f'https://{ip}/api/v3/groups/{groupId}', headers=authHeader, verify=F alse)
groupCheck_json = json.loads(groupCheck_response.text)
if groupCheck_json['uuid']:
verifiedId = groupCheck_json['uuid'] groupName = groupCheck_json['displayName']
print(f'Group \"{groupName}\" successfully created with a UUID of:{verifiedId}')
else:
print('Error in group creation, no UUID found.') sys.exit()
# グループメンバーのリストを取得します response = requests.get(
f'https://{ip}/api/v3/groups/{groupId}/entities', headers=authHeader, verify=False) if response.status_code != 200:
print(f'Could not get group members. Status is {response.status_code}.') sys.exit()
groupMembers_json = json.loads(response.text)
# グループ メンバーのリストを印刷します print('\nグループ メンバー:')
for item in groupMembers_json:
print('Display name:' + item['displayName']) print('OID:' + item['uuid'])
目標
エンティティの動的グループを作成すること。
動的グループには、フィルタ条件によって検出された一連のエンティティが含まれています。この場合、スクリプトは特定のホストに存在するすべての仮想マシンのグループを作成します。仮想マシンがホストに追加されたり、ホストから削除されたりすると、このグループのメンバーシップにそれらの変更が反映されます。
このスクリプトは、/search エンドポイントを使用して、表示名を使用してホストの一意の ID を取得し、検証対象となる予定の仮想マシンのリストを取得します。次に、スクリプトは条件リストを作成し、その値を残りのペイロードデータに挿入してから、グループを作成してメンバーシップが期待どおりであることを確認します。
前提条件
動的グループを作成するには、次の情報が必要です。
■ ホストの表示名
このグループに使用するエンティティタイプ
Workload Optimization Manager インスタンスの IP アドレスとログイン資格情報
関連するエンドポイント
このレシピは、次のエンドポイントからの情報を使用します。
注:
すべての可能な基準値は、グループエンドポイントのヒント(116 ページ)にあります。
スクリプト設定
スクリプトを設定するには、環境から次の値を指定します。
■ ip
Workload Optimization Manager インスタンスの IP アドレス。.
■ ユーザー名
Workload Optimization Manager がAPI へのアクセスに使用するアカウントのユーザー名。
■ パスワード
Workload Optimization Manager がAPI へのアクセスに使用するアカウントのパスワード。
■ host_name
仮想マシンがグループに追加されるホストの表示名。
■ group_name
グループの表示名。この名前がユーザーインターフェイスに表示されます。
■ entity_type
グループのメンバーエンティティのエンティティタイプ。スクリプトは、グループ入力データを作成する際、およびグループ メンバーシップを確認する際にこれを使用します。
注:
現時点では、Workload Optimization Manager は、複数のエンティティタイプを持つグループの作成をサポートしていません。
認証
スクリプトの最初のステップは、Workload Optimization Manager インスタンスへ認証し、認証トークンを取得して、後続の呼び出しで使用できるように保存することです。認証のために、このスクリプトは、ip、username、および password に設定した値を使用します。詳細については、「認証レシピ」(287ページ)を参照してください。
API リクエスト:https://{ip}/vmturbo/rest/login
予想される初期メンバーシップを取得します
ログインすると、ホストに存在する仮想マシンのリストが表示されます。これらがグループのメンバーになります。
スクリプトは /search エンドポイントを使用して、ホストの EntityApiDTO を取得します。consumers パラメータを使用すると、このホストからリソースを購入する各エンティティを確認できます。スクリプトは、エンティティ タイプに一致する className を持つコンシューマーをリストします。
サンプル リクエスト:GET https://{ip}/api/v3/search? q={host_name}&types=PhysicalMachine'&detail_type=entity'
フィルタ条件を作成します
動的グループを作成するには、フィルタ基準を渡して一致するエンティティを識別します。これらの基準を配列として渡します。このスクリプトでは、配列で 1 つの基準を渡します。
例:criteria_list:
[
{
"expType":"RXEQ", "expVal":"host_name", "filterType":"vmsByPMName", "caseSensitive":"false"
}
]
入力 DTO の構築とグループの作成
スクリプトは、criteria パラメータを受け取り、それを使用して GroupApiDTO(396 ページ)を構築します。次のパラメータを使用します。
■ isStatic
true の場合、作成されたグループは静的です。スクリプトは、このパラメータを false に設定します。
■ displayName
グループの表示名。この名前がユーザーインターフェイスに表示されます。スクリプトはこのパラメータを設定します:
■ memberUuidList
動的グループの場合は、空の配列を渡します。
■ criteriaList
グループメンバーシップを決定するために使用されるフィルタリング基準。スクリプトは、このパラメータを criteria_list 変数に等しくなるよう設定します。
変数を使用して追加できます。
■ groupType
グループ メンバーのエンティティタイプ。スクリプトは、このパラメータを group_entity_type 変数に等しくなるよう設定します。
API リクエスト:POST https://{ip}/api/v3/groups/
この要求に対する応答は、作成されたグループの GroupApiDTO になります。
サンプル応答:
{
"uuid":"285126581114848",
"displayName":"TestGrp2", "className":"Group", "membersCount":3, "entitiesCount":3, "groupType":"VirtualMachine", "severity":"CRITICAL", "environmentType":"ONPREM", "isStatic":false, "logicalOperator":"AND", "criteriaList":[
{
"expVal":"hp-esx119.eng.vmturbo.com",
"expType":"RXEQ", "filterType":"vmsByPMName", "caseSensitive":false, "entityType":null, "singleLine":false
}
],
"memberUuidList":[
"73943582577376",
"73943582577568",
"73943582577744"
],
"temporary":false, "activeEntitiesCount":2, "cloudType":"UNKNOWN", "memberTypes":[
"VirtualMachine"
],
"entityTypes":[
"VirtualMachine"
],
"groupClassName":"GroupApiDTO"
}
グループの確認
グループが正常に作成されたことを確認するために、スクリプトは返された UUID を使用して、/groups エンドポイント経由でグループ データを取得します。リクエストがグループを取得する場合、その時点以降に仮想マシンが追加または削除されていないと仮定すると、グループのメンバーシップは、スクリプトの Get Expected Initial Membership 部分でコンソールに出力されたものと一致する必要があります。
指定された UUID のグループが存在しない場合、API はリクエスト ステータス 404 を返し、Group not found というメッセージを返します。
<Passed_UUID>。これは、スクリプトがグループの作成に失敗したことを示しています。
API リクエスト:https://{ip}/api/v3/groups/{group_uuid}
提供された応答のサブセットのみを使用することを選択できます。たとえば、このスクリプトは、各グループ メンバーの displayName と UUIDを出力します。
サンプルスクリプトの応答:
グループメンバー:
表示名:DC26-P02-03
OID:73943582577376
表示名:DC26-P02-02
OID:73943582577568
表示名:DC26-P02-01
OID:73943582577744
スクリプト例
#
# コマンドライン引数:platformIP、username、pwd、group_name、entity_type、host_name
# 例:./entity_changes.py 10.10.123.456 MyUser MyPwd MyTestGroup VirtualMachine MyHost
#
import json import requests import urllib3 import re
import sys
sys.path.append('../login') # これによりログインを可視化します... import login
#
# 引数の数が正しいことを確認してください。
#
if len(sys.argv) != 7:
print("Incorrect arguments list.") sys.exit()
#
# 引数を適切な名前の変数に取得し、認証も行います。
#
ip = sys.argv[1] group_name = sys.argv[4] entity_type = sys.argv[5] host_name = sys.argv[6]
token = login.get_cookie(ip, sys.argv[2], sys.argv[3]) authHeader = {'cookie':token}
#
# 予想される初期メンバーシップを取得します #
response = requests.get(
f'https://{ip}/api/v3/search?q={host_name}&types=PhysicalMachine' f'&detail_type=entity',
headers=authHeader, verify=False) get_vms_response_json = json.loads(response.text)
print(f'CONSUMERS:{get_vms_response_json[0]["consumers"]}') print(f'The {entity_type} members of this dynamic group will be:') for entity in get_vms_response_json[0]['consumers']:
if entity['className'] == entity_type:
print(entity)
#
# フィルタ条件を作成します
#
criterion = {} criterion['expType'] = "RXEQ" criterion['expVal'] = host_name
criterion['filterType'] = "vmsByPMName" criterion['caseSensitive'] = "false"
#
# 入力 DTO を構築し、グループを作成します
#
group_input_dto = {} group_input_dto['isStatic'] = 'false' group_input_dto['displayName'] = group_name group_input_dto['memberUuidList'] = [] group_input_dto['criteriaList'] = [criterion] group_input_dto['groupType'] = entity_type
response = requests.post(
f'https://{ip}/api/v3/groups', headers=authHeader, json=group_input_dto, verify=False, stream=True) group_creation_response_json = json.loads(response.text)
group_uuid = group_creation_response_json['uuid']
#
# グループの確認
#
response = requests.get(
f'https://{ip}/api/v3/groups/{group_uuid}/entities', headers=authHeader, verify=False) group_members_response_json = json.loads(response.text)
# グループメンバーのリストを印刷します print('\nGROUP MEMBERS:')
for item in group_members_response_json:
print('Display name:' + item['displayName']) print('OID:' + item['uuid'])
内部リクエストは、Workload Optimization Manager によって内部的に使用されるリクエストで、顧客による使用を目的としたものではありません。これらのリクエストによって返される構造データは、予告なしに変更される場合があります。
次のリクエストは内部専用としてマークされています:
エンドポイント |
リクエスト |
/entities |
DELETE /entities/loggingEntities PUT /entities/{entity_Uuids}/loggingEntities GET /entities/{entity_Uuid}/aspects/{aspect_name}/actions POST /entities/{entity_Uuid}/aspects/{aspect_name}/actions GET /entities/{entity_Uuid}/aspects/{aspect_name}/stats POST /entities/{entity_Uuid}/aspects/{aspect_name}/stats POST /entities/{entity_Uuid}/tags DELETE /entities/{entity_Uuid}/tags DELETE /entities/{entity_Uuid}/tags/{tag_key} |
/groups |
GET /groups/{group_Uuid}/aspects/{aspect_name}/actions POST /groups/{group_Uuid}/aspects/{aspect_name}/actions GET /groups/{group_Uuid}/aspects/{aspect_name}/stats POST /groups/{group_Uuid}/aspects/{aspect_name}/stats POST /groups/{group_Uuid}/notifications/stats POST /groups/{group_Uuid}/tags DELETE /groups/{group_Uuid}/tags DELETE /groups/{group_Uuid}/tags/{tag_key} |
/markets |
PUT /markets/{market_Uuid}/policies/{policy_Uuid} |
/reports |
POST /reports/templates |
/scenarios |
PUT /scenarios/{scenario_Uuid} PUT /scenarios/{scenario_Uuid}/entities/{entity_Uuid} DELETE /scenarios/{scenario_Uuid}/entities/{entity_Uuid} |
エンドポイント |
リクエスト |
|
PUT /scenarios/{scenario_Uuid}/groups/{group_Uuid} PUT /scenarios/{scenario_Uuid}/policies DELETE /scenarios/{scenario_Uuid}/policies/{policy_Uuid} PUT /scenarios/{scenario_Uuid}/templates/{template_name} |
/widgetsets |
/widgetsets エンドポイント全体は内部のみです。 |
参考までに、Peak of Peaks プランの完全な入力 DTO については、以下を参照してください。
{
"uuid":"XXXXDemo", "displayName":"XXXXDemo", "owners":[
{
"uuid":"_4T_7kwY-Ed-WUKbEYSVIDw", "username":"administrator", "showSharedUserSC":false
}
],
"type":"PEAKOFPEAKS",
"scope":[
{
"uuid":"_PE0v-YEUEee_hYfzgV9uYg", "displayName":"All On-prem Hosts", "className":"All On-prem Hosts"
}
],
topologyChange
},
"loadChanges":{
"maxUtilizationList":[
{
"maxPercentage":70, "projectionDay":0, "target":{
"displayName":"All On-prem Hosts", "className":"Group",
"uuid":"_PE0v-YEUEee_hYfzgV9uYg"
}
}
]
},
"overlayStatsList":[
{
"uuid":"4223ae0c-c99b-f6ca-c1ef-3f367bdf5528", "displayName":"centos_imp_2", "className":"VirtualMachine", "environmentType":"ONPREM",
"stats":[
{
"displayName":"centos_imp_2", "date":"2019-02-01T00:00:00-05:00",
"statistics":[
{
"displayName":"centos_imp_2", "date":"2019-03-14T15:12:36-04:00",
"statistics":[
{
"name":"priceIndex", "values":{
"max":20000,
"min":20000,
"avg":20000,
"total":20000
},
"value":20000
},
{
"name":"CPUProvisioned", "capacity":{
"max":104000,
"min":104000,
"avg":104000,
"total":104000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"MHz", "values":{
"max":5200,
"min":5200,
"avg":5200,
"total":5200
},
"value":5200
},
{
"name":"Mem", "capacity":{
"max":16776692, "min":16776692, "avg":16776692,
"total":16776692
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"KB", "values":{
"max":3555836, "min":3554799.8,
"avg":3554799.8, "total":3554799.8
}, "value":3554799.8
},
{
"name":"MemProvisioned", "capacity":{
"max":167766912, "min":167766912, "avg":167766912, "total":167766912
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"KB", "values":{
"max":4194304, "min":4194304, "avg":4194304,
"total":4194304
},
"value":4194304
},
{
"name":"StorageAmount", "capacity":{
"max":3301375, "min":3301375, "avg":3301375,
"total":3301375
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"6f76b47e-e6f0a3fe",
"displayName":"QSGRID01:ESXDC1DS1",
"className":"Storage"
},
"units":"MB", "values":{
"max":725.32,
"min":725.32,
"avg":725.32,
"total":725.32
},
"value":725.32
},
{
"name":"NetThroughput", "capacity":{
"max":3072000, "min":3072000, "avg":3072000,
"total":3072000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"Kbit/sec", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"MemAllocation", "capacity":{
"max":52503552, "min":52503552, "avg":52503552,
"total":52503552
},
"filters":[
{
"type":"key", "value":"VirtualDataCenter::2332ba0f9dc14c07f11adb38e12df43c4bc8ca56"
},
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{ "uuid":"2332ba0f9dc14c07f11adb38e12df43c4bc8ca56", "displayName":"olga_do_not_touch_1", "className":"VirtualDataCenter"
},
"units":"KB", "values":{
"max":3555836, "min":3554799.8,
"avg":3554799.8, "total":3554799.8
}, "value":3554799.8
},
{
"name":"VCPU",
"capacity":{
"max":5200,
"min":5200,
"avg":5200,
"total":5200
},
"filters":[
{
"type":"relation",
"value":"sold"
}
],
"units":"MHz", "values":{
"max":5214,
"min":5201.9,
"avg":5201.9,
"total":5201.9
},
"value":5201.9
},
{
"name":"Ballooning", "capacity":{
"max":16776692, "min":16776692, "avg":16776692,
"total":16776692
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"KB", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"StorageAccess", "capacity":{
"max":5000,
"min":5000,
"avg":5000,
"total":5000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{ "uuid":"6f76b47e-e6f0a3fe",
"displayName":"QSGRID01:ESXDC1DS1",
"className":"Storage"
},
"units":"IOPS",
"values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"CPUAllocation", "capacity":{
"max":31096,
"min":31096,
"avg":31096,
"total":31096
},
"filters":[
{
"type":"key", "value":"VirtualDataCenter::2332ba0f9dc14c07f11adb38e12df43c4bc8ca56"
},
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"2332ba0f9dc14c07f11adb38e12df43c4bc8ca56", "displayName":"olga_do_not_touch_1", "className":"VirtualDataCenter"
},
"units":"MHz", "values":{
"max":5214,
"min":5201.9,
"avg":5201.9,
"total":5201.9
},
"value":5201.9
},
{
"name":"IOThroughput", "capacity":{
"max":11264000, "min":11264000, "avg":11264000,
"total":11264000
},
"reserved":{
"max":9011200, "min":9011200, "avg":9011200,
"total":9011200
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"Kbit/sec", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"StorageAccess", "capacity":{
"max":100,
"min":100,
"avg":100, "total":100
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"6f76b47e-e6f0a3fe",
"displayName":"QSGRID01:ESXDC1DS1",
"className":"Storage"
},
"units":"msec", "values":{
"max":0.5,
"min":0.5,
"avg":0.5,
"total":0.5
},
"value":0.5
},
{
"name":"VMem", "capacity":{
"max":4194304, "min":4194304, "avg":4194304,
"total":4194304
},
"filters":[
{
"type":"relation",
"value":"sold"
}
],
"units":"KB", "values":{
"max":3397384, "min":3233807, "avg":3233807,
"total":3233807
},
"value":3233807
},
{
"name":"CPU", "capacity":{
"max":10400,
"min":10400,
"avg":10400,
"total":10400
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238255f-86cc-4cb9-0f47-11ff689f0b22", "displayName":"hp-esx4.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"MHz", "values":{
"max":5214,
"min":5201.9,
"avg":5201.9,
"total":5201.9
},
"value":5201.9
},
{
"name":"VStorage", "capacity":{
"max":2646,
"min":1014,
"avg":2238,
"total":8952
},
"filters":[
{
"type":"key", "value":"VirtualMachine::08bb59f519b55c22415be8d623b5ccdf578b85cc"
},
{
"type":"relation",
"value":"sold"
}
],
"units":"MB", "values":{
"max":1016.14,
"min":142.4,
"avg":797.71,
"total":3190.82
},
"value":797.71
}
]
}
]
},
{
"uuid":"4223bb37-0090-f332-0140-cc3cce7b3735"、
"displayName":"centos_imp_3", "className":"VirtualMachine", "environmentType":"ONPREM", "stats":[
{
"displayName":"centos_imp_3", "date":"2019-02-01T00:00:00-05:00",
"statistics":[
{
"displayName":"centos_imp_3", "date":"2019-03-14T15:12:36-04:00",
"statistics":[
{
"name":"priceIndex", "values":{
"max":20000,
"min":20000,
"avg":20000,
"total":20000
},
"value":20000
},
{
"name":"CPUProvisioned", "capacity":{
"max":104000,
"min":104000,
"avg":104000,
"total":104000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"MHz", "values":{
"max":5200,
"min":5200,
"avg":5200,
"total":5200
},
"value":5200
},
{
"name":"Swapping", "capacity":{
"max":40000000, "min":40000000, "avg":40000000,
"total":40000000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"bit/sec", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"NumDisk", "capacity":{
"max":2147483650, "min":2147483650, "avg":2147483650,
"total":2147483650
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"values":{
"max":1,
"min":1,
"avg":1,
"total":1
},
"value":1
},
{
"name":"Mem", "capacity":{
"max":16776692, "min":16776692, "avg":16776692,
"total":16776692
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"KB", "values":{
"max":3069332, "min":3062497, "avg":3062497,
"total":3062497
},
"value":3062497
},
{
"name":"MemProvisioned", "capacity":{
"max":167766912, "min":167766912,
"avg":167766912, "total":167766912
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"KB", "values":{
"max":4194304, "min":4194304, "avg":4194304,
"total":4194304
},
"value":4194304
},
{
"name":"StorageAmount", "capacity":{
"max":3301375, "min":3301375, "avg":3301375,
"total":3301375
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"6f76b47e-e6f0a3fe",
"displayName":"QSGRID01:ESXDC1DS1",
"className":"Storage"
},
"units":"MB", "values":{
"max":719,
"min":719,
"avg":719, "total":719
},
"value":719
},
{
"name":"NetThroughput", "capacity":{
"max":3072000, "min":3072000, "avg":3072000,
"total":3072000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"Kbit/sec", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"MemAllocation", "capacity":{
"max":52503552, "min":52503552, "avg":52503552,
"total":52503552
},
"filters":[
{
"type":"key", "value":"VirtualDataCenter::2332ba0f9dc14c07f11adb38e12df43c4bc8ca56"
},
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"2332ba0f9dc14c07f11adb38e12df43c4bc8ca56", "displayName":"olga_do_not_touch_1", "className":"VirtualDataCenter"
},
"units":"KB", "values":{
"max":3069332, "min":3062497, "avg":3062497,
"total":3062497
},
"value":3062497
},
{
"name":"VCPU",
"capacity":{
"max":5200,
"min":5200,
"avg":5200,
"total":5200
},
"filters":[
{
"type":"relation",
"value":"sold"
}
],
"units":"MHz", "values":{
"max":5203,
"min":5194.67,
"avg":5194.67,
"total":5194.67
},
"value":5194.67
},
{
"name":"Ballooning", "capacity":{
"max":16776692, "min":16776692, "avg":16776692,
"total":16776692
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"KB", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"StorageAccess", "capacity":{
"max":5000,
"min":5000,
"avg":5000,
"total":5000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"6f76b47e-e6f0a3fe",
"displayName":"QSGRID01:ESXDC1DS1",
"className":"Storage"
},
"units":"IOPS", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"CPUAllocation", "capacity":{
"max":31096,
"min":31096,
"avg":31096,
"total":31096
},
"filters":[
{
"type":"key", "value":"VirtualDataCenter::2332ba0f9dc14c07f11adb38e12df43c4bc8ca56"
},
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"2332ba0f9dc14c07f11adb38e12df43c4bc8ca56", "displayName":"olga_do_not_touch_1", "className":"VirtualDataCenter"
},
"units":"MHz", "values":{
"max":5203,
"min":5194.67,
"avg":5194.67,
"total":5194.67
},
"value":5194.67
},
{
"name":"IOThroughput", "capacity":{
"max":11264000, "min":11264000, "avg":11264000,
"total":11264000
},
"reserved":{
"max":9011200, "min":9011200, "avg":9011200,
"total":9011200
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"Kbit/sec", "values":{
"max":0,
"min":0,
"avg":0,
"total":0
},
"value":0
},
{
"name":"StorageLatency", "capacity":{
"max":100,
"min":100,
"avg":100, "total":100
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"6f76b47e-e6f0a3fe",
"displayName":"QSGRID01:ESXDC1DS1",
"className":"Storage"
},
"units":"msec", "values":{
"max":0.33,
"min":0.33,
"avg":0.33,
"total":0.33
},
"value":0.33
},
{
"name":"Q2VCPU",
"capacity":{
"max":20000,
"min":20000,
"avg":20000,
"total":20000
},
"reserved":{
"max":10000,
"min":10000,
"avg":10000,
"total":10000
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"msec", "values":{
"max":11,
"min":11,
"avg":11, "total":11
},
"value":11
},
{
"name":"VMem", "capacity":{
"max":4194304, "min":4194304, "avg":4194304,
"total":4194304
},
"filters":[
{
"type":"relation",
"value":"sold"
}
],
"units":"KB", "values":{
"max":2894068, "min":2747267, "avg":2747267,
"total":2747267
},
"value":2747267
},
{
"name":"CPU", "capacity":{
"max":10400,
"min":10400,
"avg":10400,
"total":10400
},
"filters":[
{
"type":"relation",
"value":"bought"
}
],
"relatedEntity":{
"uuid":"Virtual_ESX_4238a511-8593-4469-2751-46611e09b6a8",
"displayName":"hp-esx1.dev.mycorp.com", "className":"PhysicalMachine"
},
"units":"MHz", "values":{
"max":5203,
"min":5194.67,
"avg":5194.67,
"total":5194.67
},
"value":5194.67
},
{
"name":"VStorage", "capacity":{
"max":2646,
"min":1014,
"avg":2238,
"total":8952
},
"filters":[
{
"タイプ":"キー"、"値":"VirtualMachine::199bb3ec4f8da89f01c126a6b3df4c1321c4b07d"
},
{
"type":"relation",
"value":"sold"
}
],
"units":"MB", "values":{
"max":1016.01,
"min":142.4,
"avg":797.61,
"total":3190.42
},
"value":797.61
}
]
}
]
}
]
},
"timebasedTopologyChanges":{
}
}
参照表の概要
付録のこのセクションには、エンドポイントごとに区切られた、一般的な API パラメータの参照表が含まれます。完全を期すために、フィルタテーブルには他の参照テーブルが含まれている場合があることに注意してください。
アクション参照表
アクションモード:
■ DISABLED:
アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。
■ RECOMMENDED:
指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。
■ MANUAL:
Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。
■ AUTOMATED:
アクションを自動的に実行するようWorkload Optimization Manager に指示したことを示します。
■ COLLECTION (未使用):
使用されなくなったレガシーアクションモード。
動作状態:
■ DISABLED:
ポリシーが無効になっているアクション。
■ RECOMMEND:
ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。
■ PENDING_ACCEPT:
アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。
■ ACCEPTED:
受け入れられたが、まだ進行していないアクション。
■ IN_PROGRESS:
実行中のアクション。
■ SUCCEEDED:
受け入れられ、正常に完了したアクション。
■ FAILED:
受け入れられたが、正常に完了しなかったアクション。
■ REJECTED:
アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。
■ CLEARED:
アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。
■ ACCOUNTING:
クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。
■ QUEUED:
1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にします。前のアクションが完了すると実行されます。
Action Type:
■ START:
エンティティを開始し、Workload Optimization Manager マーケットに追加します。
■ MOVE:
エンティティをあるプロバイダーから別のプロバイダーに移動します。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。
■ SUSPEND:
エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。マーケットの状況に基づいて、分析は中断されたエンティティの再開を推奨することがあります。これには、それらのエンティティが再びマーケット分析に含まれます。
■ ADD PROVIDER:
これは START アクションと同等ですが、ただしストレージエンティティ用です。
■ CHANGE:
データストア間で仮想マシンのストレージを移動します。
■ PROVISION:
環境にキャパシティを追加します。
■ RECONFIGURE::
分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨しています。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨することがあります。
■ DELETE:
SUSPEND アクションと同等ですが、ストレージエンティティ用です。
■ RESERVE_ON_PM:
予約機能を使用する場合、特定のホスト上の VM のリソースを予約するアクションです。
■ RESERVE_ON_DS:
予約機能を使用する場合、これは特定のデータストア上の VM のリソースを予約するアクションです。
■ RESIZE_FOR_EFFICIENCY:
vCPU や vMEM などのコモディティのキャパシティを減らすサイズ変更です。
■ RESIZE_FOR_PERFORMANCE:
vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。
アクションフィルタ基準:
基準 |
説明 |
actionModeList |
■ DISABLED: アクションを推奨せず、実行もしません。アクションを無効にすると、ユーザーインターフェイスにそのタイプのアクションが表示されなくなります。 ■ RECOMMENDED: |
基準 |
説明 |
|
指定したハイパーバイザ経由か、またはその他の手段でユーザーが実行できるようにアクションを推奨します。 ■ MANUAL: Workload Optimization Manager のユーザーインターフェイス/アクション API リクエストを通じて実行するアクションを推奨し、オプションを提供します。 ■ AUTOMATED: アクションを自動的に実行するようWorkload Optimization Manager に指示したことを示します。 ■ COLLECTION (未使用): 使用されなくなったレガシーアクションモード。 |
actionStateList |
■ DISABLED: ポリシーが無効になっているアクション。 ■ RECOMMEND: ポリシー設定により自動化できないアクション、またはハードウェアの購入など、システムの外部で実行する必要があるアクション。 ■ PENDING_ACCEPT: アクションモードが手動に設定されている場合、承認されていない、またはクリアされていない推奨アクション。 ■ ACCEPTED: 受け入れられたが、まだ進行していないアクション。 ■ IN_PROGRESS: 実行中のアクション。 ■ SUCCEEDED: 受け入れられ、正常に完了したアクション。 ■ FAILED: 受け入れられたが、正常に完了しなかったアクション。 ■ REJECTED: アクションモードが手動に設定されている場合に、ユーザーによって拒否されたアクション。 ■ CLEARED: アクションモードが手動に設定されている場合に、マーケットで推奨されなくなったアクション。 ■ ACCOUNTING: クラウドエンティティの場合、別のインスタンステンプレートを使用するためにサイズを変更するアクション。 ■ QUEUED: 1 つのターゲットに対して 10 を超えるアクションを実行する場合、Workload Optimization Manager は 11 番目以降のすべてのアクションを QUEUED 状態にします。前のアクションが完了すると実行されます。 |
actionTypeList |
■ START: エンティティを開始し、Workload Optimization Manager マーケットに追加します。 ■ MOVE: エンティティをあるプロバイダーから別のプロバイダーに移動します。ホスト間で VM を移動する、ディスク アレイ間でデータストアを移動する、といった操作です。 ■ SUSPEND: エンティティを一時停止して、環境からそのキャパシティを除外します。一時停止によってエンティティが環境から削除されることはありませんが、マーケットはそのエンティティを分析に含めません。 |
基準 |
説明 |
|
その分析におけるエンティティ。マーケットの状況に基づいて、分析は中断されたエンティティの再開を推奨することがあります。これには、それらのエンティティが再びマーケット分析に含まれます。 ■ ADD PROVIDER: これは START アクションと同等ですが、ただしストレージエンティティ用です。 ■ CHANGE: データストア間で仮想マシンのストレージを移動します。 ■ PROVISION: 環境にキャパシティを追加します。 ■ RECONFIGURE:: 分析では、VM が別のタイプのアクションによって構成ミスを修正できない場合にこれを推奨しています。たとえば、分析では、配置ポリシーで VM を特定のクラスタ上のホストに移動する必要があるものの、クラスタ間の移動が許可されていない場合に、RECONFIGURE アクションを推奨することがあります。 ■ DELETE: SUSPEND アクションと同等ですが、ストレージエンティティ用です。 ■ RESERVE_ON_PM: 予約機能を使用する場合、特定のホスト上の VM のリソースを予約するアクションです。 ■ RESERVE_ON_DS: 予約機能を使用する場合、これは特定のデータストア上の VM のリソースを予約するアクションです。 ■ RESIZE_FOR_EFFICIENCY: vCPU や vMEM などのコモディティのキャパシティを減らすサイズ変更です。 ■ RESIZE_FOR_PERFORMANCE: vCPU や vMEM などのコモディティのキャパシティを増やすサイズ変更です。 |
クリア |
デフォルト:false。 true の場合、実行される前にアクション リストから削除されたアクションが返されます。 |
costType |
■ 保存中 クラウドへの支出を減らすアクション。 ■ 投資 クラウドへの支出を増やすアクション。 |
cumulative |
デフォルト:false。 true の場合、個々のアクションの節約を表示するのではなく、範囲内の各アクションの節約を累積合計として表示します。 |
environmentType |
■ ONPREM: オンプレミス環境の一部であるエンティティに関連するアクションのみを返します。 ■ CLOUD: クラウド環境の一部であるエンティティに関連するアクションのみを返します。 |
groupBy |
次の条件によって返されるアクションをグループ化できます:[actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory] |
hasReservedInstanc |
デフォルト:false。 true の場合、予約済みインスタンスに関連するアクションのみが返されます。 |
基準 |
説明 |
relatedEntityTypes |
範囲内のこれらのタイプのエンティティに関連するアクションのみを返します。たとえば、範囲が仮想データセンターであり、関連するエンティティタイプとして VirtualMachine を指定した場合、要求には、指定された仮想データセンター内の VM に関連するアクションのみが含まれます。 次のエンティティタイプから選択します:[ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ] |
riskSeverityList |
指定された重大度のアクションのみを返します:[ Unknown, Normal, Minor, Major, Critical ] |
riskSubCategoryList |
指定されたサブカテゴリのアクションのみを返します:[ Performance Assurance, Efficiency Improvement, Prevention, Compliance ] |
エンティティ参照テーブル
エンティティの状態:
■ ACTIVE:
エンティティはリソースを積極的に消費しています。
■ EVACUATED:
エンティティは一時停止の準備ができています。マーケットに参加しませんが、SUSPEND アクションを生成しません。
注:この状態は SUSPEND 状態を置き換えるものですが、有効にするには追加の構成が必要です。Workload Optimization Manager は、この状態を有効にすることを推奨していません。
■ FAILOVER:
このエンティティはフェールオーバー用に予約されており、マーケットに参加しません。
■ IDLE:
エンティティはパワーオフになっており、マーケットのリソースを積極的に消費していません。
■ LAUNCH:
エンティティを開始しています。
■ MAINTENANCE:
エンティティはメンテナンスモードです。
■ NOT_MONITORED:
エンティティは現在、Workload Optimization Manager によって監視されていません。
■ QUEUED:
エンティティは、ある状態から別の状態に変化する過程にあります。
注:この状態は Workload Optimization Manager の内部的なもので、UI には表示されませんが、エンティティの状態が変化しているちょうどその瞬間に呼び出しが実行された場合、API 応答に表示される場合があります。
■ RESOURCE_ALLOCATION:
クラウドエンティティを作成しています。
■ RESOURCE_RELEASE:
クラウドエンティティを削除しています。
■ SUSPEND:
エンティティが中断されているか、ゲスト OS がスリープ、スタンバイ、または中断状態です。エンティティは環境から削除されませんが、マーケットの決定には使用されません。マーケットの状況に基づいて、中断されたエンティティを開始し、マーケットに再追加することができます。
■ SUSPEND_PENDING:
エンティティは一時停止の準備を行っているか、またはそのタイプで次に一時停止するエンティティです。
■ TERMINATE_PENDING:
エンティティは削除中です。
■ UNKNOWN:
Workload Optimization Manager は、エンティティの現在の状態を取得できません。
これは、エンティティの状態が DISCONNECTED、ORPHANED、または INVALID だからです。
エンティティタイプ:
■ BUSINESS_UNIT
■ CLOUD_SERVICE
■ コンテナ
■ データベース
■ DATABASE_SERVER
■ DATACENTER
■ DISK_ARRAY
■ PHYSICAL_MACHINE
■ ストレージ
■ VIRTUAL_MACHINE
■ スイッチ
■ VIRTUAL_DATACENTER
■ シャーシ
■ STORAGE_CONTROLLER
■ IO_MODULE; IO モジュール
■ APPLICATION_SERVER
■ VIRTUAL_APPLICATION
■ ネットワーク
■ アプリケーション
■ コンテナ
■ CONTAINER_POD
■ LOGICAL_POOL
■ DPOD
■ VPOD
■ LOAD_BALANCER
データ転送オブジェクト(DTO)は、データをカプセル化して Workload Optimization Manager API に送信するために使用されます。以下の DTO が Workload Optimization Manager によって使用されます。
注:
DTO インデックスは進行中の作業であり、参照用にドラフト段階に含まれています。インデックスに含まれる情報は正確ですが、完全ではない場合があります。
説明
アクションを説明するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
actionImpactID
■ タイプ:整数
■ フォーマット:int64
■ 説明:再起動後も持続するアクションの ID
marketID
■ 型:整数
■ フォーマット:int64
■ 説明:アクションが生成されたマーケットの ID
createTime
■ type: string
■ 説明:作成時間
UpdateTime
■ type: string
■ 説明:更新時刻
clearTime
■ type: string
■ 説明:実行時間
actionType
■ type: string
■ 説明:型
■ 列挙型:['START', 'MOVE', 'SCALE', 'ALLOCATE', 'SUSPEND', 'PROVISION', 'RECONFIGURE', 'RESIZE', 'DELETE', 'RIGHT_SIZE', 'BUY_RI']
actionState
■ type: string
■ 説明:動作状態
■ 列挙型:['PENDING_ACCEPT', 'ACCEPTED', 'REJECTED', 'PRE_IN_PROGRESS', 'POST_IN_PROGRESS', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'RECOMMENDED', 'DISABLED', 'QUEUED', 'CLEARED', 'ACCOUNTING', 'READY', 'FAILING']
actionMode
■ type: string
■ 説明:アクションモード
■ 列挙型:['DISABLED'、'RECOMMEND'、'EXTERNAL_APPROVAL'、'MANUAL'、'AUTOMATIC'、'COLLECTION']
userName
■ type: string
■ 説明:アクションを受け入れたユーザーのユーザー名
details
■ type: string
■ 説明:アクションを説明するユーザーが読める文字列
importance
■ タイプ:数値
■ フォーマット:float
■ 説明:アクションの優先度を説明する数値
ターゲット
■ 説明:アクションのターゲットエンティティタイプ。たとえば、サイズ変更アクションの VM、または VM 移動のホスト
■ ServiceEntityApiDTO(462ページ)
■ 説明:VM 移動アクションのために VM が存在する現在のホストなどの現在のエンティティ
■ ServiceEntityApiDTO(462ページ)
■ 説明:VM 移動アクションのための VM のホストなどの移動先エンティティ
■ ServiceEntityApiDTO(462ページ)
■ type: string
■ 説明:プロパティの現在の値(VM サイズ変更アクションの vMEM など)
newValue
■ type: string
■ 説明:VM サイズ変更アクションの vMEM など、サイズ変更する計算値
valueUnits
■ type: string
■ 説明:VM vMEM サイズ変更アクションの KB など、currentValue および newValue の単位
resizeAttribute
■ type: string
■ 説明:サイズを変更のコモディティ属性
■ 列挙型:['CAPACITY', 'LIMIT', 'RESERVATION']
前提条件
■ type: array
■ 説明:実行が可能になる前に発生しなければならない前提条件の説明。このフィールドに値が入力されている場合、アクションは実行可能ですが、この前提条件によってブロックされており、それに応じて表示されます。このフィールドに値が入力されていない場合、アクションモード変更の前提条件はなく、アクションは通常どおり表示されます。
■ – タイプ:文字列
prioritizedAutomationOpportunities
■ type: array
■ 説明:アクションは「自動化の優先度」設定を使用して生成され、これらの機会が満たされればより多くの節約が可能であることを示します
■ – 型:文字列
stats
■ type: array
■ 説明:Mem、vCPU、costPrice などの統計
■ – StatApiDTO(472ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:アクションの詳細レベルが「EXECUTION」の場合に使用可能な「executionStatus」内の「progress」パーセンテージ値を移動しました - [非推奨 - 使用:executionStatus.progress]
currentLocation
■ 説明:クラウド移行アクションのための、現在のサービスエンティティが配置されているリージョン(DataCenter)
■ DiscoveredEntityApiDTO(388ページ)
■ 説明:ターゲットのサービスエンティティが、クラウド移行アクションで置かれることになるリージョン(DataCenter)
virtualDisks
■ type: array
■ 説明:アクションに使用される仮想ディスク(ストレージの移動など)
■ – VirtualDiskApiDTO(501ページ)
■ 説明:アクションに関連するポリシー
■ PolicyApiDTO (425ページ)
■ type: array
■ 説明:アクションに関連付けられた関連設定ポリシー
■ – BaseApiDTO(353ページ)
■ 説明:アクションに関連するスケジュール
■ ActionScheduleApiDTO(347ページ)
■ type: array
■ 説明:複合移動アクションのプロパティ
■ – ActionApiDTO(336ページ)
■ 説明:アクションに関連付けられた予約済みインスタンス
■ ReservedInstanceApiDTO(445ページ)
■ type: string
■ 説明:アクションにスーパーセービングがある場合の推奨 RI のプラットフォーム
externalActionName
■ type: string
■ 説明:このアクションがサードパーティ ソフトウェアまたは外部承認バックエンドで表示される名前
externalActionUrl
■ type: string
■ 説明:このアクションを示すサードパーティ ソフトウェアの URL。外部アクション承認に適しています
executionStatus
■ 説明:アクションの実行ステータスの詳細。進行状況のパーセンテージ、エラー メッセージ、実行時間を含めます。
■ ActionExecutionAuditApiDTO(343ページ)
■ 説明:アクションの実行の特徴。中断性と可逆性を含めます。
■ ActionExecutionCharacteristicApiDTO(344ページ)
■ type: object
■ 説明:[ベータ版]:このアクションに何らかの関係がある関係タイプごとの関連アクション数のマップ
■ additionalProperties:{'type':'integer', 'format':'int32'}
actionID
■ 型:整数
■ フォーマット:int64
■ 説明:アクションの ID
説明
アクションのフィルタを記述するモデル
必須パラメータ
startTime
■ type: string
■ 説明: アクションの作成時間に基づく、フィルタリングする期間の開始時間
オプションパラメータ
"actionRelationTypeFilter": [ "NONE"
■ type: array
■ 説明:他のアクションとの関係のタイプに基づいて、アクションのメイン リストをフィルタリングします。
■ – 型:文字列
– 列挙型:['NONE', 'BLOCKED_BY', 'BLOCKING', 'CAUSED_BY', 'CAUSING']
environmentType
■ type: string
■ 説明:環境タイプでアクションをフィルタリングします
■ 列挙型:['ONPREM', 'CLOUD']
costType
■ type: string
■ 説明:アクションをコストタイプでフィルタリングします
■ 列挙型:['SAVING', 'INVESTMENT']
descriptionQuery
■ 説明:このクエリは、ActionApiDTO の詳細フィールドと照合を行い、指定された式に一致するアクションを返します。
■ QueryInputApiDTO(433ページ)
■ 説明:このクエリは、ActionApiDTO のリスク説明フィールドと照合を行い、指定された式に一致するアクションを返します。
■ QueryInputApiDTO(433ページ)
■ 説明:中断性と可逆性を含む、アクションの実行の特徴。
■ ActionExecutionCharacteristicInputApiDTO(344ページ)
■ 説明:このフィールドは、ActionApiDTO の costPrice 統計フィールドと照合を行い、minValue と maxValue の(それらを含む)間の costPrice 金額を持つアクションを返します
■ RangeInputApiDTO(435ページ)
■ type: boolean
■ 説明:true の場合、関連付けられた実行スケジュールを持つアクションのみが返されます。
hasPrerequisites
■ type: boolean
■ 説明:true の場合、アクションの実行を妨げる前提条件を持つアクションのみが返されます。
endTime
■ type: string
■ 説明:アクションの作成時間に基づく、フィルタリングする期間の終了時間
クリア
■ type: boolean
■ 説明:実行されたアクションによるフィルタ
cumulative
■ type: boolean
■ 説明:アクションの節約を累積値として表示します
hasReservedInstanc
■ type: boolean
■ 説明:関連する予約済みインスタンスがあるかどうかによってアクションをフィルタリングします
excludeNotifications
■ type: boolean
■ 説明:結果から通知を除外します
limitEntities
■ 型:整数
■ フォーマット:int32
■ 説明:結果のエンティティ数を制限します
detailLevel
■ type: string
■ 説明:アクションの詳細レベル、「standard」がデフォルト値です
■ 列挙型:['STANDARD', 'EXECUTION']
relatedEntityTypes
■ type: array
■ 例:VCD を選択し、'"related_entities":["VirtualMachine"] を指定すると、指定された VDC 内の任意の VM のアクションが含まれます。
■ 説明:このエンティティのサプライチェーンから含める関連エンティティタイプ
■ – 型:文字列
relatedCloudServiceProviderIds
■ type: array
■ 説明:関連するクラウドサービスプロバイダーでアクションをフィルタリングします。
■ – 型:文字列
groupBy
■ type: array
■ 説明:統計のグループ化に使用されるフィールド
■ – 型:文字列
actionTypeList
■ type: array
■ – 型:文字列
– 列挙型:['NONE', 'START', 'MOVE', 'SCALE', 'ALLOCATE', 'SUSPEND', 'TERMINATE', 'SPAWN', 'ADD_PROVIDER', 'CHANGE', 'REMOVE_PROVIDER', 'PROVISION', 'RECONFIGURE', 'RESIZE', 'RESIZE_CAPACITY', 'WARN', 'RECONFIGURE_THRESHOLD', 'DELETE', 'RIGHT_SIZE', 'RESERVE_ON_PM', 'RESERVE_ON_DS', 'RESIZE_FOR_EFFICIENCY', 'RESIZE_FOR_PERFORMANCE', 'CROSS_TARGET_MOVE', 'MOVE_TOGETHER', 'ACTIVATE', 'DEACTIVATE', 'BUY_RI']
actionStateList
■ type: array
■ – 型:文字列
– 列挙型:['PENDING_ACCEPT', 'ACCEPTED', 'REJECTED', 'PRE_IN_PROGRESS', 'POST_IN_PROGRESS', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'RECOMMENDED', 'DISABLED', 'QUEUED', 'CLEARED', 'ACCOUNTING', 'READY', 'FAILING']
actionModeList
■ type: array
■ – 型:文字列
– 列挙型:['DISABLED', 'RECOMMEND', 'EXTERNAL_APPROVAL', 'MANUAL', 'AUTOMATIC', 'COLLECTION']
riskSeverityList
■ type: array
■ – 型:文字列
riskSubCategoryList
■ type: array
■ – 型:文字列
説明
アクションの親クラスの詳細。実装クラスには、CloudResizeActionDetailsApiDTO, NoDetailsApiDTO、RIBuyActionDetailsApiDTO、CloudProvisionActionDetailsApiDTO、CloudSuspendActionDetailsApiDTO、OnPremResizeActionDetailsApiDTO および ReconfigureActionDetailsApiDTO が含まれます。
必須パラメータ
actionDetailType
■ type: string
actionType
■ type: string
説明
アクションの実行を記述するモデル。
必須パラメータ
acceptTime
■ type: string
■ 説明:アクションが受け入れられた時刻(ISO8601 形式 - YYYY-MM-DDTHH:MM:SS)
actionIds
■ type: array
■ 説明:アクション ID のリスト
■ – 型:文字列
■ 最大項目数:2147483647
■ minItems:1
id
■ type: string
■ 説明:アクション実行 ID
スキップされたアクション
■ type: array
■ 説明:実行中にスキップされたアクションのリスト
■ – SkippedActionApiDTO(472 ページ)
説明
アクションの実行ステータスを表すモデル。
必須パラメータ
executionTime
■ type: string
■ 説明:実行時間の開始
state
■ type: string
■ 説明:実行時間の開始
■ 列挙型:['PENDING_ACCEPT', 'ACCEPTED', 'REJECTED', 'PRE_IN_PROGRESS', 'POST_IN_PROGRESS', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'RECOMMENDED', 'DISABLED', 'QUEUED', 'CLEARED', 'ACCOUNTING', 'READY', 'FAILING']
オプションパラメータ
completionTime
■ type: string
■ 説明:実行時間の終了
message
■ type: string
■ 説明:ステータス メッセージ。アクションが失敗した場合、エラーの詳細が含まれます
progress
■ 型:整数
■ フォーマット:int32
■ 説明:0 から 100 までのアクション実行進捗値
説明
アクション実行特性を記述するモデル
オプションパラメータ
中断性
■ type: string
■ 説明:アクションが破壊的かどうか。
■ 列挙型:['DISRUPTIVE', 'NON_DISRUPTIVE']
可逆性
■ type: string
■ 説明:アクションが破壊的かどうか。
■ 列挙型:['REVERSIBLE', 'IRREVERSIBLE']
説明
アクション実行特性を記述するモデル
オプションパラメータ
中断性
■ type: string
■ 説明:アクションが破壊的かどうか。
■ 列挙型:['DISRUPTIVE', 'NON_DISRUPTIVE']
可逆性
■ type: string
■ 説明:アクションが破壊的かどうか。
■ 列挙型:['REVERSIBLE', 'IRREVERSIBLE']
説明
アクション実行入力を記述するモデル。
必須パラメータ
actionIds
■ type: array
■ 説明:アクション ID のリスト
■ – 型:文字列
■ maxItems:2147483647
■ minItems:1
説明
アクションリソースインパクト統計の入力を記述するモデル
必須パラメータ
actionResourceImpactStatList
■ type: array
■ 説明:アクションリソースインパクト統計入力のリスト
■ – ActionResourceImpactStatInput(346ページ)
オプションパラメータ
actionRelationTypeFilter
■ type: array
■ 説明:他のアクションとの関係のタイプに基づいて、アクションのメインリストをフィルタリングします。
■ – 型:文字列
– 列挙型:['NONE', 'BLOCKED_BY', 'BLOCKING', 'CAUSED_BY', 'CAUSING']
environmentType
■ type: string
■ 説明:環境タイプでアクションをフィルタリングします
■ 列挙型:['ONPREM', 'CLOUD']
costType
■ type: string
■ 説明:アクションをコストタイプでフィルタリングします
■ 列挙型:['SAVING', 'INVESTMENT']
descriptionQuery
■ 説明:このクエリは、ActionApiDTO の詳細フィールドと照合を行い、指定された式に一致するアクションを返します。
■ QueryInputApiDTO(433ページ)
■ 説明:このクエリは、ActionApiDTO のリスク説明フィールドと照合を行い、指定された式に一致するアクションを返します。
■ QueryInputApiDTO(433ページ)
■ 説明:中断性と可逆性を含む、アクションの実行の特徴。
■ ActionExecutionCharacteristicInputApiDTO(344ページ)
■ 説明:このフィールドは、ActionApiDTO の costPrice 統計フィールドと照合を行い、minValue と maxValue の(それらを含む)間の costPrice 金額を持つアクションを返します
■ RangeInputApiDTO(435ページ)
■ type: boolean
■ 説明:true の場合、関連付けられた実行スケジュールを持つアクションのみが返されます。
hasPrerequisites
■ type: boolean
■ 説明:true の場合、アクションの実行を妨げる前提条件を持つアクションのみが返されます。
actionStateList
■ type: array
■ – 型:文字列
– 列挙型:['PENDING_ACCEPT', 'ACCEPTED', 'REJECTED', 'PRE_IN_PROGRESS', 'POST_IN_PROGRESS', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'RECOMMENDED', 'DISABLED', 'QUEUED', 'CLEARED', 'ACCOUNTING', 'READY', 'FAILING']
actionModeList
■ type: array
■ – 型:文字列
– 列挙型:['DISABLED'、'RECOMMEND'、'EXTERNAL_APPROVAL'、'MANUAL'、'AUTOMATIC'、'COLLECTION']
riskSeverityList
■ type: array
■ – 型:文字列
riskSubCategoryList
■ type: array
■ – 型:文字列
説明
Action Resource Impact Stat Input を記述するモデル
必須パラメータ
actionType
■ type: string
■ 説明:アクションタイプ
■ 列挙型:['NONE', 'START', 'MOVE', 'SCALE', 'ALLOCATE', 'SUSPEND', 'TERMINATE', 'SPAWN', 'ADD_PROVIDER', 'CHANGE', 'REMOVE_PROVIDER', 'PROVISION', 'RECONFIGURE', 'RESIZE', 'RESIZE_CAPACITY', 'WARN', 'RECONFIGURE_THRESHOLD', 'DELETE', 'RIGHT_SIZE', 'RESERVE_ON_PM', 'RESERVE_ON_DS', 'RESIZE_FOR_EFFICIENCY', 'RESIZE_FOR_PERFORMANCE', 'CROSS_TARGET_MOVE', 'MOVE_TOGETHER', 'ACTIVATE', 'DEACTIVATE', 'BUY_RI']
commodityType
■ type: string
■ 例:VCPU
■ 説明:アクションの影響を受ける可能性のあるコモディティタイプ。たとえば、VM のサイズ変更アクションの場合は VCPU または VMEM です。
■ 列挙型:['ACTION_PERMIT'、'ACTIVE_SESSIONS'、'APPLICATION'、'BALLOONING'、'BUFFER_COMMODITY'、'CLUSTER'、'COLLECTION_TIME'、'COOLING'、'CONNECTION'、'COUPON'、'CPU'、'CPU_ALLOCATION'、'CPU_PROVISIONED'、'CPU_REQUEST_ALLOCATION'、'CROSS_CLOUD_MOVE_SVC'、'CROSS_CLUSTER_MOVE_SVC'、'DATACENTER'、'DATASTORE'、'DB_CACHE_HIT_RATE'、'DB_MEM'、'DISK_ARRAY_ACCESS'、'DRS_SEGMENTATION'、'DSPM_ACCESS'、'EXTENT'、'FLOW'、'FLOW_ALLOCATION'、'HEAP'、'HOST_LUN_ACCESS'、'IMAGE_CPU'、'IMAGE_MEM'、'IMAGE_STORAGE'、'INSTANCE_DISK_SIZE'、'INSTANCE_DISK_TYPE'、'IO_THROUGHPUT'、'LICENSE_ACCESS'、'MEM'、'MEM_ALLOCATION'、'MEM_REQUEST_ALLOCATION'、'MEM_PROVISIONED'、'NET_THROUGHPUT'、'NETWORK'、'NUM_DISK'、'NUMBER_CONSUMERS'、'NUM_VCORE'、'POOL_CPU'、'POOL_MEM'、'POOL_STORAGE'、'PORT_CHANNEL'、'POWER'、'Q16_VCPU'、'Q1_VCPU'、'Q2_VCPU'、'Q32_VCPU'、'Q4_VCPU'、'Q64_VCPU'、'Q8_VCPU'、'RESPONSE_TIME'、'SAME_CLUSTER_MOVE_SVC'、'SEGMENTATION'、'SLA_COMMODITY'、'SOFTWARE_LICENSE_COMMODITY'、'SPACE'、'STORAGE_ACCESS'、'STORAGE_ALLOCATION'、'STORAGE_AMOUNT'、'STORAGE_CLUSTER'、'STORAGE_LATENCY'、'STORAGE_PROVISIONED'、'SWAPPING'、'THREADS'、'TRANSACTION'、'TRANSACTION_LOG'、'VCPU'、'VCPU_LIMIT_QUOTA'、'VCPU_REQUEST'、'VCPU_REQUEST_QUOTA'、'VDC'、'VMEM'、'VMEM_LIMIT_QUOTA'、'VMEM_REQUEST'、'VMEM_REQUEST_QUOTA'、'VMPM_ACCESS'、'VSTORAGE'、'ZONE'、'LICENSE_COMMODITY',
'Q3_VCPU'、'NUMBER_CONSUMERS_PM'、'Q6_VCPU'、'Q7_VCPU'、'QN_VCPU'、'RIGHT_SIZE_SVC'、'RIGHT_SIZE_DOWN'、'MOVE'、'Q5_VCPU'、'STORAGE'、'NUMBER_CONSUMERS_STORAGE'、'ACCESS'、'RIGHT_SIZE_UP'、'VAPP_ACCESS'、'HOT_STORAGE'、'HA_COMMODITY'、'NETWORK_POLICY'、'SERVICE_LEVEL_CLUSTER'、'PROCESSING_UNITS'、'TENANCY_ACCESS'、'TEMPLATE_ACCESS'、'BURST_BALANCE'、'DESIRED_COUPON'、'NETWORK_INTERFACE_COUNT'、'BICLIQUE'、'TAINT'、'LABEL'、'UNKNOWN']
targetEntityType
■ type: string
■ 説明:アクションのターゲットエンティティタイプ。たとえば、仮想マシンのサイズ変更アクションの VirtualMachine
■ 列挙型:['ApplicationComponent', 'VirtualMachine', 'Storage', 'DiskArray', 'Database', 'DatabaseServer', 'Container', 'LogicalPool']
説明
アクションスケジュールを記述するモデル。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
nextOccurrence
■ type: string
■ 説明:ISO8601 の現地時間(YYYY-MM-DDTHH:MM:SS)で表される次の発生時刻。たとえば、2019-04-04T19:15 です。
nextOccurrenceTimestamp
■ 型:整数
■ フォーマット:int64
■ 説明:ミリ秒単位のタイムスタンプで表される、このスケジュールが次に発生する時刻。たとえば、1562100619000
timeZoneId
■ type: string
■ 説明:スケジュールのタイムゾーン
mode
■ type: string
■ 説明:スケジュールの影響を受けるアクションモード
■ 列挙型:['DISABLED'、'RECOMMEND'、'EXTERNAL_APPROVAL'、'MANUAL'、'AUTOMATIC'、'COLLECTION']
acceptedByUserForMaintenanceWindow
■ type: boolean
■ 説明:アクションの承認または拒否を示すブール値。
userName
■ type: string
■ 説明:メンテナンスウィンドウのアクションを受け入れたユーザー。
remaingTimeActiveInMs
■ 型:整数
■ フォーマット:int64
■ 説明: 呼び出し時にスケジュールがアクティブになる時間(ミリ秒)。スケジュールが現在アクティブでない場合、このフィールドは入力されません。
説明
複数の範囲でのアクションの要求を記述するモデル
必須パラメータ
actionInput
■ 説明:要求されたアクションのリスト
オプションパラメータ
スコープ
■ type: array
■ 説明:範囲として使用する uuid のリスト
■ – 型:文字列
relatedType
■ type: string
■ 説明:範囲に関連するエンティティタイプのアクションを取得します
説明
複数の範囲でのアクションリソースインパクトの要求を記述するモデル
必須パラメータ
actionResourceImpactStatApiInput
■ 説明:要求されたアクション リソースの影響統計
■ ActionResourceImpactStatApiInputDTO(345ページ)
■ type: array
■ 説明:範囲として使用する uuid のリスト
■ – 型:文字列
説明
Active Directory を表すモデル。これには、Workload Optimization Manager サーバーに対してグローバルなドメイン名とサーバー名が含まれています。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
domainName
■ type: string
■ 説明:現在のアクティブ ディレクトリのドメイン名
loginProviderURI
■ type: string
■ 説明:現在の Active Directory のサーバー名
isSecure
■ type: boolean
■ 説明:現在の Active Directory のサーバー名
グループ
■ type: array
■ 説明:現在の Active Directory 用に Ops Mgr で定義された Active Directory グループ
■ – ActiveDirectoryGroupApiDTO(350ページ)
説明
Active Dierctory グループを表すモデル。Active Directory グループは、ユーザー認証の管理に使用されます。グループのロールと範囲を指定でき、AD グループのすべてのメンバーがそれらの権限で Workload Optimization Manager にログインできます。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
type
■ type: string
■ 説明:現在の Active Directory グループのユーザータイプ
roleName
■ type: string
■ 説明:現在の Active Directory グループのユーザーロール名
scope
■ type: array
■ 説明:現在の Active Directory グループの範囲
説明
シナリオの追加変更を記述するモデル
オプションパラメータ
projectionDays
■ type: array
■ 説明:予測日のリストで、いつ変更を適用するかを示します
■ – タイプ:整数
– フォーマット:int32
ターゲット
■ 説明:変更の対象、エンティティまたはグループ
■ BaseApiDTO(353ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:追加変更を適用する回数
targetEntityType
■ type: string
■ 説明:グループ ターゲットから追加するエンティティのタイプ
説明
Inherits From
この DTO は FieldApiDTO(394 ページ)から継承します
必須パラメータ
aggregation
■ type: string
■ 説明:集計のタイプ。
■ readOnly:True
■ 列挙型:['TOTAL', 'AVERAGE']
commodityAttribute
■ type: string
■ 説明:コモディティ属性。
■ readOnly:True
■ 列挙型:['USED'、'CAPACITY'、'PEAK'、'CURRENT_UTILIZATION'、'WEIGHTED_HISTORICAL_UTILIZATION'、'PERCENTILE_HISTORICAL_UTILIZATION']
commodityType
■ type: string
■ 説明:コモディティ名。
■ readOnly:True
■ 列挙型:['ACTION_PERMIT'、'ACTIVE_SESSIONS'、'APPLICATION'、'BALLOONING'、'BUFFER_COMMODITY'、'CLUSTER'、'COLLECTION_TIME'、'COOLING'、'CONNECTION'、'COUPON'、'CPU'、'CPU_ALLOCATION'、'CPU_PROVISIONED'、'CPU_REQUEST_ALLOCATION'、'CROSS_CLOUD_MOVE_SVC'、'CROSS_CLUSTER_MOVE_SVC'、'DATACENTER'、'DATASTORE'、'DB_CACHE_HIT_RATE'、'DB_MEM'、'DISK_ARRAY_ACCESS'、'DRS_SEGMENTATION'、'DSPM_ACCESS'、'EXTENT'、'FLOW'、'FLOW_ALLOCATION'、'HEAP'、'HOST_LUN_ACCESS'、'IMAGE_CPU'、'IMAGE_MEM'、'IMAGE_STORAGE'、'INSTANCE_DISK_SIZE'、'INSTANCE_DISK_TYPE'、'IO_THROUGHPUT'、'LICENSE_ACCESS'、'MEM'、'MEM_ALLOCATION'、'MEM_REQUEST_ALLOCATION'、'MEM_PROVISIONED'、'NET_THROUGHPUT'、'NETWORK'、'NUM_DISK'、'NUMBER_CONSUMERS'、'NUM_VCORE'、'POOL_CPU'、'POOL_MEM'、'POOL_STORAGE'、'PORT_CHANNEL'、'POWER'、'Q16_VCPU'、'Q1_VCPU'、'Q2_VCPU'、'Q32_VCPU'、'Q4_VCPU'、'Q64_VCPU'、'Q8_VCPU'、'RESPONSE_TIME'、'SAME_CLUSTER_MOVE_SVC'、'SEGMENTATION'、'SLA_COMMODITY'、'SOFTWARE_LICENSE_COMMODITY'、'SPACE'、'STORAGE_ACCESS'、'STORAGE_ALLOCATION'、'STORAGE_AMOUNT'、'STORAGE_CLUSTER'、'STORAGE_LATENCY'、'STORAGE_PROVISIONED'、'SWAPPING'、'THREADS'、'TRANSACTION'、'TRANSACTION_LOG'、'VCPU'、'VCPU_LIMIT_QUOTA'、'VCPU_REQUEST'、'VCPU_REQUEST_QUOTA'、'VDC'、'VMEM'、'VMEM_LIMIT_QUOTA'、'VMEM_REQUEST'、'VMEM_REQUEST_QUOTA'、'VMPM_ACCESS'、'VSTORAGE'、'ZONE'、'LICENSE_COMMODITY',
'Q3_VCPU'、'NUMBER_CONSUMERS_PM'、'Q6_VCPU'、'Q7_VCPU'、'QN_VCPU'、'RIGHT_SIZE_SVC'、'RIGHT_SIZE_DOWN'、'MOVE'、'Q5_VCPU'、'STORAGE'、'NUMBER_CONSUMERS_STORAGE'、'ACCESS'、'RIGHT_SIZE_UP'、'VAPP_ACCESS'、'HOT_STORAGE'、'HA_COMMODITY'、'NETWORK_POLICY'、'SERVICE_LEVEL_CLUSTER'、'PROCESSING_UNITS'、'TENANCY_ACCESS'、'TEMPLATE_ACCESS'、'BURST_BALANCE'、'DESIRED_COUPON'、'NETWORK_INTERFACE_COUNT'、'BICLIQUE'、'TAINT'、'LABEL'、'UNKNOWN']
説明
単一の集約された正常性応答項目の DTO。
必須パラメータ
HealthState
■ type: string
■ 説明:サブカテゴリの(集計された)正常性状態。
■ 列挙型:['CRITICAL', 'MAJOR', 'MINOR', 'NORMAL']
numberOfItems
■ 型:整数
■ フォーマット:int32
■ 説明:状態が healthState に一致するエンティティの数。
サブカテゴリ
■ type: string
■ 説明:正常性サブカテゴリ。
オプションパラメータ
推奨事項
■ type: array
■ 説明:各問題(エラー)タイプに固有の推奨事項のリスト。
説明
Inherits From
この DTO は IEntityDefinitionData(401 ページ) から継承します。
必須パラメータ
entityType
■ type: string
■ 説明:接続エンティティタイプ
■ 列挙型:['ApplicationComponent', 'BusinessTransaction', 'Container', 'ContainerPod', 'DatabaseServer', 'Service', 'VirtualMachine']
namePrefix
■ type: string
■ 説明:自動エンティティ定義の命名プレフィックス
オプションパラメータ
generationAndConnectionAttribute
■ 説明:接続されたエンティティの定義済み基準
説明
エンティティの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
説明
コモディティの説明
必須パラメータ
type
■ type: string
■ 説明:コモディティのタイプ
■ 列挙型:['ACTION_PERMIT'、'ACTIVE_SESSIONS'、'APPLICATION'、'BALLOONING'、'BUFFER_COMMODITY'、'CLUSTER'、'COLLECTION_TIME'、'COOLING'、'CONNECTION'、'COUPON'、'CPU'、'CPU_ALLOCATION'、'CPU_PROVISIONED'、'CPU_REQUEST_ALLOCATION'、'CROSS_CLOUD_MOVE_SVC'、'CROSS_CLUSTER_MOVE_SVC'、'DATACENTER'、'DATASTORE'、'DB_CACHE_HIT_RATE'、'DB_MEM'、'DISK_ARRAY_ACCESS'、'DRS_SEGMENTATION'、'DSPM_ACCESS'、'EXTENT'、'FLOW'、'FLOW_ALLOCATION'、'HEAP'、'HOST_LUN_ACCESS'、'IMAGE_CPU'、'IMAGE_MEM'、'IMAGE_STORAGE'、'INSTANCE_DISK_SIZE'、'INSTANCE_DISK_TYPE'、'IO_THROUGHPUT'、'LICENSE_ACCESS'、'MEM'、'MEM_ALLOCATION'、'MEM_REQUEST_ALLOCATION'、'MEM_PROVISIONED'、'NET_THROUGHPUT'、'NETWORK'、'NUM_DISK'、'NUMBER_CONSUMERS'、'NUM_VCORE'、'POOL_CPU'、'POOL_MEM'、'POOL_STORAGE'、'PORT_CHANNEL'、'POWER'、'Q16_VCPU'、'Q1_VCPU'、'Q2_VCPU'、'Q32_VCPU'、'Q4_VCPU'、'Q64_VCPU'、'Q8_VCPU'、'RESPONSE_TIME'、'SAME_CLUSTER_MOVE_SVC'、'SEGMENTATION'、'SLA_COMMODITY'、'SOFTWARE_LICENSE_COMMODITY'、'SPACE'、'STORAGE_ACCESS'、'STORAGE_ALLOCATION'、'STORAGE_AMOUNT'、'STORAGE_CLUSTER'、'STORAGE_LATENCY'、'STORAGE_PROVISIONED'、'SWAPPING'、'THREADS'、'TRANSACTION'、'TRANSACTION_LOG'、'VCPU'、'VCPU_LIMIT_QUOTA'、'VCPU_REQUEST'、'VCPU_REQUEST_QUOTA'、'VDC'、'VMEM'、'VMEM_LIMIT_QUOTA'、'VMEM_REQUEST'、'VMEM_REQUEST_QUOTA'、'VMPM_ACCESS'、'VSTORAGE'、'ZONE'、'LICENSE_COMMODITY',
'Q3_VCPU'、'NUMBER_CONSUMERS_PM'、'Q6_VCPU'、'Q7_VCPU'、'QN_VCPU'、'RIGHT_SIZE_SVC'、'RIGHT_SIZE_DOWN'、'MOVE'、'Q5_VCPU'、'STORAGE'、'NUMBER_CONSUMERS_STORAGE'、'ACCESS'、'RIGHT_SIZE_UP'、'VAPP_ACCESS'、'HOT_STORAGE'、'HA_COMMODITY'、'NETWORK_POLICY'、'SERVICE_LEVEL_CLUSTER'、'PROCESSING_UNITS'、'TENANCY_ACCESS'、'TEMPLATE_ACCESS'、'BURST_BALANCE'、'DESIRED_COUPON'、'NETWORK_INTERFACE_COUNT'、'BICLIQUE'、'TAINT'、'LABEL'、'UNKNOWN']
オプションパラメータ
キー
■ type: string
■ 説明:特定のコモディティ
units
■ type: string
■ 説明:コモディティの測定単位(存在する場合)
説明
グループを表す基本モデル。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
membersCount
■ 型:整数
■ フォーマット:int32
■ 説明:グループのメンバー数
説明
基本的なフィールドのセットのみを提供する、アクションを簡潔に説明するモデル
オプションパラメータ
actionType
■ type: string
■ 説明:型
■ 列挙型:['START', 'MOVE', 'SCALE', 'ALLOCATE', 'SUSPEND', 'PROVISION', 'RECONFIGURE', 'RESIZE', 'DELETE', 'RIGHT_SIZE', 'BUY_RI']
details
■ type: string
■ 説明:アクションを説明するユーザーが読める文字列
ターゲット
■ 説明:アクションのターゲットエンティティタイプ。たとえば、サイズ変更アクションの VM、または VM 移動のホスト
■ DiscoveredEntityApiDTO(388ページ)
■ 説明:VM 移動アクションのために VM が存在する現在のホストなどの現在のエンティティ
■ DiscoveredEntityApiDTO(388ページ)
■ 説明:VM 移動アクションのための VM のホストなどの移動先エンティティ
■ DiscoveredEntityApiDTO(388ページ)
■ 型:整数
■ フォーマット:int64
■ 説明:アクションの ID
説明
Inherits From
オプションパラメータ
マスターアカウントUuid
■ type: string
■ 説明:マスターアカウントの UUID。
businessUnitApiDTOList
■ type: array
■ 説明:この請求ファミリーのすべてのアカウントのビジネスユニットのリスト。
■ – BusinessUnitApiDTO(357ページ)
説明
Inherits From
この DTO は、ConditionApiDTO(373 ページ)から継承します。
必須パラメータ
値
■ type: boolean
■ 説明:フィールドの値は、このブール値と等しくなければなりません
■ readOnly:True
説明
Inherits From
この DTO は FieldValueApiDTO(394 ページ)から継承します。
必須パラメータ
値
■ type: boolean
■ 説明:値
■ readOnly: True
説明
BulkActionRequest
オプションパラメータ
state
■ type: string
■ 説明:状態
■ 列挙型:['STOPPED', 'RUNNING', 'STARTING', 'STOPPING', 'TERMINATING', 'TERMINATED', 'MISSING']
error
■ type: string
■ 説明:エラー
entity_uuid
■ type: string
説明
BulkActionInput
オプションパラメータ
action
■ type: string
■ 説明:アクション
■ 列挙:['START', 'STOP']
entity_uuid
■ type: array
■ 説明:entityUuid
■ – 型:文字列
説明
ビジネスユニットのプロパティを説明するモデル。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
ディスカウント
■ 型:数値
■ フォーマット:float
■ 説明:エンティティ割引率
priceAdjustment
■ 説明:エンティティ価格調整率
■ PriceAdjustmentDTO(429ページ)
■ type: string
■ 説明:アカウント ID
master
■ type: boolean
■ 説明:このアカウントがマスターかどうかを示すフラグ
associatedTargetId
■ 型:整数
■ フォーマット:int64
■ 説明:このアカウントに関連するワークロードが検出されている場合、このアカウントに関連付けられたターゲット。このアカウントのワークロードが検出されない場合、associatedTargetId は空になります。
予算
■ 説明:ビジネスユニットの予算、ユーザーは値とユニットを設定するだけで済みます(月単位)
■ StatApiDTO(472ページ)
■ type: string
■ 説明:ビジネスユニット インスタンスのタイプ
■ 列挙型:['BUDGET', 'DISCOUNT', 'PRICE_ADJUSTMENT', 'DISCOVERED']
cloudType
■ type: string
■ 説明:現在のビジネス アカウントに関連するクラウド ターゲットのタイプ。
■ 列挙型:['AWS', 'AZURE', 'GCP', 'UNKNOWN']
accountType
■ type: string
■ 説明:現在のクラウド アカウントのカテゴリ。
■ 列挙型:['STANDARD', 'GOVERNMENT_US']
riSupported
■ type: boolean
■ 説明:このアカウントが RI サポートされているかどうかを示すフラグ
childrenBusinessUnits
■ type: array
■ 説明:このビジネスユニットの予算または割引構成を共有する、検出された子ビジネスユニットの UUID。
■ – 型:文字列
対象
■ type: array
■ 説明:ビジネスユニットに関連付けられたターゲット
■ – TargetApiDTO(484ページ)
■ 型:数値
■ フォーマット:float
■ 説明:1 時間あたりのコスト価格
severity
■ type: string
■ 説明:メンバーエンティティの最も高い重大度を使用して計算されます
■ 列挙型:['UNKNOWN', 'NORMAL', 'MINOR', 'MAJOR', 'CRITICAL']
membersCount
■ 型:整数
■ フォーマット:int32
■ 説明:ビジネスユニットのメンバー数
memberType
■ type: string
■ 説明:ビジネスユニットを構成するサービス エンティティのタイプ
関連
■ 説明:ビジネスユニットが使用しているレート表とカスタム価格情報
■ BusinessUnitRelatedApiDTO(361ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:ビジネスユニットに属するリソース グループの数
displayable
■ type: boolean
■ 説明:ビジネスユニットが表示可能かどうか
pricingIdentifiers
■ type: object
■ 説明:ビジネスユニットの価格設定識別子
■ additionalProperties: {'type': 'string'}
説明
ビジネスユニットを作成するためのパラメータを記述するモデル。
必須パラメータ
名前(name)
■ type: string
■ 説明:ビジネスユニットの名前
オプションパラメータ
予算
■ 説明:ビジネスユニットの予算、ユーザーは値を設定するだけで済みます
■ StatApiDTO(472ページ)
■ type: array
■ 説明:このビジネスユニットの予算または割引構成を共有する、検出された子ビジネスユニットの UUID。
■ – 型:文字列
ディスカウント
■ 型:数値
■ フォーマット:float
■ 説明:ビジネスユニットのエンタープライズ レベルの割引率。クラウドサービスまたはテンプレートレベルの割引が構成されていない場合に有効になります。
priceAdjustment
■ 説明:ビジネスユニットのエンタープライズ レベルの価格調整率。クラウドサービスまたはテンプレートレベルの割引が構成されていない場合に有効になります。
■ PriceAdjustmentDTO(429ページ)
■ type: array
■ – 型:文字列
nameWithBusinessAccountType
■ type: string
説明
ビジネスユニットに関連するクラウドサービスとテンプレートの価格調整値。ユーザー定義のビジネスユニットで構成された価格調整は、子ビジネスユニットが提供するクラウドサービスとテンプレートに適用されます。
オプションパラメータ
servicePriceAdjustments
■ type: array
■ 説明:関連するクラウドサービスおよびテンプレートの価格調整情報。
■ – CloudServicePriceAdjustmentApiDTO(369ページ)
■ type: array
■ 説明:関連するクラウドサービスおよびテンプレートの割引情報
説明
ビジネスユニットとそれに関連するレート カードと価格調整との関係を説明するモデル
オプションパラメータ
rateCard
■ 説明:このビジネスユニットに関連する料金表。
■ BaseApiDTO(353ページ)
■ 説明:このビジネスユニットに関連する価格調整。
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
セッション
■ type: array
■ 説明:この BusinessUser によって確立されたエンティティ (VM またはその他) へのセッションに関する情報。
■ – BusinessUserSessionApiDTO(361ページ)
説明
BusinessUser によってエンティティ(VM またはその他)に確立された接続のセッション情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
businessUserUuid
■ type: string
■ 説明:接続された BusinessUser の UUID
connectedEntityUuid
■ type: string
■ 説明:ユーザーが接続しているエンティティの UUID
duration
■ 型:整数
■ フォーマット:int64
■ 説明:セッション開始からの経過時間(秒)- セッションは常に時間計測されます
説明
オプションパラメータ
oldPassword
■ type: string
newPassword
■ type: string
説明
必須パラメータ
名前(name)
■ type: string
■ 説明:クライアントの名前
supportedServices
■ type: array
■ 説明:サポートされているサービスのリスト
■ – 型:文字列
説明
オプションパラメータ
id
■ type: string
■ 説明:id
名前(name)
■ type: string
■ 説明:名前
説明
オプションパラメータ
id
■ type: string
■ 説明:id
tokenData
■ type: string
■ 説明:トークンデータ
説明
オプションパラメータ
id
■ type: string
■ 説明:id
作成済み
■ type: string
■ 説明:作成日
claimsMade
■ 型:整数
■ フォーマット:int32
■ 説明:主張
claimsRemaining
■ 型:整数
■ フォーマット:int32
■ 説明:残りのクレーム
claimExpiration
■ type: string
■ 説明:クレームの有効期限
説明
オプションパラメータ
id
■ type: string
■ 説明:id
supportedServices
■ type: array
■ 説明::サポートされるサービス
■ – 型:文字列
secret
■ type: string
■ 説明:秘密
名前(name)
■ type: string
■ 説明:クライアントの名前
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
ゾーン
■ 説明:クラウドエンティティのゾーン
■ BaseApiDTO(353ページ)
■ 説明:クラウドエンティティのリージョン
■ BaseApiDTO(353ページ)
■ 説明:クラウドエンティティの BusinessAccount
■ BaseApiDTO(353ページ)
■ 説明:クラウドエンティティの ResourceGroup
■ BaseApiDTO(353ページ)
■ 説明:エンティティの生成に使用されるテンプレート
billingType
■ type: string
■ 説明:クラウド課金タイプ
階層
■ type: string
■ 説明:ストレージの階層
riCoveragePercentage
■ 型:数値
■ フォーマット:float
■ 説明:RI カバレッジのパーセンテージ
riCoverage
■ 説明:使用中の中古バリューストア VM クーポン、キャパシティストアクーポンキャパシティ
■ StatApiDTO(472ページ)
■ 型:数値
■ フォーマット:float
■ 説明:1 時間あたりのワークロードに対して支払われるオンデマンド コスト(コンピューティングとライセンスのオンデマンド コストを含む)
enhancedNetworking
■ type: string
■ 説明:サポートされる拡張ネットワーキングのタイプ。エンティティが AWS VM の場合、このフィールドには、VM が現在使用している拡張ネットワーキングの種類(存在する場合)を示す値が入力されます。エンティティが AWS VM でない場合、このフィールドは関係がなく、入力も表示もされません。
■ 列挙型:['NONE', 'ENA']
enaActive
■ type: string
■ 説明:ENA がアクティブかどうか。エンティティが AWS VM の場合、このフィールドには、ENA が現在使用されているかどうかを示す値が入力されます。エンティティが AWS VM でない場合、このフィールドは関係がなく、入力も表示もされません。
■ 列挙型:['Active', 'Inactive']
virtualizationType
■ type: string
■ 説明: 仮想化タイプ。エンティティが AWS VM の場合、このフィールドには、VM が現在使用している仮想化タイプ(存在する場合)の種類を示す値が入力されます。エンティティが AWS VM でない場合、このフィールドは関係がなく、入力も表示もされません。
■ 列挙型:['PVM', 'HVM']
アーキテクチャ
■ type: string
■ 説明:エンティティが AWS VM の場合、このフィールドには VM のアーキテクチャを説明する値が入力されます。エンティティが AWS VM でない場合、このフィールドは関係がなく、入力も表示もされません。
■ 列挙型:['32-bit', '64-bit']
nvme
■ type: string
■ 説明:NVMe ドライバーのサポート。エンティティが AWS VM で、NVMe ドライバーがインストールされている場合、このフィールドは true になります。エンティティが AWS VM でない場合、このフィールドは関係がなく、入力も表示もされません。
■ 列挙型:['Installed', 'Not installed']
entityUptime
■ 説明:エンティティの稼働時間
■ EntityUptimeApiDTO(392ページ)
■ type: string
■ 説明:VM のテナンシータイプ
■ 列挙型:['DEFAULT', 'DEDICATED', 'HOST']
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
startTimeInMilliseconds
■ 型:整数
■ フォーマット:int64
■ 説明:UTC でのクラウドコミットメントの開始時刻。
expirationTimeInMilliseconds
■ 型:整数
■ フォーマット:int64
■ 説明:UTC でのクラウド コミットメントの有効期限。
termInMilliseconds
■ 型:整数
■ フォーマット:int64
■ 説明:クラウド コミットメントの用語。
cloudCommitmentScopeType
■ type: string
■ 説明:クラウド コミットメントの範囲。
■ 列挙型:['FamilyScoped', 'FamilyAndOSScoped', 'CloudServiceScoped']
CloudCommitmentScopeDTO
■ 説明:クラウドコミットメントの範囲に関する情報。
■ CloudCommitmentScopeDTO(367ページ)
■ 説明:クラウドコミットメントのキャパシティ固有の情報。
■ CloudCommitmentCapacityApiDTO(367ページ)
■ type: string
■ 説明:クラウド コミットメントの支払いオプション。
■ 列挙型:['ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT']
providerSpecificType
■ type: string
■ 説明:プロバイダー固有のタイプ。
■ 列挙型:['SAVINGS_PLAN', 'COMMITTED_USE']
コミットメントステータス
■ type: string
■ 説明:クラウドコミットメントステータス。
■ 列挙型:['Unknown', 'Pending', 'Active', 'Expired', 'Canceled']
説明
クラウドコミットメントキャパシティを表すモデル
オプションパラメータ
instanceCapacity
■ 型:整数
■ フォーマット:int64
■ 説明:クラウド コミットメントのインスタンスキャパシティ。
spendCapacity
■ 型:数値
■ フォーマット:double
■ 説明:クラウドコミットメントの消費キャパシティ。
commoditiesBought
■ type: object
■ 説明:コミットメントによって購入された各タイプのコモディティのキャパシティ。
■ additionalProperties: {'type': 'number', 'format': 'double'}
説明
クラウドコミットメント範囲を記述するモデル。
オプションパラメータ
cloudFamilyReferenceApiDTO
■ 説明:クラウドコミットメントのファミリー範囲のタイプ固有の情報。null の場合、サービス範囲のクラウドコミットメントを示します。
説明
モデルは、クラウドファミリへの参照を記述します
オプションパラメータ
ファミリ
■ type: string
■ 説明:クラウドコミットメントのファミリー。
entityType
■ type: string
■ 説明:クラウド コミットメントが適用されるエンティティタイプ。
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
説明
Inherits From
この DTO は ActionDetailsApiDTO(342 ページ)から継承します。
オプションパラメータ
onDemandRate
■ 型:数値
■ フォーマット:float
onDemandCost
■ 型:数値
■ フォーマット:float
subType
■ type: string
説明
Inherits From
この DTO は ActionDetailsApiDTO(342 ページ)から継承します。
オプションパラメータ
onDemandRateBefore
■ 型:数値
■ フォーマット:float
onDemandRateAfter
■ 型:数値
■ フォーマット:float
onDemandCostBefore
■ 型:数値
■ フォーマット:float
onDemandCostAfter
■ 型:数値
■ フォーマット:float
riCoverageBefore
■ 説明:アクション前の対象エンティティの使用された RI クーポンとキャパシティ
■ StatApiDTO(472 ページ)
■ 説明:アクション後のターゲットエンティティの使用された RI クーポンとキャパシティ
■ 説明:アクションの生成時に考慮されたエンティティの稼働時間
■ EntityUptimeApiDTO(392ページ)
■ type: string
説明
特定の価格設定モデルに指定されたクラウドサービスおよび関連テンプレートの価格調整。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
ディスカウント
■ 型:数値
■ フォーマット:float
■ 説明:エンティティ割引率
priceAdjustment
■ 説明:エンティティ価格調整率
■ PriceAdjustmentDTO(429ページ)
■ type: string
■ 説明:価格設定モデル、時間ベースの「オンデマンド」、クーポンベースの「予約済み」、顧客入札の「スポット」
■ 列挙型:['ON_DEMAND', 'RESERVED', 'SPOT']
templateDiscounts
■ type: array
■ 説明:特定の価格モデルの下でクラウドサービスによって提供されるテンプレートの割引値。
■ – TemplatePriceAdjustmentDTO(493ページ)
■ type: array
■ 説明:特定の価格モデルの下でクラウドサービスによって提供されるテンプレートの価格調整値。
■ – TemplatePriceAdjustmentDTO(493ページ)
説明
ビジネスユニットで利用可能なクラウドサービス + 料金モデルのペア。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
ディスカウント
■ 型:数値
■ フォーマット:float
■ 説明:エンティティ割引率
priceAdjustment
■ 説明:エンティティ価格調整率
■ PriceAdjustmentDTO(429ページ)
■ type: string
■ 説明:価格設定モデル、時間ベースの「オンデマンド」、クーポンベースの「予約済み」、顧客入札の「スポット」
■ 列挙型:['ON_DEMAND', 'RESERVED', 'SPOT']
説明
Inherits From
この DTO は ActionDetailsApiDTO(342 ページ)から継承します。
オプションパラメータ
onDemandRate
■ 型:数値
■ フォーマット:float
onDemandCost
■ 型:数値
■ フォーマット:float
subType
■ type: string
説明
Inherits From
必須パラメータ
commodityAttribute
■ type: string
■ 説明:コモディティ属性。
■ readOnly:True
■ 列挙型: ['USED'、'CAPACITY'、'PEAK'、'CURRENT_UTILIZATION'、'WEIGHTED_HISTORICAL_UTILIZATION'、'PERCENTILE_HISTORICAL_UTILIZATION']
commodityType
■ type: string
■ 説明:コモディティ名。
■ readOnly:True
■ 列挙型:['ACTION_PERMIT'、'ACTIVE_SESSIONS'、'APPLICATION'、'BALLOONING'、'BUFFER_COMMODITY'、'CLUSTER'、'COLLECTION_TIME'、'COOLING'、'CONNECTION'、'COUPON'、'CPU'、'CPU_ALLOCATION'、'CPU_PROVISIONED'、'CPU_REQUEST_ALLOCATION'、'CROSS_CLOUD_MOVE_SVC'、'CROSS_CLUSTER_MOVE_SVC'、'DATACENTER'、'DATASTORE'、'DB_CACHE_HIT_RATE'、'DB_MEM'、'DISK_ARRAY_ACCESS'、'DRS_SEGMENTATION'、'DSPM_ACCESS'、'EXTENT'、'FLOW'、'FLOW_ALLOCATION'、'HEAP'、'HOST_LUN_ACCESS'、'IMAGE_CPU'、'IMAGE_MEM'、'IMAGE_STORAGE'、'INSTANCE_DISK_SIZE'、'INSTANCE_DISK_TYPE'、'IO_THROUGHPUT'、'LICENSE_ACCESS'、'MEM'、'MEM_ALLOCATION'、'MEM_REQUEST_ALLOCATION'、'MEM_PROVISIONED'、'NET_THROUGHPUT'、'NETWORK'、'NUM_DISK'、'NUMBER_CONSUMERS'、'NUM_VCORE'、'POOL_CPU'、'POOL_MEM'、'POOL_STORAGE'、'PORT_CHANNEL'、'POWER'、'Q16_VCPU'、'Q1_VCPU'、'Q2_VCPU'、'Q32_VCPU'、'Q4_VCPU'、'Q64_VCPU'、'Q8_VCPU'、'RESPONSE_TIME'、'SAME_CLUSTER_MOVE_SVC'、'SEGMENTATION'、'SLA_COMMODITY'、'SOFTWARE_LICENSE_COMMODITY'、'SPACE'、'STORAGE_ACCESS'、'STORAGE_ALLOCATION'、'STORAGE_AMOUNT'、'STORAGE_CLUSTER'、'STORAGE_LATENCY'、'STORAGE_PROVISIONED'、'SWAPPING'、'THREADS'、'TRANSACTION'、'TRANSACTION_LOG'、'VCPU'、'VCPU_LIMIT_QUOTA'、'VCPU_REQUEST'、'VCPU_REQUEST_QUOTA'、'VDC'、'VMEM'、'VMEM_LIMIT_QUOTA'、'VMEM_REQUEST'、'VMEM_REQUEST_QUOTA'、'VMPM_ACCESS'、'VSTORAGE'、'ZONE'、'LICENSE_COMMODITY',
'Q3_VCPU'、'NUMBER_CONSUMERS_PM'、'Q6_VCPU'、'Q7_VCPU'、'QN_VCPU'、'RIGHT_SIZE_SVC'、'RIGHT_SIZE_DOWN'、'MOVE'、'Q5_VCPU'、'STORAGE_CONSUMERS_SUM'、'HTTOR_AGE_NUMBER_ '、'VAPP_ACCESS'、'HOT_STORAGE'、'HA_COMMODITY'、'NETWORK_POLICY'、'SERVICE_LEVEL_CLUSTER'、'PROCESSING_UNITS'、'TENANCY_ACCESS'、'TEMPLATE_ACCESS'、'BURST_BALANCE'、_'QUERY_COUNT'、'CLICO 'TAINT'、'LABEL'、'UNKNOWN']
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
必須パラメータ
instanceStorageSize
■ 型:数値
■ フォーマット:float
■ 説明:GB 単位のインスタンスストレージあたりのサイズ。コンピューティングレベルにインスタンスストレージが存在しない場合、これは 0 になります。
numInstanceStorages
■ 型:数値
■ フォーマット:float
■ 説明:インスタンスストレージディスクの数。コンピューティング層には、0 個以上のインスタンス ストレージ ディスクを含めることができます。
tierFamily
■ type: string
■ 説明:コンピューティング層のファミリー(たとえば、M4.large の場合は「M4」)
説明
エンティティまたはグループのフィールドの条件。
必須パラメータ
conditionType
■ type: string
■ 説明:比較される値のタイプ。
■ readOnly:True
■ 列挙型:['NUMBER', 'TEXT', 'INCLUSION', 'INTEGER', 'BOOLEAN']
field
■ 説明:比較するフィールド。
■ readOnly:True
演算子
■ type: string
■ 説明:使用する演算子。
■ readOnly:True
■ 列挙型:['EQ', 'NEQ', 'GT', 'LT', 'GE', 'LE', 'LIKE', 'IN']
説明
シナリオでのポリシーと設定の変更
オプションパラメータ
addPolicyList
■ type: array
■ 説明:追加する配置ポリシーのリスト
■ – PolicyApiDTO(425ページ)
■ type: array
■ 説明:削除する配置ポリシーのリスト
automationSettingList
■ type: array
■ 説明:自動化設定のリスト
■ – SettingApiDTOString(466ページ)
■ type: array
■ 説明:削除する制約のリスト
■ – RemoveConstraintApiDTO(442 ページ)
■ type: array
■ 説明:予約済みインスタンス設定のリスト
■ – SettingApiDTO(468ページ)
■ type: array
■ 説明:OS移行設定一覧
■ – SettingApiDTOString(466ページ)
■ 説明:含まれるクーポン (RI) のリストと関連情報
■ IncludedCouponsApiDTO(402ページ)
■ 説明:サブスクリプション
説明
UI のエンティティ制約ビューに対応する制約のプロパティを記述するモデル。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
relation
■ type: string
■ 列挙型:['sold', 'bought']
entityType
■ type: string
■ 説明:プロバイダーまたはコンシューマーのエンティティタイプ
relatedEntities
■ type: array
■ 説明:関係が販売されればコンシューマー、購入されればプロバイダー
■ – ServiceEntityApiDTO(462ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:制約を満たすことができる他のプロバイダー/コンシューマーの数
placementOptions
■ type: array
■ 説明:制約のリストにより、エンティティのより適切な配置を見つけることができません
■ – PlacementOptionApiDTO(422ページ)
説明
制約の性質を記述するモデル
オプションパラメータ
relation
■ type: string
■ 列挙型:['sold', 'bought']
placementOptions
■ type: array
■ 説明:制約のリストにより、エンティティのより適切な配置を見つけることができません
■ – PlacementOptionApiInputDTO(423ページ)
■ type: string
■ 説明:潜在的なエンティティタイプフィルタ
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
説明
Inherits From
オプションパラメータ
名前空間
■ type: string
■ 説明:コンテナ プラットフォームエンティティが属する名前空間 - [非推奨 - 使用: namespaceEntity]
containerPlatformCluster
■ type: string
■ 説明: エンティティが属するコンテナ プラットフォーム クラスタ名 - [非推奨 - 使用: containerClusterEntity]
workloadControllerEntity
■ 説明」エンティティが属するワークロードコントローラエンティティ
■ BaseApiDTO(353ページ)
■ 説明: エンティティが属する名前空間エンティティ
■ BaseApiDTO(353ページ)
■ 説明:エンティティが属するコンテナプラットフォームクラスタエンティティ
説明
時間範囲によるコスト統計のリクエストを記述するモデル
オプションパラメータ
tagFilters
■ type: array
■ 説明:タグフィルタのリスト。注: costGroupBys を "TAG" に設定して使用する場合は、空でない必要があります。
■ – TagApiDTO(483ページ)
■ type: array
■ 説明:結果をグループ化するための値のリスト。注: 空でない tagFilters を使用する場合は必須
■ – 型:文字列
– 列挙型:['TAG', 'TAG_GROUP', 'ENTITY', 'ENTITY_TYPE', 'ACCOUNT', 'REGION', 'CLOUD_SERVICE', 'SERVICE_PROVIDER', 'CLOUD_TIER_PROVIDER', 'COST_CATEGORY', 'PRICE_MODEL']
startDate
■ type: string
■ 説明:フィルタリングする期間の開始時刻。startDate と endDate が指定されていない場合、現在の統計が処理されます
endDate
■ type: string
■ 説明:フィルタリングする期間の終了時刻。startDate と endDate が指定されていない場合、現在の統計が処理されます
説明
テンプレートを記述するモデル: VM のデプロイまたはプランへのワークロード/サプライの追加に使用されるリソースが含まれています
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
numCores
■ 型:整数
■ フォーマット:int32
■ 説明:コア数
speed
■ 型:整数
■ フォーマット:int32
■ 説明:速度
scalingFactor
■ 型:数値
■ フォーマット:double
■ 説明:スケーリング係数
modelName
■ type: string
説明
検索条件オプションを記述するために使用される一般的なモデル
オプションパラメータ
値
■ type: string
■ 説明:値
displayName
■ type: string
■ 説明:より読みやすく表示する値
subValues
■ type: array
■ 説明:メイン値に関連付けられた可能なサブ値
■ – 型:文字列
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
dbエンジン
■ type: string
■ 説明:データベース エンジン
dbEdition
■ type: string
■ 説明:データベースのエディション
dbVersion
■ type: string
■ 説明:データベースエンジンのバージョン
licenseModel
■ type: string
■ 説明:データベース エンジンのライセンス モデル
deploymentType
■ type: string
■ 説明:データベース エンジンの展開タイプ
maxConcurrentWorkers
■ 型:整数
■ フォーマット:int32
■ 説明:DB に許可される最大同時ワーカー
maxConcurrentSessions
■ 型:整数
■ フォーマット:int32
■ 説明:DB に許可される最大同時セッション
pricingmodel
■ type: string
■ 例:DTU
■ 説明:データベース価格設定モデル。
■ 列挙型:['DTU', 'vCore']
replicationRole
■ type: string
■ 例:プライマリ
■ 説明:DB が地理的にレプリケートされた DB の一部である場合のレプリケーションロール。現在、Azure DB のみに適用されます。
■ 列挙型:['Primary', 'Secondary', 'None']
storageTier
■ type: string
■ 例:GP2
■ 説明:ストレージ層
dbServerName
■ type: string
■ 説明:データベースのサーバー名
サービス層
■ type: string
■ 例:ハイパースケール
■ 説明:データベースのサービス層は、通常、ストレージ アーキテクチャ、スペースと I/O の制限、可用性と災害復旧に関連するビジネス継続性オプションを定義します。
■ 列挙型:['Free', 'Basic', 'Standard', 'Premium', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale']
computeTier
■ type: string
■ 例:プロビジョニングされたコンピューティング
■ 説明:データベースのコンピューティング層。コンピューティング レベルのオプションには、プロビジョニング済みおよびサーバーレスのコンピューティング層が含まれます
hardwareGeneration
■ type: string
■ 例:Gen4
■ 説明:データベース ハードウェアの世代。DB インスタンスの基礎となるハードウェアの世代
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
dbEngine
■ type: string
■ 説明:データベース エンジン
dbEdition
■ type: string
■ 説明:データベースのエディション
dbVersion
■ type: string
■ 説明:データベースエンジンのバージョン
licenseModel
■ type: string
■ 説明:データベースエンジンのライセンスモデル
deploymentType
■ type: string
■ 説明:データベース エンジンの展開タイプ
maxConcurrentWorkers
■ 型:整数
■ フォーマット:int32
■ 説明:DB に許可される最大同時ワーカー
maxConcurrentSessions
■ 型:整数
■ フォーマット:int32
■ 説明:DB に許可される最大同時セッション
pricingModel
■ type: string
■ 例:DTU
■ 説明:DB が従う価格設定モデル
storageTier
■ type: string
■ 例:GP2
■ 説明:ストレージ層
clusterRole
■ type: string
■ 説明:クラスタのロール
■ 列挙型:['Writer', 'Reader']
時間単位のBilledOps
■ 型:数値
■ フォーマット:double
■ 説明:時間単位で課金されるオペレーション - 1 時間あたりのオペレーション数
featureStateMap
■ type: object
■ 説明:機能
■ additionalProperties: {'type': 'string', 'enum': ['Enabled', 'Disabled', 'Unknown']}
説明
Inherits From
必須パラメータ
tierFamily
■ type: string
■ 説明:データベースサーバー層のファミリー (たとえば、db.M5.large の場合は「M5」)
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
必須パラメータ
tierFamily
■ type: string
■ 説明:データベース層のファミリー(S4 の場合は「S」など)
説明
予約エンティティを記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
テンプレート
■ BaseApiDTO(353ページ)
■ type: string
"placements":
説明
エンティティの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
prefix
■ type: string
count
■ 型:整数
■ フォーマット:int32
status
■ type: string
reserveDateTime
■ type: string
expireDateTime
■ type: string
deployDateTime
■ type: string
reserveCount
■ 型:整数
■ フォーマット:int32
deployCount
■ 型:整数
■ フォーマット:int32
placementExpirationDateTime
■ type: string
placementResultMessage
■ type: string
■ 説明:失敗または成功時の配置の詳細
制約情報
■ type: array
■ 説明:テンプレートを配置できる場所を制限する予約の実行時にユーザーが指定した制約。
reservationDeployed
■ type: boolean
■ 説明:true の場合、予約はシステムに組み込まれ、対応する仮想マシンの使用率が履歴に計算された使用率に反映され始めるまで、ホストとストレージのリソースを使用し続けます。
mode
■ type: string
■ 説明:NO_GROUPING/AFFINITY の予約に対するデマンド関連の動作。この値は、デマンドがモードを考慮する必要があるグループ化のタイプを指定するグループ化値と相互作用します。NO_GROUPING と NONE はペアにする必要があり、他の値とペアにすることはできません。(NO_GROUPING - NONE)、(AFFINITY - CLUSTER)などの組み合わせが有効です。無効な組み合わせの例は、(NO_GROUPING - CLUSTER)、(AFFINITY - NONE)です。
■ 列挙型:['NO_GROUPING', 'AFFINITY']
グループ化
■ type: string
■ 説明:NONE および CLUSTER の予約に対するグループ化関連の動作。この値はモード値と相互作用します。
■ 列挙型:['NONE', 'CLUSTER']
scope
■ type: array
■ 説明:メンバーがそのタイプのエンティティの唯一の可能なプロバイダーであるグループ(現在はクラスタまたはホストグループに限定されています)の uuid のリスト。これらは、配置パラメータで渡されるconstraintIdsによってさらに制約されます。プロバイダーの複数のグループが指定されている場合、エンティティが異なるグループ内に配置される可能性があります。
■ – 型:文字列
demandEntities
■ type: array
■ – DemandEntityInfoDTO(381ページ)
説明
必須パラメータ
action
■ type: string
■ 説明:予約のために要求されたアクション
■ 列挙型:['RESERVATION']
demandName
■ type: string
■ 説明:予約の名前
■ minLength: 1
■ maxLength:2147483647
パラメータ
■ type: array
■ 説明:予約パラメータ
■ – DemandReservationParametersDTO(384ページ)
■ maxItems:1
■ minItems:1
オプションパラメータ
mode
■ type: string
■ 説明:NO_GROUPING/AFFINITY の予約に対するデマンド関連の動作。この値は、デマンドがモードを考慮する必要があるグループ化のタイプを指定するグループ化値と相互作用します。NO_GROUPING と NONE はペアにする必要があり、他の値とペアにすることはできません。(NO_GROUPING - NONE)、(AFFINITY - CLUSTER)などの組み合わせが有効です。無効な組み合わせの例は、(NO_GROUPING - CLUSTER)、(AFFINITY - NONE)です。
■ 列挙型:['NO_GROUPING', 'AFFINITY']
グループ化
■ type: string
■ 説明:NONE および CLUSTER の予約に対するグループ化関連の動作。この値はモード値と相互作用します。
■ 列挙型:['NONE', 'CLUSTER']
reserveDateTime
■ type: string
■ 説明:デマンドを予約する時期を指定する日付
expireDateTime
■ type: string
■ 説明:デマンド要求がいつ期限切れになるかを指定する日付、action = RESERVATION の場合に必要
deployDateTime
■ type: string
■ 説明:デマンドをいつ展開するかを指定する日付
scope
■ type: array
■ 説明:メンバーがそのタイプのエンティティの唯一の可能なプロバイダーであるグループ(現在はクラスタまたはホストグループに限定されています)の uuid のリスト。これらは、配置パラメータで渡されるconstraintIdsによってさらに制約されます。プロバイダーの複数のグループが指定されている場合、エンティティが異なるグループ内に配置される可能性があります。
■ – 型:文字列
説明
必須パラメータ
placementParameters
■ 説明:配置パラメータ
オプションパラメータ
deploymentParameters
■ 説明:展開パラメータ、action = DEPLOYMENT、RESERVATION の場合に必要
■ DeploymentParametersDTO(385ページ)
説明
オプションパラメータ
deploymentProfileID
■ type: string
■ 説明:展開プロファイル uuid
highAvailability
■ type: boolean
■ 説明:高可用性
プライオリティ
■ type: string
■ 説明:ワークロードの優先度
■ 列挙型:['LOW', 'NORMAL', 'MISSION_CRITICAL']
説明
ターゲットおよびプロバイダーエンティティパラメータを含む、展開プロファイルを記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
管理する
■ 説明:展開プロファイルに関連するビジネス アカウント
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:展開プロファイルのターゲットおよびプロバイダーのパラメータ
説明
プロバイダー固有の展開プロファイルのパラメータ
オプションパラメータ
parameterType
■ type: string
■ 説明:パラメータタイプvCenter の場合、これはフォルダ、osConfiguration、またはイメージです。他のすべてのテクノロジーの場合、これはイメージである必要があります。
■ 列挙型:['image', 'folder', 'osConfiguration']
プロパティ
■ type: array
■ 説明:パラメータの名前と値を説明する NameValueInputDTO。
説明
展開プロファイルプロバイダーのプロパティ
オプションパラメータ
provider
■ 説明:プロバイダー UUID
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:プロバイダーエンティティのパラメータを説明する DeploymentProfileParamApiDTO
■ – DeploymentProfileParamApiDTO(386ページ)
説明
展開プロファイルターゲットのプロパティ
オプションパラメータ
targetType
■ type: string
■ 説明:展開プロファイルのターゲット タイプ
■ 列挙型:['vCenter', 'AWS', 'Azure', 'Softlayer']
プロバイダー
■ type: array
■ 説明:プロバイダー エンティティ パラメータを説明する DeploymentProfileProviderApiInputDTO
■ – DeploymentProfileProviderApiDTO(386ページ)
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
cloneType
■ type: string
■ 説明:DesktopPool によって提供されるクローンのタイプ
■ 列挙型:['FULL', 'LINKED', 'INSTANT']
provisionType
■ type: string
■ 説明:DesktopPool でのクローンのプロビジョニング方法
■ 列挙型:['UPFRONT', 'ON_DEMAND']
assignmentType
■ type: string
■ 説明:ユーザーが再度ログインするたびに同じクローンが割り当てられるかどうか
■ 列挙型:['PERSISTENT', 'DYNAMIC']
masterTemplateUuid
■ type: string
■ 説明:クローンの作成に使用されるマスターテンプレートの UUID。マスターVMとマスターテンプレートのどちらか一方のみ設定できます。
masterVirtualMachineUuid
■ type: string
■ 説明:クローンの作成に使用されるマスター仮想マシンの UUID。マスターVMとマスターテンプレートのどちらか一方のみ設定できます。
masterVirtualMachineSnapshot
■ type: string
■ 説明:クローンの作成に使用されるマスター仮想マシンのスナップショットの名前。
getvCenterClusterName
■ type: string
■ 説明:この DesktopPool がリソースを取得する vCenter クラスタの名前。
vendorId
■ type: string
■ 説明:DesktopPool のベンダー ID。
説明
キーと値のペアとして表される単一のエンティティの詳細
必須パラメータ
キー
■ type: string
■ 説明:詳細のキー
値
■ type: string
■ 説明:詳細の値
オプションパラメータ
クリティカル
■ type: boolean
説明
システム内で発見されたエンティティを表すモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
discoveredBy
■ 説明:エンティティを発見したターゲット
■ TargetApiDTO(484ページ)
■ type: object
■ 説明:リモート ターゲット上のこのエンティティのベンダー提供の ID へのターゲット ID のマッピング
■ additionalProperties: {'type': 'string'}
説明
エンティティ + アクションの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
realtimeMarketReference
■ 説明:プランマーケット エンティティの場合、これにはリアルタイムマーケットからの元のエンティティが含まれます。
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:このエンティティのアクションのリスト
説明
エンティティアスペクトの親クラス
必須パラメータ
type
■ type: string
説明
エンティティカウントを取得するために使用されるクエリ。
オプションパラメータ
groupBy
■ type: array
■ 説明:結果をグループ化する基準。
■ readOnly:True
■ – 型:文字列
– 列挙型:['ENTITY_TYPE', 'ENVIRONMENT_TYPE']
説明
エンティティをそのすべての詳細とともに記述するモデル
必須パラメータ
uuid
■ 型:整数
■ フォーマット:int64
■ 説明:エンティティの内部 UUID
オプションパラメータ
details
■ type: array
■ 説明:Key-Value として表される詳細のリスト
説明
エンティティメタデータを取得するために使用されるクエリ。
必須パラメータ
entityType
■ type: string
■ 説明:メタデータを取得するエンティティタイプ。
■ readOnly:True
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
説明
コンテキスト固有の価格。たとえば、特定のビジネスユニットのコンテキストでのテンプレートの基本レートです。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
price
■ 型:数値
■ フォーマット:float
■ 説明:関連エンティティのコンテキストでの価格
説明
トポロジエンティティの検索に使用されるクエリ。
必須パラメータ
select
■ 説明:エンティティごとに取得する情報。
■ readOnly:True
オプションパラメータ
説明:
■ 説明:取得された各エンティティが満たさなければならない条件。
■ readOnly:True
■ WhereApiDTO(505ページ)
■ 説明:ページネーション情報。
■ readOnly:True
説明
エンティティ + 統計の基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
realtimeMarketReference
■ 説明:プランマーケット エンティティの場合、これにはリアルタイムマーケットからの元のエンティティが含まれます。
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:収集された監視統計
■ – StatSnapshotApiDTO(476 ページ)
説明
エンティティの稼働時間を表すモデル
オプションパラメータ
creationTimestamp
■ 型:整数
■ フォーマット:int64
■ 説明:エンティティの作成タイムスタンプ
uptimeDurationInMilliseconds
■ 型:整数
■ フォーマット:int64
■ 説明:分析された合計時間のミリ秒単位の稼働時間
totalDurationInMilliseconds
■ 型:整数
■ フォーマット:int64
■ 説明:稼働時間が計算される合計分析時間(ミリ秒)
稼働時間の割合
■ 型:数値
■ フォーマット:double
■ 説明:エンティティの稼働時間のパーセンテージ
説明
Inherits From
この DTO は FieldValueApiDTO(394 ページ)から継承します。
必須パラメータ
値
■ type: string
■ 説明:値の文字列表現。
■ readOnly:True
説明
エンティティを配置解除する原因となったリソースの説明
必須パラメータ
コモディティ
■ 説明:エンティティが配置されない原因となったコモディティ
■ BaseCommodityApiDTO(353ページ)
■ 型:数値
■ フォーマット:double
■ 説明:エンティティを配置解除する原因となったコモディティの要求された金額
オプションパラメータ
maxAvailable
■ 型:数値
■ フォーマット:double
■ 説明:リクエストされたコモディティの最大利用可能量。要求されたコモディティを販売するエンティティが 1 つ以上ある場合にのみ入力されます。
説明
エンティティまたはグループのフィールド。
オプションパラメータ
fieldType
■ type: string
■ 説明:フィールドの種類。
■ 列挙型:['PRIMITIVE', 'COMMODITY', 'RELATED_ENTITY', 'RELATED_GROUP', 'RELATED_ACTION', 'AGGREGATE_COMMODITY', 'MEMBER']
説明
エンティティまたはグループのフィールドとその値。
必須パラメータ
field
■ 説明:比較するフィールド。
■ readOnly:True
■ FieldApiDTO(394ページ)
■ type: string
■ 説明:比較される値のタイプ。
■ readOnly:True
■ 列挙型:['NUMBER', 'TEXT', 'ENUM', 'INTEGER', 'BOOLEAN', 'MULTI_TEXT']
説明
値のタイプに関連付けられたエンティティまたはグループのフィールド。
必須パラメータ
field
■ 説明:情報が表示されるフィールド。
■ readOnly:True
valueType
■ type: string
■ 説明:このフィールドの値のタイプ。
■ readOnly:True
■ 列挙型:['NUMBER', 'TEXT', 'ENUM', 'INTEGER', 'BOOLEAN', 'MULTI_TEXT']
オプションパラメータ
allowableValues
■ type: array
■ 説明:このフィールドに許容される文字列値。
■ readOnly:True
■ – 型:文字列
説明
グループまたはエンティティのフィルタリングに使用されるモデル。すべてのフィルタは、filterType + expType + expVal を使用して構築されます。
必須パラメータ
caseSensitive
■ type: boolean
■ 説明:正規表現で大文字と小文字が区別されるかどうか
expType
■ type: string
■ 説明:フィルタの構築中に使用されるコンパレータのタイプ。許容値は、文字列に対しては「EQ」、「NEQ」、「RXEQ」、「RXNEQ」、数値に対しては「EQ」、「NEQ」、「GT」、「LT」、「GTE」、「LTE」です。
■ 列挙型:['EQ', 'NEQ', 'GT', 'LT', 'GTE', 'LTE', 'RXEQ', 'RXNEQ']
expVal
■ type: string
■ 説明:検索対象の正規表現
filterType
■ type: string
■ 説明:pmsByName、pmsByDC、storageByPMCluster などの基準の内部名
オプションパラメータ
entityType
■ type: string
■ 説明:このフィルタが適用されるエンティティタイプ
singleLine
■ type: boolean
■ 説明:正規表現のドットが改行文字を含むすべての文字に一致するかどうか。デフォルトは false です。
説明
グループを説明するモデル:エンティティのコレクション。サブクラスには、BillingFamilyApiDTO と ResourceGroupApiDTO が含まれます。
必須パラメータ
groupClassName
■ type: string
groupType
■ type: string
■ 説明:グループを構成するサービス エンティティのタイプ
isStatic
■ type: boolean
■ 説明:グループが静的な場合は True
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
メンバー数
■ 型:整数
■ フォーマット:int32
■ 説明:グループのメンバー数
entitiesCount
■ 型:整数
■ フォーマット:int32
■ 説明:グループのエンティティ数
costPrice
■ 型:数値
■ フォーマット:float
■ 説明:1 時間あたりのグループのコスト:メンバーエンティティのコストの合計
severity
■ type: string
■ 説明:メンバーエンティティの最も高い重大度を使用して計算されます
■ 列挙型:['UNKNOWN', 'NORMAL', 'MINOR', 'MAJOR', 'CRITICAL']
state
■ type: string
■ 説明:メンバーエンティティの状態を使用して計算
■ 列挙型:['UNKNOWN', 'ACTIVE']
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
scope
■ type: array
■ 説明:特定のエンティティタイプのリストに条件を適用する必要がある範囲
■ – 型:文字列
logicalOperator
■ type: string
■ 説明:動的グループの作成に使用されるすべての基準に適用される論理演算子。値は「AND」、「OR」、「XOR」を取ることができます。
criteriaList
■ type: array
■ 説明:要素の基準リスト、式のタイプ、式の値、seType - 動的グループの作成に必要
■ – FilterApiDTO(395ページ)
■ type: array
■ 説明:グループのメンバーの Uuid リスト - グループが静的な場合
■ – 型:文字列
realtimeMarketReference
■ 説明:プランマーケットグループの場合、これにはリアルタイムマーケットからの元のグループが含まれます。
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:収集された監視統計
■ – StatSnapshotApiDTO(476ページ)
■ type: boolean
■ 説明:グループは限られた期間のみ有効で、自動的に削除されます
activeEntitiesCount
■ 型:整数
■ フォーマット:int32
■ 説明:グループのアクティブ エンティティ数
cloudType
■ type: string
■ 説明:environmentType = CLOUD の場合のクラウドのタイプ
■ 列挙型:['AWS', 'AZURE', 'GCP', 'HYBRID', 'UNKNOWN']
送信元
■ 説明:グループのソース
■ TargetApiDTO(484ページ)
■ type: array
■ 説明:グループの直接のメンバーのタイプ。
■ – 型:文字列
entityTypes
■ type: array
■ 説明:グループに含まれるエンティティのタイプ。これには、グループがネストされている場合、グループのネストされたレベルにあるエンティティのタイプが含まれます。
■ – 型:文字列
アスペクト
■ type: object
■ 説明:アスペクトとして分類されたグループに関する追加情報
■ additionalProperties: {'$ref': '#/definitions/EntityAspect'}
vendorIds
■ type: object
■ 説明:グループが検出された場合の、このグループのベンダー提供の ID へのターゲット ID のマッピング
■ additionalProperties: {'type': 'string'}
groupOrigin
■ type: string
■ 説明:エンティティとグループの起源
■ 列挙型:['DISCOVERED', 'USER', 'SYSTEM']
説明
グループカウントを取得するために使用されるクエリ。
オプションパラメータ
groupBy
■ type: array
■ 説明:結果をグループ化する基準。
■ readOnly:True
■ uniqueItems: True
■ – 型:文字列
– 列挙型:['GROUP_TYPE', 'ORIGIN']
説明
グループメタデータを取得するために使用されるクエリ。
必須パラメータ
groupType
■ type: string
■ 説明:メタデータを取得するグループタイプ。
■ readOnly:True
■ 列挙型:['Group', 'Resource', 'Cluster', 'VMCluster', 'StorageCluster', 'BillingFamily', 'NodePool']
説明
グループの検索に使用されるクエリ。
必須パラメータ
select
■ 説明:グループごとに取得する情報。
■ readOnly:True
オプションパラメータ
説明:
■ 説明:取得された各グループが満たさなければならない条件。
■ readOnly:True
■ WhereApiDTO(505ページ)
■ 説明:ページネーション情報。
■ readOnly:True
説明
1 つの健康カテゴリの集約された正常性データを収集する DTO。
必須パラメータ
カテゴリ表示名
■ type: string
■ 説明:報告された正常性カテゴリ名。
categoryHealthState
■ type: string
■ 説明:報告されたカテゴリの正常性状態。
■ 列挙型:['CRITICAL', 'MAJOR', 'MINOR', 'NORMAL']
正常性カテゴリ
■ type: string
■ 説明:報告された正常性カテゴリ。
■ 列挙型:['TARGET', 'ACTION', 'COMPONENT']
オプションパラメータ
responseItems
■ type: array
■ 説明:この正常性カテゴリの個々の正常性応答項目のリスト。
説明
ユーザー名、パスワード、ポート番号、ホストなどの http プロキシ設定を記述するモデル
必須パラメータ
isProxyEnabled
■ type: boolean
■ 説明:プロキシが有効かどうか
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
proxyHost
■ type: string
■ 説明:プロキシホスト
proxyPortNumber
■ 型:整数
■ フォーマット:int32
■ 説明:プロキシポート番号
userName
■ type: string
■ 説明:プロキシのユーザー名
パスワード
■ type: string
■ 説明:プロキシのパスワード
説明
オプションパラメータ
status
■ 型:整数
■ フォーマット:int32
headerNames
■ type: array
■ – 型:文字列
作成者
■ PrintWriter(429ページ)
■ type: string
committed
■ type: boolean
bufferSize
■ 型:整数
■ フォーマット:int32
locale
■ Locale(407 ページ)
■ type: string
outputStream
説明
トポロジデータ定義の親クラス
必須パラメータ
definitionType
■ type: string
■ 列挙型:['MANUAL', 'AUTOMATED']
説明
手動接続の親クラス。
必須パラメータ
connectionType
■ type: string
■ 列挙型:['DYNAMIC', 'STATIC', 'GROUP']
説明
シナリオに RI/クーポンと関連情報を含める
オプションパラメータ
includedCouponOidsList
■ type: array
■ 説明:プランに含まれる RI のユーザー選択リスト
■ – 型:整数
– フォーマット:int64
iswhiteList
■ type: boolean
説明
Inherits From
この DTO は、ConditionApiDTO(373 ページ)から継承します。
必須パラメータ
値
■ type: array
■ 説明:文字列のセット。値はそれらのいずれかに属している必要があります。
■ readOnly:True
■ – 型:文字列
説明
エンティティの基本情報
必須パラメータ
名前(name)
■ type: string
■ 説明:フィールドの識別に使用されるフィールドの名前。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
値
■ type: string
■ 説明:フィールド値フィールドがプリミティブ値(文字列、数値、またはブール値)を保持する場合に使用されます
defaultValue
■ type: string
■ 説明:フィールドのデフォルト値
isMandatory
■ type: boolean
■ 説明:フィールドが必須かどうか。有効なターゲットには、すべての必須フィールドが設定されている必要があります。
isSecret
■ type: boolean
■ 説明:フィールドが秘密かどうか。つまり、そのフィールド値は暗号化された値に保存され、ログには表示されないということです。
isMultiline
■ type: boolean
■ 説明:フィールドが複数行の値を持つことができるかどうか。valueType フィールドが STRING に設定されている場合にのみ true にできます。
isTargetDisplayName
■ type: boolean
■ 説明:フィールドがターゲット表示名として使用されるかどうか。
valueType
■ type: string
■ 説明:このフィールドが保持する値のタイプ
■ 列挙型:['STRING', 'BOOLEAN', 'NUMERIC', 'LIST', 'OBJECT', 'GROUP_SCOPE']
specificValueType
■ type: string
■ 説明:valueType に記述できない値の特定の型
説明
■ type: string
■ 説明:フィールドへの入力に関する追加情報
verificationRegex
■ type: string
■ 説明:入力フィールドテキストが満たす必要がある正規表現パターン
groupProperties
■ type: array
■ 説明:このフィールドがグループ範囲値を表す場合に入力されるグループ範囲構造
■ – タイプ:配列
– – タイプ:文字列
allowedValues
■ type: array
■ 説明:このフィールドに可能な値。空でない場合、値はリスト内の選択肢の 1 つである必要があります。
■ – 型:文字列
dependencyKey
■ type: string
■ 説明:依存アカウント値フィールドのキー。この値が設定されていない場合、フィールドは依存関係なしで宣言されます。注釈付きのアカウント値フィールドに依存関係がある場合、その存在は
依存フィールドによって論理的に定められます。このフィールドは、
{@code dependencyKey} によって指定されるフィールドが値 {@code dependencyValue} を持つ場合にのみ利用できます。依存関係が満たされていないためにこのフィールドが使用できない場合、このフィールドは検証されず、ターゲット構成データに保存されません。このフィールドの依存関係が満たされていない場合、このフィールドの値は null になります
dependencyValue
■ type: string
■ 例:one|two|four
■ 説明:注釈付きフィールドを有効化(アクティブ化)するために、{@code dependencyKey} によって参照されるアカウント値のフィールドの値。値は正規表現で指定します。文字列のみを指定しても
正しく機能します。参照されるアカウント値フィールドがブール値フィールドである場合、値としてサポートされるのは「true」または「false」のみです。参照されるアカウント値が列挙型({@code allowedValues} が指定されている場合)の場合、この値は、パイプ {@code one|two|four} を使用して結合された許可された値のサブセットを含むようにのみ制限されます。
説明
Inherits From
この DTO は、ConditionApiDTO(373 ページ)から継承します。
必須パラメータ
値
■ 型:整数
■ フォーマット:int64
■ 説明:比較する値。
■ readOnly:True
説明
Inherits From
必須パラメータ
値
■ 型:整数
■ フォーマット:int64
■ 説明:値。
■ readOnly:True
オプションパラメータ
units
■ type: string
■ 説明:測定単位。
■ readOnly:True
説明
ライセンスの特性を記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
licenseOwner
■ type: string
■ 説明:現在のライセンスの所有者
■ type: string
■ 説明:現在のライセンスの電子メール
customerId
■ type: string
■ 説明:顧客 ID
expiration-date
■ type: string
■ 説明: 現在のライセンスの有効期限
機能
■ type: array
■ 説明:現在のライセンスに含まれる機能のリスト
■ uniqueItems: True
■ – 型:文字列
numLicensedEntities
■ 型:整数
■ フォーマット:int32
■ 説明:ライセンスされたソケットの数
numInUseEntities
■ 型:整数
■ フォーマット:int32
■ 説明:使用中のソケットの数
Edition
■ type: string
■ 説明:現在のライセンスのエディション
filename
■ type: string
■ 説明:アップロードされたファイルの名前
countedEntity
■ type: string
■ 説明:ライセンスに関してどのエンティティタイプがカウントされるかを示します
■ 列挙型:['VM', 'SOCKET']
maxReportEditorsCount
■ 型:整数
■ フォーマット:int32
■ 説明:レポート エディタの最大数
expirationDateTime
■ type: string
■ フォーマット:日付-時刻
errorReasons
■ type: array
■ 説明:ライセンスが無効である理由を示します
■ uniqueItems: True
■ – 型:文字列
– 列挙型:['DUPLICATE_LICENSE', 'EXPIRED', 'INVALID_EMAIL', 'INVALID_CONTENT_TYPE', 'INVALID_LICENSE_KEY', 'INVALID_LICENSE_TYPE_CWOM_ONLY', 'INVALID_LICENSE_TYPE_FREEMIUM_NOT_ALLOWED', 'INVALID_FEATURE_SET', 'INCOMPATIBLE']
isExpired
■ type: boolean
■ 説明:現在のライセンスが期限切れかどうかを示します
■ readOnly:True
isValid
■ type: boolean
■ 説明:現在のライセンスが有効かどうかを示します
■ readOnly:True
説明
オプションパラメータ
rel
href
■ タイプ:文字列
■ xml: {'attribute': True}
■ type: string
■ xml: {'attribute': True}
説明
シナリオにおけるワークロード使用率の変化
オプションパラメータ
baselineDate
■ type: string
■ 説明:ベースライン日
peakBaselineList
■ type: array
■ 説明:ピークベースライン変化のリスト
■ – PeakBaselineApiDTO(421 ページ)
■ type: array
■ 説明:使用率の変更のリスト
■ – UtilizationApiDTO(499ページ)
■ type: array
■ 説明:最大使用率の変更のリスト
■ – MaxUtilizationApiDTO(413ページ)
■ type: array
■ 説明:提供された入力でプランコモディティ値を上書きする統計変更のリスト
■ – EntityStatsApiDTO(392 ページ)
説明
オプションパラメータ
スクリプト
■ type: string
国
■ type: string
variant
■ type: string
extensionKeys
■ type: array
■ uniqueItems: True
■ – 型:文字列
unicodeLocaleAttributes
■ type: array
■ uniqueItems: True
■ – 型:文字列
unicodeLocaleKeys
■ type: array
■ uniqueItems: True
■ – 型:文字列
iso3Language
■ type: string
iso3Country
■ type: string
displayLanguage
■ type: string
displayScript
■ type: string
displayCountry
■ type: string
displayVariant
■ type: string
displayName
■ type: string
言語
■ type: string
説明
エンティティの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
logActionTime
■ 型:整数
■ フォーマット:int64
targetSE
■ type: string
targetUuid
■ type: string
currentSE
■ type: string
currentSEUuid
■ type: string
newSE
■ type: string
newSEUuid
■ type: string
category
■ type: string
subCategory
■ type: string
説明
■ type: string
shortDescription
■ type: string
state
■ type: string
severity
■ type: string
count
■ 型:整数
■ フォーマット:int64
合計
■ 型:整数
■ フォーマット:int64
ユーザー
■ type: string
タイプ
■ type: string
importance
■ 型:数値
■ フォーマット:float
reasonCommodities
■ type: array
■ 説明:アクションの理由となった個別のコモディティセット。すべての行動がコモディティによって起こされるわけではありません。したがって、これは空のリストである可能性があります。
■ uniqueItems: True
■ – 型:文字列
reasonCommodityRelationType
■ type: string
■ 説明:理由コモディティの関係タイプ(購入/売却)
■ 列挙型:['sold', 'bought']
logDBId
■ 型:整数
■ フォーマット:int64
説明
コンポーネントのロギング レベルを表すモデル
オプションパラメータ
componentLoggingLevel
■ type: object
■ 説明:コンポーネント名からログ レベルへのマップ。コンポーネントは、検出、監視、プレゼンテーション、抽象化、分析、拡張である可能性があります。ログ レベルは、INFO、WARN、DEBUG、TRACE のいずれかです。
■ additionalProperties: {'type': 'string', 'enum': ['FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE', 'UNKNOWN']}
説明
Inherits From
この DTO は IManualConnectionsData(401 ページ)から継承します。
オプションパラメータ
dynamicConnectionCriteria
■ type: array
■ 説明:動的に接続されたエンティティを定義するための接続基準。
説明
Inherits From
この DTO は IEntityDefinitionData(401 ページ)から継承します。
必須パラメータ
manualConnectionData
■ type: object
■ 説明:エンティティ接続を手動で設定
■ additionalProperties: {'$ref': '#/definitions/IManualConnectionsData'}
説明
Inherits From
この DTO は IManualConnectionsData(401 ページ)から継承します。
必須パラメータ
connectedGroup
■ 説明:接続のグループ。
説明
Inherits From
この DTO は IManualConnectionsData(401 ページ)から継承します。
オプションパラメータ
staticConnections
■ type: array
■ 説明:作成されたエンティティに静的に接続される Oid
■ – 型:文字列
説明
マーケットを説明するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
state
■ type: string
■ 説明:状態
■ 列挙型:['CREATED', 'READY_TO_START', 'RUNNING', 'COPYING', 'SUCCEEDED', 'STOPPING', 'STOPPED', 'DELETING']
stateProgress
■ 型:整数
■ フォーマット:int32
■ 説明:RUNNING 状態で使用されるパーセンテージで示される状態の進行状況
シナリオ
■ 説明:プランの作成に使用されるシナリオ、プランマーケットのみ
■ ScenarioApiDTO(453ページ)
■ type: boolean
■ 説明:プランマーケットが保存されているかどうかを示します
unplacedEntities
■ type: boolean
■ 説明:配置されていないエンティティ。プランマーケットに配置できなかったエンティティがあるかどうかを示します。
runDate
■ type: string
■ 説明:プランマーケットがいつ開始されたかを示します。
runCompleteDate
■ type: string
■ 説明:プランマーケットがいつ完了したかを示します
判別
■ type: array
■ 説明:プランマーケットで発生した違反
relatedPlanMarkets
■ type: array
■ 説明:特定のシナリオによって生成される関連プランマーケット
■ – MarketApiDTO(412 ページ)
■ type: string
■ 説明:環境タイプ
■ 列挙型:['HYBRID', 'CLOUD', 'ONPREM']
planDestination
■ 説明:プランマーケットのみの、プラン結果が保存されるプランの目的地。
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
displayName
■ type: string
■ 説明:新しい VM の作成に使用される masterImage の DisplayName
numVcpus
■ 型:整数
■ フォーマット:int32
■ 説明:マスター イメージから生成された各 VM に割り当てられた vCPU の数
mem
■ 型:数値
■ フォーマット:float
■ 説明:マスターイメージから生成された各 VM に割り当てられるメモリの量
ストレージ
■ 型:数値
■ format: float
■ 説明:マスターイメージから生成された各 VM に割り当てられたストレージの量
説明
シナリオでの最大使用率の変化を説明するモデル
オプションパラメータ
projectionDay
■ 型:整数
■ format: int32
■ 説明:投影日、いつ変更を適用するかを示します
ターゲット
■ 説明:変更の対象、エンティティまたはグループ。空の場合、グローバル 範囲を想定します
■ BaseApiDTO(353 ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:最大使用率のしきい値のパーセンテージの変更
selectedEntityType
■ type: string
■ 説明:グローバル範囲構成で選択するエンティティのタイプ
グローバル 範囲
■ type: boolean
説明
Inherits From
この DTO は FieldApiDTO(394 ページ)から継承します
必須パラメータ
財産
■ type: string
■ 説明:関心のあるプロパティ。
■ readOnly:True
■ 列挙型:['COUNT']
オプションパラメータ
entityType
■ type: string
■ 説明:プロパティをこのタイプのエンティティに制限します。
■ readOnly:True
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
direct
■ type: boolean
■ 説明:このフィールドが直接メンバーまたは間接メンバーを参照するかどうか(デフォルト = 直接)。
■ readOnly:True
説明
シナリオの置換変更を記述するモデル
オプションパラメータ
projectionDay
■ 型:整数
■ フォーマット:int32
■ 説明:投影日、いつ変更を適用するかを示します
送信元
■ 説明:移行のソース、エンティティまたはグループ - [非推奨 - 使用: ソース]
■ BaseApiDTO(353ページ)
■ 説明:移行の宛先 - [非推奨 - 使用:destinations]
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:移行のソース、エンティティまたはグループ。
■ – BaseApiDTO(353ページ)
■ type: array
■ 説明:移行先、エンティティまたはグループ。
■ – BaseApiDTO(353ページ)
■ type: string
■ 説明:移行先のエンティティタイプ、デフォルトは VirtualMachine です。ケース 1、移行元 VirtualMachine: 移行先エンティティは VirtualMachine である必要があります。ケース 2、移行元データベースサーバー:移行先エンティティは VirtualMachine または DatabaseServer です。
■ 列挙型:['VirtualMachine', 'DatabaseServer']
removeNonMigratingWorkloads
■ type: boolean
■ 説明:true の場合、移行していない既存の仮想マシン、データベース、およびデータベース サーバーを範囲から削除して、新しく移行されたエンティティのみが計画の結果に含まれるようにします。
説明
Inherits From
この DTO は FieldValueApiDTO(394 ページ)から継承します。
必須パラメータ
値
■ type: array
■ 説明:フィールドに関連付けられた値。
■ readOnly:True
■ – 型:文字列
説明
展開プロファイルプロバイダーのパラメータ
オプションパラメータ
名前(name)
■ type: string
■ 説明:パラメータタイプvCenter の場合、これは名前または ID です。他のすべてのターゲット タイプの場合、これは ID である必要があります。
■ 列挙型:['name', 'id']
値
■ type: string
説明
Inherits From
この DTO は、ConditionApiDTO(373 ページ)から継承します。
必須パラメータ
値
■ 型:数値
■ フォーマット:double
■ 説明:比較する値。
■ readOnly:True
説明
Inherits From
この DTO は FieldValueApiDTO(394 ページ)から継承します。
必須パラメータ
値
■ 型:数値
■ フォーマット:double
■ 説明:値。
■ readOnly:True
オプションパラメータ
units
■ type: string
■ 説明:測定単位。
■ readOnly:True
説明
Inherits From
この DTO は ActionDetailsApiDTO(342 ページ)から継承します。
オプションパラメータ
vcpuBefore
■ 型:整数
■ フォーマット:int32
■ 説明:変更前の vCPU
vcpuAfter
■ 型:整数
■ フォーマット:int32
■ 説明:変更後の vCPU
socketsBefore
■ 型:整数
■ フォーマット:int32
■ 説明:変更前のソケット
socketsAfter
■ 型:整数
■ フォーマット:int32
■ 説明:変更後のソケット
coresPerSocketBefore
■ 型:整数
■ フォーマット:int32
■ 説明:変更前のソケットあたりのコア数
coresPerSocketAfter
■ 型:整数
■ フォーマット:int32
■ 説明:変更後のソケットあたりのコア数
subType
■ type: string
説明
結果を並べ替えるフィールド。
必須パラメータ
field
■ 説明:並べ替えるフィールド。
■ readOnly:True
オプションパラメータ
昇順
■ type: boolean
■ 説明:順序が昇順かどうか(デフォルトは false)。
■ readOnly:True
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
diskCapacity
■ 型:整数
■ フォーマット:int64
■ 説明:ディスクキャパシティ
diskRole
■ type: string
■ 説明:ディスクの役割
■ 列挙型:['CAPACITY', 'CACHE']
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
disks
■ type: array
■ 説明:ディスク
■ – PMDiskAspectApiDTO(418ページ)
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
diskGroups
■ type: array
■ 説明:ディスクグループ
■ – PMDiskGroupAspectApiDTO(419ページ)
■ type: boolean
■ 説明:true の場合、このホストはフェールオーバー ホストです。
cpuModel
■ type: string
■ 例:Intel(R) Xeon(R) CPU E5-2670 0 @ 2.60GHz
■ 説明:ホストの CPU モデル
接続されたネットワーク
■ type: array
■ 例:Broadcom BCM5708C NetXtreme II GigE
■ 説明:接続されたネットワーク
■ – 型:文字列
automationLevel
■ type: string
■ 例:完全自動化
■ 説明:ベンダー提供の自動化レベル
■ 列挙型: ['FULLY_AUTOMATED', 'PARTIALLY_AUTOMATED', 'NOT_AUTOMATED', 'DISABLED']
migrationLevel
■ type: string
■ 例:保守的
■ 説明:ベンダー提供の移行レベル
processorPools
■ type: array
■ – 型:文字列
説明
Pagination パラメータ
オプションパラメータ
orderBy
■ type: array
■ 説明:これらのフィールドで並べ替えます。
■ readOnly:True
■ – OrderByApiDTO(418ページ)
■ type: string
■ 説明:次のバッチのカーソル。
■ readOnly:True
limit
■ 型:整数
■ フォーマット:int32
■ 説明:フェッチするレコードの最大数。
■ readOnly:True
説明
パッチが適用されたターゲット データを記述するモデル。
必須パラメータ
patchedFields
■ type: array
■ 説明:パッチが適用されたターゲット フィールド。
■ – PatchedTargetFieldApiDTO(421ページ)
■ type: string
■ 説明: パッチが適用されたターゲットのプローブタイプ。
説明
パッチが適用された対象データのフィールドを記述するモデル。
オプションパラメータ
fieldName
■ type: string
■ 説明:パッチが適用されたフィールド名。
fieldValue
■ type: string
■ 説明:パッチが適用されたフィールド値。
説明
シナリオのピークベースライン変化を説明するモデル
オプションパラメータ
date
■ type: string
■ 説明:使用率のピークの日付
ターゲット
■ 説明:変更の対象
説明
オプションパラメータ
computeResources
■ type: array
■ 説明:予約が配置されているコンピューティング リソース
■ – ResourceApiDTO(448ページ)
■ type: array
■ 説明:予約が配置されるストレージ リソース
networkResources
■ type: array
■ 説明:予約が配置されるネットワーク リソース
■ – ResourceApiDTO(448ページ)
■ type: array
■ 説明:予約が失敗した理由の詳細。これは、予約が失敗した場合にのみ入力されます。
■ – ReservationFailureInfoDTO(444ページ)
■ 説明:予約が無効な理由の詳細。これは、予約が無効な場合にのみ入力されます。
■ ReservationInvalidInfoApiDTO(445ページ)
説明
プロバイダーオプションのプロパティを記述するモデル。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
constraintType
■ type: string
■ 説明:制約タイプ、コモディティが AccessCommodity の場合、そのコモディティのクラス名は制約タイプです
■ 列挙型:['ApplicationCommodity', 'ClusterCommodity', 'DataCenterCommodity', 'DatastoreCommodity etc']
scope
■ 説明:範囲または配置ポリシー
■ BaseApiDTO(353ページ)
■ 説明:配置ポリシーの場合、ユーザー配置ポリシーの場合は null です。
■ TargetApiDTO(484 ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:例:この制約を購入するが、このホストでは購入しない他の VM
キー
■ type: string
■ 説明:コモディティ キー。この情報は、プロバイダーまたはコンシューマーの相互作用を取得しようとするときに必要です。
currentEntities
■ type: array
■ 説明:コンシューマーのみ。例: 購入している制約ごとに現在このホストにある VM
■ – ServiceEntityApiDTO(462ページ)
説明
プロバイダーオプションのプロパティを記述するモデル。
オプションパラメータ
constraintType
■ type: string
■ 説明:制約タイプ、コモディティが AccessCommodity の場合、そのコモディティのクラス名は制約タイプです
■ 列挙型:['ApplicationCommodity', 'ClusterCommodity', 'DataCenterCommodity', 'DatastoreCommodity etc']
キー
■ type: string
■ 説明:コモディティ キー。この情報は、プロバイダーまたはコンシューマーの共通部分を取得しようとするときに必要です。
説明
必須パラメータ
count
■ 型:整数
■ フォーマット:int32
■ 説明:配置する仮想マシンの数
オプションパラメータ
templateID
■ type: string
■ 説明:配置に使用されるテンプレート Uuid
entityNames
■ type: array
■ 説明:配置された仮想マシンの名前
■ – 型:文字列
constraintIDs
■ type: array
■ 説明:新しい VM が準拠する必要がある制約を定義する uuid のリスト、許可される uuid は次のとおりです: クラスタ、データセンター、VirtualDataCenter、ネットワーク、配置ポリシー。可能なプロバイダーは、渡されたすべての制約の共通部分です。
■ uniqueItems: True
■ – 型:文字列
geographicRedundancy
■ type: boolean
■ 説明:地理的冗長性を有効にします
説明
プランのデスティネーションを表すモデル。プランのデスティネーションは、計画結果をアップロードできる外部デスティネーションです。
必須パラメータ
businessUnit
■ 説明:宛先を計画するためのビジネス アカウント。
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:このプランの宛先に関するプランエクスポートの説明メッセージ。
exportProgressPercentage
■ 型:整数
■ フォーマット:int32
■ 説明:このプランの宛先でのプランのエクスポートの進捗率。
輸出州
■ type: string
■ 説明:このプランのデスティネーションでのプランのエクスポート状態。
■ 列挙型:['NONE', 'REJECTED', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED']
hasExportedData
■ type: boolean
■ 説明:ブール値。このプランの宛先にデータがアップロードされている場合は true。
短縮
■ 説明:現在、計画先にアップロードされているプランマーケット。
■ BaseApiDTO(353 ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:プランのデスティネーションでのエラーの数。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
説明
環境内のエンティティを管理するために使用されるワークロード ポリシーを記述するモデル。例: 特定のデータストアを使用できる VM の数を制限する、VM のコレクションを指定されたクラスタまたはホストのグループに制限することで VM モビリティを制限する、多数のクラスタをマージすることで VM モビリティを拡張する、必要なホスト上でワークロードを実行し続けるライセンス
必須パラメータ
type
■ type: string
■ 説明:配置ポリシー タイプ
■ 列挙型:['AT_MOST_N', 'BIND_TO_GROUP', 'BIND_TO_COMPLEMENTARY_GROUP', 'MUST_RUN_TOGETHER', 'AT_MOST_N_BOUND', 'MERGE', 'BIND_TO_GROUP_AND_LICENSE', 'MUST_NOT_RUN_TOGETHER', 'EXCLUSIVE_BIND_TO_GROUP']
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
名前(name)
■ type: string
■ 説明:ポリシーの名称
enabled
■ type: boolean
■ 説明:ポリシーが有効かどうかを示します
容量
■ 型:整数
■ フォーマット:int32
■ 説明:タイプが AT_MOST_N_BOUND の場合に使用される、配置エンティティごとに同時に最大のワークロード エンティティを示します。
commodityType
■ type: string
■ 説明:ポリシーに使用されるコモディティタイプ
mergeType
■ type: string
■ 説明:マージされるグループのタイプ。タイプが MERGE の場合にのみ使用されます。
■ 列挙型:['Cluster', 'StorageCluster', 'DataCenter', 'DesktopPool']
consumerGroup
■ 説明:タイプが MERGE 以外の場合に使用されるコンシューマーグループ
■ BaseApiDTO(353ページ)
■ 説明:タイプが MERGE 以外の場合に使用されるプロバイダーグループ
■ BaseApiDTO(353ページ)
■ type: array
■ 説明:タイプが MERGE の場合に使用される、マージするグループのリスト
■ – BaseApiDTO(353ページ)
■ type: string
■ 説明:プロバイダーのエンティティタイプ。このプロパティは、ポリシー タイプが MUST_RUN_TOGETHER または MUST_NOT_RUN_TOGETHER に設定されている場合にのみ適用されます。ポリシー タイプが MUST_RUN_TOGETHER または MUST_NOT_RUN_TOGETHER に設定されている場合、このフィールドは、コンシューマ グループのメンバーがポリシー タイプに応じて一緒に実行する必要があるか、または一緒に実行してはならないプロバイダーのタイプで設定する必要があります。
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
説明
配置ポリシーを記述するモデル
必須パラメータ
policyName
■ type: string
■ 説明:ポリシーの名称
type
■ type: string
■ 説明:配置ポリシー タイプ
■ 列挙型:['AT_MOST_N', 'BIND_TO_GROUP', 'BIND_TO_COMPLEMENTARY_GROUP', 'MUST_RUN_TOGETHER', 'AT_MOST_N_BOUND', 'MERGE', 'BIND_TO_GROUP_AND_LICENSE', 'MUST_NOT_RUN_TOGETHER', 'EXCLUSIVE_BIND_TO_GROUP']
オプションパラメータ
sellerUuid
■ type: string
■ 説明:配置ポリシーのプロバイダー グループの Uuid
buyerUuid
■ type: string
■ 説明:配置ポリシーのコンシューマーグループの Uuid
mergeUuid
■ type: array
■ 説明:マージ ポリシーのグループの Uuid
■ – 型:文字列
mergeType
■ type: string
■ 説明:マージポリシーのグループタイプ
■ 列挙型:['Cluster', 'StorageCluster', 'DataCenter', 'DesktopPool']
容量
■ 型:整数
■ フォーマット:int32
■ 説明:AT_MOST_N または AT_MOST_N_BOUND ポリシーの場合、プロバイダーエンティティで許可するコンシューマーの数
enabled
■ type: boolean
■ 説明:ポリシーを有効にするかどうか
providerEntityType
■ type: string
■ 説明:プロバイダーのエンティティタイプ。このプロパティは、ポリシー タイプが MUST_RUN_TOGETHER または MUST_NOT_RUN_TOGETHER に設定されている場合にのみ適用されます。このフィールドは、ポリシーが尊重する必要のあるプロバイダー タイプ (たとえば、PhysicalMachine) で設定されます。
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
説明
ポート チャネルを記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
容量
■ 説明:キャパシティ値
■ StatValueApiDTO(477ページ)
■ 説明:平均、最小、最大、合計を含む
■ StatValueApiDTO(477ページ)
■ type: string
■ 説明:コモディティ統計に使用される単位。例:$/時
ポート
■ type: array
■ 説明:チャネル内のポートのリスト
■ – StatApiDTO(472ページ)
■ type: array
■ 説明:出力の生成に使用されるグループ化オプションを説明します
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
portChannels
■ type: array
■ 説明:ポート チャネル
■ – PortChannelApiDTO(427ページ)
■ type: array
■ 説明:独立したポート
説明
オプションパラメータ
type
■ type: string
■ 列挙型:['DISCOUNT', 'INCREASE']
値
■ 型:数値
■ format: float
説明
Inherits From
この DTO は FieldApiDTO(394 ページ)から継承します
必須パラメータ
fieldName
■ type: string
■ 説明:プリミティブフィールドの名前。
■ readOnly:True
説明
これは未指定のオブジェクトです。
説明
プローブを表すモデル。
必須パラメータ
category
■ type: string
■ 説明:プローブカテゴリ
ID
■ 型:整数
■ フォーマット:int64
■ 説明:プローブ ID。
タイプ
■ type: string
■ 説明:プローブタイプ。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
error
■ type: string
■ 説明:プローブ情報の収集中に予期しないエラーが発生しました
説明
プローブの特性を表すモデル
必須パラメータ
名前(name)
■ type: string
■ 説明:プローブプロパティ名。
値
■ type: string
■ 説明: プローブ プロパティ値。
オプションパラメータ
probeId
■ 型:整数
■ フォーマット:int64
■ 説明:プローブ ID。
targetId
■ 型:整数
■ フォーマット:int64
■ 説明:ターゲット id
説明
プローブプロパティの名前と値のペアを記述するモデル。
必須パラメータ
名前(name)
■ type: string
■ 説明:プローブプロパティ名。
値
■ type: string
■ 説明:プローブプロパティ値。
説明
製品の機能情報を説明するモデル。
オプションパラメータ
deploymentMode
■ type: string
■ 説明:展開モード、複数の UI ビューの非表示/表示、オプションに影響
■ 列挙型:['HYBRID_SAAS', 'SAAS', 'SERVER']
searchApiEnabled
■ type: boolean
■ 説明: 新しい検索 API の使用を制御します
jdbcHttpSessionEnabled
■ type: boolean
■ 説明:JDBC 永続 HTTP セッションの使用を制御します
レポート有効
■ type: boolean
説明
実行中の Workload Optimization Manager インスタンスに関するバージョン情報が含まれています。
オプションパラメータ
versionInfo
■ type: string
■ 例:"versionInfo": "Turbonomic Operations Manager 8.0.1-SNAPSHOT (Build \"20200922092548000\")
\"2020-09-22 20:10:04\"\n\naction-orchestrator: 8.0.1-SNAPSHOT\napi: 8.0.1-SNAPSHOT\nauth: 8.0.1- SNAPSHOT\ncost: 8.0.1-SNAPSHOT\nextractor: 8.0.1-SNAPSHOT\ngroup: 8.0.1-SNAPSHOT\nhistory: 8.0.1-SNAPSHOT\nmarket: 8.0.1-SNAPSHOT\nmediation-actionscript: 8.0.1-SNAPSHOT\nmediation- appdynamics: 8.0.1-SNAPSHOT\nmediation-appinsights: 8.0.1-SNAPSHOT\nmediation-aws: 8.0.1- SNAPSHOT\nmediation-awsbilling: 8.0.1-SNAPSHOT\nmediation-awscost: 8.0.1-SNAPSHOT\nmediation- azure: 8.0.1-SNAPSHOT\nmediation-azurecost: 8.0.1-SNAPSHOT\nmediation-azureea: 8.0.1-SNAPSHOT
\nmediation-azuresp: 8.0.1-SNAPSHOT\nmediation-azurevolumes: 8.0.1-SNAPSHOT\nmediation- dynatrace: 8.0.1-SNAPSHOT\nmediation-hpe3par: 8.0.1-SNAPSHOT\nmediation-hyperv: 8.0.1-SNAPSHOT
\nmediation-netapp: 8.0.1-SNAPSHOT\nmediation-nutanix: 8.0.1-SNAPSHOT\nmediation-oneview: 8.0.1- SNAPSHOT\nmediation-pure: 8.0.1-SNAPSHOT\nmediation-ucs: 8.0.1-SNAPSHOT\nmediation-vcenter: 8.0.1-SNAPSHOT\nmediation-vcenterbrowsing: 8.0.1-SNAPSHOT\nmediation-vmax: 8.0.1-SNAPSHOT
\nmediation-vmm: 8.0.1-SNAPSHOT\nplan-orchestrator: 8.0.1-SNAPSHOT\nrepository: 8.0.1-SNAPSHOT
\ntopology-processor: 8.0.1-SNAPSHOT"
■ 説明:さまざまな内部コンポーネントのバージョン情報を含む、バージョン情報を説明する複数行の文字列。
version
■ type: string
■ 例:8.0.1-スナップショット
■ 説明:メジャー バージョンとマイナー バージョンを含む Operations Manager 製品バージョン
ビルド
■ type: string
■ 例:20200922211058775
■ 説明:このデプロイメントに関連付けられたビルド番号。
commit
■ type: string
■ 例:1183dd2
■ 説明:このデプロイに関連付けられたコミット。
ブランチ
■ type: string
■ 例:8.0.1
■ 説明:このデプロイメントに関連付けられたブランチ。
gitDescription
■ type: string
■ 例:1183dd2bb8ebca3dbcaf708e0c323cabc7b8e352
■ 説明:このデプロイメントに関連付けられた特定のソース管理情報。
updates
■ type: string
■ 説明:利用可能なアップデートの説明です。XL にはまだ実装されていません。
marketVersion
■ 型:整数
■ フォーマット:int32
■ 例:2
■ 説明:マーケットのバージョン
apiVersion
■ type: string
■ 例:3.1
■ 説明:REST API のバージョン。
説明
RI を購入するための一連の好みを説明するモデル
必須パラメータ
cloudType
■ type: string
■ 説明:クラウドタイプ
■ 列挙型:['AWS', 'AZURE', 'GCP', 'HYBRID', 'UNKNOWN']
paymentOption
■ type: string
■ 説明:優先支払いオプション
■ 列挙型:['ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT']
reservedInstanceType
■ type: string
■ 説明:優先オファリングクラス(標準またはコンバーチブル)
■ 列挙型:['STANDARD', 'CONVERTIBLE']
termYears
■ 型:整数
■ フォーマット:int32
■ 説明:優先期間の年数
説明
入力クエリを記述するモデル
必須パラメータ
クエリ
■ type: string
■ 説明:クエリ文字列。この形式は、選択した QueryType によって異なります。たとえば、REGEX QueryType の場合、これは正規表現である必要があります。
type
■ type: string
■ 説明:クエリタイプ
■ 列挙型:['EXACT', 'REGEX', 'CONTAINS']
オプションパラメータ
caseSensitive
■ type: boolean
■ 説明:true の場合、クエリ文字列は大文字と小文字の区別に一致します。このフィールドは、QueryType が REGEX でない場合にのみ使用されます。
説明
Inherits From
この DTO は ActionDetailsApiDTO(342 ページ)から継承します。
オプションパラメータ
estimatedOnDemandCost
■ 型:数値
■ フォーマット:float
estimatedRICoverage
■ 型:数値
■ フォーマット:float
historicalDemandDataset
■ type: array
■ – StatSnapshotApiDTO(476ページ)
■ type: string
説明
Inherits From
この DTO は、SettingApiDTO(468 ページ)から継承します。
必須パラメータ
値
■ 説明:ReservedInstancePurchaseSettingsDTO タイプの RI 購入プロファイルの値。
オプションパラメータ
defaultValue
■ 説明:変更前のデフォルト値
■ readOnly:True
■ ReservedInstancePurchaseSettingsDTO(448ページ)
説明
設定値の範囲を表すモデル
オプションパラメータ
step
■ 型:数値
■ フォーマット:double
■ 説明:スライダーのステップスケール係数
ラベル
■ type: array
■ 説明:スライダーの値に表示するラベル
■ – 型:文字列
customStepValues
■ type: array
■ 説明:スライダー ステップが一定でない場合のカスタム ステップ値 - [非推奨 - 使用: stepValues]
■ – 型:整数
– フォーマット:int32
stepValues
■ type: array
■ 説明: スライダー ステップが一定でない場合のカスタム ステップ値
■ - タイプ:数値
– フォーマット:float
説明
入力範囲を表すモデル。minValue または maxValue のいずれかを定義する必要があります。
オプションパラメータ
minValue
■ 型:数値
■ フォーマット:float
■ 説明: 入力範囲の最小値
maxValue
■ 型:数値
■ フォーマット:float
■ 説明:入力範囲の最大値
説明
料金表を表すモデル。
必須パラメータ
info
■ 説明:このレート表に関連するビジネスユニット UUID のリスト。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
type
■ type: string
■ 説明:レート表のタイプ"、例 = "AWS、Azure"
■ 列挙型:['AWS', 'AZURE', 'GCP', 'HYBRID', 'UNKNOWN']
関連
■ 説明:このレート表に関連するビジネスユニットのリスト。
■ RateCardRelatedApiDTO(437ページ)
■ 説明:料金表の検証。
■ RateCardValidationApiDTO(437ページ)
■ type: boolean
デフォルト
■ type: boolean
fileName
■ type: string
説明
レート表の属性を説明するモデル。
必須パラメータ
businessUnitsIds
■ type: array
■ 説明:この料金表に関連付けられているビジネスユニットのリスト。
■ – 型:文字列
説明
この料金表の関連するビジネスユニットを説明するモデル。
オプションパラメータ
businessUnits
■ type: array
■ 説明:料金表に関連するビジネスユニットのリスト
■ – BusinessUnitApiDTO(357ページ)
説明
RateCard を検証するモデル
オプションパラメータ
名前(name)
■ type: string
■ 説明:レート表ファイルの名前
status
■ type: string
■ 例:VALID, INVALID
■ 説明:検証ステータス
■ 列挙型:['VALID', 'INVALID']
message
■ type: string
■ 例:検証は成功しました、検証は失敗しました
■ 説明:検証の失敗または成功の理由。
説明
エラーに対する単一の推奨事項の DTO。
必須パラメータ
説明
■ type: string
■ 説明:問題を調査/軽減するために推奨されるユーザー アクション。
errorType
■ type: string
■ 説明:この推奨事項が作成された問題。
説明
Inherits From
この DTO は ActionDetailsApiDTO(342 ページ)から継承します。
オプションパラメータ
vcpuBefore
■ 型:整数
■ フォーマット:int32
■ 説明:変更前の vCPU
vcpuAfter
■ 型:整数
■ フォーマット:int32
■ 説明:変更後の vCPU
socketsBefore
■ 型:整数
■ フォーマット:int32
■ 説明:変更前のソケット
socketsAfter
■ 型:整数
■ フォーマット:int32
■ 説明:変更後のソケット
coresPerSocketBefore
■ 型:整数
■ フォーマット:int32
■ 説明:変更前のソケットあたりのコア数
coresPerSocketAfter
■ 型:整数
■ フォーマット:int32
■ 説明:変更後のソケットあたりのコア数
説明
設定ポリシーのスケジュールを記述するモデル
必須パラメータ
type
■ type: string
■ 説明:繰り返しのタイプ、列挙: DAILY、WEEKLY、MONTHLY
■ 列挙型:['DAILY', 'WEEKLY', 'MONTHLY']
オプションパラメータ
daysOfWeek
■ type: array
■ 説明:繰り返しが発生する曜日。繰り返しのタイプが WEEKLY である場合、またはタイプが MONTHLY であり、毎月の繰り返しの週が設定されている場合は必須です。
■ – 型:文字列
– 列挙型:['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']
daysOfMonth
■ type: array
■ 説明:繰り返しタイプが MONTHLY の場合、毎月の繰り返しを適用する日付
■ – 型:整数
– フォーマット:int32
weekOfTheMonth
■ type: array
■ 説明:繰り返しタイプが MONTHLY の場合、繰り返しを適用する月の週。の値
-1 は先週を示し、0 は今週を示します。
■ – 型:整数
– フォーマット:int32
間隔
■ 型:整数
■ フォーマット:int32
■ 説明:繰り返しタイプに基づく繰り返しの頻度。たとえば、繰り返しタイプが MONTHLY の間隔「2」は 2 か月ごとに発生します。
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
緯度
■ 型:数値
■ フォーマット:double
■ 説明:物理的な位置を特定するために経度とともに使用される地域の緯度。
経度
■ 型:数値
■ フォーマット:double
■ 説明:物理的な位置を特定するために緯度とともに使用される地域の経度。
numWorkloads
■ 型:整数
■ フォーマット:int32
■ 説明:このリージョンのワークロード(VM、データベースなど)の数。
説明
2 つのアクション間の関係を記述するモデル
オプションパラメータ
action
■ 説明:関連するアクションの基本アクション DTO
■ BasicActionApiDTO(355ページ)
■ type: string
■ 説明:アクション関係タイプ
■ 列挙型:['BLOCKED_BY', 'BLOCKING', 'CAUSED_BY', 'CAUSING']
説明
Inherits From
必須パラメータ
財産
■ type: string
■ 説明:対象となる関連エンティティ プロパティ。
■ readOnly:True
■ 列挙型:['NAMES', 'COUNT']
relatedEntityTypes
■ type: string
■ 説明:対象となる関連エンティティのタイプ。
■ readOnly:True
■ 列挙型:['Application', 'ApplicationComponent', 'ApplicationServer', 'AvailabilityZone', 'BusinessAccount', 'BusinessApplication', 'BusinessTransaction', 'BusinessUser', 'Chassis', 'CloudService', 'ComputeTier', 'Container', 'ContainerPod', 'ContainerSpec', 'Database', 'DatabaseServer', 'DatabaseServerTier', 'DatabaseTier', 'DataCenter', 'DesktopPool', 'DiskArray', 'DPod', 'HCIPhysicalMachine', 'HypervisorServer', 'Internet', 'IOModule', 'LoadBalancer', 'LogicalPool', 'Namespace', 'Network', 'PhysicalMachine', 'ProcessorPool', 'Region', 'ReservedInstance', 'Service', 'ServiceProvider', 'Storage', 'StorageController', 'StorageTier', 'Switch', 'Unknown', 'ViewPod', 'VirtualApplication', 'VirtualDataCenter', 'VirtualMachine', 'VirtualVolume', 'VPod', 'WorkloadController', 'ContainerPlatformCluster', 'VMSpec', 'CloudCommitment', 'ApplicationComponentSpec', 'VirtualMachineSpec']
説明
Inherits From
この DTO は FieldApiDTO(394 ページ)から継承します
必須パラメータ
財産
■ type: string
■ 説明:関連するグループ プロパティ。
■ readOnly:True
■ 列挙型:['NAMES', 'COUNT']
relatedGroupType
■ type: string
■ 説明:関連する関心のあるグループのタイプ。
■ readOnly:True
■ 列挙型:['Group', 'Resource', 'Cluster', 'VMCluster', 'StorageCluster', 'BillingFamily', 'NodePool']
説明
シナリオの圧力緩和の変化を説明するモデル: 過剰に使用されたクラスタに対する圧力を緩和する最小量のアクション移動
オプションパラメータ
projectionDay
■ 型:整数
■ フォーマット:int32
■ 説明:投影日、いつ変更を適用するかを示します
送信元
■ type: array
■ 説明:変更のソース、過負荷になっているクラスタのリスト
■ – BaseApiDTO(353ページ)
■ type: array
■ 説明:変更の宛先、VM が移動できるクラスタのリスト
説明
シナリオの制約変更を記述するモデル
オプションパラメータ
constraintType
■ type: string
■ 説明: 削除する制約のタイプ。すべての制約を無視するには、AllCommodities を使用します。これにより、Network/Cluster/StorageCluster/DC だけでなく、すべての制約が無視されます。GlobalIgnoreConstraint - 非推奨 - 代わりに AllCommodities を使用してください。
■ 列挙型:['DataCenterCommodity', 'ClusterCommodity', 'NetworkCommodity', 'DatastoreCommodity', 'StorageClusterCommodity', 'GlobalIgnoreConstraint', 'AllCommodities']
projectionDay
■ 型:整数
■ フォーマット:int32
■ 説明:投影日、いつ変更を適用するかを示します
ターゲット
■ 説明:計画範囲に適用される変更が提供されていない場合の変更の対象
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:制約構成で対象とする EntityType
■ 列挙型:['VirtualMachine', 'Container', 'ContainerPod']
説明
シナリオの削除変更を説明するモデル
オプションパラメータ
projectionDay
■ 型:整数
■ フォーマット:int32
■ 説明:投影日、いつ変更を適用するかを示します
targetEntityType
■ type: string
■ 説明:グループ ターゲットから削除するエンティティのタイプ
ターゲット
■ 説明:変更の対象、エンティティまたはグループ
説明
シナリオの移行変更を説明するモデル
オプションパラメータ
projectionDay
■ 型:整数
■ フォーマット:int32
■ 説明:投影日、いつ変更を適用するかを示します
ターゲット
■ 説明:変更の対象、エンティティまたはグループ
■ BaseApiDTO(353ページ)
■ 説明:置換に使用されるテンプレート
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:グループ ターゲットから削除するエンティティのタイプ
説明
テンプレートを配置できる場所を制限する予約の実行時にユーザーが指定した制約。
必須パラメータ
constraintType
■ type: string
■ 説明:制約のタイプ
■ 列挙型:['CLUSTER', 'DATA_CENTER', 'VIRTUAL_DATA_CENTER', 'POLICY', 'NETWORK']
uuid
■ type: string
■ 説明:制約の UUID
オプションパラメータ
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
説明
予約失敗時の失敗情報
必須パラメータ
closestSeller
■ 説明:要件を満たすのに最も近かったプロバイダー
■ BaseApiDTO(353ページ)
■ 説明:最も近いプロバイダーのクラスタ情報
■ BaseApiDTO(353 ページ)
■ 型:数値
■ フォーマット:double
■ 説明:closestSeller で利用可能なリソースの量
quantityRequested
■ 型:数値
■ フォーマット:double
■ 説明:要求されたリソースの量
リソース
■ type: string
■ 説明:最も制約のあるリソース
timespan
■ type: string
■ 説明:失敗は過去または現在にあります
■ 列挙型:['HISTORICAL', 'CURRENT', 'PROJECTED', 'PLAN_SOURCE', 'PLAN_PROJECTED']
オプションパラメータ
units
■ type: string
■ 説明:リソースの単位
説明
予約が無効な理由
オプションパラメータ
無効な理由
■ type: string
■ 説明:予約が無効な理由
■ 列挙型:['MARKET_CONNECTIVITY_ERROR', 'MARKET_NOT_READY', 'INVALID_CONSTRAINTS']
説明
予約済みインスタンスを記述するモデル
必須パラメータ
cloudType
■ type: string
■ 説明:クラウドタイプ
■ 列挙型:['AWS', 'AZURE', 'GCP', 'HYBRID', 'UNKNOWN']
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
テンプレート
■ 説明:関連テンプレート
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:プラットフォーム名
■ 列挙型:['UNKNOWN', 'LINUX', 'RHEL', 'SUSE', 'WINDOWS', 'WINDOWS_WITH_SQL_STANDARD', 'WINDOWS_WITH_SQL_WEB', 'WINDOWS_WITH_SQL_SERVER_ENTERPRISE', 'LINUX_WITH_SQL_STANDARD', 'LINUX_WITH_SQL_WEB', 'LINUX_WITH_SQL_SERVER_ENTERPRISE']
type
■ type: string
■ 説明:予約済みインスタンスタイプ
■ 列挙型:['STANDARD', 'CONVERTIBLE']
場所
■ 説明:場所、ゾーンが利用できない場合はゾーンまたはデータセンター
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:アカウント ID
accountDisplayName
■ type: string
■ 説明:アカウントの表示名
targetId
■ type: string
■ 説明:アカウントに関連付けられたターゲット ID
マスターアカウントID
■ type: string
■ 説明:マスターアカウント ID
term
■ 説明:期間、単位は年
■ StatApiDTO(472ページ)
■ type: string
■ 説明:支払いオプション
■ 列挙型:['ALL_UPFRONT', 'PARTIAL_UPFRONT', 'NO_UPFRONT']
onDemandPrice
■ 説明:オンデマンド価格、節約は RI 価格からオンデマンド価格を引いたものです
■ StatApiDTO(472ページ)
■ 説明:月々の総費用
■ StatApiDTO(472ページ)
■ 説明:クーポンと使用済みクーポンの合計、使用率 = numOfCouponsUsed / numOfCoupons
■ StatApiDTO(472ページ)
■ 型:数値
■ フォーマット:float
■ 説明:vm が一致した cbtp によって提供される合計クーポン
expDate
■ type: string
■ 説明:有効期限
instanceCount
■ 型:整数
■ フォーマット:int32
■ 説明:同じタイプ、テンプレート、プラットフォームなどの予約済みインスタンスの数。
tenancy
■ type: string
■ 説明:テナント
■ 列挙型:['DEFAULT', 'DEDICATED', 'HOST']
upFrontCost
■ 型:数値
■ フォーマット:double
■ 説明:前払い費用
actualHourlyCost
■ 型:数値
■ フォーマット:double
■ 説明:実際の時間あたりのコスト
effectiveHourlyCost
■ 型:数値
■ フォーマット:double
■ 説明:1 時間あたりの実効コスト
isExpired
■ type: boolean
■ 説明:指定された日付までに RI が期限切れになるかどうか
expDateEpochTime
■ 型:整数
■ フォーマット:int64
■ 説明:エポック時間での有効期限
scopeType
■ type: string
■ 説明:RI 範囲が単一または共有かどうか(Azure)
■ 列挙型:['SINGLE', 'SHARED', 'UNKNOWN']
appliedScopes
■ type: array
■ 説明:適用された範囲 UUID のリスト - 範囲が Single の場合にのみ提供されます(Azure)
■ – 型:文字列
orderID
■ type: string
■ 説明:RIのオーダー ID(Azure)
trueID
■ type: string
■ 説明:RI の ID
coveredEntityCount
■ 型:整数
■ フォーマット:int32
■ 説明:予約済みインスタンスでカバーされるワークロード エンティティの数
undiscoveredAccountsCoveredCount
■ 型:整数
■ フォーマット:int32
■ 説明:予約インスタンスでカバーされている未検出のアカウントの数
toBuy
■ type: boolean
sizeFlexible
■ type: boolean
説明
オプションパラメータ
awsProfile
■ PurchaseProfileDTO(433 ページ)
説明
サイズ変更アクションの詳細の親クラス。実装クラスには、CloudResizeActionDetailsApiDTO が含まれます。
必須パラメータ
actionDetailType
■ type: string
actionType
■ type: string
オプションパラメータ
subType
■ type: string
説明
テンプレートのリソースを記述するモデル
オプションパラメータ
stats
■ type: array
■ 説明:統計(CPU の数、メモリサイズ、ディスクサイズなど)
type
■ type: string
■ 説明:リソースのタイプ
テンプレート
■ type: string
■ 説明:リソースを満たすために使用されるテンプレート
relatedResources
■ type: array
■ 説明:このリソースに関連するリソースの ID
■ – 型:文字列
linkedResources
■ type: array
■ 説明:このリソースに関連するリソース。今のところ、これにはクラスタのみが含まれます
説明
Inherits From
この DTO は GroupApiDTO(396 ページ)から継承します。
オプションパラメータ
parentUuid
■ type: string
■ 説明:リソース グループが属する親ビジネス アカウント uuid(Azure のサブスクリプションなど)。
parentDisplayName
■ type: string
■ 説明:リソースグループが属する親ビジネスアカウントの表示名(Azure のサブスクリプションなど)。
説明
ユーザー ロールを説明するモデルで、Ops に対するユーザーの権限を説明します。Manager capabilities
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
名前(name)
■ type: string
■ 説明:ロールの名前
説明
SAML IDP を記述するモデル。IDP URL が含まれており、SAML のみが有効になっているかどうか。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
idpURL
■ type: string
■ 説明:SAML IDP URL
isSingleLogoutEnabled
■ type: boolean
isSAMLOnly
■ type: boolean
説明
Inherits From
オプションパラメータ
displayName
■ type: string
■ 説明:表示名
名前(name)
■ type: string
■ 説明:名前
productName
■ type: string
■ 説明:製品名
productType
■ type: string
■ 説明:製品タイプ
deviceId
■ type: string
■ 説明:デバイス ID
デバイス名
■ type: string
■ 説明:デバイス名
externalNames
■ type: array
■ 説明:外部名
■ – 型:文字列
altName
■ type: string
■ 説明:代替名
ssdDiskCount
■ 型:整数
■ フォーマット:int64
■ 説明:SSD ディスク数
rpm7200DiskCount
■ 型:整数
■ フォーマット:int64
■ 説明:RPM 7200 ディスク数
rpm10KDiskCount
■ 型:整数
■ フォーマット:int64
■ 説明:RPM 10K ディスク数
rpm15KDiskCount
■ 型:整数
■ フォーマット:int64
■ 説明:RPM 15K ディスク数
getvSeriesDiskCount
■ 型:整数
■ フォーマット:int64
■ 説明:VSeries ディスク数
ssdDiskIOPSCapacity
■ 型:数値
■ フォーマット:double
■ 説明:SSD Disk IOPS キャパシティ
rpm7200DiskIOPSCapacity
■ 型:数値
■ フォーマット:double
■ 説明:RPM 7200 ディスク IOPS キャパシティ
rpm10KDiskIOPSCapacity
■ 型:数値
■ フォーマット:double
■ 説明:RPM 10K ディスク IOPS キャパシティ
rpm15KDiskIOPSCapacity
■ 型:数値
■ フォーマット:double
■ 説明:RPM 15K ディスク IOPS キャパシティ
getvSeriesDiskIOPSCapacity
■ 型:数値
■ フォーマット:double
■ 説明: VSeries ディスク IOPS キャパシティ
technologyType
■ type: string
■ 説明:HCI テクノロジータイプ
rawCapacity
■ 型:整数
■ フォーマット:int64
■ 説明:HCI Raw キャパシティ
rawFreespace
■ 型:整数
■ フォーマット:int64
■ 説明:HCI Raw フリースペース
rawUncommitted
■ 型:整数
■ フォーマット:int64
■ 説明:HCI Raw 未コミット
redundancyMethod
■ type: string
■ 説明:HCI 冗長方式
failuresToTolerate
■ 型:整数
■ フォーマット:int32
■ 説明:許容できる HCI 障害
spaceReservationPct
■ 型:整数
■ フォーマット:int32
■ 説明:HCI スペース予約率
説明
変更のリストで構成される仮説シナリオを説明するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
所有者
■ type: array
■ 説明:シナリオを所有するユーザー
type
■ type: string
■ 説明:シナリオのタイプ
scope
■ type: array
■ 説明: 範囲を定義するエンティティ/グループのリスト
■ – BaseApiDTO(353ページ)
■ type: array
■ 説明:シナリオをいつ実行するかを定義する日のリスト
■ – 型:整数
– フォーマット:int32
topologyChanges
■ 説明:プランマーケットのトポロジに適用する変更
■ TopologyChangesApiDTO(495ページ)
■ 説明:シナリオにおけるワークロード使用率の変化
■ LoadChangesApiDTO(407ページ)
■ 説明:シナリオの構成変更
変更
■ type: array
■ 説明: シナリオを説明する変更のリスト - [非推奨 - EOL: 8.9.1 - 使用: loadChanges、configChanges]
■ – ScenarioChangeApiDTO(454ページ)
■ TimeBasedTopologyChangesApiDTO(494ページ)
説明
シナリオの変更を説明するモデル(エンティティの追加/削除/置換、使用率の変更、ワークロードポリシーの追加/削除など) - [非推奨 - EOL: 8.9.1]
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
index
■ 型:整数
■ フォーマット:int32
■ 説明: 変更を識別するために使用されるインデックス、削除時に使用される
type
■ type: string
■ 説明: タイプ
■ 列挙型: ['ADDED'、'REMOVED'、'REPLACED'、'CONSTRAINTCHANGED'、'DISABLED'、'ENABLED'、'SET'、'ADD_HIST'、'INCLUDE_RESERVED'、'SET_HIST_BASELINE'、'SET_PEAK_BASE_LINED'、''、「SET_UTILIZATION」、「SET_ACTION_SETTING」、「SET_WORKLOAD_PLACEMENT」、「SET_MAX_UTILIZATION」]
説明
■ type: string
■ 説明: 説明、例えば、追加された n 個のエンティティ、削除されたワークロード ポリシー
mergeType
■ type: string
■ 説明: タイプが SET_WORKLOAD_PLACEMENT の場合に使用されるマージ タイプ
■ 列挙型: ['Cluster'、'StorageCluster'、'Datacenter'、'DesktopPool']
対象
■ type: array
■ 説明: 変更の影響を受けるエンティティ/グループのリスト
値
■ type: string
■ 説明: タイプ ADDED の場合: 追加するカウント、SET_USED の場合、増分/減分するユーティリティの割合、SET_UTILIZATION の場合、使用率の最大割合、SET_HIST_BASELINE の場合: ベースラインをロードする時間、SET_PEAK_BASELINE の場合: ピーク ベースラインをロードする時間、CONSTRAINTCHANGED の場合: true/false、SET_WORKLOAD_PLACEMENT の場合:ADDED、NABLED、DISABLED、REMOVED
イネーブル化
■ type: boolean
■ 説明: タイプ ADD_HIST、INCLUDE_RESERVED、ENABLE、DISABLED の場合に使用
容量
■ タイプ:数字
■ フォーマット: フロート
■ 説明: タイプが SET_WORKLOAD_PLACEMENT および policyType AT_MOST_N_BOUND の場合に使用される、配置エンティティごとに同時に最大のワークロード エンティティを示します。
センター
■ 型:数値
■ フォーマット: フロート
■ 説明: タイプが SET の場合に使用される Desired state Center のパーセンテージ
diameter
■ 型:数値
■ フォーマット: フロート
■ 説明: タイプが SET の場合に使用される、望ましい状態の直径のパーセンテージ
名前(name)
■ type: string
■ 説明: タイプ SET_WORKLOAD_PLACEMENT の場合: ポリシー名、CONSTRAINTCHANGED の場合: コモディティ名 (All、DataCenterCommodity、ClusterCommodity、NetworkCommodity、DatastoreCommodity、StorageClusterCommodity、GlobalIgnoreConstraint)
maxUtilType
■ type: string
■ 説明: タイプが SET_MAX_UTILIZATION の場合に使用されるコモディティのタイプ
policyType
■ type: string
■ 説明: ポリシーのタイプ
■ 列挙型: [「AT_MOST_N」、「BIND_TO_GROUP」、「BIND_TO_COMPLEMENTARY_GROUP」、「MUST_RUN_TOGETHER」、「AT_MOST_N_BOUND」、「MERGE」、「BIND_TO_GROUP_AND_LICENSE」]
scope
■ type: array
■ 説明: シナリオの範囲を説明するエンティティ/グループのリスト
projectionDays
■ type: array
■ 説明: 予測期間のリスト、いつプランマーケットを実行するかを示します
■ – タイプ:整数
– フォーマット:int32
説明
設定ポリシーのスケジュールを記述するモデル
必須パラメータ
endTime
■ type: string
■ フォーマット:日付-時刻
■ 例:2019-04-04T19:15
■ 説明: ISO8601 のスケジュールされた期間の終了時刻(時間と分)。たとえば、2019-04-04T19:15
startDate
■ type: string
■ フォーマット:日付-時刻
■ 例:2019-04-04T19:15
■ 説明: ISO8601 フォーマット (YYYY-MM-DDTHH:MM:SS) を使用して表される、スケジュール期間の開始日。この日付は、インスタンスのタイムゾーンにローカルです。
startTime
■ type: string
■ フォーマット:日付-時刻
■ 例: 2019-04-04T19:15
■ 説明: ISO8601 のスケジュールされた期間の開始時刻 (時間と分)。たとえば、2019-04-04T17:15
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
endDate
■ type: string
■ フォーマット: 日付
■ 例: 2019-04-04
■ 説明: ISO8601 フォーマット(YYYY-MM-DDTHH:MM:SS)を使用して表される、スケジュール期間の終了日。この日付は、インスタンスのタイムゾーンにローカルです。
recurrence
■ 説明: 繰り返し設定
■ RecurrenceApiDTO(439 ページ)
■ type: string
■ 説明: tz データベースに基づくタイムゾーン名
nextOccurrence
■ type: string
■ 説明: ISO8601 現地時間 (YYYY-MM-DDTHH:MM:SS) で表された、このスケジュールの次回の発生日時。たとえば、2019-04-04T19:15
nextOccurrenceTimestamp
■ 型:整数
■ フォーマット:int64
■ 説明: ミリ秒単位のタイムスタンプで表される、このスケジュールが次に発生する日時。たとえば、1562100619000
remaingTimeActiveInMs
■ 型:整数
■ フォーマット:int64
■ 説明: 呼び出し時にスケジュールがアクティブになる時間 (ミリ秒)。スケジュールが現在アクティブでない場合、このフィールドは入力されません。
説明
一時停止可能なエンティティへの/からのアタッチ/デタッチのタイム スパン スケジュールの応答を表します
オプションパラメータ
error
■ type: string
■ 例: entityUuid が見つかりません
■ 説明:失敗の理由を示すエラー
entityUUID
■ type: string
説明
ScheduleItem を記述する基本モデル。
必須パラメータ
type
■ type: string
■ 例: SuspendItemApiDTO
■ 説明: ScheduleItem タイプの識別子。返される ScheduleItem のサブクラスについて説明します。
説明
休止期間範囲スケジュール
必須パラメータ
適用期間
■ 説明: 毎週のスケジュールの時間範囲
■ TimeSpanGroupApiDTO (495ページ)
timeZone
■ type: string
■ example: America/New_York
■ 説明: このスケジュールの期間のタイムゾーン。ここの IANA タイムゾーン データベースから選択する必要があります: [https://www.iana.org/time-zones]。ここのウィキペディアのリストを参照してください:[https://en.wikipedia.org/wiki/List_of_tz_database_time_zones]
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
説明
■ type: string
■ 例: 平日は 7 ~ 5 アップ
■ 説明:スケジュールの説明
説明
UUID でリクエストを記述するモデル
必須パラメータ
uuids
■ type: array
■ 説明: uuid のリスト
■ – 型:文字列
■ 最大項目数:2147483647
■ minItems:1
オプションパラメータ
marketId
■ type: string
■ 説明:リクエストされたアイテムに関連付けられたマーケット ID
説明
トポロジ全体 (エンティティおよびグループ) を検索するために使用されるクエリ
必須パラメータ
select
■ 説明:返されるタイプ (エンティティおよびグループ) のサブセットを定義します。
■ readOnly:True
■ 説明:取得された各オブジェクトが満たす必要がある条件 (現在、名前のみがサポートされています)。
■ readOnly:True
オプションパラメータ
ページネーション
■ 説明: ページネーション情報。
■ readOnly:True
説明
エンティティの数。
必須パラメータ
count
■ 型:整数
■ フォーマット:int32
■ 説明:エンティティの数。
■ readOnly:True
"groupBy": [
■ type: array
■ 説明:このカウントが表す groupBys を説明するフィールドのリスト
■ readOnly:True
説明
エンティティまたはグループに関する情報を含むレコード。
必須パラメータ
oid
■ 型:整数
■ フォーマット:int64
■ 説明:エンティティまたはグループの一意の識別子。
■ readOnly:True
値
■ type: array
■ 説明:エンティティまたはグループに関する情報。
■ readOnly:True
説明
タイプ(エンティティおよびグループ)のどのサブセットを返すかの指定。
オプションパラメータ
entityTypes
■ type: array
■ 説明: 応答に含めるエンティティタイプ。
■ readOnly:True
■ – 型:文字列
– enum: ['Application'、'ApplicationComponent'、'ApplicationServer'、'AvailabilityZone'、'BusinessAccount'、'BusinessApplication'、'BusinessTransaction'、'BusinessUser'、'Chassis'、'CloudService'、'ComputeTier'、'Container'、'ContainerPod'、'ContainerSpec'、'Database'、'DatabaseServer'、'DatabaseServerTier'、'DatabaseTier'、'DataCenter'、'DesktopPool'、'DiskArray'、'DPod'、'HCIPhysicalMachine'、'HypervisorServer'、' Internet'、'IOModule'、'LoadBalancer'、'LogicalPool'、'Namespace'、'Network'、'PhysicalMachine'、'ProcessorPool'、'Region'、'ReservedInstance'、'Service'、'ServiceProvider'、'Storage'、'StorageController'、'StorageTier'、'Switch'、'Unknown'、'ViewPod'、'VirtualApplication'、'VirtualDataCenter'、'VirtualMachine'、'VirtualVolume'、'VPod'、'WorkloadController'、'ContainerPlatformCluster'、' VMSpec'、'CloudCommitment'、'ApplicationComponentSpec'、'VirtualMachineSpec']
groupTypes
■ type: array
■ 説明: 応答に含めるグループ タイプ。
■ readOnly:True
■ – 型:文字列
– 列挙型: ['Group'、'Resource'、'Cluster'、'VMCluster'、'StorageCluster'、'BillingFamily'、'NodePool']
説明
エンティティ検索応答でフェッチする必要があるフィールドの指定。
必須パラメータ
entityType
■ type: string
■ 説明:エンティティ タイプ
■ readOnly:True
■ 列挙型:['Application'、'ApplicationComponent'、'ApplicationServer'、'AvailabilityZone'、'BusinessAccount'、'BusinessApplication'、'BusinessTransaction'、'BusinessUser'、'Chassis'、'CloudService'、'ComputeTier'、'Container'、'ContainerPod'、'ContainerSpec'、'Database'、'DatabaseServer'、'DatabaseServerTier'、'DatabaseTier'、'DataCenter'、'DesktopPool'、'DiskArray'、'DPod'、'HCIPhysicalMachine'、'HypervisorServer'、'Internet'、'IOModule'、'LoadBalancer'、'LogicalPool'、'Namespace'、'Network'、'PhysicalMachine'、'ProcessorPool'、'Region'、'ReservedInstance'、'Service'、'ServiceProvider'、'Storage'、'StorageController'、'StorageTier'、'Switch'、'Unknown'、'ViewPod'、'VirtualApplication'、'VirtualDataCenter'、'VirtualMachine'、'VirtualVolume'、'VPod'、'WorkloadController'、'ContainerPlatformCluster'、'VMSpec'、'CloudCommitment'、'ApplicationComponentSpec'、'VirtualMachineSpec']
オプションパラメータ
フィールド
■ type: array
■ 説明:フェッチするフィールド。
■ readOnly:True
説明
グループ検索応答で取得するフィールドの指定。
必須パラメータ
groupType
■ type: string
■ 説明: グループ タイプ。
■ readOnly:True
■ 列挙型: ['Group'、'Resource'、'Cluster'、'VMCluster'、'StorageCluster'、'BillingFamily'、'NodePool']
オプションパラメータ
フィールド
■ type: array
■ 説明:フェッチするフィールド。
■ readOnly:True
説明
エンティティを表すモデル(仮想マシン、物理マシン、ストレージなど)
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明:環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
discoveredBy
■ 説明:エンティティを発見したターゲット
■ TargetApiDTO(484ページ)vendorIds
■ type: object
■ 説明:リモート ターゲット上のこのエンティティのベンダー提供の ID へのターゲット識別子のマッピング
■ additionalProperties:{'type':'string'}
priceIndex
■ 型:数値
■ フォーマット:フロート
■ 説明: エンティティの価格指数
state
■ type: string
■ 説明:状態
■ 列挙型:['IDLE'、'RESOURCE_ALLOCATION'、'LAUNCH'、'ACTIVE'、'RESOURCE_RELEASE'、'SUSPEND'、'SUSPEND_PENDING'、'TERMINATE_PENDING'、'NOT_MONITORED'、'メンテナンス'、'FAILOVERN'、UN、'EVACUATED'、'QUEUED']
severity
■ type: string
■ 説明: このエンティティに関連するアクションの最も高い重大度
■ 列挙型: ['UNKNOWN'、'NORMAL'、'MINOR'、'MAJOR'、'CRITICAL']
unplacementDetails
■ 説明: プラン内の配置されていないエンティティに提供される追加情報
placedOn
■ type: string
■ 説明: 正常に配置されたエンティティのコンマ区切りの classNames。プランマーケットの配置されていないエンティティに使用されます - [非推奨 - 使用: unplacementDetails.placedOn]
notPlacedOn
■ type: string
■ 説明: エンティティのコンマ区切りの classNames を配置できませんでした。プランマーケットの配置されていないエンティティに使用されます - [非推奨 - 使用:unplacementDetails.reasons]
unplacedExplanation
■ type: string
■ 説明: エンティティを配置できなかった理由 - [非推奨 - 使用: unplacementDetails.reasons]
costPrice
■ 型:数値
■ フォーマット: フロート
■ 説明: 1 時間あたりの原価価格
severityBreakdown
■ type: object
■ 説明: 重大度とそのカウントのマップ。例: {CRITICAL:1、NORMAL:10}
■ 追加プロパティ:{'type':'integer', 'format': 'int64'}
remoteId
■ type: string
■ 説明: 検出されたリモート ターゲット上のこのインスタンスの識別子c - [非推奨 - 使用:vendorIds]
realtimeMarketReference
■ 説明:プランマーケット エンティティの場合、これにはリアルタイムマーケットからの元のエンティティが含まれます。
プロバイダー
■ type: array
■ 説明: プロバイダーのリスト
消費者
■ type: array
■ 説明: 消費者のリスト
テンプレート
■ 説明: 関連テンプレート
numRelatedVMs
■ 型:整数
■ フォーマット:int32
■ 説明: 関連する VM の数
接続されたエンティティ
■ type: array
■ 説明: サービス エンティティに関連する接続されたエンティティの限定されたリスト。これには、接続されたすべてのエンティティが含まれません。
■ – BaseApiDTO(353 ページ)
アスペクト
■ type: object
■ 説明: アスペクトとして分類されたエンティティに関する追加情報
■ additionalProperties:{'$ref':'#/definitions/EntityAspect'}
タグ
■ type: object
■ 説明:タグは、名前/値のペアで定義されるメタデータです。各名前には複数の値を指定できます。
■ additionalProperties:{'type': 'array', 'items': {'type': 'string'}}
onDemandRateBefore
■ 型:数値
■ フォーマット: フロート
■ 説明:アクション前のオンデマンド レート
onDemandRateAfter
■ 型:数値
■ フォーマット: フロート
■ 説明:アクション後のオンデマンド レート
staleness
■ type: string
■ 説明:[BETA]: エンティティが時代遅れかどうか、つまり、分析目的で検討するにはかなり前に発見されたかどうか
■ enum: ['CURRENT', 'STALE']
説明
オプションパラメータ
準備万端
■ type: boolean
説明
設定の値に影響を与える設定ポリシーを記述するモデル
必須パラメータ
numEntities
■ 型:整数
■ フォーマット:int32
■ 説明: 設定ポリシー値の影響を受けるエンティティの数
settingsPolicy
■ 説明: 設定の最終値に影響する設定ポリシー
値
■ type: string
■ 説明: 設定ポリシーで宣言された設定値
説明
設定を記述する一般的なモデル。サブタイプには、StringSettingApiDTO および RIPurchaseProfilesSettingApiDTO が含まれます。
必須パラメータ
値
■ 説明: 設定の値。「valueObjectType」フィールドで示されるタイプ。デフォルト タイプは「文字列」です
■ $ref:#/定義/オブジェクト
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
valueDisplayName
■ type: string
■ 説明:値がテンプレートまたは別のエンティティである場合の値の表示名
■ readOnly:True
defaultValue
■ 説明:変更前のデフォルト値
■ readOnly:True
■ $ref:#/定義/オブジェクト
カテゴリ
■ type: array
■ 説明: 設定のカテゴリとサブカテゴリ
■ readOnly:True
■ – 型:文字列
valueType
■ type: string
■ 説明: 値のタイプを定義します
■ 列挙型: ['STRING'、'NUMERIC'、'BOOLEAN']
valueObjectType
■ type: string
■ 説明:複合オブジェクト値のタイプ。デフォルトは '文字列' です。
■ 列挙型: ['文字列'、'ReservedInstancePurchaseSettingsDTO']
最低
最大
■ 型:数値
■ フォーマット: ダブル
■ 説明: タイプが NUMERIC の場合、これは最小制限を定義します
■ readOnly:True
■ 型:数値
■ フォーマット: ダブル
■ 説明: タイプが NUMERIC の場合、これは最大制限を定義します
■ readOnly:True
entityType
■ type: string
■ 説明: この設定のエンティティタイプ
range
■ 説明: 設定値の範囲オプション
■ readOnly:True
範囲
■ type: string
■ 説明:設定の可視性を定義します。EG ローカル設定は、エンティティ/グループに関連付けられている場合にのみ表示されます
■ readOnly:True
■ 列挙型: ['GLOBAL', 'LOCAL']
activeSettingsPolicies
■ type: array
■ 説明: この設定の最終値に影響を与える設定ポリシーのリスト
■ – SettingActivePolicyApiDTO(464ページ)
sourceGroupName
■ type: string
■ 説明: 設定値の送信元グループ名
sourceGroupUuid
■ type: string
■ 説明: 設定値の送信元グループ uuid
説明
設定を記述する一般的なモデル。サブタイプには、StringSettingApiDTO および RIPurchaseProfilesSettingApiDTO が含まれます。
必須パラメータ
値
■ 説明: 設定の値。`valueObjectType` フィールドで示されるタイプ。デフォルト タイプは `文字列` です
■ $ref:#/定義/オブジェクト
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
valueDisplayName
■ type: string
■ 説明: 値がテンプレートまたは別のエンティティである場合の値の表示名
■ readOnly:True
defaultValue
■ 説明:変更前のデフォルト値
■ readOnly:True
■ $ref:#/定義/オブジェクト
カテゴリ
■ type: array
■ 説明:設定のカテゴリとサブカテゴリ
■ readOnly:True
■ – 型:文字列
valueType
■ type: string
■ 説明:値のタイプを定義します
■ 列挙型:['STRING'、'NUMERIC'、'BOOLEAN']
valueObjectType
■ type: string
■ 説明: 複合オブジェクト値のタイプ。デフォルトは '文字列' です。
■ 列挙型: ['文字列'、'ReservedInstancePurchaseSettingsDTO']
オプション
■ type: array
■ 説明:この設定の許容値のリスト
■ readOnly:True
最低
■ 型:数値
■ フォーマット:ダブル
■ 説明:タイプが NUMERIC の場合、これは最小制限を定義します
■ readOnly:True
最大
■ 型:数値
■ フォーマット:ダブル
■ 説明:タイプが NUMERIC の場合、これは最大制限を定義します
■ readOnly:True
entityType
■ type: string
■ 説明:この設定のエンティティタイプ
range
■ 説明:設定値の範囲オプション
■ readOnly:True
■ type: string
■ 説明:設定の可視性を定義します。例:ローカル設定は、エンティティ/グループに関連付けられている場合にのみ表示されます
■ readOnly:True
■ 列挙型: ['GLOBAL', 'LOCAL']
activeSettingsPolicies
■ type: array
■ 説明: この設定の最終値に影響を与える設定ポリシーのリスト
■ – SettingActivePolicyApiDTO(464ページ)
sourceGroupName
■ type: string
■ 説明: 設定値の送信元グループ名
sourceGroupUuid
■ type: string
■ 説明: 設定値の送信元グループ uuid
説明
設定を記述する一般的なモデル。サブタイプには、StringSettingApiDTO および RIPurchaseProfilesSettingApiDTO が含まれます。
必須パラメータ
値
■ 説明: 設定の値。`valueObjectType` フィールドで示されるタイプ。デフォルト タイプは `文字列` です
■ $ref:#/定義/オブジェクト
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
valueDisplayName
■ type: string
■ 説明: 値がテンプレートまたは別のエンティティである場合の値の表示名
■ readOnly:True
defaultValue
■ 説明: 変更前のデフォルト値
■ readOnly:True
■ $ref:#/定義/オブジェクト
カテゴリ
■ type: array
■ 説明:設定のカテゴリとサブカテゴリ
■ readOnly:True
■ – 型:文字列
valueType
■ type: string
■ 説明:値のタイプを定義します
■ 列挙型:['STRING'、'NUMERIC'、'BOOLEAN']
valueObjectType
■ type: string
■ 説明: 複合オブジェクト値のタイプ。デフォルトは '文字列' です。
■ 列挙型:['文字列'、'ReservedInstancePurchaseSettingsDTO']
オプション
■ type: array
■ 説明:この設定の許容値のリスト
■ readOnly:True
最低
最大
■ 型:数値
■ フォーマット:ダブル
■ 説明:タイプが NUMERIC の場合、これは最小制限を定義します
■ readOnly:True
■ 型:数値
■ フォーマット:ダブル
■ 説明:タイプが NUMERIC の場合、これは最大制限を定義します
■ readOnly:True
entityType
■ type: string
■ 説明:この設定のエンティティタイプ
range
■ 説明:設定値の範囲オプション
■ readOnly:True
範囲
■ type: string
■ 説明:設定の可視性を定義します。EG ローカル設定は、エンティティ/グループに関連付けられている場合にのみ表示されます
■ readOnly:True
■ 列挙タイプ: ['GLOBAL', 'LOCAL']
activeSettingsPolicies
■ type: array
■ 説明: この設定の最終値に影響を与える設定ポリシーのリスト
■ – SettingActivePolicyApiDTO(464ページ)
sourceGroupName
■ type: string
■ 説明: 設定値のソースグループ名
sourceGroupUuid
■ type: string
■ 説明: 設定値の送信元グループ uuid
説明
オプションパラメータ
label
■ type: string
値
■ type: string
説明
設定のカテゴリ マネージャを記述するモデル
必須パラメータ
category
■ type: string
■ 説明:マネージャのカテゴリ
設定
■ type: array
■ 説明:マネージャ に含まれる設定のリスト
■ – SettingApiDTOSerializable(465ページ)
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
説明
設定ポリシーを記述するモデル:範囲および/またはスケジュールに基づいて適用される設定のグループ
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
entityType
■ type: string
■ 説明: 設定ポリシーのタイプ。例:VirtualMachine、PhysicalMachine、...
スコープ
■ type: array
■ 説明: 設定が適用される範囲のリストで、作成/編集時に Uuid のみが必要です。null の場合、グローバル 範囲と見なされます
settingsManagers
■ type: array
■ 説明:このポリシーでアクティブ化する設定のグループのリスト
■ – SettingsManagerApiDTO(470ページ)
スケジュール
■ 説明:設定がいつ適用されるかを定義するスケジュール
無効
■ type: boolean
■ 説明:ポリシーを有効にするか無効にするかを制御します
note
■ type: string
■ 説明:このポリシーに関する注意事項
readOnly
■ type: boolean
■ 説明:true の場合、ユーザーが SettingPolicy を削除または変更できないようにします。
デフォルト
■ type: boolean
説明
実行中にスキップされたアクションを説明するモデル。
必須パラメータ
actionId
■ type: string
■ 説明:アクション識別子
オプションパラメータ
reason
■ type: string
■ 説明:アクションがスキップされた理由
説明
統計を記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
名前(name)
■ type: string
■ 説明:名前
容量
■ 説明: 予約値、コモディティ統計に使用
予約済み
■ 説明: 予約値、コモディティ統計に使用
relatedEntityType
■ type: string
■ 説明:例:仮想マシン
filters
■ type: array
■ 説明:出力の生成に使用されるグループ化オプションを説明します
relatedEntity
■ 説明:統計のプロバイダーまたはコンシューマー、' relatedEntity' および ' numRelatedEntities' は相互に排他的です
numRelatedEntities
■ 型:整数
■ フォーマット:int32
■ 説明:この統計のプロバイダーまたはコンシューマの数、' relatedEntity' と 'numRelatedEntities' は相互に排他的です
units
■ type: string
■ 説明:コモディティ統計に使用される単位。例:$/時
値
■ 説明:平均、最小、最大、合計を含む
値
■ 型:数値
■ フォーマット: フロート
■ 説明:values.avg に等しい単純な値。
histUtilizations
■ type: array
■ 説明:コモディティの使用履歴値
■ – StatHistUtilizationApiDTO(475ページ)
説明
Stat の要求を記述するモデル
オプションパラメータ
名前(name)
■ type: string
■ 説明:統計の名前
relatedEntityTypes
■ type: string
■ 説明:{uuid} のサプライチェーン内のさまざまなエンティティタイプから統計を取得するために使用されます。範囲が PM である VM の EGcostPrice
filters
■ type: array
■ 説明:要求された統計に適用するフィルタ。コモディティでサポートされる値:key = {commodity_key}、relation = sales|bought、virtualDisk = {uuid}。コスト価格でサポートされる値:累積 = true|false、cloudService
= {uuid}、ターゲット = {uuid}、CSP = {name}、category = {name}、businessUnit = {uuid}、costComponent = COMPUTE|IP|LICENSE|STORAGE、costComponentArtifact = {key}。アクション統計でサポートされる値:actionTypes
= {actionType}、actionModes: {action_mode}、actionStates: {action_state}、riskSubCategory:パフォーマンス保証|効率の改善|防止|コンプライアンス、リスク重大度: UNKNOWN|NORMAL|MINOR|メジャー|クリティカル
groupBy
■ type: array
■ 説明: 統計の値に対して groupBy を実行します。コモディティでサポートされる値: key、relatedEntity、virtualDisk。コスト 価格でサポートされる値: cloudService、target、CSP、category、businessUnit、costComponent、costComponentArtifact。アクション統計でサポートされる値:actionTypes、actionModes、actionStates、リスク、riskSubCategory、riskSeverity
■ – 型:文字列
historyType
■ type: string
■ 説明:これらの historyTypes の histUtilization テーブルをクエリします。
■ 列挙型:['パーセンタイル'、'平滑化']
説明
統計に適用されるフィルタを説明するモデル
必須パラメータ
type
■ type: string
■ 説明:フィルタのタイプ、例: actionTypes、category、...
オプションパラメータ
値
■ type: string
■ 説明:フィルタの値
説明
NN 日間(最大)の観測期間にわたる VM の P95 vCPU または P95 vMEM など、使用率の履歴統計を記述するモデル。
オプションパラメータ
type
■ type: string
■ 説明:履歴使用タイプ
usage
■ 型:数値
■ フォーマット: フロート
■ 説明:履歴の使用状況
容量
■ 型:数値
■ フォーマット: フロート
■ 説明:履歴のキャパシティ
resizeMaxScalingObservationPeriod
■ 型:数値
■ フォーマット: フロート
■ 説明:最大スケーリング観測期間のサイズを変更します。アクション生成プロセスで考慮されるデータポイントの量に影響します。日単位の値。
resizeScalingAggressiveness
■ 型:数値
■ フォーマット: フロート
■ 説明: スケーリングのリサイズの積極性。リソース使用率に応じて、Workload Optimization Manager がどの程度積極的にサイズ変更するかを説明します。パーセント値。100% は最も積極的ではなく、95% で最も積極的です。
説明
時間範囲による統計のリクエストを記述するモデル
必須パラメータ
統計情報
■ type: array
■ 説明: 要求された統計のリスト。空の場合、すべての統計が処理されます
オプションパラメータ
startDate
■ type: string
■ 説明:フィルタリングする期間の開始時刻。空の場合、現在の統計が処理されます
endDate
■ type: string
■ 説明:フィルタリングする期間の終了時刻。空の場合、現在の統計が処理されます。
説明
複数の範囲での統計の要求を記述するモデル
オプションパラメータ
スコープ
■ type: array
■ 説明:範囲として使用する uuid のリスト
■ – 型:文字列
期間
■ 説明:リクエストされた統計のリスト
■ StatPeriodApiInputDTO(475ページ)
■ type: string
■ 説明: 範囲に関連するエンティティタイプの統計を取得します
説明
スナップショットの統計を説明するモデルで、一時的な統計のリストが含まれています
必須パラメータ
統計情報
■ type: array
■ 説明:統計のリスト(例: 価格指数、コモディティの値、原価価格、グループ内の VM の数など)
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
date
■ type: string
■ 説明: 統計が記録された時期
新時代
■ type: string
■ 説明:スナップショットが履歴、予測、またはプランデータを表しているかどうかの指標。この統計スナップショットのコンテキストを理解するには、日付フィールドと組み合わせて使用する必要があります。
■ 列挙型:['HISTORICAL', 'CURRENT', 'PROJECTED', 'PLAN_SOURCE', 'PLAN_PROJECTED']
説明
PM グループの CPU など、単一の統計を表すモデル
オプションパラメータ
max
min
avg
合計
■ タイプ:数値
■ フォーマット: フロート
■ 説明:最大値
■ 型:数値
■ フォーマット: フロート
■ 説明:最小値
■ 型:数値
■ フォーマット: フロート
■ 説明:平均値
■ 型:数値
■ フォーマット: フロート
■ 説明:合計値 - グループ内の平均値の合計
totalMax
■ 型:数値
■ フォーマット: フロート
■ 説明:合計最大値 - グループ内の最大値の合計
totalMin
■ 型:数値
■ フォーマット: フロート
■ 説明:合計最小値 - グループ内の最小値の合計
説明
これは未指定のオブジェクトです。
説明
Inherits From
この DTO は、SettingApiDTO(468 ページ)から継承します。
必須パラメータ
値
■ type: string
■ 説明: 設定の値。「valueObjectType」フィールドで示されるタイプ。デフォルト タイプは「文字列」です
オプションパラメータ
defaultValue
■ type: string
■ 説明: 変更前のデフォルト値
■ readOnly:True
説明
エンティティのフィルタを記述するモデル
必須パラメータ
ウイード
■ type: array
■ 説明:サプライチェーンの構築に使用される uid のリスト
■ – 型:文字列
■ 最大項目数:2147483647
■ minItems:1
オプションパラメータ
タイプ
■ type: array
■ 説明:フィルタリングするタイプのリスト
■ – 型:文字列
状態
■ type: array
■ 説明:フィルタリングする州のリスト
■ – 型:文字列
– 列挙型:['IDLE'、'RESOURCE_ALLOCATION'、'LAUNCH'、'ACTIVE'、'RESOURCE_RELEASE'、'SUSPEND'、'SUSPEND_PENDING'、'TERMINATE_PENDING'、'NOT_MONITORED'、'メンテナンス'、'FAILOVERN'、UN、'EVACUATED'、'QUEUED']
groupBy
■ type: array
■ 説明:統計をグループ化するために使用されるフィールドのリスト
■ – 型:文字列
– 列挙型:['entityType', 'state', 'severity', 'riskSubCategory', 'template', 'target', 'businessUnit', 'resourceGroup', 'nodePool']
environmentType
■ type: string
■ 説明:環境タイプでアクションをフィルタリングします
■ 列挙型:['ONPREM', 'CLOUD']
説明
サプライチェーンを記述するモデル: 環境は、生産者と消費者の間のチェーンとして記述されます
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
seMap
■ type: object
■ 説明:SupplyChainEntry に関連付けられたエンティティのタイプを説明するモデル
■ additionalProperties: {'$ref': '#/definitions/SupplychainEntryDTO'}
説明
サプライチェーンエントリを説明するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
depth
■ 型:整数
■ フォーマット:int32
■ 説明:サプライチェーンにおけるエンティティタイプの深さのレベルを示す番号
entitiesCount
■ 型:整数
■ フォーマット:int32
■ 説明:このレベルの深さのエンティティの数
healthSummary
■ type: object
■ 説明:重要度ごとのエンティティ数
■ additionalProperties: {'type': 'integer', 'format': 'int32'}
stateSummary
■ type: object
■ 説明:状態ごとのエンティティ数
■ additionalProperties: {'type': 'integer', 'format': 'int32'}
connectedProviderTypes
■ type: array
■ 説明:このレベルの深さに接続されているプロバイダータイプのリスト
■ uniqueItems: True
■ – 型:文字列
接続されたコンシューマータイプ
■ type: array
■ 説明:このレベルの深さに関連するコンシューマータイプのリスト
■ uniqueItems: True
■ – 型:文字列
インスタンス
■ type: object
■ 説明:このレベルの深さのエンティティのリスト
■ additionalProperties: {'$ref': '#/definitions/ServiceEntityApiDTO'}
説明
Inherits From
この DTO は、ScheduleItemApiDTO(457 ページ)から継承します。
必須パラメータ
state
■ type: string
■ 説明:期間中の予想される状態
■ 列挙型['IGNORE', 'ON', 'OFF']
説明
エンティティ
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明: 環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
accountOID
■ 型:整数
■ フォーマット:int64
■ 例:74613608411667
■ 説明:アカウントの一意の ID
accountName
■ type: string
■ 例:開発アカウント
■ 説明:アカウントの表示名
provider
■ type: string
■ 例:AWS
■ 説明:クラウド プロバイダーの名前
■ 列挙型: [「AWS」、「AZURE」、「GCP」、「ハイブリッド」、「不明」]
state
■ type: string
■ 例:STOPPED
■ 説明:エンティティの最後の既知の状態
■ 列挙型:['STOPPED', 'RUNNING', 'STARTING', 'STOPPING', 'TERMINATING', 'TERMINATED', 'MISSING']
suspendable
■ type: boolean
■ 例:True
■ 説明:エンティティを一時停止できるかどうかを示します
entityType
■ type: string
■ 例:COMPUTE
■ 説明:エンティティのタイプ
■ 列挙型:['VirtualMachine']
regionOID
■ 型:整数
■ フォーマット:int64
■ 例:74613608411668
■ 説明:エンティティが属する地域の一意の ID
regionName
■ type: string
■ 例:us-east-1
■ 説明:地域の名前
instanceType
■ type: string
■ 例:t3.micro
■ 説明:インスタンスのタイプ
コスト
■ 型:数値
■ フォーマット: ダブル
■ 例:10.24
■ 説明:エンティティのオンデマンドの時間あたりのコスト
タグ
■ type: array
■ 説明:エンティティに添付されたタグのリスト
オプションパラメータ
entityTypes
■ type: array
■ – 型:文字列
– 列挙型:['VirtualMachine']
status
■ type: array
■ – 型:文字列
– 列挙型:['STOPPED', 'RUNNING', 'STARTING', 'STOPPING', 'TERMINATING', 'TERMINATED', 'MISSING']
プロバイダー
■ type: array
■ 説明:サスペンションクラウドプロバイダー
■ – 型:文字列
– 列挙型: [「AWS」、「AZURE」、「GCP」、「ハイブリッド」、「不明」]
基準一覧
■ type: array
■ – FilterApiDTO(395ページ)
■ type: string
■ 説明:すべての基準に適用される論理演算子。「AND」、「OR」の値を取ることができます。省略した場合、デフォルトは「AND」です。
■ 列挙型:['AND', 'OR']
説明
一時停止可能なエンティティ uid のリスト
必須パラメータ
entity_uuid
■ type: array
■ 説明:一時停止可能なエンティティ uid のリスト
■ – 型:文字列
説明
タグ情報
オプションパラメータ
キー
■ type: string
■ 説明:タグキー
値
■ type: array
■ 説明:タグ値
■ – 型:文字列
説明
ターゲットを記述するモデル。ターゲットを使用してコンポーネントを検出し、接続された仮想環境を作成します
必須パラメータ
type
■ type: string
■ 説明:プローブタイプWorkload Optimization Manager には、次のプローブ タイプが付属しています:AppDynamics、Dynatrace、Datadog、Arista、AWS、Azure、Cisco APIC、Cisco HyperFlex、Cisco UCS Central、Cisco UCS Director、Cisco UCS Manager、CloudFoundry、CloudStack、Dell Compellent、EMC ScaleIO、EMC VMAX、EMC VNX、EMC VPLEX、EMC XtremIO、Hitachi Vantara、HP OneView、HPE 3PAR、Hyper-V、IBM PowerVM、Instana、JBoss、JVM、MSExchange、MySQL、NetApp、NetFlow、NetScaler、Nutanix、OpenStack、Oracle、Pivotal Ops Manager、Pure、Red Hat Virtualization Manager、sFlow、SNMP、SoftLayer、SQLServer、Tetration、Tomcat、vCenter、vCloudDirector、VMM、WebLogic、WebSphere、WMI、XenServer,
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
category
■ type: string
■ 例:ハイパーバイザ
■ 説明:プローブカテゴリ
uiCategory
■ type: string
■ 例: アプリケーションサーバー、課金、クラウド管理、アプリケーションとデータベース、ファブリックとネットワーク、ゲスト OS プロセス、ハイパーコンバージド、ハイパーバイザ、ロードバランサ、オペレーションマネージャアプライアンス、オーケストレータ、PaaS、ストレージ、ストレージブラウジング、WINDOWS アプリケーション。また、新しいプローブの開発に使用するカスタムと UNKNOWN のカテゴリもあります。
■ 説明:プローブ UI カテゴリ。
identifyingFields
■ type: array
■ 説明:同じカテゴリのプローブを区別するために使用されるフィールド名の配列。最も一般的なのは、名前/アドレス フィールド、またはアドレスとポートの組み合わせです。
■ – 型:文字列
inputFields
■ type: array
■ 説明:GUI のターゲット追加フォーム フィールドに類似した、ターゲットのすべての InputFieldApiDTO オブジェクトのリスト。
■ – InputFieldApiDTO(402ページ)
■ type: string
■ 説明:最後の検証の日付 - [非推奨 - 使用: healthSummary.timeOfLastSuccessfulDiscovery]
status
■ type: string
■ 例:検証済み、検証失敗、不明
■ 説明:最新の検証操作のステータスの説明 - [非推奨 - 使用: healthSummary.healthState]
derivedTargets
■ type: array
■ 説明:このターゲットから派生した(発見によって作成された)ターゲット。TargetRelationship パラメータに応じて入力されます。
■ – TargetApiDTO(484ページ)
■ type: array
■ 説明:このターゲットによってパッチされたターゲット
■ – PatchedTargetDataApiDTO(420ページ)
■ type: array
■ 説明:このターゲットを作成したターゲット。TargetRelationship パラメータに応じて入力されます。
■ – TargetApiDTO(484ページ)
■ type: boolean
■ 説明:パブリック API を介してターゲットを変更できないかどうか。
正常性
■ 説明:[BETA]: ターゲットの全体的な健全性の概要。TargetDetailLevel が HEALTH または HEALTH_DETAILS の場合にのみ返されます
■ TargetHealthApiDTO(486ページ)
■ type: array
■ 説明:[BETA]:最新の検証または発見の各段階でのステータス。TargetDetailLevel が HEALTH_DETAILS の場合にのみ返されます
■ – TargetOperationStageApiDTO(487ページ)
■ type: string
■ 例:2021-07-07T20:33:49Z
■ 説明:[BETA]: ターゲットが ISO-8601 形式(YYYY-MM-DDTHH:MM:SSZ)で最後に編集された時刻。
たとえば 2021-07-07T20:33:49Z
lastEditUser
■ type: string
■ 説明:[BETA]: ターゲットを最後に編集したユーザーのユーザー名。
healthSummary
■ 説明:ターゲットの正常性サマリー。
■ TargetHealthSummaryApiDTO(487ページ)
説明
ターゲットエラーに関連する追加の詳細。
必須パラメータ
targetErrorDetailsClass
■ type: string
説明
単一のターゲットの状態を説明する DTO。
必須パラメータ
healthCategory
■ type: string
■ 説明:実行される正常性チェックのタイプ。
■ 列挙型:['TARGET', 'ACTION', 'COMPONENT']
healthClassDiscriminator
■ type: string
■ 例:TargetHealthApiDTO
■ 説明正常性タイプの識別器。BaseHealthApiDTO のどのサブクラスが返されるかについて説明します。
targetName
■ type: string
■ 説明:ターゲットの表示名。
uuid
■ type: string
■ 説明:ターゲットの UUID。
オプションパラメータ
errorText
■ type: string
■ 説明:エラー テキスト(ある場合)。
timeOfFirstFailure
■ type: string
■ 説明:検証/検出の最初の失敗の時刻(ターゲットが失敗状態の場合。ISO-8601 フォーマットの文字列)。
timeOfLastSuccessfulDiscovery
■ type: string
■ 例:2021-07-07T20:33:49Z
■ 説明:[BETA]:ターゲットで最後に正常に検出された時刻。ISO-8601 フォーマット(YYYY-
MM-DDTHH:MM:SSZ)。たとえば 2021-07-07T20:33:49Z
targetErrorDetails
■ type: array
■ 説明:ターゲットに関連するエラーの詳細。複数のエラーの詳細をサポートします。
■ – TargetErrorDetailsApiDTO(486ページ)
■ type: string
■ 列挙型:['DISCOVERY', 'VALIDATION', 'DUPLICATION', 'DELAYED_DATA']
healthState
■ type: string
■ 列挙型: [「クリティカル」、「メジャー」、「マイナー」、「ノーマル」]
説明
ターゲットの正常性を記述する DTO。
必須パラメータ
healthState
■ type: string
■ 例:NORMAL
■ 説明: ターゲットのヘルス状態。
■ 列挙型: [「クリティカル」、「メジャー」、「マイナー」、「ノーマル」]
オプションパラメータ
timeOfLastSuccessfulDiscovery
■ type: string
■ 例;2021-07-07T20:33:49Z
■ 説明::ターゲットで最後に正常に検出された時刻。ISO-8601 フォーマット(YYYY-MM- DDTHH:MM:SSZ)たとえば 2021-07-07T20:33:49Z
説明
発見または検証の段階に関連するすべての情報を保持します。
オプションパラメータ
説明
■ type: string
■ 説明:このステージが実行していることの説明(理想的には 70 文字未満)。説明の例は、「資格情報の検証」または「ビジネス アプリケーションの取得」などです。
status
■ 説明:発見または検証段階のこの特定のインスタンスのすべての情報を保持します。
■ TargetOperationStageStatusApiDTO(488ページ)
説明
発見または検証段階のこの特定のインスタンスのすべての情報を保持します。
オプションパラメータ
state
■ type: string
■ 説明:発見または検証の終了時のこのステージの状態。
■ 列挙型:['DID_NOT_RUN', 'SUCCESS', 'FAILURE']
summary
■ type: string
■ 説明:ステージステータスを説明する短いメッセージ(理想的には 70 文字以下)。このようなメッセージの例は、「invalid credentials(無効な資格情報)または「4 business application retrieved(4 つのビジネスアプリケーションが取得されました)」などです。
fullExplanation
■ type: string
■ 説明:ステージ ステータスを説明する詳細なメッセージ。この説明には、問題に対処する方法に関する指示やヒントが含まれている場合があります。
説明
Inherits From
この DTO は、TargetErrorDetailsApiDTO(486 ページ)から継承します。
オプションパラメータ
targetErrorType
■ type: string
■ 説明:ターゲットの検証/検出エラー タイプ。
■ 列挙型:['INTERNAL_PROBE_ERROR', 'CONNECTIVITY_ERROR', 'UNAUTHENTICATED', 'TOKEN_UNAVAILABLE', 'VERSION_NOT_SUPPORTED', 'DATA_ACCESS_ERROR', 'DUPLICATION', 'DELAYED_DATA', 'THIRD_PARTY_FAILURE']
errorCode
■ type: string
■ 例:0x423232, 404, 400
■ 説明:失敗に関連するエラーコード。
endPoint
■ type: string
■ 説明:サードパーティの API 障害の原因となったエンドポイント。これは、完全な URL またはサードパーティ SDK の使用中のメソッド名になる場合があります。
説明
テレメトリの状態を表すモデル
オプションパラメータ
TelemetryTermsViewed
■ type: boolean
■ 説明:テレメトリのオプトインを管理者に表示するタイミングを制御します
telemetryEnabled
■ type: boolean
■ 説明:分析とテレメトリを有効にするかどうかを制御します
説明
テンプレートを記述するモデル:VM の展開またはプランへのワークロード/サプライの追加に使用されるリソースが含まれています
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
price
■ 型:数値
■ フォーマット: フロート
■ 説明:テンプレートの推定コスト。ハードウェアコストがわかっている物理マシンおよびストレージテンプレートに使用されます。
model
■ type: string
■ 例:Cisco UCS B200 M5(Intel Xeon Gold 5115、2.40 GHz)、PowerEdge R940(Intel Xeon Gold 6136、3.00 GHz)など。
■ 説明:物理マシンシステム全体のモデル。
cpuModel
■ type: string
■ 例:Intel Xeon Gold 6130、AMD Opteron 6166 HE など。
■ 説明:物理マシンの CPU のモデル。
ベンダー
■ type: string
■ 例:Cisco、Microsoft、HP、Novell
■ 説明:テンプレート化されたエンティティのベンダー
説明
■ type: string
■ 説明:記述
イメージ
■ type: string
■ 説明:コンテナのプロファイル画像
imageTag
■ type: string
■ 説明:(未使用)コンテナ プロファイル画像タグ
cmdWithArgs
■ type: string
■ 説明:(未使用)引数付きのコンテナコマンド
dbエンジン
■ type: string
■ 例:PostgreSql、AuroraMySQL、SqlServer
■ 説明:データベーステンプレートに使用されるデータベースエンジン
dbEdition
■ type: string
■ 例:Standard One、Enterprise、Premium_P2
■ 説明:データベーステンプレートに使用されるデータベースのエディション
computeResources
■ type: array
■ 説明:コンピューティングリソースを説明する ResourceApiDTO。テンプレートごとに最大 1 つ。
■ maxItems:1
■ minItems:0
storageResources
■ type: array
■ 説明:ストレージリソースを説明する ResourceApiDTO
networkResources
■ type: array
■ 説明:ネットワーク リソースを説明する ResourceApiDTO
■ type: array
■ 説明:インフラストラクチャリソースを記述する ResourceApiDTO。テンプレートごとに最大 1 つ
■ maxItems:1
■ minItems: 0
deploymentProfile
■ 説明:テンプレートに関連付けられた展開プロファイル
■ DeploymentProfileApiDTO(385ページ)
■ type: boolean
■ 例:False
■ 説明: テンプレートが検出されたか、手動で作成されたかを示します
■ 列挙型:[True, False]
ファミリ
■ type: string
■ 例:standardDSv2Family、standardNCFamily、r5d、r3
■ 説明:クラウドテンプレートの場合、インスタンスファミリ。
enableMatch
■ type: boolean
■ 例:False
■ 説明:インフラストラクチャコストポリシーに追加します。インフラストラクチャコストポリシーは、コストに従ってハードウェアデバイスをグループ化します。
説明
テンプレートを記述するモデル: VM の展開またはプランへのワークロード/サプライの追加に使用されるリソースが含まれています
オプションパラメータ
displayName
■ type: string
■ 説明:テンプレートの名前
className
■ type: string
■ 説明:クラス名
■ 列挙型:['VirtualMachine', 'PhysicalMachine', 'Storage', 'Container']
price
■ 型:数値
■ フォーマット: フロート
■ 説明:コスト価格
model
■ type: string
■ 説明:物理マシン システム全体のモデル。例:Cisco UCS B200 M5(Intel Xeon Gold 5115、2.40 GHz)や、PowerEdge R940(Intel Xeon Gold 6136、3.00 GHz)。
cpuModel
■ type: string
■ 説明:物理マシンの CPU のモデル。これは、物理マシン全体のモデルとは異なります。例: Intel Xeon Gold 6130 や AMD Opteron 6166 HE
ベンダー
■ type: string
■ 説明:ベンダー
説明
■ type: string
■ 説明:記述
イメージ
■ type: string
■ 説明:コンテナ テンプレートに使用されるプロファイル画像
imageTag
■ type: string
■ 説明:コンテナテンプレートに使用されるプロファイル画像タグ
cmdWithArgs
■ type: string
■ 説明:コンテナテンプレートに使用される引数付きコマンド
computeResources
■ type: array
■ 説明:コンピューティングリソース: CPU の数、CPU 速度、メモリサイズなど
■ maxItems:1
■ minItems: 0
storageResources
■ type: array
■ 説明:ストレージリソース: ディスク I/0、ディスクサイズ、消費されたディスクの割合
■ – ResourceApiDTO(448ページ)
■ type: array
■ 説明:ネットワークリソース
■ – ResourceApiDTO(448ページ)
■ type: array
■ 説明:インフラストラクチャリソース: 電力、サイズ、冷却
■ maxItems:1
■ minItems: 0
deploymentProfileID
■ type: string
■ 説明:このテンプレートに関連付けられた展開プロファイルの ID
enableMatch
■ type: boolean
■ 説明:インフラストラクチャコストポリシーに追加します。インフラストラクチャコストポリシーは、コストに従ってハードウェアデバイスをグループ化します。
説明
ビジネスユニットおよび指定された価格設定モデル内のテンプレートの価格調整情報。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
environmentType
■ type: string
■ 説明: 環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
ディスカウント
■ 型:数値
■ フォーマット: フロート
■ 説明:エンティティ割引率
priceAdjustment
■ 説明: エンティティ価格調整率
■ PriceAdjustmentDTO(429ページ)
■ type: string
■ 説明:テンプレートのファミリー、同様の目的のテンプレートのグループ。仮想マシンテンプレートでのみ使用できます。
pricesPerDatacenter
■ type: array
■ 説明:情報目的で提供される、データセンターごとのテンプレート基本料金。
説明
Inherits From
この DTO は、ConditionApiDTO(373 ページ)から継承します。
必須パラメータ
値
■ type: string
■ 説明:フィールドの値と照合される正規表現。
■ readOnly:True
説明
Inherits From
この DTO は FieldValueApiDTO (394 ページ) から継承します。
必須パラメータ
値
■ type: string
■ 説明: 値。
■ readOnly:True
説明
シナリオの時間枠に基づくトポロジの変更
オプションパラメータ
includeReservation
■ type: boolean
■ 説明: 現在予約されているワークロードを追加します、
reservationCount
■ 型:整数
■ フォーマット:int32
■ 説明:現在予約されている VM の数
■ readOnly:True
addHistoryVMs
■ type: boolean
■ 説明:過去の vmNetGrowth を考慮することになります
vmNetGrowth
■ 型:整数
■ フォーマット:int32
■ 説明:過去 1 か月間に追加されたワークロードの数
■ readOnly:True
説明
スケジュールタイムスパン情報
必須パラメータ
開始
■ type: string
■ 説明:タイムスパンの開始時刻
■ パターン:^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$
終了日
■ type: string
■ 説明:タイムスパンの終了時刻
■ パターン:^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$
policy
■ 説明:このタイムスパン中に適用されるポリシー
説明
TimeSpanGroup を記述する基本モデル。
必須パラメータ
type
■ type: string
■ 例:WeekDayTimeSpansApiDTO
■ 説明:TimeSpan グループタイプ識別子。TimeSpanGroupApiDTO のどのサブクラスが返されるかを説明します。
説明
シナリオのトポロジ変更
オプションパラメータ
addList
■ type: array
■ 説明: トポロジの追加変更のリスト
■ – AddObjectApiDTO(350ページ)
■ type: array
■ 説明:トポロジの削除変更のリスト
■ – RemoveObjectApiDTO(442ページ)
■ type: array
■ 説明:トポロジの置換変更のリスト
■ – ReplaceObjectApiDTO(443ページ)
■ type: array
■ 説明:トポロジの移行変更のリスト
■ – MigrateObjectApiDTO(415ページ)
■ type: array
■ 説明:トポロジのリリーフ圧力変化のリスト
■ – RelievePressureObjectApiDTO(441ページ)
説明
ユーザー定義のトポロジ定義を記述するモデル。
必須パラメータ
entityDefinitionData
■ 説明:エンティティ定義データ
■ IEntityDefinitionDat a(401ページ)
■ type: string
■ 説明:定義されているサービスエンティティのタイプ
■ 列挙型:['BusinessApplication', 'BusinessTransaction', 'Service']
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
contextBased
■ type: boolean
■ 説明:この定義がコンテキストベースかどうかを定義します。
説明
配置されていないプラン内のエンティティについての追加情報
必須パラメータ
理由
■ type: array
■ 説明:エンティティを配置できなかった理由に関する詳細情報
■ – UnplacementReasonApiDTO(497ページ)
オプションパラメータ
placedOn
■ type: array
■ 説明:プランマーケットでまだ配置されていなかったエンティティについて、このエンティティが配置できたプロバイダー
説明
エンティティを配置できなかった理由を説明する詳細
オプションパラメータ
failedResources
■ type: array
■ 説明: エンティティが配置されない原因となったリソースのリスト
■ – FailedResourceApiDTO(393ページ)resourceOwner
■ 説明:配置解除の原因となったリソースを所有するエンティティがこのエンティティと異なる場合、そのエンティティたとえば、VM を配置解除する原因となったボリューム。
providerType
■ type: string
■ 説明:配置解除の原因となったコモディティを販売するエンティティタイプ。
■ enum: ['Application'、'ApplicationComponent'、'ApplicationServer'、'AvailabilityZone'、'BusinessAccount'、'BusinessApplication'、'BusinessTransaction'、'BusinessUser'、'Chassis'、'CloudService'、'ComputeTier'、'Container'、'ContainerPod'、'ContainerSpec'、'Database'、'DatabaseServer'、'DatabaseServerTier'、'DatabaseTier'、'DataCenter'、'DesktopPool'、'DiskArray'、'DPod'、'HCIPhysicalMachine'、'HypervisorServer'、' Internet'、'IOModule'、'LoadBalancer'、'LogicalPool'、'Namespace'、'Network'、'PhysicalMachine'、'ProcessorPool'、'Region'、'ReservedInstance'、'Service'、'ServiceProvider'、'Storage'、'StorageController'、'StorageTier'、'Switch'、'Unknown'、'ViewPod'、'VirtualApplication'、'VirtualDataCenter'、'VirtualMachine'、'VirtualVolume'、'VPod'、'WorkloadController'、'ContainerPlatformCluster'、' VMSpec'、'CloudCommitment'、'ApplicationComponentSpec'、'VirtualMachineSpec']
closestSeller
■ 説明:最も満足のいくコモディティの売り手。この情報は常に利用できるとは限りません。
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:配置されなかった原因を分類します
■ 列挙型:['COSTS_NOT_FOUND', 'NOT_CONTROLLABLE', 'UNSATISFIED_COMMODITIES']
説明
ユーザーを記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
ユーザー名
■ type: string
■ 説明:ユーザー名
パスワード
■ type: string
■ 説明:暗号化されたパスワード
ロール
■ type: array
■ 説明:ユーザーに割り当てられたロール。
loginProvider
■ type: string
■ 説明:ログインのためのプロバイダー
■ 列挙型:['Local', 'LDAP']
type
■ type: string
■ 説明:タイプ
■ 列挙型:['DedicatedCustomer', 'SharedCustomer']
scope
■ type: array
■ 説明:ユーザーが表示できる範囲のリスト
■ – GroupApiDTO(396ページ)
■ type: array
■ 説明:ユーザーが表示できる機能のリスト
■ – 型:文字列
authToken
■ type: string
■ 説明:セキュリティで保護されたユーザートークン
showSharedUserSC
■ type: boolean
説明
シナリオにおいて利用変化を記述するモデル
オプションパラメータ
projectionDay
■ 型:整数
■ フォーマット:int32
■ 説明:投影日、いつ変更を適用するかを示します
ターゲット
■ 説明: 変更の対象、エンティティまたはグループ
■ BaseApiDTO(353ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:使用率の変化
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
os
■ type: string
■ 説明:オペレーティングシステムのタイプ例:「Linux」、「Windows」、分からない場合は「Unknown」。
ip
■ type: array
■ 説明:IP アドレスIPv4 または IPv6 のどちらも可能です
■ – 型:文字列
connectedNetworks
■ type: array
■ 説明:接続されたネットワーク
■ – BaseApiDTO(353 ページ)
■ 型:整数
■ フォーマット:int32
■ 説明:vCPU の数
coresPerSocketRatio
■ 型:整数
■ フォーマット:int32
■ 説明:ソケットあたりのコア数
processorPoolName
■ type: string
■ 説明:プロセッサ プール
ebsOptimized
■ type: boolean
■ 説明:EBS 最適化
セッション
■ type: array
■ 説明:この VirtualMachine に対して BusinessUser によって確立されたセッションに関する情報。
■ – BusinessUserSessionApiDTO(361ページ)
■ type: string
■ 説明:ベンダーツールのバージョン
ahublicense
■ type: boolean
説明
仮想ディスクを記述するモデル
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
階層
■ type: string
■ 説明:仮想ディスクの階層
アクション
■ type: array
■ 説明:関連するアクション:移動または削除
■ – ActionApiDTO(336ページ)
■ type: array
■ 説明:関連する統計
■ – StatApiDTO(472ページ)
■ 説明:ディスクが接続されている場合、仮想マシン
■ BaseApiDTO(353ページ)
■ 説明:ストレージプロバイダー
■ BaseApiDTO(353ページ)
■ 説明:VirtualDisk が存在するデータセンター
■ BaseApiDTO(353ページ)
■ type: string
■ 説明: 環境タイプ
■ 列挙型:['CLOUD', 'ONPREM', 'HYBRID']
lastModified
■ 型:整数
■ フォーマット:int64
■ 説明:最終更新日
businessAccount
■ 説明:ビジネスアカウント
■ BaseApiDTO(353ページ)
■ 説明:リソースグループ
■ BaseApiDTO(353ページ)
■ type: string
■ 説明:作成時間
skuName
■ type: string
■ 説明:SKU 名
snapshotId
■ type: string
■ 説明:スナップショット ID
encryption
■ type: string
■ 説明:暗号化
attachmentState
■ type: string
■ 説明:添付ファイルの状態
■ 列挙型:['AVAILABLE', 'IN_USE', 'UNKNOWN']
名前(name)
■ type: string
■ 説明:名前
一時的
■ type: string
■ 説明:エフェメラル
lastAttachedVm
■ type: string
■ 説明:このボリュームが最後にアタッチされた VM の名前。
numDaysUnattached
■ type: string
■ 説明:このボリュームが最後にアタッチされてからの日数。
hourlyBilledOps
■ 型:数値
■ フォーマット: ダブル
■ 説明:1 時間あたりの課金操作の平均数。
attachedVMStorageCompatibility
■ type: string
■ 説明:virtualDisk にアタッチされた VM のストレージ互換性。互換性は、ボリュームのスケール分析に影響します。アタッチされた VM が PREMIUM と互換性がない場合、ボリュームは プレミアム StorageTier にスケーリングされることはありません。
■ 列挙型:['PREMIUM', 'STANDARD']
storageUsageType
■ type: string
■ 説明:ボリュームの使用タイプ、つまり、ボリュームの使用目的。
■ 列挙型:['SITE_RECOVERY', 'BACKUP', 'STANDARD']
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
virtualDisks
■ type: array
■ 説明:仮想ディスクのリスト
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
ファイル
■ type: array
■ 説明:ボリュームに含まれるファイル
■ – 型:文字列
説明
Inherits From
必須パラメータ
メソッド
■ type: string
■ description: リクエストを作成するために使用される Http メソッド。
■ enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH']
url
■ type: string
■ description: HTTP リクエストが行われる URL。
オプションパラメータ
テンプレート
■ type: string
■ description: リクエストの本文のテンプレート。
authenticationMethod
■ type: string
■ description: リクエストに使用する認証方法。
■ enum: ['NONE', 'BASIC', 'OAUTH']
ユーザー名
■ type: string
■ description: 認証済みリクエストのユーザー名。
パスワード
■ type: string
■ description: 認証済みリクエストのパスワード。
trustSelfSignedCertificates
■ type: boolean
■ description: true の場合、HTTPS 接続の使用時に自己署名証明書が信頼されます。デフォルトは false です。
headers
■ type: array
■ description: リクエスト ヘッダー
oauthData
説明
Inherits From
この DTO は TimeSpanGroupApiDTO(495 ページ)から継承します。
オプションパラメータ
sunday
■ type: array
■ 説明:日曜日のスケジュールタイムスパン情報
monday
■ type: array
■ 説明:月曜日のスケジュールタイムスパン情報
■ – TimeSpanApiDTO(495ページ)
■ type: array
■ 説明:火曜日のスケジュールタイムスパン情報
■ – TimeSpanApiDTO(495ページ)
■ type: array
■ 説明:水曜日のスケジュールタイムスパン情報
■ – TimeSpanApiDTO(495ページ)
■ type: array
■ 説明:木曜日のスケジュールタイムスパン情報
■ – TimeSpanApiDTO(495ページ)
■ type: array
■ 説明:金曜日のスケジュールタイムスパン情報
■ – TimeSpanApiDTO(495ページ)
■ type: array
■ 説明:土曜日のスケジュールタイムスパン情報
説明
エンティティまたはグループクエリのフィルタ。
オプションパラメータ
relatedToScopes
■ type: array
■ 説明:これらの範囲に関連するエンティティに制限します。
■ readOnly:True
■ – 型:整数
– フォーマット:int64
conditions
■ type: array
■ 説明:これらの条件を満たすエンティティに制限します。
■ readOnly:True
説明
エンティティの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
type
■ type: string
row
■ 型:整数
■ フォーマット:int32
column
■ 型:整数
■ フォーマット:int32
sizeRows
■ 型:整数
■ フォーマット:int32
sizeColumns
■ 型:整数
■ フォーマット:int32
widgetsetId
■ 型:整数
■ フォーマット:int64
ウィジェット要素
■ type: array
説明
エンティティの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
row
■ 型:整数
■ フォーマット:int32
column
■ 型:整数
■ フォーマット:int32
type
■ type: string
widgetId
■ 型:整数
■ フォーマット:int64
プロパティ
■ type: object
■ additionalProperties: {'type': 'string'}
stats
■ type: array
■ – StatApiInputDTO(473ページ)
■ type: array
■ – 型:文字列
説明
エンティティの基本情報
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
scope
■ type: string
startPeriod
■ type: string
endPeriod
■ type: string
ウィジェット
■ type: array
■ – WidgetApiDTO(506ページ)
■ type: string
scopeType
■ type: string
ユーザー名
■ type: string
isSharedWithAllUsers
■ type: boolean
説明
ワークフローを説明するモデル
必須パラメータ
discoveredBy
■ 説明:このワークフローを検出したターゲット
type
■ type: string
■ 説明:このワークフローのタイプ
■ 列挙型:['UCSD', 'ACTION_SCRIPT', 'SERVICENOW', 'ACTIONSTREAM_KAFKA', 'WEBHOOK']
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
説明
■ type: string
■ 説明:ワークフローの説明
entityType
■ type: string
■ 説明:関連付けられたエンティティのタイプ
actionType
■ type: string
■ 説明:関連付けられたアクションのタイプ
パラメータ
■ type: array
■ 説明:ワークフローの入力パラメータ
■ – InputFieldApiDTO(402ページ)
■ type: string
■ 説明:ワークフロー スクリプトへの完全パス(例:ActionScript 実行可能ファイルへのパス)
actionPhase
■ type: string
■ 説明:ワークフローが適用されるアクションフェーズ
timeLimitSeconds
■ 型:整数
■ フォーマット:int64
■ 説明:ワークフロー実行の時間制限(秒単位)
typeSpecificDetails
■ 説明: このワークフローに関する、そのタイプに固有の情報。
説明
タイプ固有のワークフローの詳細を記述する親モデル
必須パラメータ
type
■ type: string
説明
ワークフローで要求された操作の詳細。
必須パラメータ
actionId
■ 型:整数
■ フォーマット:int64
■ 説明:ワークフロー操作を実行するアクションの ID
動作
■ type: string
■ 説明:ワークフローで実行されている操作
■ 列挙型:['TEST']
説明
ワークフロー操作の結果。
必須パラメータ
成功
■ type: boolean
■ 説明:ワークフロー操作が成功した場合は True。
オプションパラメータ
uuid
■ type: string
displayName
■ type: string
■ 説明:ユーザーが読める API オブジェクトの名前。空白にはできません。UTF-8 エンコーディングは最大 255 バイトです。
className
■ type: string
details
■ type: string
■ 説明:ワークフローの操作結果の詳細。
説明
Inherits From
この DTO は EntityAspect(389 ページ)から継承します。
オプションパラメータ
controllerType
■ type: string
■ 説明:ワークロード コントローラ タイプに関する情報。
■ 列挙型:['CRON_JOB_INFO', 'CUSTOM_CONTROLLER_INFO', 'DAEMON_SET_INFO', 'DEPLOYMENT_INFO', 'JOB_INFO', 'REPLICA_SET_INFO', 'REPLICATION_CONTROLLER_INFO', 'STATEFUL_SET_INFO']
customControllerType
■ type: string
■ 説明:カスタムコントローラタイプに関する情報。controllerType が CUSTOM_CONTROLLER_INFO の場合にのみ設定されます。
controllerReplicaCount
■ 型:整数
■ フォーマット:int32
■ 説明: ワークロードコントローラによって制御されるアクティブなレプリカの数。
Workload Optimization Manager は、環境内のエンティティに関する次の統計を監視します。
ヒープの
生成
RemainingGcCapacity
ResponseTime スレッド
トランザク
ション
VCPU
VMem
生成
未実装:価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
ResponseTime
応答時間(ミリ秒単位)。
トランザクション
1 秒あたりのトランザクション
ResponseTime
トランザクションを
生成します
ActiveSessions
ImageCPU
ImageMem
ImageStorage
PoolCPU
PoolMem
PoolStorage
生成
TotalSessions
冷却
割り当てられた冷却は、コンピューティング ファブリック内のシャーシなど、物理デバイスの最大許容動作温度を示します。
電源
物理デバイスによって消費される電力の測定値。
priceIndex
シャーシのリスクの程度。
生成
未実装:価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
空白(スペース)
既知の場合、このエンティティとともに使用できる物理ハードウェアの量。たとえば、サーバーラック内のスペースの数。
NumberConsumers の
生成
VCPU
VCPURequest
VMem
VMemRequest
NumberConsumers
が
StorageAmount
VCPU を生成
VCPULimitQuota
VCPURequest
VCPURequestQuota
VMem
VMemLimitQuota
VMemRequest
VMemRequestQuota
VStorage
VCPUを
生成
VCPURequest
VCPUThrottling
VMem
VMemRequest
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
VCPU
ホストしているエンティティに割り当てられた VCPU の使用率。
VCPULimitQuota
VCPURequest
VCPURequestQuota
VCPUThrottling
VMem
ホスティング VM に割り当てられた VMem の使用率(パーセント)。
VMemLimitQuota
VMemRequest
VMemRequestQuota
バルーニング
PM のバルーニングキャパシティ(キロバイト単位で測定)。このキャパシティは、PM がホストするパワーオン状態のすべての VM に構成された VMem の 65%、または物理メモリキャパシティの、大きい方です。
冷却
割り当てられた冷却は、コンピューティング ファブリック内のシャーシなど、物理デバイスの最大許容動作温度を示します。
CPU
ホストの CPU 容量(MHz 単位で測定)。これは、命令の処理に費やされている CPU サイクルの割合を示します。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
CPUAllocation
説明
CPUプロビジョニング済み
ホスト上のオーバープロビジョニングされた CPU キャパシティと、使用率の合計(KB 単位)。キャパシティは、ホストに指定されたオーバープロビジョニングの割合の関数です。
HostLunAccess
HotStorage IO スルー
プット
PM の IO アダプタを介したデータレート(KB/秒単位で測定)。
Mem
予約されているか使用中の PM のメモリの合計割合(キロバイト単位で測定)。
MemAllocation
説明
MemProvisioned
ホスト上のオーバープロビジョニングされた MEM キャパシティと使用率(KB 単位)。キャパシティは、ホストに指定されたオーバープロビジョニングの割合の関数です。
NetThroughput
PM のネットワーク アダプタを介した合計データレート。
numCPUs
ホストの CPU 容量(MHz 単位で測定)。これは、命令の処理に費やされている CPU サイクルの割合を示します
numHosts
データセンター内のホスト数
numSockets
データセンターのソケット数
電源
物理デバイスによって消費される電力の測定値。
priceIndex
データセンターのリスクの程度
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
Q16VCPU
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q1VCPU
準備完了キューのキャパシティと待機時間 (ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q2VCPU
準備完了キューのキャパシティと待機時間 (ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q32VCPU
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q4VCPU
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q64VCPU
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q8VCPU
準備完了キューのキャパシティと待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
空白(スペース)
既知の場合、このエンティティとともに使用できる物理ハードウェアの量。たとえば、サーバーラック内のスペースの数。
StorageAccess
IOPS キャパシティと使用率
StorageLatency
Swapping
説明
接続
DBCacheHitRate
DBMem
priceIndex は
ResponseTime
トランザクション
TransactionLog
VCPU を生成しま
す
VMem
VStorage
費用価格
説明
DTU
LicenseAccess
priceIndex
データベースのリスクの程度
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
StorageAmount
ActiveSessions
CPUAllocation
ImageCPU
ImageMem
ImageStorage
MemAllocation
PoolCPU
PoolMem
PoolStorage
priceIndex は
TotalSessions を
生成します
priceIndex
が生成する
範囲
冷却
割り当てられた冷却は、コンピューティング ファブリック内のシャーシなど、物理デバイスの最大許容動作温度を示します。
NetThroughput
エンティティのネットワークアダプタを介したデータレート(KB/秒単位で測定)。
PortChannel
説明
電源
物理デバイスによって消費される電力の測定値。
priceIndex
IO モジュールのリスクの程度
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
DiskArrayAccess
範囲
価格インデッ
クスは
StorageAccess
StorageAmount
StorageLatency
を生成します
StorageProvisioned
priceIndex は
VCPU を生成
します
VCPULimitQuota
VCPURequest
VCPURequestQuota
VMem
VMemLimitQuota
VMemRequest
VMemRequestQuota
バルーニング
PM のバルーニングキャパシティ(キロバイト単位で測定)。このキャパシティは、PM がホストするパワーオン状態のすべての VM に構成された VMem の 65%、または物理メモリキャパシティの、大きい方です。
冷却 CPU
CPU キャパシティ、予約済み CPU、使用済み CPU(MHz)。
準備完了キューのキャパシティと待機時間 (ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
CPUAllocation
ホストに割り当てられた CPU キャパシティ(MHz)。
CPUProvisioned
ホスト上のオーバープロビジョニングされた CPU キャパシティと使用率(MHz 単位)。キャパシティは、ホストに指定されたオーバープロビジョニングの割合の関数です。
エネルギー
ホストと仮想マシンが 1 時間に消費するエネルギー量。
HostLunAccess
IOThroughput
ホストの IO アダプタを介したデータレートのキャパシティと使用率(KB/秒単位で測定)。
Mem
予約されているか使用中の PM のメモリの割合(キロバイト単位で測定)。
MemAllocation
ホストメモリの割り当てと使用率(KB 単位)。
MemProvisioned
ホスト上のオーバープロビジョニングされた MEM キャパシティと使用率(KB 単位)。キャパシティは、ホストに指定されたオーバープロビジョニングの割合の関数です。
NetThroughput
ホストのネットワークアダプタを介したデータレートのキャパシティと使用率(KB/秒単位で測定)。
numCPUs
ホスト上の CPU の数。
numSockets
このホストで検出されたソケットの数。
電源
ホストおよび仮想マシンによる電力消費率。
priceIndex
ホストのリスクの程度。
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
Q16VCPU
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q1VCPU
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q2VCPU
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q32VCPU
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q4VCPU
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
Q64VCPU Q8VCPU
準備完了キューの容量と待機時間(ミリ秒単位)。Workload Optimization Manager は、1 つの CPU、2 つの CPU、4 つの CPU から最大 32 CPU までの準備完了キューをホスト上でモニタします。
スペース
ストレージアクセス
ストレージ遅延
スワッピング
ディスクへのメモリスワッピングのキャパシティ、予約キャパシティ、および使用率(ビット/秒)。
NumberReplicas
priceIndex
が生成
priceIndex
ディスクアレイのリスクの程度。
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
StorageAmount
このエンティティのストレージのストレージキャパシティ、予約済みストレージ、および使用済みストレージ(MB))
StorageAccess
IOPS キャパシティと使用率
StorageAmount
このエンティティのストレージキャパシティ、予約済みストレージ、および使用済みストレージ(MB)
StorageClusterCommodity
StorageLatency
ミリ秒単位のストレージトランザクションのキャパシティ、予約量、および利用されたレイテンシー(ミリ秒)。
StorageProvisioned
エンティティのオーバープロビジョニングされたストレージキャパシティと使用率(MB)。キャパシティは、エンティティに指定されたオーバープロビジョニングの割合の関数です。
エクステント
priceIndex
ストレージエンティティのリスクの程度。
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
StorageAccess
IOPS キャパシティと使用率
StorageAmount
このエンティティのストレージキャパシティ、予約済みストレージ、および使用済みストレージ(MB)
StorageLatency
ミリ秒単位のストレージ トランザクションのキャパシティ、予約量、および利用されたレイテンシー(ミリ秒)。
StorageProvisioned
エンティティのオーバープロビジョニングされたストレージキャパシティと使用率(MB)。キャパシティは、エンティティに指定されたオーバープロビジョニングの割合の関数です。
NetThroughput
エンティティのネットワークアダプタを介したデータレート(KB/秒単位で測定)。
PortChannel
ポートチャネルを介したデータレート(KB/秒単位で測定)。
priceIndex
スイッチのリスクの程度。
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
ActiveSessions
priceIndex は
TotalSessions を
生成します
CPUAllocation
ホストの CPU 容量(MHz 単位で測定)。これは、命令の処理に費やされている CPU サイクルの割合を示します。
MemAllocation
説明
priceIndex
仮想データセンターのリスクの程度
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
バルーニング
PM のバルーニングキャパシティ(キロバイト単位で測定)。このキャパシティは、PM がホストするパワーオン状態のすべての VM に構成された VMem の 65%、または物理メモリキャパシティの、大きい方です。
CPU
ホストの CPU 容量(MHz 単位で測定)。これは、命令の処理に費やされている CPU サイクルの割合を示します。
ホストしている VM に割り当てられた VCPU の使用率(MHz 単位)。
CPUAllocation
説明
CPUプロビジョニング済み
エンティティのオーバープロビジョニングされた CPU キャパシティと使用率(MHz 単位)。キャパシティは、エンティティに指定されたオーバープロビジョニングの割合の関数です。
IOThroughput
説明
Mem
VM により予約されているか使用中の PM のメモリの割合(キロバイト単位で測定)。ホスティングにより割り当てられた VMem の使用率(パーセント)。
MemAllocation
説明
MemProvisioned
エンティティのオーバープロビジョニングされた Mem のキャパシティと使用率(KB 単位)。キャパシティは、エンティティに指定されたオーバープロビジョニングの割合の関数です。
NetThroughput
エンティティのネットワークアダプタを介したデータレート(KB/秒単位で測定)。
numVCPUs
説明
priceIndex
仮想マシンのリスクの程度
生成
未実装: 価格の計算に使用される、このプロバイダーに接続されているエンティティの数。
StorageAccess
IOPS キャパシティと使用率
StorageAmount
このエンティティのストレージのストレージキャパシティ、予約済みストレージ、および使用済みストレージ(MB)
StorageLatency
説明
StorageProvisioned
エンティティのオーバープロビジョニングされたストレージキャパシティと使用率(MB)。キャパシティは、エンティティに指定されたオーバープロビジョニングの割合の関数です。
スワッピング
説明
VCPU
ホストしている VM に割り当てられた VCPU の使用率(パーセント)。
VMem
ホスティングにより割り当てられた VMem の使用率(パーセント)。
VStorage
VM に割り当てられた仮想ストレージ(キロバイト単位で測定)。
costPrice
IOThroughput
が生成する
StorageAccess
StorageAmount
StorageLatency
StorageProvisioned
priceIndex は
VCPULimitQuota
を生成します
VCPURequestQuota
VMemLimitQuota
VMemRequestQuota
Workload Optimization Manager の各メジャーリリースには、API の問題の修正と改善が含まれています。このセクションでは、メジャーリリースごとにこれらの変更をリストします。
注:
Workload Optimization Manager のポイントリリースでは、非推奨になった機能が公開されています。たとえば、一部の API 機能のサポート終了(EOL)を 8.4.3 に設定してあるとします。その場合、8.5.0 のエントリには、8.4.x ポイント リリースで行った他のすべての修正と改善のリストとともに、非推奨になった機能へのリンクが表示されます。最新の非推奨の履歴を表示するには、付録: API 非推奨の履歴(539 ページ)に移動します。
Workload Optimization Manager 3.6.0 API の修正と改善
■ 修正済みの問題:
修正バージョン: 8.7.3
「API 開発者が、検索エンドポイントでリクエストを実行するとき、API は返された結果のページネーションを行いません。」
API 開発者の場合、検索エンドポイントでリクエストを実行するとき、API は返された結果のページネーションを行いません。
Workload Optimization Manager 3.5.0 API の修正と改善
■ 改善点:
修正バージョン: 8.6.5
「API は、クラスタアフィニティによる予約をサポートするようになりました。」
予約を作成するときに、予約された VM のアフィニティルールを指定できるようになりました。予約内のすべての VM を同じクラスタに確実に展開できます。アフィニティを指定しない場合、VM は範囲内の任意のクラスタに展開されます。これは、予約の以前の動作と同じです。
詳細については、「アフィニティルール」(157ページ)を参照してください。
■ 改善点:
修正バージョン:8.2.5
修正バージョン:8.6.3
「/supplychains/leafEntities エンドポイントが利用可能になりました。」
このリリースでは、独自のサプライ チェーン トポロジを定義するために使用できる /supplychains/leafEntities エンドポイントが導入されています。このエンドポイントは、「シード エンティティ」に関連する「リーフ エンティティ」のリストを返します。
■ 修正済みの問題:
修正バージョン:8.6.1
「GET および POST メソッドで返される最大エントリは 500 です。」
Workload Optimization Manager バージョン 3.4.1 以降、ServiceEntities、Groups、または BusinessAccount エンドポイントで実行すると、GET および POST メソッドは最大 500 のエントリを返します。結果のページネーションを常に確認する必要があります。
Workload Optimization Manager 3.4.0 API の修正と改善
■ 改善点:
「API には、プラン送信先 エンドポイントが含まれるようになりました。」
プラン送信先は、プランの結果をアップロードできる外部リソースです。現在のところ、[クラウドへの移行(Migrate to Cloud)] プランの結果を、Azure Migrate ポータルにアップロードできます。プランの送信先 エンドポイントを使用して、プランの宛先を取得し、アップロードを実行します。
■ 改善点:
「予約を削除するときに、その予約を完全に削除するかどうかを指定できるようになりました。」
API には、特定の予約への DELETE 呼び出しと共に渡すことができる、新しい reservation_force_delete パラメータが含まれています。reservation_force_delete = true の場合、システムは予約の状態に関係なく、予約を完全に削除します。このリリース以前は、API またはユーザーインターフェイスを介して削除した予約は引き続き削除対象として表示され、48 時間後になって完全に削除されました。
■ 改善点:
「API には、新しい LABEL コモディティタイプが含まれています。」
commodityType 列挙には、新しい LABEL コモディティタイプが含まれています。
■ 改善点:
「API 開発者向けに、作成した予約が失敗したとき、返される DTO には失敗に関するより多くのデータが含まれるようになりました。」
予約を作成して、予約が失敗すると、API は失敗の原因を説明する DTO を返します。この DTO には、新しいフィールドが含まれています。
– timespan:予約の計算がリアルタイムまたは過去のリソース使用率データに基づいていたかどうかを示します。次のいずれかになります。
• Current:計算はリアルタイムの使用率データに基づいています
• Historical:計算は使用率履歴に基づいています。
– cluster:予約に必要なリソースを提供できる、最も近いクラスタの名前。
– hrefCluster:最も近い販売者クラスタの統計へのリンク。
– hrefEntity:最も近い販売者クラスタのメンバーである最も近い販売者エンティティの統計へのリンク。たとえば、DTO には、配置の失敗について次のようなデータを含めることができます:
"placements": { "failureInfos": [
{
"resource": "StorageAmount", "timespan": "Historical", "closestSeller": {
"uuid": "74167780552264",
"displayName": "QSGRID01:DC6DS2", "className": "Storage", "cluster": "StorageCluster-A",
"hrefEntity": "/reservations/stats/74167780552264", "hrefCluster": "/reservations/stats/74167780552265"
},
"maxQuantityAvailable": 248294.59024047852,
"quantityRequested": 273184.5625, "units": "MB"
}
]
}
■ 改善点:
「実行不可能なアクションの処理が改善されました。」
このリリースでは、前提条件のアクションのために現在実行できないアクションの処理が改善されています。
たとえば、ホスト A を一時停止するには、ホストの VM_01 を最初にホスト B に移動する必要があります。ただし、ホスト B には 1 つの VM の容量しかなく、現在 VM_02 をホストしています。この場合、ホスト A の一時停止は、VM_02 が別のホストに移動し、VM_01 がホスト B に移動するという 2 つの前提条件アクションによってブロックされます。
メイン アクション(例ではホスト A の一時停止)の [アクションの詳細] ページには、次の情報が表示されます。
「最初に実行する必要があるターゲットまたは宛先のアクションによってブロックされています。」
以前のリリースでは、[アクションの詳細] ページに、アクションがポリシーによってブロックされていることが示されていました。
API 開発者向けに、ActionApiDTO にこの状態が表示されるようになりました。Workload Optimization Manager は、relatedActionsCountByType パラメータの BLOCKED_BY キーを 0 に設定します。これは、前提条件のアクションが原因で、アクションが現在実行できないことを示しています。
前提条件のアクションがすべて実行されると、メインのアクションが実行可能になります。
■ 改善点:
「API を介して失敗した予約を調べると、データが失敗の理由を返していることがわかります。」
予約を作成したら、環境内の現在の予約に関するデータの予約 エンドポイントを取得できます。結果のデータにはステータスが含まれます。ステータスが PLACEMENT_FAILED の場合、Workload Optimization Manager は、何らかの理由ですべてのワークロードを予約に配置できなかったことを示しています。バージョン 3.3.4 以降、データの配置 フィールドには、配置の失敗の理由を示す invalidInfo が含まれています。次のような理由が考えられます。
– MARKET_CONNECTIVITY_ERROR:なんらかの理由で、予約プロセスがマーケットコンポーネントに接続できませんでした。
– MARKET_NOT_READY:マーケットには、指定された予約範囲のヘッドルーム プランからのデータがありません。
– INVALID_CONSTRAINTS:予約ポリシーに、矛盾する制約または無効な制約が含まれています。例としては、1 つの予約のデータに次のデータが含まれているものが挙げられます。。
"demandEntities": [
{
"template": {
"uuid": "215167980658768",
"displayName": "MyVmTemplate", "className": "VirtualMachineProfile"
},
"placements": { "invalidInfo": {
"invalidReason": "MARKET_CONNECTIVITY_ERROR"
}
}
}
]
Workload Optimization Manager 3.3.0 API の修正と改善
■ 修正済みの問題:
「GET /entities/{entity_Uuid}/groups エンドポイントは Swagger UI に含まれていません。」
Swagger のドキュメントには、エンドポイントのエントリ GET /entities/{entity_Uuid}/groups が含まれていません。
■ 修正済みの問題:
「大文字と小文字を区別しないフィルタを使用してグループを作成すると、グループの結果が予期しないものになることがあります。」
グループを作成する API スクリプトの場合、正規表現フィルタに caseSensitive = false を設定すると、予期しない結果になる可能性があります。グループの作成が失敗するか、期待するエンティティを含まないグループが作成されることがあります。次に例を示します。
■ 修正済みの問題:
「状況によっては、検索エンドポイントが恣意的にデータを返さないことがあります。」
キャッシュされたグループデータを更新するときのタイミングの問題により、検索 エンドポイントへの呼び出しがデータを返すことができない場合があります。
Workload Optimization Manager 3.2.0 API の修正と改善
■ 改善点:
Dynatrace では、Dynatrace ターゲットを介して VM メトリックの収集を有効化または無効化できるようになりました。
アプリケーションを管理する場合、分析では VM メトリックが考慮されます。Dynatrace 環境では、Workload Optimization Manager は、Dynatrace ターゲットおよび基礎となる VM から VM データを検出できます。両方のソースから VM データを収集する場合、分析には Dynatrace データが使用されます。
ほとんどの環境では、Workload Optimization Manager が VM 自体から直接収集する VM データを使用するのが最適です。データはより豊富かつ正確になりますが、Dynatrace を介してこのデータを検出すると、十分なパフォーマンスが得られない可能性があります。
分析で使用される VM メトリックデータのソースを制御可能にするために、このリリースでは、Dynatrace ターゲットの設定時に [仮想マシンメトリックの収集(Collect Virtual Machine Metrics)] の設定が導入されています。デフォルトでは、この設定は [オフ(Off)] です。オフの場合、Workload Optimization Manager は Dynatrace ターゲットを介して VM メトリックを収集せず、分析には VM 自体から収集されたデータが使用されます。
注:
ターゲットに対してこの設定を [On] にすると、
影響を受ける VM の [Aggressiveness] 設定で設定するパーセンタイルが分析で使用されません。
API を介して Dynatrace を設定するときに、オプションの設定を使用できるようになりました。
{
"displayName": "Collect Virtual Machine Metrics", "name": "collectVmMetrics",
"value": "false", "defaultValue": "false", "isMandatory": false, "isSecret": false, "isMultiline": false, "isTargetDisplayName": false, "valueType": "BOOLEAN",
"description": "Overwrite Hypervisor または Cloud Provider Virtual Machine メトリックをターゲットからのデータで上書きします",
"verificationRegex": "(true|false)"
}
■ 改善点:
このリリースには、[無駄なファイル(Wasted File)] ポリシーの [無駄なファイルの最小サイズ(Minimum Wasted Files Size)] の設定が含まれています。
無駄なファイルを検出すると、Workload Optimization Manager は、特定のストレージとそのストレージ上の無駄なファイルのリストを識別します。ボリュームに多数のファイルがあるような状況では、ボリュームを記述するデータが大きすぎて、ターゲットから Workload Optimization Manager に転送できないことがあります。その場合、影響を受けるストレージは分析に含めることができず、ログに文字列(* はワイルドカード)を含むエラーが投稿される可能性があります。
BroadcastStage.*Entity.* が大きすぎるため、ブロードキャストに失敗しました。
そのストレージのデータペイロードを減らすために、無駄なストレージブラウジングを指示して、最小サイズのファイルをスキップできます。その後、データのリストには大きなファイルのみが含まれるため、全体のペイロードを削減できます。デフォルトの最小値は 1 MB です。
この問題が引き続き発生する場合は、無駄なファイルのサイズを増やしてリストに追加できます。これで、ボリューム上の無駄なファイルの数が減るはずです。[無駄なファイルの最小サイズ(Minimum Wasted Files Size)] の設定を調整するには、次の手順を実行します。
1. ストレージポリシーを設定します。
[設定(Settings)] ページに移動し、[ポリシー(Policies)] を選択します。次に、新しいストレージの自動化ポリシーを編集または作成します。
2. [無駄なファイルの最小サイズ(Minimum Wasted Files Size)] の設定を編集します。
[ストレージ設定(Storage Settings)] セクションで、[無駄なファイルの最小サイズ(Minimum Wasted Files Size)] の値を編集します。
API を介してポリシーを編集する場合、この設定はストレージ設定マネージャ(...api/v3/settings/specs?manager_uuid=storagesettingsmanager)にあります。設定は次のように定義されます。
{
"uuid": "minWastedFilesSize",
"displayName": "Minimum Wasted Files Size [KB]", "defaultValue": "1000.0",
"valueType": "NUMERIC", "valueObjectType": "String", "min": 0,
"max": 1000000000,
"entityType": "Storage"
}
■ 修正済みの問題:
groupBy 設定なしで POST stats/uuid 呼び出しを実行すると、API がグループ化された統計を返すことがあります。
API への POST:.../stats/{statistic_Uuid} 呼び出しの場合、取得する統計の groupBy パラメータを指定できます。groupBy 値を指定しない場合、API はグループ化されていない統計レコードを返します。状況によっては、グループ化されたレコードが返されます。API は一貫している必要があります。
■ 修正済みの問題:
businessunits エンドポイントで GET を実行すると、指定された範囲に businessunit エンティティがない場合でも、データを返すことができます。
businessunits エンドポイントで GET を実行すると、指定された範囲に businessunit エンティティがない場合でも、データを返すことができます。返されるデータは、1 つの要素を含む配列です。次に例を示します。
[{“master”:false,“riSupported”:false,“hasRelatedTarget”:false}]
この状況に対する適切な応答は、空の配列である必要があります。
Workload Optimization Manager 3.1.0 API の修正と改善
■ 改善点:
API が VStorage エンティティに対して返す統計には、displayName フィールドにボリューム名が含まれるようになりました。
API が VStorage エンティティに対して返す統計には、displayName フィールドにボリューム名が含まれるようになりました。以前のバージョンでは、API は、displayName のエンティティのキー値を返しました。
■ 改善点:
クラウド範囲の新しい統計フィールド。
クラウド範囲に対して /stats リクエストが実行されると、次の 4 つのフィールドが必要に応じて返され、節約と投資が要約されます。
– REALIZED_SAVINGS:
実行された効率化アクションによる節約。
– REALIZED_INVESTMENTS:
実行されたパフォーマンスアクションからの投資。
– MISSED_SAVINGS:
推奨されたものの実行されなかった効率化アクションによる、潜在的な節約。
– MISSED_INVESTMENTS:
推奨されたものの実行されなかったパフォーマンスアクションによる、潜在的な投資。
■ 改善点:
LicenseApiDTO には、customerId パラメータが含まれるようになりました。
Workload Optimization Manager 3.0.3 以降、LicenseApiDTO には、ライセンスを取得した顧客の一意の識別子である customerId パラメータが含まれています。この ID は、同じ顧客を複数のライセンスにマッチさせることを目的としています。たとえば、1 人の顧客が 2 つの Workload Optimization Manager インスタンスをそれぞれ独自のライセンスで実行している場合、customerId は両方で同じになります。
■ 修正済みの問題:
FilterApiDTO オブジェクトで受け入れられる値について、Swagger UI は、有効な一致タイプとして RXEQ または RXNEQ をリストしませんでした。
フィルタを指定する場合、REGEX 値に等しい(RXEQ)または等しくない(RXNEQ)を指定できます。Swagger UI では、これらの値が説明に許容値として含まれるようになりました。指定できる値は次のとおりです。
– 文字列の場合
「EQ」、「NEQ」、「RXEQ」、「RXNEQ」
– 数値の場合
「EQ」、「NEQ」、「GT」、「LT」、「GTE」、「LTE'」
■ 修正済みの問題:
アクションのリストについては、インスタンスタイプによるフィルタは最適化アクションでは機能しません。
アクションのリストを表示すると、インスタンスタイプを含むさまざまな条件でフィルタリングできます。ただし、インスタンスタイプによるフィルタリングは、最適化アクションでは機能しません。
■ 修正済みの問題:
「等しくない」条件を含む検索フィルタは、間違った結果を返す可能性があります。
「等しくない」演算子を使用する検索条件を設定すると、結果が不正確になる可能性があります。
■ 修正済みの問題:
API を使用して、サポートされていない範囲の「numVMs」統計を取得すると、API はゼロの値を返します。
api/v3/stats?ascending=true リクエストを実行するときは、通常、リクエストの範囲を設定します。numVMs 統計を要求する場合、範囲はクラスタである必要があります。別のタイプの範囲を設定すると、データは VM の数としてゼロを返します。これは、その範囲に VM がないことを意味するとの誤解を招きます。代わりに、返される値は、無効な範囲を使用したことを示すべきです。
■ 修正済みの問題:
API を使用してグローバルデフォルトポリシーを取得すると、無効なデータが返されます。
グローバルデフォルトポリシーを照会するには、次の要求を使用できます。
api/v3/settingspolicies/55555
ただし、このリクエストは無効なペイロードを返し、ポリシーデータは含まれません。
■ 修正済みの問題:
ライセンスされたワークロードキャパシティを超えた後も、API を介してターゲットを追加できます。
Workload Optimization Manager のライセンスは、ターゲットを介して管理できるワークロードの数を指定します。ただし、ワークロードのライセンスキャパシティを超えた場合でも、API を介して新しいターゲットを追加できます。これにより、ワークロード数が増加します。
Workload Optimization Manager 3.0.0 API の修正と改善
■ 修正済みの問題:
状況によっては、大規模なグループを作成すると、API が 500 エラーを返し、次のログエントリを生成します。
ERROR [grpc-default-executor-22959] [GroupRpcService]: Cannot find groups with ids(ID を持つグループが見つかりません)
■ 修正済みの問題:
GET /supplyChains リクエストは、compact がリクエストで渡されたときにエンティティレベルの情報を返さなくなりました。
■ 修正済みの問題:
シナリオ作成に無効な ScenarioApiInputDTO を指定すると、API は適切なエラーを返します。以前は、API は無効なシナリオ UUID で 200 を返しました。
■ 修正済みの問題:
生成された Swagger DTO 階層に問題があるため、GET actions/uuid/details の結果を
リクエストするとエラーが発生していました。このエラーは発生しなくなり、リクエストは正常に完了します。
■ 修正済みの問題:
/reservations/stats/uuid のリクエストは、デプロイされた予約済み VM の値を返すことができます。
API を使用して VM を予約にデプロイした後、Workload Optimization Manager は、それらの VM とその予約の記録を 48 時間保持します。予約済み VM の統計を取得すると、API にこれらのデプロイ済み VM の値が誤って含まれます。Workload Optimization Manager が推奨するアクションは正しいものですが、プロバイダー統計に関するレポートは正しくない可能性があります。
■ 修正済みの問題:
密度グラフ(ホスト密度上の VM など)を表示するとき、グラフはデータを個別の適切なデータ ポイントにロールアップするべきでした。たとえば、1 時間ごとのデータの場合、10 分のデータ ポイントも含めるべきではありません。にもかかわらず、チャート表示では、これらのデータ ポイント タイプが混在していました。
■ 修正済みの問題:
StorageAmount メトリックに対するエンティティ統計を返すクエリを送信するときの API 応答時間が
改善されました。
■ 修正済みの問題:
/targets/{targetUuid}/health リクエストの場合、state パラメータの列挙型には次の値と説明があります。
– NORMAL (1):
このエンティティは正常な状態です。
– MINOR (2):
推奨される行動は環境を改善しますが、対処しなくても深刻な結果をもたらすことはほとんどありません。
– MAJOR (3):
推奨されるアクションは環境を改善します。対処しないままにしておくと、深刻な結果が生じる可能性があります。
– CRITICAL (4):
推奨されるアクションは環境を改善します。対処しないままにしておくと、深刻な結果が生じます。これらのアクションには迅速な対処が必要です。
■ 既知の問題:
ActionScopesApiInputDTO の limitEntities パラメータは、POST /actions および POST /actions/stats リクエストでは無視されます。POST /actions リクエストでは、この機能はページネーションによって処理されます。
■ 改善点:
marketsettingsmanager 設定マネージャで、設定 minReplicas および maxReplicas が追加されました。これにより、アプリケーション コンポーネントの水平スケーリングの最小レプリカと最大レプリカを指定できます。
■ 改善点:
ActionDetailsApiDTO に getActionDetailType パラメータが追加されました。このパラメータは、要求されたアクションのアクションタイプを返します。
■ 改善点:
レポート エディター権限をユーザーアカウントに割り当てるには、API を使用できます。たとえば、次の API ペイロードを持つレポート エディタ権限を持つユーザーを作成できます。
{
"username":"MyUserName", "password":"MyPassword", "type":"DedicatedCustomer", "loginProvider":"LOCAL",
"roles":[{"name":"report_editor"}, {"name":"advisor"}]
}
この例では、roles フィールドは、report_editor ロールを含むロールの配列です。API の使用についてご不明な点は、サポートまでお問い合わせください。
■ 改善点:
ENTITIES のリクエストから返されるデータには、アスペクトが含まれます。次のアスペクトに価値がない状況では、DTO には特定のアスペクトは含まれません。
– アスペクト.dbAspect.maxConcurrentSessions
– アスペクト.dbAspect.maxConcurrentWorkers
■ 改善点:
API には、特定の予約への DELETE 呼び出しと共に渡すことができる新しい reservation_deployed パラメータが含まれています。これにより、Workload Optimization Manager は、影響を受けるプロバイダーのリソース使用率を正しく追跡できます。
API を介して予約を削除し、reservation_deployed = true パラメータを含めると、次のことが起こります。
– Workload Optimization Manager の分析は、プロバイダーに新しくデプロイされたワークロードを認識し、それらの VM を通常どおり追跡します。
– 予約は、Workload Optimization Managerに 48 時間保持されます。API またはユーザーインターフェイスを介してこの予約を調べると、予約は変更されていないように見えます。
– 48 時間以後に、Workload Optimization Manager は予約を削除します。
■ 改善点:
このバージョンの Workload Optimization Manager には、新しいグローバル デフォルト設定であるオンプレミス仮想ボリュームの分析を有効にする機能が導入されています。この設定により、製品はコモディティを生成し、個々の仮想ボリュームでアクションを実行するために必要な分析を実行できます。
注:
この機能はパブリックプレビューとして提供されています。機能の詳細は変更される場合があります。
このバージョンのWorkload Optimization Managerでは、marketsettingsmanager 設定マネージャ onPremVirtualVolumeResourceAnalysis に新しいブール設定が導入されています。このグローバル設定はデフォルトで false に設定されており、有効にすると、製品はコモディティを生成し、個々の仮想ボリュームでアクションを実行するために必要な分析を実行します。
■ 改善点:
アクション DTO には、アクションの説明にある Current、New、および Target エンティティのそれぞれの connectedEntities オブジェクトに関連するクラスタが含まれるようになりました。DTO では、クラスタオブジェクトは次のようになります。
"connectedEntities": [
{
"className": "Cluster", "displayName": "ACM/ACM Cluster", "uuid": "73856545920539"
}
]
■ 改善点:
DemandReservationApiDTO では、relatedResources パラメータは非推奨になり、
linkedResources パラメータにより置き換えられました。このパラメータは、予約リソースに関するより詳細な情報を返します。
■ 改善点:
パラメータ orderBy、limit、または cursor の少なくとも 1 つが GET /tags リクエストに含まれている場合、結果はページネーションされます。
これらのパラメータがないと、結果はページネーションなしで返されます。
■ 改善点:
スケーリングアクションのプロビジョニング設定は、水平スケーリング 設定に置き換えられました。さらに、アプリケーションを水平方向にスケーリングするには、次の項目が当てはまる必要があります。
– アプリケーションは水平方向にスケーラブルで、Kubernetes ターゲットに存在する必要があります
– アプリケーションには Transaction または ResponseTime メトリックが必要です
– トランザクション SLO または応答時間 SLO を有効にする必要があります
■ 改善点:
パラメータ orderBy、limit、または cursor の少なくとも 1 つが GET /search、POST / search、および GET /groups リクエストに含まれている場合、結果はページネーションされます。これらのパラメータがないと、結果はページネーションなしで返されます。
さらに、空のグループの environmentType および cloudType パラメータは、最初にそれらを検出したターゲットの値に設定されます。
以下のエンドポイント、リクエスト、DTO、およびパラメータは、Workload Optimization Manager API で廃止されました。サポート終了(EOL)により、これらの変更を確定する製品バージョンが提供され、廃止項目は提供されなくなります。
注:
EOL が定義されている廃止項目については、代替の使用方法を参照してください。
EOL:8.8.1
8.8.1 リリースでは、次の廃止に関する変更が行われます。廃止機能は、廃止時点で API から削除されます。
エンドポイント |
なし |
リクエスト |
■ GET /search/market/ 代わりに、GET /markets を使用します。 ■ GET /search/target/ 代わりに、GET /targets を使用します。 ■ GET /groups/<groupId>/actions/<actionId> この呼び出しは使用しないでください(実装されていません)。 ■ GET, POST /target/<targetId>/stats この呼び出しは使用しないでください(実装されていません)。 ■ GET /businessunits/<busUnitId>/stats 代わりに、GET /entities/<entityId>/stats または GET /stats/ を使用します。 <entityId>/stats。これらの呼び出しは、ビジネス ユニット エンティティ ID を使用します。 ■ POST /businessunits/<busUnitId>/stats 代わりに、POST /stats/<entityId>/stats or POST /stats を使用します。 |
要求パラメータ |
なし |
DTO |
なし |
DTO パラメータ |
なし |
ENUM 値 |
■ entityType:VMSpec 代わりに VirtualMachineSpec を使用します。 ■ entityTypes:VMSpec 代わりに VirtualMachineSpec を使用します。 |
|
■ entityTypeFilter:VMSpec 代わりに VirtualMachineSpec を使用します。 ■ providerEntityType:VMSpec 代わりに VirtualMachineSpec を使用します。 ■ relatedEntityType:VMSpec 代わりに VirtualMachineSpec を使用します。 ■ providerType:VMSpec 代わりに VirtualMachineSpec を使用します。 |
EOL: 8.9.1
8.9.1 リリースでは、次の廃止に関する変更が行われます。廃止機能は、廃止時点で API から削除されます。
エンドポイント |
なし |
リクエスト |
なし |
要求パラメータ |
なし |
DTO |
■ DTO:ScenarioChangeApiDTO 手順:loadChanges または configChanges パラメータを以下において使用します: ScenarioApiDTO で使用します。 |
DTO パラメータ |
■ DTO:ScenarioApiDTO パラメータ:changes 手順:loadChanges または configChanges パラメータを使用します。 |
EOL: 8.10.1
8.10.1 リリースでは、次の廃止に関する変更が行われます。廃止機能は、廃止時点で API から削除されます。
エンドポイント |
なし |
リクエスト |
なし |
要求パラメータ |
なし |
DTO |
なし |
DTO パラメータ |
■ DTO: StatApiInputDTO パラメータ名:costPrice 手順: 代わりに、/entities、/groups、および /markets の専用のコストエンドポイントを使用します。 注: これらは現在「開発中」とマークされていますが、まもなく一般提供される予定です。
– /entities/{entity_Uuid}/cost – /groups/{group_Uuid}/cost – /markets/{market_Uuid}/cost |
以下のエンドポイント、リクエスト、DTO、およびパラメータは、Workload Optimization Manager API で廃止されました。サポート終了(EOL)により、これらの変更を確定する製品バージョンが提供されます。廃止項目は提供されなくなります。
これらの廃止機能は、API から削除されます。
エンドポイント |
なし |
リクエスト |
■ DELETE /entities/<entityId>/tags/<tagKey> 代わりに、DELETE /entities/<entityId>/tags?key=<tagKey> を使用します。 ■ DELETE /groups/<groupId>/tags/<tagKey> 代わりに、DELETE /groups/<groupId>/tags?key=<tagKey> を使用します。 |
要求パラメータ |
なし |
DTO |
■ LicenseApiInputDTO 手順:LicenseApiDTO を使用します。 |
DTO パラメータ |
■ DTO:HttpProxyDTO パラメータ名:portNumber 手順:proxyPortNumber を使用します。 ■ DTO:LogEntryApiDTO パラメータ名:reasonCommodity 手順:配列 reasonCommodities を使用します。 |
動作の変更:
■ /search リクエストから返されたデータのページネーション:
検索の場合、API は返されたデータをページネーションします。バージョン 8.6.1 以降、デフォルトのページネーション制限は 100 エントリで、最大ページネーション制限は 500 です。ページネーション制限を指定しない場合、API はデフォルトの制限 100 に設定されたページを返します。設定を行わず、検索結果に 100 を超えるエントリが含まれている場合、結果はページ分割されます。スクリプトは、検索結果を処理するときに常にページネーションカーソルをチェックする必要があります。
Workload Optimization Manager の cr.yaml ファイルのこれらの設定を変更することができます。次のエントリを見つけます。
– apiPaginationDefaultLimit
– apiPaginationMaxLimit
8.6.1 リリースでは、次の廃止に関する変更が行われました。廃止機能は、廃止時点で API から削除されました。
エンドポイント |
なし |
リクエスト |
なし |
要求パラメータ |
なし |
DTO |
■ ReportScheduleApiDTO このリリースでは、ReportScheduleApiDTO が削除されます。 |
DTO パラメータ |
■ DTO:ActionApiDTO パラメータ名:CurrentLocation 手順:このパラメータのオブジェクトには、次のフィールドのみが含まれます。
– リンク
– uuid
– className
– displayName
– discoveredBy
– environmentType
– vendorIDs ■ DTO:ActionApiDTO パラメータ名:NewLocation 手順:このパラメータのオブジェクトには、次のフィールドのみが含まれます。
– リンク
– uuid
– className
– displayName
– discoveredBy
– environmentType
– vendorIDs ■ DTO:ProductVersionDTO パラメータ名:buildUser 手順:代替機能なしで廃止。このパラメータは、8.x 製品ファミリでは導入されていませんでした。 |
|
■ DTO:GroupApiDTO パラメータ名:remoteId 手順:代替機能なしで廃止。このパラメータは、8.x 製品ファミリでは導入されていませんでした。 ■ DTO:UserApiDTO パラメータ名:
– roleUuid
– roleName 手順:非推奨。UserApiDTO のロールパラメータを使用します。 |
動作の変更:
■ 返されたデータのページネーション
次のリクエストに対しては、デフォルトのページネーションが変更されます。
– GET /groups
– GET /groups/<groupId>/members
– GET /groups/<groupId>/entities
– GET /targets/ /entities<targetId>
– GET /tags
– GET /tags/{tagKey}/entities
返されたデータのページネーションを行うには、limit、orderBy、および cursor パラメータで、API によるデータのページネーション方法を制御します。現在、これらのパラメータのいずれかを指定すると、API は返されたデータをページ分割します。これらのパラメータのいずれも指定しない場合、API は出力のページネーションを行わず、無制限のデータセットを返します。
バージョン 8.5.1 以降、これらのリクエストに limit を指定しない場合、API はデータをデフォルトの制限でページネーションを行います。limit を設定せずにスクリプトでこれらのリクエストが行われる場合、スクリプトを更新して、返されたデータのページネーションカーソルを確認する必要があります。
8.5.1 リリースでは、次の廃止に関する変更が行われました。廃止機能は、廃止時点で API から削除されました。
エンドポイント |
なし |
リクエスト |
■ リクエスト:GET /users/onetimepassword 手順:代替機能なしで廃止。これは、Workload Optimization Manager のアクティビティには必要ありません。 |
要求パラメータ |
なし |
DTO |
なし |
DTO パラメータ |
なし |
8.4.3 リリースでは、次の廃止に関する変更が行われました。廃止機能は、廃止時点で API から削除されました。
エンドポイント |
なし |
リクエスト |
なし |
要求パラメータ |
■ リクエスト:GET /search パラメータ名:regex 手順:queryType パラメータを使用します。 |
DTO |
■ DTO:StatPercentileApiDTO 手順:StatHistUtilizationApiDTO を使用します。 |
DTO パラメータ |
■ DTO:ActionApiDTO パラメータ名:resizeToValue 手順:newValue パラメータを使用します。 ■ DTO:ActionScopesApiDTO ■ DTO:BillingFamilyApiDTO パラメータ名:uuidToNameMap 手順:businessUnitApiDTOList パラメータを使用します。 ■ DTO:BusinessUnitApiDTO パラメータ名:hasRelatedTarget 手順:associatedTargetId パラメータを使用します。 ■ DTO:ScopeUuidsApiInputDTO ■ DTO:StatApiDTO パラメータ名:percentile 手順:histUtilizations パラメータを使用します。 ■ DTO:TargetApiDTO パラメータ名:currentBusinessAccount 手順:associatedTargetId パラメータを使用します。 BusinessUnitApiDTO。 |