dubhe-sdk-release

dubhe-sdk-release - JavaScript client for dubhe release service

• Package version: 1.0.27, generate by [email protected]
• Build date: 2024-03-21 10:58:29

For more information, please visit http://www.billion-byte.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dubhe-sdk-release --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your dubhe-sdk-release from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

Getting Started

Please follow the installation instruction and execute the following JS code:

import { DiscoveryControllerApi } from 'dubhe-sdk-release';

const api = new DiscoveryControllerApi(ApiContext.getInstance());
try {
  const {data} = await api.allApplication();
} catch(error) {
  console.error(error);
}

API Endpoints

All URIs are relative to http://139.3.24.189:28790/RELEASE

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DiscoveryControllerApi | allApplication | GET /rest/release/discovery/allApplication | allApplication DiscoveryControllerApi | discoveryService | GET /rest/release/discovery/discoveryService/{serviceName} | discoveryService MockCacheControllerApi | doMockCache | GET /rest/release/mockCache/doMockCache | doMockCache PingControllerApi | systemPing | GET /open/release/ping/ping/ping | systemPing RecExportDataControllerApi | disableRecExportData | PUT /rest/release/recExportData/disable | 禁用导出数据 RecExportDataControllerApi | enableRecExportData | PUT /rest/release/recExportData/enable | 启用导出数据 RecExportDataControllerApi | fetchRecExportDataList | GET /rest/release/recExportData/list | 获取导出数据列表 RecExportDataControllerApi | recordDownload | POST /rest/release/recExportData/record | 记录下载次数 RecExportDataControllerApi | saveRecExportData | POST /rest/release/recExportData/save | 保存导出数据 RecExportDataControllerApi | updateRecExportData | PATCH /rest/release/recExportData/update | 更新导出数据 RecSyncDataControllerApi | fetchRecSyncDataList | GET /rest/release/recSyncData/list | 获取数据同步表列表 RecSyncDataControllerApi | fileCheck | POST /rest/release/recSyncData/fileCheck | 文件验证 ServiceOfflineControllerApi | fireOffline | DELETE /rest/release/serviceOffline/fireOffline | fireOffline SystemCacheControllerApi | systemCacheClearAll | POST /rest/release/systemCache/clearAll | 清理L2CACHE全部缓存 SystemCacheControllerApi | systemCacheClearMulti | POST /rest/release/systemCache/clearMulti | 清理L2CACHE缓存 SystemCacheControllerApi | systemCacheList | GET /rest/release/systemCache/list | list

Models

• CacheStatsWraper
• RecExportData
• RecSyncData