Download PDF
Download page ライセンス API.
ライセンス API
Related pages:
このページでは、ライセンスファイルのアップロード、ライセンスの割り当て、ライセンスおよびアカウントの使用情報の取得、ライセンスルールの作成、更新、削除など、ライセンスおよびアカウントに関連する機能の実行に使用できるライセンス API について説明します。
次のライセンス API は、ライセンスモデル別に分類されています。各モデル内のライセンスについては、「ライセンスの付与および制限事項」を参照してください。
インフラストラクチャベースのライセンスの API:
アカウント使用状況 API
ライセンス ID によるアカウント使用状況の取得
指定されたライセンス ID によって参照されるアカウント使用状況を取得します。
URL
http://<host>:<port>/controller/licensing/v1/usage/license/{licenseId}
形式
GET /controller/licensing/v1/usage/license/{licenseId}
パスパラメータ
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 文字列 | 使用状況の取得が要求されるライセンス ID。 | 対応 |
クエリパラメータ
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 文字列 | 要求されたライセンス使用期間の開始日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
| 文字列 | 要求されたライセンス使用期間の終了日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
| 整数型(Integer) | 要求されたライセンス使用状況データの粒度。 | 対応 |
| ブール | ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは | いいえ |
| ブール | 消費ベースの使用状況を含めるかどうか。デフォルト値: | なし |
応答形式
response オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 整数 | アカウント ID。 |
| オブジェクト | アカウントまたは割り当てのライセンス使用状況を表すエンティティ。 |
| package オブジェクトの配列 |
licenseRule オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割当 ID。 |
| 文字列 | 割り当て名。 |
| 文字列 | この特定の割り当てのライセンスキー。 |
package オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
packageName | 文字列 | 次のパッケージ(エディション)インスタンスの名前を表す列挙型:
|
type | 文字列 | 次のパッケージインスタンスのタイプを表す列挙型:
|
kind | 文字列 | パッケージの作成元のライセンスモデルから派生したパッケージの種類。レガシーエージェントベースのライセンスモジュール(APM、DOTNET など)に基づくパッケージを、新しいインフラストラクチャベースのパッケージと迅速に区別するのに役立ちます。 列挙型: "AGENT_BASED" "INFRASTRUCTURE_BASED" |
family | 文字列 | パッケージファミリ。 |
createdDate | 文字列 | ライセンス内のパッケージインスタンスの作成日。ISO 8601 日時文字列。 |
startDate | 文字列 | パッケージインスタンスの開始日。例:パッケージインスタンスがアクティブになる日付:ISO 8601 日時文字列。 |
expirationDate | 文字列 | パッケージインスタンスの期限日、つまりパッケージインスタンスがアクティブでなくなる日付。ISO 8601 日時文字列。 |
licenseUnits | 文字列 | パッケージインスタンスで使用可能なライセンスの数。 |
properties | オブジェクト | キーと値のペア形式でのパッケージ固有のカスタムプロパティのコレクション。グローバルプロパティとマージする場合は、競合するパッケージ固有のプロパティが優先されます。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/usage/license/{licenseId}?dateFrom=<ISO 8601 date-time string>&dateTo=<ISO 8601 date-time string>&granularityMinutes=<number of minutes as an integer>
{ "accountId":0, "licenseRule":{ "id":"string", "name":"string", "licenseKey":"string" }, "packages":[ { "name":"string", "unitUsages":[ { "usageType":"string", "granularityInMinutes":0, "data":{ "timestamp":"string", "provisioned":{ "min":0, "max":0, "avg":0, "count":0 }, "used":{ "min":0, "max":0, "avg":0, "count":0 }, "registrations":[ { "type":"string", "registered":{ "min":0, "max":0, "avg":0, "count":0 } } ] } } ] } ] }
ライセンスキーによる割り当てルール使用状況の取得
指定のライセンスキーで参照する割り当てルール使用状況を取得します。
URL
http://<host>:<port>/controller/licensing/v1/usage/license/{licenseId}/allocation/{licenseKey}
形式
GET /controller/licensing/v1/usage/license/{licenseId}/allocation/{licenseKey}
Path Parameters
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
licenseId | 文字列 | 使用状況の取得が要求されるライセンス ID。 | はい |
licenseKey | 文字列 | 割り当てルールに基づいたライセンスキーが選択されます。返される使用状況は、その特定の割り当てルールに関連します。 | 対応 |
クエリパラメータ
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
| 文字列 | 要求されたライセンス使用期間の開始日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
| 文字列 | 要求されたライセンス使用期間の終了日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
| 整数型(Integer) | 要求されたライセンス使用状況データの粒度。 | 対応 |
| ブール | ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは false. | なし |
応答形式
response オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
| 整数 | アカウント ID。 |
| オブジェクト | アカウントまたは割り当てのライセンス使用状況を表すエンティティ。 |
| package オブジェクトの配列 |
licenseRule オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
id | 文字列 | 割当 ID。 |
name | 文字列 | 割り当て名。 |
licenseKey | 文字列 | この特定の割り当てのライセンスキー。 |
package オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
packageName | 文字列 | 次のパッケージ(エディション)インスタンスの名前を表す列挙型:
|
type | 文字列 | 次のパッケージインスタンスのタイプを表す列挙型:
|
kind | 文字列 | パッケージの作成元のライセンスモデルから派生したパッケージの種類。レガシーエージェントベースのライセンスモジュール(APM、DOTNET など)に基づくパッケージを、新しいインフラストラクチャベースのパッケージと迅速に区別するのに役立ちます。 列挙型: "AGENT_BASED" "INFRASTRUCTURE_BASED" |
family | 文字列 | パッケージファミリ。 |
createdDate | 文字列 | ライセンス内のパッケージインスタンスの作成日。ISO 8601 日時文字列。 |
startDate | 文字列 | パッケージインスタンスの開始日。例:パッケージインスタンスがアクティブになる日付:ISO 8601 日時文字列。 |
expirationDate | 文字列 | パッケージインスタンスの期限日、つまりパッケージインスタンスがアクティブでなくなる日付。ISO 8601 日時文字列。 |
licenseUnits | 文字列 | パッケージインスタンスで使用可能なライセンスの数。 |
properties | オブジェクト | キーと値のペア形式でのパッケージ固有のカスタムプロパティのコレクション。グローバルプロパティとマージする場合は、競合するパッケージ固有のプロパティが優先されます。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/usage/license/{licenseId}/allocation/{licenseKey}?dateFrom=<ISO 8601 date-time string>&dateTo=<ISO 8601 date-time string>&granularityMinutes=<number of minutes as an integer>
{ "accountId":0, "licenseRule":{ "id":"string", "name":"string", "licenseKey":"string" }, "packages":[ { "name":"string", "unitUsages":[ { "usageType":"string", "granularityInMinutes":0, "data":{ "timestamp":"string", "provisioned":{ "min":0, "max":0, "avg":0, "count":0 }, "used":{ "min":0, "max":0, "avg":0, "count":0 }, "registrations":[ { "type":"string", "registered":{ "min":0, "max":0, "avg":0, "count":0 } } ] } } ] } ] }
アカウント ID によるアカウント使用状況の取得
指定のアカウント ID で参照するアカウント使用状況を取得します。
URL
http://<host>:<port>/controller/licensing/v1/usage/account/{accountId}
形式
GET /controller/licensing/v1/usage/account/{accountId}
Path Parameters
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
accountId | 整数 | 使用状況の取得が要求されるアカウント ID。 | 対応 |
クエリパラメータ
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
dateFrom | 文字列 | 要求されたライセンス使用期間の開始日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
dateTo | 文字列 | 要求されたライセンス使用期間の終了日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
granularityMinutes | 整数型(Integer) | 要求されたライセンス使用状況データの粒度。 | 対応 |
includeEntityTypes | ブール | ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは false. | いいえ |
includeConsumptionBased | ブール | 消費ベースの使用状況を含めるかどうか。デフォルト値: false. | なし |
応答形式
response オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
| 整数 | アカウント ID。 |
| オブジェクト | アカウントまたは割り当てのライセンス使用状況を表すエンティティ。 |
| package オブジェクトの配列 |
licenseRule オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
| 文字列 | 割当 ID。 |
| 文字列 | 割り当て名。 |
| 文字列 | この特定の割り当てのライセンスキー。 |
package オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
packageName | 文字列 | 次のパッケージ(エディション)インスタンスの名前を表す列挙型:
|
type | 文字列 | 次のパッケージインスタンスのタイプを表す列挙型:
|
kind | 文字列 | パッケージの作成元のライセンスモデルから派生したパッケージの種類。レガシーエージェントベースのライセンスモジュール(APM、DOTNET など)に基づくパッケージを、新しいインフラストラクチャベースのパッケージと迅速に区別するのに役立ちます。 列挙型: "AGENT_BASED" "INFRASTRUCTURE_BASED" |
family | 文字列 | パッケージファミリ。 |
createdDate | 文字列 | ライセンス内のパッケージインスタンスの作成日。ISO 8601 日時文字列。 |
startDate | 文字列 | パッケージインスタンスの開始日。例:パッケージインスタンスがアクティブになる日付:ISO 8601 日時文字列。 |
expirationDate | 文字列 | パッケージインスタンスの期限日、つまりパッケージインスタンスがアクティブでなくなる日付。ISO 8601 日時文字列。 |
licenseUnits | 文字列 | パッケージインスタンスで使用可能なライセンスの数。 |
properties | オブジェクト | キーと値のペア形式でのパッケージ固有のカスタムプロパティのコレクション。グローバルプロパティとマージする場合は、競合するパッケージ固有のプロパティが優先されます。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/usage/account/{accountId}?dateFrom=<ISO 8601 date-time string>&dateTo=<ISO 8601 date-time string>&granularityMinutes=<number of minutes as an integer>
{ "accountId":0, "licenseRule":{ "id":"string", "name":"string", "licenseKey":"string" }, "packages":[ { "name":"string", "unitUsages":[ { "usageType":"string", "granularityInMinutes":0, "data":{ "timestamp":"string", "provisioned":{ "min":0, "max":0, "avg":0, "count":0 }, "used":{ "min":0, "max":0, "avg":0, "count":0 }, "registrations":[ { "type":"string", "registered":{ "min":0, "max":0, "avg":0, "count":0 } } ] } } ] } ] }
アカウント ID による割り当てルール使用状況の取得
指定のライセンスキー ID で参照する割り当てルール使用状況を取得します。
URL
http://<host>:<port>/controller/licensing/v1/usage/account/{accountId}/allocation/{licenseKey}
形式
GET /controller/licensing/v1/usage/account/{accountId}/allocation/{licenseKey}
Path Parameters
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
accountId | 整数 | 使用状況の取得が要求されるアカウント ID。 | はい |
licenseKey | 文字列 | 割り当てルールに基づいたライセンスキーが選択されます。返される使用状況は、その特定の割り当てルールに関連します。 | 対応 |
クエリパラメータ
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
| 文字列 | 要求されたライセンス使用期間の開始日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
| 文字列 | 要求されたライセンス使用期間の終了日。対応する形式は ISO-8601(拡張)です。例:2020-10-05T10:00:00Z | はい |
| 整数型(Integer) | 要求されたライセンス使用状況データの粒度。 | 対応 |
| ブール | ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは false. | なし |
応答形式
response オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
| 整数 | アカウント ID。 |
| オブジェクト | アカウントまたは割り当てのライセンス使用状況を表すエンティティ。 |
| package オブジェクトの配列 |
licenseRule オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
| 文字列 | 割当 ID。 |
| 文字列 | 割り当て名。 |
| 文字列 | この特定の割り当てのライセンスキー。 |
package オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
packageName | 文字列 | 次のパッケージ(エディション)インスタンスの名前を表す列挙型:
|
type | 文字列 | 次のパッケージインスタンスのタイプを表す列挙型:
|
kind | 文字列 | パッケージの作成元のライセンスモデルから派生したパッケージの種類。レガシーエージェントベースのライセンスモジュール(APM、DOTNET など)に基づくパッケージを、新しいインフラストラクチャベースのパッケージと迅速に区別するのに役立ちます。 列挙型: "AGENT_BASED" "INFRASTRUCTURE_BASED" |
family | 文字列 | パッケージファミリ。 |
createdDate | 文字列 | ライセンス内のパッケージインスタンスの作成日。ISO 8601 日時文字列。 |
startDate | 文字列 | パッケージインスタンスの開始日。例:パッケージインスタンスがアクティブになる日付:ISO 8601 日時文字列。 |
expirationDate | 文字列 | パッケージインスタンスの期限日、つまりパッケージインスタンスがアクティブでなくなる日付。ISO 8601 日時文字列。 |
licenseUnits | 文字列 | パッケージインスタンスで使用可能なライセンスの数。 |
properties | オブジェクト | キーと値のペア形式でのパッケージ固有のカスタムプロパティのコレクション。グローバルプロパティとマージする場合は、競合するパッケージ固有のプロパティが優先されます。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/usage/account/{accountId}/allocation/{licenseKey}?dateFrom=<ISO 8601 date-time string>&dateTo=<ISO 8601 date-time string>&granularityMinutes=<number of minutes as an integer>
{ "accountId":0, "licenseRule":{ "id":"string", "name":"string", "licenseKey":"string" }, "packages":[ { "name":"string", "unitUsages":[ { "usageType":"string", "granularityInMinutes":0, "data":{ "timestamp":"string", "provisioned":{ "min":0, "max":0, "avg":0, "count":0 }, "used":{ "min":0, "max":0, "avg":0, "count":0 }, "registrations":[ { "type":"string", "registered":{ "min":0, "max":0, "avg":0, "count":0 } } ] } } ] } ] }
ライセンス割り当て API
次の方法では、アカウントのライセンス割り当て(ライセンスルール)を取得、作成、フィルタリング、および削除できます。
すべてのライセンス割り当ての取得
すべてのライセンス割り当てを取得し、オプションのクエリパラメータを使用して割り当てのリストを絞り込みます。
URL
http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation
形式
GET /controller/licensing/v1/account/{accountId}/allocation
パスパラメータ
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
| 整数 | 割り当ての取得が要求されるアカウント ID。 | 対応 |
クエリパラメータ
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 文字列 | 割り当ての名前。 | なし |
| 文字列 | 割り当てのライセンスキー。 | なし |
| 文字列 | 割り当てに関連付けられたタグ。 | なし |
応答形式
response オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割当 ID。アカウントごとに一意です。 |
| 整数 | 割り当てが属するアカウント ID。 |
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | 割り当てで使用するライセンスキー。アカウントごとに一意です。 |
| オブジェクトの配列 | filter オブジェクトの配列 |
| オブジェクトの配列 |
|
| 文字列の配列 | 割り当てに関連付けられたタグ。 |
| 文字列 | 割り当ての作成日:ISO 8601 日時文字列。 |
| 文字列 | 割り当ての最終更新日:ISO 8601 日時文字列。 |
filter オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | フィルタを適用するエンティティのタイプ。 列挙型:"APPLICATION" "HOST" |
| 文字列 |
|
| 文字列 | フィルタ対象の値。 |
limit オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
id | 文字列 | 割り当てパッケージ制限 ID。 |
package | 文字列 | 制限のパッケージのタイプ。 サポートされている列挙型は次のとおりです。
|
units | 整数 | 割り当て制限ごとのライセンスユニットの数。 |
tags | Array of Strings | 割り当てに関連付けられたタグ。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation
[
{
"id":"string",
"accountId":0,
"name":"string",
"licenseKey":"string",
"filters":[
{
"id":"string",
"type":"APPLICATION",
"operator":"ID_EQUALS",
"value":"string"
}
],
"limits":[
{
"id":"string",
"package":"INFRA",
"units":0
}
],
"tags":[
"string"
],
"createdDate":"string",
"lastUpdatedDate":"string"
}
]
ライセンス割り当ての作成
ライセンス割り当てを作成します。この方法では、次のことを確認します。
- サブエンティティ(フィルタ、制限)の ID はフィルタリングされない
- 他の一意のパラメータ(
name
、licenseKey
など)が既存の割り当てと競合しない
URL
http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation
形式
POST /controller/licensing/v1/account/{accountId}/allocation
Path Parameters
Parameter Name | Parameter Type | 値 | 必須 |
---|---|---|---|
accountId | 整数 | 割り当ての取得が要求されるアカウント ID。 | 対応 |
要求の形式
request オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| オブジェクトの配列 |
|
| オブジェクトの配列 |
|
Filter オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | フィルタを適用するエンティティのタイプ。 列挙型:"APPLICATION" "HOST" |
| 文字列 |
|
| 文字列 | フィルタ対象の値。 |
limit オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当てパッケージ制限 ID。 |
| 文字列 | 制限のパッケージのタイプ。 サポートされている列挙型は次のとおりです。
|
| 整数 | 割り当て制限ごとのライセンスユニットの数。 |
| Array of Strings | 割り当てに関連付けられたタグ。 |
応答形式
response オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割当 ID。アカウントごとに一意です。 |
| 整数 | 割り当てが属するアカウント ID。 |
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | 割り当てで使用するライセンスキー。アカウントごとに一意です。 |
フィルタ | オブジェクトの配列 | filter オブジェクトの配列 |
| オブジェクトの配列 |
|
| 文字列の配列 | 割り当てに関連付けられたタグ。 |
| 文字列 | 割り当ての作成日:ISO 8601 日時文字列。 |
| 文字列 | 割り当ての最終更新日:ISO 8601 日時文字列。 |
filter オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | フィルタを適用するエンティティのタイプ。 列挙型:"APPLICATION" "HOST" |
| 文字列 |
|
| 文字列 | フィルタ対象の値。 |
limit オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
id | 文字列 | 割り当てパッケージ制限 ID。 |
package | 文字列 | 制限のパッケージのタイプ。 サポートされている列挙型は次のとおりです。
|
units | 整数 | 割り当て制限ごとのライセンスユニットの数。 |
tags | Array of Strings | 割り当てに関連付けられたタグ。 |
例
curl --user <user>@<AccountName>:<password> -X POST \ http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "filters": [ { "id": "string", "type": "APPLICATION", "operator": "ID_EQUALS", "value": "string" } ], "limits": [ { "id": "string", "package": "INFRA", "units": 0 } ], "tags": ["string"] }'
[
{
"id": "string",
"accountId": integer,
"name": "string",
"licenseKey": "string",
"filters": [
{
"id": "string",
"type": "APPLICATION",
"operator": "ID_EQUALS",
"value": "string"
}
],
"limits": [
{
"id": "string",
"package": "INFRA",
"units": 0
}
],
"tags": ["string"],
"createdDate": "ISO 8601 date-time",
"lastUpdatedDate": "ISO 8601 date-time"
},
...
]
ライセンス割り当ての取得
割り当て ID によってライセンス割り当てを取得します。
URL
http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation/{allocationId}
形式
GET /controller/licensing/v1/account/{accountId}/allocation/{allocationId}
Path Parameters
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 整数 | 割り当ての取得が要求されるアカウント ID。 | はい |
| 文字列 | 取得する割り当てを参照する割り当て ID。 | あり |
応答形式
response オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割当 ID。アカウントごとに一意です。 |
| 整数 | 割り当てが属するアカウント ID。 |
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | 割り当てで使用するライセンスキー。アカウントごとに一意です。 |
| オブジェクトの配列 | filter オブジェクトの配列 |
| オブジェクトの配列 |
|
| 文字列の配列 | 割り当てに関連付けられたタグ。 |
| 文字列 | 割り当ての作成日:ISO 8601 日時文字列。 |
| 文字列 | 割り当ての最終更新日:ISO 8601 日時文字列。 |
filter オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
id | 文字列 | 割り当ての名前。アカウントごとに一意です。 |
type | 文字列 | フィルタを適用するエンティティのタイプ。 列挙型:"APPLICATION" "HOST" |
operator | 文字列 |
|
value | 文字列 | フィルタ対象の値。 |
limit オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当てパッケージ制限 ID。 |
| 文字列 | 制限のパッケージのタイプ。 サポートされている列挙型は次のとおりです。
|
| 整数 | 割り当て制限ごとのライセンスユニットの数。 |
| Array of Strings | 割り当てに関連付けられたタグ。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation/{allocationId}
[
{
"id": "string",
"accountId": integer,
"name": "string",
"licenseKey": "string",
"filters": [
{
"id": "string",
"type": "APPLICATION",
"operator": "ID_EQUALS",
"value": "string"
}
],
"limits": [
{
"id": "string",
"package": "INFRA",
"units": 0
}
],
"tags": ["string"],
"createdDate": "ISO 8601 date-time",
"lastUpdatedDate": "ISO 8601 date-time"
},
...
]
ライセンス割り当ての更新
割り当て ID によってライセンス割り当てを更新します。
URL
http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation/{allocationId}
形式
PUT /controller/licensing/v1/account/{accountId}/allocation/{allocationId}
Path Parameters
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 整数 | 割り当ての取得が要求されるアカウント ID。 | はい |
| 文字列 | 取得する割り当てを参照する割り当て ID。 | 対応 |
要求の形式
request オブジェクト
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 文字列 | 割り当ての名前。アカウントごとに一意です。 | はい |
| 文字列 | 取得する割り当てを参照する割り当て ID。 | いいえ |
| オブジェクト | いいえ | |
| Array of Strings | いいえ |
filter オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当ての名前。アカウントごとに一意です。 |
| 文字列 | フィルタを適用するエンティティのタイプ。 列挙型:"APPLICATION" "HOST" |
| 文字列 |
|
| 文字列 | フィルタ対象の値。 |
limit オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 文字列 | 割り当てパッケージ制限 ID。 |
| 文字列 | 制限のパッケージのタイプ。 サポートされている列挙型は次のとおりです。
|
| 整数 | 割り当て制限ごとのライセンスユニットの数。 |
| Array of Strings | 割り当てに関連付けられたタグ。 |
例
curl --user <user>@<AccountName>:<password> -X PUT \ http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "filters": [ { "id": "string", "type": "APPLICATION", "operator": "ID_EQUALS", "value": "string" } ], "limits": [ { "id": "string", "package": "INFRA", "units": 0 } ], "tags": [ "string" ] }'
{
"id":"string",
"accountId":0,
"name":"string",
"licenseKey":"string",
"filters":[
{
"id":"string",
"type":"APPLICATION",
"operator":"ID_EQUALS",
"value":"string"
}
],
"limits":[
{
"id":"string",
"package":"INFRA",
"units":0
}
],
"tags":[
"string"
],
"createdDate":"string",
"lastUpdatedDate":"string"
}
ライセンスルール割り当ての削除
割り当て ID によってライセンス割り当てを削除します。
URL
http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation/{allocationId}
形式
DELETE /controller/licensing/v1/account/{accountId}/allocation/{allocationId}
Path Parameters
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 整数 | 割り当ての取得が要求されるアカウント ID。 | はい |
| 文字列 | 取得する割り当てを参照する割り当て ID。 | あり |
例
curl --user <user>@<AccountName>:<password> -X DELETE \ http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation/{allocationId}
ライセンス情報 API
アカウントのライセンス情報(ライセンスタイプ、パッケージ、期限日など)を取得するには、次の方法を使用します。
アカウントライセンス情報の取得
アカウントのライセンス情報を取得します。
URL
http://<host>:<port>/controller/licensing/v1/account/{accountId}/info
形式
GET /controller/licensing/v1/account/{accountId}/info
Path Parameters
パラメータ名 | Parameter Type | 値 | 必須 |
---|---|---|---|
| 整数 | 割り当ての取得が要求されるアカウント ID。 | あり |
応答形式
response オブジェクト
パラメータ名 | Parameter Type | 値 |
---|---|---|
| 整数 | ライセンス情報が属するアカウント ID。 |
| 文字列 | SFDC ライセンス ID。 |
| 文字列 | カスタマー ID。 |
| 文字列 | カスタマー名。 |
| 文字列 | ライセンスが使用される予定の環境を表す列挙型:
|
| 文字列 | ライセンスが使用される予定のマシンのハードウェア フィンガープリント。現在、MAC アドレスのみがサポートされています。無制限の場合は |
| 文字列 | ライセンスの対象コンシューマを表す列挙型:
|
| 文字列 | ライセンス全体の期限日:ISO 8601 日時文字列。 |
| 文字列 | ライセンスステータスを表す列挙型:
|
| オブジェクトの配列 | |
| オブジェクト | キー → 値の形式でライセンスに関連付けられたグローバル カスタム プロパティのコレクション。これらのプロパティは、すべてのパッケージで共有できます。 |
| オブジェクト | アカウントレベルのフォールバックユニットの定義。エージェントタイプ(文字列)をフォールバックユニット(整数)にマッピングします。 |
package オブジェクト
Parameter Name | Parameter Type | 値 |
---|---|---|
| 文字列 | 次のパッケージ(エディション)インスタンスの名前を表す列挙型:
|
| 文字列 | 次のパッケージインスタンスのタイプを表す列挙型:
|
| 文字列 | パッケージの作成元のライセンスモデルから派生したパッケージの種類。レガシーエージェントベースのライセンスモジュール(APM、DOTNET など)に基づくパッケージを、新しいインフラストラクチャベースのパッケージと迅速に区別するのに役立ちます。 列挙型:"INFRASTRUCTURE_BASED" |
| 文字列 | パッケージファミリ。 |
| 文字列 | ライセンス内のパッケージインスタンスの作成日。ISO 8601 日時文字列。 |
| 文字列 | パッケージインスタンスの開始日。例:パッケージインスタンスがアクティブになる日付:ISO 8601 日時文字列。 |
| 文字列 | パッケージインスタンスの期限日、つまりパッケージインスタンスがアクティブでなくなる日付。ISO 8601 日時文字列。 |
| 文字列 | パッケージインスタンスで使用可能なライセンスの数。 |
| オブジェクト | キーと値のペア形式でのパッケージ固有のカスタムプロパティのコレクション。グローバルプロパティとマージする場合は、競合するパッケージ固有のプロパティが優先されます。 |
例
curl --user <user>@<AccountName>:<password> -X GET \ http://<host>:<port>/controller/licensing/v1/account/{accountId}/info
{
"accountId":0,
"licenseId":"string",
"customerId":"string",
"customerName":"string",
"environment":"DEV/TEST",
"hardwareFingerprint":"string",
"type":"SAAS-CONTROLLER",
"expirationDate":"string",
"status":"ACTIVE",
"packages":[
{
"packageName":"INFRA",
"type":"PAID",
"kind":"AGENT_BASED",
"family":"string",
"createdDate":"string",
"startDate":"string",
"expirationDate":"string",
"licenseUnits":0,
"properties":{
}
}
],
"properties":{
},
"fallbackUnits":{
}
}
エージェントベースのライセンスの API:
ライセンスルール API
このセクションでは、ライセンスルールの作成、更新、および削除や、ID、アクセスキー、および名前によるライセンスルールの取得などの、AppDynamics でモデル化されたライセンスルールに関する情報を取得するために使用できるライセンスルール API メソッドについて説明します。
すべてのライセンスルール API に以下が適用されます。
id
:これはグローバルで一意な識別子の頭字語である GUID(または UUID)です。access_key
:すべてのlicenseRules
で一意である必要があります。name
:すべてのlicenseRules
で一意である必要があります。account_id
:GET API を使用して次のパラメータの現在の値を確認します:account_ID.
ライセンスルールの新規作成
URL
http://<host>:<port>/controller/mds/v1/license/rules
形式
POST /controller/mds/v1/license/rules
Input Parameters
Parameter Name | Parameter Type | Value | 必須 |
---|---|---|---|
| 文字列 | ライセンスモジュールのタイプを表す文字列。 モジュールタイプ:
| [はい(Yes)] に設定 |
| 文字列 | ID または名前を表す文字列。 | [はい(Yes)] に設定 |
| 整数型(Integer) | バージョン番号を示します。 | [はい(Yes)] に設定 |
| 整数型(Integer) | 必要なライセンス数を示す整数。 | [はい(Yes)] に設定 |
| 文字列 | アカウント名またはアカウント ID を提供します。 | [はい(Yes)] に設定 |
| [パス(Path)] | アカウントアクセスキーを提供します。 | [はい(Yes)] に設定 |
LicenseRule
は、license_module_type, id, access_key, account_id,
、version
、および number_of_licenses
で構成されています。
例
curl --user <user>@<AccountName>:<password> -X POST \ http://<host>:<port>/controller/mds/v1/license/rules \ -H 'Content-Type: application/json' \ -d '{ "id": "011116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Default_API9", "description": null, "enabled": true, "constraints": [], "entitlements": [ { "license_module_type": "JAVA", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_WEB_SERVER", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_SDK", "number_of_licenses": 100 }, { "license_module_type": "DOT_NET", "number_of_licenses": 100 }, { "license_module_type": "NETVIZ", "number_of_licenses": 100 }, { "license_module_type": "MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "NODEJS", "number_of_licenses": 100 }, { "license_module_type": "SIM_MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "PHP", "number_of_licenses": 100 }, { "license_module_type": "PYTHON", "number_of_licenses": 100 } ], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "ap1845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": null, "peak_usage": null }
{ "id": "011116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Default_API9", "description": null, "enabled": true, "constraints": [ ], "entitlements": [ { "license_module_type": "JAVA", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_WEB_SERVER", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_SDK", "number_of_licenses": 100 }, { "license_module_type": "DOT_NET", "number_of_licenses": 100 }, { "license_module_type": "NETVIZ", "number_of_licenses": 100 }, { "license_module_type": "MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "NODEJS", "number_of_licenses": 100 }, { "license_module_type": "SIM_MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "PHP", "number_of_licenses": 100 }, { "license_module_type": "PYTHON", "number_of_licenses": 100 } ], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "ap1845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": null, "peak_usage": null }
作成時にはバージョンを 0 にする必要があります。
現在のアカウントのすべてのライセンスルールの概要を返します。
ライセンスルールの概要を取得するには、これを使用します。返されるデータ転送オブジェクト(DTO)には、制約、一致条件、または権限付与は含まれません。
URL
http://<host>:<port>/controller/mds/v1/license/rules
フォーマット(Format)
GET /controller/mds/v1/license/rules
例
[ { "id": "f36e08e2-5f57-4b8c-9ad2-f18873adcd87", "version": 2, "name": "Default", "description": null, "enabled": true, "constraints": [], "entitlements": [], "account_id": "0429fc7b-a2b9-42e3-a7fb-f704d436a054", "access_key": "account-accesskey-123", "total_licenses": 120, "peak_usage": null } ]
ライセンスルールを更新する
URL
http://<host>:<port>/controller/mds/v1/license/rules
形式
PUT /controller/mds/v1/license/rules
入力パラメータ
Parameter Name | Parameter Type | Value | 必須 |
---|---|---|---|
id | 文字列 | ID または名前を表す文字列。 | [はい(Yes)] に設定 |
license_module_type | 文字列 | ライセンスモジュールのタイプを表す文字列。 モジュールタイプ:
| [はい(Yes)] に設定 |
version | 整数型(Integer) | バージョン番号を示します。 | [はい(Yes)] に設定 |
number_of_licenses | 整数型(Integer) | 必要なライセンス数を示す整数。 | [はい(Yes)] に設定 |
account_id | 文字列 | アカウント名またはアカウント ID を提供します。 | [はい(Yes)] に設定 |
access_key | [パス(Path)] | アカウントアクセスキーを提供します。 | [はい(Yes)] に設定 |
要求の例
curl -v -X PUT http://<host>:<port>/controller/mds/v1/license/rules \ --user <user>@<AccountName>:<password> \ -H 'Content-Type: application/json' \ -d '{ "id": "321116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Default_API", "description": null, "enabled": true, "constraints": [], "entitlements": [ { "license_module_type": "JAVA", "number_of_licenses": 1000 }, { "license_module_type": "NATIVE_WEB_SERVER", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_SDK", "number_of_licenses": 100 }, { "license_module_type": "DOT_NET", "number_of_licenses": 100 }, { "license_module_type": "NETVIZ", "number_of_licenses": 100 }, { "license_module_type": "MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "NODEJS", "number_of_licenses": 100 }, { "license_module_type": "SIM_MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "PHP", "number_of_licenses": 100 }, { "license_module_type": "PYTHON", "number_of_licenses": 100 } ], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "api845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": null, "peak_usage": null }
ライセンスルールを更新するには、次の手順を実行します。
1. 使用可能な GET
メソッドのいずれかを使用してペイロードを取得します。
2.accessKeys
、権限付与などを更新します。
3. 他のキーと値のペアを変更せずに PUT
要求を送信します。
4. "version
" は GET
時の状態のまま維持する必要があります。これはインクリメントされます。
ライセンスルールを削除する
URL
http://<host>:<port>/controller/mds/v1/license/rules/f36e08e2-5f57-4b8c-9ad2-f18873adcd87
形式
DELETE /controller/mds/v1/license/rules/{id}
入力パラメータ
Parameter Name | Parameter Type | Value | 必須 |
---|---|---|---|
| パス | ID によってライセンスルールを削除します。 | 対応 |
ID によるライセンスルールの取得
ライセンスルール ID によってライセンスルールを取得するには、これを使用します。
URL
http://<host>:<port>/mds/v1/license/rules/f36e08e2-5f57-4b8c-9ad2-f18873adcd87
形式
GET /mds/v1/license/rules/{licenseRuleId}
パス パラメータ
Parameter Name | Parameter Type | Value | 必須 |
---|---|---|---|
licenseRuleId | パス | ライセンスルールの UUID を取得します。 | あり |
出力パラメータ
Parameter Name | Parameter Type | Value | Mandatory |
---|---|---|---|
id | 文字列 | ID または名前を表す文字列。 | [はい(Yes)] に設定 |
version | 整数型(Integer) | バージョン番号を示します。 | [はい(Yes)] に設定 |
total_licenses | 整数型(Integer) | ライセンスの合計数を示す整数。 | [はい(Yes)] に設定 |
account_id | 文字列 | アカウント名またはアカウント ID を提供します。 | [はい(Yes)] に設定 |
access_key | path | アカウントアクセスキーを提供します。 | [はい(Yes)] に設定 |
例
curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules/091116a4-124c-4b73-9343-f315836f103b
{ "id": "091116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Default", "description": null, "enabled": true, "constraints": [], "entitlements": [ { "license_module_type": "JAVA", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_WEB_SERVER", "number_of_licenses": 100 }, { "license_module_type": "NATIVE_SDK", "number_of_licenses": 100 }, { "license_module_type": "DOT_NET", "number_of_licenses": 100 }, { "license_module_type": "NETVIZ", "number_of_licenses": 100 }, { "license_module_type": "MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "NODEJS", "number_of_licenses": 100 }, { "license_module_type": "SIM_MACHINE_AGENT", "number_of_licenses": 100 }, { "license_module_type": "PHP", "number_of_licenses": 100 }, { "license_module_type": "PYTHON", "number_of_licenses": 100 } ], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "bd3845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": null, "peak_usage": null }
"version
" は UI または API からの更新のたびに更新されます。
アクセスキーごとにライセンスルールを取得する
URL
http://<host>:<port>/controller/mds/v1/license/rules/accessKey/account-accesskey-123
形式
GET /controller/mds/v1/license/rules/accessKey/{accessKey}
パス パラメータ
Parameter Name | Parameter Type | Value | 必須 |
---|---|---|---|
access_key | パス | ライセンスルールに割り当てられているアクセスキーを取得します。 | あり |
出力パラメータ
Parameter Name | Parameter Type | Value | Mandatory |
---|---|---|---|
id | 文字列 | ID または名前を表す文字列。 | [はい(Yes)] に設定 |
version | 整数型(Integer) | バージョン番号を示します。 | [はい(Yes)] に設定 |
total_licenses | 整数型(Integer) | ライセンスの合計数を示す整数。 | [はい(Yes)] に設定 |
account_id | 文字列 | アカウント名またはアカウント ID を提供します。 | [はい(Yes)] に設定 |
例
curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules
[ { "id": "221116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Default", "description": null, "enabled": true, "constraints": [], "entitlements": [], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "bd3845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": 1000, "peak_usage": null }, { "id": "321116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Custom1", "description": null, "enabled": true, "constraints": [], "entitlements": [], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "api845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": 1000, "peak_usage": null } ]
名前ごとにライセンスルールを取得する
URL
http://<host>:<port>/controller/mds/v1/license/rules/name/Default
形式
GET /controller/mds/v1/license/rules/name/{name}
パス パラメータ
Parameter Name | Parameter Type | Value | 必須 |
---|---|---|---|
| パス | ライセンスルールの名前を取得します。 | あり |
出力パラメータ
Parameter Name | Parameter Type | Value | Mandatory |
---|---|---|---|
id | 文字列 | ID または名前を表す文字列。 | [はい(Yes)] に設定 |
version | 整数型(Integer) | バージョン番号を示します。 | [はい(Yes)] に設定 |
total_licenses | 整数型(Integer) | ライセンスの合計数を示す整数。 | [はい(Yes)] に設定 |
account_id | 文字列 | アカウント名またはアカウント ID を提供します。 | [はい(Yes)] に設定 |
例
curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules
[ { "id": "221116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Default", "description": null, "enabled": true, "constraints": [], "entitlements": [], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "bd3845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": 1000, "peak_usage": null }, { "id": "321116a4-124c-4b73-9343-f315836f103b", "version": 0, "name": "Custom1", "description": null, "enabled": true, "constraints": [], "entitlements": [], "account_id": "8b1e92f2-387c-45b6-9bb5-ebd7f67587d4", "access_key": "api845ad-1f3e-4c9b-909b-a3cfa510bfb0", "total_licenses": 1000, "peak_usage": null } ]