Documentation
¶
Index ¶
- Constants
- type AddExistedInstancesRequest
- type AddExistedInstancesResponse
- type Client
- func (c *Client) AddExistedInstances(request *AddExistedInstancesRequest) (response *AddExistedInstancesResponse, err error)
- func (c *Client) CreateCluster(request *CreateClusterRequest) (response *CreateClusterResponse, err error)
- func (c *Client) DeleteClusterInstances(request *DeleteClusterInstancesRequest) (response *DeleteClusterInstancesResponse, err error)
- func (c *Client) DescribeClusterInstances(request *DescribeClusterInstancesRequest) (response *DescribeClusterInstancesResponse, err error)
- func (c *Client) DescribeClusters(request *DescribeClustersRequest) (response *DescribeClustersResponse, err error)
- type Cluster
- type ClusterAdvancedSettings
- type ClusterBasicSettings
- type ClusterCIDRSettings
- type ClusterNetworkSettings
- type CreateClusterRequest
- type CreateClusterResponse
- type DeleteClusterInstancesRequest
- type DeleteClusterInstancesResponse
- type DescribeClusterInstancesRequest
- type DescribeClusterInstancesResponse
- type DescribeClustersRequest
- type DescribeClustersResponse
- type EnhancedService
- type ExistedInstancesForNode
- type ExistedInstancesPara
- type Filter
- type Instance
- type InstanceAdvancedSettings
- type LoginSettings
- type RunInstancesForNode
- type RunMonitorServiceEnabled
- type RunSecurityServiceEnabled
Constants ¶
View Source
const APIVersion = "2018-05-25"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddExistedInstancesRequest ¶
type AddExistedInstancesRequest struct { *tchttp.BaseRequest // 集群ID ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // 实例列表 InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list` // 实例额外需要设置参数信息 InstanceAdvancedSettings *InstanceAdvancedSettings `json:"InstanceAdvancedSettings,omitempty" name:"InstanceAdvancedSettings"` // 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。 EnhancedService *EnhancedService `json:"EnhancedService,omitempty" name:"EnhancedService"` // 节点登录信息(目前仅支持使用Password或者单个KeyIds) LoginSettings *LoginSettings `json:"LoginSettings,omitempty" name:"LoginSettings"` // 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。(目前仅支持设置单个sgId) SecurityGroupIds []*string `json:"SecurityGroupIds,omitempty" name:"SecurityGroupIds" list` }
func NewAddExistedInstancesRequest ¶
func NewAddExistedInstancesRequest() (request *AddExistedInstancesRequest)
func (*AddExistedInstancesRequest) FromJsonString ¶
func (r *AddExistedInstancesRequest) FromJsonString(s string) error
func (*AddExistedInstancesRequest) ToJsonString ¶
func (r *AddExistedInstancesRequest) ToJsonString() string
type AddExistedInstancesResponse ¶
type AddExistedInstancesResponse struct { *tchttp.BaseResponse Response *struct { // 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewAddExistedInstancesResponse ¶
func NewAddExistedInstancesResponse() (response *AddExistedInstancesResponse)
func (*AddExistedInstancesResponse) FromJsonString ¶
func (r *AddExistedInstancesResponse) FromJsonString(s string) error
func (*AddExistedInstancesResponse) ToJsonString ¶
func (r *AddExistedInstancesResponse) ToJsonString() string
type Client ¶
func NewClient ¶
func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) AddExistedInstances ¶
func (c *Client) AddExistedInstances(request *AddExistedInstancesRequest) (response *AddExistedInstancesResponse, err error)
添加已经存在的实例到集群
func (*Client) CreateCluster ¶
func (c *Client) CreateCluster(request *CreateClusterRequest) (response *CreateClusterResponse, err error)
创建集群
func (*Client) DeleteClusterInstances ¶
func (c *Client) DeleteClusterInstances(request *DeleteClusterInstancesRequest) (response *DeleteClusterInstancesResponse, err error)
删除集群中的实例
func (*Client) DescribeClusterInstances ¶
func (c *Client) DescribeClusterInstances(request *DescribeClusterInstancesRequest) (response *DescribeClusterInstancesResponse, err error)
查询集群下节点实例信息
func (*Client) DescribeClusters ¶
func (c *Client) DescribeClusters(request *DescribeClustersRequest) (response *DescribeClustersResponse, err error)
查询集群列表
type Cluster ¶
type Cluster struct { // 集群ID ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // 集群名称 ClusterName *string `json:"ClusterName,omitempty" name:"ClusterName"` // 集群描述 ClusterDescription *string `json:"ClusterDescription,omitempty" name:"ClusterDescription"` // 集群版本(默认值为1.10.5) ClusterVersion *string `json:"ClusterVersion,omitempty" name:"ClusterVersion"` // 集群系统。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64,默认取值为ubuntu16.04.1 LTSx86_64 ClusterOs *string `json:"ClusterOs,omitempty" name:"ClusterOs"` // 集群类型,托管集群:MANAGED_CLUSTER,独立集群:INDEPENDENT_CLUSTER。 ClusterType *string `json:"ClusterType,omitempty" name:"ClusterType"` // 集群网络相关参数 ClusterNetworkSettings *ClusterNetworkSettings `json:"ClusterNetworkSettings,omitempty" name:"ClusterNetworkSettings"` // 集群当前node数量 ClusterNodeNum *uint64 `json:"ClusterNodeNum,omitempty" name:"ClusterNodeNum"` // 集群所属的项目ID ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"` }
type ClusterAdvancedSettings ¶
type ClusterBasicSettings ¶
type ClusterBasicSettings struct { // 集群系统。centos7.2x86_64 或者 ubuntu16.04.1 LTSx86_64,默认取值为ubuntu16.04.1 LTSx86_64 ClusterOs *string `json:"ClusterOs,omitempty" name:"ClusterOs"` // 集群版本,默认值为1.10.5 ClusterVersion *string `json:"ClusterVersion,omitempty" name:"ClusterVersion"` // 集群名称 ClusterName *string `json:"ClusterName,omitempty" name:"ClusterName"` // 集群描述 ClusterDescription *string `json:"ClusterDescription,omitempty" name:"ClusterDescription"` // 私有网络ID,形如vpc-xxx。创建托管空集群时必传。 VpcId *string `json:"VpcId,omitempty" name:"VpcId"` // 集群内新增资源所属项目ID。 ProjectId *int64 `json:"ProjectId,omitempty" name:"ProjectId"` }
type ClusterCIDRSettings ¶
type ClusterCIDRSettings struct { // 用于分配集群容器和服务 IP 的 CIDR,不得与 VPC CIDR 冲突,也不得与同 VPC 内其他集群 CIDR 冲突 ClusterCIDR *string `json:"ClusterCIDR,omitempty" name:"ClusterCIDR"` // 是否忽略 ClusterCIDR 冲突错误, 默认不忽略 IgnoreClusterCIDRConflict *bool `json:"IgnoreClusterCIDRConflict,omitempty" name:"IgnoreClusterCIDRConflict"` // 集群中每个Node上最大的Pod数量 MaxNodePodNum *uint64 `json:"MaxNodePodNum,omitempty" name:"MaxNodePodNum"` // 集群最大的service数量 MaxClusterServiceNum *uint64 `json:"MaxClusterServiceNum,omitempty" name:"MaxClusterServiceNum"` }
type ClusterNetworkSettings ¶
type ClusterNetworkSettings struct { // 用于分配集群容器和服务 IP 的 CIDR,不得与 VPC CIDR 冲突,也不得与同 VPC 内其他集群 CIDR 冲突 ClusterCIDR *string `json:"ClusterCIDR,omitempty" name:"ClusterCIDR"` // 是否忽略 ClusterCIDR 冲突错误, 默认不忽略 IgnoreClusterCIDRConflict *bool `json:"IgnoreClusterCIDRConflict,omitempty" name:"IgnoreClusterCIDRConflict"` // 集群中每个Node上最大的Pod数量(默认为256) MaxNodePodNum *uint64 `json:"MaxNodePodNum,omitempty" name:"MaxNodePodNum"` // 集群最大的service数量(默认为256) MaxClusterServiceNum *uint64 `json:"MaxClusterServiceNum,omitempty" name:"MaxClusterServiceNum"` // 是否启用IPVS(默认不开启) Ipvs *bool `json:"Ipvs,omitempty" name:"Ipvs"` // 集群的VPCID(如果创建空集群,为必传值,否则自动设置为和集群的节点保持一致) VpcId *string `json:"VpcId,omitempty" name:"VpcId"` }
type CreateClusterRequest ¶
type CreateClusterRequest struct { *tchttp.BaseRequest // 集群容器网络配置信息 ClusterCIDRSettings *ClusterCIDRSettings `json:"ClusterCIDRSettings,omitempty" name:"ClusterCIDRSettings"` // 集群类型,托管集群:MANAGED_CLUSTER,独立集群:INDEPENDENT_CLUSTER。 ClusterType *string `json:"ClusterType,omitempty" name:"ClusterType"` // CVM创建透传参数,json化字符串格式,详见[CVM创建实例](https://cloud.tencent.com/document/product/213/15730)接口。 RunInstancesForNode []*RunInstancesForNode `json:"RunInstancesForNode,omitempty" name:"RunInstancesForNode" list` // 集群的基本配置信息 ClusterBasicSettings *ClusterBasicSettings `json:"ClusterBasicSettings,omitempty" name:"ClusterBasicSettings"` // 集群高级配置信息 ClusterAdvancedSettings *ClusterAdvancedSettings `json:"ClusterAdvancedSettings,omitempty" name:"ClusterAdvancedSettings"` // 节点高级配置信息 InstanceAdvancedSettings *InstanceAdvancedSettings `json:"InstanceAdvancedSettings,omitempty" name:"InstanceAdvancedSettings"` // 已存在实例的配置信息 ExistedInstancesForNode []*ExistedInstancesForNode `json:"ExistedInstancesForNode,omitempty" name:"ExistedInstancesForNode" list` }
func NewCreateClusterRequest ¶
func NewCreateClusterRequest() (request *CreateClusterRequest)
func (*CreateClusterRequest) FromJsonString ¶
func (r *CreateClusterRequest) FromJsonString(s string) error
func (*CreateClusterRequest) ToJsonString ¶
func (r *CreateClusterRequest) ToJsonString() string
type CreateClusterResponse ¶
type CreateClusterResponse struct { *tchttp.BaseResponse Response *struct { // 集群ID ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateClusterResponse ¶
func NewCreateClusterResponse() (response *CreateClusterResponse)
func (*CreateClusterResponse) FromJsonString ¶
func (r *CreateClusterResponse) FromJsonString(s string) error
func (*CreateClusterResponse) ToJsonString ¶
func (r *CreateClusterResponse) ToJsonString() string
type DeleteClusterInstancesRequest ¶
type DeleteClusterInstancesRequest struct { *tchttp.BaseRequest // 集群ID ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // 主机InstanceId列表 InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list` // 集群实例删除时的策略:terminate(销毁实例,仅支持按量计费云主机实例) retain (仅移除,保留实例) InstanceDeleteMode *string `json:"InstanceDeleteMode,omitempty" name:"InstanceDeleteMode"` }
func NewDeleteClusterInstancesRequest ¶
func NewDeleteClusterInstancesRequest() (request *DeleteClusterInstancesRequest)
func (*DeleteClusterInstancesRequest) FromJsonString ¶
func (r *DeleteClusterInstancesRequest) FromJsonString(s string) error
func (*DeleteClusterInstancesRequest) ToJsonString ¶
func (r *DeleteClusterInstancesRequest) ToJsonString() string
type DeleteClusterInstancesResponse ¶
type DeleteClusterInstancesResponse struct { *tchttp.BaseResponse Response *struct { // 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteClusterInstancesResponse ¶
func NewDeleteClusterInstancesResponse() (response *DeleteClusterInstancesResponse)
func (*DeleteClusterInstancesResponse) FromJsonString ¶
func (r *DeleteClusterInstancesResponse) FromJsonString(s string) error
func (*DeleteClusterInstancesResponse) ToJsonString ¶
func (r *DeleteClusterInstancesResponse) ToJsonString() string
type DescribeClusterInstancesRequest ¶
type DescribeClusterInstancesRequest struct { *tchttp.BaseRequest // 集群ID ClusterId *string `json:"ClusterId,omitempty" name:"ClusterId"` // 偏移量,默认0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // 最大输出条数,默认20 Limit *int64 `json:"Limit,omitempty" name:"Limit"` // 需要获取的节点实例Id列表(默认为空,表示拉取集群下所有节点实例) InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list` }
func NewDescribeClusterInstancesRequest ¶
func NewDescribeClusterInstancesRequest() (request *DescribeClusterInstancesRequest)
func (*DescribeClusterInstancesRequest) FromJsonString ¶
func (r *DescribeClusterInstancesRequest) FromJsonString(s string) error
func (*DescribeClusterInstancesRequest) ToJsonString ¶
func (r *DescribeClusterInstancesRequest) ToJsonString() string
type DescribeClusterInstancesResponse ¶
type DescribeClusterInstancesResponse struct { *tchttp.BaseResponse Response *struct { // 集群中实例总数 TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // 集群中实例列表 InstanceSet []*Instance `json:"InstanceSet,omitempty" name:"InstanceSet" list` // 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeClusterInstancesResponse ¶
func NewDescribeClusterInstancesResponse() (response *DescribeClusterInstancesResponse)
func (*DescribeClusterInstancesResponse) FromJsonString ¶
func (r *DescribeClusterInstancesResponse) FromJsonString(s string) error
func (*DescribeClusterInstancesResponse) ToJsonString ¶
func (r *DescribeClusterInstancesResponse) ToJsonString() string
type DescribeClustersRequest ¶
type DescribeClustersRequest struct { *tchttp.BaseRequest // 集群ID列表(为空时, // 表示获取账号下所有集群) ClusterIds []*string `json:"ClusterIds,omitempty" name:"ClusterIds" list` // 偏移量,默认0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // 最大输出条数,默认20 Limit *int64 `json:"Limit,omitempty" name:"Limit"` // 过滤条件,当前只支持按照单个条件ClusterName进行过滤 Filters []*Filter `json:"Filters,omitempty" name:"Filters" list` }
func NewDescribeClustersRequest ¶
func NewDescribeClustersRequest() (request *DescribeClustersRequest)
func (*DescribeClustersRequest) FromJsonString ¶
func (r *DescribeClustersRequest) FromJsonString(s string) error
func (*DescribeClustersRequest) ToJsonString ¶
func (r *DescribeClustersRequest) ToJsonString() string
type DescribeClustersResponse ¶
type DescribeClustersResponse struct { *tchttp.BaseResponse Response *struct { // 集群总个数 TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // 集群信息列表 Clusters []*Cluster `json:"Clusters,omitempty" name:"Clusters" list` // 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeClustersResponse ¶
func NewDescribeClustersResponse() (response *DescribeClustersResponse)
func (*DescribeClustersResponse) FromJsonString ¶
func (r *DescribeClustersResponse) FromJsonString(s string) error
func (*DescribeClustersResponse) ToJsonString ¶
func (r *DescribeClustersResponse) ToJsonString() string
type EnhancedService ¶
type EnhancedService struct { // 开启云安全服务。若不指定该参数,则默认开启云安全服务。 SecurityService *RunSecurityServiceEnabled `json:"SecurityService,omitempty" name:"SecurityService"` // 开启云监控服务。若不指定该参数,则默认开启云监控服务。 MonitorService *RunMonitorServiceEnabled `json:"MonitorService,omitempty" name:"MonitorService"` }
type ExistedInstancesForNode ¶
type ExistedInstancesForNode struct { // 节点角色,取值:MASTER_ETCD, WORKER。MASTER_ETCD只有在创建 INDEPENDENT_CLUSTER 独立集群时需要指定。 NodeRole *string `json:"NodeRole,omitempty" name:"NodeRole"` // 已存在实例的重装参数 ExistedInstancesPara *ExistedInstancesPara `json:"ExistedInstancesPara,omitempty" name:"ExistedInstancesPara"` }
type ExistedInstancesPara ¶
type ExistedInstancesPara struct { // 集群ID InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds" list` // 实例额外需要设置参数信息 InstanceAdvancedSettings *InstanceAdvancedSettings `json:"InstanceAdvancedSettings,omitempty" name:"InstanceAdvancedSettings"` // 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。 EnhancedService *EnhancedService `json:"EnhancedService,omitempty" name:"EnhancedService"` // 节点登录信息(目前仅支持使用Password或者单个KeyIds) LoginSettings *LoginSettings `json:"LoginSettings,omitempty" name:"LoginSettings"` // 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。(目前仅支持设置单个sgId) SecurityGroupIds []*string `json:"SecurityGroupIds,omitempty" name:"SecurityGroupIds" list` }
type Instance ¶
type Instance struct { // 实例的附加信息 InstanceAdvanceSettings *InstanceAdvancedSettings `json:"InstanceAdvanceSettings,omitempty" name:"InstanceAdvanceSettings"` // 实例ID InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` // 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER InstanceRole *string `json:"InstanceRole,omitempty" name:"InstanceRole"` // 实例异常(或者处于初始化中)的原因 FailedReason *string `json:"FailedReason,omitempty" name:"FailedReason"` // 实例的状态(running 运行中,initializing 初始化中,failed 异常) InstanceState *string `json:"InstanceState,omitempty" name:"InstanceState"` }
type InstanceAdvancedSettings ¶
type InstanceAdvancedSettings struct { // 数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3,ext4,xfs 文件系统的数据盘将直接挂载,其他文件系统或未格式化的数据盘将自动格式化为ext4 并挂载,请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。 MountTarget *string `json:"MountTarget,omitempty" name:"MountTarget"` // dockerd --graph 指定值, 默认为 /var/lib/docker DockerGraphPath *string `json:"DockerGraphPath,omitempty" name:"DockerGraphPath"` // base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看, 如果要求节点需要在进行初始化完成后才可加入调度, 可配合 unschedulable 参数使用, 在 userScript 最后初始化完成后, 添加 kubectl uncordon nodename --kubeconfig=/root/.kube/config 命令使节点加入调度 UserScript *string `json:"UserScript,omitempty" name:"UserScript"` // 设置加入的节点是否参与调度,默认值为0,表示参与调度;非0表示不参与调度, 待节点初始化完成之后, 可执行kubectl uncordon nodename使node加入调度. Unschedulable *int64 `json:"Unschedulable,omitempty" name:"Unschedulable"` }
type LoginSettings ¶
type LoginSettings struct { // 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:<br><li>Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。<br><li>Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。<br><br>若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 // 注意:此字段可能返回 null,表示取不到有效值。 Password *string `json:"Password,omitempty" name:"Password"` // 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。 // 注意:此字段可能返回 null,表示取不到有效值。 KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds" list` // 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围:<br><li>TRUE:表示保持镜像的登录设置<br><li>FALSE:表示不保持镜像的登录设置<br><br>默认取值:FALSE。 // 注意:此字段可能返回 null,表示取不到有效值。 KeepImageLogin *string `json:"KeepImageLogin,omitempty" name:"KeepImageLogin"` }
type RunInstancesForNode ¶
type RunInstancesForNode struct { // 节点角色,取值:MASTER_ETCD, WORKER。MASTER_ETCD只有在创建 INDEPENDENT_CLUSTER 独立集群时需要指定。 NodeRole *string `json:"NodeRole,omitempty" name:"NodeRole"` // CVM创建透传参数,json化字符串格式,详见[CVM创建实例](https://cloud.tencent.com/document/product/213/15730)接口,传入公共参数外的其他参数即可,其中ImageId会替换为TKE集群OS对应的镜像。 RunInstancesPara []*string `json:"RunInstancesPara,omitempty" name:"RunInstancesPara" list` }
type RunMonitorServiceEnabled ¶
type RunMonitorServiceEnabled struct { // 是否开启[云监控](/document/product/248)服务。取值范围:<br><li>TRUE:表示开启云监控服务<br><li>FALSE:表示不开启云监控服务<br><br>默认取值:TRUE。 Enabled *bool `json:"Enabled,omitempty" name:"Enabled"` }
type RunSecurityServiceEnabled ¶
type RunSecurityServiceEnabled struct { // 是否开启[云安全](/document/product/296)服务。取值范围:<br><li>TRUE:表示开启云安全服务<br><li>FALSE:表示不开启云安全服务<br><br>默认取值:TRUE。 Enabled *bool `json:"Enabled,omitempty" name:"Enabled"` }
Click to show internal directories.
Click to hide internal directories.