v20190819

package
v3.0.233+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const APIVersion = "2019-08-19"

Variables

This section is empty.

Functions

This section is empty.

Types

type Acl

type Acl struct {

	// Acl资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID)当前只有TOPIC,
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// 资源名称,和resourceType相关如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
	// 注意:此字段可能返回 null,表示取不到有效值。
	Principal *string `json:"Principal,omitempty" name:"Principal"`

	// 默认为*,表示任何host都可以访问,当前ckafka不支持host为*,但是后面开源kafka的产品化会直接支持
	// 注意:此字段可能返回 null,表示取不到有效值。
	Host *string `json:"Host,omitempty" name:"Host"`

	// Acl操作方式(0:UNKNOWN,1:ANY,2:ALL,3:READ,4:WRITE,5:CREATE,6:DELETE,7:ALTER,8:DESCRIBE,9:CLUSTER_ACTION,10:DESCRIBE_CONFIGS,11:ALTER_CONFIGS,12:IDEMPOTEN_WRITE)
	Operation *int64 `json:"Operation,omitempty" name:"Operation"`

	// 权限类型(0:UNKNOWN,1:ANY,2:DENY,3:ALLOW)
	PermissionType *int64 `json:"PermissionType,omitempty" name:"PermissionType"`
}

type AclResponse

type AclResponse struct {

	// 符合条件的总数据条数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// ACL列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	AclList []*Acl `json:"AclList,omitempty" name:"AclList" list`
}

type AppIdResponse

type AppIdResponse struct {

	// 符合要求的所有AppId数量
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 符合要求的App Id列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	AppIdList []*int64 `json:"AppIdList,omitempty" name:"AppIdList" list`
}

type Assignment

type Assignment struct {

	// assingment版本信息
	Version *int64 `json:"Version,omitempty" name:"Version"`

	// topic信息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Topics []*GroupInfoTopics `json:"Topics,omitempty" name:"Topics" list`
}

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateAcl

func (c *Client) CreateAcl(request *CreateAclRequest) (response *CreateAclResponse, err error)

添加 ACL 策略

func (*Client) CreateInstancePre

func (c *Client) CreateInstancePre(request *CreateInstancePreRequest) (response *CreateInstancePreResponse, err error)

创建实例(预付费包年包月)

func (*Client) CreatePartition

func (c *Client) CreatePartition(request *CreatePartitionRequest) (response *CreatePartitionResponse, err error)

本接口用于增加主题中的分区

func (*Client) CreateTopic

func (c *Client) CreateTopic(request *CreateTopicRequest) (response *CreateTopicResponse, err error)

创建ckafka主题

func (*Client) CreateTopicIpWhiteList

func (c *Client) CreateTopicIpWhiteList(request *CreateTopicIpWhiteListRequest) (response *CreateTopicIpWhiteListResponse, err error)

创建主题ip白名单

func (*Client) CreateUser

func (c *Client) CreateUser(request *CreateUserRequest) (response *CreateUserResponse, err error)

添加用户

func (*Client) DeleteAcl

func (c *Client) DeleteAcl(request *DeleteAclRequest) (response *DeleteAclResponse, err error)

删除ACL

func (*Client) DeleteTopic

func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)

删除ckafka主题

func (*Client) DeleteTopicIpWhiteList

func (c *Client) DeleteTopicIpWhiteList(request *DeleteTopicIpWhiteListRequest) (response *DeleteTopicIpWhiteListResponse, err error)

删除主题IP白名单

func (*Client) DeleteUser

func (c *Client) DeleteUser(request *DeleteUserRequest) (response *DeleteUserResponse, err error)

删除用户

func (*Client) DescribeACL

func (c *Client) DescribeACL(request *DescribeACLRequest) (response *DescribeACLResponse, err error)

枚举ACL

func (*Client) DescribeAppInfo

func (c *Client) DescribeAppInfo(request *DescribeAppInfoRequest) (response *DescribeAppInfoResponse, err error)

查询用户列表

func (*Client) DescribeConsumerGroup

func (c *Client) DescribeConsumerGroup(request *DescribeConsumerGroupRequest) (response *DescribeConsumerGroupResponse, err error)

查询消费分组信息

func (*Client) DescribeGroup

func (c *Client) DescribeGroup(request *DescribeGroupRequest) (response *DescribeGroupResponse, err error)

枚举消费分组(精简版)

func (*Client) DescribeGroupInfo

func (c *Client) DescribeGroupInfo(request *DescribeGroupInfoRequest) (response *DescribeGroupInfoResponse, err error)

获取消费分组信息

func (*Client) DescribeGroupOffsets

func (c *Client) DescribeGroupOffsets(request *DescribeGroupOffsetsRequest) (response *DescribeGroupOffsetsResponse, err error)

获取消费分组offset

func (*Client) DescribeInstanceAttributes

func (c *Client) DescribeInstanceAttributes(request *DescribeInstanceAttributesRequest) (response *DescribeInstanceAttributesResponse, err error)

获取实例属性

func (*Client) DescribeInstances

func (c *Client) DescribeInstances(request *DescribeInstancesRequest) (response *DescribeInstancesResponse, err error)

本接口(DescribeInstance)用于在用户账户下获取消息队列 CKafka 实例列表

func (*Client) DescribeInstancesDetail

func (c *Client) DescribeInstancesDetail(request *DescribeInstancesDetailRequest) (response *DescribeInstancesDetailResponse, err error)

用户账户下获取实例列表详情

func (*Client) DescribeRoute

func (c *Client) DescribeRoute(request *DescribeRouteRequest) (response *DescribeRouteResponse, err error)

查看路由信息

func (*Client) DescribeTopic

func (c *Client) DescribeTopic(request *DescribeTopicRequest) (response *DescribeTopicResponse, err error)

接口请求域名:https://ckafka.tencentcloudapi.com 本接口(DescribeTopic)用于在用户获取消息队列 CKafka 实例的主题列表

func (*Client) DescribeTopicAttributes

func (c *Client) DescribeTopicAttributes(request *DescribeTopicAttributesRequest) (response *DescribeTopicAttributesResponse, err error)

获取主题属性

func (*Client) DescribeTopicDetail

func (c *Client) DescribeTopicDetail(request *DescribeTopicDetailRequest) (response *DescribeTopicDetailResponse, err error)

获取主题列表详情(仅控制台调用)

func (*Client) DescribeUser

func (c *Client) DescribeUser(request *DescribeUserRequest) (response *DescribeUserResponse, err error)

查询用户信息

func (*Client) ModifyGroupOffsets

func (c *Client) ModifyGroupOffsets(request *ModifyGroupOffsetsRequest) (response *ModifyGroupOffsetsResponse, err error)

设置Groups 消费分组offset

func (*Client) ModifyInstanceAttributes

func (c *Client) ModifyInstanceAttributes(request *ModifyInstanceAttributesRequest) (response *ModifyInstanceAttributesResponse, err error)

设置实例属性

func (*Client) ModifyPassword

func (c *Client) ModifyPassword(request *ModifyPasswordRequest) (response *ModifyPasswordResponse, err error)

修改密码

func (*Client) ModifyTopicAttributes

func (c *Client) ModifyTopicAttributes(request *ModifyTopicAttributesRequest) (response *ModifyTopicAttributesResponse, err error)

本接口用于修改主题属性。

type Config

type Config struct {

	// 消息保留时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	Retention *int64 `json:"Retention,omitempty" name:"Retention"`

	// 最小同步复制数
	// 注意:此字段可能返回 null,表示取不到有效值。
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitempty" name:"MinInsyncReplicas"`

	// 日志清理模式,默认 delete。
	// delete:日志按保存时间删除;compact:日志按 key 压缩;compact, delete:日志按 key 压缩且会保存时间删除。
	// 注意:此字段可能返回 null,表示取不到有效值。
	CleanUpPolicy *string `json:"CleanUpPolicy,omitempty" name:"CleanUpPolicy"`

	// Segment 分片滚动的时长
	// 注意:此字段可能返回 null,表示取不到有效值。
	SegmentMs *int64 `json:"SegmentMs,omitempty" name:"SegmentMs"`

	// 0表示 false。 1表示 true。
	// 注意:此字段可能返回 null,表示取不到有效值。
	UncleanLeaderElectionEnable *int64 `json:"UncleanLeaderElectionEnable,omitempty" name:"UncleanLeaderElectionEnable"`

	// Segment 分片滚动的字节数
	// 注意:此字段可能返回 null,表示取不到有效值。
	SegmentBytes *int64 `json:"SegmentBytes,omitempty" name:"SegmentBytes"`

	// 最大消息字节数
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitempty" name:"MaxMessageBytes"`
}

type ConsumerGroup

type ConsumerGroup struct {

	// 用户组名称
	ConsumerGroupName *string `json:"ConsumerGroupName,omitempty" name:"ConsumerGroupName"`

	// 订阅信息实体
	SubscribedInfo []*SubscribedInfo `json:"SubscribedInfo,omitempty" name:"SubscribedInfo" list`
}

type ConsumerGroupResponse

type ConsumerGroupResponse struct {

	// 符合条件的消费组数量
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 主题列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	TopicList []*ConsumerGroupTopic `json:"TopicList,omitempty" name:"TopicList" list`

	// 消费分组List
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupList []*ConsumerGroup `json:"GroupList,omitempty" name:"GroupList" list`

	// 所有分区数量
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalPartition *int64 `json:"TotalPartition,omitempty" name:"TotalPartition"`

	// 监控的分区列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	PartitionListForMonitor []*Partition `json:"PartitionListForMonitor,omitempty" name:"PartitionListForMonitor" list`

	// 主题总数
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalTopic *int64 `json:"TotalTopic,omitempty" name:"TotalTopic"`

	// 监控的主题列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	TopicListForMonitor []*ConsumerGroupTopic `json:"TopicListForMonitor,omitempty" name:"TopicListForMonitor" list`

	// 监控的组列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupListForMonitor []*Group `json:"GroupListForMonitor,omitempty" name:"GroupListForMonitor" list`
}

type ConsumerGroupTopic

type ConsumerGroupTopic struct {

	// 主题ID
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`

	// 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`
}

type CreateAclRequest

type CreateAclRequest struct {
	*tchttp.BaseRequest

	// 实例id信息
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Acl资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID),当前只有TOPIC,其它字段用于后续兼容开源kafka的acl时使用
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// 资源名称,和resourceType相关,如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// Acl操作方式,(0:UNKNOWN,1:ANY,2:ALL,3:READ,4:WRITE,5:CREATE,6:DELETE,7:ALTER,8:DESCRIBE,9:CLUSTER_ACTION,10:DESCRIBE_CONFIGS,11:ALTER_CONFIGS)
	Operation *int64 `json:"Operation,omitempty" name:"Operation"`

	// 权限类型,(0:UNKNOWN,1:ANY,2:DENY,3:ALLOW),当前ckakfa支持ALLOW(相当于白名单),其它用于后续兼容开源kafka的acl时使用
	PermissionType *int64 `json:"PermissionType,omitempty" name:"PermissionType"`

	// 默认为\*,表示任何host都可以访问,当前ckafka不支持host为\*,但是后面开源kafka的产品化会直接支持
	Host *string `json:"Host,omitempty" name:"Host"`

	// 用户列表,默认为*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
	Principal *string `json:"Principal,omitempty" name:"Principal"`
}

func NewCreateAclRequest

func NewCreateAclRequest() (request *CreateAclRequest)

func (*CreateAclRequest) FromJsonString

func (r *CreateAclRequest) FromJsonString(s string) error

func (*CreateAclRequest) ToJsonString

func (r *CreateAclRequest) ToJsonString() string

type CreateAclResponse

type CreateAclResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateAclResponse

func NewCreateAclResponse() (response *CreateAclResponse)

func (*CreateAclResponse) FromJsonString

func (r *CreateAclResponse) FromJsonString(s string) error

func (*CreateAclResponse) ToJsonString

func (r *CreateAclResponse) ToJsonString() string

type CreateInstancePreData

type CreateInstancePreData struct {

	// CreateInstancePre返回固定为0,不能作为CheckTaskStatus的查询条件。只是为了保证和后台数据结构对齐。
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowId *int64 `json:"FlowId,omitempty" name:"FlowId"`

	// 订单号列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	DealNames []*string `json:"DealNames,omitempty" name:"DealNames" list`
}

type CreateInstancePreRequest

type CreateInstancePreRequest struct {
	*tchttp.BaseRequest

	// 实例名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 可用区
	ZoneId *int64 `json:"ZoneId,omitempty" name:"ZoneId"`

	// 预付费购买时长,例如 "1m",就是一个月
	Period *string `json:"Period,omitempty" name:"Period"`

	// 实例规格,1:入门型 ,2: 标准型,3 :进阶型,4 :容量型,5: 高阶型1,6:高阶性2, 7: 高阶型3,8: 高阶型4, 9 :独占型。
	InstanceType *int64 `json:"InstanceType,omitempty" name:"InstanceType"`

	// vpcId,不填默认基础网络
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// 子网id,vpc网络需要传该参数,基础网络可以不传
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// 可选。实例日志的最长保留时间,单位分钟,默认为10080(7天),最大30天,不填默认0,代表不开启日志保留时间回收策略
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitempty" name:"MsgRetentionTime"`

	// 创建实例时可以选择集群Id, 该入参表示集群Id
	ClusterId *int64 `json:"ClusterId,omitempty" name:"ClusterId"`

	// 预付费自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置)
	RenewFlag *int64 `json:"RenewFlag,omitempty" name:"RenewFlag"`
}

func NewCreateInstancePreRequest

func NewCreateInstancePreRequest() (request *CreateInstancePreRequest)

func (*CreateInstancePreRequest) FromJsonString

func (r *CreateInstancePreRequest) FromJsonString(s string) error

func (*CreateInstancePreRequest) ToJsonString

func (r *CreateInstancePreRequest) ToJsonString() string

type CreateInstancePreResponse

type CreateInstancePreResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的code,0为正常,非0为错误
		ReturnCode *string `json:"ReturnCode,omitempty" name:"ReturnCode"`

		// 成功消息
		ReturnMessage *string `json:"ReturnMessage,omitempty" name:"ReturnMessage"`

		// 操作型返回的Data数据
		// 注意:此字段可能返回 null,表示取不到有效值。
		Data *CreateInstancePreData `json:"Data,omitempty" name:"Data"`
	} `json:"Response"`
}

func NewCreateInstancePreResponse

func NewCreateInstancePreResponse() (response *CreateInstancePreResponse)

func (*CreateInstancePreResponse) FromJsonString

func (r *CreateInstancePreResponse) FromJsonString(s string) error

func (*CreateInstancePreResponse) ToJsonString

func (r *CreateInstancePreResponse) ToJsonString() string

type CreatePartitionRequest

type CreatePartitionRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// 主题分区个数
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`
}

func NewCreatePartitionRequest

func NewCreatePartitionRequest() (request *CreatePartitionRequest)

func (*CreatePartitionRequest) FromJsonString

func (r *CreatePartitionRequest) FromJsonString(s string) error

func (*CreatePartitionRequest) ToJsonString

func (r *CreatePartitionRequest) ToJsonString() string

type CreatePartitionResponse

type CreatePartitionResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果集
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreatePartitionResponse

func NewCreatePartitionResponse() (response *CreatePartitionResponse)

func (*CreatePartitionResponse) FromJsonString

func (r *CreatePartitionResponse) FromJsonString(s string) error

func (*CreatePartitionResponse) ToJsonString

func (r *CreatePartitionResponse) ToJsonString() string

type CreateTopicIpWhiteListRequest

type CreateTopicIpWhiteListRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// ip白名单列表
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList" list`
}

func NewCreateTopicIpWhiteListRequest

func NewCreateTopicIpWhiteListRequest() (request *CreateTopicIpWhiteListRequest)

func (*CreateTopicIpWhiteListRequest) FromJsonString

func (r *CreateTopicIpWhiteListRequest) FromJsonString(s string) error

func (*CreateTopicIpWhiteListRequest) ToJsonString

func (r *CreateTopicIpWhiteListRequest) ToJsonString() string

type CreateTopicIpWhiteListResponse

type CreateTopicIpWhiteListResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 删除主题IP白名单结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateTopicIpWhiteListResponse

func NewCreateTopicIpWhiteListResponse() (response *CreateTopicIpWhiteListResponse)

func (*CreateTopicIpWhiteListResponse) FromJsonString

func (r *CreateTopicIpWhiteListResponse) FromJsonString(s string) error

func (*CreateTopicIpWhiteListResponse) ToJsonString

func (r *CreateTopicIpWhiteListResponse) ToJsonString() string

type CreateTopicRequest

type CreateTopicRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 主题名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Partition个数,大于0
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`

	// 副本个数,不能多于 broker 数,最大为3
	ReplicaNum *int64 `json:"ReplicaNum,omitempty" name:"ReplicaNum"`

	// ip白名单开关, 1:打开  0:关闭,默认不打开
	EnableWhiteList *int64 `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// Ip白名单列表,配额限制,enableWhileList=1时必选
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList" list`

	// 清理日志策略,日志清理模式,默认为"delete"。"delete":日志按保存时间删除,"compact":日志按 key 压缩,"compact, delete":日志按 key 压缩且会按保存时间删除。
	CleanUpPolicy *string `json:"CleanUpPolicy,omitempty" name:"CleanUpPolicy"`

	// 主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
	Note *string `json:"Note,omitempty" name:"Note"`

	// 默认为1
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitempty" name:"MinInsyncReplicas"`

	// 是否允许未同步的副本选为leader,false:不允许,true:允许,默认不允许
	UncleanLeaderElectionEnable *int64 `json:"UncleanLeaderElectionEnable,omitempty" name:"UncleanLeaderElectionEnable"`

	// 可消息选。保留时间,单位ms,当前最小值为60000ms
	RetentionMs *int64 `json:"RetentionMs,omitempty" name:"RetentionMs"`

	// Segment分片滚动的时长,单位ms,当前最小为3600000ms
	SegmentMs *int64 `json:"SegmentMs,omitempty" name:"SegmentMs"`
}

func NewCreateTopicRequest

func NewCreateTopicRequest() (request *CreateTopicRequest)

func (*CreateTopicRequest) FromJsonString

func (r *CreateTopicRequest) FromJsonString(s string) error

func (*CreateTopicRequest) ToJsonString

func (r *CreateTopicRequest) ToJsonString() string

type CreateTopicResp

type CreateTopicResp struct {

	// 主题Id
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`
}

type CreateTopicResponse

type CreateTopicResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回创建结果
		Result *CreateTopicResp `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateTopicResponse

func NewCreateTopicResponse() (response *CreateTopicResponse)

func (*CreateTopicResponse) FromJsonString

func (r *CreateTopicResponse) FromJsonString(s string) error

func (*CreateTopicResponse) ToJsonString

func (r *CreateTopicResponse) ToJsonString() string

type CreateUserRequest

type CreateUserRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 用户名称
	Name *string `json:"Name,omitempty" name:"Name"`

	// 用户密码
	Password *string `json:"Password,omitempty" name:"Password"`
}

func NewCreateUserRequest

func NewCreateUserRequest() (request *CreateUserRequest)

func (*CreateUserRequest) FromJsonString

func (r *CreateUserRequest) FromJsonString(s string) error

func (*CreateUserRequest) ToJsonString

func (r *CreateUserRequest) ToJsonString() string

type CreateUserResponse

type CreateUserResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewCreateUserResponse

func NewCreateUserResponse() (response *CreateUserResponse)

func (*CreateUserResponse) FromJsonString

func (r *CreateUserResponse) FromJsonString(s string) error

func (*CreateUserResponse) ToJsonString

func (r *CreateUserResponse) ToJsonString() string

type DeleteAclRequest

type DeleteAclRequest struct {
	*tchttp.BaseRequest

	// 实例id信息
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Acl资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID),当前只有TOPIC,其它字段用于后续兼容开源kafka的acl时使用
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// 资源名称,和resourceType相关,如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// Acl操作方式,(0:UNKNOWN,1:ANY,2:ALL,3:READ,4:WRITE,5:CREATE,6:DELETE,7:ALTER,8:DESCRIBE,9:CLUSTER_ACTION,10:DESCRIBE_CONFIGS,11:ALTER_CONFIGS,12:IDEMPOTEN_WRITE),当前ckafka只支持READ,WRITE,其它用于后续兼容开源kafka的acl时使用
	Operation *int64 `json:"Operation,omitempty" name:"Operation"`

	// 权限类型,(0:UNKNOWN,1:ANY,2:DENY,3:ALLOW),当前ckakfa支持ALLOW(相当于白名单),其它用于后续兼容开源kafka的acl时使用
	PermissionType *int64 `json:"PermissionType,omitempty" name:"PermissionType"`

	// 默认为\*,表示任何host都可以访问,当前ckafka不支持host为\*,但是后面开源kafka的产品化会直接支持
	Host *string `json:"Host,omitempty" name:"Host"`

	// 用户列表,默认为*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
	Principal *string `json:"Principal,omitempty" name:"Principal"`
}

func NewDeleteAclRequest

func NewDeleteAclRequest() (request *DeleteAclRequest)

func (*DeleteAclRequest) FromJsonString

func (r *DeleteAclRequest) FromJsonString(s string) error

func (*DeleteAclRequest) ToJsonString

func (r *DeleteAclRequest) ToJsonString() string

type DeleteAclResponse

type DeleteAclResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteAclResponse

func NewDeleteAclResponse() (response *DeleteAclResponse)

func (*DeleteAclResponse) FromJsonString

func (r *DeleteAclResponse) FromJsonString(s string) error

func (*DeleteAclResponse) ToJsonString

func (r *DeleteAclResponse) ToJsonString() string

type DeleteTopicIpWhiteListRequest

type DeleteTopicIpWhiteListRequest struct {
	*tchttp.BaseRequest

	// 实例ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// ip白名单列表
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList" list`
}

func NewDeleteTopicIpWhiteListRequest

func NewDeleteTopicIpWhiteListRequest() (request *DeleteTopicIpWhiteListRequest)

func (*DeleteTopicIpWhiteListRequest) FromJsonString

func (r *DeleteTopicIpWhiteListRequest) FromJsonString(s string) error

func (*DeleteTopicIpWhiteListRequest) ToJsonString

func (r *DeleteTopicIpWhiteListRequest) ToJsonString() string

type DeleteTopicIpWhiteListResponse

type DeleteTopicIpWhiteListResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 删除主题IP白名单结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteTopicIpWhiteListResponse

func NewDeleteTopicIpWhiteListResponse() (response *DeleteTopicIpWhiteListResponse)

func (*DeleteTopicIpWhiteListResponse) FromJsonString

func (r *DeleteTopicIpWhiteListResponse) FromJsonString(s string) error

func (*DeleteTopicIpWhiteListResponse) ToJsonString

func (r *DeleteTopicIpWhiteListResponse) ToJsonString() string

type DeleteTopicRequest

type DeleteTopicRequest struct {
	*tchttp.BaseRequest

	// ckafka 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// ckafka 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`
}

func NewDeleteTopicRequest

func NewDeleteTopicRequest() (request *DeleteTopicRequest)

func (*DeleteTopicRequest) FromJsonString

func (r *DeleteTopicRequest) FromJsonString(s string) error

func (*DeleteTopicRequest) ToJsonString

func (r *DeleteTopicRequest) ToJsonString() string

type DeleteTopicResponse

type DeleteTopicResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果集
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteTopicResponse

func NewDeleteTopicResponse() (response *DeleteTopicResponse)

func (*DeleteTopicResponse) FromJsonString

func (r *DeleteTopicResponse) FromJsonString(s string) error

func (*DeleteTopicResponse) ToJsonString

func (r *DeleteTopicResponse) ToJsonString() string

type DeleteUserRequest

type DeleteUserRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 用户名称
	Name *string `json:"Name,omitempty" name:"Name"`
}

func NewDeleteUserRequest

func NewDeleteUserRequest() (request *DeleteUserRequest)

func (*DeleteUserRequest) FromJsonString

func (r *DeleteUserRequest) FromJsonString(s string) error

func (*DeleteUserRequest) ToJsonString

func (r *DeleteUserRequest) ToJsonString() string

type DeleteUserResponse

type DeleteUserResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteUserResponse

func NewDeleteUserResponse() (response *DeleteUserResponse)

func (*DeleteUserResponse) FromJsonString

func (r *DeleteUserResponse) FromJsonString(s string) error

func (*DeleteUserResponse) ToJsonString

func (r *DeleteUserResponse) ToJsonString() string

type DescribeACLRequest

type DescribeACLRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Acl资源类型,(0:UNKNOWN,1:ANY,2:TOPIC,3:GROUP,4:CLUSTER,5:TRANSACTIONAL_ID),当前只有TOPIC,其它字段用于后续兼容开源kafka的acl时使用
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// 资源名称,和resourceType相关,如当resourceType为TOPIC时,则该字段表示topic名称,当resourceType为GROUP时,该字段表示group名称
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// 偏移位置
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 个数限制
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 关键字匹配
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`
}

func NewDescribeACLRequest

func NewDescribeACLRequest() (request *DescribeACLRequest)

func (*DescribeACLRequest) FromJsonString

func (r *DescribeACLRequest) FromJsonString(s string) error

func (*DescribeACLRequest) ToJsonString

func (r *DescribeACLRequest) ToJsonString() string

type DescribeACLResponse

type DescribeACLResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的ACL结果集对象
		Result *AclResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeACLResponse

func NewDescribeACLResponse() (response *DescribeACLResponse)

func (*DescribeACLResponse) FromJsonString

func (r *DescribeACLResponse) FromJsonString(s string) error

func (*DescribeACLResponse) ToJsonString

func (r *DescribeACLResponse) ToJsonString() string

type DescribeAppInfoRequest

type DescribeAppInfoRequest struct {
	*tchttp.BaseRequest

	// 偏移位置
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 本次查询用户数目最大数量限制,最大值为50,默认50
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeAppInfoRequest

func NewDescribeAppInfoRequest() (request *DescribeAppInfoRequest)

func (*DescribeAppInfoRequest) FromJsonString

func (r *DescribeAppInfoRequest) FromJsonString(s string) error

func (*DescribeAppInfoRequest) ToJsonString

func (r *DescribeAppInfoRequest) ToJsonString() string

type DescribeAppInfoResponse

type DescribeAppInfoResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的符合要求的App Id列表
		Result *AppIdResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeAppInfoResponse

func NewDescribeAppInfoResponse() (response *DescribeAppInfoResponse)

func (*DescribeAppInfoResponse) FromJsonString

func (r *DescribeAppInfoResponse) FromJsonString(s string) error

func (*DescribeAppInfoResponse) ToJsonString

func (r *DescribeAppInfoResponse) ToJsonString() string

type DescribeConsumerGroupRequest

type DescribeConsumerGroupRequest struct {
	*tchttp.BaseRequest

	// ckafka实例id。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 可选,用户需要查询的group名称。
	GroupName *string `json:"GroupName,omitempty" name:"GroupName"`

	// 可选,用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// 本次返回个数限制
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 偏移位置
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeConsumerGroupRequest

func NewDescribeConsumerGroupRequest() (request *DescribeConsumerGroupRequest)

func (*DescribeConsumerGroupRequest) FromJsonString

func (r *DescribeConsumerGroupRequest) FromJsonString(s string) error

func (*DescribeConsumerGroupRequest) ToJsonString

func (r *DescribeConsumerGroupRequest) ToJsonString() string

type DescribeConsumerGroupResponse

type DescribeConsumerGroupResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的消费分组信息
		Result *ConsumerGroupResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeConsumerGroupResponse

func NewDescribeConsumerGroupResponse() (response *DescribeConsumerGroupResponse)

func (*DescribeConsumerGroupResponse) FromJsonString

func (r *DescribeConsumerGroupResponse) FromJsonString(s string) error

func (*DescribeConsumerGroupResponse) ToJsonString

func (r *DescribeConsumerGroupResponse) ToJsonString() string

type DescribeGroup

type DescribeGroup struct {

	// groupId
	Group *string `json:"Group,omitempty" name:"Group"`

	// 该 group 使用的协议。
	Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
}

type DescribeGroupInfoRequest

type DescribeGroupInfoRequest struct {
	*tchttp.BaseRequest

	// (过滤条件)按照实例 ID 过滤。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Kafka 消费分组,Consumer-group,这里是数组形式,格式:GroupList.0=xxx&GroupList.1=yyy。
	GroupList []*string `json:"GroupList,omitempty" name:"GroupList" list`
}

func NewDescribeGroupInfoRequest

func NewDescribeGroupInfoRequest() (request *DescribeGroupInfoRequest)

func (*DescribeGroupInfoRequest) FromJsonString

func (r *DescribeGroupInfoRequest) FromJsonString(s string) error

func (*DescribeGroupInfoRequest) ToJsonString

func (r *DescribeGroupInfoRequest) ToJsonString() string

type DescribeGroupInfoResponse

type DescribeGroupInfoResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果
		// 注意:此字段可能返回 null,表示取不到有效值。
		Result []*GroupInfoResponse `json:"Result,omitempty" name:"Result" list`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeGroupInfoResponse

func NewDescribeGroupInfoResponse() (response *DescribeGroupInfoResponse)

func (*DescribeGroupInfoResponse) FromJsonString

func (r *DescribeGroupInfoResponse) FromJsonString(s string) error

func (*DescribeGroupInfoResponse) ToJsonString

func (r *DescribeGroupInfoResponse) ToJsonString() string

type DescribeGroupOffsetsRequest

type DescribeGroupOffsetsRequest struct {
	*tchttp.BaseRequest

	// (过滤条件)按照实例 ID 过滤
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Kafka 消费分组
	Group *string `json:"Group,omitempty" name:"Group"`

	// group 订阅的主题名称数组,如果没有该数组,则表示指定的 group 下所有 topic 信息
	Topics []*string `json:"Topics,omitempty" name:"Topics" list`

	// 模糊匹配 topicName
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// 本次查询的偏移位置,默认为0
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 本次返回结果的最大个数,默认为50,最大值为50
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeGroupOffsetsRequest

func NewDescribeGroupOffsetsRequest() (request *DescribeGroupOffsetsRequest)

func (*DescribeGroupOffsetsRequest) FromJsonString

func (r *DescribeGroupOffsetsRequest) FromJsonString(s string) error

func (*DescribeGroupOffsetsRequest) ToJsonString

func (r *DescribeGroupOffsetsRequest) ToJsonString() string

type DescribeGroupOffsetsResponse

type DescribeGroupOffsetsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果对象
		Result *GroupOffsetResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeGroupOffsetsResponse

func NewDescribeGroupOffsetsResponse() (response *DescribeGroupOffsetsResponse)

func (*DescribeGroupOffsetsResponse) FromJsonString

func (r *DescribeGroupOffsetsResponse) FromJsonString(s string) error

func (*DescribeGroupOffsetsResponse) ToJsonString

func (r *DescribeGroupOffsetsResponse) ToJsonString() string

type DescribeGroupRequest

type DescribeGroupRequest struct {
	*tchttp.BaseRequest

	// 实例ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 搜索关键字
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// 偏移量
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 最大返回数量
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeGroupRequest

func NewDescribeGroupRequest() (request *DescribeGroupRequest)

func (*DescribeGroupRequest) FromJsonString

func (r *DescribeGroupRequest) FromJsonString(s string) error

func (*DescribeGroupRequest) ToJsonString

func (r *DescribeGroupRequest) ToJsonString() string

type DescribeGroupResponse

type DescribeGroupResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果集列表
		Result *GroupResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeGroupResponse

func NewDescribeGroupResponse() (response *DescribeGroupResponse)

func (*DescribeGroupResponse) FromJsonString

func (r *DescribeGroupResponse) FromJsonString(s string) error

func (*DescribeGroupResponse) ToJsonString

func (r *DescribeGroupResponse) ToJsonString() string

type DescribeInstanceAttributesRequest

type DescribeInstanceAttributesRequest struct {
	*tchttp.BaseRequest

	// 实例id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceAttributesRequest

func NewDescribeInstanceAttributesRequest() (request *DescribeInstanceAttributesRequest)

func (*DescribeInstanceAttributesRequest) FromJsonString

func (r *DescribeInstanceAttributesRequest) FromJsonString(s string) error

func (*DescribeInstanceAttributesRequest) ToJsonString

func (r *DescribeInstanceAttributesRequest) ToJsonString() string

type DescribeInstanceAttributesResponse

type DescribeInstanceAttributesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 实例属性返回结果对象
		Result *InstanceAttributesResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInstanceAttributesResponse

func NewDescribeInstanceAttributesResponse() (response *DescribeInstanceAttributesResponse)

func (*DescribeInstanceAttributesResponse) FromJsonString

func (r *DescribeInstanceAttributesResponse) FromJsonString(s string) error

func (*DescribeInstanceAttributesResponse) ToJsonString

func (r *DescribeInstanceAttributesResponse) ToJsonString() string

type DescribeInstancesDetailRequest

type DescribeInstancesDetailRequest struct {
	*tchttp.BaseRequest

	// (过滤条件)按照实例ID过滤
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// (过滤条件)按照实例名称过滤,支持模糊查询
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// (过滤条件)实例的状态。0:创建中,1:运行中,2:删除中,不填默认返回全部
	Status []*int64 `json:"Status,omitempty" name:"Status" list`

	// 偏移量,不填默认为0
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 返回数量,不填则默认10,最大值20
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 匹配标签key值。
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

	// 过滤器
	Filters []*Filter `json:"Filters,omitempty" name:"Filters" list`
}

func NewDescribeInstancesDetailRequest

func NewDescribeInstancesDetailRequest() (request *DescribeInstancesDetailRequest)

func (*DescribeInstancesDetailRequest) FromJsonString

func (r *DescribeInstancesDetailRequest) FromJsonString(s string) error

func (*DescribeInstancesDetailRequest) ToJsonString

func (r *DescribeInstancesDetailRequest) ToJsonString() string

type DescribeInstancesDetailResponse

type DescribeInstancesDetailResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的实例详情结果对象
		Result *InstanceDetailResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInstancesDetailResponse

func NewDescribeInstancesDetailResponse() (response *DescribeInstancesDetailResponse)

func (*DescribeInstancesDetailResponse) FromJsonString

func (r *DescribeInstancesDetailResponse) FromJsonString(s string) error

func (*DescribeInstancesDetailResponse) ToJsonString

func (r *DescribeInstancesDetailResponse) ToJsonString() string

type DescribeInstancesRequest

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

	// (过滤条件)按照实例ID过滤
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// (过滤条件)按照实例名称过滤,支持模糊查询
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// (过滤条件)实例的状态。0:创建中,1:运行中,2:删除中,不填默认返回全部
	Status []*int64 `json:"Status,omitempty" name:"Status" list`

	// 偏移量,不填默认为0
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 返回数量,不填则默认10,最大值100
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// 匹配标签key值。
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`
}

func NewDescribeInstancesRequest

func NewDescribeInstancesRequest() (request *DescribeInstancesRequest)

func (*DescribeInstancesRequest) FromJsonString

func (r *DescribeInstancesRequest) FromJsonString(s string) error

func (*DescribeInstancesRequest) ToJsonString

func (r *DescribeInstancesRequest) ToJsonString() string

type DescribeInstancesResponse

type DescribeInstancesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果
		Result *InstanceResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeInstancesResponse

func NewDescribeInstancesResponse() (response *DescribeInstancesResponse)

func (*DescribeInstancesResponse) FromJsonString

func (r *DescribeInstancesResponse) FromJsonString(s string) error

func (*DescribeInstancesResponse) ToJsonString

func (r *DescribeInstancesResponse) ToJsonString() string

type DescribeRouteRequest

type DescribeRouteRequest struct {
	*tchttp.BaseRequest

	// 实例唯一id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

func NewDescribeRouteRequest

func NewDescribeRouteRequest() (request *DescribeRouteRequest)

func (*DescribeRouteRequest) FromJsonString

func (r *DescribeRouteRequest) FromJsonString(s string) error

func (*DescribeRouteRequest) ToJsonString

func (r *DescribeRouteRequest) ToJsonString() string

type DescribeRouteResponse

type DescribeRouteResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的路由信息结果集
		Result *RouteResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRouteResponse

func NewDescribeRouteResponse() (response *DescribeRouteResponse)

func (*DescribeRouteResponse) FromJsonString

func (r *DescribeRouteResponse) FromJsonString(s string) error

func (*DescribeRouteResponse) ToJsonString

func (r *DescribeRouteResponse) ToJsonString() string

type DescribeTopicAttributesRequest

type DescribeTopicAttributesRequest struct {
	*tchttp.BaseRequest

	// 实例 ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`
}

func NewDescribeTopicAttributesRequest

func NewDescribeTopicAttributesRequest() (request *DescribeTopicAttributesRequest)

func (*DescribeTopicAttributesRequest) FromJsonString

func (r *DescribeTopicAttributesRequest) FromJsonString(s string) error

func (*DescribeTopicAttributesRequest) ToJsonString

func (r *DescribeTopicAttributesRequest) ToJsonString() string

type DescribeTopicAttributesResponse

type DescribeTopicAttributesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果对象
		Result *TopicAttributesResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTopicAttributesResponse

func NewDescribeTopicAttributesResponse() (response *DescribeTopicAttributesResponse)

func (*DescribeTopicAttributesResponse) FromJsonString

func (r *DescribeTopicAttributesResponse) FromJsonString(s string) error

func (*DescribeTopicAttributesResponse) ToJsonString

func (r *DescribeTopicAttributesResponse) ToJsonString() string

type DescribeTopicDetailRequest

type DescribeTopicDetailRequest struct {
	*tchttp.BaseRequest

	// 实例id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// (过滤条件)按照topicName过滤,支持模糊查询
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// 偏移量,不填默认为0
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 返回数量,不填则默认 10,最大值20,取值要大于0
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeTopicDetailRequest

func NewDescribeTopicDetailRequest() (request *DescribeTopicDetailRequest)

func (*DescribeTopicDetailRequest) FromJsonString

func (r *DescribeTopicDetailRequest) FromJsonString(s string) error

func (*DescribeTopicDetailRequest) ToJsonString

func (r *DescribeTopicDetailRequest) ToJsonString() string

type DescribeTopicDetailResponse

type DescribeTopicDetailResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的主题详情实体
		Result *TopicDetailResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTopicDetailResponse

func NewDescribeTopicDetailResponse() (response *DescribeTopicDetailResponse)

func (*DescribeTopicDetailResponse) FromJsonString

func (r *DescribeTopicDetailResponse) FromJsonString(s string) error

func (*DescribeTopicDetailResponse) ToJsonString

func (r *DescribeTopicDetailResponse) ToJsonString() string

type DescribeTopicRequest

type DescribeTopicRequest struct {
	*tchttp.BaseRequest

	// 实例 ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 过滤条件,按照 topicName 过滤,支持模糊查询
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// 偏移量,不填默认为0
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 返回数量,不填则默认为10,最大值为50
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeTopicRequest

func NewDescribeTopicRequest() (request *DescribeTopicRequest)

func (*DescribeTopicRequest) FromJsonString

func (r *DescribeTopicRequest) FromJsonString(s string) error

func (*DescribeTopicRequest) ToJsonString

func (r *DescribeTopicRequest) ToJsonString() string

type DescribeTopicResponse

type DescribeTopicResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回的结果
		// 注意:此字段可能返回 null,表示取不到有效值。
		Result *TopicResult `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTopicResponse

func NewDescribeTopicResponse() (response *DescribeTopicResponse)

func (*DescribeTopicResponse) FromJsonString

func (r *DescribeTopicResponse) FromJsonString(s string) error

func (*DescribeTopicResponse) ToJsonString

func (r *DescribeTopicResponse) ToJsonString() string

type DescribeUserRequest

type DescribeUserRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 按照名称过滤
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// 偏移
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 本次返回个数
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeUserRequest

func NewDescribeUserRequest() (request *DescribeUserRequest)

func (*DescribeUserRequest) FromJsonString

func (r *DescribeUserRequest) FromJsonString(s string) error

func (*DescribeUserRequest) ToJsonString

func (r *DescribeUserRequest) ToJsonString() string

type DescribeUserResponse

type DescribeUserResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果列表
		Result *UserResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeUserResponse

func NewDescribeUserResponse() (response *DescribeUserResponse)

func (*DescribeUserResponse) FromJsonString

func (r *DescribeUserResponse) FromJsonString(s string) error

func (*DescribeUserResponse) ToJsonString

func (r *DescribeUserResponse) ToJsonString() string

type Filter

type Filter struct {

	// 需要过滤的字段。
	Name *string `json:"Name,omitempty" name:"Name"`

	// 字段的过滤值。
	Values []*string `json:"Values,omitempty" name:"Values" list`
}

type Group

type Group struct {

	// 组名称
	GroupName *string `json:"GroupName,omitempty" name:"GroupName"`
}

type GroupInfoMember

type GroupInfoMember struct {

	// coordinator 为消费分组中的消费者生成的唯一 ID
	MemberId *string `json:"MemberId,omitempty" name:"MemberId"`

	// 客户消费者 SDK 自己设置的 client.id 信息
	ClientId *string `json:"ClientId,omitempty" name:"ClientId"`

	// 一般存储客户的 IP 地址
	ClientHost *string `json:"ClientHost,omitempty" name:"ClientHost"`

	// 存储着分配给该消费者的 partition 信息
	Assignment *Assignment `json:"Assignment,omitempty" name:"Assignment"`
}

type GroupInfoResponse

type GroupInfoResponse struct {

	// 错误码,正常为0
	ErrorCode *string `json:"ErrorCode,omitempty" name:"ErrorCode"`

	// group 状态描述(常见的为 Empty、Stable、Dead 三种状态):
	// Dead:消费分组不存在
	// Empty:消费分组,当前没有任何消费者订阅
	// PreparingRebalance:消费分组处于 rebalance 状态
	// CompletingRebalance:消费分组处于 rebalance 状态
	// Stable:消费分组中各个消费者已经加入,处于稳定状态
	State *string `json:"State,omitempty" name:"State"`

	// 消费分组选择的协议类型正常的消费者一般为 consumer 但有些系统采用了自己的协议如 kafka-connect 用的就是 connect。只有标准的 consumer 协议,本接口才知道具体的分配方式的格式,才能解析到具体的 partition 的分配情况
	ProtocolType *string `json:"ProtocolType,omitempty" name:"ProtocolType"`

	// 消费者 partition 分配算法常见的有如下几种(Kafka 消费者 SDK 默认的选择项为 range):range、 roundrobin、 sticky
	Protocol *string `json:"Protocol,omitempty" name:"Protocol"`

	// 仅当 state 为 Stable 且 protocol_type 为 consumer 时, 该数组才包含信息
	Members []*GroupInfoMember `json:"Members,omitempty" name:"Members" list`

	// Kafka 消费分组
	Group *string `json:"Group,omitempty" name:"Group"`
}

type GroupInfoTopics

type GroupInfoTopics struct {

	// 分配的 topic 名称
	Topic *string `json:"Topic,omitempty" name:"Topic"`

	// 分配的 partition 信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Partitions []*int64 `json:"Partitions,omitempty" name:"Partitions" list`
}

type GroupOffsetPartition

type GroupOffsetPartition struct {

	// topic 的 partitionId
	Partition *int64 `json:"Partition,omitempty" name:"Partition"`

	// consumer 提交的 offset 位置
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// 支持消费者提交消息时,传入 metadata 作为它用,当前一般为空字符串
	// 注意:此字段可能返回 null,表示取不到有效值。
	Metadata *string `json:"Metadata,omitempty" name:"Metadata"`

	// 错误码
	ErrorCode *int64 `json:"ErrorCode,omitempty" name:"ErrorCode"`

	// 当前 partition 最新的 offset
	LogEndOffset *int64 `json:"LogEndOffset,omitempty" name:"LogEndOffset"`

	// 未消费的消息个数
	Lag *int64 `json:"Lag,omitempty" name:"Lag"`
}

type GroupOffsetResponse

type GroupOffsetResponse struct {

	// 符合调节的总结果数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 该主题分区数组,其中每个元素为一个 json object
	// 注意:此字段可能返回 null,表示取不到有效值。
	TopicList []*GroupOffsetTopic `json:"TopicList,omitempty" name:"TopicList" list`
}

type GroupOffsetTopic

type GroupOffsetTopic struct {

	// 主题名称
	Topic *string `json:"Topic,omitempty" name:"Topic"`

	// 该主题分区数组,其中每个元素为一个 json object
	// 注意:此字段可能返回 null,表示取不到有效值。
	Partitions []*GroupOffsetPartition `json:"Partitions,omitempty" name:"Partitions" list`
}

type GroupResponse

type GroupResponse struct {

	// 计数
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// GroupList
	// 注意:此字段可能返回 null,表示取不到有效值。
	GroupList []*DescribeGroup `json:"GroupList,omitempty" name:"GroupList" list`
}

type Instance

type Instance struct {

	// 实例id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 实例的状态。0:创建中,1:运行中,2:删除中 , 5 隔离中,-1 创建失败
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 是否开源实例。开源:true,不开源:false
	// 注意:此字段可能返回 null,表示取不到有效值。
	IfCommunity *bool `json:"IfCommunity,omitempty" name:"IfCommunity"`
}

type InstanceAttributesResponse

type InstanceAttributesResponse struct {

	// 实例ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 接入点 VIP 列表信息
	VipList []*VipEntity `json:"VipList,omitempty" name:"VipList" list`

	// 虚拟IP
	Vip *string `json:"Vip,omitempty" name:"Vip"`

	// 虚拟端口
	Vport *string `json:"Vport,omitempty" name:"Vport"`

	// 实例的状态。0:创建中,1:运行中,2:删除中
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 实例带宽,单位:Mbps
	Bandwidth *int64 `json:"Bandwidth,omitempty" name:"Bandwidth"`

	// 实例的存储大小,单位:GB
	DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// 可用区
	ZoneId *int64 `json:"ZoneId,omitempty" name:"ZoneId"`

	// VPC 的 ID,为空表示是基础网络
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// 子网 ID, 为空表示基础网络
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// 实例健康状态, 1:健康,2:告警,3:异常
	Healthy *int64 `json:"Healthy,omitempty" name:"Healthy"`

	// 实例健康信息,当前会展示磁盘利用率,最大长度为256
	HealthyMessage *string `json:"HealthyMessage,omitempty" name:"HealthyMessage"`

	// 创建时间
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 消息保存时间,单位为分钟
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitempty" name:"MsgRetentionTime"`

	// 自动创建 Topic 配置, 若该字段为空,则表示未开启自动创建
	Config *InstanceConfigDO `json:"Config,omitempty" name:"Config"`

	// 剩余创建分区数
	RemainderPartitions *int64 `json:"RemainderPartitions,omitempty" name:"RemainderPartitions"`

	// 剩余创建主题数
	RemainderTopics *int64 `json:"RemainderTopics,omitempty" name:"RemainderTopics"`

	// 当前创建分区数
	CreatedPartitions *int64 `json:"CreatedPartitions,omitempty" name:"CreatedPartitions"`

	// 当前创建主题数
	CreatedTopics *int64 `json:"CreatedTopics,omitempty" name:"CreatedTopics"`

	// 标签数组
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*Tag `json:"Tags,omitempty" name:"Tags" list`

	// 过期时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	ExpireTime *uint64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// 跨可用区
	// 注意:此字段可能返回 null,表示取不到有效值。
	ZoneIds []*int64 `json:"ZoneIds,omitempty" name:"ZoneIds" list`

	// kafka版本信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Version *string `json:"Version,omitempty" name:"Version"`

	// 最大分组数
	// 注意:此字段可能返回 null,表示取不到有效值。
	MaxGroupNum *int64 `json:"MaxGroupNum,omitempty" name:"MaxGroupNum"`

	// 售卖类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	Cvm *int64 `json:"Cvm,omitempty" name:"Cvm"`
}

type InstanceConfigDO

type InstanceConfigDO struct {

	// 是否自动创建主题
	AutoCreateTopicsEnable *bool `json:"AutoCreateTopicsEnable,omitempty" name:"AutoCreateTopicsEnable"`

	// 分区数
	DefaultNumPartitions *int64 `json:"DefaultNumPartitions,omitempty" name:"DefaultNumPartitions"`

	// 默认的复制Factor
	DefaultReplicationFactor *int64 `json:"DefaultReplicationFactor,omitempty" name:"DefaultReplicationFactor"`
}

type InstanceDetail

type InstanceDetail struct {

	// 实例id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 实例名称
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 访问实例的vip 信息
	Vip *string `json:"Vip,omitempty" name:"Vip"`

	// 访问实例的端口信息
	Vport *string `json:"Vport,omitempty" name:"Vport"`

	// 虚拟IP列表
	VipList []*VipEntity `json:"VipList,omitempty" name:"VipList" list`

	// 实例的状态。0:创建中,1:运行中,2:删除中:5隔离中, -1 创建失败
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// 实例带宽,单位Mbps
	Bandwidth *int64 `json:"Bandwidth,omitempty" name:"Bandwidth"`

	// 实例的存储大小,单位GB
	DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// 可用区域ID
	ZoneId *int64 `json:"ZoneId,omitempty" name:"ZoneId"`

	// vpcId,如果为空,说明是基础网络
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// 子网id
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// 实例是否续费,int  枚举值:1表示自动续费,2表示明确不自动续费
	RenewFlag *int64 `json:"RenewFlag,omitempty" name:"RenewFlag"`

	// 实例状态 int:0表示健康,1表示告警,2 表示实例状态异常
	Healthy *int64 `json:"Healthy,omitempty" name:"Healthy"`

	// 实例状态信息
	HealthyMessage *string `json:"HealthyMessage,omitempty" name:"HealthyMessage"`

	// 实例创建时间时间
	CreateTime *int64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 实例过期时间
	ExpireTime *int64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// 是否为内部客户。值为1 表示内部客户
	IsInternal *int64 `json:"IsInternal,omitempty" name:"IsInternal"`

	// Topic个数
	TopicNum *int64 `json:"TopicNum,omitempty" name:"TopicNum"`

	// 标识tag
	Tags []*Tag `json:"Tags,omitempty" name:"Tags" list`

	// kafka版本信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	Version *string `json:"Version,omitempty" name:"Version"`

	// 跨可用区
	// 注意:此字段可能返回 null,表示取不到有效值。
	ZoneIds []*int64 `json:"ZoneIds,omitempty" name:"ZoneIds" list`

	// ckafka售卖类型
	// 注意:此字段可能返回 null,表示取不到有效值。
	Cvm *int64 `json:"Cvm,omitempty" name:"Cvm"`
}

type InstanceDetailResponse

type InstanceDetailResponse struct {

	// 符合条件的实例总数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// 符合条件的实例详情列表
	InstanceList []*InstanceDetail `json:"InstanceList,omitempty" name:"InstanceList" list`
}

type InstanceResponse

type InstanceResponse struct {

	// 符合条件的实例列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	InstanceList []*Instance `json:"InstanceList,omitempty" name:"InstanceList" list`

	// 符合条件的结果总数
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type JgwOperateResponse

type JgwOperateResponse struct {

	// 返回的code,0为正常,非0为错误
	ReturnCode *string `json:"ReturnCode,omitempty" name:"ReturnCode"`

	// 成功消息
	ReturnMessage *string `json:"ReturnMessage,omitempty" name:"ReturnMessage"`

	// 操作型返回的Data数据,可能有flowId等
	// 注意:此字段可能返回 null,表示取不到有效值。
	Data *OperateResponseData `json:"Data,omitempty" name:"Data"`
}

type ModifyGroupOffsetsRequest

type ModifyGroupOffsetsRequest struct {
	*tchttp.BaseRequest

	// kafka实例id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// kafka 消费分组
	Group *string `json:"Group,omitempty" name:"Group"`

	// 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
	Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"`

	// 表示需要重置的topics, 不填表示全部
	Topics []*string `json:"Topics,omitempty" name:"Topics" list`

	// 当strategy为0时,必须包含该字段,可以大于零代表会把offset向后移动shift条,小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift),需要注意的是如果新的offset小于partition的earliest则会设置为earliest,如果大于partition 的latest则会设置为latest
	Shift *int64 `json:"Shift,omitempty" name:"Shift"`

	// 单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的时,如果指定的时间不存在消息,则获取最末尾的offset。
	ShiftTimestamp *int64 `json:"ShiftTimestamp,omitempty" name:"ShiftTimestamp"`

	// 需要重新设置的offset位置。当strategy为2,必须包含该字段。
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}

func NewModifyGroupOffsetsRequest

func NewModifyGroupOffsetsRequest() (request *ModifyGroupOffsetsRequest)

func (*ModifyGroupOffsetsRequest) FromJsonString

func (r *ModifyGroupOffsetsRequest) FromJsonString(s string) error

func (*ModifyGroupOffsetsRequest) ToJsonString

func (r *ModifyGroupOffsetsRequest) ToJsonString() string

type ModifyGroupOffsetsResponse

type ModifyGroupOffsetsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyGroupOffsetsResponse

func NewModifyGroupOffsetsResponse() (response *ModifyGroupOffsetsResponse)

func (*ModifyGroupOffsetsResponse) FromJsonString

func (r *ModifyGroupOffsetsResponse) FromJsonString(s string) error

func (*ModifyGroupOffsetsResponse) ToJsonString

func (r *ModifyGroupOffsetsResponse) ToJsonString() string

type ModifyInstanceAttributesConfig

type ModifyInstanceAttributesConfig struct {

	// 自动创建 true 表示开启,false 表示不开启
	AutoCreateTopicEnable *bool `json:"AutoCreateTopicEnable,omitempty" name:"AutoCreateTopicEnable"`

	// 可选,如果auto.create.topic.enable设置为true没有设置该值时,默认设置为3
	DefaultNumPartitions *int64 `json:"DefaultNumPartitions,omitempty" name:"DefaultNumPartitions"`

	// 如歌auto.create.topic.enable设置为true没有指定该值时默认设置为2
	DefaultReplicationFactor *int64 `json:"DefaultReplicationFactor,omitempty" name:"DefaultReplicationFactor"`
}

type ModifyInstanceAttributesRequest

type ModifyInstanceAttributesRequest struct {
	*tchttp.BaseRequest

	// 实例id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 实例日志的最长保留时间,单位分钟,最大30天,0代表不开启日志保留时间回收策略
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitempty" name:"MsgRetentionTime"`

	// 实例名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// 实例配置
	Config *ModifyInstanceAttributesConfig `json:"Config,omitempty" name:"Config"`
}

func NewModifyInstanceAttributesRequest

func NewModifyInstanceAttributesRequest() (request *ModifyInstanceAttributesRequest)

func (*ModifyInstanceAttributesRequest) FromJsonString

func (r *ModifyInstanceAttributesRequest) FromJsonString(s string) error

func (*ModifyInstanceAttributesRequest) ToJsonString

func (r *ModifyInstanceAttributesRequest) ToJsonString() string

type ModifyInstanceAttributesResponse

type ModifyInstanceAttributesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyInstanceAttributesResponse

func NewModifyInstanceAttributesResponse() (response *ModifyInstanceAttributesResponse)

func (*ModifyInstanceAttributesResponse) FromJsonString

func (r *ModifyInstanceAttributesResponse) FromJsonString(s string) error

func (*ModifyInstanceAttributesResponse) ToJsonString

func (r *ModifyInstanceAttributesResponse) ToJsonString() string

type ModifyPasswordRequest

type ModifyPasswordRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 用户名称
	Name *string `json:"Name,omitempty" name:"Name"`

	// 用户当前密码
	Password *string `json:"Password,omitempty" name:"Password"`

	// 用户新密码
	PasswordNew *string `json:"PasswordNew,omitempty" name:"PasswordNew"`
}

func NewModifyPasswordRequest

func NewModifyPasswordRequest() (request *ModifyPasswordRequest)

func (*ModifyPasswordRequest) FromJsonString

func (r *ModifyPasswordRequest) FromJsonString(s string) error

func (*ModifyPasswordRequest) ToJsonString

func (r *ModifyPasswordRequest) ToJsonString() string

type ModifyPasswordResponse

type ModifyPasswordResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyPasswordResponse

func NewModifyPasswordResponse() (response *ModifyPasswordResponse)

func (*ModifyPasswordResponse) FromJsonString

func (r *ModifyPasswordResponse) FromJsonString(s string) error

func (*ModifyPasswordResponse) ToJsonString

func (r *ModifyPasswordResponse) ToJsonString() string

type ModifyTopicAttributesRequest

type ModifyTopicAttributesRequest struct {
	*tchttp.BaseRequest

	// 实例 ID。
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// 主题名称。
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// 主题备注,是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线-。
	Note *string `json:"Note,omitempty" name:"Note"`

	// IP 白名单开关,1:打开;0:关闭。
	EnableWhiteList *int64 `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// 默认为1。
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitempty" name:"MinInsyncReplicas"`

	// 默认为 0,0:false;1:true。
	UncleanLeaderElectionEnable *int64 `json:"UncleanLeaderElectionEnable,omitempty" name:"UncleanLeaderElectionEnable"`

	// 消息保留时间,单位:ms,当前最小值为60000ms。
	RetentionMs *int64 `json:"RetentionMs,omitempty" name:"RetentionMs"`

	// Segment 分片滚动的时长,单位:ms,当前最小为86400000ms。
	SegmentMs *int64 `json:"SegmentMs,omitempty" name:"SegmentMs"`

	// 主题消息最大值,单位为 Byte,最大值为8388608Byte(即8MB)。
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitempty" name:"MaxMessageBytes"`

	// 消息删除策略,可以选择delete 或者compact
	CleanUpPolicy *string `json:"CleanUpPolicy,omitempty" name:"CleanUpPolicy"`
}

func NewModifyTopicAttributesRequest

func NewModifyTopicAttributesRequest() (request *ModifyTopicAttributesRequest)

func (*ModifyTopicAttributesRequest) FromJsonString

func (r *ModifyTopicAttributesRequest) FromJsonString(s string) error

func (*ModifyTopicAttributesRequest) ToJsonString

func (r *ModifyTopicAttributesRequest) ToJsonString() string

type ModifyTopicAttributesResponse

type ModifyTopicAttributesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// 返回结果集
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewModifyTopicAttributesResponse

func NewModifyTopicAttributesResponse() (response *ModifyTopicAttributesResponse)

func (*ModifyTopicAttributesResponse) FromJsonString

func (r *ModifyTopicAttributesResponse) FromJsonString(s string) error

func (*ModifyTopicAttributesResponse) ToJsonString

func (r *ModifyTopicAttributesResponse) ToJsonString() string

type OperateResponseData

type OperateResponseData struct {

	// FlowId
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowId *int64 `json:"FlowId,omitempty" name:"FlowId"`
}

type Partition

type Partition struct {

	// 分区ID
	PartitionId *int64 `json:"PartitionId,omitempty" name:"PartitionId"`
}

type PartitionOffset

type PartitionOffset struct {

	// Partition,例如"0"或"1"
	// 注意:此字段可能返回 null,表示取不到有效值。
	Partition *string `json:"Partition,omitempty" name:"Partition"`

	// Offset,例如100
	// 注意:此字段可能返回 null,表示取不到有效值。
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}

type Route

type Route struct {

	// 实例接入方式
	// 0:PLAINTEXT (明文方式,没有带用户信息老版本及社区版本都支持)
	// 1:SASL_PLAINTEXT(明文方式,不过在数据开始时,会通过SASL方式登录鉴权,仅社区版本支持)
	// 2:SSL(SSL加密通信,没有带用户信息,老版本及社区版本都支持)
	// 3:SASL_SSL(SSL加密通信,在数据开始时,会通过SASL方式登录鉴权,仅社区版本支持)
	AccessType *int64 `json:"AccessType,omitempty" name:"AccessType"`

	// 路由ID
	RouteId *int64 `json:"RouteId,omitempty" name:"RouteId"`

	// vip网络类型(1:外网TGW  2:基础网络 3:VPC网络 4:腾讯云支持环境(一般用于内部实例) 5:SSL外网访问方式访问 6:黑石环境vpc)
	VipType *int64 `json:"VipType,omitempty" name:"VipType"`

	// 虚拟IP列表
	VipList []*VipEntity `json:"VipList,omitempty" name:"VipList" list`

	// 域名
	// 注意:此字段可能返回 null,表示取不到有效值。
	Domain *string `json:"Domain,omitempty" name:"Domain"`

	// 域名port
	// 注意:此字段可能返回 null,表示取不到有效值。
	DomainPort *int64 `json:"DomainPort,omitempty" name:"DomainPort"`
}

type RouteResponse

type RouteResponse struct {

	// 路由信息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Routers []*Route `json:"Routers,omitempty" name:"Routers" list`
}

type SubscribedInfo

type SubscribedInfo struct {

	// 订阅的主题名
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// 订阅的分区
	// 注意:此字段可能返回 null,表示取不到有效值。
	Partition []*int64 `json:"Partition,omitempty" name:"Partition" list`

	// 分区offset信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	PartitionOffset []*PartitionOffset `json:"PartitionOffset,omitempty" name:"PartitionOffset" list`
}

type Tag

type Tag struct {

	// 标签的key
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

	// 标签的值
	TagValue *string `json:"TagValue,omitempty" name:"TagValue"`
}

type Topic

type Topic struct {

	// 主题的ID
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`

	// 主题的名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// 备注
	// 注意:此字段可能返回 null,表示取不到有效值。
	Note *string `json:"Note,omitempty" name:"Note"`
}

type TopicAttributesResponse

type TopicAttributesResponse struct {

	// 主题 ID
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`

	// 创建时间
	CreateTime *int64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 主题备注
	// 注意:此字段可能返回 null,表示取不到有效值。
	Note *string `json:"Note,omitempty" name:"Note"`

	// 分区个数
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`

	// IP 白名单开关,1:打开; 0:关闭
	EnableWhiteList *int64 `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// IP 白名单列表
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList" list`

	// topic 配置数组
	Config *Config `json:"Config,omitempty" name:"Config"`

	// 分区详情
	Partitions []*TopicPartitionDO `json:"Partitions,omitempty" name:"Partitions" list`
}

type TopicDetail

type TopicDetail struct {

	// 主题名称
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// 主题ID
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`

	// 分区数
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`

	// 副本数
	ReplicaNum *int64 `json:"ReplicaNum,omitempty" name:"ReplicaNum"`

	// 备注
	// 注意:此字段可能返回 null,表示取不到有效值。
	Note *string `json:"Note,omitempty" name:"Note"`

	// 创建时间
	CreateTime *int64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// 是否开启ip鉴权白名单,true表示开启,false表示不开启
	EnableWhiteList *bool `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// ip白名单中ip个数
	IpWhiteListCount *int64 `json:"IpWhiteListCount,omitempty" name:"IpWhiteListCount"`

	// 数据备份cos bucket: 转存到cos 的bucket地址
	// 注意:此字段可能返回 null,表示取不到有效值。
	ForwardCosBucket *string `json:"ForwardCosBucket,omitempty" name:"ForwardCosBucket"`

	// 数据备份cos 状态: 1 不开启数据备份,0 开启数据备份
	ForwardStatus *int64 `json:"ForwardStatus,omitempty" name:"ForwardStatus"`

	// 数据备份到cos的周期频率
	ForwardInterval *int64 `json:"ForwardInterval,omitempty" name:"ForwardInterval"`

	// 高级配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	Config *Config `json:"Config,omitempty" name:"Config"`
}

type TopicDetailResponse

type TopicDetailResponse struct {

	// 返回的主题详情列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	TopicList []*TopicDetail `json:"TopicList,omitempty" name:"TopicList" list`

	// 符合条件的所有主题详情数量
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type TopicPartitionDO

type TopicPartitionDO struct {

	// Partition ID
	Partition *int64 `json:"Partition,omitempty" name:"Partition"`

	// Leader 运行状态
	LeaderStatus *int64 `json:"LeaderStatus,omitempty" name:"LeaderStatus"`

	// ISR 个数
	IsrNum *int64 `json:"IsrNum,omitempty" name:"IsrNum"`

	// 副本个数
	ReplicaNum *int64 `json:"ReplicaNum,omitempty" name:"ReplicaNum"`
}

type TopicResult

type TopicResult struct {

	// 返回的主题信息列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	TopicList []*Topic `json:"TopicList,omitempty" name:"TopicList" list`

	// 符合条件的 topic 数量
	// 注意:此字段可能返回 null,表示取不到有效值。
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type User

type User struct {

	// 用户id
	UserId *int64 `json:"UserId,omitempty" name:"UserId"`

	// 用户名称
	Name *string `json:"Name,omitempty" name:"Name"`

	// 创建时间
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// 最后更新时间
	UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"`
}

type UserResponse

type UserResponse struct {

	// 符合条件的用户列表
	// 注意:此字段可能返回 null,表示取不到有效值。
	Users []*User `json:"Users,omitempty" name:"Users" list`

	// 符合条件的总用户数
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type VipEntity

type VipEntity struct {

	// 虚拟IP
	Vip *string `json:"Vip,omitempty" name:"Vip"`

	// 虚拟端口
	Vport *string `json:"Vport,omitempty" name:"Vport"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL