v20190819

package
v3.0.320+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error.
	AUTHFAILURE = "AuthFailure"

	// DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
	DRYRUNOPERATION = "DryRunOperation"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The instance does not exist.
	INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"

	// The parameter is required.
	INVALIDPARAMETERVALUE_NOTALLOWEDEMPTY = "InvalidParameterValue.NotAllowedEmpty"

	// The parameter already exists.
	INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"

	// Invalid subnet ID.
	INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"

	// The subnet is not in the zone.
	INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"

	// Invalid VPC ID.
	INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"

	// The value of the `Action` parameter is incorrect.
	INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"

	// The zone is not supported.
	INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// The number of requests exceeds the frequency limit.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// The resource is occupied.
	RESOURCEINUSE = "ResourceInUse"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Unknown parameter error.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// The batch instance deletion limit is reached.
	UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"

	// Oss rejected the operation.
	UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"
)
View Source 
const APIVersion = "2019-08-19"

Variables

This section is empty.

Functions

This section is empty.

Types

type Acl 

type Acl struct {

	// ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only `TOPIC` is available,
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// User list. The default value is `User:*`, which means that any user can access. The current user can only be one included in the user list
	// Note: this field may return null, indicating that no valid values can be obtained.
	Principal *string `json:"Principal,omitempty" name:"Principal"`

	// The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this
	// Note: this field may return null, indicating that no valid values can be obtained.
	Host *string `json:"Host,omitempty" name:"Host"`

	// ACL operation mode. 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"`

	// Permission type. 0: UNKNOWN, 1: ANY, 2: DENY, 3: ALLOW
	PermissionType *int64 `json:"PermissionType,omitempty" name:"PermissionType"`
}

type AclResponse 

type AclResponse struct {

	// Number of eligible data entries
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// ACL list
	// Note: this field may return null, indicating that no valid values can be obtained.
	AclList []*Acl `json:"AclList,omitempty" name:"AclList"`
}

type AclRule 

type AclRule struct {

	// ACL rule name.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	RuleName *string `json:"RuleName,omitempty" name:"RuleName"`

	// Instance ID.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Matching type. Currently, only prefix match is supported. Enumerated value list: PREFIXED
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	PatternType *string `json:"PatternType,omitempty" name:"PatternType"`

	// Prefix value for prefix match.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Pattern *string `json:"Pattern,omitempty" name:"Pattern"`

	// ACL resource type. Only “Topic” is supported. Enumerated value list: Topic.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	ResourceType *string `json:"ResourceType,omitempty" name:"ResourceType"`

	// ACL information contained in the rule.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	AclList *string `json:"AclList,omitempty" name:"AclList"`

	// Creation time of the rule.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	CreateTimeStamp *string `json:"CreateTimeStamp,omitempty" name:"CreateTimeStamp"`

	// A parameter used to specify whether the preset ACL rule is applied to new topics.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	IsApplied *int64 `json:"IsApplied,omitempty" name:"IsApplied"`

	// Rule update time.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	UpdateTimeStamp *string `json:"UpdateTimeStamp,omitempty" name:"UpdateTimeStamp"`

	// Remarks of the rule.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Comment *string `json:"Comment,omitempty" name:"Comment"`

	// One of the corresponding topic names that is displayed.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// The number of topics that apply this ACL rule.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	TopicCount *int64 `json:"TopicCount,omitempty" name:"TopicCount"`

	// Name of rule type.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	PatternTypeTitle *string `json:"PatternTypeTitle,omitempty" name:"PatternTypeTitle"`
}

type AclRuleInfo 

type AclRuleInfo struct {

	// ACL operation types. Enumerated values: `All` (all operations), `Read` (read), `Write` (write).
	Operation *string `json:"Operation,omitempty" name:"Operation"`

	// Permission types: `Deny`, `Allow`.
	PermissionType *string `json:"PermissionType,omitempty" name:"PermissionType"`

	// The default value is `*`, which means that any host can access the topic. CKafka currently does not support specifying a host value of * or an IP range.
	Host *string `json:"Host,omitempty" name:"Host"`

	// The list of users allowed to access the topic. Default value: `User:*`, which means all users. The current user must be in the user list. Add the prefix `User:` before the user name (`User:A`, for example).
	Principal *string `json:"Principal,omitempty" name:"Principal"`
}

type AppIdResponse 

type AppIdResponse struct {

	// Number of eligible `AppId`
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// List of eligible `AppId`
	// Note: this field may return null, indicating that no valid values can be obtained.
	AppIdList []*int64 `json:"AppIdList,omitempty" name:"AppIdList"`
}

type Assignment 

type Assignment struct {

	// Assignment version information
	Version *int64 `json:"Version,omitempty" name:"Version"`

	// Topic information list
	// Note: this field may return null, indicating that no valid values can be obtained.
	Topics []*GroupInfoTopics `json:"Topics,omitempty" name:"Topics"`
}

type BatchCreateAclRequest 

type BatchCreateAclRequest struct {
	*tchttp.BaseRequest

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// ACL resource type. Default value: `2` (topic).
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// Resource list array.
	ResourceNames []*string `json:"ResourceNames,omitempty" name:"ResourceNames"`

	// ACL rule list.
	RuleList []*AclRuleInfo `json:"RuleList,omitempty" name:"RuleList"`
}

func NewBatchCreateAclRequest 

func NewBatchCreateAclRequest() (request *BatchCreateAclRequest)

func (*BatchCreateAclRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateAclRequest) ToJsonString 

func (r *BatchCreateAclRequest) ToJsonString() string

type BatchCreateAclResponse 

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

		// Status code.
		Result *int64 `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewBatchCreateAclResponse 

func NewBatchCreateAclResponse() (response *BatchCreateAclResponse)

func (*BatchCreateAclResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BatchCreateAclResponse) ToJsonString 

func (r *BatchCreateAclResponse) ToJsonString() string

type Client 

type Client struct {
	common.Client
}

func NewClient 

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

func NewClientWithSecretId 

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

Deprecated

func (*Client) BatchCreateAcl 

func (c *Client) BatchCreateAcl(request *BatchCreateAclRequest) (response *BatchCreateAclResponse, err error)

BatchCreateAcl This API is used to create ACL policies in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) CreateAcl 

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

CreateAcl This API is used to add an ACL policy.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreatePartition 

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

CreatePartition This API is used to add a partition in a topic.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreateTopic 

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

CreateTopic This API is used to create a CKafka topic.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreateTopicIpWhiteList 

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

CreateTopicIpWhiteList This API is used to create a topic IP allowlist.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreateUser 

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

CreateUser This API is used to add a user.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DeleteAcl 

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

DeleteAcl This API is used to delete an ACL.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DeleteRouteTriggerTime 

func (c *Client) DeleteRouteTriggerTime(request *DeleteRouteTriggerTimeRequest) (response *DeleteRouteTriggerTimeResponse, err error)

DeleteRouteTriggerTime This API is used to modify the delayed trigger time of route deletion.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DeleteTopic 

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

DeleteTopic This API is used to delete a CKafka topic.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEINUSE = "ResourceInUse"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DeleteTopicIpWhiteList 

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

DeleteTopicIpWhiteList This API is used to delete a topic IP allowlist.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DeleteUser 

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

DeleteUser This API is used to delete a user.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeACL 

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

DescribeACL This API is used to enumerate ACLs.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeAppInfo 

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

DescribeAppInfo This API is used to query the user list.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeCkafkaZone 

func (c *Client) DescribeCkafkaZone(request *DescribeCkafkaZoneRequest) (response *DescribeCkafkaZoneResponse, err error)

DescribeCkafkaZone This API is used to view the AZ list of Ckafka.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeConsumerGroup 

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

DescribeConsumerGroup This API is used to query consumer group information.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeGroup 

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

DescribeGroup This API is used to enumerate consumer groups (simplified).

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeGroupInfo 

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

DescribeGroupInfo This API is used to get consumer group information.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeGroupOffsets 

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

DescribeGroupOffsets This API is used to get the consumer group offset.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeInstanceAttributes 

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

DescribeInstanceAttributes This API is used to get instance attributes.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeInstances 

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

DescribeInstances This API is used to get the list of CKafka instances under a user account.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeInstancesDetail 

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

DescribeInstancesDetail This API is used to get instance list details under a user account.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeRegion 

func (c *Client) DescribeRegion(request *DescribeRegionRequest) (response *DescribeRegionResponse, err error)

DescribeRegion This API is used to enumerate regions, and can be called only in Guangzhou.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeRoute 

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

DescribeRoute This API is used to view route information.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTopic 

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

DescribeTopic API domain name: https://ckafka.tencentcloudapi.com

This API is used to get the list of topics in a CKafka instance of a user.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTopicAttributes 

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

DescribeTopicAttributes This API is used to get topic attributes.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTopicDetail 

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

DescribeTopicDetail This API is used to get topic list details (only for call in the console).

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTopicSubscribeGroup 

func (c *Client) DescribeTopicSubscribeGroup(request *DescribeTopicSubscribeGroupRequest) (response *DescribeTopicSubscribeGroupResponse, err error)

DescribeTopicSubscribeGroup This API is used to search and subscribe the message group information of a topic.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_NOTALLOWEDEMPTY = "InvalidParameterValue.NotAllowedEmpty"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTopicSyncReplica 

func (c *Client) DescribeTopicSyncReplica(request *DescribeTopicSyncReplicaRequest) (response *DescribeTopicSyncReplicaResponse, err error)

DescribeTopicSyncReplica This API is used to get the details of a synced topic replica.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"

func (*Client) DescribeUser 

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

DescribeUser This API is used to query user information.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) FetchMessageByOffset 

func (c *Client) FetchMessageByOffset(request *FetchMessageByOffsetRequest) (response *FetchMessageByOffsetResponse, err error)

FetchMessageByOffset This API is used to query messages based on a specified offset position.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"

func (*Client) ModifyGroupOffsets 

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

ModifyGroupOffsets This API is used to set the consumer group (Groups) offset.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) ModifyInstanceAttributes 

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

ModifyInstanceAttributes This API is used to set instance attributes.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) ModifyPassword 

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

ModifyPassword This API is used to change the password.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) ModifyTopicAttributes 

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

ModifyTopicAttributes This API is used to modify topic attributes.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_SUBNETIDINVALID = "InvalidParameterValue.SubnetIdInvalid"
INVALIDPARAMETERVALUE_SUBNETNOTBELONGTOZONE = "InvalidParameterValue.SubnetNotBelongToZone"
INVALIDPARAMETERVALUE_VPCIDINVALID = "InvalidParameterValue.VpcIdInvalid"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

type ClusterInfo 

type ClusterInfo struct {

	// Cluster ID
	ClusterId *int64 `json:"ClusterId,omitempty" name:"ClusterId"`

	// Cluster name
	ClusterName *string `json:"ClusterName,omitempty" name:"ClusterName"`

	// The cluster’s maximum disk capacity in GB
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	MaxDiskSize *int64 `json:"MaxDiskSize,omitempty" name:"MaxDiskSize"`

	// The cluster’s maximum bandwidth in MB/s
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	MaxBandWidth *int64 `json:"MaxBandWidth,omitempty" name:"MaxBandWidth"`

	// The cluster’s available disk capacity in GB
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	AvailableDiskSize *int64 `json:"AvailableDiskSize,omitempty" name:"AvailableDiskSize"`

	// The cluster’s available bandwidth in MB/s
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	AvailableBandWidth *int64 `json:"AvailableBandWidth,omitempty" name:"AvailableBandWidth"`

	// The AZ where the cluster resides
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	ZoneId *int64 `json:"ZoneId,omitempty" name:"ZoneId"`

	// The AZ where the cluster nodes reside. If the cluster is a multi-AZ cluster, this field means multiple AZs where the cluster nodes reside.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	ZoneIds []*int64 `json:"ZoneIds,omitempty" name:"ZoneIds"`
}

type Config 

type Config struct {

	// Message retention period
	// Note: this field may return null, indicating that no valid values can be obtained.
	Retention *int64 `json:"Retention,omitempty" name:"Retention"`

	// Minimum number of sync replications
	// Note: this field may return null, indicating that no valid values can be obtained.
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitempty" name:"MinInsyncReplicas"`

	// Log cleanup mode. Default value: delete.
	// delete: logs will be deleted by save time; compact: logs will be compressed by key; compact, delete: logs will be compressed by key and deleted by save time.
	// Note: this field may return null, indicating that no valid values can be obtained.
	CleanUpPolicy *string `json:"CleanUpPolicy,omitempty" name:"CleanUpPolicy"`

	// Segment rolling duration
	// Note: this field may return null, indicating that no valid values can be obtained.
	SegmentMs *int64 `json:"SegmentMs,omitempty" name:"SegmentMs"`

	// 0: false, 1: true.
	// Note: this field may return null, indicating that no valid values can be obtained.
	UncleanLeaderElectionEnable *int64 `json:"UncleanLeaderElectionEnable,omitempty" name:"UncleanLeaderElectionEnable"`

	// Number of bytes for segment rolling
	// Note: this field may return null, indicating that no valid values can be obtained.
	SegmentBytes *int64 `json:"SegmentBytes,omitempty" name:"SegmentBytes"`

	// Maximum number of message bytes
	// Note: this field may return null, indicating that no valid values can be obtained.
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitempty" name:"MaxMessageBytes"`
}

type ConsumerGroup 

type ConsumerGroup struct {

	// User group name
	ConsumerGroupName *string `json:"ConsumerGroupName,omitempty" name:"ConsumerGroupName"`

	// Subscribed message entity
	SubscribedInfo []*SubscribedInfo `json:"SubscribedInfo,omitempty" name:"SubscribedInfo"`
}

type ConsumerGroupResponse 

type ConsumerGroupResponse struct {

	// Number of eligible consumer groups
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// Topic list
	// Note: this field may return null, indicating that no valid values can be obtained.
	TopicList []*ConsumerGroupTopic `json:"TopicList,omitempty" name:"TopicList"`

	// Consumer group list
	// Note: this field may return null, indicating that no valid values can be obtained.
	GroupList []*ConsumerGroup `json:"GroupList,omitempty" name:"GroupList"`

	// Total number of partitions
	// Note: this field may return null, indicating that no valid values can be obtained.
	TotalPartition *int64 `json:"TotalPartition,omitempty" name:"TotalPartition"`

	// List of monitored partitions
	// Note: this field may return null, indicating that no valid values can be obtained.
	PartitionListForMonitor []*Partition `json:"PartitionListForMonitor,omitempty" name:"PartitionListForMonitor"`

	// Total number of topics
	// Note: this field may return null, indicating that no valid values can be obtained.
	TotalTopic *int64 `json:"TotalTopic,omitempty" name:"TotalTopic"`

	// List of monitored topics
	// Note: this field may return null, indicating that no valid values can be obtained.
	TopicListForMonitor []*ConsumerGroupTopic `json:"TopicListForMonitor,omitempty" name:"TopicListForMonitor"`

	// List of monitored groups
	// Note: this field may return null, indicating that no valid values can be obtained.
	GroupListForMonitor []*Group `json:"GroupListForMonitor,omitempty" name:"GroupListForMonitor"`
}

type ConsumerGroupTopic 

type ConsumerGroupTopic struct {

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`
}

type ConsumerRecord 

type ConsumerRecord struct {

	// Topic name
	Topic *string `json:"Topic,omitempty" name:"Topic"`

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

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

	// Message key
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Key *string `json:"Key,omitempty" name:"Key"`

	// Message value
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Value *string `json:"Value,omitempty" name:"Value"`

	// Message timestamp
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Timestamp *int64 `json:"Timestamp,omitempty" name:"Timestamp"`
}

type CreateAclRequest 

type CreateAclRequest struct {
	*tchttp.BaseRequest

	// Instance ID information
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only `TOPIC` is available, and other fields will be used for future ACLs compatible with open-source Kafka
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// ACL operation mode. 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"`

	// Permission type. 0: UNKNOWN, 1: ANY, 2: DENY, 3: ALLOW. Currently, CKafka supports `ALLOW` (equivalent to allowlist), and other fields will be used for future ACLs compatible with open-source Kafka
	PermissionType *int64 `json:"PermissionType,omitempty" name:"PermissionType"`

	// Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this
	Host *string `json:"Host,omitempty" name:"Host"`

	// The list of users allowed to access the topic. Default: User:*, meaning all users. The current user must be in the user list. Add `User:` before the user name (`User:A` for example).
	Principal *string `json:"Principal,omitempty" name:"Principal"`

	// The resource name list, which is in JSON string format. Either `ResourceName` or `resourceNameList` can be specified.
	ResourceNameList *string `json:"ResourceNameList,omitempty" name:"ResourceNameList"`
}

func NewCreateAclRequest 

func NewCreateAclRequest() (request *CreateAclRequest)

func (*CreateAclRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAclRequest) ToJsonString 

func (r *CreateAclRequest) ToJsonString() string

type CreateAclResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateAclResponse) ToJsonString 

func (r *CreateAclResponse) ToJsonString() string

type CreatePartitionRequest 

type CreatePartitionRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Number of topic partitions
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`
}

func NewCreatePartitionRequest 

func NewCreatePartitionRequest() (request *CreatePartitionRequest)

func (*CreatePartitionRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreatePartitionRequest) ToJsonString 

func (r *CreatePartitionRequest) ToJsonString() string

type CreatePartitionResponse 

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

		// Returned result set
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreatePartitionResponse) ToJsonString 

func (r *CreatePartitionResponse) ToJsonString() string

type CreateTopicIpWhiteListRequest 

type CreateTopicIpWhiteListRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// IP allowlist list
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList"`
}

func NewCreateTopicIpWhiteListRequest 

func NewCreateTopicIpWhiteListRequest() (request *CreateTopicIpWhiteListRequest)

func (*CreateTopicIpWhiteListRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateTopicIpWhiteListRequest) ToJsonString 

func (r *CreateTopicIpWhiteListRequest) ToJsonString() string

type CreateTopicIpWhiteListResponse 

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

		// Result of deleting topic IP allowlist
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateTopicIpWhiteListResponse) ToJsonString 

func (r *CreateTopicIpWhiteListResponse) ToJsonString() string

type CreateTopicRequest 

type CreateTopicRequest struct {
	*tchttp.BaseRequest

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

	// Topic name string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Number of partitions, which should be greater than 0
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`

	// Number of replicas, which cannot be higher than the number of brokers. Maximum value: 3
	ReplicaNum *int64 `json:"ReplicaNum,omitempty" name:"ReplicaNum"`

	// IP allowlist switch. 1: enabled, 0: disabled. Default value: 0
	EnableWhiteList *int64 `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// IP allowlist list for quota limit, which is required if `enableWhileList` is 1
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList"`

	// Log cleanup policy, which is `delete` by default. `delete`: logs will be deleted by save time; `compact`: logs will be compressed by key; `compact, delete`: logs will be compressed by key and deleted by save time.
	CleanUpPolicy *string `json:"CleanUpPolicy,omitempty" name:"CleanUpPolicy"`

	// Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)
	Note *string `json:"Note,omitempty" name:"Note"`

	// Default value: 1
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitempty" name:"MinInsyncReplicas"`

	// Whether to allow an unsynced replica to be elected as leader. false: no, true: yes. Default value: false
	UncleanLeaderElectionEnable *int64 `json:"UncleanLeaderElectionEnable,omitempty" name:"UncleanLeaderElectionEnable"`

	// Message retention period in ms, which is optional. The current minimum value is 60,000 ms
	RetentionMs *int64 `json:"RetentionMs,omitempty" name:"RetentionMs"`

	// Segment rolling duration in ms. The current minimum value is 3,600,000 ms
	SegmentMs *int64 `json:"SegmentMs,omitempty" name:"SegmentMs"`

	// Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.
	EnableAclRule *int64 `json:"EnableAclRule,omitempty" name:"EnableAclRule"`

	// Name of the preset ACL rule.
	AclRuleName *string `json:"AclRuleName,omitempty" name:"AclRuleName"`
}

func NewCreateTopicRequest 

func NewCreateTopicRequest() (request *CreateTopicRequest)

func (*CreateTopicRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateTopicRequest) ToJsonString 

func (r *CreateTopicRequest) ToJsonString() string

type CreateTopicResp 

type CreateTopicResp struct {

	// Topic ID
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`
}

type CreateTopicResponse 

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

		// Returned creation result
		Result *CreateTopicResp `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateTopicResponse) ToJsonString 

func (r *CreateTopicResponse) ToJsonString() string

type CreateUserRequest 

type CreateUserRequest struct {
	*tchttp.BaseRequest

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

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`

	// User password
	Password *string `json:"Password,omitempty" name:"Password"`
}

func NewCreateUserRequest 

func NewCreateUserRequest() (request *CreateUserRequest)

func (*CreateUserRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUserRequest) ToJsonString 

func (r *CreateUserRequest) ToJsonString() string

type CreateUserResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateUserResponse) ToJsonString 

func (r *CreateUserResponse) ToJsonString() string

type DeleteAclRequest 

type DeleteAclRequest struct {
	*tchttp.BaseRequest

	// Instance ID information
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only `TOPIC` is available, and other fields will be used for future ACLs compatible with open-source Kafka
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// ACL operation mode. 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. Currently, CKafka only supports `READ` and `WRITE`, and other values will be used for future ACLs compatible with open-source Kafka
	Operation *int64 `json:"Operation,omitempty" name:"Operation"`

	// Permission type. 0: UNKNOWN, 1: ANY, 2: DENY, 3: ALLOW. Currently, CKafka supports `ALLOW` (equivalent to allowlist), and other fields will be used for future ACLs compatible with open-source Kafka
	PermissionType *int64 `json:"PermissionType,omitempty" name:"PermissionType"`

	// The default value is `*`, which means that any host can access. Currently, CKafka does not support the host as `*`, but the future product based on the open-source Kafka will directly support this
	Host *string `json:"Host,omitempty" name:"Host"`

	// User list. The default value is `*`, which means that any user can access. The current user can only be one included in the user list
	Principal *string `json:"Principal,omitempty" name:"Principal"`
}

func NewDeleteAclRequest 

func NewDeleteAclRequest() (request *DeleteAclRequest)

func (*DeleteAclRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAclRequest) ToJsonString 

func (r *DeleteAclRequest) ToJsonString() string

type DeleteAclResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteAclResponse) ToJsonString 

func (r *DeleteAclResponse) ToJsonString() string

type DeleteRouteTriggerTimeRequest 

type DeleteRouteTriggerTimeRequest struct {
	*tchttp.BaseRequest

	// Modification time.
	DelayTime *string `json:"DelayTime,omitempty" name:"DelayTime"`
}

func NewDeleteRouteTriggerTimeRequest 

func NewDeleteRouteTriggerTimeRequest() (request *DeleteRouteTriggerTimeRequest)

func (*DeleteRouteTriggerTimeRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRouteTriggerTimeRequest) ToJsonString 

func (r *DeleteRouteTriggerTimeRequest) ToJsonString() string

type DeleteRouteTriggerTimeResponse 

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

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDeleteRouteTriggerTimeResponse 

func NewDeleteRouteTriggerTimeResponse() (response *DeleteRouteTriggerTimeResponse)

func (*DeleteRouteTriggerTimeResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteRouteTriggerTimeResponse) ToJsonString 

func (r *DeleteRouteTriggerTimeResponse) ToJsonString() string

type DeleteTopicIpWhiteListRequest 

type DeleteTopicIpWhiteListRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// IP allowlist list
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList"`
}

func NewDeleteTopicIpWhiteListRequest 

func NewDeleteTopicIpWhiteListRequest() (request *DeleteTopicIpWhiteListRequest)

func (*DeleteTopicIpWhiteListRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteTopicIpWhiteListRequest) ToJsonString 

func (r *DeleteTopicIpWhiteListRequest) ToJsonString() string

type DeleteTopicIpWhiteListResponse 

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

		// Result of deleting topic IP allowlist
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteTopicIpWhiteListResponse) ToJsonString 

func (r *DeleteTopicIpWhiteListResponse) ToJsonString() string

type DeleteTopicRequest 

type DeleteTopicRequest struct {
	*tchttp.BaseRequest

	// CKafka instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// CKafka topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`
}

func NewDeleteTopicRequest 

func NewDeleteTopicRequest() (request *DeleteTopicRequest)

func (*DeleteTopicRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteTopicRequest) ToJsonString 

func (r *DeleteTopicRequest) ToJsonString() string

type DeleteTopicResponse 

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

		// Returned result set
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteTopicResponse) ToJsonString 

func (r *DeleteTopicResponse) ToJsonString() string

type DeleteUserRequest 

type DeleteUserRequest struct {
	*tchttp.BaseRequest

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

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`
}

func NewDeleteUserRequest 

func NewDeleteUserRequest() (request *DeleteUserRequest)

func (*DeleteUserRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUserRequest) ToJsonString 

func (r *DeleteUserRequest) ToJsonString() string

type DeleteUserResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteUserResponse) ToJsonString 

func (r *DeleteUserResponse) ToJsonString() string

type DescribeACLRequest 

type DescribeACLRequest struct {
	*tchttp.BaseRequest

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

	// ACL resource type. 0: UNKNOWN, 1: ANY, 2: TOPIC, 3: GROUP, 4: CLUSTER, 5: TRANSACTIONAL_ID. Currently, only `TOPIC` is available, and other fields will be used for future ACLs compatible with open-source Kafka
	ResourceType *int64 `json:"ResourceType,omitempty" name:"ResourceType"`

	// Resource name, which is related to `resourceType`. For example, if `resourceType` is `TOPIC`, this field indicates the topic name; if `resourceType` is `GROUP`, this field indicates the group name
	ResourceName *string `json:"ResourceName,omitempty" name:"ResourceName"`

	// Offset position
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Quantity limit
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Keyword match
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`
}

func NewDescribeACLRequest 

func NewDescribeACLRequest() (request *DescribeACLRequest)

func (*DescribeACLRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeACLRequest) ToJsonString 

func (r *DescribeACLRequest) ToJsonString() string

type DescribeACLResponse 

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

		// Returned ACL result set object
		Result *AclResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeACLResponse) ToJsonString 

func (r *DescribeACLResponse) ToJsonString() string

type DescribeAppInfoRequest 

type DescribeAppInfoRequest struct {
	*tchttp.BaseRequest

	// Offset position
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Maximum number of users to be queried in this request. Maximum value: 50. Default value: 50
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeAppInfoRequest 

func NewDescribeAppInfoRequest() (request *DescribeAppInfoRequest)

func (*DescribeAppInfoRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAppInfoRequest) ToJsonString 

func (r *DescribeAppInfoRequest) ToJsonString() string

type DescribeAppInfoResponse 

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

		// Returned list of eligible `AppId`
		Result *AppIdResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeAppInfoResponse) ToJsonString 

func (r *DescribeAppInfoResponse) ToJsonString() string

type DescribeCkafkaZoneRequest 

type DescribeCkafkaZoneRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeCkafkaZoneRequest 

func NewDescribeCkafkaZoneRequest() (request *DescribeCkafkaZoneRequest)

func (*DescribeCkafkaZoneRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCkafkaZoneRequest) ToJsonString 

func (r *DescribeCkafkaZoneRequest) ToJsonString() string

type DescribeCkafkaZoneResponse 

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

		// Returned results for the query
		Result *ZoneResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeCkafkaZoneResponse 

func NewDescribeCkafkaZoneResponse() (response *DescribeCkafkaZoneResponse)

func (*DescribeCkafkaZoneResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeCkafkaZoneResponse) ToJsonString 

func (r *DescribeCkafkaZoneResponse) ToJsonString() string

type DescribeConsumerGroupRequest 

type DescribeConsumerGroupRequest struct {
	*tchttp.BaseRequest

	// CKafka instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Name of the group to be queried, which is optional.
	GroupName *string `json:"GroupName,omitempty" name:"GroupName"`

	// Name of the corresponding topic in the group to be queried, which is optional. If this parameter is specified but `group` is not specified, this parameter will be ignored.
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Number of results to be returned in this request
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Offset position
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}

func NewDescribeConsumerGroupRequest 

func NewDescribeConsumerGroupRequest() (request *DescribeConsumerGroupRequest)

func (*DescribeConsumerGroupRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeConsumerGroupRequest) ToJsonString 

func (r *DescribeConsumerGroupRequest) ToJsonString() string

type DescribeConsumerGroupResponse 

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

		// Returned consumer group information
		Result *ConsumerGroupResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeConsumerGroupResponse) ToJsonString 

func (r *DescribeConsumerGroupResponse) ToJsonString() string

type DescribeGroup 

type DescribeGroup struct {

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

	// Protocol used by the group.
	Protocol *string `json:"Protocol,omitempty" name:"Protocol"`
}

type DescribeGroupInfoRequest 

type DescribeGroupInfoRequest struct {
	*tchttp.BaseRequest

	// (Filter) filter by instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Kafka consumer group (`Consumer-group`), which is an array in the format of `GroupList.0=xxx&GroupList.1=yyy`.
	GroupList []*string `json:"GroupList,omitempty" name:"GroupList"`
}

func NewDescribeGroupInfoRequest 

func NewDescribeGroupInfoRequest() (request *DescribeGroupInfoRequest)

func (*DescribeGroupInfoRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupInfoRequest) ToJsonString 

func (r *DescribeGroupInfoRequest) ToJsonString() string

type DescribeGroupInfoResponse 

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

		// Returned result
		// Note: this field may return null, indicating that no valid values can be obtained.
		Result []*GroupInfoResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupInfoResponse) ToJsonString 

func (r *DescribeGroupInfoResponse) ToJsonString() string

type DescribeGroupOffsetsRequest 

type DescribeGroupOffsetsRequest struct {
	*tchttp.BaseRequest

	// (Filter) filter by instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Kafka consumer group
	Group *string `json:"Group,omitempty" name:"Group"`

	// Array of the names of topics subscribed to by a group. If there is no such array, this parameter means the information of all topics in the specified group
	Topics []*string `json:"Topics,omitempty" name:"Topics"`

	// Fuzzy match by `topicName`
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// Offset position of this query. Default value: 0
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Maximum number of results to be returned in this request. Default value: 50. Maximum value: 50
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeGroupOffsetsRequest 

func NewDescribeGroupOffsetsRequest() (request *DescribeGroupOffsetsRequest)

func (*DescribeGroupOffsetsRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupOffsetsRequest) ToJsonString 

func (r *DescribeGroupOffsetsRequest) ToJsonString() string

type DescribeGroupOffsetsResponse 

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

		// Returned result object
		Result *GroupOffsetResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupOffsetsResponse) ToJsonString 

func (r *DescribeGroupOffsetsResponse) ToJsonString() string

type DescribeGroupRequest 

type DescribeGroupRequest struct {
	*tchttp.BaseRequest

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

	// Search keyword
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

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

	// Maximum number of results to be returned
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeGroupRequest 

func NewDescribeGroupRequest() (request *DescribeGroupRequest)

func (*DescribeGroupRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupRequest) ToJsonString 

func (r *DescribeGroupRequest) ToJsonString() string

type DescribeGroupResponse 

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

		// List of returned results
		Result *GroupResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeGroupResponse) ToJsonString 

func (r *DescribeGroupResponse) ToJsonString() string

type DescribeInstanceAttributesRequest 

type DescribeInstanceAttributesRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceAttributesRequest 

func NewDescribeInstanceAttributesRequest() (request *DescribeInstanceAttributesRequest)

func (*DescribeInstanceAttributesRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceAttributesRequest) ToJsonString 

func (r *DescribeInstanceAttributesRequest) ToJsonString() string

type DescribeInstanceAttributesResponse 

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

		// Returned result object of instance attributes
		Result *InstanceAttributesResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstanceAttributesResponse) ToJsonString 

func (r *DescribeInstanceAttributesResponse) ToJsonString() string

type DescribeInstancesDetailRequest 

type DescribeInstancesDetailRequest struct {
	*tchttp.BaseRequest

	// (Filter) filter by instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// (Filter) filter by instance name. Fuzzy search is supported
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default
	Status []*int64 `json:"Status,omitempty" name:"Status"`

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Tag key match.
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

	// Filter
	Filters []*Filter `json:"Filters,omitempty" name:"Filters"`
}

func NewDescribeInstancesDetailRequest 

func NewDescribeInstancesDetailRequest() (request *DescribeInstancesDetailRequest)

func (*DescribeInstancesDetailRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesDetailRequest) ToJsonString 

func (r *DescribeInstancesDetailRequest) ToJsonString() string

type DescribeInstancesDetailResponse 

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

		// Returned result object of instance details
		Result *InstanceDetailResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesDetailResponse) ToJsonString 

func (r *DescribeInstancesDetailResponse) ToJsonString() string

type DescribeInstancesRequest 

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

	// (Filter) filter by instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// (Filter) filter by instance name. Fuzzy search is supported
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default
	Status []*int64 `json:"Status,omitempty" name:"Status"`

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 100.
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Tag key match.
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`
}

func NewDescribeInstancesRequest 

func NewDescribeInstancesRequest() (request *DescribeInstancesRequest)

func (*DescribeInstancesRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesRequest) ToJsonString 

func (r *DescribeInstancesRequest) ToJsonString() string

type DescribeInstancesResponse 

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

		// Returned result
		Result *InstanceResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesResponse) ToJsonString 

func (r *DescribeInstancesResponse) ToJsonString() string

type DescribeRegionRequest 

type DescribeRegionRequest struct {
	*tchttp.BaseRequest

	// The offset value
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// The maximum number of results returned
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Business field, which can be ignored.
	Business *string `json:"Business,omitempty" name:"Business"`
}

func NewDescribeRegionRequest 

func NewDescribeRegionRequest() (request *DescribeRegionRequest)

func (*DescribeRegionRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRegionRequest) ToJsonString 

func (r *DescribeRegionRequest) ToJsonString() string

type DescribeRegionResponse 

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

		// List of the returned results of enumerated regions
		// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
		Result []*Region `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeRegionResponse 

func NewDescribeRegionResponse() (response *DescribeRegionResponse)

func (*DescribeRegionResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRegionResponse) ToJsonString 

func (r *DescribeRegionResponse) ToJsonString() string

type DescribeRouteRequest 

type DescribeRouteRequest struct {
	*tchttp.BaseRequest

	// Unique instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

func NewDescribeRouteRequest 

func NewDescribeRouteRequest() (request *DescribeRouteRequest)

func (*DescribeRouteRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRouteRequest) ToJsonString 

func (r *DescribeRouteRequest) ToJsonString() string

type DescribeRouteResponse 

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

		// Returned result set of route information
		Result *RouteResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRouteResponse) ToJsonString 

func (r *DescribeRouteResponse) ToJsonString() string

type DescribeTopicAttributesRequest 

type DescribeTopicAttributesRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`
}

func NewDescribeTopicAttributesRequest 

func NewDescribeTopicAttributesRequest() (request *DescribeTopicAttributesRequest)

func (*DescribeTopicAttributesRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicAttributesRequest) ToJsonString 

func (r *DescribeTopicAttributesRequest) ToJsonString() string

type DescribeTopicAttributesResponse 

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

		// Returned result object
		Result *TopicAttributesResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicAttributesResponse) ToJsonString 

func (r *DescribeTopicAttributesResponse) ToJsonString() string

type DescribeTopicDetailRequest 

type DescribeTopicDetailRequest struct {
	*tchttp.BaseRequest

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

	// (Filter) filter by `topicName`. Fuzzy search is supported
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20. This value must be greater than 0
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Name of the preset ACL rule.
	AclRuleName *string `json:"AclRuleName,omitempty" name:"AclRuleName"`
}

func NewDescribeTopicDetailRequest 

func NewDescribeTopicDetailRequest() (request *DescribeTopicDetailRequest)

func (*DescribeTopicDetailRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicDetailRequest) ToJsonString 

func (r *DescribeTopicDetailRequest) ToJsonString() string

type DescribeTopicDetailResponse 

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

		// Returned entity of topic details
		Result *TopicDetailResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicDetailResponse) ToJsonString 

func (r *DescribeTopicDetailResponse) ToJsonString() string

type DescribeTopicRequest 

type DescribeTopicRequest struct {
	*tchttp.BaseRequest

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

	// Filter by `topicName`. Fuzzy search is supported
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Name of the preset ACL rule.
	AclRuleName *string `json:"AclRuleName,omitempty" name:"AclRuleName"`
}

func NewDescribeTopicRequest 

func NewDescribeTopicRequest() (request *DescribeTopicRequest)

func (*DescribeTopicRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicRequest) ToJsonString 

func (r *DescribeTopicRequest) ToJsonString() string

type DescribeTopicResponse 

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

		// Returned result
		// Note: this field may return null, indicating that no valid values can be obtained.
		Result *TopicResult `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicResponse) ToJsonString 

func (r *DescribeTopicResponse) ToJsonString() string

type DescribeTopicSubscribeGroupRequest 

type DescribeTopicSubscribeGroupRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Starting position of paging
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of results per page
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeTopicSubscribeGroupRequest 

func NewDescribeTopicSubscribeGroupRequest() (request *DescribeTopicSubscribeGroupRequest)

func (*DescribeTopicSubscribeGroupRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicSubscribeGroupRequest) ToJsonString 

func (r *DescribeTopicSubscribeGroupRequest) ToJsonString() string

type DescribeTopicSubscribeGroupResponse 

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

		// Returned results
		Result *TopicSubscribeGroup `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTopicSubscribeGroupResponse 

func NewDescribeTopicSubscribeGroupResponse() (response *DescribeTopicSubscribeGroupResponse)

func (*DescribeTopicSubscribeGroupResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicSubscribeGroupResponse) ToJsonString 

func (r *DescribeTopicSubscribeGroupResponse) ToJsonString() string

type DescribeTopicSyncReplicaRequest 

type DescribeTopicSyncReplicaRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Offset. If this parameter is left empty, 0 will be used by default.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20.
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Filters unsynced replicas only
	OutOfSyncReplicaOnly *bool `json:"OutOfSyncReplicaOnly,omitempty" name:"OutOfSyncReplicaOnly"`
}

func NewDescribeTopicSyncReplicaRequest 

func NewDescribeTopicSyncReplicaRequest() (request *DescribeTopicSyncReplicaRequest)

func (*DescribeTopicSyncReplicaRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicSyncReplicaRequest) ToJsonString 

func (r *DescribeTopicSyncReplicaRequest) ToJsonString() string

type DescribeTopicSyncReplicaResponse 

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

		// Returns topic replica details
		Result *TopicInSyncReplicaResult `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewDescribeTopicSyncReplicaResponse 

func NewDescribeTopicSyncReplicaResponse() (response *DescribeTopicSyncReplicaResponse)

func (*DescribeTopicSyncReplicaResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTopicSyncReplicaResponse) ToJsonString 

func (r *DescribeTopicSyncReplicaResponse) ToJsonString() string

type DescribeUserRequest 

type DescribeUserRequest struct {
	*tchttp.BaseRequest

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

	// Filter by name
	SearchWord *string `json:"SearchWord,omitempty" name:"SearchWord"`

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

	// Number of results to be returned in this request
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`
}

func NewDescribeUserRequest 

func NewDescribeUserRequest() (request *DescribeUserRequest)

func (*DescribeUserRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUserRequest) ToJsonString 

func (r *DescribeUserRequest) ToJsonString() string

type DescribeUserResponse 

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

		// Returned result list
		Result *UserResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeUserResponse) ToJsonString 

func (r *DescribeUserResponse) ToJsonString() string

type DynamicRetentionTime 

type DynamicRetentionTime struct {

	// Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Enable *int64 `json:"Enable,omitempty" name:"Enable"`

	// Disk quota threshold (in percentage) for triggering the message retention time change event
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	DiskQuotaPercentage *int64 `json:"DiskQuotaPercentage,omitempty" name:"DiskQuotaPercentage"`

	// Percentage by which the message retention time is shortened each time
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	StepForwardPercentage *int64 `json:"StepForwardPercentage,omitempty" name:"StepForwardPercentage"`

	// Minimum retention time, in minutes
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	BottomRetention *int64 `json:"BottomRetention,omitempty" name:"BottomRetention"`
}

type FetchMessageByOffsetRequest 

type FetchMessageByOffsetRequest struct {
	*tchttp.BaseRequest

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Topic name
	Topic *string `json:"Topic,omitempty" name:"Topic"`

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

	// Offset information
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}

func NewFetchMessageByOffsetRequest 

func NewFetchMessageByOffsetRequest() (request *FetchMessageByOffsetRequest)

func (*FetchMessageByOffsetRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*FetchMessageByOffsetRequest) ToJsonString 

func (r *FetchMessageByOffsetRequest) ToJsonString() string

type FetchMessageByOffsetResponse 

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

		// Returned results
		Result *ConsumerRecord `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `json:"Response"`
}

func NewFetchMessageByOffsetResponse 

func NewFetchMessageByOffsetResponse() (response *FetchMessageByOffsetResponse)

func (*FetchMessageByOffsetResponse) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*FetchMessageByOffsetResponse) ToJsonString 

func (r *FetchMessageByOffsetResponse) ToJsonString() string

type Filter 

type Filter struct {

	// Field to be filtered.
	Name *string `json:"Name,omitempty" name:"Name"`

	// Filter value of field.
	Values []*string `json:"Values,omitempty" name:"Values"`
}

type Group 

type Group struct {

	// Group name
	GroupName *string `json:"GroupName,omitempty" name:"GroupName"`
}

type GroupInfoMember 

type GroupInfoMember struct {

	// Unique ID generated for consumer in consumer group by coordinator
	MemberId *string `json:"MemberId,omitempty" name:"MemberId"`

	// `client.id` information by the client consumer SDK
	ClientId *string `json:"ClientId,omitempty" name:"ClientId"`

	// Generally stores client IP address
	ClientHost *string `json:"ClientHost,omitempty" name:"ClientHost"`

	// Stores the information of partition assigned to this consumer
	Assignment *Assignment `json:"Assignment,omitempty" name:"Assignment"`
}

type GroupInfoResponse 

type GroupInfoResponse struct {

	// Error code. 0: success
	ErrorCode *string `json:"ErrorCode,omitempty" name:"ErrorCode"`

	// Group status description (common valid values: Empty, Stable, Dead):
	// Dead: the consumer group does not exist
	// Empty: there are currently no consumer subscriptions in the consumer group
	// PreparingRebalance: the consumer group is currently in `rebalance` state
	// CompletingRebalance: the consumer group is currently in `rebalance` state
	// Stable: each consumer in the consumer group has joined and is in stable state
	State *string `json:"State,omitempty" name:"State"`

	// The type of protocol selected by the consumer group, which is `consumer` for common consumers. However, some systems use their own protocols; for example, the protocol used by kafka-connect is `connect`. Only with the standard `consumer` protocol can this API get to know the specific assigning method and parse the specific partition assignment
	ProtocolType *string `json:"ProtocolType,omitempty" name:"ProtocolType"`

	// Consumer partition assignment algorithm, such as `range` (which is the default value for the Kafka consumer SDK), `roundrobin`, and `sticky`
	Protocol *string `json:"Protocol,omitempty" name:"Protocol"`

	// This array contains information only if `state` is `Stable` and `protocol_type` is `consumer`
	Members []*GroupInfoMember `json:"Members,omitempty" name:"Members"`

	// Kafka consumer group
	Group *string `json:"Group,omitempty" name:"Group"`
}

type GroupInfoTopics 

type GroupInfoTopics struct {

	// Name of assigned topics
	Topic *string `json:"Topic,omitempty" name:"Topic"`

	// Information of assigned partition
	// Note: this field may return null, indicating that no valid values can be obtained.
	Partitions []*int64 `json:"Partitions,omitempty" name:"Partitions"`
}

type GroupOffsetPartition 

type GroupOffsetPartition struct {

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

	// Offset position submitted by consumer
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// Metadata can be passed in for other purposes when the consumer submits messages. Currently, this parameter is usually an empty string
	// Note: this field may return null, indicating that no valid values can be obtained.
	Metadata *string `json:"Metadata,omitempty" name:"Metadata"`

	// Error code
	ErrorCode *int64 `json:"ErrorCode,omitempty" name:"ErrorCode"`

	// Latest offset of current partition
	LogEndOffset *int64 `json:"LogEndOffset,omitempty" name:"LogEndOffset"`

	// Number of unconsumed messages
	Lag *int64 `json:"Lag,omitempty" name:"Lag"`
}

type GroupOffsetResponse 

type GroupOffsetResponse struct {

	// Total number of eligible results
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// Array of partitions in the topic, where each element is a JSON object
	// Note: this field may return null, indicating that no valid values can be obtained.
	TopicList []*GroupOffsetTopic `json:"TopicList,omitempty" name:"TopicList"`
}

type GroupOffsetTopic 

type GroupOffsetTopic struct {

	// Topic name
	Topic *string `json:"Topic,omitempty" name:"Topic"`

	// Array of partitions in the topic, where each element is a JSON object
	// Note: this field may return null, indicating that no valid values can be obtained.
	Partitions []*GroupOffsetPartition `json:"Partitions,omitempty" name:"Partitions"`
}

type GroupResponse 

type GroupResponse struct {

	// Count
	// Note: this field may return null, indicating that no valid values can be obtained.
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// GroupList
	// Note: this field may return null, indicating that no valid values can be obtained.
	GroupList []*DescribeGroup `json:"GroupList,omitempty" name:"GroupList"`
}

type Instance 

type Instance struct {

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

	// Instance name
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Whether it is an open-source instance. true: yes, false: no
	// Note: this field may return null, indicating that no valid values can be obtained.
	IfCommunity *bool `json:"IfCommunity,omitempty" name:"IfCommunity"`
}

type InstanceAttributesResponse 

type InstanceAttributesResponse struct {

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

	// Instance name
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// VIP list information of access point
	VipList []*VipEntity `json:"VipList,omitempty" name:"VipList"`

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

	// Virtual port
	Vport *string `json:"Vport,omitempty" name:"Vport"`

	// Instance status. 0: creating, 1: running, 2: deleting
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Instance bandwidth in Mbps
	Bandwidth *int64 `json:"Bandwidth,omitempty" name:"Bandwidth"`

	// Instance storage capacity in GB
	DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// AZ
	ZoneId *int64 `json:"ZoneId,omitempty" name:"ZoneId"`

	// VPC ID. If this parameter is empty, it means the basic network
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// Subnet ID. If this parameter is empty, it means the basic network
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Instance health status. 1: healthy, 2: alarmed, 3: exceptional
	Healthy *int64 `json:"Healthy,omitempty" name:"Healthy"`

	// Instance health information. Currently, the disk utilization is displayed with a maximum length of 256
	HealthyMessage *string `json:"HealthyMessage,omitempty" name:"HealthyMessage"`

	// Creation time
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Message retention period in minutes
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitempty" name:"MsgRetentionTime"`

	// Configuration for automatic topic creation. If this field is empty, it means that automatic creation is not enabled
	Config *InstanceConfigDO `json:"Config,omitempty" name:"Config"`

	// Number of remaining creatable partitions
	RemainderPartitions *int64 `json:"RemainderPartitions,omitempty" name:"RemainderPartitions"`

	// Number of remaining creatable topics
	RemainderTopics *int64 `json:"RemainderTopics,omitempty" name:"RemainderTopics"`

	// Number of partitions already created
	CreatedPartitions *int64 `json:"CreatedPartitions,omitempty" name:"CreatedPartitions"`

	// Number of topics already created
	CreatedTopics *int64 `json:"CreatedTopics,omitempty" name:"CreatedTopics"`

	// Tag array
	// Note: this field may return null, indicating that no valid values can be obtained.
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`

	// Expiration time
	// Note: this field may return null, indicating that no valid values can be obtained.
	ExpireTime *uint64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// Cross-AZ
	// Note: this field may return null, indicating that no valid values can be obtained.
	ZoneIds []*int64 `json:"ZoneIds,omitempty" name:"ZoneIds"`

	// Kafka version information
	// Note: this field may return null, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitempty" name:"Version"`

	// Maximum number of groups
	// Note: this field may return null, indicating that no valid values can be obtained.
	MaxGroupNum *int64 `json:"MaxGroupNum,omitempty" name:"MaxGroupNum"`

	// Offering type. `0`: Standard Edition; `1`: Professional Edition
	// Note: this field may return `null`, indicating that no valid value was found.
	Cvm *int64 `json:"Cvm,omitempty" name:"Cvm"`

	// Type.
	// Note: this field may return `null`, indicating that no valid value was found.
	InstanceType *string `json:"InstanceType,omitempty" name:"InstanceType"`

	// Features supported by the instance. `FEATURE_SUBNET_ACL` indicates that the ACL policy supports setting subnets.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Features []*string `json:"Features,omitempty" name:"Features"`

	// Dynamic message retention policy
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	RetentionTimeConfig *DynamicRetentionTime `json:"RetentionTimeConfig,omitempty" name:"RetentionTimeConfig"`

	// Maximum number of connections
	// Note: this field may return null, indicating that no valid values can be obtained.
	MaxConnection *uint64 `json:"MaxConnection,omitempty" name:"MaxConnection"`

	// Public network bandwidth
	// Note: this field may return null, indicating that no valid values can be obtained.
	PublicNetwork *int64 `json:"PublicNetwork,omitempty" name:"PublicNetwork"`

	// Time
	// Note: this field may return null, indicating that no valid values can be obtained.
	DeleteRouteTimestamp *string `json:"DeleteRouteTimestamp,omitempty" name:"DeleteRouteTimestamp"`
}

type InstanceConfigDO 

type InstanceConfigDO struct {

	// Whether to create topics automatically
	AutoCreateTopicsEnable *bool `json:"AutoCreateTopicsEnable,omitempty" name:"AutoCreateTopicsEnable"`

	// Number of partitions
	DefaultNumPartitions *int64 `json:"DefaultNumPartitions,omitempty" name:"DefaultNumPartitions"`

	// Default replication factor
	DefaultReplicationFactor *int64 `json:"DefaultReplicationFactor,omitempty" name:"DefaultReplicationFactor"`
}

type InstanceDetail 

type InstanceDetail struct {

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

	// Instance name
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// Instance VIP information
	Vip *string `json:"Vip,omitempty" name:"Vip"`

	// Instance port information
	Vport *string `json:"Vport,omitempty" name:"Vport"`

	// Virtual IP list
	VipList []*VipEntity `json:"VipList,omitempty" name:"VipList"`

	// Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Instance bandwidth in Mbps
	Bandwidth *int64 `json:"Bandwidth,omitempty" name:"Bandwidth"`

	// Instance storage capacity in GB
	DiskSize *int64 `json:"DiskSize,omitempty" name:"DiskSize"`

	// AZ ID
	ZoneId *int64 `json:"ZoneId,omitempty" name:"ZoneId"`

	// vpcId. If this parameter is empty, it means the basic network
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// Subnet ID
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Whether to renew the instance automatically, which is an int-type enumerated value. 1: yes, 2: no
	RenewFlag *int64 `json:"RenewFlag,omitempty" name:"RenewFlag"`

	// Instance status, which is an int-type value. 0: healthy, 1: alarmed, 2: exceptional
	Healthy *int64 `json:"Healthy,omitempty" name:"Healthy"`

	// Instance status information
	HealthyMessage *string `json:"HealthyMessage,omitempty" name:"HealthyMessage"`

	// Instance creation time
	CreateTime *int64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Instance expiration time
	ExpireTime *int64 `json:"ExpireTime,omitempty" name:"ExpireTime"`

	// Whether it is an internal customer. 1: yes
	IsInternal *int64 `json:"IsInternal,omitempty" name:"IsInternal"`

	// Number of topics
	TopicNum *int64 `json:"TopicNum,omitempty" name:"TopicNum"`

	// Tag
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`

	// Kafka version information
	// Note: this field may return null, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitempty" name:"Version"`

	// Cross-AZ
	// Note: this field may return null, indicating that no valid values can be obtained.
	ZoneIds []*int64 `json:"ZoneIds,omitempty" name:"ZoneIds"`

	// CKafka sale type
	// Note: this field may return null, indicating that no valid values can be obtained.
	Cvm *int64 `json:"Cvm,omitempty" name:"Cvm"`

	// CKafka instance type
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	InstanceType *string `json:"InstanceType,omitempty" name:"InstanceType"`

	// Disk type
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	DiskType *string `json:"DiskType,omitempty" name:"DiskType"`

	// Maximum number of topics for the current instance
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	MaxTopicNumber *int64 `json:"MaxTopicNumber,omitempty" name:"MaxTopicNumber"`

	// Maximum number of partitions for the current instance
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	MaxPartitionNumber *int64 `json:"MaxPartitionNumber,omitempty" name:"MaxPartitionNumber"`

	// Time of scheduled upgrade
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	RebalanceTime *string `json:"RebalanceTime,omitempty" name:"RebalanceTime"`
}

type InstanceDetailResponse 

type InstanceDetailResponse struct {

	// Total number of eligible instances
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// List of eligible instance details
	InstanceList []*InstanceDetail `json:"InstanceList,omitempty" name:"InstanceList"`
}

type InstanceResponse 

type InstanceResponse struct {

	// List of eligible instances
	// Note: this field may return null, indicating that no valid values can be obtained.
	InstanceList []*Instance `json:"InstanceList,omitempty" name:"InstanceList"`

	// Total number of eligible results
	// Note: this field may return null, indicating that no valid values can be obtained.
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type JgwOperateResponse 

type JgwOperateResponse struct {

	// Returned code. 0: normal, other values: error
	ReturnCode *string `json:"ReturnCode,omitempty" name:"ReturnCode"`

	// Success message
	ReturnMessage *string `json:"ReturnMessage,omitempty" name:"ReturnMessage"`

	// Data returned by an operation, which may contain `flowId`, etc.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Data *OperateResponseData `json:"Data,omitempty" name:"Data"`
}

type ModifyGroupOffsetsRequest 

type ModifyGroupOffsetsRequest struct {
	*tchttp.BaseRequest

	// Kafka instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Kafka consumer group
	Group *string `json:"Group,omitempty" name:"Group"`

	// Offset resetting policy. Meanings of the input parameters: 0: equivalent to the `shift-by` parameter, which indicates to shift the offset forward or backward by the value of the `shift`. 1: equivalent to `by-duration`, `to-datetime`, `to-earliest`, or `to-latest`, which indicates to move the offset to the specified timestamp. 2: equivalent to `to-offset`, which indicates to move the offset to the specified offset position
	Strategy *int64 `json:"Strategy,omitempty" name:"Strategy"`

	// Indicates the topics to be reset. If this parameter is left empty, all topics will be reset
	Topics []*string `json:"Topics,omitempty" name:"Topics"`

	// When `strategy` is 0, this field is required. If it is above zero, the offset will be shifted backward by the value of the `shift`. If it is below zero, the offset will be shifted forward by the value of the `shift`. After a correct reset, the new offset should be (old_offset + shift). Note that if the new offset is smaller than the `earliest` parameter of the partition, it will be set to `earliest`, and if it is greater than the `latest` parameter of the partition, it will be set to `latest`
	Shift *int64 `json:"Shift,omitempty" name:"Shift"`

	// Unit: ms. When `strategy` is 1, this field is required, where -2 indicates to reset the offset to the initial position, -1 indicates to reset to the latest position (equivalent to emptying), and other values represent the specified time, i.e., the offset of the topic at the specified time will be obtained and then reset. Note that if there is no message at the specified time, the last offset will be obtained
	ShiftTimestamp *int64 `json:"ShiftTimestamp,omitempty" name:"ShiftTimestamp"`

	// Position of the offset that needs to be reset. When `strategy` is 2, this field is required
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// List of partitions that need to be reset. If the topics parameter is not specified, reset partitions in the corresponding partition list of all topics. If the topics parameter is specified, reset partitions of the corresponding partition list of the specified topic list.
	Partitions []*int64 `json:"Partitions,omitempty" name:"Partitions"`
}

func NewModifyGroupOffsetsRequest 

func NewModifyGroupOffsetsRequest() (request *ModifyGroupOffsetsRequest)

func (*ModifyGroupOffsetsRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyGroupOffsetsRequest) ToJsonString 

func (r *ModifyGroupOffsetsRequest) ToJsonString() string

type ModifyGroupOffsetsResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyGroupOffsetsResponse) ToJsonString 

func (r *ModifyGroupOffsetsResponse) ToJsonString() string

type ModifyInstanceAttributesConfig 

type ModifyInstanceAttributesConfig struct {

	// Automatic creation. true: enabled, false: not enabled
	AutoCreateTopicEnable *bool `json:"AutoCreateTopicEnable,omitempty" name:"AutoCreateTopicEnable"`

	// Optional. If `auto.create.topic.enable` is set to `true` and this value is not set, 3 will be used by default
	DefaultNumPartitions *int64 `json:"DefaultNumPartitions,omitempty" name:"DefaultNumPartitions"`

	// If `auto.create.topic.enable` is set to `true` but this value is not set, 2 will be used by default
	DefaultReplicationFactor *int64 `json:"DefaultReplicationFactor,omitempty" name:"DefaultReplicationFactor"`
}

type ModifyInstanceAttributesRequest 

type ModifyInstanceAttributesRequest struct {
	*tchttp.BaseRequest

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

	// Maximum retention period in minutes for instance log, which can be up to 30 days. 0 indicates not to enable the log retention period policy
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitempty" name:"MsgRetentionTime"`

	// Instance name string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// Instance configuration
	Config *ModifyInstanceAttributesConfig `json:"Config,omitempty" name:"Config"`

	// Dynamic message retention policy configuration
	DynamicRetentionConfig *DynamicRetentionTime `json:"DynamicRetentionConfig,omitempty" name:"DynamicRetentionConfig"`

	// Modification of the rebalancing time after upgrade
	RebalanceTime *int64 `json:"RebalanceTime,omitempty" name:"RebalanceTime"`

	// Timestamp
	PublicNetwork *int64 `json:"PublicNetwork,omitempty" name:"PublicNetwork"`
}

func NewModifyInstanceAttributesRequest 

func NewModifyInstanceAttributesRequest() (request *ModifyInstanceAttributesRequest)

func (*ModifyInstanceAttributesRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInstanceAttributesRequest) ToJsonString 

func (r *ModifyInstanceAttributesRequest) ToJsonString() string

type ModifyInstanceAttributesResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyInstanceAttributesResponse) ToJsonString 

func (r *ModifyInstanceAttributesResponse) ToJsonString() string

type ModifyPasswordRequest 

type ModifyPasswordRequest struct {
	*tchttp.BaseRequest

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

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`

	// Current user password
	Password *string `json:"Password,omitempty" name:"Password"`

	// New user password
	PasswordNew *string `json:"PasswordNew,omitempty" name:"PasswordNew"`
}

func NewModifyPasswordRequest 

func NewModifyPasswordRequest() (request *ModifyPasswordRequest)

func (*ModifyPasswordRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyPasswordRequest) ToJsonString 

func (r *ModifyPasswordRequest) ToJsonString() string

type ModifyPasswordResponse 

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

		// Returned result
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyPasswordResponse) ToJsonString 

func (r *ModifyPasswordResponse) ToJsonString() string

type ModifyTopicAttributesRequest 

type ModifyTopicAttributesRequest struct {
	*tchttp.BaseRequest

	// Instance ID.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Topic name.
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`).
	Note *string `json:"Note,omitempty" name:"Note"`

	// IP allowlist switch. 1: enabled, 0: disabled.
	EnableWhiteList *int64 `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// Default value: 1.
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitempty" name:"MinInsyncReplicas"`

	// 0: false, 1: true. Default value: 0.
	UncleanLeaderElectionEnable *int64 `json:"UncleanLeaderElectionEnable,omitempty" name:"UncleanLeaderElectionEnable"`

	// Message retention period in ms. The current minimum value is 60,000 ms.
	RetentionMs *int64 `json:"RetentionMs,omitempty" name:"RetentionMs"`

	// Segment rolling duration in ms. The current minimum value is 86,400,000 ms.
	SegmentMs *int64 `json:"SegmentMs,omitempty" name:"SegmentMs"`

	// Maximum topic message length in bytes. The maximum value is 8,388,608 bytes (i.e., 8 MB).
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitempty" name:"MaxMessageBytes"`

	// Message deletion policy. Valid values: delete, compact
	CleanUpPolicy *string `json:"CleanUpPolicy,omitempty" name:"CleanUpPolicy"`

	// IP allowlist, which is required if the value of `enableWhileList` is 1.
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList"`

	// Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.
	EnableAclRule *int64 `json:"EnableAclRule,omitempty" name:"EnableAclRule"`

	// Name of the preset ACL rule.
	AclRuleName *string `json:"AclRuleName,omitempty" name:"AclRuleName"`
}

func NewModifyTopicAttributesRequest 

func NewModifyTopicAttributesRequest() (request *ModifyTopicAttributesRequest)

func (*ModifyTopicAttributesRequest) FromJsonString 

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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyTopicAttributesRequest) ToJsonString 

func (r *ModifyTopicAttributesRequest) ToJsonString() string

type ModifyTopicAttributesResponse 

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

		// Returned result set
		Result *JgwOperateResponse `json:"Result,omitempty" name:"Result"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		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

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyTopicAttributesResponse) ToJsonString 

func (r *ModifyTopicAttributesResponse) ToJsonString() string

type OperateResponseData 

type OperateResponseData struct {

	// FlowId11
	// Note: this field may return null, indicating that no valid values can be obtained.
	FlowId *int64 `json:"FlowId,omitempty" name:"FlowId"`
}

type Partition 

type Partition struct {

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

type PartitionOffset 

type PartitionOffset struct {

	// Partition, such as "0" or "1"
	// Note: this field may return null, indicating that no valid values can be obtained.
	Partition *string `json:"Partition,omitempty" name:"Partition"`

	// Offset, such as 100
	// Note: this field may return null, indicating that no valid values can be obtained.
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`
}

type Price 

type Price struct {

	// Discounted price
	RealTotalCost *float64 `json:"RealTotalCost,omitempty" name:"RealTotalCost"`

	// Original price
	TotalCost *float64 `json:"TotalCost,omitempty" name:"TotalCost"`
}

type Region 

type Region struct {

	// Region ID
	RegionId *int64 `json:"RegionId,omitempty" name:"RegionId"`

	// Region name
	RegionName *string `json:"RegionName,omitempty" name:"RegionName"`

	// Area name
	AreaName *string `json:"AreaName,omitempty" name:"AreaName"`

	// Region code
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	RegionCode *string `json:"RegionCode,omitempty" name:"RegionCode"`

	// Region code (v3)
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	RegionCodeV3 *string `json:"RegionCodeV3,omitempty" name:"RegionCodeV3"`

	// NONE: no special models are supported by default.\nCVM: the CVM type is supported.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Support *string `json:"Support,omitempty" name:"Support"`

	// Whether IPv6 is supported. `0` indicates no, and `1` indicates yes.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Ipv6 *int64 `json:"Ipv6,omitempty" name:"Ipv6"`

	// Whether cross-AZ clusters are supported.`0` indicates no, and `1` indicates yes.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	MultiZone *int64 `json:"MultiZone,omitempty" name:"MultiZone"`
}

type Route 

type Route struct {

	// Instance connection method
	// 0: PLAINTEXT (plaintext method, which does not carry user information and is supported for legacy versions and Community Edition)
	// 1: SASL_PLAINTEXT (plaintext method, which authenticates the login through SASL before data start and is supported only for Community Edition)
	// 2: SSL (SSL-encrypted communication, which does not carry user information and is supported for legacy versions and Community Edition)
	// 3: SASL_SSL (SSL-encrypted communication, which authenticates the login through SASL before data start and is supported only for Community Edition)
	AccessType *int64 `json:"AccessType,omitempty" name:"AccessType"`

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

	// VIP network type (1: public network TGW; 2: classic network; 3: VPC; 4: supporting network (Standard Edition); 5: SSL public network access; 6: BM VPC; 7: supporting network (Pro Edition))
	VipType *int64 `json:"VipType,omitempty" name:"VipType"`

	// Virtual IP list
	VipList []*VipEntity `json:"VipList,omitempty" name:"VipList"`

	// Domain name
	// Note: this field may return null, indicating that no valid values can be obtained.
	Domain *string `json:"Domain,omitempty" name:"Domain"`

	// Domain name port
	// Note: this field may return null, indicating that no valid values can be obtained.
	DomainPort *int64 `json:"DomainPort,omitempty" name:"DomainPort"`

	// Timestamp
	// Note: this field may return null, indicating that no valid values can be obtained.
	DeleteTimestamp *string `json:"DeleteTimestamp,omitempty" name:"DeleteTimestamp"`
}

type RouteResponse 

type RouteResponse struct {

	// Route information list
	// Note: this field may return null, indicating that no valid values can be obtained.
	Routers []*Route `json:"Routers,omitempty" name:"Routers"`
}

type SaleInfo 

type SaleInfo struct {

	// Manually set flag.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Flag *bool `json:"Flag,omitempty" name:"Flag"`

	// CKafka version (v1.1.1/2.4.2/0.10.2）
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitempty" name:"Version"`

	// Whether it is Pro Edition or Standard Edition.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Platform *string `json:"Platform,omitempty" name:"Platform"`

	// Whether it has been sold out. `true`: sold out.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SoldOut *bool `json:"SoldOut,omitempty" name:"SoldOut"`
}

type SubscribedInfo 

type SubscribedInfo struct {

	// Subscribed topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Subscribed partition
	// Note: this field may return null, indicating that no valid values can be obtained.
	Partition []*int64 `json:"Partition,omitempty" name:"Partition"`

	// Partition offset information
	// Note: this field may return null, indicating that no valid values can be obtained.
	PartitionOffset []*PartitionOffset `json:"PartitionOffset,omitempty" name:"PartitionOffset"`

	// ID of the subscribed topic.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TopicId *string `json:"TopicId,omitempty" name:"TopicId"`
}

type Tag 

type Tag struct {

	// Tag key
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

	// Tag value
	TagValue *string `json:"TagValue,omitempty" name:"TagValue"`
}

type Topic 

type Topic struct {

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

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

	// Remarks
	// Note: this field may return null, indicating that no valid values can be obtained.
	Note *string `json:"Note,omitempty" name:"Note"`
}

type TopicAttributesResponse 

type TopicAttributesResponse struct {

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

	// Creation time
	CreateTime *int64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Topic remarks
	// Note: this field may return null, indicating that no valid values can be obtained.
	Note *string `json:"Note,omitempty" name:"Note"`

	// Number of partitions
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`

	// IP allowlist switch. 1: enabled, 0: disabled
	EnableWhiteList *int64 `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// IP allowlist list
	IpWhiteList []*string `json:"IpWhiteList,omitempty" name:"IpWhiteList"`

	// Topic configuration array
	Config *Config `json:"Config,omitempty" name:"Config"`

	// Partition details
	Partitions []*TopicPartitionDO `json:"Partitions,omitempty" name:"Partitions"`

	// Switch of the preset ACL rule. `1`: enable, `0`: disable.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	EnableAclRule *int64 `json:"EnableAclRule,omitempty" name:"EnableAclRule"`

	// Preset ACL rule list.
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	AclRuleList []*AclRule `json:"AclRuleList,omitempty" name:"AclRuleList"`
}

type TopicDetail 

type TopicDetail struct {

	// Topic name
	TopicName *string `json:"TopicName,omitempty" name:"TopicName"`

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

	// Number of partitions
	PartitionNum *int64 `json:"PartitionNum,omitempty" name:"PartitionNum"`

	// Number of replicas
	ReplicaNum *int64 `json:"ReplicaNum,omitempty" name:"ReplicaNum"`

	// Remarks
	// Note: this field may return null, indicating that no valid values can be obtained.
	Note *string `json:"Note,omitempty" name:"Note"`

	// Creation time
	CreateTime *int64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Whether to enable IP authentication allowlist. true: yes, false: no
	EnableWhiteList *bool `json:"EnableWhiteList,omitempty" name:"EnableWhiteList"`

	// Number of IPs in IP allowlist
	IpWhiteListCount *int64 `json:"IpWhiteListCount,omitempty" name:"IpWhiteListCount"`

	// COS bucket for data backup: address of the destination COS bucket
	// Note: this field may return null, indicating that no valid values can be obtained.
	ForwardCosBucket *string `json:"ForwardCosBucket,omitempty" name:"ForwardCosBucket"`

	// Status of data backup to COS. 1: not enabled, 0: enabled
	ForwardStatus *int64 `json:"ForwardStatus,omitempty" name:"ForwardStatus"`

	// Frequency of data backup to COS
	ForwardInterval *int64 `json:"ForwardInterval,omitempty" name:"ForwardInterval"`

	// Advanced configuration
	// Note: this field may return null, indicating that no valid values can be obtained.
	Config *Config `json:"Config,omitempty" name:"Config"`

	// Message retention time configuration (for recording the latest retention time)
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	RetentionTimeConfig *TopicRetentionTimeConfigRsp `json:"RetentionTimeConfig,omitempty" name:"RetentionTimeConfig"`

	// `0`: normal, `1`: deleted, `2`: deleting
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Status *int64 `json:"Status,omitempty" name:"Status"`
}

type TopicDetailResponse 

type TopicDetailResponse struct {

	// List of returned topic details
	// Note: this field may return null, indicating that no valid values can be obtained.
	TopicList []*TopicDetail `json:"TopicList,omitempty" name:"TopicList"`

	// Number of all eligible topic details
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type TopicInSyncReplicaInfo 

type TopicInSyncReplicaInfo struct {

	// Partition name
	Partition *string `json:"Partition,omitempty" name:"Partition"`

	// Leader ID
	Leader *uint64 `json:"Leader,omitempty" name:"Leader"`

	// Replica set
	Replica *string `json:"Replica,omitempty" name:"Replica"`

	// ISR
	InSyncReplica *string `json:"InSyncReplica,omitempty" name:"InSyncReplica"`

	// Starting offset
	// Note: this field may return null, indicating that no valid values can be obtained.
	BeginOffset *uint64 `json:"BeginOffset,omitempty" name:"BeginOffset"`

	// Ending offset
	// Note: this field may return null, indicating that no valid values can be obtained.
	EndOffset *uint64 `json:"EndOffset,omitempty" name:"EndOffset"`

	// Number of messages
	// Note: this field may return null, indicating that no valid values can be obtained.
	MessageCount *uint64 `json:"MessageCount,omitempty" name:"MessageCount"`

	// Unsynced replica set
	// Note: this field may return null, indicating that no valid values can be obtained.
	OutOfSyncReplica *string `json:"OutOfSyncReplica,omitempty" name:"OutOfSyncReplica"`
}

type TopicInSyncReplicaResult 

type TopicInSyncReplicaResult struct {

	// Set of topic details and replicas
	TopicInSyncReplicaList []*TopicInSyncReplicaInfo `json:"TopicInSyncReplicaList,omitempty" name:"TopicInSyncReplicaList"`

	// Total number
	TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type TopicPartitionDO 

type TopicPartitionDO struct {

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

	// Leader running status
	LeaderStatus *int64 `json:"LeaderStatus,omitempty" name:"LeaderStatus"`

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

	// Number of replicas
	ReplicaNum *int64 `json:"ReplicaNum,omitempty" name:"ReplicaNum"`
}

type TopicResult 

type TopicResult struct {

	// List of returned topic information
	// Note: this field may return null, indicating that no valid values can be obtained.
	TopicList []*Topic `json:"TopicList,omitempty" name:"TopicList"`

	// Number of eligible topics
	// Note: this field may return null, indicating that no valid values can be obtained.
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type TopicRetentionTimeConfigRsp 

type TopicRetentionTimeConfigRsp struct {

	// Expected value, i.e., the topic message retention time (min) configured
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Expect *int64 `json:"Expect,omitempty" name:"Expect"`

	// Current value (min), i.e., the retention time currently in effect, which may be dynamically adjusted
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Current *int64 `json:"Current,omitempty" name:"Current"`

	// Last modified time
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	ModTimeStamp *int64 `json:"ModTimeStamp,omitempty" name:"ModTimeStamp"`
}

type TopicSubscribeGroup 

type TopicSubscribeGroup struct {

	// Total number
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

	// Number of consumer group status
	StatusCountInfo *string `json:"StatusCountInfo,omitempty" name:"StatusCountInfo"`

	// Consumer group information
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	GroupsInfo []*GroupInfoResponse `json:"GroupsInfo,omitempty" name:"GroupsInfo"`

	// Whether a request is asynchronous. If there are fewer consumer groups in the instances, the result will be returned directly, and status code is 1. When there are many consumer groups in the instances, cache will be updated asynchronously. When status code is 0, grouping information will not be returned until cache update is completed and status code becomes 1.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Status *int64 `json:"Status,omitempty" name:"Status"`
}

type User 

type User struct {

	// User ID
	UserId *int64 `json:"UserId,omitempty" name:"UserId"`

	// Username
	Name *string `json:"Name,omitempty" name:"Name"`

	// Creation time
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// Last updated time
	UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"`
}

type UserResponse 

type UserResponse struct {

	// List of eligible users
	// Note: this field may return null, indicating that no valid values can be obtained.
	Users []*User `json:"Users,omitempty" name:"Users"`

	// Total number of eligible users
	TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`
}

type VipEntity 

type VipEntity struct {

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

	// Virtual port
	Vport *string `json:"Vport,omitempty" name:"Vport"`
}

type ZoneInfo 

type ZoneInfo struct {

	// Zone ID
	ZoneId *string `json:"ZoneId,omitempty" name:"ZoneId"`

	// Whether it is an internal application.
	IsInternalApp *int64 `json:"IsInternalApp,omitempty" name:"IsInternalApp"`

	// Application ID
	AppId *int64 `json:"AppId,omitempty" name:"AppId"`

	// Flag
	Flag *bool `json:"Flag,omitempty" name:"Flag"`

	// Zone name
	ZoneName *string `json:"ZoneName,omitempty" name:"ZoneName"`

	// Zone status
	ZoneStatus *int64 `json:"ZoneStatus,omitempty" name:"ZoneStatus"`

	// Extra flag
	Exflag *string `json:"Exflag,omitempty" name:"Exflag"`

	// JSON object. The key is the model. The value `true` means “sold out”, and `false` means “not sold out”.
	SoldOut *string `json:"SoldOut,omitempty" name:"SoldOut"`

	// Information on whether Standard Edition has been sold out.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SalesInfo []*SaleInfo `json:"SalesInfo,omitempty" name:"SalesInfo"`
}

type ZoneResponse 

type ZoneResponse struct {

	// Zone list
	ZoneList []*ZoneInfo `json:"ZoneList,omitempty" name:"ZoneList"`

	// Maximum number of instances to be purchased
	MaxBuyInstanceNum *int64 `json:"MaxBuyInstanceNum,omitempty" name:"MaxBuyInstanceNum"`

	// Maximum bandwidth in MB/S
	MaxBandwidth *int64 `json:"MaxBandwidth,omitempty" name:"MaxBandwidth"`

	// Pay-as-you-go unit price
	UnitPrice *Price `json:"UnitPrice,omitempty" name:"UnitPrice"`

	// Pay-as-you-go unit message price
	MessagePrice *Price `json:"MessagePrice,omitempty" name:"MessagePrice"`

	// Cluster information dedicated to a user
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	ClusterInfo []*ClusterInfo `json:"ClusterInfo,omitempty" name:"ClusterInfo"`

	// Purchase of Standard Edition configurations
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Standard *string `json:"Standard,omitempty" name:"Standard"`

	// Purchase of Standard S2 Edition configurations
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	StandardS2 *string `json:"StandardS2,omitempty" name:"StandardS2"`

	// Purchase of Pro Edition configurations
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Profession *string `json:"Profession,omitempty" name:"Profession"`

	// Purchase of Physical Dedicated Edition configurations
	// Note: `null` may be returned for this field, indicating that no valid values can be obtained.
	Physical *string `json:"Physical,omitempty" name:"Physical"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.