Cisco UCS Director REST 開発者ガイド、リリース 4.1
API の操作
API の操作
発行日;2014/02/05   |   ドキュメントご利用ガイド   |   ダウンロード ;   この章 pdf   ,   ドキュメント全体 pdf    |   フィードバック

API の操作

この章は、次の内容で構成されています。

REST API の操作の概要

この項に記載された Cisco UCS Director REST API 操作のカタログは、どの操作がニーズに対応するか、各操作をどのように行うかを知るために役立ちます。 レポート メタデータおよび REST API ブラウザを介した API 操作の要求と応答値の例が記載されています。


(注)  


この項に記載されている操作はデータの GET と POST を行います。 データの POST 操作は主にサービスとプロビジョニングに使用されます。


ログインの操作

userAPIGetMyLoginProfile

説明

ログインしたユーザに関する情報を返します。

パラメータ

なし。

戻り値のタイプ

APILoginProfile

アクセス可能

管理者/エンド ユーザ

userAPIGetUserLoginProfile

説明

特定のユーザ ID に関するユーザ情報を返します。

パラメータ

String userId

戻り値のタイプ

APILoginReport

アクセス可能

管理者/エンド ユーザ


(注)  


ユーザ アカウントの操作も参照してください。ユーザの追加、オンボーディング、パスワードの管理、プロファイルなどの操作が説明されています。


ユーザ アカウントの操作

userAPIAddUser

説明

提供された情報(ユーザ ID、パスワード、電子メールなど)とともにユーザを追加します。

パラメータ
  • String userId
  • String password
  • String firstName
  • String lastName
  • String email
  • String role
  • String groupName
戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIOnBoarding

説明

APIUserOnBoardDetails 引数で提供された詳細を使用し、ユーザ、グループ、VDC を作成します。

パラメータ

APIUserOnBoardParams inParams

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

APIUserOnBoardDetails

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPIGetUserLoginProfile

説明

特定のユーザ ID に関するユーザ情報を返します。

パラメータ

String userId

戻り値のタイプ

APILoginReport

アクセス可能

管理者/エンド ユーザ

userAPIDeleteUser

説明

特定のユーザ ID のユーザを削除します。

パラメータ

String userId

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIResetMyPassword

説明

ユーザ アカウントのパスワードを、要求で提供された新しいパスワードにリセットします。

パラメータ

String newPassword

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIResetUserPassword

説明

ユーザのパスワードを、提供されたユーザ ID と新しいパスワードにリセットします。

パラメータ
  • String user ID
  • String newPassword
  • boolean resetAPIKey

(注)  


restAPKey が true に設定されている場合には、パスワードのリセットだけでなく、REST API キーも Cisco UCS Director によってリセットされます。 false に設定されている場合には、その特定ユーザのパスワードのみがリセットされ、REST API キーは変更されません。 restAPKey が true に設定されている場合には、ユーザは何もする必要がありません。 パスワードのリセット時に REST API キーをリセットするか否かを決める必要があります。


戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIVerifyUser

説明

提供されたパスワードでユーザを認証します。

パラメータ
  • String userId
  • String passWord
戻り値のタイプ

APILoginProfile

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

アクセス可能

管理者/エンド ユーザ


(注)  


ログインの操作も参照してください。


レポートの操作

userAPIGetAvailableReports

説明

特定のコンテキストで利用可能なレポートを返します。

パラメータ
  • String contextName
  • String contextValue
戻り値のタイプ

List

アクセス可能

管理者/エンド ユーザ

userAPIGetTabularReports

説明

特定のコンテキストとレポート ID について表形式のレポートを返します。

パラメータ
  • String contextName
  • String contextValue
  • String reportId
戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetHistoricalReport

説明

特定のコンテキスト、レポート ID、および期間について表形式のレポートを返します。

パラメータ
  • String contextName
  • String contextValue
  • String reportId
  • String durationName
戻り値のタイプ

APIHistoricalReport

アクセス可能

管理者/エンド ユーザ

userAPIGetInstantDataReport

説明

特定のコンテキストとレポート ID についてスナップショット レポートを返します。

パラメータ
  • String contextName
  • String contextValue
  • String reportId
\
戻り値のタイプ

APISnapshotReport

アクセス可能

管理者/エンド ユーザ

userAPIGetTabularReportWithMetaData

説明

メタデータを含むレポートを提供します。

パラメータ
  • String contextName
  • String contextValue
  • String reportId
戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

承認の操作

userAPIGetMyApprovalList

説明

ログインしたユーザの承認リストを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIUpdateMyApproval

説明

提供されたデータを使用し、現在のユーザの承認ステータスを更新します。

パラメータ
  • int requestId
  • int entryId
  • boolean isApproved
  • String comments
戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

カタログの操作

userAPICreateCatalogItem

説明

提供データで定義された特徴でカタログ項目を作成します。

パラメータ

APICatalogItem item

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者

userAPIGetAllCatalogs

説明

すべてのカタログ レポートを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetCatalogsPerGroup

説明

特定のグループに割り当てられたカタログを返します。

パラメータ

String groupName

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetAllCatalogs

説明

すべてのカタログ レポートを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

チャージバックの操作

userAPIChargebackDetails

説明

ログインしたユーザ グループに関するチャージバックの詳細を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

資金の操作

userAPICheckFunds

説明

利用可能な顧客の資金を返します。

パラメータ

String userID

戻り値のタイプ

Double(利用可能な資金)

アクセス可能

管理者/エンド ユーザ


(注)  


支払いステータスの操作も参照してください。


グループの操作

userAPIAddGroup

説明

指定されたデータ(グループ名、説明、名前、電子メール)とともにグループを追加します。

パラメータ
  • String groupName
  • String description
  • String firstName
  • String lastName
  • String contactEmail
戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者


(注)  


userAPIGetCatalogsPerGroup など多くの操作がグループ値に関連付けられています。 詳細については、主要操作のカテゴリを参照してください。


インベントリ(クラウド)の操作

userAPIRequestInventoryCollection

説明

指定されたクラウドのインベントリ収集をトリガーします。

パラメータ

String cloudName

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

LOV プロバイダーの操作

userAPIgetStaticListByName

説明

リストの要素を返します。

パラメータ

リストの名前

戻り値のタイプ

FormLOVPair[]

アクセス可能

管理者/エンド ユーザ

userAPIgetBMAOSList

説明

Cisco UCS Director Baremetal Agent OS 名のリストを返します。

パラメータ

なし。

戻り値のタイプ

FormLOVPair[]

アクセス可能

管理者/エンド ユーザ

userAPIGetLOVProvidersList

説明

システム内の利用可能なリストの名前を返します。

パラメータ

なし。

戻り値のタイプ

List<String>

アクセス可能
管理者/エンド ユーザ

支払いステータスの操作

userAPIUpdatePaymentStatus

説明

金額およびタイムスタンプで支払いステータスを更新します。

パラメータ

APIMakePaymentParams inParams

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ


(注)  


資金の操作も参照してください。


リソース アカウンティングおよび制限

userAPIGetResourceAccounting

説明

ログインしたユーザ グループのリソース使用状況を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetResourceAccountingDetails

説明

ログインしたユーザ グループのリソース使用状況の詳細を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetResourceLimits

説明

要求されたグループに対するリソース制限を返します。

パラメータ

String groupName

戻り値のタイプ

APITabularReport

アクセス可能

管理者

userAPIGetResourceLimitsForMyGroup

説明

ログインしたグループのリソース制限を返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

サービス コンテナの操作

userAPICreateServiceContainer

説明

サービス リクエストの SR ID を整数値として返します。

パラメータ
  • groupName:ユーザが所属し、コンテナ プロビジョニング許可が許可されているグループの名前。
  • catalogName:アプリケーション コンテナ テンプレートを含むカタログの名前。
  • serviceContainerName:作成されるサービス コンテナの名前。
  • Comments:プロビジョニング操作に関するコメント。
戻り値のタイプ

整数

アクセス可能

管理者/エンド ユーザ

サービス要求操作

userAPISubmitServiceRequest

説明

VM プロビジョニングのサービス要求を送信します。 Qty 1 をサポートします。

パラメータ
  • String catalogName
  • String vdcName
  • int durationHours
  • int qty
  • String comments
戻り値のタイプ

整数(サービス リクエスト ID)

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceRequests

説明

ユーザ グループのすべてのサービス リクエストを返します。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceRequestDetails

説明

サービス要求の詳細を返します。

パラメータ

int requestId

戻り値のタイプ

APIServiceRequestDetails

アクセス可能

管理者/エンド ユーザ

userAPICancelServiceRequest

説明

進行中のサービス要求をキャンセルします。

パラメータ

int requestID

戻り値のタイプ

ブール値

アクセス可能

管理者/エンド ユーザ

userAPIGetServiceRequestLogEntries

説明

要求された重大度のサービス要求のログ エントリを返します。

  • 0:デバッグ
  • 1:情報
  • 2:警告
  • 3:エラー
パラメータ
  • int srId
  • int severity(0 ~ 3)
戻り値のタイプ

ServiceRequestLogEntry[ ]

アクセス可能

管理者

userAPIGetServiceRequestWorkFlow

説明

サービス要求ワークフローの詳細を返します。

パラメータ

int requestId

戻り値のタイプ

APIWorkFlowStatus

このレポートの例については、レポートおよび JSON オブジェクト応答サンプル を参照してください。

アクセス可能

管理者/エンド ユーザ

userAPISubmitVAppServiceRequest

説明

仮想アプリケーション カタログ タイプおよび引数とともにサービス要求を送信します。

パラメータ
  • String catalogName
  • APINameValueList list
戻り値のタイプ

int(サービス リクエスト ID)

アクセス可能

管理者/エンド ユーザ

userAPIGetVMsForServiceRequest

説明

指定されたサービス要求に現在関連付けられている VM を返します。

パラメータ

int requestId

戻り値のタイプ

APIVMList

このレポートの例については、レポートおよび JSON オブジェクト応答サンプル を参照してください。

アクセス可能

管理者/エンド ユーザ

userAPISubmitWorkflowServiceRequest

説明

ワークフローとともにサービス要求を送信します。 サービス要求の ID を返します。

パラメータ
  • String workflowName
  • APINameValueList list
  • int parentSRID
戻り値のタイプ

int(サービス リクエスト ID)

アクセス可能

管理者/エンド ユーザ


(注)  


userAPIGetServiceRequestWorkFlow などのサービス要求に関連する操作については、ワークフローの操作も参照してください。


タスクの操作

タスクのさまざまな API 操作に関する情報は REST API ブラウザで見つけることができます。 詳細については、REST API ブラウザの使用を参照してください。


(注)  


ワークフローの操作も参照してください。


VDC の操作

userAPIGetAllVDCs

説明

ログインしているユーザ グループのすべての vDC(バーチャル デバイス コンテキスト)を返します。 パラメータは必要ありません。

パラメータ

なし。

戻り値のタイプ

APITabularReport

このレポートの詳細については、表形式のレポートを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPICreateVDC

説明

提供されたデータで定義された VDC(バーチャル デバイス コンテキスト)を作成します。

パラメータ

APIVDCDetails

この JSON オブジェクトの例については、JSON オブジェクト パラメータ タイプを参照してください。

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者


(注)  


ユーザ アカウントの操作userAPIOnboarding および サービス要求操作userAPISubmitServiceRequest も参照してください。


VM の操作

userAPIGetAllVMs

説明

ログインしたユーザのすべての VM を返します。 パラメータは必要ありません。

パラメータ

なし。

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetVMSummary

説明

指定された VM のサマリーを返します。

パラメータ

int vmId

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetVMsForServiceRequest

説明

指定されたサービス要求に現在関連付けられている VM を返します。

パラメータ

int requestId

戻り値のタイプ

APIVMList

レポートの例については、レポートおよび JSON オブジェクト応答サンプルを参照してください。

アクセス可能

管理者/エンド ユーザ

userAPIGetVMActionRequests

説明

特定コンテキストの VM アクション要求を返します。

パラメータ
  • String contextName
  • String contextValue
戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ

userAPIGetAvailableVMActions

説明

特定の VM ID で利用可能な VM アクションを返します。

パラメータ

int vmId

戻り値のタイプ

List

アクセス可能

管理者/エンド ユーザ

userAPIExecuteVMAction(汎用 VM の場合)

説明

特定の汎用 VM で指定された電源管理オプション アクションを実行します。

パラメータ
  • int vmId
  • String actionName:actionName の値には次が含まれます。
    • powerOn
    • powerOff
    • suspend
    • shutdownGuest
    • standby
    • reset
    • reboot
    • rebuildServer
    • pause
    • resume
    • saveState
    • discardSaveState
    • repairVM
  • String comments
戻り値のタイプ

文字列(VM アクション要求 ID)。 要求のステータス取得に使用されます。

アクセス可能

管理者/エンド ユーザ

userAPIExecuteVMAction(VMware vSphere VM の場合)

説明

特定の VMware vSphere VM で指定された電源管理オプション アクションを実行します。

パラメータ
  • int vmId
  • String actionName:actionName の値には次が含まれます。
    • vmStackView
    • accessVMCredentials
    • launchVMClient
    • assignVMToGroup
    • configureLeaseTime
    • reconfigureVM
    • powerOn
    • powerOff
    • deleteVM
    • suspend
    • shutdownGuest
    • standby
    • reset
    • reboot
    • createVMwareSnapshot
    • revertVMwareSnapshot
    • markVMwareSnapshot
    • deleteVMwareSnapshot
    • deleteAllVMwareSnapshot
    • resizeDisk
    • vmwareVMInventory
    • createVMDisk
    • deleteVMDisk
    • addVmvNic
    • deleteVmvNic
    • configureVmVNC
    • testVmVNCConnection
    • privateCloudVMClone
    • resynchVM
    • moveVMToVdc
  • String comments
戻り値のタイプ

文字列(VM アクション要求 ID)。 要求のステータス取得に使用されます。

アクセス可能

管理者/エンド ユーザ

userAPIExecuteVMAction(Microsoft Hyper-V VM の場合)

説明

特定の Microsoft Hyper-V VM で指定された電源管理オプション アクションを実行します。

パラメータ
  • int vmId
  • String actionName:actionName の値には次が含まれます。
    • assignVMToGroup
    • configureLeaseTime
    • vmStackView
    • accessVMCredentials
    • launchVMClient
    • reconfigureHyperVVM
    • powerOn
    • powerOff
    • pause
    • resume
    • createHyperVSnapshot
    • vmwareVMInventory
    • saveState
    • discardSaveState
    • shutdownGuest
    • addHyperVvNic
    • deleteHyperVvNic
    • hypervResizeDisk
    • deleteHyperVSnapshot
    • deleteAllHyperVSnapshot
    • markHypervSnapshot
    • restoreHyperVSnapshot
    • repairVM
    • deleteVM
    • removeHypervVMDisk
    • addHypervVMDisk
  • String comments
戻り値のタイプ

文字列(VM アクション要求 ID)。 要求のステータス取得に使用されます。

アクセス可能

管理者/エンド ユーザ

userAPIReconfigureVM

説明

指定された VM をリサイズします。

パラメータ
  • int vmId
  • int memorySizeInMb
  • int numVCPUS:仮想マシン用仮想 CPU の数
  • String comments
戻り値のタイプ

文字列

アクセス可能

管理者/エンド ユーザ

userAPIGetVMActionStatus

説明

特定の VM アクション要求の VM アクション ステータスを返します。

パラメータ

String requestactionId

戻り値のタイプ

APIVMActionStatus

アクセス可能

管理者/エンド ユーザ

userAPISetVMProperties

説明

VM にユーザ ラベルを割り当てます。

パラメータ
  • int vmId
  • String userLabel
戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIGetVMAccessCredentials

説明

VM アクセス クレデンシャルを返します。

パラメータ

int vmId

戻り値のタイプ

APIVMAccess

アクセス可能

管理者/エンド ユーザ

userAPIGetVMSnapshotDetails

説明

VM スナップショットの詳細を返します。

パラメータ

int vmId

戻り値のタイプ

APITabularReport

アクセス可能

管理者/エンド ユーザ/エンド ユーザ

userAPICreateVMSnapshot

説明

提供されたパラメータに基づいてスナップショットを作成します。 スナップショットは VM 上の既存データのバックアップです。 後で VM に障害が発生した場合、エンド ユーザはスナップショットに復元することができます。

パラメータ
  • int vmId
  • String name
  • String descr
  • boolean isMemory:値を true に設定すると、メモリのスナップショットを作成
  • boolean isQuiesce:値を true に設定すると、ファイル システムを休止
戻り値のタイプ

文字列(VM アクション要求 ID)

アクセス可能

管理者/エンド ユーザ

userAPICheckContextActionStatus

説明

VM アクションのステータス メッセージの詳細を返します。

パラメータ

statusId:VM アクションを実行するスレッドから更新されるデータベースからステータスをチェックするために使用される文字列の ID 値です。

戻り値のタイプ

文字列

API namespace

genericvm

アクセス可能

管理者/エンド ユーザ

ワークフローの操作

userAPIImportWorkflows

説明

システムにワークフローをインポートします。

パラメータ

APIWFExport export

戻り値のタイプ

ブール値(成功の場合 true)

アクセス可能

管理者/エンド ユーザ

userAPIExportWorkflows

説明

指定されたワークフローをエクスポートします。

パラメータ

String workflowNames

戻り値のタイプ

APICustomWorkflowDefinitionList

アクセス可能

管理者/エンド ユーザ

userAPIRollbackWorkflow

説明

指定されたサービス要求 ID をロールバックします。

パラメータ

int srId

戻り値のタイプ

int(サービス リクエスト ID)

アクセス可能

管理者

userAPIGetWorkflows

説明

フォルダ内のワークフローを返します。

パラメータ

String folderName

戻り値のタイプ

CustomActionDefinition[ ]

アクセス可能

管理者

userAPIGetWorkflowInputs

説明

ワークフローの入力を返します。

パラメータ

String workflowName

戻り値のタイプ

APINameValueList

アクセス可能

管理者

userAPIValidateWorkFlow

説明

ワークフローを検証し、結果を返します。

パラメータ

String workflowName

戻り値のタイプ

APIWFValidationResult

アクセス可能

管理者

userAPISubmitWorkflowServiceRequest

説明

ワークフローとともにサービス要求を送信します。 サービス要求の ID を返します。

パラメータ
  • String workflowName
  • APINameValueList list
  • int parentSRID
戻り値のタイプ

int(サービス リクエスト ID)

アクセス可能

管理者/エンド ユーザ