Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Comment: Published by Scroll Versions from this space and version 20.8-next
    Sv translation
    languageen
    Appd tocbox
    Width325px

    Related pages:

    This page describes the License Rules API methods you can use to retrieve information about the license rules as modeled in AppDynamics such as creating, updating and deleting license rules, and also retrieving license rules by its id, access key, and name.

    Note

    The following are true for all Licence Rule APIs:

    • id—is GUID (or UUID) which is an acronym for Globally Unique Identifier. 
    • access_key—must be unique across all licenseRules.
    • name—must be unique across all licenseRules.
    • account_id—Use GET API to know your current account_id.

    Creates a New License Rule   

    URL

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

    Format

    POST /mds/v1/license/rules 

      

    Input parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    license_module_type

    String

    String representing the type of the license module.

    Module types are:

    • NETVIZ
    • MACHINE_AGENT
    • SIM_MACHINE_AGENT
    • APM
    • APP_AGENT
    • DOT_NET_AGENT
    Yes

    id

    StringString representing the id or name.Yes

    version

    IntegerIndicates the version number.Yes

    number_of_licenses

    IntegerInteger indicating the required number of licenses.Yes

    account_id

    StringProvides the account name or account id.Yes

    access_key

    PathProvides the account access key.Yes


    LicenseRule is comprised of license_module_type, id, access_key, account_id, version, and number_of_licenses.

    Example

    Tabs Container
    directionhorizontal
    Tabs Page
    titleRequest
    No Format
    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
    }
    Tabs Page
    titleResponse
    No Format
    {  
       "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
    }
    Note

    The version must be 0 when creating.


    Returns a Summary of All the License Rules for the Current Account

    Use this to retrieve a summary of the license rules. The data transfer objects (DTOs) returned will not contain any constraints, match conditions, or entitlements.

    URL

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

    Format

    GET /mds/v1/license/rules

    Example

    No Format
    [
    {
    "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
    }
    ]

    Updates a License Rule

    URL

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

    Format

    PUT /mds/v1/license/rules

    Input parameters

    Parameter Name

    Parameter Type

    Value

    Mandatory

    id
    StringString representing the id or name.Yes
    license_module_type
    String

    String representing the type of the license module.

    Module types are:

    • NetViz
    • Machine Agent
    • SIM Machine Agent
    • APM
    Yes
    version
    IntegerIndicates the version number.Yes
    number_of_licenses
    IntegerInteger indicating the required number of licenses.Yes
    account_id
    StringProvides the account name or account id.Yes
    access_key
    PathProvides the account access key.Yes

    Example Request

    No Format
    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
    }
    Info

    To update the license rules:

    1. Get the payload using any of the available GET methods.

    2. Update accessKeys, entitlements, etc.

    3. Send the PUT request without changing other key-value pairs.

    4. "version" should be kept as it was during GET. This would be incremental.

    Deletes a License Rule

    URL

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

    Format

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

    Input parameter

    Parameter Name

    Parameter Type

    Value

    Mandatory

    LicenseRuleId

    Path

    Deletes license rule by its id.

    Yes

    Retrieve a License Rule via its Id

    Use this to retrieve a license rule by the license rule id.

    URL

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

    Format

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

    Input parameter

    Parameter Name

    Parameter Type

    Value

    Mandatory

    licenseRuleIdPathRetrieves the UUID of the license rule.Yes

    Output Parameters

    Parameter NameParameter TypeValueMandatory
    id
    StringString representing the id or name.Yes
    version
    IntegerIndicates the version number.Yes
    total_licenses
    IntegerInteger indicating the total number of licenses.Yes
    account_id
    StringProvides the account name or account id.Yes
    access_key
    pathProvides the account access key.Yes


    Example

    Tabs Container
    directionhorizontal
    Tabs Page
    titleRequest
    No Format
    curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules/091116a4-124c-4b73-9343-f315836f103b
    Tabs Page
    titleResponse
    No Format
    {
        "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
    }
    Note

    The "version" gets updated after every update from UI or API.


    Retrieves a License Rule by Access Key

    URL

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

    Format 

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

    Input parameter

    Parameter Name

    Parameter Type

    Value

    Mandatory

    access_key

    Path

    Retrieves the access key assigned to the license rule.

    Yes

    Output Parameters

    Parameter NameParameter TypeValueMandatory
    id
    StringString representing the id or name.Yes
    version
    IntegerIndicates the version number.Yes
    total_licenses
    IntegerInteger indicating the total number of licenses.Yes
    account_id
    StringProvides the account name or account id.Yes


    Example

    Tabs Container
    directionhorizontal
    Tabs Page
    titleRequest
    No Format
    curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules
    Tabs Page
    titleResponse
    No Format
    [
        {
            "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
        }
    ]
     


    Retrieve a License Rule by Name

    URL

    http://<host>:<port>/mds/v1/license/rules/name/Default

    Format 

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

    Input parameter

    Parameter Name

    Parameter Type

    Value

    Mandatory

    name

    Path

    Retrieves the name of the license rule.

    Yes

    Output Parameters

    Parameter NameParameter TypeValueMandatory
    id
    StringString representing the id or name.Yes
    version
    IntegerIndicates the version number.Yes
    total_licenses
    IntegerInteger indicating the total number of licenses.Yes
    account_id
    StringProvides the account name or account id.Yes


    Example

    Tabs Container
    directionhorizontal
    Tabs Page
    titleRequest
    No Format
    curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules
    Tabs Page
    titleResponse
    No Format
     [
        {
            "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
        }
    ]




    Sv translation
    languageja
    Appd tocbox
    Width325px

    On this page

    Table of Contents
    maxLevel2

    Related Links

    ライセンスルール API を使用すると、AppDynamics でモデル化されているライセンスルールに関する情報を取得できます。たとえば、この情報には、ライセンスルールの作成、更新、および削除、さらに、ID、アクセスキー、および名前によるライセンスルールの取得が含まれます。

    ライセンスルールの新規作成

    URL

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

    形式

    POST /mds/v1/license/rules

      

    Input parameters

    Parameter Name

    Parameter Type

    Value

    必須

    license_module_type
    文字列

    ライセンスモジュールのタイプを表す文字列。

    モジュールタイプ:

    • NETVIZ
    • MACHINE_AGENT
    • SIM_MACHINE_AGENT
    • APM
    • APP_AGENT
    • DOT_NET_AGENT
    [はい(Yes)]に設定
    id
    文字列ID または名前を表す文字列。[はい(Yes)]に設定
    version
    整数型(Integer)バージョン番号を示します。[はい(Yes)]に設定
    number_of_licenses
    整数型(Integer)必要なライセンス数を示す整数。[はい(Yes)]に設定
    account_id
    文字列アカウント名またはアカウント ID を提供します。[はい(Yes)]に設定
    access_key
    [パス(Path)]アカウントアクセスキーを提供します。[はい(Yes)]に設定

     

    LicenseRule は、license_module_type、id、access_key、account_id、バージョン、および number_of_licenses からなります。

    要求の例

    No Format
    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
    }

    応答の例

    Code Block
    {  
       "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
    }
    Info

    注:作成時のバージョンは 0 にする必要があります。

    現在のアカウントのすべてのライセンスルールの概要を返します。

    返されるライセンスルール DTO にはサマリーのみが含まれ、制約、一致条件、または権限は含まれません。

    URL

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

    形式

    GET /mds/v1/license/rules

    No Format
    [
    {
    "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>/mds/v1/license/rules

    形式

    PUT/mds/v1/license/rules

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    id
    文字列ID または名前を表す文字列。[はい(Yes)]に設定
    license_module_type
    文字列

    ライセンスモジュールのタイプを表す文字列。

    モジュールタイプ:

    • NetViz
    • マシンエージェント
    • SIM マシンエージェント
    • APM
    [はい(Yes)]に設定
    version
    整数型(Integer)バージョン番号を示します。[はい(Yes)]に設定
    number_of_licenses
    整数型(Integer)必要なライセンス数を示す整数。[はい(Yes)]に設定
    account_id
    文字列アカウント名またはアカウント ID を提供します。[はい(Yes)]に設定
    access_key
    [パス(Path)]アカウントアクセスキーを提供します。[はい(Yes)]に設定

    要求の例

    No Format
    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
    }
    Info

    注:ライセンスルールを更新するには、次の手順に従います。

    1. 使用可能な GET メソッドのいずれかを使用してペイロードを取得します。

    2. アクセスキー/権限付与などを更新します。

    3. 他のキーと値のペアを変更せずに PUT 要求を送信します。

    4. 「バージョン」は取得中のものとして保持する必要があります。これはインクリメントされます。

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

    URL

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

    形式

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

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    LicenseRuleId

    パス

    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 NameParameter TypeValueMandatory
    id
    文字列ID または名前を表す文字列。[はい(Yes)]に設定
    version
    整数型(Integer)バージョン番号を示します。[はい(Yes)]に設定
    total_licenses
    整数型(Integer)ライセンスの合計数を示す整数。[はい(Yes)]に設定
    account_id
    文字列アカウント名またはアカウント ID を提供します。[はい(Yes)]に設定
    access_key
    pathアカウントアクセスキーを提供します。[はい(Yes)]に設定

     

    要求の例

    No Format
    curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules/091116a4-124c-4b73-9343-f315836f103b

    応答の例

    Code Block
    {
        "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
    }
    Info

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

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

    URL

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

    形式

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

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    access_key

    パス

    ライセンスルールに割り当てられているアクセスキーを取得します。

    あり

    出力パラメータ

    Parameter NameParameter TypeValueMandatory
    id
    文字列ID または名前を表す文字列。[はい(Yes)]に設定
    version
    整数型(Integer)バージョン番号を示します。[はい(Yes)]に設定
    total_licenses
    整数型(Integer)ライセンスの合計数を示す整数。[はい(Yes)]に設定
    account_id
    文字列アカウント名またはアカウント ID を提供します。[はい(Yes)]に設定

     

    要求の例

    No Format
    curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules

    応答の例

    Code Block
    [
        {
            "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>/mds/v1/license/rules/name/Default

    形式

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

    入力パラメータ

    Parameter Name

    Parameter Type

    Value

    必須

    name

    パス

    ライセンスルールの名前を取得します。

    あり

    出力パラメータ

    Parameter NameParameter TypeValueMandatory
    id
    文字列ID または名前を表す文字列。[はい(Yes)]に設定
    version
    整数型(Integer)バージョン番号を示します。[はい(Yes)]に設定
    total_licenses
    整数型(Integer)ライセンスの合計数を示す整数。[はい(Yes)]に設定
    account_id
    文字列アカウント名またはアカウント ID を提供します。[はい(Yes)]に設定


    要求の例

    No Format
    curl -X GET --user <user>@<AccountName>:<password> http://<host>:<port>/controller/mds/v1/license/rules

    応答の例

    Code Block
    [
        {
            "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
        }
    ]
    Info

    すべての API の注意事項:

    • id:これはグローバルで一意な識別子の略語である GUID(または UUID)です。 
    • access_key:すべての licenseRules で一意である必要があります。
    • name:すべての licenseRules で一意である必要があります。
    • account_id:現在の account_id を確認するために GET api を使用します