Skip to content

Latest commit

 

History

History
698 lines (534 loc) · 22 KB

ConfigTemplateApi.md

File metadata and controls

698 lines (534 loc) · 22 KB

ConfigTemplateApi

All URIs are relative to https://api.lucfish.com/configuration/v1

Method HTTP request Description
configTemplateBatchDeletePost POST /configTemplate/batchDelete 批量删除配置模版
configTemplateBatchRetrieveByGroupPost POST /configTemplate/batchRetrieveByGroup 查询配置模版
configTemplateBatchRetrieveByKeysPost POST /configTemplate/batchRetrieveByKeys 查询配置模版
configTemplateBatchRetrievePost POST /configTemplate/batchRetrieve 批量查询配置模版
configTemplateCursorPost POST /configTemplate/cursor Cursor查询配置模版
configTemplateIdDelete DELETE /configTemplate/{id} 删除配置模版
configTemplateIdGet GET /configTemplate/{id} 查询配置模版
configTemplatePagePost POST /configTemplate/page Page查询配置模版
configTemplatePost POST /configTemplate 创建配置模版
configTemplateRetrieveByKeyPost POST /configTemplate/retrieveByKey 查询配置模版

configTemplateBatchDeletePost

DeleteRsp configTemplateBatchDeletePost(idsReq)

批量删除配置模版

批量删除配置模版通过配置Id

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    IdsReq idsReq = new IdsReq(); // IdsReq | 
    try {
      DeleteRsp result = apiInstance.configTemplateBatchDeletePost(idsReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateBatchDeletePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
idsReq IdsReq [optional]

Return type

DeleteRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateBatchRetrieveByGroupPost

BatchRetrieveConfigTemplatesByGroupRsp configTemplateBatchRetrieveByGroupPost(groupName)

查询配置模版

查询配置模版通过配置模版GroupID

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    String groupName = "groupName_example"; // String | 分组标签名
    try {
      BatchRetrieveConfigTemplatesByGroupRsp result = apiInstance.configTemplateBatchRetrieveByGroupPost(groupName);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateBatchRetrieveByGroupPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
groupName String 分组标签名

Return type

BatchRetrieveConfigTemplatesByGroupRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateBatchRetrieveByKeysPost

BatchRetrieveConfigTemplatesByKeysRsp configTemplateBatchRetrieveByKeysPost(batchRetrieveConfigTemplateByKeysReq)

查询配置模版

查询配置通过配置Keys

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    BatchRetrieveConfigTemplateByKeysReq batchRetrieveConfigTemplateByKeysReq = new BatchRetrieveConfigTemplateByKeysReq(); // BatchRetrieveConfigTemplateByKeysReq | 
    try {
      BatchRetrieveConfigTemplatesByKeysRsp result = apiInstance.configTemplateBatchRetrieveByKeysPost(batchRetrieveConfigTemplateByKeysReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateBatchRetrieveByKeysPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
batchRetrieveConfigTemplateByKeysReq BatchRetrieveConfigTemplateByKeysReq [optional]

Return type

BatchRetrieveConfigTemplatesByKeysRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateBatchRetrievePost

BatchRetrieveConfigTemplatesRsp configTemplateBatchRetrievePost(idsReq)

批量查询配置模版

批量查询配置模版通过配置Id

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    IdsReq idsReq = new IdsReq(); // IdsReq | 
    try {
      BatchRetrieveConfigTemplatesRsp result = apiInstance.configTemplateBatchRetrievePost(idsReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateBatchRetrievePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
idsReq IdsReq [optional]

Return type

BatchRetrieveConfigTemplatesRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateCursorPost

CursorConfigTemplatesRsp configTemplateCursorPost(cursorQuery)

Cursor查询配置模版

Cursor查询配置模版

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    CursorQuery cursorQuery = new CursorQuery(); // CursorQuery | 
    try {
      CursorConfigTemplatesRsp result = apiInstance.configTemplateCursorPost(cursorQuery);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateCursorPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
cursorQuery CursorQuery [optional]

Return type

CursorConfigTemplatesRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateIdDelete

DeleteRsp configTemplateIdDelete(id)

删除配置模版

删除配置模版

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    String id = "id_example"; // String | 删除配置模版
    try {
      DeleteRsp result = apiInstance.configTemplateIdDelete(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateIdDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id String 删除配置模版

Return type

DeleteRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateIdGet

GetConfigTemplateRsp configTemplateIdGet(id)

查询配置模版

查询配置通过配置模版ID

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    String id = "id_example"; // String | 查询配置通过配置ID
    try {
      GetConfigTemplateRsp result = apiInstance.configTemplateIdGet(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id String 查询配置通过配置ID

Return type

GetConfigTemplateRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplatePagePost

PageConfigTemplatesRsp configTemplatePagePost(pageQuery)

Page查询配置模版

Page查询配置模版

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    PageQuery pageQuery = new PageQuery(); // PageQuery | 
    try {
      PageConfigTemplatesRsp result = apiInstance.configTemplatePagePost(pageQuery);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplatePagePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
pageQuery PageQuery [optional]

Return type

PageConfigTemplatesRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplatePost

CreateConfigTemplateRsp configTemplatePost(createConfigTemplateReq)

创建配置模版

创建配置模版

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    CreateConfigTemplateReq createConfigTemplateReq = new CreateConfigTemplateReq(); // CreateConfigTemplateReq | 
    try {
      CreateConfigTemplateRsp result = apiInstance.configTemplatePost(createConfigTemplateReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplatePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
createConfigTemplateReq CreateConfigTemplateReq [optional]

Return type

CreateConfigTemplateRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -

configTemplateRetrieveByKeyPost

RetrieveConfigTemplateByKeyRsp configTemplateRetrieveByKeyPost(key)

查询配置模版

查询配置模版通过配置Key

Example

// Import classes:
import com.xopenapi.ApiClient;
import com.xopenapi.ApiException;
import com.xopenapi.Configuration;
import com.xopenapi.auth.*;
import com.xopenapi.models.*;
import com.xopenapi.config.ConfigTemplateApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.lucfish.com/configuration/v1");
    
    // Configure HTTP bearer authorization: ApiKey
    HttpBearerAuth ApiKey = (HttpBearerAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setBearerToken("BEARER TOKEN");

    ConfigTemplateApi apiInstance = new ConfigTemplateApi(defaultClient);
    String key = "key_example"; // String | 主键Key
    try {
      RetrieveConfigTemplateByKeyRsp result = apiInstance.configTemplateRetrieveByKeyPost(key);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigTemplateApi#configTemplateRetrieveByKeyPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
key String 主键Key

Return type

RetrieveConfigTemplateByKeyRsp

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
405 Invalid input -