Skip to content

Latest commit

 

History

History
518 lines (294 loc) · 14.2 KB

ConfigApi.md

File metadata and controls

518 lines (294 loc) · 14.2 KB

\ConfigApi

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

Method HTTP request Description
BatchDeleteConfigs Post /config/batchDelete 批量删除配置
BatchRetrieveByKeysConfigs Post /config/batchRetrieveByKeys 查询配置
BatchRetrieveByResourcesConfigs Post /config/batchRetrieveByResources 查询配置
BatchRetrieveConfigs Post /config/batchRetrieve 批量查询配置
CreateConfig Post /config 创建配置
CursorConfigs Post /config/cursor Cursor查询配置
DeleteConfig Delete /config/{id} 删除配置
GetConfig Get /config/{id} 查询配置
PageConfigs Post /config/page Page查询配置
RetrieveByKeyConfig Post /config/retrieveByKey 查询配置
UpdateConfig Put /config 更新配置
UpdateConfigTemplate Put /configTemplate 更新配置模版

BatchDeleteConfigs

DeleteResponse BatchDeleteConfigs(ctx, optional)

批量删除配置

批量删除配置通过配置Id

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *BatchDeleteConfigsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BatchDeleteConfigsOpts struct

Name Type Description Notes
idsReq optional.Interface of IdsReq

Return type

DeleteResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BatchRetrieveByKeysConfigs

BatchRetrieveConfigsByKeysResponse BatchRetrieveByKeysConfigs(ctx, optional)

查询配置

查询配置通过配置Keys和资源ID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *BatchRetrieveByKeysConfigsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BatchRetrieveByKeysConfigsOpts struct

Name Type Description Notes
batchRetrieveByKeysReq optional.Interface of BatchRetrieveByKeysReq

Return type

BatchRetrieveConfigsByKeysResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BatchRetrieveByResourcesConfigs

BatchRetrieveConfigsByResourcesResponse BatchRetrieveByResourcesConfigs(ctx, optional)

查询配置

查询配置通过配置GroupID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *BatchRetrieveByResourcesConfigsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BatchRetrieveByResourcesConfigsOpts struct

Name Type Description Notes
batchRetrieveByResourcesReq optional.Interface of BatchRetrieveByResourcesReq

Return type

BatchRetrieveConfigsByResourcesResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

BatchRetrieveConfigs

BatchRetrieveConfigsResponse BatchRetrieveConfigs(ctx, optional)

批量查询配置

批量查询配置通过配置Id

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *BatchRetrieveConfigsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BatchRetrieveConfigsOpts struct

Name Type Description Notes
idsReq optional.Interface of IdsReq

Return type

BatchRetrieveConfigsResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateConfig

CreateConfigResponse CreateConfig(ctx, optional)

创建配置

创建配置

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CreateConfigOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateConfigOpts struct

Name Type Description Notes
createConfigReq optional.Interface of CreateConfigReq

Return type

CreateConfigResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CursorConfigs

CursorConfigsResponse CursorConfigs(ctx, optional)

Cursor查询配置

Cursor查询配置

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CursorConfigsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CursorConfigsOpts struct

Name Type Description Notes
cursorQuery optional.Interface of CursorQuery

Return type

CursorConfigsResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteConfig

DeleteResponse DeleteConfig(ctx, id)

删除配置

删除配置

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string 删除配置

Return type

DeleteResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConfig

GetConfigResponse GetConfig(ctx, id)

查询配置

查询配置通过配置ID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string 查询配置通过配置ID

Return type

GetConfigResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PageConfigs

PageConfigsResponse PageConfigs(ctx, optional)

Page查询配置

Page查询配置

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *PageConfigsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PageConfigsOpts struct

Name Type Description Notes
pageQuery optional.Interface of PageQuery

Return type

PageConfigsResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveByKeyConfig

RetrieveConfigByKeyResponse RetrieveByKeyConfig(ctx, optional)

查询配置

查询配置通过配置Key和资源ID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *RetrieveByKeyConfigOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RetrieveByKeyConfigOpts struct

Name Type Description Notes
retrieveConfigByKeyReq optional.Interface of RetrieveConfigByKeyReq

Return type

RetrieveConfigByKeyResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateConfig

UpdateConfigResponse UpdateConfig(ctx, optional)

更新配置

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *UpdateConfigOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateConfigOpts struct

Name Type Description Notes
updateConfigReq optional.Interface of UpdateConfigReq

Return type

UpdateConfigResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateConfigTemplate

UpdateConfigTemplateResponse UpdateConfigTemplate(ctx, optional)

更新配置模版

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *UpdateConfigTemplateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateConfigTemplateOpts struct

Name Type Description Notes
updateConfigTemplateReq optional.Interface of UpdateConfigTemplateReq

Return type

UpdateConfigTemplateResponse

Authorization

ApiKey

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]