Workload Optimization Manager 3.4.4 REST API の変更点
2022 年 9 月 23 日
このドキュメントでは、REST API の変更につながる問題について説明します。これは、API プログラミング ガイドの次のリリースまでに蓄積される変更の実行リストです。プログラミング ガイドの新しいバージョンをリリースするときに、これらの変更が含まれます。その時点で、このリストは API への新しい変更から始まります。
API は Workload Optimization Manager 製品を完全に反映しているため、製品に変更を加えると、必然的に API も変更されます。これには、製品のバグ修正や改善が含まれる場合があります。たとえば、特定のエンティティ タイプで入手できる新しい商品を追加する場合があります。または、バグ修正により、API リクエストによって返されるデータが変更される可能性があります。可能な限り、これらの変更に下位互換性を持たせるよう努めています。
場合によっては、下位互換性のない変更を加える必要があります。この場合、変更を理解し、スクリプトに代替を実装するのに十分な期間、変更を非推奨にします。
▪ 今後の非推奨のリストについては、「 API 非推奨コントラクト」(2 ページ)を参照してください。
修正バージョン:8.2.5
修正バージョン:8.6.3
このリリースでは、独自のサプライ チェーン トポロジを定義するために使用できる /supplychains/leafEntities エンドポイントが導入されています。このエンドポイントは、「シード エンティティ」に関連する「リーフ エンティティ」のリストを返します。
シード エンティティは、ユーザー定義トポロジを定義するための開始点として機能します。Workload Optimization Manager は、指定されたシード エンティティを使用して、関連するすべてのエンティティ(またはリーフ エンティティ)を検索します。たとえば、トポロジを定義するには、頻繁にモニタする VM(シード エンティティ)の UUID を指定することから始めます。GET /supplychains/ を実行すると
LeafEntities、Workload Optimization Manager は 3 つのリーフ エンティティ(ビジネスアプリケーション、アプリケーション)を返す場合があります。
コンポーネント、および VM がサポートするサービス。その後、シード エンティティとリーフ エンティティに基づいてトポロジ定義を作成できます。
修正バージョン:8.6.1
Workload Optimization Manager バージョン 3.4.1 以降、ServiceEntities、Groups、または BusinessAccount エンドポイントで実行すると、GET および POST メソッドは最大 500 のエントリを返します。結果のページネーションを常に確認する必要があります。
以下のエンドポイント、リクエスト、DTO、およびパラメータは、Workload Optimization Manager API で廃止されました。サポート終了(EOL)により、これらの変更を確定する製品バージョンが提供され、廃止項目は提供されなくなります。
注:
EOL が定義されている廃止項目については、代替の使用方法を参照してください。
EOL:未定
以下の機能は廃止予定ですが、どの Workload Optimization Manager バージョンがサポート終了となるかは特定されていません。
エンドポイント |
なし |
リクエスト |
なし |
要求パラメータ |
なし |
DTO |
▪ DTO:ScenarioChangeApiDTO 手順:Scenario•ApiDTO で loadChanges または configChanges パラメータを使用します。 |
DTO パラメータ |
▪ DTO:ScenarioApiDTO パラメータ:changes 手順:loadChanges または configChanges パラメータを使用します。 |
8.7.1 リリースでは、次の廃止に関する変更が行われます。廃止機能は、廃止時点で 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 を使用します。 |
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/<entity• Id>/stats を使用します。これらの呼び出しは、ビジネス ユニット エンティティ ID を使用します。 ▪ POST /businessunits/<busUnitId>/stats 代わりに、POST /stats/ <entityId>/stats または POST /stats を使用してください。 |
要求パラメータ |
なし |
DTO |
なし |
DTO パラメータ |
なし |
ENUM 値 |
▪ entityType:VMSpec 代わりに、VirtualMachineSpec を使用してください。 ▪ entityTypes:VMSpec 代わりに、VirtualMachineSpec を使用してください。 ▪ entityTypeFilter:VMSpec 代わりに、VirtualMachineSpec を使用してください。 ▪ providerEntityType:VMSpec 代わりに、VirtualMachineSpec を使用してください。 ▪ relatedEntityType:VMSpec 代わりに、VirtualMachineSpec を使用してください。 |
|
▪ providerType:VMSpec 代わりに、VirtualMachineSpec を使用してください。 |
以下のエンドポイント、リクエスト、DTO、およびパラメータは、Workload Optimization Manager API で廃止されました。サポート終了(EOL)により、これらの変更を確定する製品バージョンが提供され、廃止項目は提供されなくなります。
▪ /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 のロールパラメータを使用します。 |
▪ 返されたデータのページネーション
次のリクエストに対しては、デフォルトのページネーションが変更されます。
|
|
|
|
|
|
返されたデータをページネーションするには、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 パラメータ名:limitEntities 手順:limit パラメータを使用します。 ▪ DTO:BillingFamilyApiDTO パラメータ名:uuidToNameMap 手順:businessUnitApiDTOList パラメータを使用します。 ▪ DTO:BusinessUnitApiDTO パラメータ名:hasRelatedTarget 手順:associatedTargetId パラメータを使用します。 ▪ DTO:ScopeUuidsApiInputDTO パラメータ名:topologyContextId 手順:marketId パラメータを使用します。 ▪ DTO:StatApiDTO パラメータ名:percentile 手順:histUtilizations パラメータを使用します。 ▪ DTO:TargetApiDTO パラメータ名:currentBusinessAccount 手順:BusinessUnitApiDTO の associatedTargetId パラメータを使用します。 |