v20190819

package
v3.0.970+incompatible Latest Latest
Warning

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

Go to latest
Published: Jun 2, 2024 License: Apache-2.0 Imports: 7 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"

	// The topic name is duplicate.
	INVALIDPARAMETER_TOPICEXIST = "InvalidParameter.TopicExist"

	// 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"

	// The quota limit has been reached.
	LIMITEXCEEDED = "LimitExceeded"

	// Missing parameter
	MISSINGPARAMETER = "MissingParameter"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// Task paused.
	OPERATIONDENIED_RESOURCETASKPAUSED = "OperationDenied.ResourceTaskPaused"

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

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

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

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

	// Disk resources are unavailable on the broker.
	RESOURCEUNAVAILABLE_KAFKASTORAGEERROR = "ResourceUnavailable.KafkaStorageError"

	// 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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"Operation"`

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

type AclResponse

type AclResponse struct {
	// Number of eligible data entries
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// ACL list
	// Note: this field may return null, indicating that no valid values can be obtained.
	AclList []*Acl `json:"AclList,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"PatternTypeTitle"`
}

type AclRuleInfo

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

	// Permission types: `Deny`, `Allow`.
	PermissionType *string `json:"PermissionType,omitnil,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,omitnil,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,omitnil,omitempty" name:"Principal"`
}

type AclRuleResp

type AclRuleResp struct {
	// Total number of data entries
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

type AppIdResponse

type AppIdResponse struct {
	// Number of eligible `AppId`
	TotalCount *int64 `json:"TotalCount,omitnil,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,omitnil,omitempty" name:"AppIdList"`
}

type Assignment

type Assignment struct {
	// Assignment version information
	Version *int64 `json:"Version,omitnil,omitempty" name:"Version"`

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

type BatchContent

type BatchContent struct {
	// Message body that is sent.
	Body *string `json:"Body,omitnil,omitempty" name:"Body"`

	// Message sending key name.
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`
}

type BatchCreateAclRequest

type BatchCreateAclRequest struct {
	*tchttp.BaseRequest

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

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

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

	// ACL rule list.
	RuleList []*AclRuleInfo `json:"RuleList,omitnil,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 BatchCreateAclRequestParams

type BatchCreateAclRequestParams struct {
	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

Predefined struct for user

type BatchCreateAclResponse

type BatchCreateAclResponse struct {
	*tchttp.BaseResponse
	Response *BatchCreateAclResponseParams `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 BatchCreateAclResponseParams

type BatchCreateAclResponseParams struct {
	// Status code.
	Result *int64 `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type BatchModifyGroupOffsetsRequest

type BatchModifyGroupOffsetsRequest struct {
	*tchttp.BaseRequest

	// Consumer group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

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

	// Partition information.
	Partitions []*Partitions `json:"Partitions,omitnil,omitempty" name:"Partitions"`

	// Name of the specified topic. Default value: names of all topics.
	TopicName []*string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
}

func NewBatchModifyGroupOffsetsRequest

func NewBatchModifyGroupOffsetsRequest() (request *BatchModifyGroupOffsetsRequest)

func (*BatchModifyGroupOffsetsRequest) FromJsonString

func (r *BatchModifyGroupOffsetsRequest) 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 (*BatchModifyGroupOffsetsRequest) ToJsonString

func (r *BatchModifyGroupOffsetsRequest) ToJsonString() string

type BatchModifyGroupOffsetsRequestParams

type BatchModifyGroupOffsetsRequestParams struct {
	// Consumer group name.
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`

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

	// Partition information.
	Partitions []*Partitions `json:"Partitions,omitnil,omitempty" name:"Partitions"`

	// Name of the specified topic. Default value: names of all topics.
	TopicName []*string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
}

Predefined struct for user

type BatchModifyGroupOffsetsResponse

type BatchModifyGroupOffsetsResponse struct {
	*tchttp.BaseResponse
	Response *BatchModifyGroupOffsetsResponseParams `json:"Response"`
}

func NewBatchModifyGroupOffsetsResponse

func NewBatchModifyGroupOffsetsResponse() (response *BatchModifyGroupOffsetsResponse)

func (*BatchModifyGroupOffsetsResponse) FromJsonString

func (r *BatchModifyGroupOffsetsResponse) 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 (*BatchModifyGroupOffsetsResponse) ToJsonString

func (r *BatchModifyGroupOffsetsResponse) ToJsonString() string

type BatchModifyGroupOffsetsResponseParams

type BatchModifyGroupOffsetsResponseParams struct {
	// Returned result.
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type BatchModifyTopicAttributesRequest

type BatchModifyTopicAttributesRequest struct {
	*tchttp.BaseRequest

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

	// Topic attribute list
	Topic []*BatchModifyTopicInfo `json:"Topic,omitnil,omitempty" name:"Topic"`
}

func NewBatchModifyTopicAttributesRequest

func NewBatchModifyTopicAttributesRequest() (request *BatchModifyTopicAttributesRequest)

func (*BatchModifyTopicAttributesRequest) FromJsonString

func (r *BatchModifyTopicAttributesRequest) 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 (*BatchModifyTopicAttributesRequest) ToJsonString

func (r *BatchModifyTopicAttributesRequest) ToJsonString() string

type BatchModifyTopicAttributesRequestParams

type BatchModifyTopicAttributesRequestParams struct {
	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Topic attribute list
	Topic []*BatchModifyTopicInfo `json:"Topic,omitnil,omitempty" name:"Topic"`
}

Predefined struct for user

type BatchModifyTopicAttributesResponse

type BatchModifyTopicAttributesResponse struct {
	*tchttp.BaseResponse
	Response *BatchModifyTopicAttributesResponseParams `json:"Response"`
}

func NewBatchModifyTopicAttributesResponse

func NewBatchModifyTopicAttributesResponse() (response *BatchModifyTopicAttributesResponse)

func (*BatchModifyTopicAttributesResponse) FromJsonString

func (r *BatchModifyTopicAttributesResponse) 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 (*BatchModifyTopicAttributesResponse) ToJsonString

func (r *BatchModifyTopicAttributesResponse) ToJsonString() string

type BatchModifyTopicAttributesResponseParams

type BatchModifyTopicAttributesResponseParams struct {
	// Returned result.
	Result []*BatchModifyTopicResultDTO `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type BatchModifyTopicInfo

type BatchModifyTopicInfo struct {
	// Topic name.
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

	// The number of partitions.
	PartitionNum *int64 `json:"PartitionNum,omitnil,omitempty" name:"PartitionNum"`

	// Remarks.
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

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

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

	// The minimum number of replicas specified by `min.insync.replicas` when the producer sets `request.required.acks` to `-1`.
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitnil,omitempty" name:"MinInsyncReplicas"`

	// Whether to allow a non-ISR replica to be the leader.
	UncleanLeaderElectionEnable *bool `json:"UncleanLeaderElectionEnable,omitnil,omitempty" name:"UncleanLeaderElectionEnable"`

	// Message retention period in topic dimension in milliseconds. Value range: 1 minute to 90 days.
	RetentionMs *int64 `json:"RetentionMs,omitnil,omitempty" name:"RetentionMs"`

	// Message retention size in topic dimension. Value range: 1 MB - 1024 GB.
	RetentionBytes *int64 `json:"RetentionBytes,omitnil,omitempty" name:"RetentionBytes"`

	// Segment rolling duration in milliseconds. Value range: 1-90 days.
	SegmentMs *int64 `json:"SegmentMs,omitnil,omitempty" name:"SegmentMs"`

	// Message size per batch. Value range: 1 KB - 12 MB.
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitnil,omitempty" name:"MaxMessageBytes"`
}

type BatchModifyTopicResultDTO

type BatchModifyTopicResultDTO struct {
	// Instance ID.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

	// Message status.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`
}

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:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) BatchCreateAclWithContext

func (c *Client) BatchCreateAclWithContext(ctx context.Context, request *BatchCreateAclRequest) (response *BatchCreateAclResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) BatchModifyGroupOffsets

func (c *Client) BatchModifyGroupOffsets(request *BatchModifyGroupOffsetsRequest) (response *BatchModifyGroupOffsetsResponse, err error)

BatchModifyGroupOffsets This API is used to batch modify consumer group offsets.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"

func (*Client) BatchModifyGroupOffsetsWithContext

func (c *Client) BatchModifyGroupOffsetsWithContext(ctx context.Context, request *BatchModifyGroupOffsetsRequest) (response *BatchModifyGroupOffsetsResponse, err error)

BatchModifyGroupOffsets This API is used to batch modify consumer group offsets.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"

func (*Client) BatchModifyTopicAttributes

func (c *Client) BatchModifyTopicAttributes(request *BatchModifyTopicAttributesRequest) (response *BatchModifyTopicAttributesResponse, err error)

BatchModifyTopicAttributes This API is used to batch set topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) BatchModifyTopicAttributesWithContext

func (c *Client) BatchModifyTopicAttributesWithContext(ctx context.Context, request *BatchModifyTopicAttributesRequest) (response *BatchModifyTopicAttributesResponse, err error)

BatchModifyTopicAttributes This API is used to batch set topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

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:

FAILEDOPERATION = "FailedOperation"
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) CreateAclRule

func (c *Client) CreateAclRule(request *CreateAclRuleRequest) (response *CreateAclRuleResponse, err error)

CreateAclRule This API shows you how to create an ACL rule.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
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) CreateAclRuleWithContext

func (c *Client) CreateAclRuleWithContext(ctx context.Context, request *CreateAclRuleRequest) (response *CreateAclRuleResponse, err error)

CreateAclRule This API shows you how to create an ACL rule.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
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) CreateAclWithContext

func (c *Client) CreateAclWithContext(ctx context.Context, request *CreateAclRequest) (response *CreateAclResponse, err error)

CreateAcl This API is used to add an ACL policy.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) CreateConsumer

func (c *Client) CreateConsumer(request *CreateConsumerRequest) (response *CreateConsumerResponse, err error)

CreateConsumer This API is used to create a consumer group.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateConsumerWithContext

func (c *Client) CreateConsumerWithContext(ctx context.Context, request *CreateConsumerRequest) (response *CreateConsumerResponse, err error)

CreateConsumer This API is used to create a consumer group.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
RESOURCENOTFOUND = "ResourceNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateDatahubTopic

func (c *Client) CreateDatahubTopic(request *CreateDatahubTopicRequest) (response *CreateDatahubTopicResponse, err error)

CreateDatahubTopic This API is used to create a DataHub topic.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_TOPICEXIST = "InvalidParameter.TopicExist"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreateDatahubTopicWithContext

func (c *Client) CreateDatahubTopicWithContext(ctx context.Context, request *CreateDatahubTopicRequest) (response *CreateDatahubTopicResponse, err error)

CreateDatahubTopic This API is used to create a DataHub topic.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_TOPICEXIST = "InvalidParameter.TopicExist"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreateInstancePost

func (c *Client) CreateInstancePost(request *CreateInstancePostRequest) (response *CreateInstancePostResponse, err error)

CreateInstancePost This API is used to create a pay-as-you-go instance. It will be deprecated in future versions. We recommend that you use the `CreatePostPaidInstance` API instead. You can call this API via SDK or the TencentCloud API console to create a pay-as-you-go CKafka instance, which is an alternate option for making a purchase in the console.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreateInstancePostWithContext

func (c *Client) CreateInstancePostWithContext(ctx context.Context, request *CreateInstancePostRequest) (response *CreateInstancePostResponse, err error)

CreateInstancePost This API is used to create a pay-as-you-go instance. It will be deprecated in future versions. We recommend that you use the `CreatePostPaidInstance` API instead. You can call this API via SDK or the TencentCloud API console to create a pay-as-you-go CKafka instance, which is an alternate option for making a purchase in the console.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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"
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:

FAILEDOPERATION = "FailedOperation"
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"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreatePartitionWithContext

func (c *Client) CreatePartitionWithContext(ctx context.Context, request *CreatePartitionRequest) (response *CreatePartitionResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreatePostPaidInstance

func (c *Client) CreatePostPaidInstance(request *CreatePostPaidInstanceRequest) (response *CreatePostPaidInstanceResponse, err error)

CreatePostPaidInstance This API is used to replace `CreateInstancePost` to create a pay-as-you-go instance. You can call this API via SDK or the TencentCloud API console to create a pay-as-you-go CKafka instance, which is an alternate option for making a purchase in the console.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) CreatePostPaidInstanceWithContext

func (c *Client) CreatePostPaidInstanceWithContext(ctx context.Context, request *CreatePostPaidInstanceRequest) (response *CreatePostPaidInstanceResponse, err error)

CreatePostPaidInstance This API is used to replace `CreateInstancePost` to create a pay-as-you-go instance. You can call this API via SDK or the TencentCloud API console to create a pay-as-you-go CKafka instance, which is an alternate option for making a purchase in the console.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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"
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:

FAILEDOPERATION = "FailedOperation"
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"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) CreateTopicIpWhiteListWithContext

func (c *Client) CreateTopicIpWhiteListWithContext(ctx context.Context, request *CreateTopicIpWhiteListRequest) (response *CreateTopicIpWhiteListResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) CreateTopicWithContext

func (c *Client) CreateTopicWithContext(ctx context.Context, request *CreateTopicRequest) (response *CreateTopicResponse, err error)

CreateTopic This API is used to create a CKafka topic.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) CreateUserWithContext

func (c *Client) CreateUserWithContext(ctx context.Context, request *CreateUserRequest) (response *CreateUserResponse, err error)

CreateUser This API is used to add a user.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) DeleteAclWithContext

func (c *Client) DeleteAclWithContext(ctx context.Context, request *DeleteAclRequest) (response *DeleteAclResponse, err error)

DeleteAcl This API is used to delete an ACL.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DeleteInstancePre

func (c *Client) DeleteInstancePre(request *DeleteInstancePreRequest) (response *DeleteInstancePreResponse, err error)

DeleteInstancePre This API is used to delete a monthly subscribed (prepaid) instance.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteInstancePreWithContext

func (c *Client) DeleteInstancePreWithContext(ctx context.Context, request *DeleteInstancePreRequest) (response *DeleteInstancePreResponse, err error)

DeleteInstancePre This API is used to delete a monthly subscribed (prepaid) instance.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DeleteRoute

func (c *Client) DeleteRoute(request *DeleteRouteRequest) (response *DeleteRouteResponse, err error)

DeleteRoute This API is used to delete a route.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
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) DeleteRouteTriggerTimeWithContext

func (c *Client) DeleteRouteTriggerTimeWithContext(ctx context.Context, 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) DeleteRouteWithContext

func (c *Client) DeleteRouteWithContext(ctx context.Context, request *DeleteRouteRequest) (response *DeleteRouteResponse, err error)

DeleteRoute This API is used to delete a route.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

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:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
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:

FAILEDOPERATION = "FailedOperation"
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) DeleteTopicIpWhiteListWithContext

func (c *Client) DeleteTopicIpWhiteListWithContext(ctx context.Context, request *DeleteTopicIpWhiteListRequest) (response *DeleteTopicIpWhiteListResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DeleteTopicWithContext

func (c *Client) DeleteTopicWithContext(ctx context.Context, request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)

DeleteTopic This API is used to delete a CKafka topic.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
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:

FAILEDOPERATION = "FailedOperation"
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) DeleteUserWithContext

func (c *Client) DeleteUserWithContext(ctx context.Context, request *DeleteUserRequest) (response *DeleteUserResponse, err error)

DeleteUser This API is used to delete a user.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) DescribeACLWithContext

func (c *Client) DescribeACLWithContext(ctx context.Context, request *DescribeACLRequest) (response *DescribeACLResponse, err error)

DescribeACL This API is used to enumerate ACLs.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DescribeAclRule

func (c *Client) DescribeAclRule(request *DescribeAclRuleRequest) (response *DescribeAclRuleResponse, err error)

DescribeAclRule This API is used to query the ACL rule list.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DescribeAclRuleWithContext

func (c *Client) DescribeAclRuleWithContext(ctx context.Context, request *DescribeAclRuleRequest) (response *DescribeAclRuleResponse, err error)

DescribeAclRule This API is used to query the ACL rule list.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DescribeAppInfoWithContext

func (c *Client) DescribeAppInfoWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeCkafkaZoneWithContext

func (c *Client) DescribeCkafkaZoneWithContext(ctx context.Context, request *DescribeCkafkaZoneRequest) (response *DescribeCkafkaZoneResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) DescribeConsumerGroupWithContext

func (c *Client) DescribeConsumerGroupWithContext(ctx context.Context, request *DescribeConsumerGroupRequest) (response *DescribeConsumerGroupResponse, err error)

DescribeConsumerGroup This API is used to query consumer group information.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DescribeDatahubTopic

func (c *Client) DescribeDatahubTopic(request *DescribeDatahubTopicRequest) (response *DescribeDatahubTopicResponse, err error)

DescribeDatahubTopic This API is used to get the DataHub topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeDatahubTopicWithContext

func (c *Client) DescribeDatahubTopicWithContext(ctx context.Context, request *DescribeDatahubTopicRequest) (response *DescribeDatahubTopicResponse, err error)

DescribeDatahubTopic This API is used to get the DataHub topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeDatahubTopics

func (c *Client) DescribeDatahubTopics(request *DescribeDatahubTopicsRequest) (response *DescribeDatahubTopicsResponse, err error)

DescribeDatahubTopics This API is used to query the DataHub topic list.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeDatahubTopicsWithContext

func (c *Client) DescribeDatahubTopicsWithContext(ctx context.Context, request *DescribeDatahubTopicsRequest) (response *DescribeDatahubTopicsResponse, err error)

DescribeDatahubTopics This API is used to query the DataHub topic list.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
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:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) DescribeGroupInfoWithContext

func (c *Client) DescribeGroupInfoWithContext(ctx context.Context, request *DescribeGroupInfoRequest) (response *DescribeGroupInfoResponse, err error)

DescribeGroupInfo This API is used to get consumer group information.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) DescribeGroupOffsetsWithContext

func (c *Client) DescribeGroupOffsetsWithContext(ctx context.Context, request *DescribeGroupOffsetsRequest) (response *DescribeGroupOffsetsResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DescribeGroupWithContext

func (c *Client) DescribeGroupWithContext(ctx context.Context, request *DescribeGroupRequest) (response *DescribeGroupResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeInstanceAttributesWithContext

func (c *Client) DescribeInstanceAttributesWithContext(ctx context.Context, request *DescribeInstanceAttributesRequest) (response *DescribeInstanceAttributesResponse, err error)

DescribeInstanceAttributes This API is used to get instance attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
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:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeInstancesDetailWithContext

func (c *Client) DescribeInstancesDetailWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeInstancesWithContext

func (c *Client) DescribeInstancesWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_REPETITIONVALUE = "InvalidParameterValue.RepetitionValue"
INVALIDPARAMETERVALUE_WRONGACTION = "InvalidParameterValue.WrongAction"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) DescribeRegionWithContext

func (c *Client) DescribeRegionWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeRouteWithContext

func (c *Client) DescribeRouteWithContext(ctx context.Context, request *DescribeRouteRequest) (response *DescribeRouteResponse, err error)

DescribeRoute This API is used to view route information.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTaskStatus

func (c *Client) DescribeTaskStatus(request *DescribeTaskStatusRequest) (response *DescribeTaskStatusResponse, err error)

DescribeTaskStatus This API is used to query the task status.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) DescribeTaskStatusWithContext

func (c *Client) DescribeTaskStatusWithContext(ctx context.Context, request *DescribeTaskStatusRequest) (response *DescribeTaskStatusResponse, err error)

DescribeTaskStatus This API is used to query the task status.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
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:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) DescribeTopicAttributesWithContext

func (c *Client) DescribeTopicAttributesWithContext(ctx context.Context, request *DescribeTopicAttributesRequest) (response *DescribeTopicAttributesResponse, err error)

DescribeTopicAttributes This API is used to get topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
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:

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

func (*Client) DescribeTopicDetailWithContext

func (c *Client) DescribeTopicDetailWithContext(ctx context.Context, 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:

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

func (*Client) DescribeTopicProduceConnection

func (c *Client) DescribeTopicProduceConnection(request *DescribeTopicProduceConnectionRequest) (response *DescribeTopicProduceConnectionResponse, err error)

DescribeTopicProduceConnection This API is used to query the connection information of the topic producer.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"

func (*Client) DescribeTopicProduceConnectionWithContext

func (c *Client) DescribeTopicProduceConnectionWithContext(ctx context.Context, request *DescribeTopicProduceConnectionRequest) (response *DescribeTopicProduceConnectionResponse, err error)

DescribeTopicProduceConnection This API is used to query the connection information of the topic producer.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
INVALIDPARAMETERVALUE_ZONENOTSUPPORT = "InvalidParameterValue.ZoneNotSupport"

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) DescribeTopicSubscribeGroupWithContext

func (c *Client) DescribeTopicSubscribeGroupWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTopicSyncReplicaWithContext

func (c *Client) DescribeTopicSyncReplicaWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTopicWithContext

func (c *Client) DescribeTopicWithContext(ctx context.Context, 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:

FAILEDOPERATION = "FailedOperation"
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"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

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:

FAILEDOPERATION = "FailedOperation"
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) DescribeUserWithContext

func (c *Client) DescribeUserWithContext(ctx context.Context, request *DescribeUserRequest) (response *DescribeUserResponse, err error)

DescribeUser This API is used to query user information.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) FetchMessageByOffsetWithContext

func (c *Client) FetchMessageByOffsetWithContext(ctx context.Context, 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) FetchMessageListByOffset

func (c *Client) FetchMessageListByOffset(request *FetchMessageListByOffsetRequest) (response *FetchMessageListByOffsetResponse, err error)

FetchMessageListByOffset This API is used to query the message list based on an offset.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"

func (*Client) FetchMessageListByOffsetWithContext

func (c *Client) FetchMessageListByOffsetWithContext(ctx context.Context, request *FetchMessageListByOffsetRequest) (response *FetchMessageListByOffsetResponse, err error)

FetchMessageListByOffset This API is used to query the message list based on an offset.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"

func (*Client) InquireCkafkaPrice

func (c *Client) InquireCkafkaPrice(request *InquireCkafkaPriceRequest) (response *InquireCkafkaPriceResponse, err error)

InquireCkafkaPrice This API is used to purchase a CKafka instance or query the instance renewal price.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"

func (*Client) InquireCkafkaPriceWithContext

func (c *Client) InquireCkafkaPriceWithContext(ctx context.Context, request *InquireCkafkaPriceRequest) (response *InquireCkafkaPriceResponse, err error)

InquireCkafkaPrice This API is used to purchase a CKafka instance or query the instance renewal price.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"

func (*Client) ModifyAclRule

func (c *Client) ModifyAclRule(request *ModifyAclRuleRequest) (response *ModifyAclRuleResponse, err error)

ModifyAclRule This API is used to modify an ACL policy, and currently only supports specifying whether to apply the preset rule to new topics.

error code that may be returned:

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

func (*Client) ModifyAclRuleWithContext

func (c *Client) ModifyAclRuleWithContext(ctx context.Context, request *ModifyAclRuleRequest) (response *ModifyAclRuleResponse, err error)

ModifyAclRule This API is used to modify an ACL policy, and currently only supports specifying whether to apply the preset rule to new topics.

error code that may be returned:

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

func (*Client) ModifyDatahubTopic

func (c *Client) ModifyDatahubTopic(request *ModifyDatahubTopicRequest) (response *ModifyDatahubTopicResponse, err error)

ModifyDatahubTopic This API is used to modify the DataHub topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) ModifyDatahubTopicWithContext

func (c *Client) ModifyDatahubTopicWithContext(ctx context.Context, request *ModifyDatahubTopicRequest) (response *ModifyDatahubTopicResponse, err error)

ModifyDatahubTopic This API is used to modify the DataHub topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) 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:

FAILEDOPERATION = "FailedOperation"
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) ModifyGroupOffsetsWithContext

func (c *Client) ModifyGroupOffsetsWithContext(ctx context.Context, request *ModifyGroupOffsetsRequest) (response *ModifyGroupOffsetsResponse, err error)

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

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) ModifyInstanceAttributesWithContext

func (c *Client) ModifyInstanceAttributesWithContext(ctx context.Context, request *ModifyInstanceAttributesRequest) (response *ModifyInstanceAttributesResponse, err error)

ModifyInstanceAttributes This API is used to set instance attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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 = "UnsupportedOperation"
UNSUPPORTEDOPERATION_BATCHDELINSTANCELIMIT = "UnsupportedOperation.BatchDelInstanceLimit"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) ModifyInstancePre

func (c *Client) ModifyInstancePre(request *ModifyInstancePreRequest) (response *ModifyInstancePreResponse, err error)

ModifyInstancePre This API is used to change the configurations of a prepaid instance, such as disk capacity and bandwidth.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION_OSSREJECT = "UnsupportedOperation.OssReject"

func (*Client) ModifyInstancePreWithContext

func (c *Client) ModifyInstancePreWithContext(ctx context.Context, request *ModifyInstancePreRequest) (response *ModifyInstancePreResponse, err error)

ModifyInstancePre This API is used to change the configurations of a prepaid instance, such as disk capacity and bandwidth.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
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"
RESOURCENOTFOUND = "ResourceNotFound"
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:

FAILEDOPERATION = "FailedOperation"
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) ModifyPasswordWithContext

func (c *Client) ModifyPasswordWithContext(ctx context.Context, request *ModifyPasswordRequest) (response *ModifyPasswordResponse, err error)

ModifyPassword This API is used to change the password.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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:

FAILEDOPERATION = "FailedOperation"
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) ModifyTopicAttributesWithContext

func (c *Client) ModifyTopicAttributesWithContext(ctx context.Context, request *ModifyTopicAttributesRequest) (response *ModifyTopicAttributesResponse, err error)

ModifyTopicAttributes This API is used to modify topic attributes.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
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) SendMessage

func (c *Client) SendMessage(request *SendMessageRequest) (response *SendMessageResponse, err error)

SendMessage This API is used to send messages through the HTTP access layer.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_RESOURCETASKPAUSED = "OperationDenied.ResourceTaskPaused"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_KAFKASTORAGEERROR = "ResourceUnavailable.KafkaStorageError"

func (*Client) SendMessageWithContext

func (c *Client) SendMessageWithContext(ctx context.Context, request *SendMessageRequest) (response *SendMessageResponse, err error)

SendMessage This API is used to send messages through the HTTP access layer.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INSTANCENOTEXIST = "InvalidParameterValue.InstanceNotExist"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_RESOURCETASKPAUSED = "OperationDenied.ResourceTaskPaused"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_KAFKASTORAGEERROR = "ResourceUnavailable.KafkaStorageError"

type ClusterInfo

type ClusterInfo struct {
	// Cluster ID
	ClusterId *int64 `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// Cluster name
	ClusterName *string `json:"ClusterName,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"CleanUpPolicy"`

	// Segment rolling duration
	// Note: this field may return null, indicating that no valid values can be obtained.
	SegmentMs *int64 `json:"SegmentMs,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"MaxMessageBytes"`

	// Message retention file size.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	RetentionBytes *int64 `json:"RetentionBytes,omitnil,omitempty" name:"RetentionBytes"`
}

type ConsumerGroup

type ConsumerGroup struct {
	// User group name
	ConsumerGroupName *string `json:"ConsumerGroupName,omitnil,omitempty" name:"ConsumerGroupName"`

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

type ConsumerGroupResponse

type ConsumerGroupResponse struct {
	// Number of eligible consumer groups
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

	// Consumer group list
	// Note: this field may return null, indicating that no valid values can be obtained.
	GroupList []*ConsumerGroup `json:"GroupList,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"GroupListForMonitor"`
}

type ConsumerGroupTopic

type ConsumerGroupTopic struct {
	// Topic ID
	TopicId *string `json:"TopicId,omitnil,omitempty" name:"TopicId"`

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

type ConsumerRecord

type ConsumerRecord struct {
	// Topic name
	Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`

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

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

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

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

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

	// Message headers
	// Note: This field may return null, indicating that no valid values can be obtained.
	Headers *string `json:"Headers,omitnil,omitempty" name:"Headers"`
}

type CreateAclRequest

type CreateAclRequest struct {
	*tchttp.BaseRequest

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

	// ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
	ResourceType *int64 `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`

	// ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).
	Operation *int64 `json:"Operation,omitnil,omitempty" name:"Operation"`

	// Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.
	PermissionType *int64 `json:"PermissionType,omitnil,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; if `resourceType` is `CLUSTER`, this field can be left empty.
	ResourceName *string `json:"ResourceName,omitnil,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,omitnil,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,omitnil,omitempty" name:"Principal"`

	// The resource name list, which is in JSON string format. Either `ResourceName` or `resourceNameList` can be specified.
	ResourceNameList *string `json:"ResourceNameList,omitnil,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 CreateAclRequestParams

type CreateAclRequestParams struct {
	// Instance ID information
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
	ResourceType *int64 `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`

	// ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).
	Operation *int64 `json:"Operation,omitnil,omitempty" name:"Operation"`

	// Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.
	PermissionType *int64 `json:"PermissionType,omitnil,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; if `resourceType` is `CLUSTER`, this field can be left empty.
	ResourceName *string `json:"ResourceName,omitnil,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,omitnil,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,omitnil,omitempty" name:"Principal"`

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

Predefined struct for user

type CreateAclResponse

type CreateAclResponse struct {
	*tchttp.BaseResponse
	Response *CreateAclResponseParams `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 CreateAclResponseParams

type CreateAclResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateAclRuleRequest

type CreateAclRuleRequest struct {
	*tchttp.BaseRequest

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

	// ACL resource type. Currently, the only valid value is `Topic`.
	ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`

	// Matching type. Valid values: `PREFIXED`(match by prefix), `PRESET` (match by preset policy).
	PatternType *string `json:"PatternType,omitnil,omitempty" name:"PatternType"`

	// Rule name
	RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`

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

	// Prefix value for prefix match
	Pattern *string `json:"Pattern,omitnil,omitempty" name:"Pattern"`

	// A parameter used to specify whether the preset ACL rule is applied to new topics
	IsApplied *int64 `json:"IsApplied,omitnil,omitempty" name:"IsApplied"`

	// Remarks for ACL rules
	Comment *string `json:"Comment,omitnil,omitempty" name:"Comment"`
}

func NewCreateAclRuleRequest

func NewCreateAclRuleRequest() (request *CreateAclRuleRequest)

func (*CreateAclRuleRequest) FromJsonString

func (r *CreateAclRuleRequest) 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 (*CreateAclRuleRequest) ToJsonString

func (r *CreateAclRuleRequest) ToJsonString() string

type CreateAclRuleRequestParams

type CreateAclRuleRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// ACL resource type. Currently, the only valid value is `Topic`.
	ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`

	// Matching type. Valid values: `PREFIXED`(match by prefix), `PRESET` (match by preset policy).
	PatternType *string `json:"PatternType,omitnil,omitempty" name:"PatternType"`

	// Rule name
	RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`

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

	// Prefix value for prefix match
	Pattern *string `json:"Pattern,omitnil,omitempty" name:"Pattern"`

	// A parameter used to specify whether the preset ACL rule is applied to new topics
	IsApplied *int64 `json:"IsApplied,omitnil,omitempty" name:"IsApplied"`

	// Remarks for ACL rules
	Comment *string `json:"Comment,omitnil,omitempty" name:"Comment"`
}

Predefined struct for user

type CreateAclRuleResponse

type CreateAclRuleResponse struct {
	*tchttp.BaseResponse
	Response *CreateAclRuleResponseParams `json:"Response"`
}

func NewCreateAclRuleResponse

func NewCreateAclRuleResponse() (response *CreateAclRuleResponse)

func (*CreateAclRuleResponse) FromJsonString

func (r *CreateAclRuleResponse) 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 (*CreateAclRuleResponse) ToJsonString

func (r *CreateAclRuleResponse) ToJsonString() string

type CreateAclRuleResponseParams

type CreateAclRuleResponseParams struct {
	// Unique key of a rule
	Result *int64 `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateConsumerRequest

type CreateConsumerRequest struct {
	*tchttp.BaseRequest

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

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

	// Topic name. You must specify the name of an existing topic for either `TopicName` or `TopicNameList`.
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

	// Topic name array.
	TopicNameList []*string `json:"TopicNameList,omitnil,omitempty" name:"TopicNameList"`
}

func NewCreateConsumerRequest

func NewCreateConsumerRequest() (request *CreateConsumerRequest)

func (*CreateConsumerRequest) FromJsonString

func (r *CreateConsumerRequest) 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 (*CreateConsumerRequest) ToJsonString

func (r *CreateConsumerRequest) ToJsonString() string

type CreateConsumerRequestParams

type CreateConsumerRequestParams struct {
	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

	// Topic name. You must specify the name of an existing topic for either `TopicName` or `TopicNameList`.
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

	// Topic name array.
	TopicNameList []*string `json:"TopicNameList,omitnil,omitempty" name:"TopicNameList"`
}

Predefined struct for user

type CreateConsumerResponse

type CreateConsumerResponse struct {
	*tchttp.BaseResponse
	Response *CreateConsumerResponseParams `json:"Response"`
}

func NewCreateConsumerResponse

func NewCreateConsumerResponse() (response *CreateConsumerResponse)

func (*CreateConsumerResponse) FromJsonString

func (r *CreateConsumerResponse) 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 (*CreateConsumerResponse) ToJsonString

func (r *CreateConsumerResponse) ToJsonString() string

type CreateConsumerResponseParams

type CreateConsumerResponseParams struct {
	// Description of the created consumer group.
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateDatahubTopicRequest

type CreateDatahubTopicRequest struct {
	*tchttp.BaseRequest

	// Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

	// Topic remarks, which are a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

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

func NewCreateDatahubTopicRequest

func NewCreateDatahubTopicRequest() (request *CreateDatahubTopicRequest)

func (*CreateDatahubTopicRequest) FromJsonString

func (r *CreateDatahubTopicRequest) 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 (*CreateDatahubTopicRequest) ToJsonString

func (r *CreateDatahubTopicRequest) ToJsonString() string

type CreateDatahubTopicRequestParams

type CreateDatahubTopicRequestParams struct {
	// Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

	// Topic remarks, which are a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

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

Predefined struct for user

type CreateDatahubTopicResponse

type CreateDatahubTopicResponse struct {
	*tchttp.BaseResponse
	Response *CreateDatahubTopicResponseParams `json:"Response"`
}

func NewCreateDatahubTopicResponse

func NewCreateDatahubTopicResponse() (response *CreateDatahubTopicResponse)

func (*CreateDatahubTopicResponse) FromJsonString

func (r *CreateDatahubTopicResponse) 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 (*CreateDatahubTopicResponse) ToJsonString

func (r *CreateDatahubTopicResponse) ToJsonString() string

type CreateDatahubTopicResponseParams

type CreateDatahubTopicResponseParams struct {
	// Returned creation result
	Result *DatahubTopicResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateInstancePostData

type CreateInstancePostData struct {
	// This parameter has a fixed value of 0 returned by `CreateInstancePre`. It is only used for backend data alignment  and cannot be used as the query condition for `CheckTaskStatus`.
	// Note:  This field may return null, indicating that no valid values can be obtained.
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// List of order IDs Note: This field may return null, indicating that no valid values can be obtained.
	DealNames []*string `json:"DealNames,omitnil,omitempty" name:"DealNames"`

	// Instance ID. When multiple instances are purchased, the ID of the first one is returned by default . Note: This field may return null, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Mapping between orders and the purchased instances.  Note: This field may return null, indicating that no valid values can be obtained.
	DealNameInstanceIdMapping []*DealInstanceDTO `json:"DealNameInstanceIdMapping,omitnil,omitempty" name:"DealNameInstanceIdMapping"`
}

type CreateInstancePostRequest

type CreateInstancePostRequest struct {
	*tchttp.BaseRequest

	// Instance name, which is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Private network peak bandwidth of an instance  in MB/sec.  If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification.  If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.
	BandWidth *int64 `json:"BandWidth,omitnil,omitempty" name:"BandWidth"`

	// ID of the VPC where the default access point of the created instance resides.  This parameter is required as instances cannot be created in the classic network currently.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// ID of the subnet  where the default access point of the created instance resides.
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// Instance specification.  This parameter is required for a Standard Edition instance but not for a Pro Edition instance.  Valid values:  `1` (Small),  `2` (Standard),  `3` (Advanced),  `4` (Large),  `5` (Xlarge L1),  `6` (Xlarge L2),  `7` (Xlarge L3),  `8` (Xlarge L4),
	InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// The maximum instance log retention period in minutes by default.  If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days.  If the message retention period of the topic is explicitly set, it will prevail.
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitnil,omitempty" name:"MsgRetentionTime"`

	// Cluster ID, which can be selected when you create an instance.  You don’t need to pass in this parameter if the cluster where the instance resides is not specified.
	ClusterId *int64 `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// Instance version.  Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.
	KafkaVersion *string `json:"KafkaVersion,omitnil,omitempty" name:"KafkaVersion"`

	// Instance type. Valid values: `standard` (Standard Edition),  `profession`  (Pro Edition)
	SpecificationsType *string `json:"SpecificationsType,omitnil,omitempty" name:"SpecificationsType"`

	// Instance disk type. Valid values:  `CLOUD_BASIC` (Premium Cloud Storage),  `CLOUD_SSD` (SSD).  If this parameter is left empty, the default value `CLOUD_BASIC` will be used.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Instance disk size, which must meet the requirement of the instance’s specification.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.
	TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`

	// AZ of the instance.  When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// Whether the current instance is a multi-AZ instance
	MultiZoneFlag *bool `json:"MultiZoneFlag,omitnil,omitempty" name:"MultiZoneFlag"`

	// This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs.  Note that `ZoneId` must be included in the array of this parameter.
	ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`

	// The number of purchased instances.  Default value: `1`. This parameter is optional.  If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.
	InstanceNum *int64 `json:"InstanceNum,omitnil,omitempty" name:"InstanceNum"`

	// Public network bandwidth in Mbps.  The 3 Mbps of free bandwidth is not included here by default.  For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`. The value must be an integer multiple of 3.
	PublicNetworkMonthly *int64 `json:"PublicNetworkMonthly,omitnil,omitempty" name:"PublicNetworkMonthly"`
}

func NewCreateInstancePostRequest

func NewCreateInstancePostRequest() (request *CreateInstancePostRequest)

func (*CreateInstancePostRequest) FromJsonString

func (r *CreateInstancePostRequest) 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 (*CreateInstancePostRequest) ToJsonString

func (r *CreateInstancePostRequest) ToJsonString() string

type CreateInstancePostRequestParams

type CreateInstancePostRequestParams struct {
	// Instance name, which is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// Private network peak bandwidth of an instance  in MB/sec.  If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification.  If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.
	BandWidth *int64 `json:"BandWidth,omitnil,omitempty" name:"BandWidth"`

	// ID of the VPC where the default access point of the created instance resides.  This parameter is required as instances cannot be created in the classic network currently.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// ID of the subnet  where the default access point of the created instance resides.
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// Instance specification.  This parameter is required for a Standard Edition instance but not for a Pro Edition instance.  Valid values:  `1` (Small),  `2` (Standard),  `3` (Advanced),  `4` (Large),  `5` (Xlarge L1),  `6` (Xlarge L2),  `7` (Xlarge L3),  `8` (Xlarge L4),
	InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// The maximum instance log retention period in minutes by default.  If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days.  If the message retention period of the topic is explicitly set, it will prevail.
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitnil,omitempty" name:"MsgRetentionTime"`

	// Cluster ID, which can be selected when you create an instance.  You don’t need to pass in this parameter if the cluster where the instance resides is not specified.
	ClusterId *int64 `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// Instance version.  Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.
	KafkaVersion *string `json:"KafkaVersion,omitnil,omitempty" name:"KafkaVersion"`

	// Instance type. Valid values: `standard` (Standard Edition),  `profession`  (Pro Edition)
	SpecificationsType *string `json:"SpecificationsType,omitnil,omitempty" name:"SpecificationsType"`

	// Instance disk type. Valid values:  `CLOUD_BASIC` (Premium Cloud Storage),  `CLOUD_SSD` (SSD).  If this parameter is left empty, the default value `CLOUD_BASIC` will be used.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Instance disk size, which must meet the requirement of the instance’s specification.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.
	TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`

	// AZ of the instance.  When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// Whether the current instance is a multi-AZ instance
	MultiZoneFlag *bool `json:"MultiZoneFlag,omitnil,omitempty" name:"MultiZoneFlag"`

	// This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs.  Note that `ZoneId` must be included in the array of this parameter.
	ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`

	// The number of purchased instances.  Default value: `1`. This parameter is optional.  If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.
	InstanceNum *int64 `json:"InstanceNum,omitnil,omitempty" name:"InstanceNum"`

	// Public network bandwidth in Mbps.  The 3 Mbps of free bandwidth is not included here by default.  For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`. The value must be an integer multiple of 3.
	PublicNetworkMonthly *int64 `json:"PublicNetworkMonthly,omitnil,omitempty" name:"PublicNetworkMonthly"`
}

Predefined struct for user

type CreateInstancePostResp

type CreateInstancePostResp struct {
	// Returned code. `0` indicates normal status while other codes indicate errors.
	ReturnCode *string `json:"ReturnCode,omitnil,omitempty" name:"ReturnCode"`

	// Message returned by the API. An error message will be returned if the API reports an error.
	ReturnMessage *string `json:"ReturnMessage,omitnil,omitempty" name:"ReturnMessage"`

	// Returned data.  Note: This field may return null, indicating that no valid values can be obtained.
	Data *CreateInstancePostData `json:"Data,omitnil,omitempty" name:"Data"`
}

type CreateInstancePostResponse

type CreateInstancePostResponse struct {
	*tchttp.BaseResponse
	Response *CreateInstancePostResponseParams `json:"Response"`
}

func NewCreateInstancePostResponse

func NewCreateInstancePostResponse() (response *CreateInstancePostResponse)

func (*CreateInstancePostResponse) FromJsonString

func (r *CreateInstancePostResponse) 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 (*CreateInstancePostResponse) ToJsonString

func (r *CreateInstancePostResponse) ToJsonString() string

type CreateInstancePostResponseParams

type CreateInstancePostResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateInstancePreData

type CreateInstancePreData struct {
	// The value returned by `CreateInstancePre` is 0, which is fixed and cannot be used as the query condition of `CheckTaskStatus`. It is only used to ensure the consistency with the backend data structure.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

	// Order number list.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	DealNames []*string `json:"DealNames,omitnil,omitempty" name:"DealNames"`

	// Instance ID. When multiple instances are purchased, the ID of the first one is returned by default . Note: This field may return null, indicating that no valid values can be obtained.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Mapping between orders and the purchased instances.  Note: This field may return null, indicating that no valid values can be obtained.
	DealNameInstanceIdMapping []*DealInstanceDTO `json:"DealNameInstanceIdMapping,omitnil,omitempty" name:"DealNameInstanceIdMapping"`
}

type CreateInstancePreResp

type CreateInstancePreResp struct {
	// Returned code. 0: Normal; other values: Error.
	ReturnCode *string `json:"ReturnCode,omitnil,omitempty" name:"ReturnCode"`

	// The message indicating whether the operation is successful.
	ReturnMessage *string `json:"ReturnMessage,omitnil,omitempty" name:"ReturnMessage"`

	// Data returned by the operation.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Data *CreateInstancePreData `json:"Data,omitnil,omitempty" name:"Data"`

	// Deletion time.  This parameter has been deprecated and will be deleted.  Note: This field may return null, indicating that no valid values can be obtained.
	//
	// Deprecated: DeleteRouteTimestamp is deprecated.
	DeleteRouteTimestamp *string `json:"DeleteRouteTimestamp,omitnil,omitempty" name:"DeleteRouteTimestamp"`
}

type CreatePartitionRequest

type CreatePartitionRequest struct {
	*tchttp.BaseRequest

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

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

	// Number of topic partitions
	PartitionNum *int64 `json:"PartitionNum,omitnil,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 CreatePartitionRequestParams

type CreatePartitionRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

Predefined struct for user

type CreatePartitionResponse

type CreatePartitionResponse struct {
	*tchttp.BaseResponse
	Response *CreatePartitionResponseParams `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 CreatePartitionResponseParams

type CreatePartitionResponseParams struct {
	// Returned result set
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreatePostPaidInstanceRequest

type CreatePostPaidInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance name, which is a string of up to 64 letters, digits, and hyphens (-). It must start with a letter.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// ID of the VPC where the default access point of the created instance resides.  This parameter is required as instances cannot be created in the classic network currently.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// ID of the subnet  where the default access point of the created instance resides.
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// Instance specification.  This parameter is required for a Standard Edition instance but not for a Pro Edition instance.  Valid values:  `1` (Small),  `2` (Standard),  `3` (Advanced),  `4` (Large),  `5` (Xlarge L1),  `6` (Xlarge L2),  `7` (Xlarge L3),  `8` (Xlarge L4),
	InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// The maximum instance log retention period in minutes by default.  If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days.  If the message retention period of the topic is explicitly set, it will prevail.
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitnil,omitempty" name:"MsgRetentionTime"`

	// Cluster ID, which can be selected when you create an instance.  You don’t need to pass in this parameter if the cluster where the instance resides is not specified.
	ClusterId *int64 `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// Instance version.  Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.
	KafkaVersion *string `json:"KafkaVersion,omitnil,omitempty" name:"KafkaVersion"`

	// Instance type. `standard` (Standard Edition),  `profession`  (Pro Edition)
	SpecificationsType *string `json:"SpecificationsType,omitnil,omitempty" name:"SpecificationsType"`

	// Instance disk type.  `CLOUD_BASIC` (Premium Cloud Storage),  `CLOUD_SSD` (SSD).  If this parameter is left empty, the default value `CLOUD_BASIC` will be used.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Private network peak bandwidth of an instance  in MB/sec.  If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification.  If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.
	BandWidth *int64 `json:"BandWidth,omitnil,omitempty" name:"BandWidth"`

	// Instance disk size, which must meet the requirement of the instance’s specification.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.
	TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`

	// AZ of the instance.  When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// Whether the current instance is a multi-AZ instance
	MultiZoneFlag *bool `json:"MultiZoneFlag,omitnil,omitempty" name:"MultiZoneFlag"`

	// This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs.  Note that `ZoneId` must be included in the array of this parameter.
	ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`

	// The number of purchased instances.  Default value: `1`. This parameter is optional.  If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.
	InstanceNum *int64 `json:"InstanceNum,omitnil,omitempty" name:"InstanceNum"`

	// Public network bandwidth in Mbps.  The 3 Mbps of free bandwidth is not included here by default.  For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`.  The value must be an integer multiple of 3.
	PublicNetworkMonthly *int64 `json:"PublicNetworkMonthly,omitnil,omitempty" name:"PublicNetworkMonthly"`
}

func NewCreatePostPaidInstanceRequest

func NewCreatePostPaidInstanceRequest() (request *CreatePostPaidInstanceRequest)

func (*CreatePostPaidInstanceRequest) FromJsonString

func (r *CreatePostPaidInstanceRequest) 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 (*CreatePostPaidInstanceRequest) ToJsonString

func (r *CreatePostPaidInstanceRequest) ToJsonString() string

type CreatePostPaidInstanceRequestParams

type CreatePostPaidInstanceRequestParams struct {
	// Instance name, which is a string of up to 64 letters, digits, and hyphens (-). It must start with a letter.
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// ID of the VPC where the default access point of the created instance resides.  This parameter is required as instances cannot be created in the classic network currently.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// ID of the subnet  where the default access point of the created instance resides.
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// Instance specification.  This parameter is required for a Standard Edition instance but not for a Pro Edition instance.  Valid values:  `1` (Small),  `2` (Standard),  `3` (Advanced),  `4` (Large),  `5` (Xlarge L1),  `6` (Xlarge L2),  `7` (Xlarge L3),  `8` (Xlarge L4),
	InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// The maximum instance log retention period in minutes by default.  If this parameter is left empty, the default retention period is 1,440 minutes (1 day) to 30 days.  If the message retention period of the topic is explicitly set, it will prevail.
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitnil,omitempty" name:"MsgRetentionTime"`

	// Cluster ID, which can be selected when you create an instance.  You don’t need to pass in this parameter if the cluster where the instance resides is not specified.
	ClusterId *int64 `json:"ClusterId,omitnil,omitempty" name:"ClusterId"`

	// Instance version.  Valid values: `0.10.2`, `1.1.1`, `2.4.2`, and `2.8.1`.
	KafkaVersion *string `json:"KafkaVersion,omitnil,omitempty" name:"KafkaVersion"`

	// Instance type. `standard` (Standard Edition),  `profession`  (Pro Edition)
	SpecificationsType *string `json:"SpecificationsType,omitnil,omitempty" name:"SpecificationsType"`

	// Instance disk type.  `CLOUD_BASIC` (Premium Cloud Storage),  `CLOUD_SSD` (SSD).  If this parameter is left empty, the default value `CLOUD_BASIC` will be used.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Private network peak bandwidth of an instance  in MB/sec.  If you create a Standard Edition instance, pass in the corresponding peak bandwidth for the current instance specification.  If you create a Pro Edition instance, configure the peak bandwidth, partition count, and other parameters as required by Pro Edition.
	BandWidth *int64 `json:"BandWidth,omitnil,omitempty" name:"BandWidth"`

	// Instance disk size, which must meet the requirement of the instance’s specification.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// The maximum number of partitions of the instance, which must meet the requirement of the instance’s specification.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// The maximum number of topics of the instance, which must meet the requirement of the instance’s specification.
	TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`

	// AZ of the instance.  When a multi-AZ instance is created, the value of this parameter is the AZ ID of the subnet where the instance’s default access point resides.
	ZoneId *int64 `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// Whether the current instance is a multi-AZ instance
	MultiZoneFlag *bool `json:"MultiZoneFlag,omitnil,omitempty" name:"MultiZoneFlag"`

	// This parameter indicates the list of AZ IDs when the instance is deployed in multiple AZs.  Note that `ZoneId` must be included in the array of this parameter.
	ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`

	// The number of purchased instances.  Default value: `1`. This parameter is optional.  If it is passed in, multiple instances will be created, with their names being `instanceName` plus different suffixes.
	InstanceNum *int64 `json:"InstanceNum,omitnil,omitempty" name:"InstanceNum"`

	// Public network bandwidth in Mbps.  The 3 Mbps of free bandwidth is not included here by default.  For example, if you need 3 Mbps of public network bandwidth, pass in `0`; if you need 6 Mbps, pass in `3`.  The value must be an integer multiple of 3.
	PublicNetworkMonthly *int64 `json:"PublicNetworkMonthly,omitnil,omitempty" name:"PublicNetworkMonthly"`
}

Predefined struct for user

type CreatePostPaidInstanceResponse

type CreatePostPaidInstanceResponse struct {
	*tchttp.BaseResponse
	Response *CreatePostPaidInstanceResponseParams `json:"Response"`
}

func NewCreatePostPaidInstanceResponse

func NewCreatePostPaidInstanceResponse() (response *CreatePostPaidInstanceResponse)

func (*CreatePostPaidInstanceResponse) FromJsonString

func (r *CreatePostPaidInstanceResponse) 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 (*CreatePostPaidInstanceResponse) ToJsonString

func (r *CreatePostPaidInstanceResponse) ToJsonString() string

type CreatePostPaidInstanceResponseParams

type CreatePostPaidInstanceResponseParams struct {
	// Returned result
	Result *CreateInstancePostResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateTopicIpWhiteListRequest

type CreateTopicIpWhiteListRequest struct {
	*tchttp.BaseRequest

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

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

	// IP allowlist list
	IpWhiteList []*string `json:"IpWhiteList,omitnil,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 CreateTopicIpWhiteListRequestParams

type CreateTopicIpWhiteListRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

Predefined struct for user

type CreateTopicIpWhiteListResponse

type CreateTopicIpWhiteListResponse struct {
	*tchttp.BaseResponse
	Response *CreateTopicIpWhiteListResponseParams `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 CreateTopicIpWhiteListResponseParams

type CreateTopicIpWhiteListResponseParams struct {
	// Result of deleting topic IP allowlist
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateTopicRequest

type CreateTopicRequest struct {
	*tchttp.BaseRequest

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

	// Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

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

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

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

	// IP allowlist list for quota limit, which is required if `enableWhileList` is 1
	IpWhiteList []*string `json:"IpWhiteList,omitnil,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,omitnil,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,omitnil,omitempty" name:"Note"`

	// Default value: 1
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitnil,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,omitnil,omitempty" name:"UncleanLeaderElectionEnable"`

	// Message retention period in milliseconds, which is optional. Min value: 60,000 ms.
	RetentionMs *int64 `json:"RetentionMs,omitnil,omitempty" name:"RetentionMs"`

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

	// Max message size in bytes. Value range: 1,024 bytes (1 KB) to 8,388,608 bytes (8 MB).
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitnil,omitempty" name:"MaxMessageBytes"`

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

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

	// Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.
	RetentionBytes *int64 `json:"RetentionBytes,omitnil,omitempty" name:"RetentionBytes"`

	// Tag list.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

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 CreateTopicRequestParams

type CreateTopicRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

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

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

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

	// IP allowlist list for quota limit, which is required if `enableWhileList` is 1
	IpWhiteList []*string `json:"IpWhiteList,omitnil,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,omitnil,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,omitnil,omitempty" name:"Note"`

	// Default value: 1
	MinInsyncReplicas *int64 `json:"MinInsyncReplicas,omitnil,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,omitnil,omitempty" name:"UncleanLeaderElectionEnable"`

	// Message retention period in milliseconds, which is optional. Min value: 60,000 ms.
	RetentionMs *int64 `json:"RetentionMs,omitnil,omitempty" name:"RetentionMs"`

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

	// Max message size in bytes. Value range: 1,024 bytes (1 KB) to 8,388,608 bytes (8 MB).
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitnil,omitempty" name:"MaxMessageBytes"`

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

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

	// Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.
	RetentionBytes *int64 `json:"RetentionBytes,omitnil,omitempty" name:"RetentionBytes"`

	// Tag list.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateTopicResp

type CreateTopicResp struct {
	// Topic ID
	TopicId *string `json:"TopicId,omitnil,omitempty" name:"TopicId"`
}

type CreateTopicResponse

type CreateTopicResponse struct {
	*tchttp.BaseResponse
	Response *CreateTopicResponseParams `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 CreateTopicResponseParams

type CreateTopicResponseParams struct {
	// Returned creation result
	Result *CreateTopicResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type CreateUserRequest

type CreateUserRequest struct {
	*tchttp.BaseRequest

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

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

	// User password
	Password *string `json:"Password,omitnil,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 CreateUserRequestParams

type CreateUserRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

Predefined struct for user

type CreateUserResponse

type CreateUserResponse struct {
	*tchttp.BaseResponse
	Response *CreateUserResponseParams `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 CreateUserResponseParams

type CreateUserResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DatahubTopicDTO

type DatahubTopicDTO struct {
	// Name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

	// The number of partitions
	PartitionNum *uint64 `json:"PartitionNum,omitnil,omitempty" name:"PartitionNum"`

	// Expiration time
	RetentionMs *uint64 `json:"RetentionMs,omitnil,omitempty" name:"RetentionMs"`

	// Remarks
	Note *string `json:"Note,omitnil,omitempty" name:"Note"`

	// Status (`1`: In use; `2`: Deleting)
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`
}

type DatahubTopicResp

type DatahubTopicResp struct {
	// Topic name
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

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

type DealInstanceDTO

type DealInstanceDTO struct {
	// Order list.  Note: This field may return null, indicating that no valid values can be obtained.
	DealName *string `json:"DealName,omitnil,omitempty" name:"DealName"`

	// ID list of the purchased CKafka instances corresponding to the order list.  Note: This field may return null, indicating that no valid values can be obtained.
	InstanceIdList []*string `json:"InstanceIdList,omitnil,omitempty" name:"InstanceIdList"`
}

type DeleteAclRequest

type DeleteAclRequest struct {
	*tchttp.BaseRequest

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

	// ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
	ResourceType *int64 `json:"ResourceType,omitnil,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; if `resourceType` is `CLUSTER`, this field can be left empty.
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).
	Operation *int64 `json:"Operation,omitnil,omitempty" name:"Operation"`

	// Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.
	PermissionType *int64 `json:"PermissionType,omitnil,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,omitnil,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,omitnil,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 DeleteAclRequestParams

type DeleteAclRequestParams struct {
	// Instance ID information
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
	ResourceType *int64 `json:"ResourceType,omitnil,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; if `resourceType` is `CLUSTER`, this field can be left empty.
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// ACL operation type (`2`: ALL, `3`: READ, `4`: WRITE, `5`: CREATE, `6`: DELETE, `7`: ALTER, `8`: DESCRIBE, `9`: CLUSTER_ACTION, `10`: DESCRIBE_CONFIGS, `11`: ALTER_CONFIGS, `12`: IDEMPOTENT_WRITE).
	Operation *int64 `json:"Operation,omitnil,omitempty" name:"Operation"`

	// Permission type (`2`: DENY, `3`: ALLOW). CKafka currently supports `ALLOW`, which is equivalent to allowlist. `DENY` will be supported for ACLs compatible with open-source Kafka.
	PermissionType *int64 `json:"PermissionType,omitnil,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,omitnil,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,omitnil,omitempty" name:"Principal"`
}

Predefined struct for user

type DeleteAclResponse

type DeleteAclResponse struct {
	*tchttp.BaseResponse
	Response *DeleteAclResponseParams `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 DeleteAclResponseParams

type DeleteAclResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DeleteInstancePreRequest

type DeleteInstancePreRequest struct {
	*tchttp.BaseRequest

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

func NewDeleteInstancePreRequest

func NewDeleteInstancePreRequest() (request *DeleteInstancePreRequest)

func (*DeleteInstancePreRequest) FromJsonString

func (r *DeleteInstancePreRequest) 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 (*DeleteInstancePreRequest) ToJsonString

func (r *DeleteInstancePreRequest) ToJsonString() string

type DeleteInstancePreRequestParams

type DeleteInstancePreRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DeleteInstancePreResponse

type DeleteInstancePreResponse struct {
	*tchttp.BaseResponse
	Response *DeleteInstancePreResponseParams `json:"Response"`
}

func NewDeleteInstancePreResponse

func NewDeleteInstancePreResponse() (response *DeleteInstancePreResponse)

func (*DeleteInstancePreResponse) FromJsonString

func (r *DeleteInstancePreResponse) 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 (*DeleteInstancePreResponse) ToJsonString

func (r *DeleteInstancePreResponse) ToJsonString() string

type DeleteInstancePreResponseParams

type DeleteInstancePreResponseParams struct {
	// Returned result
	Result *CreateInstancePreResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DeleteRouteRequest

type DeleteRouteRequest struct {
	*tchttp.BaseRequest

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

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

	// AppId of the caller.
	CallerAppid *int64 `json:"CallerAppid,omitnil,omitempty" name:"CallerAppid"`

	// The time when a route was deleted.
	DeleteRouteTime *string `json:"DeleteRouteTime,omitnil,omitempty" name:"DeleteRouteTime"`
}

func NewDeleteRouteRequest

func NewDeleteRouteRequest() (request *DeleteRouteRequest)

func (*DeleteRouteRequest) FromJsonString

func (r *DeleteRouteRequest) 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 (*DeleteRouteRequest) ToJsonString

func (r *DeleteRouteRequest) ToJsonString() string

type DeleteRouteRequestParams

type DeleteRouteRequestParams struct {
	// Unique instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

	// AppId of the caller.
	CallerAppid *int64 `json:"CallerAppid,omitnil,omitempty" name:"CallerAppid"`

	// The time when a route was deleted.
	DeleteRouteTime *string `json:"DeleteRouteTime,omitnil,omitempty" name:"DeleteRouteTime"`
}

Predefined struct for user

type DeleteRouteResponse

type DeleteRouteResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRouteResponseParams `json:"Response"`
}

func NewDeleteRouteResponse

func NewDeleteRouteResponse() (response *DeleteRouteResponse)

func (*DeleteRouteResponse) FromJsonString

func (r *DeleteRouteResponse) 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 (*DeleteRouteResponse) ToJsonString

func (r *DeleteRouteResponse) ToJsonString() string

type DeleteRouteResponseParams

type DeleteRouteResponseParams struct {
	// Returned result.
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DeleteRouteTriggerTimeRequest

type DeleteRouteTriggerTimeRequest struct {
	*tchttp.BaseRequest

	// Modification time.
	DelayTime *string `json:"DelayTime,omitnil,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 DeleteRouteTriggerTimeRequestParams

type DeleteRouteTriggerTimeRequestParams struct {
	// Modification time.
	DelayTime *string `json:"DelayTime,omitnil,omitempty" name:"DelayTime"`
}

Predefined struct for user

type DeleteRouteTriggerTimeResponse

type DeleteRouteTriggerTimeResponse struct {
	*tchttp.BaseResponse
	Response *DeleteRouteTriggerTimeResponseParams `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 DeleteRouteTriggerTimeResponseParams

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

Predefined struct for user

type DeleteTopicIpWhiteListRequest

type DeleteTopicIpWhiteListRequest struct {
	*tchttp.BaseRequest

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

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

	// IP allowlist list
	IpWhiteList []*string `json:"IpWhiteList,omitnil,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 DeleteTopicIpWhiteListRequestParams

type DeleteTopicIpWhiteListRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

Predefined struct for user

type DeleteTopicIpWhiteListResponse

type DeleteTopicIpWhiteListResponse struct {
	*tchttp.BaseResponse
	Response *DeleteTopicIpWhiteListResponseParams `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 DeleteTopicIpWhiteListResponseParams

type DeleteTopicIpWhiteListResponseParams struct {
	// Result of deleting topic IP allowlist
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DeleteTopicRequest

type DeleteTopicRequest struct {
	*tchttp.BaseRequest

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

	// CKafka topic name
	TopicName *string `json:"TopicName,omitnil,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 DeleteTopicRequestParams

type DeleteTopicRequestParams struct {
	// CKafka instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

Predefined struct for user

type DeleteTopicResponse

type DeleteTopicResponse struct {
	*tchttp.BaseResponse
	Response *DeleteTopicResponseParams `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 DeleteTopicResponseParams

type DeleteTopicResponseParams struct {
	// Returned result set
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DeleteUserRequest

type DeleteUserRequest struct {
	*tchttp.BaseRequest

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

	// Username
	Name *string `json:"Name,omitnil,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 DeleteUserRequestParams

type DeleteUserRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

Predefined struct for user

type DeleteUserResponse

type DeleteUserResponse struct {
	*tchttp.BaseResponse
	Response *DeleteUserResponseParams `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 DeleteUserResponseParams

type DeleteUserResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeACLRequest

type DescribeACLRequest struct {
	*tchttp.BaseRequest

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

	// ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
	ResourceType *int64 `json:"ResourceType,omitnil,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; if `resourceType` is `CLUSTER`, this field can be left empty.
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

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

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

	// Keyword match
	SearchWord *string `json:"SearchWord,omitnil,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 DescribeACLRequestParams

type DescribeACLRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// ACL resource type (`2`: TOPIC, `3`: GROUP, `4`: CLUSTER).
	ResourceType *int64 `json:"ResourceType,omitnil,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; if `resourceType` is `CLUSTER`, this field can be left empty.
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

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

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

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

Predefined struct for user

type DescribeACLResponse

type DescribeACLResponse struct {
	*tchttp.BaseResponse
	Response *DescribeACLResponseParams `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 DescribeACLResponseParams

type DescribeACLResponseParams struct {
	// Returned ACL result set object
	Result *AclResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeAclRuleRequest

type DescribeAclRuleRequest struct {
	*tchttp.BaseRequest

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

	// ACL rule name
	RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`

	// ACL rule matching type
	PatternType *string `json:"PatternType,omitnil,omitempty" name:"PatternType"`

	// Whether to read simplified ACL rules
	IsSimplified *bool `json:"IsSimplified,omitnil,omitempty" name:"IsSimplified"`
}

func NewDescribeAclRuleRequest

func NewDescribeAclRuleRequest() (request *DescribeAclRuleRequest)

func (*DescribeAclRuleRequest) FromJsonString

func (r *DescribeAclRuleRequest) 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 (*DescribeAclRuleRequest) ToJsonString

func (r *DescribeAclRuleRequest) ToJsonString() string

type DescribeAclRuleRequestParams

type DescribeAclRuleRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// ACL rule name
	RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`

	// ACL rule matching type
	PatternType *string `json:"PatternType,omitnil,omitempty" name:"PatternType"`

	// Whether to read simplified ACL rules
	IsSimplified *bool `json:"IsSimplified,omitnil,omitempty" name:"IsSimplified"`
}

Predefined struct for user

type DescribeAclRuleResponse

type DescribeAclRuleResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAclRuleResponseParams `json:"Response"`
}

func NewDescribeAclRuleResponse

func NewDescribeAclRuleResponse() (response *DescribeAclRuleResponse)

func (*DescribeAclRuleResponse) FromJsonString

func (r *DescribeAclRuleResponse) 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 (*DescribeAclRuleResponse) ToJsonString

func (r *DescribeAclRuleResponse) ToJsonString() string

type DescribeAclRuleResponseParams

type DescribeAclRuleResponseParams struct {
	// The set of returned ACL rules
	Result *AclRuleResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeAppInfoRequest

type DescribeAppInfoRequest struct {
	*tchttp.BaseRequest

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

	// Maximum number of users to be queried in this request. Maximum value: 50. Default value: 50
	Limit *int64 `json:"Limit,omitnil,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 DescribeAppInfoRequestParams

type DescribeAppInfoRequestParams struct {
	// Offset position
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

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

Predefined struct for user

type DescribeAppInfoResponse

type DescribeAppInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAppInfoResponseParams `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 DescribeAppInfoResponseParams

type DescribeAppInfoResponseParams struct {
	// Returned list of eligible `AppId`
	Result *AppIdResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeCkafkaZoneRequest

type DescribeCkafkaZoneRequest struct {
	*tchttp.BaseRequest

	// Cloud Dedicated Cluster (CDC) business parameter.
	CdcId *string `json:"CdcId,omitnil,omitempty" name:"CdcId"`
}

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 DescribeCkafkaZoneRequestParams

type DescribeCkafkaZoneRequestParams struct {
	// Cloud Dedicated Cluster (CDC) business parameter.
	CdcId *string `json:"CdcId,omitnil,omitempty" name:"CdcId"`
}

Predefined struct for user

type DescribeCkafkaZoneResponse

type DescribeCkafkaZoneResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCkafkaZoneResponseParams `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 DescribeCkafkaZoneResponseParams

type DescribeCkafkaZoneResponseParams struct {
	// Returned results for the query
	Result *ZoneResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeConnectInfoResultDTO

type DescribeConnectInfoResultDTO struct {
	// IP address
	// Note: This field may return null, indicating that no valid values can be obtained.
	IpAddr *string `json:"IpAddr,omitnil,omitempty" name:"IpAddr"`

	// Connection time
	// Note: This field may return null, indicating that no valid values can be obtained.
	Time *string `json:"Time,omitnil,omitempty" name:"Time"`

	// Whether it is a supported version
	// Note: This field may return null, indicating that no valid values can be obtained.
	IsUnSupportVersion *bool `json:"IsUnSupportVersion,omitnil,omitempty" name:"IsUnSupportVersion"`
}

type DescribeConsumerGroupRequest

type DescribeConsumerGroupRequest struct {
	*tchttp.BaseRequest

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

	// Name of the group to be queried, which is optional.
	GroupName *string `json:"GroupName,omitnil,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,omitnil,omitempty" name:"TopicName"`

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

	// Offset position
	Offset *int64 `json:"Offset,omitnil,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 DescribeConsumerGroupRequestParams

type DescribeConsumerGroupRequestParams struct {
	// CKafka instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Name of the group to be queried, which is optional.
	GroupName *string `json:"GroupName,omitnil,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,omitnil,omitempty" name:"TopicName"`

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

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

Predefined struct for user

type DescribeConsumerGroupResponse

type DescribeConsumerGroupResponse struct {
	*tchttp.BaseResponse
	Response *DescribeConsumerGroupResponseParams `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 DescribeConsumerGroupResponseParams

type DescribeConsumerGroupResponseParams struct {
	// Returned consumer group information
	Result *ConsumerGroupResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeDatahubTopicRequest

type DescribeDatahubTopicRequest struct {
	*tchttp.BaseRequest

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

func NewDescribeDatahubTopicRequest

func NewDescribeDatahubTopicRequest() (request *DescribeDatahubTopicRequest)

func (*DescribeDatahubTopicRequest) FromJsonString

func (r *DescribeDatahubTopicRequest) 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 (*DescribeDatahubTopicRequest) ToJsonString

func (r *DescribeDatahubTopicRequest) ToJsonString() string

type DescribeDatahubTopicRequestParams

type DescribeDatahubTopicRequestParams struct {
	// Name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

Predefined struct for user

type DescribeDatahubTopicResp

type DescribeDatahubTopicResp struct {
	// Name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

	// The number of partitions
	PartitionNum *uint64 `json:"PartitionNum,omitnil,omitempty" name:"PartitionNum"`

	// Expiration time
	RetentionMs *uint64 `json:"RetentionMs,omitnil,omitempty" name:"RetentionMs"`

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

	// Username
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// Password
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// Status (`1`: In use; `2`: Deleting)
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// Service routing address
	// Note: This field may return null, indicating that no valid values can be obtained.
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`
}

type DescribeDatahubTopicResponse

type DescribeDatahubTopicResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDatahubTopicResponseParams `json:"Response"`
}

func NewDescribeDatahubTopicResponse

func NewDescribeDatahubTopicResponse() (response *DescribeDatahubTopicResponse)

func (*DescribeDatahubTopicResponse) FromJsonString

func (r *DescribeDatahubTopicResponse) 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 (*DescribeDatahubTopicResponse) ToJsonString

func (r *DescribeDatahubTopicResponse) ToJsonString() string

type DescribeDatahubTopicResponseParams

type DescribeDatahubTopicResponseParams struct {
	// Returned result object
	Result *DescribeDatahubTopicResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeDatahubTopicsRequest

type DescribeDatahubTopicsRequest struct {
	*tchttp.BaseRequest

	// Keyword for query
	SearchWord *string `json:"SearchWord,omitnil,omitempty" name:"SearchWord"`

	// Query offset, which defaults to `0`.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

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

func NewDescribeDatahubTopicsRequest

func NewDescribeDatahubTopicsRequest() (request *DescribeDatahubTopicsRequest)

func (*DescribeDatahubTopicsRequest) FromJsonString

func (r *DescribeDatahubTopicsRequest) 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 (*DescribeDatahubTopicsRequest) ToJsonString

func (r *DescribeDatahubTopicsRequest) ToJsonString() string

type DescribeDatahubTopicsRequestParams

type DescribeDatahubTopicsRequestParams struct {
	// Keyword for query
	SearchWord *string `json:"SearchWord,omitnil,omitempty" name:"SearchWord"`

	// Query offset, which defaults to `0`.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

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

Predefined struct for user

type DescribeDatahubTopicsResp

type DescribeDatahubTopicsResp struct {
	// Total count
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

type DescribeDatahubTopicsResponse

type DescribeDatahubTopicsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDatahubTopicsResponseParams `json:"Response"`
}

func NewDescribeDatahubTopicsResponse

func NewDescribeDatahubTopicsResponse() (response *DescribeDatahubTopicsResponse)

func (*DescribeDatahubTopicsResponse) FromJsonString

func (r *DescribeDatahubTopicsResponse) 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 (*DescribeDatahubTopicsResponse) ToJsonString

func (r *DescribeDatahubTopicsResponse) ToJsonString() string

type DescribeDatahubTopicsResponseParams

type DescribeDatahubTopicsResponseParams struct {
	// Topic list
	// Note: This field may return null, indicating that no valid values can be obtained.
	Result *DescribeDatahubTopicsResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeGroup

type DescribeGroup struct {
	// groupId
	Group *string `json:"Group,omitnil,omitempty" name:"Group"`

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

type DescribeGroupInfoRequest

type DescribeGroupInfoRequest struct {
	*tchttp.BaseRequest

	// (Filter) filter by instance ID.
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,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 DescribeGroupInfoRequestParams

type DescribeGroupInfoRequestParams struct {
	// (Filter) filter by instance ID.
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,omitempty" name:"GroupList"`
}

Predefined struct for user

type DescribeGroupInfoResponse

type DescribeGroupInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupInfoResponseParams `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 DescribeGroupInfoResponseParams

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

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

Predefined struct for user

type DescribeGroupOffsetsRequest

type DescribeGroupOffsetsRequest struct {
	*tchttp.BaseRequest

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

	// Kafka consumer group
	Group *string `json:"Group,omitnil,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,omitnil,omitempty" name:"Topics"`

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

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

	// Maximum number of results to be returned in this request. Default value: 50. Maximum value: 50
	Limit *int64 `json:"Limit,omitnil,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 DescribeGroupOffsetsRequestParams

type DescribeGroupOffsetsRequestParams struct {
	// (Filter) filter by instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Kafka consumer group
	Group *string `json:"Group,omitnil,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,omitnil,omitempty" name:"Topics"`

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

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

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

Predefined struct for user

type DescribeGroupOffsetsResponse

type DescribeGroupOffsetsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupOffsetsResponseParams `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 DescribeGroupOffsetsResponseParams

type DescribeGroupOffsetsResponseParams struct {
	// Returned result object
	Result *GroupOffsetResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeGroupRequest

type DescribeGroupRequest struct {
	*tchttp.BaseRequest

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

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

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

	// Maximum number of results to be returned
	Limit *int64 `json:"Limit,omitnil,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 DescribeGroupRequestParams

type DescribeGroupRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

Predefined struct for user

type DescribeGroupResponse

type DescribeGroupResponse struct {
	*tchttp.BaseResponse
	Response *DescribeGroupResponseParams `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 DescribeGroupResponseParams

type DescribeGroupResponseParams struct {
	// List of returned results
	Result *GroupResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeInstanceAttributesRequest

type DescribeInstanceAttributesRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,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 DescribeInstanceAttributesRequestParams

type DescribeInstanceAttributesRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceAttributesResponse

type DescribeInstanceAttributesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceAttributesResponseParams `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 DescribeInstanceAttributesResponseParams

type DescribeInstanceAttributesResponseParams struct {
	// Returned result object of instance attributes
	Result *InstanceAttributesResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeInstancesDetailRequest

type DescribeInstancesDetailRequest struct {
	*tchttp.BaseRequest

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

	// Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.
	SearchWord *string `json:"SearchWord,omitnil,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,omitnil,omitempty" name:"Status"`

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

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

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

	// Filter. Valid values of `filter.Name` include `Ip`, `VpcId`, `SubNetId`, `InstanceType`, and `InstanceId`. Up to 10 values can be passed for `filter.Values`.
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// This parameter has been deprecated and replaced with `InstanceIdList`.
	InstanceIds *string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// Filter by instance ID.
	InstanceIdList []*string `json:"InstanceIdList,omitnil,omitempty" name:"InstanceIdList"`

	// Filter instances by a set of tags
	TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}

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 DescribeInstancesDetailRequestParams

type DescribeInstancesDetailRequestParams struct {
	// (Filter) filter by instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.
	SearchWord *string `json:"SearchWord,omitnil,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,omitnil,omitempty" name:"Status"`

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

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

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

	// Filter. Valid values of `filter.Name` include `Ip`, `VpcId`, `SubNetId`, `InstanceType`, and `InstanceId`. Up to 10 values can be passed for `filter.Values`.
	Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`

	// This parameter has been deprecated and replaced with `InstanceIdList`.
	InstanceIds *string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// Filter by instance ID.
	InstanceIdList []*string `json:"InstanceIdList,omitnil,omitempty" name:"InstanceIdList"`

	// Filter instances by a set of tags
	TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}

Predefined struct for user

type DescribeInstancesDetailResponse

type DescribeInstancesDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesDetailResponseParams `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 DescribeInstancesDetailResponseParams

type DescribeInstancesDetailResponseParams struct {
	// Returned result object of instance details
	Result *InstanceDetailResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeInstancesRequest

type DescribeInstancesRequest struct {
	*tchttp.BaseRequest

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

	// (Filter) filter by instance name. Fuzzy search is supported
	SearchWord *string `json:"SearchWord,omitnil,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,omitnil,omitempty" name:"Status"`

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Limit"`

	// Tag key value (this field has been deprecated).
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// VPC ID.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`
}

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 DescribeInstancesRequestParams

type DescribeInstancesRequestParams struct {
	// (Filter) filter by instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// (Filter) filter by instance name. Fuzzy search is supported
	SearchWord *string `json:"SearchWord,omitnil,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,omitnil,omitempty" name:"Status"`

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Limit"`

	// Tag key value (this field has been deprecated).
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// VPC ID.
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`
}

Predefined struct for user

type DescribeInstancesResponse

type DescribeInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesResponseParams `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 DescribeInstancesResponseParams

type DescribeInstancesResponseParams struct {
	// Returned result
	Result *InstanceResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeRegionRequest

type DescribeRegionRequest struct {
	*tchttp.BaseRequest

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

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

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

	// CDC business field, which can be ignored.
	CdcId *string `json:"CdcId,omitnil,omitempty" name:"CdcId"`
}

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 DescribeRegionRequestParams

type DescribeRegionRequestParams struct {
	// The offset value
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

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

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

	// CDC business field, which can be ignored.
	CdcId *string `json:"CdcId,omitnil,omitempty" name:"CdcId"`
}

Predefined struct for user

type DescribeRegionResponse

type DescribeRegionResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRegionResponseParams `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 DescribeRegionResponseParams

type DescribeRegionResponseParams 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,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeRouteRequest

type DescribeRouteRequest struct {
	*tchttp.BaseRequest

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

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

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 DescribeRouteRequestParams

type DescribeRouteRequestParams struct {
	// Unique instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

Predefined struct for user

type DescribeRouteResponse

type DescribeRouteResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRouteResponseParams `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 DescribeRouteResponseParams

type DescribeRouteResponseParams struct {
	// Returned result set of route information
	Result *RouteResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTaskStatusRequest

type DescribeTaskStatusRequest struct {
	*tchttp.BaseRequest

	// Unique task ID
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`
}

func NewDescribeTaskStatusRequest

func NewDescribeTaskStatusRequest() (request *DescribeTaskStatusRequest)

func (*DescribeTaskStatusRequest) FromJsonString

func (r *DescribeTaskStatusRequest) 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 (*DescribeTaskStatusRequest) ToJsonString

func (r *DescribeTaskStatusRequest) ToJsonString() string

type DescribeTaskStatusRequestParams

type DescribeTaskStatusRequestParams struct {
	// Unique task ID
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`
}

Predefined struct for user

type DescribeTaskStatusResponse

type DescribeTaskStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTaskStatusResponseParams `json:"Response"`
}

func NewDescribeTaskStatusResponse

func NewDescribeTaskStatusResponse() (response *DescribeTaskStatusResponse)

func (*DescribeTaskStatusResponse) FromJsonString

func (r *DescribeTaskStatusResponse) 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 (*DescribeTaskStatusResponse) ToJsonString

func (r *DescribeTaskStatusResponse) ToJsonString() string

type DescribeTaskStatusResponseParams

type DescribeTaskStatusResponseParams struct {
	// Returned result
	Result *TaskStatusResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTopicAttributesRequest

type DescribeTopicAttributesRequest struct {
	*tchttp.BaseRequest

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

	// Topic name
	TopicName *string `json:"TopicName,omitnil,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 DescribeTopicAttributesRequestParams

type DescribeTopicAttributesRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

Predefined struct for user

type DescribeTopicAttributesResponse

type DescribeTopicAttributesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTopicAttributesResponseParams `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 DescribeTopicAttributesResponseParams

type DescribeTopicAttributesResponseParams struct {
	// Returned result object
	Result *TopicAttributesResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTopicDetailRequest

type DescribeTopicDetailRequest struct {
	*tchttp.BaseRequest

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

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

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Limit"`

	// Name of the preset ACL rule.
	AclRuleName *string `json:"AclRuleName,omitnil,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 DescribeTopicDetailRequestParams

type DescribeTopicDetailRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

	// Offset. If this parameter is left empty, 0 will be used by default
	Offset *int64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Limit"`

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

Predefined struct for user

type DescribeTopicDetailResponse

type DescribeTopicDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTopicDetailResponseParams `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 DescribeTopicDetailResponseParams

type DescribeTopicDetailResponseParams struct {
	// Returned entity of topic details
	Result *TopicDetailResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTopicProduceConnectionRequest

type DescribeTopicProduceConnectionRequest struct {
	*tchttp.BaseRequest

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

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

func NewDescribeTopicProduceConnectionRequest

func NewDescribeTopicProduceConnectionRequest() (request *DescribeTopicProduceConnectionRequest)

func (*DescribeTopicProduceConnectionRequest) FromJsonString

func (r *DescribeTopicProduceConnectionRequest) 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 (*DescribeTopicProduceConnectionRequest) ToJsonString

type DescribeTopicProduceConnectionRequestParams

type DescribeTopicProduceConnectionRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

Predefined struct for user

type DescribeTopicProduceConnectionResponse

type DescribeTopicProduceConnectionResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTopicProduceConnectionResponseParams `json:"Response"`
}

func NewDescribeTopicProduceConnectionResponse

func NewDescribeTopicProduceConnectionResponse() (response *DescribeTopicProduceConnectionResponse)

func (*DescribeTopicProduceConnectionResponse) FromJsonString

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

func (*DescribeTopicProduceConnectionResponse) ToJsonString

type DescribeTopicProduceConnectionResponseParams

type DescribeTopicProduceConnectionResponseParams struct {
	// Result set of returned connection information
	Result []*DescribeConnectInfoResultDTO `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTopicRequest

type DescribeTopicRequest struct {
	*tchttp.BaseRequest

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

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

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

	// The number of results to be returned, which defaults to 20 if left empty. The maximum value is 50.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Name of the preset ACL rule.
	AclRuleName *string `json:"AclRuleName,omitnil,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 DescribeTopicRequestParams

type DescribeTopicRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

	// The number of results to be returned, which defaults to 20 if left empty. The maximum value is 50.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

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

Predefined struct for user

type DescribeTopicResponse

type DescribeTopicResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTopicResponseParams `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 DescribeTopicResponseParams

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

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

Predefined struct for user

type DescribeTopicSubscribeGroupRequest

type DescribeTopicSubscribeGroupRequest struct {
	*tchttp.BaseRequest

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

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

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

	// Number of results per page
	Limit *uint64 `json:"Limit,omitnil,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 DescribeTopicSubscribeGroupRequestParams

type DescribeTopicSubscribeGroupRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

Predefined struct for user

type DescribeTopicSubscribeGroupResponse

type DescribeTopicSubscribeGroupResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTopicSubscribeGroupResponseParams `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 DescribeTopicSubscribeGroupResponseParams

type DescribeTopicSubscribeGroupResponseParams struct {
	// Returned results
	Result *TopicSubscribeGroup `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeTopicSyncReplicaRequest

type DescribeTopicSyncReplicaRequest struct {
	*tchttp.BaseRequest

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

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

	// Offset. If this parameter is left empty, 0 will be used by default.
	Offset *uint64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Limit"`

	// Filters unsynced replicas only
	OutOfSyncReplicaOnly *bool `json:"OutOfSyncReplicaOnly,omitnil,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 DescribeTopicSyncReplicaRequestParams

type DescribeTopicSyncReplicaRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

	// Offset. If this parameter is left empty, 0 will be used by default.
	Offset *uint64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Limit"`

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

Predefined struct for user

type DescribeTopicSyncReplicaResponse

type DescribeTopicSyncReplicaResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTopicSyncReplicaResponseParams `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 DescribeTopicSyncReplicaResponseParams

type DescribeTopicSyncReplicaResponseParams struct {
	// Returns topic replica details
	Result *TopicInSyncReplicaResult `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DescribeUserRequest

type DescribeUserRequest struct {
	*tchttp.BaseRequest

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

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

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

	// Number of results to be returned in this request
	Limit *int64 `json:"Limit,omitnil,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 DescribeUserRequestParams

type DescribeUserRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

Predefined struct for user

type DescribeUserResponse

type DescribeUserResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserResponseParams `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 DescribeUserResponseParams

type DescribeUserResponseParams struct {
	// Returned result list
	Result *UserResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type DynamicDiskConfig

type DynamicDiskConfig struct {
	// Whether to enable dynamic disk expansion configuration. `0`: disable, `1`: enable.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Enable *int64 `json:"Enable,omitnil,omitempty" name:"Enable"`

	// Percentage of dynamic disk expansion each time.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	StepForwardPercentage *int64 `json:"StepForwardPercentage,omitnil,omitempty" name:"StepForwardPercentage"`

	// Disk quota threshold (in percentage) for triggering the automatic disk expansion event.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	DiskQuotaPercentage *int64 `json:"DiskQuotaPercentage,omitnil,omitempty" name:"DiskQuotaPercentage"`

	// Max disk space in GB.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	MaxDiskSpace *int64 `json:"MaxDiskSpace,omitnil,omitempty" name:"MaxDiskSpace"`
}

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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"BottomRetention"`
}

type FetchMessageByOffsetRequest

type FetchMessageByOffsetRequest struct {
	*tchttp.BaseRequest

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

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

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

	// Offset information, which is required.
	Offset *int64 `json:"Offset,omitnil,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 FetchMessageByOffsetRequestParams

type FetchMessageByOffsetRequestParams struct {
	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

	// Offset information, which is required.
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type FetchMessageByOffsetResponse

type FetchMessageByOffsetResponse struct {
	*tchttp.BaseResponse
	Response *FetchMessageByOffsetResponseParams `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 FetchMessageByOffsetResponseParams

type FetchMessageByOffsetResponseParams struct {
	// Returned results
	Result *ConsumerRecord `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type FetchMessageListByOffsetRequest

type FetchMessageListByOffsetRequest struct {
	*tchttp.BaseRequest

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

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

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

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

	// The maximum number of messages that can be queried. Default value: 20. Maximum value: 20.
	SinglePartitionRecordNumber *int64 `json:"SinglePartitionRecordNumber,omitnil,omitempty" name:"SinglePartitionRecordNumber"`
}

func NewFetchMessageListByOffsetRequest

func NewFetchMessageListByOffsetRequest() (request *FetchMessageListByOffsetRequest)

func (*FetchMessageListByOffsetRequest) FromJsonString

func (r *FetchMessageListByOffsetRequest) 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 (*FetchMessageListByOffsetRequest) ToJsonString

func (r *FetchMessageListByOffsetRequest) ToJsonString() string

type FetchMessageListByOffsetRequestParams

type FetchMessageListByOffsetRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

	// The maximum number of messages that can be queried. Default value: 20. Maximum value: 20.
	SinglePartitionRecordNumber *int64 `json:"SinglePartitionRecordNumber,omitnil,omitempty" name:"SinglePartitionRecordNumber"`
}

Predefined struct for user

type FetchMessageListByOffsetResponse

type FetchMessageListByOffsetResponse struct {
	*tchttp.BaseResponse
	Response *FetchMessageListByOffsetResponseParams `json:"Response"`
}

func NewFetchMessageListByOffsetResponse

func NewFetchMessageListByOffsetResponse() (response *FetchMessageListByOffsetResponse)

func (*FetchMessageListByOffsetResponse) FromJsonString

func (r *FetchMessageListByOffsetResponse) 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 (*FetchMessageListByOffsetResponse) ToJsonString

func (r *FetchMessageListByOffsetResponse) ToJsonString() string

type FetchMessageListByOffsetResponseParams

type FetchMessageListByOffsetResponseParams struct {
	// Returned result. Note: The returned list does not display the message content (key and value). To query the message content, call the `FetchMessageByOffset` API.
	Result []*ConsumerRecord `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type Filter

type Filter struct {
	// Field to be filtered.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

type Group

type Group struct {
	// Group name
	GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
}

type GroupInfoMember

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

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

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

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

type GroupInfoResponse

type GroupInfoResponse struct {
	// Error code. 0: success
	ErrorCode *string `json:"ErrorCode,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"Protocol"`

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

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

type GroupInfoTopics

type GroupInfoTopics struct {
	// Name of assigned topics
	Topic *string `json:"Topic,omitnil,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,omitnil,omitempty" name:"Partitions"`
}

type GroupOffsetPartition

type GroupOffsetPartition struct {
	// Topic `partitionId`
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// Offset position submitted by consumer
	Offset *int64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Metadata"`

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

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

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

type GroupOffsetResponse

type GroupOffsetResponse struct {
	// Total number of eligible results
	TotalCount *int64 `json:"TotalCount,omitnil,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,omitnil,omitempty" name:"TopicList"`
}

type GroupOffsetTopic

type GroupOffsetTopic struct {
	// Topic name
	Topic *string `json:"Topic,omitnil,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,omitnil,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,omitnil,omitempty" name:"TotalCount"`

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

	// Consumer group quota
	// Note: This field may return null, indicating that no valid values can be obtained.
	GroupCountQuota *uint64 `json:"GroupCountQuota,omitnil,omitempty" name:"GroupCountQuota"`
}

type InquireCkafkaPriceRequest

type InquireCkafkaPriceRequest struct {
	*tchttp.BaseRequest

	// `standard`: Standard Edition; `profession`: Pro Edition
	InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// Billing mode for instance purchase/renewal. If this parameter is left empty when you purchase an instance, the fees for one month under the monthly subscription mode will be displayed by default.
	InstanceChargeParam *InstanceChargeParam `json:"InstanceChargeParam,omitnil,omitempty" name:"InstanceChargeParam"`

	// The number of instances to be purchased or renewed. If this parameter is left empty, the default value is `1`.
	InstanceNum *int64 `json:"InstanceNum,omitnil,omitempty" name:"InstanceNum"`

	// Private network bandwidth in MB/sec, which is required when you purchase an instance.
	Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`

	// Disk type and size, which is required when you purchase an instance.
	InquiryDiskParam *InquiryDiskParam `json:"InquiryDiskParam,omitnil,omitempty" name:"InquiryDiskParam"`

	// Message retention period in hours, which is required when you purchase an instance.
	MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`

	// The number of instance topics to be purchased, which is required when you purchase an instance.
	Topic *int64 `json:"Topic,omitnil,omitempty" name:"Topic"`

	// The number of instance partitions to be purchased, which is required when you purchase an instance.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// The region for instance purchase, which can be obtained via the `DescribeCkafkaZone` API.
	ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`

	// Operation type flag. `purchase`: Making new purchases; `renew`: Renewing an instance. The default value is `purchase` if this parameter is left empty.
	CategoryAction *string `json:"CategoryAction,omitnil,omitempty" name:"CategoryAction"`

	// This field is not required.
	BillType *string `json:"BillType,omitnil,omitempty" name:"BillType"`

	// Billing mode for public network bandwidth, which is required when you purchase public network bandwidth. Currently, public network bandwidth is only supported for Pro Edition.
	PublicNetworkParam *InquiryPublicNetworkParam `json:"PublicNetworkParam,omitnil,omitempty" name:"PublicNetworkParam"`

	// ID of the instance to be renewed, which is required when you renew an instance.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewInquireCkafkaPriceRequest

func NewInquireCkafkaPriceRequest() (request *InquireCkafkaPriceRequest)

func (*InquireCkafkaPriceRequest) FromJsonString

func (r *InquireCkafkaPriceRequest) 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 (*InquireCkafkaPriceRequest) ToJsonString

func (r *InquireCkafkaPriceRequest) ToJsonString() string

type InquireCkafkaPriceRequestParams

type InquireCkafkaPriceRequestParams struct {
	// `standard`: Standard Edition; `profession`: Pro Edition
	InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// Billing mode for instance purchase/renewal. If this parameter is left empty when you purchase an instance, the fees for one month under the monthly subscription mode will be displayed by default.
	InstanceChargeParam *InstanceChargeParam `json:"InstanceChargeParam,omitnil,omitempty" name:"InstanceChargeParam"`

	// The number of instances to be purchased or renewed. If this parameter is left empty, the default value is `1`.
	InstanceNum *int64 `json:"InstanceNum,omitnil,omitempty" name:"InstanceNum"`

	// Private network bandwidth in MB/sec, which is required when you purchase an instance.
	Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`

	// Disk type and size, which is required when you purchase an instance.
	InquiryDiskParam *InquiryDiskParam `json:"InquiryDiskParam,omitnil,omitempty" name:"InquiryDiskParam"`

	// Message retention period in hours, which is required when you purchase an instance.
	MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`

	// The number of instance topics to be purchased, which is required when you purchase an instance.
	Topic *int64 `json:"Topic,omitnil,omitempty" name:"Topic"`

	// The number of instance partitions to be purchased, which is required when you purchase an instance.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// The region for instance purchase, which can be obtained via the `DescribeCkafkaZone` API.
	ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`

	// Operation type flag. `purchase`: Making new purchases; `renew`: Renewing an instance. The default value is `purchase` if this parameter is left empty.
	CategoryAction *string `json:"CategoryAction,omitnil,omitempty" name:"CategoryAction"`

	// This field is not required.
	BillType *string `json:"BillType,omitnil,omitempty" name:"BillType"`

	// Billing mode for public network bandwidth, which is required when you purchase public network bandwidth. Currently, public network bandwidth is only supported for Pro Edition.
	PublicNetworkParam *InquiryPublicNetworkParam `json:"PublicNetworkParam,omitnil,omitempty" name:"PublicNetworkParam"`

	// ID of the instance to be renewed, which is required when you renew an instance.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type InquireCkafkaPriceResp

type InquireCkafkaPriceResp struct {
	// Instance price
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstancePrice *InquiryPrice `json:"InstancePrice,omitnil,omitempty" name:"InstancePrice"`

	// Public network bandwidth price
	// Note: This field may return null, indicating that no valid values can be obtained.
	PublicNetworkBandwidthPrice *InquiryPrice `json:"PublicNetworkBandwidthPrice,omitnil,omitempty" name:"PublicNetworkBandwidthPrice"`
}

type InquireCkafkaPriceResponse

type InquireCkafkaPriceResponse struct {
	*tchttp.BaseResponse
	Response *InquireCkafkaPriceResponseParams `json:"Response"`
}

func NewInquireCkafkaPriceResponse

func NewInquireCkafkaPriceResponse() (response *InquireCkafkaPriceResponse)

func (*InquireCkafkaPriceResponse) FromJsonString

func (r *InquireCkafkaPriceResponse) 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 (*InquireCkafkaPriceResponse) ToJsonString

func (r *InquireCkafkaPriceResponse) ToJsonString() string

type InquireCkafkaPriceResponseParams

type InquireCkafkaPriceResponseParams struct {
	// Output parameters
	Result *InquireCkafkaPriceResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type InquiryBasePrice

type InquiryBasePrice struct {
	// Original unit price
	// Note: This field may return null, indicating that no valid values can be obtained.
	UnitPrice *float64 `json:"UnitPrice,omitnil,omitempty" name:"UnitPrice"`

	// Discounted unit price
	// Note: This field may return null, indicating that no valid values can be obtained.
	UnitPriceDiscount *float64 `json:"UnitPriceDiscount,omitnil,omitempty" name:"UnitPriceDiscount"`

	// Original price in total
	// Note: This field may return null, indicating that no valid values can be obtained.
	OriginalPrice *float64 `json:"OriginalPrice,omitnil,omitempty" name:"OriginalPrice"`

	// Discounted price in total
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiscountPrice *float64 `json:"DiscountPrice,omitnil,omitempty" name:"DiscountPrice"`

	// Discount (%)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Discount *float64 `json:"Discount,omitnil,omitempty" name:"Discount"`

	// Number of purchased items
	// Note: This field may return null, indicating that no valid values can be obtained.
	GoodsNum *int64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// Currency for payment
	// Note: This field may return null, indicating that no valid values can be obtained.
	Currency *string `json:"Currency,omitnil,omitempty" name:"Currency"`

	// Dedicated disk response parameter
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Validity period
	// Note: This field may return null, indicating that no valid values can be obtained.
	TimeSpan *int64 `json:"TimeSpan,omitnil,omitempty" name:"TimeSpan"`

	// Unit of the validity period (`m`: Month; `h`: Hour)
	// Note: This field may return null, indicating that no valid values can be obtained.
	TimeUnit *string `json:"TimeUnit,omitnil,omitempty" name:"TimeUnit"`

	// Purchase quantity
	// Note: This field may return null, indicating that no valid values can be obtained.
	Value *int64 `json:"Value,omitnil,omitempty" name:"Value"`
}

type InquiryDetailPrice

type InquiryDetailPrice struct {
	// Price of additional private network bandwidth
	// Note: This field may return null, indicating that no valid values can be obtained.
	BandwidthPrice *InquiryBasePrice `json:"BandwidthPrice,omitnil,omitempty" name:"BandwidthPrice"`

	// Disk price
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskPrice *InquiryBasePrice `json:"DiskPrice,omitnil,omitempty" name:"DiskPrice"`

	// Price of additional partitions
	// Note: This field may return null, indicating that no valid values can be obtained.
	PartitionPrice *InquiryBasePrice `json:"PartitionPrice,omitnil,omitempty" name:"PartitionPrice"`

	// Price of additional topics
	// Note: This field may return null, indicating that no valid values can be obtained.
	TopicPrice *InquiryBasePrice `json:"TopicPrice,omitnil,omitempty" name:"TopicPrice"`

	// Instance package price
	// Note: This field may return null, indicating that no valid values can be obtained.
	InstanceTypePrice *InquiryBasePrice `json:"InstanceTypePrice,omitnil,omitempty" name:"InstanceTypePrice"`
}

type InquiryDiskParam

type InquiryDiskParam struct {
	// Disk type. Valid values: `SSD` (SSD), `CLOUD_SSD` (SSD cloud disk), `CLOUD_PREMIUM` (Premium cloud disk), `CLOUD_BASIC` (Cloud disk).
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Size of the purchased disk in GB
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`
}

type InquiryPrice

type InquiryPrice struct {
	// Original unit price
	// Note: This field may return null, indicating that no valid values can be obtained.
	UnitPrice *float64 `json:"UnitPrice,omitnil,omitempty" name:"UnitPrice"`

	// Discounted unit price
	// Note: This field may return null, indicating that no valid values can be obtained.
	UnitPriceDiscount *float64 `json:"UnitPriceDiscount,omitnil,omitempty" name:"UnitPriceDiscount"`

	// Original price in total
	// Note: This field may return null, indicating that no valid values can be obtained.
	OriginalPrice *float64 `json:"OriginalPrice,omitnil,omitempty" name:"OriginalPrice"`

	// Discounted price in total
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiscountPrice *float64 `json:"DiscountPrice,omitnil,omitempty" name:"DiscountPrice"`

	// Discount (%)
	// Note: This field may return null, indicating that no valid values can be obtained.
	Discount *float64 `json:"Discount,omitnil,omitempty" name:"Discount"`

	// Number of purchased items
	// Note: This field may return null, indicating that no valid values can be obtained.
	GoodsNum *int64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// Currency for payment
	// Note: This field may return null, indicating that no valid values can be obtained.
	Currency *string `json:"Currency,omitnil,omitempty" name:"Currency"`

	// Dedicated disk response parameter
	// Note: This field may return null, indicating that no valid values can be obtained.
	DiskType *string `json:"DiskType,omitnil,omitempty" name:"DiskType"`

	// Validity period
	// Note: This field may return null, indicating that no valid values can be obtained.
	TimeSpan *int64 `json:"TimeSpan,omitnil,omitempty" name:"TimeSpan"`

	// Unit of the validity period (`m`: Month; `h`: Hour)
	// Note: This field may return null, indicating that no valid values can be obtained.
	TimeUnit *string `json:"TimeUnit,omitnil,omitempty" name:"TimeUnit"`

	// Purchase quantity
	// Note: This field may return null, indicating that no valid values can be obtained.
	Value *int64 `json:"Value,omitnil,omitempty" name:"Value"`

	// Prices of different purchased items
	// Note: This field may return null, indicating that no valid values can be obtained.
	DetailPrices *InquiryDetailPrice `json:"DetailPrices,omitnil,omitempty" name:"DetailPrices"`
}

type InquiryPublicNetworkParam

type InquiryPublicNetworkParam struct {
	// Public network bandwidth billing mode (`BANDWIDTH_PREPAID`: Monthly subscription; `BANDWIDTH_POSTPAID_BY_HOUR`: Bill-by-hour)
	PublicNetworkChargeType *string `json:"PublicNetworkChargeType,omitnil,omitempty" name:"PublicNetworkChargeType"`

	// Public network bandwidth in MB
	PublicNetworkMonthly *int64 `json:"PublicNetworkMonthly,omitnil,omitempty" name:"PublicNetworkMonthly"`
}

type Instance

type Instance struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

	// Instance status. 0: creating, 1: running, 2: deleting, 5: isolated, -1: creation failed
	Status *int64 `json:"Status,omitnil,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,omitnil,omitempty" name:"IfCommunity"`
}

type InstanceAttributesResponse

type InstanceAttributesResponse struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

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

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

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

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

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

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

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

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

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

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

	// Message retention period in minutes
	MsgRetentionTime *int64 `json:"MsgRetentionTime,omitnil,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,omitnil,omitempty" name:"Config"`

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

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

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

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

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

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

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

	// Kafka version information
	// Note: this field may return null, indicating that no valid values can be obtained.
	Version *string `json:"Version,omitnil,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,omitnil,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,omitnil,omitempty" name:"Cvm"`

	// Type.
	// Note: this field may return `null`, indicating that no valid value was found.
	InstanceType *string `json:"InstanceType,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"MaxConnection"`

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

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

	// Number of remaining creatable partitions
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	RemainingPartitions *int64 `json:"RemainingPartitions,omitnil,omitempty" name:"RemainingPartitions"`

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

	// Dynamic disk expansion policy.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	DynamicDiskConfig *DynamicDiskConfig `json:"DynamicDiskConfig,omitnil,omitempty" name:"DynamicDiskConfig"`
}

type InstanceChargeParam

type InstanceChargeParam struct {
	// Instance billing mode (`PREPAID`: Monthly subscription; `POSTPAID_BY_HOUR`: Pay-as-you-go)
	InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"`

	// Validity period, which is only required for the monthly subscription billing mode
	InstanceChargePeriod *int64 `json:"InstanceChargePeriod,omitnil,omitempty" name:"InstanceChargePeriod"`
}

type InstanceConfigDO

type InstanceConfigDO struct {
	// Whether to create topics automatically
	AutoCreateTopicsEnable *bool `json:"AutoCreateTopicsEnable,omitnil,omitempty" name:"AutoCreateTopicsEnable"`

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

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

type InstanceDetail

type InstanceDetail struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

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

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

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

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

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

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

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

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

	// Instance status. An int-type value will be returned. `0`: Healthy, `1`: Alarmed, `2`: Exceptional
	Healthy *int64 `json:"Healthy,omitnil,omitempty" name:"Healthy"`

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

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

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

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

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

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

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

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

	// CKafka sale type
	// Note: this field may return null, indicating that no valid values can be obtained.
	Cvm *int64 `json:"Cvm,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"RebalanceTime"`

	// Number of partitions in the current instance.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	PartitionNumber *uint64 `json:"PartitionNumber,omitnil,omitempty" name:"PartitionNumber"`

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

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

	// Instance type.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// Instance feature list.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Features []*string `json:"Features,omitnil,omitempty" name:"Features"`
}

type InstanceDetailResponse

type InstanceDetailResponse struct {
	// Total number of eligible instances
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

type InstanceQuotaConfigResp

type InstanceQuotaConfigResp struct {
	// Production throttling in MB/sec.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	QuotaProducerByteRate *int64 `json:"QuotaProducerByteRate,omitnil,omitempty" name:"QuotaProducerByteRate"`

	// Consumption throttling in MB/sec.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	QuotaConsumerByteRate *int64 `json:"QuotaConsumerByteRate,omitnil,omitempty" name:"QuotaConsumerByteRate"`
}

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,omitnil,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,omitnil,omitempty" name:"TotalCount"`
}

type JgwOperateResponse

type JgwOperateResponse struct {
	// Returned code. 0: normal, other values: error
	ReturnCode *string `json:"ReturnCode,omitnil,omitempty" name:"ReturnCode"`

	// Success message
	ReturnMessage *string `json:"ReturnMessage,omitnil,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,omitnil,omitempty" name:"Data"`
}

type ModifyAclRuleRequest

type ModifyAclRuleRequest struct {
	*tchttp.BaseRequest

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

	// ACL policy name
	RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`

	// Whether to be applied to new topics
	IsApplied *int64 `json:"IsApplied,omitnil,omitempty" name:"IsApplied"`
}

func NewModifyAclRuleRequest

func NewModifyAclRuleRequest() (request *ModifyAclRuleRequest)

func (*ModifyAclRuleRequest) FromJsonString

func (r *ModifyAclRuleRequest) 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 (*ModifyAclRuleRequest) ToJsonString

func (r *ModifyAclRuleRequest) ToJsonString() string

type ModifyAclRuleRequestParams

type ModifyAclRuleRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// ACL policy name
	RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`

	// Whether to be applied to new topics
	IsApplied *int64 `json:"IsApplied,omitnil,omitempty" name:"IsApplied"`
}

Predefined struct for user

type ModifyAclRuleResponse

type ModifyAclRuleResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAclRuleResponseParams `json:"Response"`
}

func NewModifyAclRuleResponse

func NewModifyAclRuleResponse() (response *ModifyAclRuleResponse)

func (*ModifyAclRuleResponse) FromJsonString

func (r *ModifyAclRuleResponse) 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 (*ModifyAclRuleResponse) ToJsonString

func (r *ModifyAclRuleResponse) ToJsonString() string

type ModifyAclRuleResponseParams

type ModifyAclRuleResponseParams struct {
	// Unique key of a rule
	Result *int64 `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type ModifyDatahubTopicRequest

type ModifyDatahubTopicRequest struct {
	*tchttp.BaseRequest

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

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

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

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

func NewModifyDatahubTopicRequest

func NewModifyDatahubTopicRequest() (request *ModifyDatahubTopicRequest)

func (*ModifyDatahubTopicRequest) FromJsonString

func (r *ModifyDatahubTopicRequest) 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 (*ModifyDatahubTopicRequest) ToJsonString

func (r *ModifyDatahubTopicRequest) ToJsonString() string

type ModifyDatahubTopicRequestParams

type ModifyDatahubTopicRequestParams struct {
	// Name
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

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

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

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

Predefined struct for user

type ModifyDatahubTopicResponse

type ModifyDatahubTopicResponse struct {
	*tchttp.BaseResponse
	Response *ModifyDatahubTopicResponseParams `json:"Response"`
}

func NewModifyDatahubTopicResponse

func NewModifyDatahubTopicResponse() (response *ModifyDatahubTopicResponse)

func (*ModifyDatahubTopicResponse) FromJsonString

func (r *ModifyDatahubTopicResponse) 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 (*ModifyDatahubTopicResponse) ToJsonString

func (r *ModifyDatahubTopicResponse) ToJsonString() string

type ModifyDatahubTopicResponseParams

type ModifyDatahubTopicResponseParams struct {
	// Returned result set
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type ModifyGroupOffsetsRequest

type ModifyGroupOffsetsRequest struct {
	*tchttp.BaseRequest

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

	// Kafka consumer group
	Group *string `json:"Group,omitnil,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,omitnil,omitempty" name:"Strategy"`

	// Indicates the topics to be reset. If this parameter is left empty, all topics will be reset
	Topics []*string `json:"Topics,omitnil,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,omitnil,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,omitnil,omitempty" name:"ShiftTimestamp"`

	// Position of the offset that needs to be reset. When `strategy` is 2, this field is required
	Offset *int64 `json:"Offset,omitnil,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,omitnil,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 ModifyGroupOffsetsRequestParams

type ModifyGroupOffsetsRequestParams struct {
	// Kafka instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Kafka consumer group
	Group *string `json:"Group,omitnil,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,omitnil,omitempty" name:"Strategy"`

	// Indicates the topics to be reset. If this parameter is left empty, all topics will be reset
	Topics []*string `json:"Topics,omitnil,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,omitnil,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,omitnil,omitempty" name:"ShiftTimestamp"`

	// Position of the offset that needs to be reset. When `strategy` is 2, this field is required
	Offset *int64 `json:"Offset,omitnil,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,omitnil,omitempty" name:"Partitions"`
}

Predefined struct for user

type ModifyGroupOffsetsResponse

type ModifyGroupOffsetsResponse struct {
	*tchttp.BaseResponse
	Response *ModifyGroupOffsetsResponseParams `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 ModifyGroupOffsetsResponseParams

type ModifyGroupOffsetsResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type ModifyInstanceAttributesConfig

type ModifyInstanceAttributesConfig struct {
	// Automatic creation. true: enabled, false: not enabled
	AutoCreateTopicEnable *bool `json:"AutoCreateTopicEnable,omitnil,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,omitnil,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,omitnil,omitempty" name:"DefaultReplicationFactor"`
}

type ModifyInstanceAttributesRequest

type ModifyInstanceAttributesRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,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,omitnil,omitempty" name:"InstanceName"`

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

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

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

	// Public network bandwidth
	PublicNetwork *int64 `json:"PublicNetwork,omitnil,omitempty" name:"PublicNetwork"`

	// Dynamic disk expansion policy configuration.
	DynamicDiskConfig *DynamicDiskConfig `json:"DynamicDiskConfig,omitnil,omitempty" name:"DynamicDiskConfig"`

	// The size of a single message in bytes at the instance level.
	MaxMessageByte *uint64 `json:"MaxMessageByte,omitnil,omitempty" name:"MaxMessageByte"`
}

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 ModifyInstanceAttributesRequestParams

type ModifyInstanceAttributesRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,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,omitnil,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,omitnil,omitempty" name:"InstanceName"`

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

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

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

	// Public network bandwidth
	PublicNetwork *int64 `json:"PublicNetwork,omitnil,omitempty" name:"PublicNetwork"`

	// Dynamic disk expansion policy configuration.
	DynamicDiskConfig *DynamicDiskConfig `json:"DynamicDiskConfig,omitnil,omitempty" name:"DynamicDiskConfig"`

	// The size of a single message in bytes at the instance level.
	MaxMessageByte *uint64 `json:"MaxMessageByte,omitnil,omitempty" name:"MaxMessageByte"`
}

Predefined struct for user

type ModifyInstanceAttributesResponse

type ModifyInstanceAttributesResponse struct {
	*tchttp.BaseResponse
	Response *ModifyInstanceAttributesResponseParams `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 ModifyInstanceAttributesResponseParams

type ModifyInstanceAttributesResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type ModifyInstancePreRequest

type ModifyInstancePreRequest struct {
	*tchttp.BaseRequest

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

	// Estimated disk capacity, which can be increased by increment.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// Estimated bandwidth, which can be increased by increment.
	BandWidth *int64 `json:"BandWidth,omitnil,omitempty" name:"BandWidth"`

	// Estimated partition count, which can be increased by increment.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`
}

func NewModifyInstancePreRequest

func NewModifyInstancePreRequest() (request *ModifyInstancePreRequest)

func (*ModifyInstancePreRequest) FromJsonString

func (r *ModifyInstancePreRequest) 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 (*ModifyInstancePreRequest) ToJsonString

func (r *ModifyInstancePreRequest) ToJsonString() string

type ModifyInstancePreRequestParams

type ModifyInstancePreRequestParams struct {
	// Instance name.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Estimated disk capacity, which can be increased by increment.
	DiskSize *int64 `json:"DiskSize,omitnil,omitempty" name:"DiskSize"`

	// Estimated bandwidth, which can be increased by increment.
	BandWidth *int64 `json:"BandWidth,omitnil,omitempty" name:"BandWidth"`

	// Estimated partition count, which can be increased by increment.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`
}

Predefined struct for user

type ModifyInstancePreResponse

type ModifyInstancePreResponse struct {
	*tchttp.BaseResponse
	Response *ModifyInstancePreResponseParams `json:"Response"`
}

func NewModifyInstancePreResponse

func NewModifyInstancePreResponse() (response *ModifyInstancePreResponse)

func (*ModifyInstancePreResponse) FromJsonString

func (r *ModifyInstancePreResponse) 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 (*ModifyInstancePreResponse) ToJsonString

func (r *ModifyInstancePreResponse) ToJsonString() string

type ModifyInstancePreResponseParams

type ModifyInstancePreResponseParams struct {
	// Response structure of modifying the configurations of a prepaid instance.
	Result *CreateInstancePreResp `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type ModifyPasswordRequest

type ModifyPasswordRequest struct {
	*tchttp.BaseRequest

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

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

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

	// New user password
	PasswordNew *string `json:"PasswordNew,omitnil,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 ModifyPasswordRequestParams

type ModifyPasswordRequestParams struct {
	// Instance ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

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

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

Predefined struct for user

type ModifyPasswordResponse

type ModifyPasswordResponse struct {
	*tchttp.BaseResponse
	Response *ModifyPasswordResponseParams `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 ModifyPasswordResponseParams

type ModifyPasswordResponseParams struct {
	// Returned result
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type ModifyTopicAttributesRequest

type ModifyTopicAttributesRequest struct {
	*tchttp.BaseRequest

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

	// Topic name.
	TopicName *string `json:"TopicName,omitnil,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,omitnil,omitempty" name:"Note"`

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

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

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

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

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

	// Max message size in bytes. Max value: 8,388,608 bytes (8 MB).
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitnil,omitempty" name:"MaxMessageBytes"`

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

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

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

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

	// Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.
	RetentionBytes *int64 `json:"RetentionBytes,omitnil,omitempty" name:"RetentionBytes"`

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

	// Production throttling in MB/sec.
	QuotaProducerByteRate *int64 `json:"QuotaProducerByteRate,omitnil,omitempty" name:"QuotaProducerByteRate"`

	// Consumption throttling in MB/sec.
	QuotaConsumerByteRate *int64 `json:"QuotaConsumerByteRate,omitnil,omitempty" name:"QuotaConsumerByteRate"`

	// The number of topic replicas.
	ReplicaNum *int64 `json:"ReplicaNum,omitnil,omitempty" name:"ReplicaNum"`
}

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 ModifyTopicAttributesRequestParams

type ModifyTopicAttributesRequestParams struct {
	// Instance ID.
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Topic name.
	TopicName *string `json:"TopicName,omitnil,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,omitnil,omitempty" name:"Note"`

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

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

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

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

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

	// Max message size in bytes. Max value: 8,388,608 bytes (8 MB).
	MaxMessageBytes *int64 `json:"MaxMessageBytes,omitnil,omitempty" name:"MaxMessageBytes"`

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

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

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

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

	// Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.
	RetentionBytes *int64 `json:"RetentionBytes,omitnil,omitempty" name:"RetentionBytes"`

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

	// Production throttling in MB/sec.
	QuotaProducerByteRate *int64 `json:"QuotaProducerByteRate,omitnil,omitempty" name:"QuotaProducerByteRate"`

	// Consumption throttling in MB/sec.
	QuotaConsumerByteRate *int64 `json:"QuotaConsumerByteRate,omitnil,omitempty" name:"QuotaConsumerByteRate"`

	// The number of topic replicas.
	ReplicaNum *int64 `json:"ReplicaNum,omitnil,omitempty" name:"ReplicaNum"`
}

Predefined struct for user

type ModifyTopicAttributesResponse

type ModifyTopicAttributesResponse struct {
	*tchttp.BaseResponse
	Response *ModifyTopicAttributesResponseParams `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 ModifyTopicAttributesResponseParams

type ModifyTopicAttributesResponseParams struct {
	// Returned result set
	Result *JgwOperateResponse `json:"Result,omitnil,omitempty" name:"Result"`

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

Predefined struct for user

type OperateResponseData

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

	// RouteIdDto Note: This field may return null, indicating that no valid values can be obtained.
	RouteDTO *RouteDTO `json:"RouteDTO,omitnil,omitempty" name:"RouteDTO"`
}

type Partition

type Partition struct {
	// Partition ID
	PartitionId *int64 `json:"PartitionId,omitnil,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,omitnil,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,omitnil,omitempty" name:"Offset"`
}

type Partitions

type Partitions struct {
	// Partition.
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

	// Partition consumption offset.
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

type Price

type Price struct {
	// Discounted price
	RealTotalCost *float64 `json:"RealTotalCost,omitnil,omitempty" name:"RealTotalCost"`

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

type Region

type Region struct {
	// Region ID
	RegionId *int64 `json:"RegionId,omitnil,omitempty" name:"RegionId"`

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

	// Area name
	AreaName *string `json:"AreaName,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"AccessType"`

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

	// VIP network type (1: Public network TGW; 2: Classic network; 3: VPC; 4: Supporting network (IDC environment); 5: SSL public network access; 6: BM VPC; 7: Supporting network (CVM environment)).
	VipType *int64 `json:"VipType,omitnil,omitempty" name:"VipType"`

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

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

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

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

type RouteDTO

type RouteDTO struct {
	// RouteId11 Note: This field may return null, indicating that no valid values can be obtained.
	RouteId *int64 `json:"RouteId,omitnil,omitempty" name:"RouteId"`
}

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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"SoldOut"`
}

type SendMessageRequest

type SendMessageRequest struct {
	*tchttp.BaseRequest

	// Datahub access ID.
	DataHubId *string `json:"DataHubId,omitnil,omitempty" name:"DataHubId"`

	// Content of the message that has been sent. Up to 500 messages can be sent in a single request.
	Message []*BatchContent `json:"Message,omitnil,omitempty" name:"Message"`
}

func NewSendMessageRequest

func NewSendMessageRequest() (request *SendMessageRequest)

func (*SendMessageRequest) FromJsonString

func (r *SendMessageRequest) 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 (*SendMessageRequest) ToJsonString

func (r *SendMessageRequest) ToJsonString() string

type SendMessageRequestParams

type SendMessageRequestParams struct {
	// Datahub access ID.
	DataHubId *string `json:"DataHubId,omitnil,omitempty" name:"DataHubId"`

	// Content of the message that has been sent. Up to 500 messages can be sent in a single request.
	Message []*BatchContent `json:"Message,omitnil,omitempty" name:"Message"`
}

Predefined struct for user

type SendMessageResponse

type SendMessageResponse struct {
	*tchttp.BaseResponse
	Response *SendMessageResponseParams `json:"Response"`
}

func NewSendMessageResponse

func NewSendMessageResponse() (response *SendMessageResponse)

func (*SendMessageResponse) FromJsonString

func (r *SendMessageResponse) 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 (*SendMessageResponse) ToJsonString

func (r *SendMessageResponse) ToJsonString() string

type SendMessageResponseParams

type SendMessageResponseParams struct {
	// Message ID list.
	MessageId []*string `json:"MessageId,omitnil,omitempty" name:"MessageId"`

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

Predefined struct for user

type SubscribedInfo

type SubscribedInfo struct {
	// Subscribed topic name
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

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

	// Partition offset information
	// Note: this field may return null, indicating that no valid values can be obtained.
	PartitionOffset []*PartitionOffset `json:"PartitionOffset,omitnil,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,omitnil,omitempty" name:"TopicId"`
}

type Tag

type Tag struct {
	// Tag key
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

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

type TaskStatusResponse

type TaskStatusResponse struct {
	// Task status. `0` (Successful), `1` (Failed), `2` ( Running)
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

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

type Topic

type Topic struct {
	// Topic ID
	TopicId *string `json:"TopicId,omitnil,omitempty" name:"TopicId"`

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

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

type TopicAttributesResponse

type TopicAttributesResponse struct {
	// Topic ID
	TopicId *string `json:"TopicId,omitnil,omitempty" name:"TopicId"`

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

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

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

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

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

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

	// Partition details
	Partitions []*TopicPartitionDO `json:"Partitions,omitnil,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,omitnil,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,omitnil,omitempty" name:"AclRuleList"`

	// Traffic throttling policy in topic dimension.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	QuotaConfig *InstanceQuotaConfigResp `json:"QuotaConfig,omitnil,omitempty" name:"QuotaConfig"`

	// Number of replicas
	// Note: This field may return null, indicating that no valid values can be obtained.
	ReplicaNum *int64 `json:"ReplicaNum,omitnil,omitempty" name:"ReplicaNum"`
}

type TopicDetail

type TopicDetail struct {
	// Topic name
	TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`

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

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

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

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

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

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

	// Number of IPs in IP allowlist
	IpWhiteListCount *int64 `json:"IpWhiteListCount,omitnil,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,omitnil,omitempty" name:"ForwardCosBucket"`

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

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

	// Advanced configuration
	// Note: this field may return null, indicating that no valid values can be obtained.
	Config *Config `json:"Config,omitnil,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,omitnil,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,omitnil,omitempty" name:"Status"`

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

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,omitnil,omitempty" name:"TopicList"`

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

type TopicInSyncReplicaInfo

type TopicInSyncReplicaInfo struct {
	// Partition name
	Partition *string `json:"Partition,omitnil,omitempty" name:"Partition"`

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

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

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

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

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

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

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

type TopicInSyncReplicaResult

type TopicInSyncReplicaResult struct {
	// Set of topic details and replicas
	TopicInSyncReplicaList []*TopicInSyncReplicaInfo `json:"TopicInSyncReplicaList,omitnil,omitempty" name:"TopicInSyncReplicaList"`

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

type TopicPartitionDO

type TopicPartitionDO struct {
	// Partition ID
	Partition *int64 `json:"Partition,omitnil,omitempty" name:"Partition"`

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

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

	// Number of replicas
	ReplicaNum *int64 `json:"ReplicaNum,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"ModTimeStamp"`
}

type TopicSubscribeGroup

type TopicSubscribeGroup struct {
	// Total number
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

	// Consumer group information
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	GroupsInfo []*GroupInfoResponse `json:"GroupsInfo,omitnil,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,omitnil,omitempty" name:"Status"`
}

type User

type User struct {
	// User ID
	UserId *int64 `json:"UserId,omitnil,omitempty" name:"UserId"`

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

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

	// Last updated time
	UpdateTime *string `json:"UpdateTime,omitnil,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,omitnil,omitempty" name:"Users"`

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

type VipEntity

type VipEntity struct {
	// Virtual IP
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

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

type ZoneInfo

type ZoneInfo struct {
	// Zone ID
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

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

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

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

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

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

	// Extra flag
	Exflag *string `json:"Exflag,omitnil,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,omitnil,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,omitnil,omitempty" name:"SalesInfo"`
}

type ZoneResponse

type ZoneResponse struct {
	// Zone list
	ZoneList []*ZoneInfo `json:"ZoneList,omitnil,omitempty" name:"ZoneList"`

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

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

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

	// Pay-as-you-go unit message price
	MessagePrice *Price `json:"MessagePrice,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"Physical"`

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

	// Public network bandwidth configuration.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	PublicNetworkLimit *string `json:"PublicNetworkLimit,omitnil,omitempty" name:"PublicNetworkLimit"`
}

Jump to

Keyboard shortcuts

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