ConfigApi

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

Method	HTTP request	Description
configBatchDeletePost	POST /config/batchDelete	批量删除配置
configBatchRetrieveByKeysPost	POST /config/batchRetrieveByKeys	查询配置
configBatchRetrieveByResourcesPost	POST /config/batchRetrieveByResources	查询配置
configBatchRetrievePost	POST /config/batchRetrieve	批量查询配置
configCursorPost	POST /config/cursor	Cursor查询配置
configIdDelete	DELETE /config/{id}	删除配置
configIdGet	GET /config/{id}	查询配置
configPagePost	POST /config/page	Page查询配置
configPost	POST /config	创建配置
configPut	PUT /config	更新配置
configRetrieveByKeyPost	POST /config/retrieveByKey	查询配置
configTemplatePut	PUT /configTemplate	更新配置模版

configBatchDeletePost

DeleteRsp configBatchDeletePost(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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    IdsReq idsReq = new IdsReq(); // IdsReq | 
    try {
      DeleteRsp result = apiInstance.configBatchDeletePost(idsReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configBatchDeletePost");
      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	-

configBatchRetrieveByKeysPost

BatchRetrieveConfigsByKeysRsp configBatchRetrieveByKeysPost(batchRetrieveByKeysReq)

查询配置

查询配置通过配置Keys和资源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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    BatchRetrieveByKeysReq batchRetrieveByKeysReq = new BatchRetrieveByKeysReq(); // BatchRetrieveByKeysReq | 
    try {
      BatchRetrieveConfigsByKeysRsp result = apiInstance.configBatchRetrieveByKeysPost(batchRetrieveByKeysReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configBatchRetrieveByKeysPost");
      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
batchRetrieveByKeysReq	BatchRetrieveByKeysReq		[optional]

Return type

BatchRetrieveConfigsByKeysRsp

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	-

configBatchRetrieveByResourcesPost

BatchRetrieveConfigsByResourcesRsp configBatchRetrieveByResourcesPost(batchRetrieveByResourcesReq)

查询配置

查询配置通过配置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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    BatchRetrieveByResourcesReq batchRetrieveByResourcesReq = new BatchRetrieveByResourcesReq(); // BatchRetrieveByResourcesReq | 
    try {
      BatchRetrieveConfigsByResourcesRsp result = apiInstance.configBatchRetrieveByResourcesPost(batchRetrieveByResourcesReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configBatchRetrieveByResourcesPost");
      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
batchRetrieveByResourcesReq	BatchRetrieveByResourcesReq		[optional]

Return type

BatchRetrieveConfigsByResourcesRsp

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	-

configBatchRetrievePost

BatchRetrieveConfigsRsp configBatchRetrievePost(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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    IdsReq idsReq = new IdsReq(); // IdsReq | 
    try {
      BatchRetrieveConfigsRsp result = apiInstance.configBatchRetrievePost(idsReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configBatchRetrievePost");
      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

BatchRetrieveConfigsRsp

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	-

configCursorPost

CursorConfigsRsp configCursorPost(cursorQuery)

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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    CursorQuery cursorQuery = new CursorQuery(); // CursorQuery | 
    try {
      CursorConfigsRsp result = apiInstance.configCursorPost(cursorQuery);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configCursorPost");
      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

CursorConfigsRsp

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	-

configIdDelete

DeleteRsp configIdDelete(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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    String id = "id_example"; // String | 删除配置
    try {
      DeleteRsp result = apiInstance.configIdDelete(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configIdDelete");
      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	-

configIdGet

GetConfigRsp configIdGet(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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    String id = "id_example"; // String | 查询配置通过配置ID
    try {
      GetConfigRsp result = apiInstance.configIdGet(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configIdGet");
      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

GetConfigRsp

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	-

configPagePost

PageConfigsRsp configPagePost(pageQuery)

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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    PageQuery pageQuery = new PageQuery(); // PageQuery | 
    try {
      PageConfigsRsp result = apiInstance.configPagePost(pageQuery);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configPagePost");
      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

PageConfigsRsp

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	-

configPost

CreateConfigRsp configPost(createConfigReq)

创建配置

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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    CreateConfigReq createConfigReq = new CreateConfigReq(); // CreateConfigReq | 
    try {
      CreateConfigRsp result = apiInstance.configPost(createConfigReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configPost");
      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
createConfigReq	CreateConfigReq		[optional]

Return type

CreateConfigRsp

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	-

configPut

UpdateConfigRsp configPut(updateConfigReq)

更新配置

更新配置，需要全部的配置信息

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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    UpdateConfigReq updateConfigReq = new UpdateConfigReq(); // UpdateConfigReq | 
    try {
      UpdateConfigRsp result = apiInstance.configPut(updateConfigReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configPut");
      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
updateConfigReq	UpdateConfigReq		[optional]

Return type

UpdateConfigRsp

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	-

configRetrieveByKeyPost

RetrieveConfigByKeyRsp configRetrieveByKeyPost(retrieveConfigByKeyReq)

查询配置

查询配置通过配置Key和资源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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    RetrieveConfigByKeyReq retrieveConfigByKeyReq = new RetrieveConfigByKeyReq(); // RetrieveConfigByKeyReq | 
    try {
      RetrieveConfigByKeyRsp result = apiInstance.configRetrieveByKeyPost(retrieveConfigByKeyReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configRetrieveByKeyPost");
      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
retrieveConfigByKeyReq	RetrieveConfigByKeyReq		[optional]

Return type

RetrieveConfigByKeyRsp

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	-

configTemplatePut

UpdateConfigTemplateRsp configTemplatePut(updateConfigTemplateReq)

更新配置模版

更新配置模版，需要全部的配置模版信息

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.ConfigApi;

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");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    UpdateConfigTemplateReq updateConfigTemplateReq = new UpdateConfigTemplateReq(); // UpdateConfigTemplateReq | 
    try {
      UpdateConfigTemplateRsp result = apiInstance.configTemplatePut(updateConfigTemplateReq);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configTemplatePut");
      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
updateConfigTemplateReq	UpdateConfigTemplateReq		[optional]

Return type

UpdateConfigTemplateRsp

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	-

FilesExpand file tree

ConfigApi.md

Latest commit

History

ConfigApi.md

File metadata and controls

ConfigApi

configBatchDeletePost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configBatchRetrieveByKeysPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configBatchRetrieveByResourcesPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configBatchRetrievePost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configCursorPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configPagePost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configPut

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

configRetrieveByKeyPost

Example

Parameters