Blusam 應用程式主控台 REST 端點 - AWS 大型主機現代化
資料集相關端點大量資料集相關端點記錄遮罩其他BAC 使用者管理端點

AWS Mainframe Modernization Service （受管執行期環境體驗） 不再向新客戶開放。對於與 AWS Mainframe Modernization Service （受管執行期環境體驗） 類似的功能，探索 AWS Mainframe Modernization Service （自我管理體驗）。現有客戶可以繼續正常使用該服務。如需詳細資訊，請參閱AWS 大型主機現代化可用性變更。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

Blusam 應用程式主控台 REST 端點

在本節中，您可以了解Blusam應用程式主控台，這是專為簡化現代化 VSAM 資料集管理而設計的 API。Blusam Web 應用程式的端點使用根路徑 /bac。

資料集相關端點

使用下列端點來建立或管理特定資料集。

建立資料集

您可以使用此端點來建立資料集定義。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/createDataSet

  • 引數：

    name

    （必要，字串）：資料集的名稱。

    type

    （必要，字串）：資料集類型。可能的值為：ESDS、KSDS、RRDS。

    recordSize

    （選用，字串）：資料集每個記錄的大小上限。

    fixedLength

    （選用，布林值） ：指出記錄長度是否固定。

    compression

    （選用，布林值） ：指出資料集是否已壓縮。

    cacheEnable

    （選用，布林值） ：指出是否已為資料集啟用快取。

    alternativeKeys

    （選用，金鑰清單）：

    • 位移 （必要，數字）

    • length （必要，數字）

    • name （必要，數字）

  • 傳回代表新建立資料集的 JSON 檔案。

請求範例：

POST /api/services/rest/bluesamservice/createDataSet
{
  "name": "DATASET",
  "checked": false,
  "records": [],
  "primaryKey": {
    "name": "PK"
  },
  "alternativeKeys": [
    {
      "offset": 10,
      "length": 10,
      "name": "ALTK_0"
    }
  ],
  "type": "ESDS",
  "recordSize": 10,
  "compression": true,
  "cacheEnable": true
}

回應範例：

{
    "dataSet": {
      "name": "DATASET",
      "checked": false,
      "nbRecords": 0,
      "keyLength": -1,
      "recordSize": 10,
      "compression": false,
      "fixLength": true,
      "type": "ESDS",
      "cacheEnable": false,
      "cacheWarmup": false,
      "cacheEviction": "100ms",
      "creationDate": 1686744961234,
      "modificationDate": 1686744961234,
      "records": [],
      "primaryKey": {
        "name": "PK",
        "offset": null,
        "length": null,
        "columns": null,
        "unique": true
      },
      "alternativeKeys": [
        {
          "offset": 10,
          "length": 10,
          "name": "ALTK_0"
        }
      ],
      "readLimit": 0,
      "readEncoding": null,
      "initCharacter": null,
      "defaultCharacter": null,
      "blankCharacter": null,
      "strictZoned": null,
      "decimalSeparator": null,
      "currencySign": null,
      "pictureCurrencySign": null
    },
    "message": null,
    "result": true
  }

上傳檔案

您可以使用此端點將檔案上傳至伺服器。檔案會存放在對應至每個特定使用者的暫時資料夾中。每次您需要上傳檔案時，都使用此端點。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/upload

  • 引數：

    file

    （必要，分段/表單資料）：要上傳的檔案。

  • 傳回反映上傳狀態的布林值

載入資料集 (POST)

使用 createDataSet建立資料集定義後，您可以將與上傳檔案相關聯的記錄載入至特定資料集。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/loadDataSet

  • 引數：

    name

    （必要，字串）：資料集的名稱。

  • 傳回請求的狀態和載入的資料集。

載入資料集 (GET)

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/loadDataSet

  • 引數：

    name

    （必要，字串）：資料集的名稱。

    資料集檔案

    （必要，字串）：資料集檔案名稱。

  • 傳回請求的狀態和載入的資料集。

從 Amazon S3 儲存貯體載入資料集

使用 listcat 檔案從 Amazon S3 儲存貯體載入資料集。

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/loadDataSetFromS3

  • 引數：

    listcatFileS3Location

    （必要，字串）：Listcat 檔案的 Amazon S3 位置。

    datasetFileS3Location

    （必要，字串）：資料集檔案的 Amazon S3 位置。

    region

    （必要，字串）：存放檔案的 Amazon S3 AWS 區域 。

  • 傳回新建立的資料集

請求範例：

/BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT

將資料集匯出至 Amazon S3 儲存貯體

將資料集匯出至指定的 Amazon S3 儲存貯體。

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/exportDataSetToS3

  • 引數：

    s3Location

    （必要，字串）：匯出資料集的 Amazon S3 位置。

    datasetName

    （必要，字串）：要匯出的資料集名稱。

    region

    （必要，字串）：Amazon S3 儲存貯體 AWS 區域 的 。

    kmsKeyId

    （選用，字串）：用於將匯出資料集加密至 Amazon S3 儲存貯體的 AWS KMS ID。

  • 傳回匯出的資料集

請求範例：

/BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset

清除資料集

清除資料集中的所有記錄。

  • 支援的方法：POST、GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/clearDataSet

  • 引數：

    name

    （必要，字串）：要清除的資料集名稱。

  • 傳回請求的狀態。

刪除資料集

刪除資料集定義和記錄。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/deleteDataSet

  • 引數：

    name

    （必要，字串）：要刪除的資料集名稱。

  • 傳回請求的狀態和已刪除的資料集。

計數資料集記錄

此端點會傳回與資料集相關聯的記錄數目。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/countRecords

  • 引數：

    name

    （必要，字串）：資料集的名稱。

  • 傳回：記錄的數量

大量資料集相關端點

使用下列端點一次建立或管理多個資料集。

匯出資料集 (GET)

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/exportDataSet

  • 引數：

    datasetName

    （必要，字串）：要匯出的資料集名稱。

    datasetOutputFile

    （必要，字串）：您要在伺服器上存放匯出資料集的資料夾路徑。

    rdw

    （必要，布林值）：您是否希望記錄描述項字詞 (RDW) 成為匯出記錄的一部分。如果資料集具有固定長度的記錄，則會忽略此參數的值。

  • 傳回請求的狀態，以及包含匯出資料集之檔案的路徑 （如果有的話）。如果回應中的資料集為 null，表示系統找不到具有指定名稱的資料集。

匯出資料集 (POST)

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/exportDataSet

  • 引數：

    dumpParameters

    （必要，BACReadParameters)：Bluesam 讀取參數。

  • 傳回匯出資料集的狀態。

建立多個資料集

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/createAllDataSets

  • 引數：

    • 資料集清單

      name

      （必要，字串）：資料集的名稱。

      type

      （必要，字串）：資料集類型。可能的值為：ESDS、KSDS、RRDS。

      recordSize

      （選用，字串）：資料集每個記錄的大小上限。

      fixedLength

      （選用，布林值） ：指出記錄長度是否固定。

      compression

      （選用，布林值） ：指出資料集是否已壓縮。

      cacheEnable

      （選用，布林值） ：指出是否已為資料集啟用快取。

  • 傳回：請求的狀態和新建立的資料集。

列出所有資料集

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/listDataSet

  • 引數：無

  • 傳回：請求的狀態和資料集的清單。

直接列出所有資料集

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/directListDataSet

  • 引數：無

  • 傳回：請求的狀態和資料集的清單。

依頁面直接列出所有資料集

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/directListDataSetByPage

  • 引數：

    datasetName

    （必要，字串）：資料集的名稱。

    pageNumber

    （必要，整數）：頁碼。

    pageSize

    （必要，整數）：頁面大小。

  • 傳回：請求的狀態和資料集的清單。

串流資料集

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/streamDataset

  • 引數：

    datasetName

    （必要，字串）：資料集的名稱。

  • 傳回：請求的資料集串流。

刪除所有資料集

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/removeAll

  • 引數：無

  • 傳回：代表請求狀態的布林值。

從 listcat 檔案取得資料集定義

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat

  • 引數：

    paramFilePath

    （必要，字串）：Listcat 檔案的路徑。

  • 傳回：資料集清單

從上傳的清單目錄檔案取得資料集定義

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat

  • 引數：無

  • 傳回：資料集清單

取得資料集

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/getDataSet

  • 引數：

    name

    （必要，字串）：資料集的名稱。

  • 傳回請求的資料集。

從 JSON 檔案載入 listcat

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/loadListcatFromJsonFile

  • 引數：

    filePath

    （必要，字串）：Listcat 檔案的路徑。

  • 傳回：資料集清單

記錄

使用下列端點來建立或管理資料集內的記錄。

建立記錄

您可以使用此端點來建立新的記錄。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/createRecord

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    遮罩

    （必要，遮罩）：遮罩物件。

  • 傳回請求的狀態和建立的記錄。

讀取資料集

您可以使用此端點來讀取資料集。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/readDataSet

  • 引數：

    dataset

    （必要，DataSet)：資料集物件。

  • 傳回請求的狀態，以及包含記錄的資料集。

刪除記錄

您可以使用此端點從資料集刪除記錄。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/deleteRecord

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    record

    （必要，記錄）：要刪除的記錄

  • 傳回刪除的狀態。

更新記錄

您可以使用此端點來更新與資料集相關聯的記錄。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/updateRecord

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    record

    （必要，記錄）：要更新的記錄

  • 傳回請求的狀態，以及包含記錄的資料集。

儲存記錄

您可以使用此端點將記錄儲存到資料集並使用遮罩。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/saveRecord

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    record

    （必要，記錄）：要儲存的記錄

  • 傳回請求的狀態，以及包含記錄的資料集。

驗證記錄

使用此端點來驗證記錄。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/validateRecord

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

  • 傳回請求的狀態，以及包含記錄的資料集。

取得記錄樹狀目錄

使用此端點來取得記錄的階層樹狀目錄。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/getRecordTree

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    record

    （必要，記錄）：要擷取的記錄

  • 傳回請求的狀態和請求記錄的階層樹狀結構。

遮罩

使用下列端點將遮罩載入或套用至資料集。

載入遮罩

您可以使用此端點來擷取與特定資料集相關聯的所有遮罩。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/loadMasks

  • 路徑變數：

    recordSize：.../loadMasks/{recordSize}

    （選用，數值）：記錄大小，篩選符合此記錄大小的已載入遮罩

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

  • 傳回請求的狀態和遮罩清單。

套用遮罩

您可以使用此端點將遮罩套用至特定資料集。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/applyMask

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    遮罩

    （必要，遮罩）：資料集物件

  • 傳回請求的狀態，以及已套用遮罩的資料集。

套用遮罩篩選條件

您可以使用此端點，將遮罩和篩選條件套用至特定資料集。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/crud/applyMaskFilter

  • 引數：

    dataset

    （必要，DataSet)：資料集物件

    遮罩

    （必要，遮罩）：資料集物件

  • 傳回請求的狀態，以及具有套用遮罩和篩選條件的資料集。

其他

使用下列端點來管理資料集的快取或檢查資料集特性

檢查暖機快取

檢查是否已針對特定資料集啟用暖機快取。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/warmupCache

  • 引數：

    name

    （必要，字串）：資料集的名稱。

  • 如果啟用了暖機快取，則傳回： true，否則傳回 false。

檢查快取已啟用

檢查是否針對特定資料集啟用快取。

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/isEnableCache

  • 引數：無

  • 如果啟用快取，則傳回 true。

啟用快取

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 和 ROLE_SUPER_ADMIN 角色。

  • 路徑： /api/services/rest/bluesamservice/enableDisableCache/{enable}

  • 引數：

    啟用

    （必要，布林值）：如果設定為 true，則會啟用快取。

  • 傳回無

檢查配置的 RAM 快取

您可以使用此端點來擷取配置的 RAM 快取記憶體。

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/allocatedRamCache

  • 引數：無

  • 傳回：做為字串的記憶體大小

檢查持久性

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_USER 角色。

  • 路徑： /api/services/rest/bluesamservice/persistence

  • 引數：無

  • 傳回：用作字串的持久性

檢查支援的資料集類型

  • 支援的方法：GET

  • 路徑： /api/services/rest/bluesamservice/getDataSetTypes

  • 需要身分驗證和 ROLE_USER 角色。

  • 引數：無

  • 傳回：支援的資料集類型清單做為字串清單。

檢查伺服器運作狀態

  • 支援的方法：GET

  • 路徑： /api/services/rest/bluesamserver/serverIsUp

  • 引數：無

  • 傳回：無。HTTP 回應狀態碼 200 表示伺服器已啟動並執行。

BAC 使用者管理端點

使用下列端點來管理使用者互動。

在 中記錄使用者

  • 支援的方法：POST

  • 路徑： /api/services/security/servicelogin/login

  • 引數：無

  • 傳回com.netfective.bluage.bac.entities.SignOn物件的 JSON 序列化，代表目前請求中提供其登入資料的使用者。密碼會從傳回物件的檢視中隱藏。正在列出提供給使用 的角色。

回應範例：

{
     "login": "some-admin",
     "password": null,
     "roles": [
       {
         "id": 0,
         "roleName": "ROLE_ADMIN"
       }
     ]
   }

驗證系統中是否至少有一個使用者

  • 支援的方法：GET

  • 路徑： /api/services/security/servicelogin/hasAccount

  • 引數：無

  • true 如果已建立預設超級管理員使用者以外的至少一個使用者，則傳回布林值。false 否則傳回 。

記錄新使用者

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/security/servicelogin/recorduser

  • 引數：代表要新增至儲存體之使用者之com.netfective.bluage.bac.entities.SignOn物件的 JSON 序列化。必須定義使用者的角色，否則使用者可能無法使用 BAC 設施和端點。

  • true 如果使用者已成功建立，則傳回布林值。false 否則傳回 。

  • 請求 JSON 範例：

    
 {
     "login": "simpleuser",
     "password": "simplepassword",
     "roles": [
       {
         "id": 2,
         "roleName": "ROLE_USER"
       }
     ]
   }

    以下是 的兩個有效值roleName：

    • ROLE_ADMIN： 可以管理Blusam資源和使用者。

    • ROLE_USER： 可以管理Blusam資源，但無法管理使用者。

取得使用者資訊

  • 支援的方法：GET

  • 路徑： /api/services/security/servicelogin/userInfo

  • 引數：無

  • 傳回目前連線使用者的使用者名稱和角色

列出使用者

  • 支援的方法：GET

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/security/servicelogin/listusers

  • 引數：無

  • 傳回com.netfective.bluage.bac.entities.SignOn序列化為 JSON 的 清單。

刪除使用者

重要

這個操作無法復原。刪除的使用者將無法再次連線至 BAC 應用程式。

  • 支援的方法：POST

  • 需要身分驗證和 ROLE_ADMIN 角色。

  • 路徑： /api/services/security/servicelogin/deleteuser

  • 引數：代表要從儲存體中移除之使用者的com.netfective.bluage.bac.entities.SignOn物件 JSON 序列化。

  • true 如果使用者已成功移除，則傳回布林值。

登出目前的使用者

  • 支援的方法：GET

  • 路徑： /api/services/security/servicelogout/logout

  • 引數：無

  • {"success":true} 如果目前使用者已成功登出，則傳回 JSON 訊息。相關的 HTTP 工作階段將會失效。