ConfigGroupApi.md

\ConfigGroupApi

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

Method	HTTP request	Description
BatchDeleteGroups	Post /configGroup/batchDelete	批量删除组
BatchRetrieveGroups	Post /configGroup/batchRetrieve	批量查询组
CreateGroup	Post /configGroup	创建组
CursorGroups	Post /configGroup/cursor	Cursor查询组
DeleteGroup	Delete /configGroup/{id}	删除组
GetGroup	Get /configGroup/{id}	查询组
PageGroups	Post /configGroup/page	Page查询组
RetrieveByNameGroup	Post /configGroup/retrieveByName	查询组
UpdateGroup	Put /configGroup	更新组

BatchDeleteGroups

DeleteResponse BatchDeleteGroups(ctx, optional)

批量删除组

批量删除组通过组Id

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a BatchDeleteGroupsOpts 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]

BatchRetrieveGroups

BatchRetrieveConfigGroupsResponse BatchRetrieveGroups(ctx, optional)

批量查询组

批量查询组通过组Id

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a BatchRetrieveGroupsOpts struct

Name	Type	Description	Notes
idsReq	optional.Interface of IdsReq

Return type

BatchRetrieveConfigGroupsResponse

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]

CreateGroup

CreateConfigGroupResponse CreateGroup(ctx, optional)

创建组

创建组

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateGroupOpts struct

Name	Type	Description	Notes
createConfigGroupReq	optional.Interface of CreateConfigGroupReq

Return type

CreateConfigGroupResponse

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]

CursorGroups

CursorConfigGroupsResponse CursorGroups(ctx, optional)

Cursor查询组

Cursor查询组

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CursorGroupsOpts struct

Name	Type	Description	Notes
cursorQuery	optional.Interface of CursorQuery

Return type

CursorConfigGroupsResponse

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]

DeleteGroup

DeleteResponse DeleteGroup(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]

GetGroup

GetConfigGroupResponse GetGroup(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

GetConfigGroupResponse

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]

PageGroups

PageConfigGroupsResponse PageGroups(ctx, optional)

Page查询组

Page查询组

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a PageGroupsOpts struct

Name	Type	Description	Notes
pageQuery	optional.Interface of PageQuery

Return type

PageConfigGroupsResponse

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]

RetrieveByNameGroup

RetrieveConfigGroupByNameResponse RetrieveByNameGroup(ctx, name)

查询组

查询组通过Name

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
name	string	查询组通过Name

Return type

RetrieveConfigGroupByNameResponse

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]

UpdateGroup

UpdateConfigGroupResponse UpdateGroup(ctx, optional)

更新组

更新组，需要全部的组信息

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a UpdateGroupOpts struct

Name	Type	Description	Notes
updateConfigGroupReq	optional.Interface of UpdateConfigGroupReq

Return type

UpdateConfigGroupResponse

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]