ライセンス API

このページでは、ライセンスファイルのアップロード、ライセンスの割り当て、ライセンスおよびアカウントの使用情報の取得、ライセンスルールの作成、更新、削除など、ライセンスおよびアカウントに関連する機能の実行に使用できるライセンス API について説明します。

次のライセンス API は、ライセンスモデル別に分類されています。各モデル内のライセンスの詳細については、「ライセンスの付与および制限事項」を参照してください。

インフラストラクチャベースのライセンス

インフラストラクチャベースのライセンスの API：

エージェントベースのライセンス

エージェントベースのライセンスの API：

ライセンスルール API

License Usage API

A RESTful API to programmatically retrieve overall license usage by application ID or name, or by host ID.

Retrieve Usage by Application ID

You can retrieve license usage details (such as vCPU count) for an application by application ID.

URL

http://<host>:<port>/controller/licensing/v1/account/{accountId}/grouped-usage/application/by-id

Format

GET /controller/licensing/v1/account/{accountId}/grouped-usage/application/by-id

Path Parameters


Parameter Name	Parameter Type	Value	Mandatory
accountId	Integer	Account identification for which allocations are requested to be retrieved.	Yes

Query Parameters


Parameter Name	Parameter Type	Value	Mandatory
appId	Array	A set of application IDs.	Yes
`includeAgents`	Boolean	Flag indicates whether the list of agents is required in response.	No

Response Format

response appObject


Parameter Name	Parameter Type	Value
vCpuTotal	Integer	Total number of vCPUs on hosts where all applications are running.
fallbackLicenseUnits	Object	Total number of (fallback) license units used by the applications per package name.
items	Object	Detail of usages by application.

appItemObject


Parameter Name	Parameter Type	Value
appId	Integer	Application ID.
appName	String	Application name.
vCpu	Integer	Number of vCPU on the host.
nodes	Object (`nodeObject`)	Nodes where the application is running.
containers	Object (`containerObject`)	Containers where the application is running.
agents	Object (`agentObject`)	(Optional) License keys associated with all agents.
hosts	Object (`hostObject`)	Hosts where the application is running. Will be `null` when this object is self-referenced.

nodeObject


Parameter Name	Parameter Type	Value
nodeName	String	Node name.

containerObject


Parameter Name	Parameter Type	Value
containerId	String	Container ID.

agentObject


Parameter Name	Parameter Type	Value
type	String	Agent type.
version	String	Agent version.
licenseKey	String	License key used to obtain lease.

hostObject


Parameter Name	Parameter Type	Value
vCpuTotal	Integer	Total number of vCPUs on hosts.
items	Object	Detail of usages by host.

hostItemObject


Parameter Name	Parameter Type	Value
host	String	Host name.
fallbackLicenseUnits	Object	License unit used by the application/host per package name.
vCpu	Integer	Number of vCPU on the host.
nodes	Object (`nodeObject`)	Number of nodes on the host.
containers	Object (`containerObject`)	Number of containers on the host.
agents	Object (`agentObject`)	(Optional) License keys associated with all agents.
application	Object (`appItemObject`)	Applications running on the host. Will be `null` when this object is self-referenced.

Example

Request

curl --user <user>@<AccountName>:<password> "http://<host>:<port>/controller/licensing/v1/account/1965/grouped-usage/application/by-id?appId=18151&appId=18156&appId=18157&includeAgents=true"

Response

{
  "vCpuTotal": 48,
  "items": {
    "18156": {
      "vCpu": 32,
      "nodes": [
        {
          "nodeName": "OrderFulfillmentServiceNode"
        },
        {
          "nodeName": "OrderFulfillmentServiceDotnetNode"
        }
      ],
      "containers": [
        {
          "containerId": "orderfulfillmentservice"
        },
        {
          "containerId": "fe8ec1f60b5b"
        }
      ],
      "agents": [
        {
          "type": "APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        },
        {
          "type": "DOT_NET_APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        }
      ],
      "appId": 18156,
      "appName": "Sangrah-OrderFulfillment",
      "hosts": {
        "vCpuTotal": 32,
        "items": {
          "sangrah_analytics": {
            "vCpu": 16,
            "nodes": [
              {
                "nodeName": "OrderFulfillmentServiceDotnetNode"
              }
            ],
            "containers": [
              {
                "containerId": "fe8ec1f60b5b"
              }
            ],
            "agents": [
              {
                "type": "DOT_NET_APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              }
            ],
            "host": "sangrah_analytics",
            "fallbackLicenseUnits": {}
          },
          "ip-10-117-85-124": {
            "vCpu": 16,
            "nodes": [
              {
                "nodeName": "OrderFulfillmentServiceNode"
              }
            ],
            "containers": [
              {
                "containerId": "orderfulfillmentservice"
              }
            ],
            "agents": [
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              }
            ],
            "host": "ip-10-117-85-124",
            "fallbackLicenseUnits": {}
          }
        }
      }
    },
    "18157": {
      "vCpu": 16,
      "nodes": [
        {
          "nodeName": "CartServiceNode"
        },
        {
          "nodeName": "CustomPojoRulesServiceNode"
        },
        {
          "nodeName": "OrderProcessingServiceNode"
        },
        {
          "nodeName": "PaymentServiceNode"
        },
        {
          "nodeName": "OrderServiceNode"
        },
        {
          "nodeName": "ApacheWebServerNode"
        },
        {
          "nodeName": "ShippingServiceNode"
        },
        {
          "nodeName": "FrontEndNode-0"
        }
      ],
      "containers": [
        {
          "containerId": "shippingservice"
        },
        {
          "containerId": "99d7338250be"
        },
        {
          "containerId": "apacheloadbalancer"
        },
        {
          "containerId": "frontend"
        },
        {
          "containerId": "orderprocessingservice"
        },
        {
          "containerId": "cartservice"
        },
        {
          "containerId": "orderservice"
        },
        {
          "containerId": "70b30fc810bc"
        }
      ],
      "agents": [
        {
          "type": "NATIVE_WEB_SERVER",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        },
        {
          "type": "APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        },
        {
          "type": "PHP_APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        }
      ],
      "appId": 18157,
      "appName": "SangrahApp",
      "hosts": {
        "vCpuTotal": 16,
        "items": {
          "ip-10-117-85-124": {
            "vCpu": 16,
            "nodes": [
              {
                "nodeName": "CartServiceNode"
              },
              {
                "nodeName": "CustomPojoRulesServiceNode"
              },
              {
                "nodeName": "OrderProcessingServiceNode"
              },
              {
                "nodeName": "PaymentServiceNode"
              },
              {
                "nodeName": "OrderServiceNode"
              },
              {
                "nodeName": "ApacheWebServerNode"
              },
              {
                "nodeName": "ShippingServiceNode"
              },
              {
                "nodeName": "FrontEndNode-0"
              }
            ],
            "containers": [
              {
                "containerId": "shippingservice"
              },
              {
                "containerId": "99d7338250be"
              },
              {
                "containerId": "apacheloadbalancer"
              },
              {
                "containerId": "frontend"
              },
              {
                "containerId": "orderprocessingservice"
              },
              {
                "containerId": "cartservice"
              },
              {
                "containerId": "orderservice"
              },
              {
                "containerId": "70b30fc810bc"
              }
            ],
            "agents": [
              {
                "type": "NATIVE_WEB_SERVER",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              },
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              },
              {
                "type": "PHP_APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              }
            ],
            "host": "ip-10-117-85-124",
            "fallbackLicenseUnits": {}
          }
        }
      }
    }
  }
}

Retrieve by Application Name

You can retrieve license usage details (such as vCPU count) for an application by application name.

URL

http://<host>:<port>/controller/licensing/v1/account/{accountId}/grouped-usage/application/by-name

Format

GET /controller/licensing/v1/account/{accountId}/grouped-usage/application/by-name

Path Parameters


Parameter Name	Parameter Type	Value	Mandatory
accountId	Integer	Account identification for which allocations are requested to be retrieved.	Yes

Query Parameters


Parameter Name	Parameter Type	Value	Mandatory
appName	Array	A set of (URL escaped) application names.	Yes
`includeAgents`	Boolean	Flag indicates whether the list of agents is required in response.	No

Response Format

response appObject


Parameter Name	Parameter Type	Value
vCpuTotal	Integer	Total number of vCPUs on hosts where all applications are running.
fallbackLicenseUnits	Object	Total number of (fallback) license units used by the applications per package name.
items	Object	Detail of usages by application.

appItemObject


Parameter Name	Parameter Type	Value
appId	Integer	Application ID.
appName	String	Application name.
vCpu	Integer	Number of vCPUs on the host.
nodes	Object (`nodeObject`)	Nodes where the application is running.
containers	Object (`containerObject`)	Containers where the application is running.
agents	Object (`agentObject`)	(Optional) License keys associated with all agents.
hosts	Object (`hostObject`)	Hosts where the application is running. Will be `null` when this object is self-referenced.

nodeObject


Parameter Name	Parameter Type	Value
nodeName	String	Node name.

containerObject


Parameter Name	Parameter Type	Value
containerId	String	Container ID.

agentObject


Parameter Name	Parameter Type	Value
type	String	Agent type.
version	String	Agent version.
licenseKey	String	License key used to obtain lease.

hostObject


Parameter Name	Parameter Type	Value
vCpuTotal	Integer	Total number of vCPUs on hosts.
items	Object	Detail of usages by host.

hostItemObject


Parameter Name	Parameter Type	Value
host	String	Host name.
fallbackLicenseUnits	Object	License unit used by the application/host per package name.
vCpu	Integer	Number of vCPU nodes on the host.
nodes	Object (`nodeObject`)	Nodes where the application is running.
containers	Object (`containerObject`)	Containers where the application is running.
agents	Object (`agentObject`)	(Optional) License keys associated with all agents.
application	Object (`appItemObject`)	Applications running on the host. Will be `null` when this object is self-referenced.

Example

Request

curl --user <user>@<AccountName>:<password> "http://<host>:<port>/controller/licensing/v1/account/1965/grouped-usage/application/by-name?appName=SangrahApp&appName=Sangrah-OrderFulfillment&appName=Travel&includeAgents=true"

Response

{
  "vCpuTotal": 48,
  "items": {
    "18156": {
      "vCpu": 32,
      "nodes": [
        {
          "nodeName": "OrderFulfillmentServiceNode"
        },
        {
          "nodeName": "OrderFulfillmentServiceDotnetNode"
        }
      ],
      "containers": [
        {
          "containerId": "orderfulfillmentservice"
        },
        {
          "containerId": "fe8ec1f60b5b"
        }
      ],
      "agents": [
        {
          "type": "APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        },
        {
          "type": "DOT_NET_APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        }
      ],
      "appId": 18156,
      "appName": "Sangrah-OrderFulfillment",
      "hosts": {
        "vCpuTotal": 32,
        "items": {
          "sangrah_analytics": {
            "vCpu": 16,
            "nodes": [
              {
                "nodeName": "OrderFulfillmentServiceDotnetNode"
              }
            ],
            "containers": [
              {
                "containerId": "fe8ec1f60b5b"
              }
            ],
            "agents": [
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              },
              {
                "type": "DOT_NET_APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              }
            ],
            "host": "sangrah_analytics",
            "fallbackLicenseUnits": {}
          },
          "ip-10-115-85-164": {
            "vCpu": 16,
            "nodes": [
              {
                "nodeName": "OrderFulfillmentServiceNode"
              }
            ],
            "containers": [
              {
                "containerId": "orderfulfillmentservice"
              }
            ],
            "agents": [
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              }
            ],
            "host": "ip-10-117-85-124",
            "fallbackLicenseUnits": {}
          }
        }
      }
    },
    "18157": {
      "vCpu": 16,
      "nodes": [
        {
          "nodeName": "CartServiceNode"
        },
        {
          "nodeName": "CustomPojoRulesServiceNode"
        },
        {
          "nodeName": "OrderProcessingServiceNode"
        },
        {
          "nodeName": "PaymentServiceNode"
        },
        {
          "nodeName": "OrderServiceNode"
        },
        {
          "nodeName": "ApacheWebServerNode"
        },
        {
          "nodeName": "ShippingServiceNode"
        }
      ],
      "containers": [
        {
          "containerId": "shippingservice"
        },
        {
          "containerId": "99d7338250be"
        },
        {
          "containerId": "apacheloadbalancer"
        },
        {
          "containerId": "orderprocessingservice"
        },
        {
          "containerId": "cartservice"
        },
        {
          "containerId": "orderservice"
        },
        {
          "containerId": "70b30fc810bc"
        }
      ],
      "agents": [
        {
          "type": "NATIVE_WEB_SERVER",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        },
        {
          "type": "APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        },
        {
          "type": "PHP_APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
        }
      ],
      "appId": 18157,
      "appName": "SangrahApp",
      "hosts": {
        "vCpuTotal": 16,
        "items": {
          "ip-10-115-85-164": {
            "vCpu": 16,
            "nodes": [
              {
                "nodeName": "CartServiceNode"
              },
              {
                "nodeName": "CustomPojoRulesServiceNode"
              },
              {
                "nodeName": "OrderProcessingServiceNode"
              },
              {
                "nodeName": "PaymentServiceNode"
              },
              {
                "nodeName": "OrderServiceNode"
              },
              {
                "nodeName": "ApacheWebServerNode"
              },
              {
                "nodeName": "ShippingServiceNode"
              }
            ],
            "containers": [
              {
                "containerId": "shippingservice"
              },
              {
                "containerId": "99d7338250be"
              },
              {
                "containerId": "apacheloadbalancer"
              },
              {
                "containerId": "orderprocessingservice"
              },
              {
                "containerId": "cartservice"
              },
              {
                "containerId": "orderservice"
              },
              {
                "containerId": "70b30fc810bc"
              }
            ],
            "agents": [
              {
                "type": "NATIVE_WEB_SERVER",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              },
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              },
              {
                "type": "PHP_APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af848"
              }
            ],
            "host": "ip-10-117-85-124",
            "fallbackLicenseUnits": {}
          }
        }
      }
    }
  }
}

Retrieve Usage by Host ID

You can retrieve license usage information (such as vCPU count) for an application by host ID.

URL

http://<host>:<port>/controller/licensing/v1/account/{accountId}/grouped-usage/host

Format

GET /controller/licensing/v1/account/{accountId}/grouped-usage/host

Path Parameters


Parameter Name	Parameter Type	Value	Mandatory
accountId	Integer	Account identification for which allocations are requested to be retrieved.	Yes

Query Parameters


Parameter Name	Parameter Type	Value	Mandatory
hostId	Array	A set of (URL escaped) host IDs.	Yes
`includeAgents`	Boolean	A flag indicates whether the list of agents is required in response.	No

Response Format

response hostObject


Parameter Name	Parameter Type	Value
vCpuTotal	Integer	Total number of vCPUs on hosts.
items	Object	Detail of usages by host.

hostItemObject


Parameter Name	Parameter Type	Value
host	String	Host name.
fallbackLicenseUnits	Object	License unit used by the application/host per package name.
vCpu	Integer	Number of vCPU on the host.
nodes	Object (`nodeObject`)	Number of nodes on the host.
containers	Object (`containerObject`)	Number of containers on the host.
agents	Object (`agentObject`)	(Optional) License keys associated with all agents.
application	Object (`appItemObject`)	Applications running on the host. Will be `null` when this object is self-referenced.

nodeObject


Parameter Name	Parameter Type	Value
nodeName	String	Node name.

containerObject


Parameter Name	Parameter Type	Value
containerId	String	Container ID.

agentObject


Parameter Name	Parameter Type	Value
type	String	Agent type.
version	String	Agent version.
licenseKey	String	License key used to obtain lease.

appObject


Parameter Name	Parameter Type	Value
vCpuTotal	Integer	Total number of vCPUs on hosts where all applications are running.
fallbackLicenseUnits	Object	Total number of (fallback) license units used by the applications per package name.
items	Object	Detail of usages by application.

appItemObject


Parameter Name	Parameter Type	Value
appId	Integer	Application ID.
appName	String	Application name.
vCpu	Integer	Number of vCPU on the host.
nodes	Object (`nodeObject`)	Nodes where the application is running.
containers	Object (`containerObject`)	Containers where the application is running.
agents	Object (`agentObject`)	(Optional) License keys associated with all agents.
hosts	Object (`hostObject`)	Hosts where the application is running. Will be `null` when this object is self-referenced.

Example

Request

curl --user <user>@<AccountName>:<password> "http://<host>:<port>/controller/licensing/v1/account/1965/grouped-usage/host?hostId=ip-10-117-85-124&hostId=sangrah_analytics&includeAgents=true"

Response

{
  "vCpuTotal": 32,
  "items": {
    "sangrah_analytics": {
      "vCpu": 16,
      "nodes": [
        {
          "nodeName": "OrderFulfillmentServiceDotnetNode"
        }
      ],
      "containers": [
        {
          "containerId": "sangrahmysql"
        },
        {
          "containerId": "sangrahoracle"
        },
        {
          "containerId": "fe8ec1f60b5b"
        }
      ],
      "agents": [
        {
          "type": "SIM_MACHINE_AGENT",
          "version": "24.7.0.4339",
          "licenseKey": "d3a4d1d8-5504-402f-8c0a8"
        },
        {
          "type": "DB_COLLECTOR",
          "version": "24.7.0.4394",
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af898"
        },
        {
          "type": "DOT_NET_APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8948"
        }
      ],
      "host": "sangrah_analytics",
      "fallbackLicenseUnits": {},
      "applications": {
        "vCpuTotal": 0,
        "items": {
          "18156": {
            "vCpu": 0,
            "nodes": [
              {
                "nodeName": "OrderFulfillmentServiceDotnetNode"
              }
            ],
            "containers": [
              {
                "containerId": "fe8ec1f60b5b"
              }
            ],
            "agents": [
              {
                "type": "DOT_NET_APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8948"
              }
            ],
            "appId": 18156,
            "appName": "Sangrah-OrderFulfillment"
          }
        }
      }
    },
    "ip-10-117-85-124": {
      "vCpu": 16,
      "nodes": [
        {
          "nodeName": "OrderFulfillmentServiceNode"
        },
        {
          "nodeName": "CartServiceNode"
        },
        {
          "nodeName": "CustomPojoRulesServiceNode"
        },
        {
          "nodeName": "OrderProcessingServiceNode"
        },
        {
          "nodeName": "PaymentServiceNode"
        },
        {
          "nodeName": "OrderServiceNode"
        },
        {
          "nodeName": "ApacheWebServerNode"
        },
        {
          "nodeName": "ShippingServiceNode"
        }
      ],
      "containers": [
        {
          "containerId": "shippingservice"
        },
        {
          "containerId": "orderfulfillmentservice"
        },
        {
          "containerId": "99d7338250be"
        },
        {
          "containerId": "apacheloadbalancer"
        },
        {
          "containerId": "orderprocessingservice"
        },
        {
          "containerId": "cartservice"
        },
        {
          "containerId": "orderservice"
        },
        {
          "containerId": "70b30fc810bc"
        }
      ],
      "agents": [
        {
          "type": "SIM_MACHINE_AGENT",
          "version": "24.7.0.4339",
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af2148"
        },
        {
          "type": "NETVIZ_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8148"
        },
        {
          "type": "NATIVE_WEB_SERVER",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8148"
        },
        {
          "type": "APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8248"
        },
        {
          "type": "PHP_APP_AGENT",
          "version": null,
          "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8148"
        }
      ],
      "host": "ip-10-117-85-124",
      "fallbackLicenseUnits": {},
      "applications": {
        "vCpuTotal": 0,
        "items": {
          "18156": {
            "vCpu": 0,
            "nodes": [
              {
                "nodeName": "OrderFulfillmentServiceNode"
              }
            ],
            "containers": [
              {
                "containerId": "orderfulfillmentservice"
              }
            ],
            "agents": [
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af898"
              }
            ],
            "appId": 18156,
            "appName": "Sangrah-OrderFulfillment"
          },
          "18157": {
            "vCpu": 0,
            "nodes": [
              {
                "nodeName": "CartServiceNode"
              },
              {
                "nodeName": "CustomPojoRulesServiceNode"
              },
              {
                "nodeName": "OrderProcessingServiceNode"
              },
              {
                "nodeName": "PaymentServiceNode"
              },
              {
                "nodeName": "OrderServiceNode"
              },
              {
                "nodeName": "ApacheWebServerNode"
              },
              {
                "nodeName": "ShippingServiceNode"
              }
            ],
            "containers": [
              {
                "containerId": "shippingservice"
              },
              {
                "containerId": "99d7338250be"
              },
              {
                "containerId": "apacheloadbalancer"
              },
              {
                "containerId": "orderprocessingservice"
              },
              {
                "containerId": "cartservice"
              },
              {
                "containerId": "orderservice"
              },
              {
                "containerId": "70b30fc810bc"
              }
            ],
            "agents": [
              {
                "type": "NATIVE_WEB_SERVER",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af8148"
              },
              {
                "type": "APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af89848"
              },
              {
                "type": "PHP_APP_AGENT",
                "version": null,
                "licenseKey": "d3a4d1d8-5504-402f-8c0a-af89848"
              }
            ],
            "appId": 18157,
            "appName": "SangrahApp"
          }
        }
      }
    }
  }
}

アカウント使用状況 API

ライセンスとアカウントの ID によってアカウントの使用状況をプログラムで取得するための RESTful API です。

ライセンス ID によるアカウント使用状況の取得

指定されたライセンス ID によって参照されるアカウント使用状況を取得します。

URL

http://<host>:<port>/controller/licensing/v1/usage/license/{licenseId}

形式

GET /controller/licensing/v1/usage/license/{licenseId}

パスパラメータ


パラメータ名	Parameter Type	値	必須
licenseId	文字列	使用状況の取得が要求されるライセンス ID。	あり

クエリパラメータ


パラメータ名	Parameter Type	値	必須
dateFrom	文字列	要求されたライセンス使用期間の開始日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
dateTo	文字列	要求されたライセンス使用期間の終了日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
granularityMinutes	整数	要求されたライセンス使用状況データの粒度。	あり
includeEntityTypes	ブーリアン	ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは `false.`	いいえ
includeConsumptionBased	ブーリアン	消費ベースの使用状況を含めるかどうか。デフォルトは `false.`	いいえ

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
accountId	整数	アカウント ID。
license-rules	オブジェクト	アカウントまたは割り当てのライセンス使用状況を表すエンティティ。
packages	パッケージオブジェクトの配列

licenseRule オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割当 ID。
name	文字列	割り当て名。
licenseKey	文字列	この特定の割り当てのライセンスキー。

package オブジェクト


パラメータ名	Parameter Type	値
`packageName`	文字列	次のパッケージ（エディション）インスタンスの名前を表す列挙型： infra "PREMIUM" "ENTERPRISE"
`type`	文字列	次のパッケージインスタンスのタイプを表す列挙型： "PAID" トライアル "LITE"
`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
}
}
]
}
}
]
}
]
}

アカウント ID によるアカウント使用状況の取得

指定のアカウント ID で参照するアカウント使用状況を取得します。

URL

http://<host>:<port>/controller/licensing/v1/usage/account/{accountId}

形式

GET /controller/licensing/v1/usage/account/{accountId}

パスパラメータ


パラメータ名	Parameter Type	値	必須
`accountId`	整数	使用状況の取得が要求されるアカウント ID。	あり

クエリパラメータ


パラメータ名	Parameter Type	値	必須
`dateFrom`	文字列	要求されたライセンス使用期間の開始日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
`dateTo`	文字列	要求されたライセンス使用期間の終了日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
`granularityMinutes`	整数	要求されたライセンス使用状況データの粒度。	あり
`includeEntityTypes`	ブーリアン	ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは `false.`	いいえ
`includeConsumptionBased`	ブーリアン	消費ベースの使用状況を含めるかどうか。デフォルトは `false.`	いいえ

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
accountId	整数	アカウント ID。
license-rules	オブジェクト	アカウントまたは割り当てのライセンス使用状況を表すエンティティ。
packages	配列	パッケージオブジェクト

licenseRule オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割当 ID。
name	文字列	割り当て名。
licenseKey	文字列	この特定の割り当てのライセンスキー。

package オブジェクト


パラメータ名	Parameter Type	値
`packageName`	文字列	次のパッケージ（エディション）インスタンスの名前を表す列挙型： infra "PREMIUM" "ENTERPRISE"
`type`	文字列	次のパッケージインスタンスのタイプを表す列挙型： "PAID" トライアル "LITE"
`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
}
}
]
}
}
]
}
]
}

ライセンス割り当て API

次の方法では、アカウントのライセンス割り当て（ライセンスルール）を取得、作成、フィルタリング、および削除できます。

すべてのライセンス割り当ての取得

すべてのライセンス割り当てを取得し、オプションのクエリパラメータを使用して割り当てのリストを絞り込みます。

URL

http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation

形式

 GET /controller/licensing/v1/account/{accountId}/allocation

パスパラメータ


パラメータ名	Parameter Type	値	必須
accountId	整数	割り当ての取得が要求されるアカウント ID。	あり

クエリパラメータ


パラメータ名	Parameter Type	値	必須
name	文字列	割り当ての名前。`license-key` と `tag` と組み合わせて使用することはできません。	いいえ
license-key	文字列	割り当てのライセンスキー。`name` と `tag` と組み合わせて使用することはできません。	いいえ
tag	文字列	割り当てに関連付けられたタグ。 `name` と `license-key` と組み合わせて使用することはできません。	いいえ

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割当 ID。アカウントごとに一意です。
accountId	整数	割り当てが属するアカウント ID。
name	文字列	割り当ての名前。アカウントごとに一意です。
licenseKey	文字列	割り当てで使用するライセンスキー。アカウントごとに一意です。
filters	オブジェクトの配列	filter オブジェクトの配列
制限	オブジェクトの配列	`limit` オブジェクトの配列
タグ	Array of Strings	割り当てに関連付けられたタグ。
"createdDate": "",	文字列	割り当ての作成日：ISO 8601 日時文字列。
lastUpdatedDate	文字列	割り当ての最終更新日：ISO 8601 日時文字列。

filter オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当ての名前。アカウントごとに一意です。
type	文字列	フィルタを適用するエンティティのタイプ。列挙型："APPLICATION" "HOST"
operator	文字列	`type` を `value:` と照合する際に使用する次の列挙型の演算子 `ID_EQUALS` ：エンティティ ID の完全一致 `EQUALS` ：エンティティ値の完全一致 `STARTS_WITH` ：値で始まるエンティティの一致 `ENDS_WITH` ：値で終わるエンティティの一致 `CONTAINS` ：値を含むエンティティの一致 `REGEX` ：正規表現でのエンティティの一致
value	文字列	フィルタ対象の値。

limit オブジェクト


パラメータ名	Parameter Type	値
`id`	文字列	割り当てパッケージ制限 ID。
`package`	文字列	制限のパッケージのタイプ。サポートされている列挙型は次のとおりです。 infra "PREMIUM" "ENTERPRISE"
`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 による割り当て使用状況の取得

指定のライセンスキー ID で参照する割り当てルール使用状況を取得します。

URL

http://<host>:<port>/controller/licensing/v1/usage/account/{accountId}/allocation/{licenseKey}

形式

 GET /controller/licensing/v1/usage/account/{accountId}/allocation/{licenseKey}

パスパラメータ


パラメータ名	Parameter Type	値	必須
`accountId`	整数	使用状況の取得が要求されるアカウント ID。	あり
`licenseKey`	文字列	割り当てルールに基づいたライセンスキーが選択されます。返される使用状況は、その特定の割り当てルールに関連します。	あり

クエリパラメータ


パラメータ名	Parameter Type	値	必須
dateFrom	文字列	要求されたライセンス使用期間の開始日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
dateTo	文字列	要求されたライセンス使用期間の終了日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
granularityMinutes	整数	要求されたライセンス使用状況データの粒度。	あり
includeEntityTypes	ブーリアン	ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは `false.`	いいえ

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
accountId	整数	アカウント ID。
licenseRule	オブジェクト	アカウントまたは割り当てのライセンス使用状況を表すエンティティ。
packages	配列	パッケージオブジェクト。

licenseRule オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割当 ID。
name	文字列	割り当て名。
licenseKey	文字列	この特定の割り当てのライセンスキー。

package オブジェクト


パラメータ名	Parameter Type	値
`packageName`	文字列	次のパッケージ（エディション）インスタンスの名前を表す列挙型： infra "PREMIUM" "ENTERPRISE"
`type`	文字列	次のパッケージインスタンスのタイプを表す列挙型： "PAID" トライアル "LITE"
`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
}
}
]
}
}
]
}
]
}

ライセンスキーによる割り当て使用状況の取得

指定のライセンスキーで参照する割り当て使用状況を取得します。

URL

http://<host>:<port>/controller/licensing/v1/usage/license/{licenseId}/allocation/{licenseKey}

形式

GET /controller/licensing/v1/usage/license/{licenseId}/allocation/{licenseKey}

パスパラメータ


パラメータ名	Parameter Type	値	必須
`licenseId`	文字列	使用状況の取得が要求されるライセンス ID。	あり
`licenseKey`	文字列	割り当てルールに基づいたライセンスキーが選択されます。返される使用状況は、その特定の割り当てルールに関連します。	あり

クエリパラメータ


パラメータ名	Parameter Type	値	必須
dateFrom	文字列	要求されたライセンス使用期間の開始日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
dateTo	文字列	要求されたライセンス使用期間の終了日。対応する形式は ISO-8601（拡張）です。例：2020-10-05T10:00:00Z	あり
granularityMinutes	整数	要求されたライセンス使用状況データの粒度。	あり
includeEntityTypes	ブーリアン	ライセンスされたエンティティタイプの使用状況を含めるかどうかを指定します。デフォルトは `false.`	いいえ

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
accountId	整数	アカウント ID。
licenseRule	オブジェクト	アカウントまたは割り当てのライセンス使用状況を表すエンティティ。
packages	パッケージオブジェクトの配列	パッケージオブジェクト。

licenseRule オブジェクト


パラメータ名	Parameter Type	値
`id`	文字列	割当 ID。
`name`	文字列	割り当て名。
`licenseKey`	文字列	この特定の割り当てのライセンスキー。

package オブジェクト


パラメータ名	Parameter Type	値
`packageName`	文字列	次のパッケージ（エディション）インスタンスの名前を表す列挙型： infra "PREMIUM" "ENTERPRISE"
`type`	文字列	次のパッケージインスタンスのタイプを表す列挙型： "PAID" トライアル "LITE"
`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 はフィルタリングされない
他の一意のパラメータ（name、licenseKey など）が既存の割り当てと競合しない

URL

http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation

形式

 POST /controller/licensing/v1/account/{accountId}/allocation

パスパラメータ


パラメータ名	Parameter Type	値	必須
`accountId`	整数	割り当ての取得が要求されるアカウント ID。	あり

要求の形式

request オブジェクト


パラメータ名	Parameter Type	値	必須
fallbackModeDelay	ブーリアン	`true` に設定されている場合、コンテナ（インフラストラクチャベースのライセンス）で実行されるアプリケーションサーバーエージェントは、vCPU 数が不明な場合、事前定義された期間拒否されます。フォールバック vCPU 数は、実際の vCPU 数がまだ不明な場合に、この時間が経過して初めてデフォルト値に設定されます。実際の vCPU 数が判明すると、その vCPU 数がすぐに使用されます。	あり
filters	オブジェクトの配列	`filter` オブジェクトの配列	いいえ
制限	オブジェクトの配列	`limit` オブジェクトの配列
`machineAgentPriority`	ブーリアン	アプリケーションサーバーエージェントに対してインフラストラクチャベースライセンス（IBL）を使用する場合に、マシンエージェントの使用に関してライセンスリースが優先順位付けされることを示します。	あり
name	文字列	割り当ての名前。アカウントごとに一意です。	あり

Filter オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当ての名前。アカウントごとに一意です。
type	文字列	フィルタを適用するエンティティのタイプ。列挙型："APPLICATION" "HOST"
operator	文字列	`type` を `value:` と照合する際に使用する次の列挙型の演算子 `ID_EQUALS` ：エンティティ ID の完全一致 `EQUALS` ：エンティティ値の完全一致 `STARTS_WITH` ：値で始まるエンティティの一致 `ENDS_WITH` ：値で終わるエンティティの一致 `CONTAINS` ：値を含むエンティティの一致 `REGEX` ：正規表現でのエンティティの一致
value	文字列	フィルタ対象の値。

limit オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当てパッケージ制限 ID。
package	文字列	制限のパッケージのタイプ。サポートされている列挙型は次のとおりです。 infra "PREMIUM" "ENTERPRISE"
units	整数	割り当て制限ごとのライセンスユニットの数。
タグ	Array of Strings	割り当てに関連付けられたタグ。

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割当 ID。アカウントごとに一意です。
accountId	整数	割り当てが属するアカウント ID。
name	文字列	割り当ての名前。アカウントごとに一意です。
licenseKey	文字列	割り当てで使用するライセンスキー。アカウントごとに一意です。
filters	オブジェクトの配列	filter オブジェクトの配列
制限	オブジェクトの配列	`limit` オブジェクトの配列
タグ	Array of Strings	割り当てに関連付けられたタグ。
"createdDate": "",	文字列	割り当ての作成日：ISO 8601 日時文字列。
lastUpdatedDate	文字列	割り当ての最終更新日：ISO 8601 日時文字列。

filter オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当ての名前。アカウントごとに一意です。
type	文字列	フィルタを適用するエンティティのタイプ。列挙型："APPLICATION" "HOST"
operator	文字列	`type` を `value:` と照合する際に使用する次の列挙型の演算子 `ID_EQUALS` ：エンティティ ID の完全一致 `EQUALS` ：エンティティ値の完全一致 `STARTS_WITH` ：値で始まるエンティティの一致 `ENDS_WITH` ：値で終わるエンティティの一致 `CONTAINS` ：値を含むエンティティの一致 `REGEX` ：正規表現でのエンティティの一致
value	文字列	フィルタ対象の値。

limit オブジェクト


パラメータ名	Parameter Type	値
`id`	文字列	割り当てパッケージ制限 ID。
`package`	文字列	制限のパッケージのタイプ。サポートされている列挙型は次のとおりです。 infra "PREMIUM" "ENTERPRISE"
`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}

パスパラメータ


パラメータ名	Parameter Type	値	必須
accountId	整数	割り当ての取得が要求されるアカウント ID。	あり
allocationId	文字列	取得する割り当てを参照する割り当て ID。	あり

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割当 ID。アカウントごとに一意です。
accountId	整数	割り当てが属するアカウント ID。
`fallbackModeDelay`	ブーリアン	`true` の場合、コンテナ（インフラストラクチャベースのライセンス）で実行されるアプリケーションサーバーエージェントは、vCPU 数が不明な場合、事前定義された期間拒否されます。フォールバック vCPU 数は、実際の vCPU 数がまだ不明な場合に、この時間が経過して初めてデフォルト値に設定されます。実際の vCPU 数が判明すると、その vCPU 数がすぐに使用されます。
name	文字列	割り当ての名前。アカウントごとに一意です。
licenseKey	文字列	割り当てで使用するライセンスキー。アカウントごとに一意です。
filters	オブジェクトの配列	filter オブジェクトの配列
limits	オブジェクトの配列	`limit` オブジェクトの配列
`machineAgentPriority`	ブーリアン	アプリケーションサーバーエージェントを優先してインフラストラクチャベースライセンス（IBL）を使用する場合に、マシンエージェントの使用に関してライセンスリースを優先順位付けするには、true に設定します。
tags	Array of Strings	割り当てに関連付けられたタグ。
"createdDate": "",	文字列	割り当ての作成日：ISO 8601 日時文字列。
lastUpdatedDate	文字列	割り当ての最終更新日：ISO 8601 日時文字列。

filter オブジェクト


パラメータ名	Parameter Type	値
`id`	文字列	割り当ての名前。アカウントごとに一意です。
`type`	文字列	フィルタを適用するエンティティのタイプ。列挙型："APPLICATION" "HOST"
`operator`	文字列	以下のタイプ値を照合する際に使用する次の列挙型の演算子 `ID_EQUALS` ：エンティティ ID の完全一致 `EQUALS` ：エンティティ値の完全一致 `STARTS_WITH` ：値で始まるエンティティの一致 `ENDS_WITH` ：値で終わるエンティティの一致 `CONTAINS` ：値を含むエンティティの一致 `REGEX` ：正規表現でのエンティティの一致
`value`	文字列	フィルタ対象の値。

limit オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当てパッケージ制限 ID。
パッケージ	文字列	制限のパッケージのタイプ。サポートされている列挙型は次のとおりです。 infra "PREMIUM" "ENTERPRISE"
units	整数	割り当て制限ごとのライセンスユニットの数。
タグ	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}

パスパラメータ


パラメータ名	Parameter Type	値	必須
accountId	整数	割り当ての取得が要求されるアカウント ID。	あり
allocationId	文字列	取得する割り当てを参照する割り当て ID。	あり

要求の形式

request オブジェクト


パラメータ名	Parameter Type	値	必須
`fallbackModeDelay`	ブーリアン	`true` に設定されている場合、コンテナ（インフラストラクチャベースのライセンス）で実行されるアプリケーションサーバーエージェントは、vCPU 数が不明な場合、事前定義された期間拒否されます。フォールバック vCPU 数は、実際の vCPU 数がまだ不明な場合に、この時間が経過して初めてデフォルト値に設定されます。実際の vCPU 数が判明すると、その vCPU 数がすぐに使用されます。	あり
filters	文字列	取得する割り当てを参照する割り当て ID。	いいえ
制限	オブジェクト		いいえ
`machineAgentPriority`	ブーリアン	アプリケーションサーバーエージェントを優先してインフラストラクチャベースライセンス（IBL）を使用する場合に、マシンエージェントの使用に関してライセンスリースを優先順位付けするには、`true` に設定します。	あり
name	文字列	割り当ての名前。アカウントごとに一意です。	あり
タグ	Array of Strings		いいえ

filter オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当ての名前。アカウントごとに一意です。
type	文字列	フィルタを適用するエンティティのタイプ。列挙型："APPLICATION" "HOST"
operator	文字列	`type` を `value:` と照合する際に使用する次の列挙型の演算子 `ID_EQUALS` ：エンティティ ID の完全一致 `EQUALS` ：エンティティ値の完全一致 `STARTS_WITH` ：値で始まるエンティティの一致 `ENDS_WITH` ：値で終わるエンティティの一致 `CONTAINS` ：値を含むエンティティの一致 `REGEX` ：正規表現でのエンティティの一致
value	文字列	フィルタ対象の値。

limit オブジェクト


パラメータ名	Parameter Type	値
id	文字列	割り当てパッケージ制限 ID。
パッケージ	文字列	制限のパッケージのタイプ。サポートされている列挙型は次のとおりです。 infra "PREMIUM" "ENTERPRISE"
units	整数	割り当て制限ごとのライセンスユニットの数。
タグ	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}

パスパラメータ


パラメータ名	Parameter Type	値	必須
accountId	整数	割り当ての取得が要求されるアカウント ID。	あり
allocationId	文字列	取得する割り当てを参照する割り当て ID。	あり

例

curl --user <user>@<AccountName>:<password> -X DELETE \
http://<host>:<port>/controller/licensing/v1/account/{accountId}/allocation/{allocationId}

ライセンス情報 API

アカウントのライセンス情報（ライセンスタイプ、パッケージ、期限日など）をプログラムで取得するための RESTful API です。

アカウントライセンス情報の取得

アカウントのライセンス情報を取得します。

URL

http://<host>:<port>/controller/licensing/v1/account/{accountId}/info

形式

GET /controller/licensing/v1/account/{accountId}/info

パスパラメータ


パラメータ名	Parameter Type	値	必須
accountId	整数	割り当ての取得が要求されるアカウント ID。	あり

応答形式

response オブジェクト


パラメータ名	Parameter Type	値
accountId	整数	ライセンス情報が属するアカウント ID。
licenseId	文字列	SFDC ライセンス ID。
customerId	文字列	カスタマー ID。
customerName	文字列	カスタマー名。
環境	文字列	ライセンスが使用される予定の環境を表す列挙型： "DEV/TEST" PROD"
hardwareFingerprint	文字列	ライセンスが使用される予定のマシンのハードウェアフィンガープリント。現在、MAC アドレスのみがサポートされています。無制限の場合は `ANY` となります。
type	文字列	ライセンスの対象コンシューマを表す列挙型： "SAAS-CONTROLLER" "SAAS-ACCOUNT" "ONPREM-CONTROLLER" "ONPREM-ACCOUNT"
expiration-date	文字列	ライセンス全体の期限日：ISO 8601 日時文字列。
status	文字列	ライセンスステータスを表す列挙型： "ACTIVE"：期限切れではない paID ライセンス。すべてのユニットが支払い済みです。 "LIMITED"：期限切れはしていない Lite または Trial。少なくとも 1 つのユニットが LITE または TRIAL です。 "EXPIRED"：期限切れライセンス。
packages	オブジェクトの配列
プロパティ	オブジェクト	キー → 値の形式でライセンスに関連付けられたグローバルカスタムプロパティのコレクション。これらのプロパティは、すべてのパッケージで共有できます。
fallbackUnits	オブジェクト	アカウントレベルのフォールバックユニットの定義。エージェントタイプ（文字列）をフォールバックユニット（整数）にマッピングします。

package オブジェクト


パラメータ名	Parameter Type	値
packageName	文字列	次のパッケージ（エディション）インスタンスの名前を表す列挙型： infra "PREMIUM" "ENTERPRISE"
type	文字列	次のパッケージインスタンスのタイプを表す列挙型： "PAID" トライアル "LITE"
種類	文字列	パッケージの作成元のライセンスモデルから派生したパッケージの種類。レガシーエージェントベースのライセンスモジュール（APM、DOTNET など）に基づくパッケージを、新しいインフラストラクチャベースのパッケージと迅速に区別するのに役立ちます。列挙型："INFRASTRUCTURE_BASED"
ファミリ	文字列	パッケージファミリ。
"createdDate": "",	文字列	ライセンス内のパッケージインスタンスの作成日。ISO 8601 日時文字列。
startDate	文字列	パッケージインスタンスの開始日。例：パッケージインスタンスがアクティブになる日付：ISO 8601 日時文字列。
expiration-date	文字列	パッケージインスタンスの期限日、つまりパッケージインスタンスがアクティブでなくなる日付。ISO 8601 日時文字列。
licenseUnits	文字列	パッケージインスタンスで使用可能なライセンスの数。
プロパティ	オブジェクト	キーと値のペア形式でのパッケージ固有のカスタムプロパティのコレクション。グローバルプロパティとマージする場合は、競合するパッケージ固有のプロパティが優先されます。

例

リクエスト

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

このセクションでは、ライセンスルールの作成、更新、および削除や、ID、アクセスキー、および名前によるライセンスルールの取得などの、Splunk AppDynamics でモデル化されたライセンスルールに関する情報を取得するために使用できるライセンスルール API メソッドについて説明します。

警告: すべてのライセンスルール API に以下が適用されます。id：グローバルで一意な識別子の頭字語である GUID（または UUID）です。access_key：すべての licenseRules で一意である必要があります。name：すべての licenseRules で一意である必要があります。account_id：現在の account_id を確認するために GET api を使用します

ライセンスルールを新規作成する

URL

http://<host>:<port>/controller/mds/v1/license/rules

形式

 POST /controller/mds/v1/license/rules

入力パラメータ


パラメータ名	Parameter Type	値	必須
license_module_type	文字列	ライセンスモジュールのタイプを表す文字列。モジュールタイプ： NETVIZ MACHINE_AGENT SIM_MACHINE_AGENT APM APP_AGENT DOT_NET_AGENT	あり
id	文字列	ID または名前を表す文字列。	あり
バージョン	整数	バージョン番号を示します。	あり
number_of_licenses	整数	必要なライセンス数を示す整数。	あり
account_id	文字列	アカウント名またはアカウント ID を提供します。	あり
access_key	パス	アカウントアクセスキーを提供します。	あり

LicenseRule は、license_module_type、id、access_key、account_id、バージョン、および 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

形式

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 Type	値	必須
id	文字列	ID または名前を表す文字列。	あり
license_module_type	文字列	ライセンスモジュールのタイプを表す文字列。モジュールタイプ： NetViz マシンエージェント SIM マシンエージェント APM	あり
version	整数	バージョン番号を示します。	あり
number_of_licenses	整数	必要なライセンス数を示す整数。	あり
account_id	文字列	アカウント名またはアカウント ID を提供します。	あり
access_key	パス	アカウントアクセスキーを提供します。	あり

要求の例

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
}

注: ライセンスルールを更新するには、利用可能な GET メソッドのいずれかを使用してペイロードを取得します。アクセスキー、権限付与などを更新します。他のキーと値のペアは変更せずに PUT 要求を送信します。「version」は、GET 中のバージョンのままにする必要があります。これはインクリメントされます。

ライセンスルールを削除する

URL

http://<host>:<port>/controller/mds/v1/license/rules/f36e08e2-5f57-4b8c-9ad2-f18873adcd87

形式

DELETE /controller/mds/v1/license/rules/{id}

入力パラメータ


パラメータ名	Parameter Type	値	必須
LicenseRuleId	パス	ID によってライセンスルールを削除します。	あり

ID によるライセンスルールの取得

ライセンスルール ID によってライセンスルールを取得するには、これを使用します。

URL

http://<host>:<port>/mds/v1/license/rules/f36e08e2-5f57-4b8c-9ad2-f18873adcd87

形式

GET /mds/v1/license/rules/{licenseRuleId}

パスパラメータ


パラメータ名	Parameter Type	値	必須
`licenseRuleId`	パス	ライセンスルールの UUID を取得します。	あり

出力パラメータ


パラメータ名	Parameter Type	値	必須
id	文字列	ID または名前を表す文字列。	あり
version	整数	バージョン番号を示します。	あり
total_licenses	整数	ライセンスの合計数を示す整数。	あり
account_id	文字列	アカウント名またはアカウント ID を提供します。	あり
access_key	パス	アカウントアクセスキーを提供します。	あり

例

リクエスト

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
}

警告: 注：バージョンは UI または API からの更新のたびに更新されます。

アクセスキーごとにライセンスルールを取得する

URL

http://<host>:<port>/controller/mds/v1/license/rules/accessKey/account-accesskey-123

形式

GET /controller/mds/v1/license/rules/accessKey/{accessKey}

パスパラメータ


パラメータ名	Parameter Type	値	必須
access_key	パス	ライセンスルールに割り当てられているアクセスキーを取得します。	あり

出力パラメータ


パラメータ名	Parameter Type	値	必須
id	文字列	ID または名前を表す文字列。	あり
version	整数	バージョン番号を示します。	あり
total_licenses	整数	ライセンスの合計数を示す整数。	あり
account_id	文字列	アカウント名またはアカウント ID を提供します。	あり

例

リクエスト

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 Type	値	必須
name	パス	ライセンスルールの名前を取得します。	あり

出力パラメータ


パラメータ名	Parameter Type	値	必須
id	文字列	ID または名前を表す文字列。	あり
version	整数	バージョン番号を示します。	あり
total_licenses	整数	ライセンスの合計数を示す整数。	あり
account_id	文字列	アカウント名またはアカウント ID を提供します。	あり

例

リクエスト

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
}
]