Go API client for polaris

一个支持多语言、多框架的云原生服务发现和治理中心

提供高性能SDK和无侵入Sidecar两种接入方式

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: v0.1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://polarismesh.cn/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./polaris"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	AuthStatus	Get /core/v1/auth/status	查询鉴权开关信息
AuthApi	CreateStrategy	Post /core/v1/auth/strategy	创建鉴权策略
AuthApi	DeleteStrategies	Post /core/v1/auth/strategies/delete	删除鉴权策略
AuthApi	GetPrincipalResources	Get /core/v1/auth/principal/resources	获取鉴权策略详细
AuthApi	GetStrategies	Get /core/v1/auth/strategies	查询鉴权策略列表
AuthApi	GetStrategy	Get /core/v1/auth/strategy/detail	获取鉴权策略详细
AuthApi	UpdateStrategies	Put /core/v1/auth/strategies	更新鉴权策略
CircuitBreakersApi	CreateCircuitBreakerVersions	Post /naming/v1/circuitbreakers/version	创建熔断规则版本
CircuitBreakersApi	CreateCircuitBreakers	Post /naming/v1/circuitbreakers	创建熔断规则
CircuitBreakersApi	DeleteCircuitBreakers	Post /naming/v1/circuitbreakers/delete	删除熔断规则
CircuitBreakersApi	GetCircuitBreaker	Get /naming/v1/circuitbreaker	查询熔断规则
CircuitBreakersApi	GetCircuitBreakerToken	Get /naming/v1/circuitbreaker/token	查询熔断规则Token
CircuitBreakersApi	GetCircuitBreakerVersions	Get /naming/v1/circuitbreaker/versions	查询熔断规则版本
CircuitBreakersApi	GetMasterCircuitBreakers	Get /naming/v1/circuitbreakers/master	查询熔断规则Master版本
CircuitBreakersApi	GetReleaseCircuitBreakers	Get /naming/v1/circuitbreakers/release	根据规则id查询已发布的熔断规则
CircuitBreakersApi	ReleaseCircuitBreakers	Post /naming/v1/circuitbreakers/release	发布熔断规则
CircuitBreakersApi	UnBindCircuitBreakers	Post /naming/v1/circuitbreakers/unbind	解绑熔断规则
CircuitBreakersApi	UpdateCircuitBreakers	Put /naming/v1/circuitbreakers	更新熔断规则
ConfigClientApi	GetConfigFile	Get /config/v1/GetConfigFile	拉取配置
ConfigClientApi	WatchConfigFile	Post /config/v1/WatchConfigFile	监听配置
ConfigConsoleApi	BatchDeleteConfigFile	Post /config/v1/configfiles/batchdelete	批量删除配置文件
ConfigConsoleApi	CreateConfigFile	Post /config/v1/configfiles	创建配置文件
ConfigConsoleApi	CreateConfigFileGroup	Post /config/v1/configfilegroups	创建配置文件组
ConfigConsoleApi	CreateConfigFileTemplate	Post /config/v1/configfiletemplates	创建配置模板
ConfigConsoleApi	DeleteConfigFile	Delete /config/v1/configfiles	创建配置文件
ConfigConsoleApi	DeleteConfigFileGroup	Delete /config/v1/configfilegroups	删除配置文件
ConfigConsoleApi	GetAllConfigFileTemplates	Get /config/v1/configfiletemplates	获取配置模板
ConfigConsoleApi	GetConfigFile	Get /config/v1/configfiles	拉取配置
ConfigConsoleApi	GetConfigFileRelease	Get /config/v1/configfiles/release	获取配置文件最后一次全量发布信息
ConfigConsoleApi	GetConfigFileReleaseHistory	Get /config/v1/configfiles/releasehistory	获取配置文件发布历史记录
ConfigConsoleApi	PublishConfigFile	Post /config/v1/configfiles/release	发布配置文件
ConfigConsoleApi	QueryConfigFileGroups	Get /config/v1/configfilegroups	搜索配置文件组
ConfigConsoleApi	QueryConfigFilesByGroup	Get /config/v1/configfiles/by-group	搜索配置文件
ConfigConsoleApi	SearchConfigFile	Get /config/v1/configfiles/search	搜索配置文件
ConfigConsoleApi	UpdateConfigFile	Put /config/v1/configfiles	创建配置文件
ConfigConsoleApi	UpdateConfigFileGroup	Put /config/v1/configfilegroups	更新配置文件组
InstancesApi	CreateInstances	Post /naming/v1/instances	创建实例
InstancesApi	DeleteInstances	Post /naming/v1/instances/delete	删除实例(根据实例ID)
InstancesApi	DeleteInstancesByHost	Post /naming/v1/instances/delete/host	删除实例(根据主机)
InstancesApi	GetInstanceLabels	Get /naming/v1/instances/labels	查询某个服务下所有实例的标签信息
InstancesApi	GetInstances	Get /naming/v1/instances	查询服务实例
InstancesApi	GetInstancesCount	Get /naming/v1/instances/count	查询服务实例数量
InstancesApi	UpdateInstances	Put /naming/v1/instances	更新实例
InstancesApi	UpdateInstancesIsolate	Put /naming/v1/instances/isolate/host	修改服务实例的隔离状态
MaintainApi	CleanInstance	Post /maintain/v1/instance/clean	彻底清理flag=1的实例
MaintainApi	CloseConnections	Post /maintain/v1/apiserver/conn/close	关闭指定client ip的连接
MaintainApi	FreeOSMemory	Post /maintain/v1/memory/free	释放系统内存
MaintainApi	GetLastHeartbeat	Get /maintain/v1/instance/heartbeat	获取上一次心跳的时间
MaintainApi	GetLogOutputLevel	Get /maintain/v1/log/outputlevel	获取日志输出级别
MaintainApi	GetServerConnStats	Get /maintain/v1/apiserver/conn/stats	获取服务端连接统计信息
MaintainApi	GetServerConnections	Get /maintain/v1/apiserver/conn	获取服务端连接数
MaintainApi	SetLogOutputLevel	Put /maintain/v1/log/outputlevel	设置日志输出级别
NamespacesApi	CoreCreateNamespaces	Post /core/v1/namespaces	创建命名空间
NamespacesApi	CoreDeleteNamespaces	Post /core/v1/namespaces/delete	删除命名空间
NamespacesApi	CoreGetNamespaceToken	Get /core/v1/namespaces/token	查询命名空间Token
NamespacesApi	CoreGetNamespaces	Get /core/v1/namespaces	查询命名空间列表
NamespacesApi	CoreUpdateNamespaceToken	Put /core/v1/namespaces/token	更新命名空间Token
NamespacesApi	CoreUpdateNamespaces	Put /core/v1/namespaces	更新命名空间
NamespacesApi	CreateNamespaces	Post /naming/v1/namespaces	创建命名空间
NamespacesApi	DeleteNamespaces	Post /naming/v1/namespaces/delete	删除命名空间
NamespacesApi	GetNamespaceToken	Get /naming/v1/namespace/token	查询命名空间Token
NamespacesApi	GetNamespaces	Get /naming/v1/namespaces	获取命名空间列表
NamespacesApi	UpdateNamespaceToken	Put /naming/v1/namespace/token	更新命名空间Token
NamespacesApi	UpdateNamespaces	Put /naming/v1/namespaces	更新命名空间
RateLimitsApi	CreateRateLimits	Post /naming/v1/ratelimits	创建限流规则
RateLimitsApi	DeleteRateLimits	Post /naming/v1/ratelimits/delete	删除限流规则
RateLimitsApi	EnableRateLimits	Put /naming/v1/ratelimits/enable	启用限流规则
RateLimitsApi	GetRateLimits	Get /naming/v1/ratelimits	查询限流规则
RateLimitsApi	UpdateRateLimits	Put /naming/v1/ratelimits	更新限流规则
RegisterInstanceApi	DeregisterInstance	Post /v1/DeregisterInstance	注销实例
RegisterInstanceApi	Discover	Post /v1/Discover	服务发现
RegisterInstanceApi	Heartbeat	Post /v1/Heartbeat	上报心跳
RegisterInstanceApi	RegisterInstance	Post /v1/RegisterInstance	注册实例
RegisterInstanceApi	ReportClient	Post /v1/ReportClient	上报客户端
RegisterInstanceApi	V2Discover	Post /v2/Discover	服务发现
RoutingRulesApi	CreateRoutings	Post /naming/v1/routings	创建路由规则
RoutingRulesApi	DeleteRoutings	Post /naming/v1/routings/delete	删除路由规则
RoutingRulesApi	GetRoutings	Get /naming/v1/routings	查询路由规则
RoutingRulesApi	UpdateRoutings	Put /naming/v1/routings	更新路由规则
RoutingRulesApi	V2CreateRoutings	Post /naming/v2/routings	创建路由规则
RoutingRulesApi	V2DeleteRoutings	Post /naming/v2/routings/delete	删除路由规则
RoutingRulesApi	V2EnableRoutings	Put /naming/v2/routings/enable	启用路由规则
RoutingRulesApi	V2GetRoutings	Get /naming/v2/routings	获取路由规则
RoutingRulesApi	V2UpdateRoutings	Put /naming/v2/routings	更新路由规则
ServicesApi	CreateServiceAlias	Post /naming/v1/service/alias	创建服务别名
ServicesApi	CreateServices	Post /naming/v1/services	创建服务
ServicesApi	DeleteServiceAliases	Post /naming/v1/service/aliases/delete	删除服务别名
ServicesApi	DeleteServices	Post /naming/v1/services/delete	删除服务
ServicesApi	GetCircuitBreakerByService	Get /naming/v1/service/circuitbreaker	根据服务查询熔断规则
ServicesApi	GetServiceAliases	Get /naming/v1/service/aliases	查询服务别名
ServicesApi	GetServiceOwner	Post /naming/v1/service/owner	根据服务获取服务负责人
ServicesApi	GetServiceToken	Get /naming/v1/service/token	查询服务Token
ServicesApi	GetServices	Get /naming/v1/services	获取服务列表
ServicesApi	GetServicesCount	Get /naming/v1/services/count	获取服务数量
ServicesApi	UpdateServiceAlias	Put /naming/v1/service/alias	更新服务别名
ServicesApi	UpdateServiceToken	Put /naming/v1/service/token	更新服务Token
ServicesApi	UpdateServices	Put /naming/v1/services	更新服务
UserGroupApi	CreateGroup	Post /core/v1/usergroup	创建用户组
UserGroupApi	DeleteGroups	Post /core/v1/usergroups/delete	删除用户组
UserGroupApi	GetGroup	Get /core/v1/usergroup/detail	获取用户组详情
UserGroupApi	GetGroupToken	Get /core/v1/usergroup/token	获取用户组 token
UserGroupApi	GetGroups	Get /core/v1/usergroups	查询用户组列表
UserGroupApi	ResetGroupToken	Put /core/v1/usergroup/token/refresh	重置用户组 token
UserGroupApi	UpdateGroupToken	Put /core/v1/usergroup/token/status	更新用户组 token
UserGroupApi	UpdateGroups	Put /core/v1/usergroups	更新用户组
UsersApi	CreateUsers	Post /core/v1/users	创建用户
UsersApi	DeleteUsers	Post /core/v1/users/delete	删除用户
UsersApi	GetUserToken	Get /core/v1/user/token	获取用户Token
UsersApi	GetUsers	Get /core/v1/users	获取用户
UsersApi	Login	Post /core/v1/user/login	用户登录
UsersApi	ResetUserToken	Put /core/v1/user/token/refresh	重置用户Token
UsersApi	UpdateUser	Put /core/v1/user	更新用户
UsersApi	UpdateUserPassword	Put /core/v1/user/password	更新用户密码
UsersApi	UpdateUserToken	Put /core/v1/user/token/status	更新用户Token

Documentation For Models

• AnypbAny
• DurationpbDuration
• MaintainConnReq
• V1Amount
• V1AmountAdjuster
• V1AuthStrategy
• V1CbPolicy
• V1CbPolicyConsecutiveErrConfig
• V1CbPolicyErrRateConfig
• V1CbPolicyErrRateConfigSpecialConfig
• V1CbPolicySlowRateConfig
• V1CbRule
• V1CircuitBreaker
• V1Client
• V1ClientConfigFileInfo
• V1ClientWatchConfigFileRequest
• V1ClimbConfig
• V1ClimbConfigClimbThrottling
• V1ClimbConfigMetricConfig
• V1ClimbConfigTriggerPolicy
• V1ClimbConfigTriggerPolicyErrorRate
• V1ClimbConfigTriggerPolicyErrorRateSpecialConfig
• V1ClimbConfigTriggerPolicySlowRate
• V1ConfigFile
• V1ConfigFileGroup
• V1ConfigFileRelease
• V1ConfigFileTag
• V1ConfigRelease
• V1Destination
• V1DestinationSet
• V1HealthCheck
• V1HeartbeatHealthCheck
• V1Instance
• V1Location
• V1LoginRequest
• V1MatchArgument
• V1MatchString
• V1ModifyUserPassword
• V1Namespace
• V1Principal
• V1Principals
• V1RateLimit
• V1RateLimitCluster
• V1RecoverConfig
• V1Report
• V1Route
• V1Routing
• V1Rule
• V1Service
• V1ServiceAlias
• V1Source
• V1SourceMatcher
• V1StatInfo
• V1StrategyResourceEntry
• V1StrategyResources
• V1User
• V1UserGroup
• V1UserGroupRelation
• V2Routing
• WrapperspbInt32Value
• WrapperspbInt64Value

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: X-Polaris-Token
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-Polaris-Token and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author