CLIコマンド

リソース分析の CLIコマンドのリスト。

コマンド 摘要 必須 オプション
oci resource-analytics -h
リソース・アナリティクス・コントロール・プレーンCLIを使用して、リソース・アナリティクス・インスタンスとそのテナンシ・アタッチメントを管理するか、ADWインスタンスでOACを有効化/無効化します。
リソース分析インスタンス
oci resource-analytics resource-analytics-instance -h
ResourceAnalyticsInstanceは、すべてのお客様のOCIリソースに対応するADWハウジング分析です。
oci resource-analytics resource-analytics-instance create [OPTIONS]
ResourceAnalyticsInstanceを作成します。 --adw-admin-password-password [テキスト]--compartment-id、 -c [テキスト]--included-regions [複合タイプ]--subnet-id [テキスト] --defined-tags [複合型]-- 説明[テキスト]--display-name [テキスト]--freeform-tags [複合型]--from-json [テキスト]--is-mutual-tls-required [ブール]--max-wait-seconds [整数]--nsg-ids [複合型]--wait-for-state [テキスト]--wait-interval-seconds [整数]
oci resource-analytics resource-analytics-instance change-compartment [OPTIONS]
ResourceAnalyticsInstanceを同じテナンシ内の別のコンパートメントに移動します。コンパートメント間でのリソース移動の詳細は、別のコンパートメントへのリソースの移動を参照してください。

--compartment-id、-c [テキスト]

--resource-analytics-instance-id [テキスト]

--from-json [テキスト]

--if-match [テキスト]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

oci resource-analytics resource-analytics-instance delete [OPTIONS]
ResourceAnalyticsInstanceを削除します。 --resource-analytics-instance-id [テキスト]

--force

--from-json [テキスト]

--if-match [テキスト]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

oci resource-analytics resource-analytics-instance disable-oac [OPTIONS]
ResourceAnalyticsInstanceのOACインスタンスを無効にします。 --resource-analytics-instance-id [テキスト]

--from-json [テキスト]

--if-match [テキスト]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

oci resource-analytics resource-analytics-instance enable-oac [OPTIONS]
OACインスタンスをResourceAnalyticsInstanceにアタッチします。

--attachment-details [複合タイプ]

--attachment-type [テキスト]

--resource-analytics-instance-id [テキスト]

--from-json [テキスト]

--if-match [テキスト]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

oci resource-analytics resource-analytics-instance get [OPTIONS]
ResourceAnalyticsInstanceに関する情報を取得します。 --resource-analytics-instance-id [テキスト] --from-json [テキスト]
oci resource-analytics resource-analytics-instance list [OPTIONS]
ResourceAnalyticsInstancesのリストを取得する。

-- すべて

--compartment-id、-c [テキスト]

--display-name [テキスト]

--from-json [テキスト]

--id [テキスト]

--lifecycle-state [テキスト]

--limit [整数]

-- ページ[テキスト]

--page-size [整数]

--sort-by [テキスト]

--sort-order [テキスト]

oci resource-analytics resource-analytics-instance update [OPTIONS]
ResourceAnalyticsInstanceを更新します。 --resource-analytics-instance-id [テキスト]

--defined-tags [複合型]

-- 説明[テキスト]

--display-name [テキスト]

--force

--freeform-tags [複合型]

--from-json [テキスト]

--if-match [テキスト]

--included-regions [複合タイプ]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

テナンシ添付
oci resource-analytics tenancy-attachment -h
TenancyAttachmentは、ResourceAnalyticsInstanceにアタッチされた顧客のテナンシです。アタッチされたテナンシは、分析コレクションに含まれています。
oci resource-analytics tenancy-attachment create [OPTIONS]
TenancyAttachmentを作成します。 --resource-analytics-instance-id [テキスト]--tenancy-id [テキスト] -- 説明[テキスト]--from-json [テキスト]--max-wait-seconds [整数]--wait-for-state [テキスト]--wait-interval-seconds [整数]
oci resource-analytics tenancy-attachment delete [OPTIONS]
TenancyAttachmentを削除します。 --tenancy-attachment-id [テキスト]

--force

--from-json [テキスト]

--if-match [テキスト]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

oci resource-analytics tenancy-attachment get [OPTIONS]
TenancyAttachmentに関する情報を取得します。 --tenancy-attachment-id [テキスト] --from-json [テキスト]
oci resource-analytics tenancy-attachment list [OPTIONS]
TenancyAttachmentsのリストを取得する。

-- すべて

--from-json [テキスト]

--id [テキスト]

--lifecycle-state [テキスト]

--limit [整数]

-- ページ[テキスト]

--page-size [整数]

--resource-analytics-instance-id [テキスト]

--sort-by [テキスト]

--sort-order [テキスト]

oci resource-analytics tenancy-attachment update [OPTIONS]
TenancyAttachmentを更新します。

-- 説明[テキスト]

--tenancy-attachment-id [テキスト]

--from-json [テキスト]

--if-match [テキスト]

--max-wait-seconds [整数]

--wait-for-state [テキスト]

--wait-interval-seconds [整数]

作業リクエスト
oci resource-analytics work-request -h
非同期作業リクエスト。作業リクエストは、長時間実行操作の監視に役立ちます。長時間実行操作を開始すると、サービスによって作業リクエストが作成されます。作業リクエストとは、操作の進行状況の各ステップをトラッキングできるアクティビティ・ログのことです。各作業リクエストには、プログラムで操作し、自動化に使用できるOCIDが含まれます。
oci resource-analytics work-request cancel [OPTIONS]
作業リクエストを取り消します。 --work-request-id [テキスト]

--force

--from-json [テキスト]

--if-match [テキスト]

oci resource-analytics work-request get [OPTIONS]
作業リクエストの詳細を取得します。 --work-request-id [テキスト] --from-json [テキスト]
oci resource-analytics work-request list [OPTIONS]
コンパートメント内の作業リクエストをリストします。

-- すべて

--compartment-id、-c [テキスト]

--from-json [テキスト]

--limit [整数]

-- ページ[テキスト]

--page-size [整数]

--resource-id [テキスト]

--sort-by [テキスト]

--sort-order [テキスト]

--status [テキスト]

--work-request-id [テキスト]

作業リクエスト・エラー
oci resource-analytics work-request-error -h
作業リクエストによって追跡される操作の実行中にエラーが発生しました。
oci resource-analytics work-request-error list [OPTIONS]
作業リクエストのエラーをリストします。 --work-request-id [テキスト]

-- すべて

--from-json [テキスト]

--limit [整数]

-- ページ[テキスト]

--page-size [整数]

--sort-by [テキスト]

--sort-order [テキスト]

作業リクエスト・ログ
oci resource-analytics work-request-log-entry -h
作業リクエストによって追跡される操作の実行からのログ・メッセージ。
oci resource-analytics work-request-log-entry list [OPTIONS]
作業リクエストのログをリストします。 --work-request-id [テキスト]

-- すべて

--from-json [テキスト]

--limit [整数]

-- ページ[テキスト]

--page-size [整数]

--sort-by [テキスト]

--sort-order [テキスト]

パラメータの説明

パラメータ 摘要 SDK標準テキスト
--adw-admin-password-password [テキスト] ユーザー・テナンシに作成するADWのパスワード。パスワードは12から30文字の長さで、大文字、小文字および数字をそれぞれ1つ以上含める必要がある。二重引用符記号"や、ユーザー名adminを含めることはできません(大文字/小文字にかかわらない)。
-- すべて 結果のすべてのページをフェッチします。このオプションを指定する場合は、--limitオプションを指定できません。 SDK標準テキスト
--attachment-details [複合タイプ]

これは複合型で、その値は有効なJSONである必要があります。値は、コマンドラインで文字列として指定するか、またはfile://path/to/file構文を使用してファイルとして渡すことができます。

--generate-param-json-inputオプションを使用すると、指定する必要があるJSONの例を生成できます。この例は、ファイルに格納し、必要に応じて修正してから、file://構文に従って渡して戻すことをお薦めします。

--attachment-type [テキスト]

OACインスタンスが使用しているアタッチメントのタイプ。

指定できる値は次のとおりです。

MANAGED
--compartment-id、-c [テキスト] ResourceAnalyticsInstanceを作成するコンパートメントのOCID。ResourceAnalyticsInstanceの移動先のコンパートメントのOCID。リソースをリストするコンパートメントのOCID
--defined-tags [複合型]

このリソースに対して定義されているタグ。各キーは事前定義され、ネームスペースにスコープ指定されます。詳細は、リソース・タグを参照してください。

例:

{"Operations": {"CostCenter": "42"}}

これは複合型で、その値は有効なJSONである必要があります。値は、コマンドラインで文字列として指定するか、またはfile://path/to/file構文を使用してファイルとして渡すことができます。

--generate-param-json-inputオプションを使用すると、指定する必要があるJSONの例を生成できます。この例は、ファイルに格納し、必要に応じてそれを変更してから、file://構文に従って渡して戻ることをお薦めします。

SDK標準テキスト
-- 説明[テキスト] ResourceAnalyticsInstanceインスタンスの説明。テナンシの説明。
--display-name [テキスト] わかりやすい名前。一意である必要はなく、変更可能です。機密情報を入力しないでください。特定の表示名に正確に一致するリソースのみを返すフィルタ。
--id [テキスト]

ResourceAnalyticsInstanceのOCID

TenancyAttachmentのOCID

--if-match [テキスト] 楽観的な同時実行性制御。リソースのPUTまたはDELETEコールで、if-matchパラメータを、そのリソースの以前のGETまたはPOSTレスポンスからのetagの値に設定します。そのリソースが更新または削除されるのは、指定したタグがそのリソースの現在のetagの値と一致する場合のみです。 SDK標準テキスト
--included-regions [複合タイプ]

データ収集に含めるリージョン。リージョンID。たとえば、us-ashburn-1。少なくとも1つのリージョンが必要です。これは複合型で、その値は有効なJSONである必要があります。値は、コマンドラインで文字列として指定することも、file://path/to/file構文を使用してファイルとして渡すこともできます。

--generate-param-json-inputオプションを使用すると、指定する必要があるJSONの例を生成できます。この例は、ファイルに格納し、必要に応じてそれを変更してから、file://構文に従って渡して戻ることをお薦めします。

--is-mutual-tls-required [ブール値] ADWデータベースへの接続を認証する場合は、相互TLS (mTLS)が必要です。
--freeform-tags [複合型]

このリソースのフリーフォーム・タグ。各タグは、名前、タイプまたはネームスペースが定義されていないキーと値のペアになります。詳細は、リソース・タグを参照してください。

例:

{"Department": "Finance"}

これは複合型で、その値は有効なJSONである必要があります。値は、コマンドラインで文字列として指定するか、またはfile://path/to/file構文を使用してファイルとして渡すことができます。

--generate-param-json-inputオプションを使用すると、指定する必要があるJSONの例を生成できます。この例は、ファイルに格納し、必要に応じてそれを変更してから、file://構文に従って渡して戻ることをお薦めします。

SDK標準テキスト
--from-json [テキスト]

file://path-to/file構文を使用して、このコマンドへの入力をファイルからのJSONドキュメントとして指定します。

--generate-full-command-json-inputオプションを使用すると、このコマンド・オプションとともに使用するサンプルjsonファイルを生成できます。キー名は、事前に入力されており、コマンド・オプション名(camelCase形式に変換される)と一致しています。たとえば、compartment-idcompartmentIdになりますが、キーの値は、このコマンドへの入力としてサンプル・ファイルを使用する前に、ユーザーが移入する必要があります。多数の値を受け入れるコマンド・オプションの場合、キーの値はJSON配列にすることができます。

オプションは、引き続きコマンドラインで指定できます。オプションがJSONドキュメントとコマンドラインの両方に存在する場合は、コマンドラインで指定された値が使用されます

このオプションの使用例は、CLIと拡張JSONオプションの使用を参照してください

SDK標準テキスト
--force

確認を求めずに削除を実行します。

確認を要求せずに更新を実行します。

SDK標準テキスト
--lifecycle-state [テキスト]

特定のライフサイクル状態に一致するリソースのみを返すフィルタ。状態値では大文字と小文字が区別されません。

指定できる値は次のとおりです。

ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
SDK標準テキスト
--limit [整数] リストのページ分割用。ページ当たりの最大結果数、またはページ区切りされるListコールで返すアイテムの数。ページ区切りの仕組みの重要な詳細は、リスト・ページ区切りを参照してください。 SDK標準テキスト
--max-wait-seconds [整数] 作業リクエストが--wait-for-stateで定義された状態に達するまで待機する最大時間。デフォルト値は1200秒です。 SDK標準テキスト
--nsg-ids [複合タイプ]

ネットワーク・セキュリティ・グループOCIDのリスト。これは複合型で、その値は有効なJSONである必要があります。値は、コマンドラインで文字列として指定するか、またはfile://path/to/file構文を使用してファイルとして渡すことができます。

--generate-param-json-inputオプションを使用すると、指定する必要があるJSONの例を生成できます。この例は、ファイルに格納し、必要に応じてそれを変更してから、file://構文に従って渡して戻ることをお薦めします。

-- ページ[テキスト] リストのページ分割用。前のListコールからのopc-next-pageレスポンス・ヘッダー値。ページ区切りの仕組みの重要な詳細は、リスト・ページ区切りを参照してください。 SDK標準テキスト
--page-size [整数] 結果をフェッチする場合、コールごとにフェッチする結果の数。--allまたは--limitとともに使用した場合にのみ有効であり、それ以外の場合は無視されます。 SDK標準テキスト
--resource-analytics-instance-id [テキスト]

ResourceAnalyticsInstanceのOCID

ResourceAnalyticsInstanceのOCID

--resource-id [テキスト] 作業リクエストの影響を受けるリソースのOCID SDK標準テキスト
--sort-by [テキスト]

並べ替えるフィールド。指定できるソート順は1つのみです。TIME_CREATEDのデフォルトの順序は降順です。DISPLAY_NAMEのデフォルトの順序は昇順です。

指定できる値は次のとおりです。

DISPLAY_NAME, TIME_CREATED

並べ替えるフィールド。1つのソート順序のみを指定できます。timeAcceptedのデフォルトの順序は降順です。

指定できる値は次のとおりです。

timeAccepted
SDK標準テキスト
--sort-order [テキスト]

使用するソート順序。昇順(ASC)または降順(DESC)。

指定できる値は次のとおりです。

ASC, DESC
SDK標準テキスト
--status [テキスト]

特定のライフサイクル状態に一致するリソースのみを返すフィルタ。

指定できる値は次のとおりです。

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
SDK標準テキスト
--subnet-id [テキスト] リソースが関連付けられているサブネットのOCID
--wait-for-state [テキスト]

この操作では、リソースを非同期で作成、変更または削除し、作業リクエストを使用して操作の進行状況を追跡します。このオプションを指定してアクションを実行し、作業リクエストが特定の状態に達するまで待機します。いくつかの状態を指定でき、最初の状態のときに返されます。たとえば、--wait-for-state SUCCEEDED --wait-for-state FAILEDは、最初に達したライフサイクル状態のときに返されます。タイムアウトに達すると、リターン・コード2が返されます。その他のエラーの場合は、リターン・コード1が返されます。

指定できる値は次のとおりです。

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
SDK標準テキスト
--wait-interval-seconds [整数] --wait-interval-secondsごとに、作業リクエストが--wait-for-stateで定義された状態に達しているかどうかを確認します。この値のデフォルトは30秒です。 SDK標準テキスト
--work-request-id [テキスト] 非同期作業リクエストのOCID SDK標準テキスト