Qmonus SDK機能一覧

本ページではQmonus SDKの機能の一覧について記載します。

機能に関するお問い合わせについて

下記に示している機能に関する不具合等についてはサポートにお問い合わせください。 不具合であることが判明した場合、一時的にユーザーの皆様に対してワークアラウンドを提供するケースがございます。この際、フレームワークの非公開の内部関数を使用する場合がありますが、このケースにつきましてはワークアラウンドの2次展開はおやめください。

種別と属性について

Qmonus SDK機能一覧の種別・属性の区分についての説明です。

種別 属性
API portalで利用可能な機能 POST HTTP POSTメソッド
PUT HTTP PUTメソッド
PATCH HTTP PATCHメソッド
DELETE HTTP DELETEメソッド
GET HTTP GETメソッド
function 組み込み関数 public ユーザー公開しているcontext機能
object 組み込みオブジェクト classmethod クラスメソッド
instancemethod インスタンスメソッド
instanceattr オブジェクトで参照可能な属性

各カラムについて

Qmonus SDK機能一覧の各カラムについての説明です。

カラム
pluginで定義可能なリソース 環境作成後にinstallするユーザー定義可能なリソースです。
SDK Coreが作成するリソース ユーザー操作等によりシステムが自動作成するリソースです。
redis/DB flushにより削除されます。
master podでのみ受け付ける機能 冗長構成において、master podでのみ動作し、guest podでは4XXを返却する機能です。
RDB接続の有無 レコードの操作の有無を問わず、RDBと接続する機能のフラグです。
redis接続の有無 レコードの操作の有無を問わず、Redisと接続する機能のフラグです。
機能概要 機能の1行程度の簡単な説明です。

Qmonus SDK機能一覧

Qmonus SDKの機能の一覧を記載します。

SDKカテゴリ・APIGWコンポーネント・authサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
logon v22.2 - - Portal POST - - username, password, apiキーを使用してapiトークンを発行します。
logoff v22.2 - - Portal GET - - - 指定したapiトークンを無効化します。
tokens v22.2 - - Portal GET - - - 指定したapiトークンに紐づくアカウント情報を返却します。
accounts v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてqmonus_accountテーブルにアカウントレコードをを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてqmonus_accountテーブルに存在するアカウントレコードを変更します。
key_updateクエリがtrueの場合はAPIキーを更新します。secure_updateクエリがtrueの場合のみpasswordの更新が可能です。
v22.2 - Portal PATCH - - リクエストボディのusernameキーで指定した名前と一致するアカウントに対してapiキーを更新します。
v22.2 - Portal DELETE - - リクエストボディのusernameキーで指定した名前と一致するアカウントに対してqmonus_accountテーブルに存在するアカウントレコードを削除します。
v22.2 - Portal GET - qmonus_accountテーブルに存在するアカウントレコードを取得します。usernameクエリを使用可能です。
roles v22.2 - Portal POST - 受け付けたリクエストボディに基づいてqmonus_roleテーブルにアカウントレコードをを作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてqmonus_roleテーブルに存在するアカウントレコードを変更します。
v22.2 - Portal DELETE - path指定したrole名と一致するroleに対してqmonus_roleテーブルに存在するアカウントレコードを削除します。
v22.2 - Portal GET - - qmonus_roleテーブルに存在するアカウントレコードを取得します。

SDKカテゴリ・APIGWコンポーネント・gatewayサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
activities v22.2 - Portal DELETE - - 処理中のAPI件数をリセットします。リセット時に処理中のAPIが存在する場合そのAPI処理は以降のGETでのカウント対象になりません。
v22.2 - Portal GET - - 処理中のAPIの件数を表示します。リクエストされていないAPIの情報は返却されません。
diagnosis v22.2 - - Portal GET - - サーバ情報を取得します。
gateways v22.2 - - Portal GET - - 受け付けたリクエストボディに基づいてルーティングの経路選択をします。
statistics v22.2 - Portal DELETE - - API統計情報を削除します。
v22.2 - Portal GET - - API統計情報を取得します。
queues v22.2 - Portal POST - - - 受け付けたリクエストボディに基づいてタスクをキューに追加します。
v22.2 - Portal GET - - キューからタスクの状態を取得します。
全件の取得とpath指定したtask_idと一致する1件の取得が可能です。
routings v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてルーティングを作成・更新します。
v22.2 - Portal DELETE - - proxy_pathクエリに指定したproxy_pathと一致するルーティングを削除します。
v22.2 - Portal GET - - ルーティングを取得します。全件の取得とproxy_pathクエリに指定したproxy_pathと一致する1件の取得が可能です。
routingtree v22.2 - - Portal GET - - - ルーティングツリーを取得します。
proxy_pathクエリとreachabilityクエリを使用してルーティングの疎通試験が可能です。
graphql v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてGraphQLサービスでクエリを送信します。
v22.2 - Portal GET - - GraphQLサービスのスキーマを取得します。
parametermappers v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてパラメータマッパーを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてパラメータマッパーを変更します。
v22.2 - Portal DELETE - - path指定したparametermapper_nameと一致するパラメータマッパーを削除します。
v22.2 - Portal GET - - パラメータマッパーを取得します。全件の取得とpath指定したparametermapper_nameと一致する1件の取得が可能です。
grpcroutings v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてgRPCサーバを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したgrpcrouting_nameと一致するgRPCサーバを変更します。
v22.2 - Portal DELETE - - path指定したgrpcrouting_nameと一致するgRPCサーバを削除します。
v22.2 - Portal GET - - gRPCサーバを取得します。全件の取得とpath指定したgrpcrouting_nameと一致する1件の取得が可能です。
hotspot_synchronizers v22.2 - - Portal GET - - - APIGWサーバのプラグインとLambdaサーバのプラグインを再同期します。

SDKカテゴリ・Transactionコンポーネント・transactionサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
transactions v22.2 - Portal POST - 受け付けたリクエストボディに基づいてトランザクションを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したxidと一致するトランザクションを変更します。
v22.2 - Portal PATCH - - 受け付けたリクエストボディに基づいてpath指定したxidと一致するトランザクションの状態マシンを変更します。
v22.2 - Portal DELETE - - path指定したxidと一致するトランザクションを削除します。
v22.2 - Portal GET - - トランザクションを取得します。
pathにobject_idを指定した場合、detailクエリが使用可能です。
pathの指定がない場合、xidクエリ、xnameクエリ、xdomainクエリ、xtypeクエリ、statusクエリ、detailクエリ、minimumクエリが使用可能です。
counters v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてCounterを作成します。
v22.2 - Portal DELETE - - counter_nameクエリに指定したcounter_nameと一致するCounterを削除します。
v22.2 - Portal GET - - Counterを取得します。全件の取得とpath指定したcounter_nameと一致する1件の取得が可能です。
transaction_quotas v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてクォータ制限を作成します。
v22.2 - Portal DELETE - - xdomainクエリに指定したxdomainとxtypeクエリに指定したxtypeから一致するクォータ制限を削除します。
v22.2 - Portal GET - - クォータ制限を全件取得します。
exclusives v22.2 - Portal POST - - transactionを排他制御するためのexclusiveリソースを作成します。
v22.2 - Portal DELETE - - transactionを排他制御するためのexclusiveリソースを削除します。
v22.2 - Portal GET - - transactionを排他制御するためのexclusiveリソースを取得します。
aborthooks v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてAborthookを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したaborthook_idと一致するAborthookを更新します。
v22.2 - Portal DELETE - - path指定したaborthook_idと一致するAborthookを削除します。
v22.2 - Portal GET - - Aborthookを取得します。全件の取得とpath指定したaborthook_idと一致する1件の取得が可能です。
ipam v22.2 - Portal POST - 受け付けたリクエストボディに基づいてIpamを作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したipam_nameと一致するIpamを更新します。
v22.2 - Portal PATCH - 受け付けたリクエストボディに基づいてpath指定したipam_nameと一致するIpamをロックします。
v22.2 - Portal DELETE - path指定したipam_nameと一致するIpamを削除します。forceクエリが使用可能です。
v22.2 - Portal GET - Ipamを取得します。全件の取得とpath指定したipam_nameと一致する1件の取得が可能です。
unuseクエリ、inuseクエリ、candidateクエリ、prefixクエリ、tagクエリ、offsetクエリ、limitクエリが使用可能です。

SDKカテゴリ・Scenarioコンポーネント・scenarioサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
scenarios v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてシナリオを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてシナリオを変更します。
v22.2 - Portal DELETE - - nameクエリで指定したscenario_nameと一致するシナリオを削除します。uriクエリが使用可能です。
v22.2 - Portal GET - - シナリオを取得します。全件の取得とpath指定またはnameクエリに指定したscenario_nameと一致する1件の取得が可能です。
daemons v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてデーモンを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてデーモンを変更します。
v22.2 - Portal DELETE - - nameクエリで指定したmodel_nameと一致するデーモンを削除します。
v22.2 - Portal GET - - デーモンを取得します。全件の取得とpath指定またはnameクエリに指定したdemon_nameと一致する1件の取得が可能です。
classes v22.2 - Portal POST - 受け付けたリクエストボディに基づいてクラスを作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したclass_nameと一致するクラスを変更します。
force_rebuildクエリが使用可能です。
v22.2 - Portal DELETE - path指定したclass_nameと一致するクラスを削除します。
v22.2 - Portal GET - - クラスを取得します。全件の取得とpath指定したclass_nameと一致する1件の取得が可能です。
全件の取得の場合、types_onlyクエリが使用可能です。1件の取得の場合、hierarchy_onlyクエリが使用可能です。
daginstances v23.1 - Portal POST - - 受け付けたリクエストボディに基づいてDagInstanceを作成します。
v23.1 - Portal PATCH - - 受け付けたリクエストボディに基づいてDagを実行します。
v23.1 - Portal DELETE - - 受け付けたリクエストボディに基づいてDagInstanceを削除します。
v23.1 - Portal GET - 受け付けたリクエストボディに基づいてDagInstanceを取得します。
daglogs v23.1 - Portal GET - - dag_logテーブルからDaglogを取得します。全件の取得とpath指定したdag_instanceと一致する1件の取得が可能です。
offsetクエリとlimitクエリが使用可能です。
dags v23.1 - Portal POST - - 受け付けたリクエストボディに基づいてDagを作成します。
v23.1 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したdag_nameと一致するDagを変更します。
v23.1 - Portal DELETE - - path指定したdag_nameと一致するDagを削除します。
v23.1 - Portal GET - - Dagを取得します。全件の取得とpath指定したdag_nameと一致する1件の取得が可能です。
grpcservicers v22.2 - Portal POST - - gRPCサーバを作成します。
v22.2 - Portal PUT - - gRPCサーバを更新します。
v22.2 - Portal DELETE - - gRPCサーバを削除します。
v22.2 - Portal GET - - gRPCサーバを取得します。
instances v22.2 - Portal POST - - pythonインスタンスを作成します。
v22.2 - Portal DELETE - - pythonインスタンスを削除します。
jobs v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてジョブを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてジョブを変更します。
v22.2 - Portal DELETE - - path指定したjob_nameと一致するジョブを削除します。
v22.2 - Portal GET - - ジョブを取得します。全件の取得とpath指定したjob_nameと一致する1件の取得が可能です。
tasks v22.2 - Portal POST - - jobを動作させるためのtaskを作成します。
v22.2 - Portal GET - - jobを動作させるためのtaskを取得します。
configs v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてコンフィグを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したconfig_idと一致するコンフィグを変更します。
v22.2 - Portal DELETE - - path指定したconfig_idと一致するコンフィグを削除します。
v22.2 - Portal GET - - コンフィグを取得します。全件の取得とpath指定したconfig_idと一致する1件の取得が可能です。
functions v22.2 - Portal POST - - コンポーネントで使用可能なfunctionを作成します。
v22.2 - Portal PUT - - コンポーネントで使用可能なfunctionを更新します。
v22.2 - Portal DELETE - - コンポーネントで使用可能なfunctionを削除します。
v22.2 - Portal GET - - コンポーネントで使用可能なfunctionを取得します。
modules v22.2 - Portal POST - - コンポーネントで使用可能なmoduleを作成します。
v22.2 - Portal PUT - - コンポーネントで使用可能なmoduleを更新します。
v22.2 - Portal DELETE - - コンポーネントで使用可能なmoduleを削除します。
v22.2 - Portal GET - - コンポーネントで使用可能なmoduleを取得します。
formats v22.2 - Portal POST - - コンポーネントで使用可能な正規表現パターンを作成します。
v22.2 - Portal PUT - - コンポーネントで使用可能な正規表現パターンを更新します。
v22.2 - Portal DELETE - - コンポーネントで使用可能な正規表現パターンを削除します。
v22.2 - Portal GET - - コンポーネントで使用可能な正規表現パターンを取得します。
jsonschemas v22.2 - Portal POST - - コンポーネントで使用可能なjsonスキーマを作成します。
v22.2 - Portal PUT - - コンポーネントで使用可能なjsonスキーマを更新します。
v22.2 - Portal DELETE - - コンポーネントで使用可能なjsonスキーマを削除します。
v22.2 - Portal GET - - コンポーネントで使用可能なjsonスキーマを取得します。
kubernetes_operations v22.2 - Portal GET - - KubernetesOperationを取得します。全件の取得とpath指定したcluster_nameと一致する1件の取得が可能です。
1件の取得の場合、kindクエリ、nameクエリ、namespaceクエリが使用可能です。
templates v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてテンプレートを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてテンプレートを変更します。
v22.2 - Portal PATCH - - テンプレートのレンダリングを実行します。
v22.2 - Portal DELETE - - path指定したtemplate_tagと一致するテンプレートを削除します。
v22.2 - Portal GET - - テンプレートを取得します。全件の取得とpath指定したtemplate_tagと一致する1件の取得が可能です。
modelschemas v22.2 - Portal POST - 受け付けたリクエストボディに基づいてModelschemaを作成します。
v22.2 - Portal DELETE - nameクエリで指定したmodel_nameと一致するModelschemaを削除します。
v22.2 - Portal GET - - Modelschemaを取得します。全件の取得とnameクエリで指定したmodel_nameと一致する1件の取得が可能です。
variablegroups v22.2 - Portal POST - - variablegtoupを作成します。
v22.2 - Portal PUT - - variablegtoupを更新します。
v22.2 - Portal DELETE - - variablegtoupを削除します。
v22.2 - Portal GET - - variablegtoupを取得します。
workspaces v22.2 - Portal POST - - 開発用の名前空間を作成します。
v22.2 - Portal PUT - - 開発用の名前空間を更新します。
v22.2 - Portal DELETE - - 開発用の名前空間を削除します。
v22.2 - Portal GET - - - 開発用の名前空間を取得します。
kubernetesv1 v22.2 - Portal POST - - kubernetesクラスタ情報を登録します。
v22.2 - Portal PUT - - kubernetesクラスタ情報を更新します。
v22.2 - Portal PATCH - - - 登録したkubernetesクラスタに対してリソース操作りクエストを送ります。
v22.2 - Portal DELETE - - kubernetesクラスタ情報を削除します。
v22.2 - Portal GET - - kubernetesクラスタ情報を取得します。
closedloopcomponents v22.7 - Portal POST - closedloopcomponentリソースを作成します。
v22.7 - Portal PUT - closedloopcomponentリソースを更新します。
v22.7 - Portal DELETE - closedloopcomponentリソースを削除します。
v22.7 - Portal GET - closedloopcomponentリソースを取得します。
closedlooptypes v22.7 - Portal POST - closedlooptypeリソースを作成します。
v22.7 - Portal PUT - closedlooptypeリソースを更新します。
v22.7 - Portal DELETE - closedlooptypeリソースを削除します。
v22.7 - Portal GET - closedlooptypeリソースを取得します。
closedloopgovernance v22.7 - Portal POST - closedloopgovernanceリソースを作成します。
v22.7 - Portal PUT - closedloopgovernanceリソースを更新します。
v22.7 - Portal PATCH - closedloopインスタンスの設定を変更します。
v22.7 - Portal DELETE - closedloopgovernanceリソースを削除します。
v22.7 - Portal GET - closedloopgovernanceリソースを取得します。
closedloopreportconfigs v22.7 - Portal PUT - closedloopのコンフィグを更新します。
v22.7 - Portal GET - closedloopのコンフィグを取得します。
closedloopreports v22.7 - Portal POST - closedloopの実行結果を整形して出力します。
plugins v22.2 - - Portal PUT - pluginを再インストールします。
v22.2 - - Portal GET - installされているpluginの情報を返却します。
protobufs v22.2 - Portal POST - - gRPCプロキシを利用するためのプロトコルバッファを作成します。
v22.2 - Portal PUT - - gRPCプロキシを利用するためのプロトコルバッファを更新します。
v22.2 - Portal DELETE - - gRPCプロキシを利用するためのプロトコルバッファを削除します。
v22.2 - Portal GET - - gRPCプロキシを利用するためのプロトコルバッファを取得します。
rdbschemas v22.2 - - Portal GET - - - schema情報を取得します。
tdd v22.2 - Portal POST - tddの機能を有効化します。
v22.2 - Portal DELETE - tddの機能を無効化します。
v22.2 - Portal GET - tddの情報を取得します。
coverages v22.2 - - Portal POST - - coverage機能の有効/無効を切り替えます。
v22.2 - - Portal GET - - coverage情報を取得します。
unittests v22.2 - Portal POST - ユニットテストを実行します。
v22.2 - Portal PATCH - 実行中のユニットテストの操作をします。
v22.2 - Portal DELETE - 実行中のユニットテストを破棄します。
v22.2 - Portal GET - ユニットテストの情報を取得します。
testsuites v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてテストスイートを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したtestsuite_nameと一致するテストスイートを変更します。
v22.2 - Portal DElETE - - path指定したtestsuite_nameと一致するテストスイートを削除します。
v22.2 - Portal GET - - テストスイートを取得します。全件の取得とpath指定したtestsuite_nameと一致する1件の取得が可能です。
全件の取得の場合、offsetクエリとlimitクエリが使用可能です。
testcases v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてテストケースを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したtestcase_nameと一致するテストケースを変更します。
v22.2 - Portal DELETE - - path指定したtestcase_nameと一致するテストケースを削除します。
v22.2 - Portal GET - - テストケースを取得します。全件の取得とpath指定したtestcase_nameと一致する1件の取得が可能です。
全件の取得の場合、offsetクエリとlimitクエリが使用可能です。
fakers v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてFakerを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したfaker_nameと一致するFakerを変更します。
v22.2 - Portal DELETE - - path指定したfaker_nameと一致するFakerを削除します。
v22.2 - Portal GET - - Fakerを取得します。全件の取得とpath指定したfaker_nameと一致する1件の取得が可能です。
illusions v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてIllusionを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したillusion_nameと一致するIllusionを変更します。
v22.2 - Portal DELETE - - path指定したillusion_nameと一致するIllusionを削除します。
v22.2 - Portal GET - - Illusionを取得します。全件の取得とpath指定したillusion_nameと一致する1件の取得が可能です。

SDKカテゴリ・Scheduleコンポーネント・scheduleサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
schedules v22.2 - Portal POST - 受け付けたリクエストボディに基づいてWebフック予約を作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したlife_uuidと一致するWebフック予約を変更します。
v22.2 - Portal DELETE - path指定したlife_uuidと一致するWebフック予約を削除します。
v22.2 - Portal GET - Webフック予約を取得します。全件の取得とpath指定したlife_uuidと一致する1件の取得が可能です。
outgoingwebhooks v22.2 - Portal POST - 受け付けたリクエストボディに基づいてデイリーWebフック予約を作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したoutgoingwebhook_nameと一致するデイリーWebフック予約を変更します。
v22.2 - Portal DELETE - path指定したoutgoingwebhook_nameと一致するデイリーWebフック予約を削除します。
v22.2 - Portal GET - - デイリーWebフック予約を取得します。全件の取得とpath指定したoutgoingwebhook_nameと一致する1件の取得が可能です。

SDKカテゴリ・Lambdaコンポーネント・lambda_eventサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
lambda_events v22.2 - Portal POST - - lambdaイベントを発行します。
v22.2 - Portal GET - - lambdaイベントの一覧を取得します。
lambda_functions v22.2 - Portal POST - - lambda functionを作成します。
v22.2 - Portal PUT - - lambda functionを更新します。
v22.2 - Portal DELETE - - lambda functionを削除します。
v22.2 - Portal GET - - lambda functionを取得します。
device_roles v22.2 - Portal POST - - device roleを作成します。
v22.2 - Portal PUT - - device roleを更新します。
v22.2 - Portal DELETE - - device roleを削除します。
v22.2 - Portal GET - - device roleを取得します。
devices v22.2 - Portal POST - - deviceリソースを作成します。
v22.2 - Portal PUT - - deviceリソースを更新します。
v22.2 - Portal PATCH - - deviceリソースにactionを適用します。
v22.2 - Portal DELETE - - deviceリソースを削除します。
v22.2 - Portal GET - - deviceリソースを取得します。
sync_lambda v22.2 - - Portal GET - - lambdaサーバのプラグインを再同期します。

SDKカテゴリ・Lambdaコンポーネント・protocolサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
cliproxy v22.2 - Portal POST - - CLI proxyリソースを作成します。
v22.2 - Portal DELETE - - CLI proxyリソースを削除します。
v22.2 - Portal GET - - CLI proxyリソースを取得します。
netconfproxy v22.2 - Portal POST - - Netconf proxyリソースを作成します。
v22.2 - Portal DELETE - - Netconf proxyリソースを削除します。
v22.2 - Portal GET - - Netconf proxyリソースを取得します。

SDKカテゴリ・Collectorコンポーネント・collectorサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
collection_caches v22.2 - Portal DELETE - path指定したtarget_idと一致するcash_keyを削除します。
v22.2 - Portal GET - path指定したtarget_idと一致するcash_keyを取得します。
collection_queues v22.2 - Portal DELETE - path指定した種類のCollectionqueueを削除します。
v22.2 - Portal GET - Collectionqueueを取得します。with_contentクエリが使用可能です。
collection_errors v22.2 - Portal PATCH - - path指定したcollectionerror_idと一致するCollectionerrorと紐づくCollectionの取得状況を無効にします。
v22.2 - Portal GET - Collectionerrorの一覧を取得します。
collections v22.2 - Portal POST - 受け付けたリクエストボディに基づいてCollectionを作成します。run_scriptクエリが使用可能です。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したtarget_idと一致するCollectionを更新します。
run_scriptクエリが使用可能です。
v22.2 - Portal PATCH - - 受け付けたリクエストボディに基づいてCollectionsの接続テストを実施します。
v22.2 - Portal DELETE - path指定したtarget_idと一致するCollectionを削除します。
run_scriptクエリが使用可能です。
v22.2 - Portal GET - - Collectionを取得します。全件の取得とpath指定したtarget_idと一致する1件の取得が可能です。
run_scriptクエリが使用可能です。
collection_hooks v22.2 - Portal POST - - 受け付けたリクエストボディに基づいてCollectionhookを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてCollectionhookを更新します。
v22.2 - Portal DELETE - - path指定したcollectionhook_nameと一致するCollectionhookを削除します。
v22.2 - Portal GET - - Collectionhookを取得します。全件の取得とpath指定したcollectionhook_nameと一致する1件の取得が可能です。
collection_patterns v22.2 - Portal POST - 受け付けたリクエストボディに基づいてCollectionpatternを作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したcollectionpattern_nameと一致するCollectionpatternを変更します。
v22.2 - Portal DELETE - path指定したcollectionpattern_nameと一致するCollectionpatternを削除します。
v22.2 - Portal GET - Collectionpatternを取得します。全件の取得とpath指定したcollectionpattern_nameと一致する1件の取得が可能です。

SDKカテゴリ・Reflectionコンポーネント・reflectorサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
reflections v22.2 - Portal POST - 受け付けたリクエストボディに基づいてReflectionを作成します。
v22.2 - Portal PUT - 受け付けたリクエストボディに基づいてpath指定したreflection_idと一致するReflectionを変更します。
v22.2 - Portal PATCH - - 受け付けたリクエストボディに基づいてReflectionをCollectionとバインドします。
v22.2 - Portal DELETE - path指定したreflection_idと一致するReflectionを削除します。
v22.2 - Portal GET - Reflectionを取得します。全件の取得とpath指定したreflection_idと一致する1件の取得が可能です。
sent_metrics v22.2 - Portal PATCH - リクエストボディのsent_metric_idsキーと一致する送信済メトリックを再送信します。
v22.2 - Portal DELETE - - path指定したsent_metric_idと一致するsent_metricsテーブルに存在する送信済メトリックレコードを削除します。
v22.2 - Portal GET - - sent_metricsテーブルに存在する送信済メトリックレコードを取得します。
offsetクエリとlimitクエリが使用可能です。
unsentmetrics v22.2 - Portal PATCH - リクエストボディのunsent_metric_idsキーと一致する未送信メトリックを再送信します。
v22.2 - Portal DELETE - - unsent_metricsテーブルに存在する未送信メトリックレコードを削除します。
idをpath指定しない場合、未送信メトリックレコード全件を削除します。
v22.2 - Portal GET - - unsent_metricsテーブルに存在する未送信メトリックレコードを取得します。
offsetクエリとlimitクエリが使用可能です。
workers v22.2 - Portal POST - 受け付けたリクエストボディに基づいてWorkerを作成します。
v22.2 - Portal PUT - - 受け付けたリクエストボディに基づいてpath指定したworker名と一致するWorkerを変更します。
v22.2 - Portal DELETE - - path指定したworker名と一致するWorkerを削除します。
v22.2 - Portal GET - - Wokerを取得します。全件の取得とpath指定したwoker名と一致する1件の取得が可能です。

SDKカテゴリ・Commonコンポーネント・Commonサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
clusters v22.2 - - Portal GET - - - redisクラスタの情報を返却します。
heartbeat v22.2 - - Portal GET - healthcheck用APIです。cluster=trueを指定すると、着弾したpodを起点に系内のの全コンポーネントへのhealthcheckを実施しその結果を返却します。
controls v22.2 - - Portal POST - - - リクエストボディに応じて系に対して様々な操作を行います。原則直叩きしません。
masterlookup v23.1 - - Portal GET - - - masterコンポーネントの情報を返却します。role(コンポーネント名)、scope(cluster)の指定が可能です。
processes v22.2 - - Portal DELETE - - - オンプレミスでsupervisorを使用して起動している場合に使われる機能です。
v22.2 - - Portal GET - - - オンプレミスでsupervisorを使用して起動している場合に使われる機能です。
profiles v22.2 - - Portal GET - - redisから指定したキーの情報を取得して返却します。
releases v22.2 - - Portal GET - - - github連携モードでtagとcommitIdの情報を返却します。
services v22.2 - - Portal PUT - - - 起動オプションを上書き変更します。
v22.2 - - Portal PATCH - - - master_surpressionの有効/無効を切り替えます。
v22.2 - - Portal GET - - - サービスの提供状態を取得します。
traces v22.2 - - Portal GET - - redisから指定したキーの情報を取得して返却します。

Common/Systemcontextカテゴリ・CLI/functionコンポーネント・CLI/functionサービス

機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無 機能概要
futureization v22.2 - - function public(deprecated) - - - ブロッキング関数を非同期化する関数です。
get_service_config v22.2 - - function public - - スクリプト内でconfigを取得する関数です。
genkey v22.2 - - function public - - - 暗号化用のキーを生成します。
encrypt v22.2 - - function public - - - キーを使用して文字列を暗号化します。
decrypt v22.2 - - function public - - - キーを使用して文字列を復号します。
render v22.2 - - function public - - - redisに格納されている情報を用いてテンプレートレンダリングする関数です。
pubsub v22.2 - - function public - - redisにメッセージ登録する関数です。原則使用しません。
lambda_convergence v22.2 - - function public - - idを指定し、lambdaeventをterminateします。正常に処理された場合は情報を返却します。
lambda_terminate v22.2 - - function public - - idを指定し、lambdaeventをterminateします。正常に処理された場合は整形された情報を返却します。
cpu_watch v22.2 - - function public - - - cpu/メモリの使用量を取得するdaemonを作成します。
add_timeout v22.2 - - function public - - - 指定した関数にタイムアウトを追加する関数です。
callout v22.2 - - function public - - - api callをする関数です。
status_poll v22.2 - - function public(deprecated) - - - status pollingに利用される関数です。

Common/Systemcontextカテゴリ・Builtin Objectコンポーネント

詳しくはhttps://docs.sdk.qmonus.net/builtins/を参照ください。

コンポーネント 機能群 提供バージョン pluginで定義可能なリソース SDK Coreが作成するリソース 種別 属性 master podでのみ受け付ける機能 RDB接続の有無 redis接続の有無
QmonusRole retrieve v22.2 - - object classmethod - -
load v22.2 - - object classmethod - -
exists v22.2 - - object classmethod - -
save v22.2 - - object instancemethod - -
destroy v22.2 - - object instancemethod - -
context v22.2 - - object instanceAttr - - -
kwargs v22.2 - - object instanceAttr - - -
QmonusAccount retrieve v22.2 - - object classmethod - -
load v22.2 - - object classmethod - -
exists v22.2 - - object classmethod - -
save v22.2 - - object instancemethod - -
destroy v22.2 - - object instancemethod - -
create v22.2 - - object instancemethod - -
context v22.2 - - object instanceAttr - - -
kwargs v22.2 - - object instanceAttr - - -
Error code v22.2 - - object instanceAttr - - -
reason v22.2 - - object instanceAttr - - -
body v22.2 - - object instanceAttr - - -
ipam create v22.2 - - object classmethod -
delete v22.2 - - object classmethod -
get v22.2 - - object classmethod -
retrieve v22.2 - - object classmethod -
candidate v22.2 - - object classmethod -
allocate v22.2 - - object classmethod -
release v22.2 - - object classmethod -
inuse v22.2 - - object classmethod -
unuse v22.2 - - object classmethod -
name v22.2 - - object instanceAttr - - -
cidr v22.2 - - object instanceAttr - - -
Counter expand v22.2 - - object classmethod - -
remainds v22.2 - - object classmethod - -
allocate v22.2 - - object classmethod - -
release v22.2 - - object classmethod - -
Cache put v22.2 - - object classmethod - -
exists v22.2 - - object classmethod - -
get v22.2 - - object classmethod - -
delete v22.2 - - object classmethod - -
key v22.2 - - object instanceAttr - - -
interval v22.2 - - object instanceAttr - - -
count v22.2 - - object instanceAttr - - -
ttl v22.2 - - object instanceAttr - - -
Clock now v22.2 - - object classmethod - - -
utcnow v22.2 - - object classmethod - - -
after_now v22.2 - - object classmethod - - -
before_now v22.2 - - object classmethod - - -
Scenario retrieve v22.2 - - object classmethod - -
load v22.2 - - object classmethod - -
run v22.2 - - object classmethod - -
Daemon retrieve v22.2 - - object classmethod - -
load v22.2 - - object classmethod - -
run v22.2 - - object classmethod - -
Template exists v22.2 - - object classmethod - -
load v22.2 - - object classmethod - -
validate v22.2 - - object instancemethod - - -
render v22.2 - - object instancemethod - - -
Format format v22.2 - - object classmethod - - -
${format_name} v22.2 - - object classmethod - - -
Geo locate v22.2 - - object classmethod - - -
SQL run v22.2 - - object classmethod - -
bulkUpsert v22.2 - - object classmethod - -
Redis info v22.2 - - object classmethod - -
get v22.2 - - object classmethod - -
mget v22.2 - - object classmethod - -
exists v22.2 - - object classmethod - -
keys v22.2 - - object classmethod - -
llen v22.2 - - object classmethod - -
lrange v22.2 - - object classmethod - -
lindex v22.2 - - object classmethod - -
hkeys v22.2 - - object classmethod - -
hexists v22.2 - - object classmethod - -
hget v22.2 - - object classmethod - -
hlen v22.2 - - object classmethod - -
hvals v22.2 - - object classmethod - -
hgetall v22.2 - - object classmethod - -
flushall v22.2 - - object classmethod - -
incr v23.2 - - object classmethod - -
expire v23.2 - - object classmethod - -
Faker load v22.2 - - object classmethod - -
${method_name} v22.2 - - object classmethod - - -
FakeHttpResponse code v22.2 - - object instanceAttr - - -
headers v22.2 - - object instanceAttr - - -
body v22.2 - - object instanceAttr - - -
error v22.2 - - object instanceAttr - - -
Illusion inuse v22.2 - - object classmethod - -
unuse v22.2 - - object classmethod - -
cleanup v22.2 - - object classmethod - -
Test run v22.2 - - object classmethod -
runall v22.2 - - object classmethod -
flash v22.2 - - object classmethod - -
Booking save v22.2 - - object classmethod -
regist v22.2 - - object classmethod -
retrieve v22.2 - - object classmethod -
get v22.2 - - object classmethod -
shift v22.2 - - object classmethod -
destroy v22.2 - - object classmethod -
cancel v22.2 - - object classmethod -
path v22.2 - - object instanceAttr - - -
method v22.2 - - object instanceAttr - - -
headers v22.2 - - object instanceAttr - - -
body v22.2 - - object instanceAttr - - -
reservationDateTime v22.2 - - object instanceAttr - - -
reservationId v22.2 - - object instanceAttr - - -
reservationResourceId v22.2 - - object instanceAttr - - -
LambdaBooking save v22.2 - - object classmethod -
regist v22.2 - - object classmethod -
retrieve v22.2 - - object classmethod -
get v22.2 - - object classmethod -
shift v22.2 - - object classmethod -
destroy v22.2 - - object classmethod -
cancel v22.2 - - object classmethod -
event v22.2 - - object instanceAttr - - -
content v22.2 - - object instanceAttr - - -
reservationDateTime v22.2 - - object instanceAttr - - -
reservationId v22.2 - - object instanceAttr - - -
reservationResourceId v22.2 - - object instanceAttr - - -
CLI kwargs v22.2 - - object instanceAttr - - -
conn v22.2 - - object instanceAttr - - -
Device load v22.2 - - object classmethod - -
retrieve v22.2 - - object classmethod - -
save v22.2 - - object instancemethod - -
delete v22.2 - - object instancemethod - -
actions v22.2 - - object instanceAttr - - -
alias v22.2 - - object instanceAttr - - -
device v22.2 - - object instanceAttr - - -
host v22.2 - - object instanceAttr - - -
port v22.2 - - object instanceAttr - - -
username v22.2 - - object instanceAttr - - -
password v22.2 - - object instanceAttr - - -
secret v22.2 - - object instanceAttr - - -
parameters v22.2 - - object instanceAttr - - -
role v22.2 - - object instanceAttr - - -
version v22.2 - - object instanceAttr - - -
update v22.2 - - object instanceAttr - - -
created_at v22.2 - - object instanceAttr - - -
updated_at v22.2 - - object instanceAttr - - -
ComplexDevice load v22.2 - - object classmethod - -
retrieve v22.2 - - object classmethod - -
save v22.2 - - object instancemethod - -
dalete v22.2 - - object instancemethod - -
actions v22.2 - - object instanceAttr - - -
alias v22.2 - - object instanceAttr - - -
aliases v22.2 - - object instanceAttr - - -
parameters v22.2 - - object instanceAttr - - -
role v22.2 - - object instanceAttr - - -
version v22.2 - - object instanceAttr - - -
update v22.2 - - object instanceAttr - - -
created_at v22.2 - - object instanceAttr - - -
updated_at v22.2 - - object instanceAttr - - -
CLIProxy load v22.2 - - object classmethod - -
schema v22.2 - - object instanceAttr - - -
run v22.2 - - object instancemethod - - -
context v22.2 - - object instanceAttr - - -
kwargs v22.2 - - object instanceAttr - - -
NetconfProxy load v22.2 - - object classmethod - -
schema v22.2 - - object instanceAttr - - -
run v22.2 - - object instancemethod - - -
context v22.2 - - object instanceAttr - - -
kwargs v22.2 - - object instanceAttr - - -
Netconf context v22.2 - - object instanceAttr - - -
kwargs v22.2 - - object instanceAttr - - -
conn v22.2 - - object instanceAttr - - -
SNMPv2 get v22.2 - - object instancemethod - - -
bulk v22.2 - - object instancemethod - - -
getInterfaces v22.2 - - object instancemethod - - -
credencial v22.2 - - object instanceAttr - - -
SNMPv3 get v22.2 - - object instancemethod - - -
bulk v22.2 - - object instancemethod - - -
getInterfaces v22.2 - - object instancemethod - - -
credencial v22.2 - - object instanceAttr - - -
Collection load v22.2 - - object classmethod - -
run v22.2 - - object instancemethod - -
getIfIndexes v22.2 - - object instancemethod - - -
Runtime running v22.2 - - object classmethod - - -
masterlookup v23.1 - - object classmethod - - -
clusterlookup v23.1 - - object classmethod - - -
context v22.2 - - object instanceAttr - - -
streamer v22.2 - - object instanceAttr - - -
FIFO put v22.2 - - object instancemethod - -
clear v22.2 - - object instancemethod - -
name v22.2 - - object instanceAttr - - -
unlockDelay v22.2 - - object instanceAttr - - -
lock v22.2 - - object instanceAttr - - -
backup v22.2 - - object instanceAttr - - -
mFIFO put v22.2 - - object instancemethod - -
name v22.2 - - object instanceAttr - - -
unlockDelay v22.2 - - object instanceAttr - - -
lock v22.2 - - object instanceAttr - - -
backup v22.2 - - object instanceAttr - - -
DAG load v23.1 - - object classmethod - -
save v23.1 - - object instancemethod - -
createInstance v23.1 - - object instancemethod - - -
retrieve v23.1 - - object classmethod - -
destory v23.1 - - object instancemethod - -
add v23.1 - - object instancemethod - - -
update v23.1 - - object instancemethod - - -
delete v23.1 - - object instancemethod - - -
category v23.1 - - object instanceAttr - - -
name v23.1 - - object instanceAttr - - -
metadata v23.1 - - object instanceAttr - - -
autoReverseOnFailure v23.1 - - object instanceAttr - - -
DagInstance run v23.1 - - object instancemethod - -
approval v23.1 - - object instancemethod - -
skip v23.1 - - object instancemethod - -
view v23.1 - - object instancemethod - - -
statusView v23.1 - - object instancemethod - -
load v23.1 - - object classmethod - -
retrieve v23.1 - - object classmethod - -
save v23.1 - - object instancemethod - -
destory v23.1 - - object instancemethod - -
context v23.1 - - object instanceAttr - -
instance v23.1 - - object instanceAttr - - -
category v23.1 - - object instanceAttr - - -
name v23.1 - - object instanceAttr - - -
metadata v23.1 - - object instanceAttr - - -
autoReverseOnFailure v23.1 - - object instanceAttr - - -
status v23.1 - - object instanceAttr - - -