Documentation
¶
Index ¶
- Constants
- type ChangeMigratingTopicToNextStageRequest
- type ChangeMigratingTopicToNextStageRequestParams
- type ChangeMigratingTopicToNextStageResponse
- type ChangeMigratingTopicToNextStageResponseParams
- type Client
- func (c *Client) ChangeMigratingTopicToNextStage(request *ChangeMigratingTopicToNextStageRequest) (response *ChangeMigratingTopicToNextStageResponse, err error)
- func (c *Client) ChangeMigratingTopicToNextStageWithContext(ctx context.Context, request *ChangeMigratingTopicToNextStageRequest) (response *ChangeMigratingTopicToNextStageResponse, err error)
- func (c *Client) CreateConsumerGroup(request *CreateConsumerGroupRequest) (response *CreateConsumerGroupResponse, err error)
- func (c *Client) CreateConsumerGroupWithContext(ctx context.Context, request *CreateConsumerGroupRequest) (response *CreateConsumerGroupResponse, err error)
- func (c *Client) CreateInstance(request *CreateInstanceRequest) (response *CreateInstanceResponse, err error)
- func (c *Client) CreateInstanceWithContext(ctx context.Context, request *CreateInstanceRequest) (response *CreateInstanceResponse, err error)
- func (c *Client) CreateRole(request *CreateRoleRequest) (response *CreateRoleResponse, err error)
- func (c *Client) CreateRoleWithContext(ctx context.Context, request *CreateRoleRequest) (response *CreateRoleResponse, err error)
- func (c *Client) DeleteConsumerGroup(request *DeleteConsumerGroupRequest) (response *DeleteConsumerGroupResponse, err error)
- func (c *Client) DeleteConsumerGroupWithContext(ctx context.Context, request *DeleteConsumerGroupRequest) (response *DeleteConsumerGroupResponse, err error)
- func (c *Client) DeleteInstance(request *DeleteInstanceRequest) (response *DeleteInstanceResponse, err error)
- func (c *Client) DeleteInstanceWithContext(ctx context.Context, request *DeleteInstanceRequest) (response *DeleteInstanceResponse, err error)
- func (c *Client) DeleteRole(request *DeleteRoleRequest) (response *DeleteRoleResponse, err error)
- func (c *Client) DeleteRoleWithContext(ctx context.Context, request *DeleteRoleRequest) (response *DeleteRoleResponse, err error)
- func (c *Client) DeleteSmoothMigrationTask(request *DeleteSmoothMigrationTaskRequest) (response *DeleteSmoothMigrationTaskResponse, err error)
- func (c *Client) DeleteSmoothMigrationTaskWithContext(ctx context.Context, request *DeleteSmoothMigrationTaskRequest) (response *DeleteSmoothMigrationTaskResponse, err error)
- func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
- func (c *Client) DeleteTopicWithContext(ctx context.Context, request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
- func (c *Client) DescribeConsumerClient(request *DescribeConsumerClientRequest) (response *DescribeConsumerClientResponse, err error)
- func (c *Client) DescribeConsumerClientList(request *DescribeConsumerClientListRequest) (response *DescribeConsumerClientListResponse, err error)
- func (c *Client) DescribeConsumerClientListWithContext(ctx context.Context, request *DescribeConsumerClientListRequest) (response *DescribeConsumerClientListResponse, err error)
- func (c *Client) DescribeConsumerClientWithContext(ctx context.Context, request *DescribeConsumerClientRequest) (response *DescribeConsumerClientResponse, err error)
- func (c *Client) DescribeConsumerGroup(request *DescribeConsumerGroupRequest) (response *DescribeConsumerGroupResponse, err error)
- func (c *Client) DescribeConsumerGroupWithContext(ctx context.Context, request *DescribeConsumerGroupRequest) (response *DescribeConsumerGroupResponse, err error)
- func (c *Client) DescribeConsumerLag(request *DescribeConsumerLagRequest) (response *DescribeConsumerLagResponse, err error)
- func (c *Client) DescribeConsumerLagWithContext(ctx context.Context, request *DescribeConsumerLagRequest) (response *DescribeConsumerLagResponse, err error)
- func (c *Client) DescribeFusionInstanceList(request *DescribeFusionInstanceListRequest) (response *DescribeFusionInstanceListResponse, err error)
- func (c *Client) DescribeFusionInstanceListWithContext(ctx context.Context, request *DescribeFusionInstanceListRequest) (response *DescribeFusionInstanceListResponse, err error)
- func (c *Client) DescribeInstance(request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)
- func (c *Client) DescribeInstanceList(request *DescribeInstanceListRequest) (response *DescribeInstanceListResponse, err error)
- func (c *Client) DescribeInstanceListWithContext(ctx context.Context, request *DescribeInstanceListRequest) (response *DescribeInstanceListResponse, err error)
- func (c *Client) DescribeInstanceWithContext(ctx context.Context, request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)
- func (c *Client) DescribeMessage(request *DescribeMessageRequest) (response *DescribeMessageResponse, err error)
- func (c *Client) DescribeMessageList(request *DescribeMessageListRequest) (response *DescribeMessageListResponse, err error)
- func (c *Client) DescribeMessageListWithContext(ctx context.Context, request *DescribeMessageListRequest) (response *DescribeMessageListResponse, err error)
- func (c *Client) DescribeMessageTrace(request *DescribeMessageTraceRequest) (response *DescribeMessageTraceResponse, err error)
- func (c *Client) DescribeMessageTraceWithContext(ctx context.Context, request *DescribeMessageTraceRequest) (response *DescribeMessageTraceResponse, err error)
- func (c *Client) DescribeMessageWithContext(ctx context.Context, request *DescribeMessageRequest) (response *DescribeMessageResponse, err error)
- func (c *Client) DescribeMigratingGroupStats(request *DescribeMigratingGroupStatsRequest) (response *DescribeMigratingGroupStatsResponse, err error)
- func (c *Client) DescribeMigratingGroupStatsWithContext(ctx context.Context, request *DescribeMigratingGroupStatsRequest) (response *DescribeMigratingGroupStatsResponse, err error)
- func (c *Client) DescribeMigratingTopicList(request *DescribeMigratingTopicListRequest) (response *DescribeMigratingTopicListResponse, err error)
- func (c *Client) DescribeMigratingTopicListWithContext(ctx context.Context, request *DescribeMigratingTopicListRequest) (response *DescribeMigratingTopicListResponse, err error)
- func (c *Client) DescribeMigratingTopicStats(request *DescribeMigratingTopicStatsRequest) (response *DescribeMigratingTopicStatsResponse, err error)
- func (c *Client) DescribeMigratingTopicStatsWithContext(ctx context.Context, request *DescribeMigratingTopicStatsRequest) (response *DescribeMigratingTopicStatsResponse, err error)
- func (c *Client) DescribeMigrationTaskList(request *DescribeMigrationTaskListRequest) (response *DescribeMigrationTaskListResponse, err error)
- func (c *Client) DescribeMigrationTaskListWithContext(ctx context.Context, request *DescribeMigrationTaskListRequest) (response *DescribeMigrationTaskListResponse, err error)
- func (c *Client) DescribeProducerList(request *DescribeProducerListRequest) (response *DescribeProducerListResponse, err error)
- func (c *Client) DescribeProducerListWithContext(ctx context.Context, request *DescribeProducerListRequest) (response *DescribeProducerListResponse, err error)
- func (c *Client) DescribeProductSKUs(request *DescribeProductSKUsRequest) (response *DescribeProductSKUsResponse, err error)
- func (c *Client) DescribeProductSKUsWithContext(ctx context.Context, request *DescribeProductSKUsRequest) (response *DescribeProductSKUsResponse, err error)
- func (c *Client) DescribeRoleList(request *DescribeRoleListRequest) (response *DescribeRoleListResponse, err error)
- func (c *Client) DescribeRoleListWithContext(ctx context.Context, request *DescribeRoleListRequest) (response *DescribeRoleListResponse, err error)
- func (c *Client) DescribeSmoothMigrationTaskList(request *DescribeSmoothMigrationTaskListRequest) (response *DescribeSmoothMigrationTaskListResponse, err error)
- func (c *Client) DescribeSmoothMigrationTaskListWithContext(ctx context.Context, request *DescribeSmoothMigrationTaskListRequest) (response *DescribeSmoothMigrationTaskListResponse, err error)
- func (c *Client) DescribeSourceClusterGroupList(request *DescribeSourceClusterGroupListRequest) (response *DescribeSourceClusterGroupListResponse, err error)
- func (c *Client) DescribeSourceClusterGroupListWithContext(ctx context.Context, request *DescribeSourceClusterGroupListRequest) (response *DescribeSourceClusterGroupListResponse, err error)
- func (c *Client) DescribeTopic(request *DescribeTopicRequest) (response *DescribeTopicResponse, err error)
- func (c *Client) DescribeTopicList(request *DescribeTopicListRequest) (response *DescribeTopicListResponse, err error)
- func (c *Client) DescribeTopicListByGroup(request *DescribeTopicListByGroupRequest) (response *DescribeTopicListByGroupResponse, err error)
- func (c *Client) DescribeTopicListByGroupWithContext(ctx context.Context, request *DescribeTopicListByGroupRequest) (response *DescribeTopicListByGroupResponse, err error)
- func (c *Client) DescribeTopicListWithContext(ctx context.Context, request *DescribeTopicListRequest) (response *DescribeTopicListResponse, err error)
- func (c *Client) DescribeTopicWithContext(ctx context.Context, request *DescribeTopicRequest) (response *DescribeTopicResponse, err error)
- func (c *Client) DoHealthCheckOnMigratingTopic(request *DoHealthCheckOnMigratingTopicRequest) (response *DoHealthCheckOnMigratingTopicResponse, err error)
- func (c *Client) DoHealthCheckOnMigratingTopicWithContext(ctx context.Context, request *DoHealthCheckOnMigratingTopicRequest) (response *DoHealthCheckOnMigratingTopicResponse, err error)
- func (c *Client) ModifyConsumerGroup(request *ModifyConsumerGroupRequest) (response *ModifyConsumerGroupResponse, err error)
- func (c *Client) ModifyConsumerGroupWithContext(ctx context.Context, request *ModifyConsumerGroupRequest) (response *ModifyConsumerGroupResponse, err error)
- func (c *Client) ModifyInstance(request *ModifyInstanceRequest) (response *ModifyInstanceResponse, err error)
- func (c *Client) ModifyInstanceEndpoint(request *ModifyInstanceEndpointRequest) (response *ModifyInstanceEndpointResponse, err error)
- func (c *Client) ModifyInstanceEndpointWithContext(ctx context.Context, request *ModifyInstanceEndpointRequest) (response *ModifyInstanceEndpointResponse, err error)
- func (c *Client) ModifyInstanceWithContext(ctx context.Context, request *ModifyInstanceRequest) (response *ModifyInstanceResponse, err error)
- func (c *Client) ModifyRole(request *ModifyRoleRequest) (response *ModifyRoleResponse, err error)
- func (c *Client) ModifyRoleWithContext(ctx context.Context, request *ModifyRoleRequest) (response *ModifyRoleResponse, err error)
- func (c *Client) ModifyTopic(request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
- func (c *Client) ModifyTopicWithContext(ctx context.Context, request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
- func (c *Client) RemoveMigratingTopic(request *RemoveMigratingTopicRequest) (response *RemoveMigratingTopicResponse, err error)
- func (c *Client) RemoveMigratingTopicWithContext(ctx context.Context, request *RemoveMigratingTopicRequest) (response *RemoveMigratingTopicResponse, err error)
- func (c *Client) ResendDeadLetterMessage(request *ResendDeadLetterMessageRequest) (response *ResendDeadLetterMessageResponse, err error)
- func (c *Client) ResendDeadLetterMessageWithContext(ctx context.Context, request *ResendDeadLetterMessageRequest) (response *ResendDeadLetterMessageResponse, err error)
- func (c *Client) ResetConsumerGroupOffset(request *ResetConsumerGroupOffsetRequest) (response *ResetConsumerGroupOffsetResponse, err error)
- func (c *Client) ResetConsumerGroupOffsetWithContext(ctx context.Context, request *ResetConsumerGroupOffsetRequest) (response *ResetConsumerGroupOffsetResponse, err error)
- func (c *Client) RollbackMigratingTopicStage(request *RollbackMigratingTopicStageRequest) (response *RollbackMigratingTopicStageResponse, err error)
- func (c *Client) RollbackMigratingTopicStageWithContext(ctx context.Context, request *RollbackMigratingTopicStageRequest) (response *RollbackMigratingTopicStageResponse, err error)
- type ClientSubscriptionInfo
- type ConsumerClient
- type CreateConsumerGroupRequest
- type CreateConsumerGroupRequestParams
- type CreateConsumerGroupResponse
- type CreateConsumerGroupResponseParams
- type CreateInstanceRequest
- type CreateInstanceRequestParams
- type CreateInstanceResponse
- type CreateInstanceResponseParams
- type CreateRoleRequest
- type CreateRoleRequestParams
- type CreateRoleResponse
- type CreateRoleResponseParams
- type DeleteConsumerGroupRequest
- type DeleteConsumerGroupRequestParams
- type DeleteConsumerGroupResponse
- type DeleteConsumerGroupResponseParams
- type DeleteInstanceRequest
- type DeleteInstanceRequestParams
- type DeleteInstanceResponse
- type DeleteInstanceResponseParams
- type DeleteRoleRequest
- type DeleteRoleRequestParams
- type DeleteRoleResponse
- type DeleteRoleResponseParams
- type DeleteSmoothMigrationTaskRequest
- type DeleteSmoothMigrationTaskRequestParams
- type DeleteSmoothMigrationTaskResponse
- type DeleteSmoothMigrationTaskResponseParams
- type DeleteTopicRequest
- type DeleteTopicRequestParams
- type DeleteTopicResponse
- type DeleteTopicResponseParams
- type DescribeConsumerClientListRequest
- type DescribeConsumerClientListRequestParams
- type DescribeConsumerClientListResponse
- type DescribeConsumerClientListResponseParams
- type DescribeConsumerClientRequest
- type DescribeConsumerClientRequestParams
- type DescribeConsumerClientResponse
- type DescribeConsumerClientResponseParams
- type DescribeConsumerGroupRequest
- type DescribeConsumerGroupRequestParams
- type DescribeConsumerGroupResponse
- type DescribeConsumerGroupResponseParams
- type DescribeConsumerLagRequest
- type DescribeConsumerLagRequestParams
- type DescribeConsumerLagResponse
- type DescribeConsumerLagResponseParams
- type DescribeFusionInstanceListRequest
- type DescribeFusionInstanceListRequestParams
- type DescribeFusionInstanceListResponse
- type DescribeFusionInstanceListResponseParams
- type DescribeInstanceListRequest
- type DescribeInstanceListRequestParams
- type DescribeInstanceListResponse
- type DescribeInstanceListResponseParams
- type DescribeInstanceRequest
- type DescribeInstanceRequestParams
- type DescribeInstanceResponse
- type DescribeInstanceResponseParams
- type DescribeMessageListRequest
- type DescribeMessageListRequestParams
- type DescribeMessageListResponse
- type DescribeMessageListResponseParams
- type DescribeMessageRequest
- type DescribeMessageRequestParams
- type DescribeMessageResponse
- type DescribeMessageResponseParams
- type DescribeMessageTraceRequest
- type DescribeMessageTraceRequestParams
- type DescribeMessageTraceResponse
- type DescribeMessageTraceResponseParams
- type DescribeMigratingGroupStatsRequest
- type DescribeMigratingGroupStatsRequestParams
- type DescribeMigratingGroupStatsResponse
- type DescribeMigratingGroupStatsResponseParams
- type DescribeMigratingTopicListRequest
- type DescribeMigratingTopicListRequestParams
- type DescribeMigratingTopicListResponse
- type DescribeMigratingTopicListResponseParams
- type DescribeMigratingTopicStatsRequest
- type DescribeMigratingTopicStatsRequestParams
- type DescribeMigratingTopicStatsResponse
- type DescribeMigratingTopicStatsResponseParams
- type DescribeMigrationTaskListRequest
- type DescribeMigrationTaskListRequestParams
- type DescribeMigrationTaskListResponse
- type DescribeMigrationTaskListResponseParams
- type DescribeProducerListRequest
- type DescribeProducerListRequestParams
- type DescribeProducerListResponse
- type DescribeProducerListResponseParams
- type DescribeProductSKUsRequest
- type DescribeProductSKUsRequestParams
- type DescribeProductSKUsResponse
- type DescribeProductSKUsResponseParams
- type DescribeRoleListRequest
- type DescribeRoleListRequestParams
- type DescribeRoleListResponse
- type DescribeRoleListResponseParams
- type DescribeSmoothMigrationTaskListRequest
- type DescribeSmoothMigrationTaskListRequestParams
- type DescribeSmoothMigrationTaskListResponse
- type DescribeSmoothMigrationTaskListResponseParams
- type DescribeSourceClusterGroupListRequest
- type DescribeSourceClusterGroupListRequestParams
- type DescribeSourceClusterGroupListResponse
- type DescribeSourceClusterGroupListResponseParams
- type DescribeTopicListByGroupRequest
- type DescribeTopicListByGroupRequestParams
- type DescribeTopicListByGroupResponse
- type DescribeTopicListByGroupResponseParams
- type DescribeTopicListRequest
- type DescribeTopicListRequestParams
- type DescribeTopicListResponse
- type DescribeTopicListResponseParams
- type DescribeTopicRequest
- type DescribeTopicRequestParams
- type DescribeTopicResponse
- type DescribeTopicResponseParams
- type DetailedRolePerm
- type DoHealthCheckOnMigratingTopicRequest
- type DoHealthCheckOnMigratingTopicRequestParams
- type DoHealthCheckOnMigratingTopicResponse
- type DoHealthCheckOnMigratingTopicResponseParams
- type Endpoint
- type Filter
- type FusionInstanceItem
- type InstanceItem
- type InstanceItemExtraInfo
- type IpRule
- type MessageItem
- type MessageTraceItem
- type MessageTrackItem
- type MigratingTopic
- type MigrationTaskItem
- type ModifyConsumerGroupRequest
- type ModifyConsumerGroupRequestParams
- type ModifyConsumerGroupResponse
- type ModifyConsumerGroupResponseParams
- type ModifyInstanceEndpointRequest
- type ModifyInstanceEndpointRequestParams
- type ModifyInstanceEndpointResponse
- type ModifyInstanceEndpointResponseParams
- type ModifyInstanceRequest
- type ModifyInstanceRequestParams
- type ModifyInstanceResponse
- type ModifyInstanceResponseParams
- type ModifyRoleRequest
- type ModifyRoleRequestParams
- type ModifyRoleResponse
- type ModifyRoleResponseParams
- type ModifyTopicRequest
- type ModifyTopicRequestParams
- type ModifyTopicResponse
- type ModifyTopicResponseParams
- type PriceTag
- type ProducerInfo
- type ProductSKU
- type RemoveMigratingTopicRequest
- type RemoveMigratingTopicRequestParams
- type RemoveMigratingTopicResponse
- type RemoveMigratingTopicResponseParams
- type ResendDeadLetterMessageRequest
- type ResendDeadLetterMessageRequestParams
- type ResendDeadLetterMessageResponse
- type ResendDeadLetterMessageResponseParams
- type ResetConsumerGroupOffsetRequest
- type ResetConsumerGroupOffsetRequestParams
- type ResetConsumerGroupOffsetResponse
- type ResetConsumerGroupOffsetResponseParams
- type RoleItem
- type RollbackMigratingTopicStageRequest
- type RollbackMigratingTopicStageRequestParams
- type RollbackMigratingTopicStageResponse
- type RollbackMigratingTopicStageResponseParams
- type SmoothMigrationTaskItem
- type SourceClusterGroupConfig
- type SubscriptionData
- type Tag
- type TagFilter
- type TopicConsumeStats
- type TopicItem
- type TopicStageChangeResult
- type VpcInfo
- type ZoneScheduledItem
Constants ¶
const ( // Operation failed. FAILEDOPERATION = "FailedOperation" // Instance not ready. Please try again later. FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" // Operation denied. OPERATIONDENIED = "OperationDenied" // The resource is occupied. RESOURCEINUSE = "ResourceInUse" // Access point does not exist. RESOURCENOTFOUND_ENDPOINT = "ResourceNotFound.Endpoint" // Consumer group does not exist. Please check and try again. RESOURCENOTFOUND_GROUP = "ResourceNotFound.Group" // The instance does not exist. RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" // Message does not exist. RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message" // Migration task does not exist. Please check and try again. RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" // Role does not exist. Please check and try again. RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role" // Topic does not exist. Please check and try again. RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" // Resources are unavailable. RESOURCEUNAVAILABLE = "ResourceUnavailable" // The operation is not supported. UNSUPPORTEDOPERATION = "UnsupportedOperation" // The number of instance topics cannot be adjusted below the used quota. UNSUPPORTEDOPERATION_INSTANCETOPICNUMDOWNGRADE = "UnsupportedOperation.InstanceTopicNumDowngrade" // Resource already exists. Please check and try again. UNSUPPORTEDOPERATION_RESOURCEALREADYEXISTS = "UnsupportedOperation.ResourceAlreadyExists" )
const APIVersion = "2023-03-08"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ChangeMigratingTopicToNextStageRequest ¶
type ChangeMigratingTopicToNextStageRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// List of topic names. topic name can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the api [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in data type.
TopicNameList []*string `json:"TopicNameList,omitnil,omitempty" name:"TopicNameList"`
// Namespace list. It is valid only for 4.x clusters and has a one-to-one relationship with TopicNameList. The list can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
NamespaceList []*string `json:"NamespaceList,omitnil,omitempty" name:"NamespaceList"`
}
func NewChangeMigratingTopicToNextStageRequest ¶
func NewChangeMigratingTopicToNextStageRequest() (request *ChangeMigratingTopicToNextStageRequest)
func (*ChangeMigratingTopicToNextStageRequest) FromJsonString ¶
func (r *ChangeMigratingTopicToNextStageRequest) 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 (*ChangeMigratingTopicToNextStageRequest) ToJsonString ¶
func (r *ChangeMigratingTopicToNextStageRequest) ToJsonString() string
type ChangeMigratingTopicToNextStageRequestParams ¶
type ChangeMigratingTopicToNextStageRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// List of topic names. topic name can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the api [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in data type.
TopicNameList []*string `json:"TopicNameList,omitnil,omitempty" name:"TopicNameList"`
// Namespace list. It is valid only for 4.x clusters and has a one-to-one relationship with TopicNameList. The list can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
NamespaceList []*string `json:"NamespaceList,omitnil,omitempty" name:"NamespaceList"`
}
Predefined struct for user
type ChangeMigratingTopicToNextStageResponse ¶
type ChangeMigratingTopicToNextStageResponse struct {
*tchttp.BaseResponse
Response *ChangeMigratingTopicToNextStageResponseParams `json:"Response"`
}
func NewChangeMigratingTopicToNextStageResponse ¶
func NewChangeMigratingTopicToNextStageResponse() (response *ChangeMigratingTopicToNextStageResponse)
func (*ChangeMigratingTopicToNextStageResponse) FromJsonString ¶
func (r *ChangeMigratingTopicToNextStageResponse) 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 (*ChangeMigratingTopicToNextStageResponse) ToJsonString ¶
func (r *ChangeMigratingTopicToNextStageResponse) ToJsonString() string
type ChangeMigratingTopicToNextStageResponseParams ¶
type ChangeMigratingTopicToNextStageResponseParams struct {
// Result list of migration topic status modification.
Results []*TopicStageChangeResult `json:"Results,omitnil,omitempty" name:"Results"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) ChangeMigratingTopicToNextStage ¶
func (c *Client) ChangeMigratingTopicToNextStage(request *ChangeMigratingTopicToNextStageRequest) (response *ChangeMigratingTopicToNextStageResponse, err error)
ChangeMigratingTopicToNextStage This API is used to modify the Topic status during migration and go to next step.
error code that may be returned:
RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask"
func (*Client) ChangeMigratingTopicToNextStageWithContext ¶
func (c *Client) ChangeMigratingTopicToNextStageWithContext(ctx context.Context, request *ChangeMigratingTopicToNextStageRequest) (response *ChangeMigratingTopicToNextStageResponse, err error)
ChangeMigratingTopicToNextStage This API is used to modify the Topic status during migration and go to next step.
error code that may be returned:
RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask"
func (*Client) CreateConsumerGroup ¶
func (c *Client) CreateConsumerGroup(request *CreateConsumerGroupRequest) (response *CreateConsumerGroupResponse, err error)
CreateConsumerGroup Create consumer groups.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" UNSUPPORTEDOPERATION_RESOURCEALREADYEXISTS = "UnsupportedOperation.ResourceAlreadyExists"
func (*Client) CreateConsumerGroupWithContext ¶
func (c *Client) CreateConsumerGroupWithContext(ctx context.Context, request *CreateConsumerGroupRequest) (response *CreateConsumerGroupResponse, err error)
CreateConsumerGroup Create consumer groups.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" UNSUPPORTEDOPERATION_RESOURCEALREADYEXISTS = "UnsupportedOperation.ResourceAlreadyExists"
func (*Client) CreateInstance ¶
func (c *Client) CreateInstance(request *CreateInstanceRequest) (response *CreateInstanceResponse, err error)
CreateInstance This API is used to create a RocketMQ 5.x cluster.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) CreateInstanceWithContext ¶
func (c *Client) CreateInstanceWithContext(ctx context.Context, request *CreateInstanceRequest) (response *CreateInstanceResponse, err error)
CreateInstance This API is used to create a RocketMQ 5.x cluster.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) CreateRole ¶
func (c *Client) CreateRole(request *CreateRoleRequest) (response *CreateRoleResponse, err error)
CreateRole This API is used to add a role.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" OPERATIONDENIED = "OperationDenied" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" UNSUPPORTEDOPERATION_RESOURCEALREADYEXISTS = "UnsupportedOperation.ResourceAlreadyExists"
func (*Client) CreateRoleWithContext ¶
func (c *Client) CreateRoleWithContext(ctx context.Context, request *CreateRoleRequest) (response *CreateRoleResponse, err error)
CreateRole This API is used to add a role.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" OPERATIONDENIED = "OperationDenied" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" UNSUPPORTEDOPERATION_RESOURCEALREADYEXISTS = "UnsupportedOperation.ResourceAlreadyExists"
func (*Client) DeleteConsumerGroup ¶
func (c *Client) DeleteConsumerGroup(request *DeleteConsumerGroupRequest) (response *DeleteConsumerGroupResponse, err error)
DeleteConsumerGroup This API is used to delete a consumer group. After a consumer group is deleted, all configurations and related data of the consumer group are cleared and cannot be restored. After deletion, online consumer clients report errors. It is recommended to take clients offline in advance.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_GROUP = "ResourceNotFound.Group"
func (*Client) DeleteConsumerGroupWithContext ¶
func (c *Client) DeleteConsumerGroupWithContext(ctx context.Context, request *DeleteConsumerGroupRequest) (response *DeleteConsumerGroupResponse, err error)
DeleteConsumerGroup This API is used to delete a consumer group. After a consumer group is deleted, all configurations and related data of the consumer group are cleared and cannot be restored. After deletion, online consumer clients report errors. It is recommended to take clients offline in advance.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_GROUP = "ResourceNotFound.Group"
func (*Client) DeleteInstance ¶
func (c *Client) DeleteInstance(request *DeleteInstanceRequest) (response *DeleteInstanceResponse, err error)
DeleteInstance This API is used to delete a TDMQ RocketMQ 5.x cluster. Topics, consumer groups, and roles in use should be deleted first.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DeleteInstanceWithContext ¶
func (c *Client) DeleteInstanceWithContext(ctx context.Context, request *DeleteInstanceRequest) (response *DeleteInstanceResponse, err error)
DeleteInstance This API is used to delete a TDMQ RocketMQ 5.x cluster. Topics, consumer groups, and roles in use should be deleted first.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCEINUSE = "ResourceInUse" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DeleteRole ¶
func (c *Client) DeleteRole(request *DeleteRoleRequest) (response *DeleteRoleResponse, err error)
DeleteRole This API is used to delete a role. Make sure that the related information on this role is not used in the current code. After the role is deleted, the keys (AccessKey and SecretKey) used to produce or consume messages with this role become invalid immediately.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role"
func (*Client) DeleteRoleWithContext ¶
func (c *Client) DeleteRoleWithContext(ctx context.Context, request *DeleteRoleRequest) (response *DeleteRoleResponse, err error)
DeleteRole This API is used to delete a role. Make sure that the related information on this role is not used in the current code. After the role is deleted, the keys (AccessKey and SecretKey) used to produce or consume messages with this role become invalid immediately.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role"
func (*Client) DeleteSmoothMigrationTask ¶
func (c *Client) DeleteSmoothMigrationTask(request *DeleteSmoothMigrationTaskRequest) (response *DeleteSmoothMigrationTaskResponse, err error)
DeleteSmoothMigrationTask This API is used to delete a smooth migration task. Only canceled tasks can be deleted.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role"
func (*Client) DeleteSmoothMigrationTaskWithContext ¶
func (c *Client) DeleteSmoothMigrationTaskWithContext(ctx context.Context, request *DeleteSmoothMigrationTaskRequest) (response *DeleteSmoothMigrationTaskResponse, err error)
DeleteSmoothMigrationTask This API is used to delete a smooth migration task. Only canceled tasks can be deleted.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role"
func (*Client) DeleteTopic ¶
func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
DeleteTopic This API is used to delete a topic. After deletion, all configurations and related data of the topic will be cleared and cannot be restored.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic"
func (*Client) DeleteTopicWithContext ¶
func (c *Client) DeleteTopicWithContext(ctx context.Context, request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
DeleteTopic This API is used to delete a topic. After deletion, all configurations and related data of the topic will be cleared and cannot be restored.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic"
func (*Client) DescribeConsumerClient ¶
func (c *Client) DescribeConsumerClient(request *DescribeConsumerClientRequest) (response *DescribeConsumerClientResponse, err error)
DescribeConsumerClient Query consumer client details.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerClientList ¶
func (c *Client) DescribeConsumerClientList(request *DescribeConsumerClientListRequest) (response *DescribeConsumerClientListResponse, err error)
DescribeConsumerClientList This API is used to query the client connection list of a consumer group.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerClientListWithContext ¶
func (c *Client) DescribeConsumerClientListWithContext(ctx context.Context, request *DescribeConsumerClientListRequest) (response *DescribeConsumerClientListResponse, err error)
DescribeConsumerClientList This API is used to query the client connection list of a consumer group.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerClientWithContext ¶
func (c *Client) DescribeConsumerClientWithContext(ctx context.Context, request *DescribeConsumerClientRequest) (response *DescribeConsumerClientResponse, err error)
DescribeConsumerClient Query consumer client details.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerGroup ¶
func (c *Client) DescribeConsumerGroup(request *DescribeConsumerGroupRequest) (response *DescribeConsumerGroupResponse, err error)
DescribeConsumerGroup Query consumer group details.
error code that may be returned:
RESOURCENOTFOUND_GROUP = "ResourceNotFound.Group" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerGroupWithContext ¶
func (c *Client) DescribeConsumerGroupWithContext(ctx context.Context, request *DescribeConsumerGroupRequest) (response *DescribeConsumerGroupResponse, err error)
DescribeConsumerGroup Query consumer group details.
error code that may be returned:
RESOURCENOTFOUND_GROUP = "ResourceNotFound.Group" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerLag ¶
func (c *Client) DescribeConsumerLag(request *DescribeConsumerLagRequest) (response *DescribeConsumerLagResponse, err error)
DescribeConsumerLag This API is used to query the number of heaped messages in a specified consumer group.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeConsumerLagWithContext ¶
func (c *Client) DescribeConsumerLagWithContext(ctx context.Context, request *DescribeConsumerLagRequest) (response *DescribeConsumerLagResponse, err error)
DescribeConsumerLag This API is used to query the number of heaped messages in a specified consumer group.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeFusionInstanceList ¶
func (c *Client) DescribeFusionInstanceList(request *DescribeFusionInstanceListRequest) (response *DescribeFusionInstanceListResponse, err error)
DescribeFusionInstanceList This API is used to describe clusters, supporting both 4.x and 5.x clusters. Among them, parameter usage of Filters is as follows:.
-InstanceName, the cluster name, supports fuzzy query and can be obtained from the API return value or console.
-InstanceId Cluster ID, exact query, obtain from the current API or console.
- InstanceType cluster type, see InstanceItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#InstanceItem) data structure, supports multiple selections.
- Version: cluster edition, enumeration values as follows:.
-4 RocketMQ 4.x clusters.
-Deploy a RocketMQ 5.x cluster.
This API is used to demonstrate Filters.
[{ "Name": "InstanceId", "Values": ["rmq-72mo3a9o"] }]
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) DescribeFusionInstanceListWithContext ¶
func (c *Client) DescribeFusionInstanceListWithContext(ctx context.Context, request *DescribeFusionInstanceListRequest) (response *DescribeFusionInstanceListResponse, err error)
DescribeFusionInstanceList This API is used to describe clusters, supporting both 4.x and 5.x clusters. Among them, parameter usage of Filters is as follows:.
-InstanceName, the cluster name, supports fuzzy query and can be obtained from the API return value or console.
-InstanceId Cluster ID, exact query, obtain from the current API or console.
- InstanceType cluster type, see InstanceItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#InstanceItem) data structure, supports multiple selections.
- Version: cluster edition, enumeration values as follows:.
-4 RocketMQ 4.x clusters.
-Deploy a RocketMQ 5.x cluster.
This API is used to demonstrate Filters.
[{ "Name": "InstanceId", "Values": ["rmq-72mo3a9o"] }]
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) DescribeInstance ¶
func (c *Client) DescribeInstance(request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)
DescribeInstance This API is used to query RocketMQ 5.x cluster information.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeInstanceList ¶
func (c *Client) DescribeInstanceList(request *DescribeInstanceListRequest) (response *DescribeInstanceListResponse, err error)
DescribeInstanceList This API is used to describe clusters. It only supports 5.x clusters. Description of the Filters parameter use is as follows:.
-InstanceName Cluster name, supports fuzzy search.
- InstanceId The Tencent Cloud RocketMQ instance ID, obtained from the [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) API or console.
- InstanceType cluster type, see InstanceItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#InstanceItem) data structure, supports multiple selections.
-InstanceStatus cluster status, see InstanceItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#InstanceItem) data structure, supports multiple selections.
This API is used to demonstrate Filters.
[{
"Name": "InstanceId", "Values": ["rmq-72mo3a9o"]
}]
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) DescribeInstanceListWithContext ¶
func (c *Client) DescribeInstanceListWithContext(ctx context.Context, request *DescribeInstanceListRequest) (response *DescribeInstanceListResponse, err error)
DescribeInstanceList This API is used to describe clusters. It only supports 5.x clusters. Description of the Filters parameter use is as follows:.
-InstanceName Cluster name, supports fuzzy search.
- InstanceId The Tencent Cloud RocketMQ instance ID, obtained from the [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) API or console.
- InstanceType cluster type, see InstanceItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#InstanceItem) data structure, supports multiple selections.
-InstanceStatus cluster status, see InstanceItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#InstanceItem) data structure, supports multiple selections.
This API is used to demonstrate Filters.
[{
"Name": "InstanceId", "Values": ["rmq-72mo3a9o"]
}]
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) DescribeInstanceWithContext ¶
func (c *Client) DescribeInstanceWithContext(ctx context.Context, request *DescribeInstanceRequest) (response *DescribeInstanceResponse, err error)
DescribeInstance This API is used to query RocketMQ 5.x cluster information.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeMessage ¶
func (c *Client) DescribeMessage(request *DescribeMessageRequest) (response *DescribeMessageResponse, err error)
DescribeMessage Query message details.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message"
func (*Client) DescribeMessageList ¶
func (c *Client) DescribeMessageList(request *DescribeMessageListRequest) (response *DescribeMessageListResponse, err error)
DescribeMessageList Query the message list. If querying dead letter messages, set the ConsumerGroup parameter.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeMessageListWithContext ¶
func (c *Client) DescribeMessageListWithContext(ctx context.Context, request *DescribeMessageListRequest) (response *DescribeMessageListResponse, err error)
DescribeMessageList Query the message list. If querying dead letter messages, set the ConsumerGroup parameter.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeMessageTrace ¶
func (c *Client) DescribeMessageTrace(request *DescribeMessageTraceRequest) (response *DescribeMessageTraceResponse, err error)
DescribeMessageTrace This API is used to query message trace by message ID.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message"
func (*Client) DescribeMessageTraceWithContext ¶
func (c *Client) DescribeMessageTraceWithContext(ctx context.Context, request *DescribeMessageTraceRequest) (response *DescribeMessageTraceResponse, err error)
DescribeMessageTrace This API is used to query message trace by message ID.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message"
func (*Client) DescribeMessageWithContext ¶
func (c *Client) DescribeMessageWithContext(ctx context.Context, request *DescribeMessageRequest) (response *DescribeMessageResponse, err error)
DescribeMessage Query message details.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message"
func (*Client) DescribeMigratingGroupStats ¶
func (c *Client) DescribeMigratingGroupStats(request *DescribeMigratingGroupStatsRequest) (response *DescribeMigratingGroupStatsResponse, err error)
DescribeMigratingGroupStats This API is used to view real-time information of migration consumption groups.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message"
func (*Client) DescribeMigratingGroupStatsWithContext ¶
func (c *Client) DescribeMigratingGroupStatsWithContext(ctx context.Context, request *DescribeMigratingGroupStatsRequest) (response *DescribeMigratingGroupStatsResponse, err error)
DescribeMigratingGroupStats This API is used to view real-time information of migration consumption groups.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MESSAGE = "ResourceNotFound.Message"
func (*Client) DescribeMigratingTopicList ¶
func (c *Client) DescribeMigratingTopicList(request *DescribeMigratingTopicListRequest) (response *DescribeMigratingTopicListResponse, err error)
DescribeMigratingTopicList This API is used to query the Topic migration status list.
The Filters field is a query filter that supports the following conditions:.
This API is used to get topic names with fuzzy query support.
This api is used to query the migration status. See the data structure in MigratingTopic (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic).
This API is used to manage namespaces, valid only for 4.x clusters.
This API is used to demonstrate Filters.
[{
"Name": "TopicName", "Values": ["topic-a"]
}]
error code that may be returned:
RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask"
func (*Client) DescribeMigratingTopicListWithContext ¶
func (c *Client) DescribeMigratingTopicListWithContext(ctx context.Context, request *DescribeMigratingTopicListRequest) (response *DescribeMigratingTopicListResponse, err error)
DescribeMigratingTopicList This API is used to query the Topic migration status list.
The Filters field is a query filter that supports the following conditions:.
This API is used to get topic names with fuzzy query support.
This api is used to query the migration status. See the data structure in MigratingTopic (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic).
This API is used to manage namespaces, valid only for 4.x clusters.
This API is used to demonstrate Filters.
[{
"Name": "TopicName", "Values": ["topic-a"]
}]
error code that may be returned:
RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask"
func (*Client) DescribeMigratingTopicStats ¶
func (c *Client) DescribeMigratingTopicStats(request *DescribeMigratingTopicStatsRequest) (response *DescribeMigratingTopicStatsResponse, err error)
DescribeMigratingTopicStats This API is used to query real-time data of migration topics.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeMigratingTopicStatsWithContext ¶
func (c *Client) DescribeMigratingTopicStatsWithContext(ctx context.Context, request *DescribeMigratingTopicStatsRequest) (response *DescribeMigratingTopicStatsResponse, err error)
DescribeMigratingTopicStats This API is used to query real-time data of migration topics.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeMigrationTaskList ¶
func (c *Client) DescribeMigrationTaskList(request *DescribeMigrationTaskListRequest) (response *DescribeMigrationTaskListResponse, err error)
DescribeMigrationTaskList This API is used to search the data migration task list. Filter parameter usage instructions are as follows:.
This API is used to search precisely according to task ID.
InstanceId. This API is used to precisely search based on instance ID.
This API is used to search by task Type.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeMigrationTaskListWithContext ¶
func (c *Client) DescribeMigrationTaskListWithContext(ctx context.Context, request *DescribeMigrationTaskListRequest) (response *DescribeMigrationTaskListResponse, err error)
DescribeMigrationTaskList This API is used to search the data migration task list. Filter parameter usage instructions are as follows:.
This API is used to search precisely according to task ID.
InstanceId. This API is used to precisely search based on instance ID.
This API is used to search by task Type.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeProducerList ¶
func (c *Client) DescribeProducerList(request *DescribeProducerListRequest) (response *DescribeProducerListResponse, err error)
DescribeProducerList This API is used to query producer list information associated with a topic. Filters support the following criteria:.
-client IP.
-client ID.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeProducerListWithContext ¶
func (c *Client) DescribeProducerListWithContext(ctx context.Context, request *DescribeProducerListRequest) (response *DescribeProducerListResponse, err error)
DescribeProducerList This API is used to query producer list information associated with a topic. Filters support the following criteria:.
-client IP.
-client ID.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeProductSKUs ¶
func (c *Client) DescribeProductSKUs(request *DescribeProductSKUsRequest) (response *DescribeProductSKUsResponse, err error)
DescribeProductSKUs This API is used to query product sales specifications against RocketMQ 5.x clusters.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeProductSKUsWithContext ¶
func (c *Client) DescribeProductSKUsWithContext(ctx context.Context, request *DescribeProductSKUsRequest) (response *DescribeProductSKUsResponse, err error)
DescribeProductSKUs This API is used to query product sales specifications against RocketMQ 5.x clusters.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeRoleList ¶
func (c *Client) DescribeRoleList(request *DescribeRoleListRequest) (response *DescribeRoleListResponse, err error)
DescribeRoleList This API is used to query the list of roles. Filter parameter usage instructions are as follows:.
-Role name supports fuzzy search and can be obtained from the API return value or console.
-AccessKey, support fuzzy search, obtain from API return value or console.
This API is used to demonstrate Filters.
[{ "Name": "RoleName", "Values": ["test_role"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeRoleListWithContext ¶
func (c *Client) DescribeRoleListWithContext(ctx context.Context, request *DescribeRoleListRequest) (response *DescribeRoleListResponse, err error)
DescribeRoleList This API is used to query the list of roles. Filter parameter usage instructions are as follows:.
-Role name supports fuzzy search and can be obtained from the API return value or console.
-AccessKey, support fuzzy search, obtain from API return value or console.
This API is used to demonstrate Filters.
[{ "Name": "RoleName", "Values": ["test_role"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeSmoothMigrationTaskList ¶
func (c *Client) DescribeSmoothMigrationTaskList(request *DescribeSmoothMigrationTaskListRequest) (response *DescribeSmoothMigrationTaskListResponse, err error)
DescribeSmoothMigrationTaskList This API is used to query the migration task list smoothly.
This API is used to query the supported fields of the query parameter Filters as follows:.
Task status, supports multiple selections.
ConnectionType, network connection type, supports multiple selections. See the description of SmoothMigrationTaskItem (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem).
This API is used to search for an instance by instance ID with precise matching.
This API is used to query task names with fuzzy search support.
This API is used to demonstrate Filters.
[{
"Name": "InstanceId", "Values": ["rmq-1gzecldfg"]
}]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeSmoothMigrationTaskListWithContext ¶
func (c *Client) DescribeSmoothMigrationTaskListWithContext(ctx context.Context, request *DescribeSmoothMigrationTaskListRequest) (response *DescribeSmoothMigrationTaskListResponse, err error)
DescribeSmoothMigrationTaskList This API is used to query the migration task list smoothly.
This API is used to query the supported fields of the query parameter Filters as follows:.
Task status, supports multiple selections.
ConnectionType, network connection type, supports multiple selections. See the description of SmoothMigrationTaskItem (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem).
This API is used to search for an instance by instance ID with precise matching.
This API is used to query task names with fuzzy search support.
This API is used to demonstrate Filters.
[{
"Name": "InstanceId", "Values": ["rmq-1gzecldfg"]
}]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeSourceClusterGroupList ¶
func (c *Client) DescribeSourceClusterGroupList(request *DescribeSourceClusterGroupListRequest) (response *DescribeSourceClusterGroupListResponse, err error)
DescribeSourceClusterGroupList This API is used to obtain the group list of the source cluster during the smooth migration process.
The Filters field is a query filter that supports the following fields:.
This API is used to query consumer group names with fuzzy search support.
This API is used to check whether the data is Imported.
This api is used to check the import status. See SourceClusterGroupConfig (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) for details.
This API is used to manage namespaces, valid only for 4.x clusters.
This API is used to demonstrate Filters.
[{
"Name": "GroupName", "Values": ["group-a"]
}]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeSourceClusterGroupListWithContext ¶
func (c *Client) DescribeSourceClusterGroupListWithContext(ctx context.Context, request *DescribeSourceClusterGroupListRequest) (response *DescribeSourceClusterGroupListResponse, err error)
DescribeSourceClusterGroupList This API is used to obtain the group list of the source cluster during the smooth migration process.
The Filters field is a query filter that supports the following fields:.
This API is used to query consumer group names with fuzzy search support.
This API is used to check whether the data is Imported.
This api is used to check the import status. See SourceClusterGroupConfig (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) for details.
This API is used to manage namespaces, valid only for 4.x clusters.
This API is used to demonstrate Filters.
[{
"Name": "GroupName", "Values": ["group-a"]
}]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_MIGRATIONTASK = "ResourceNotFound.MigrationTask" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic" RESOURCEUNAVAILABLE = "ResourceUnavailable"
func (*Client) DescribeTopic ¶
func (c *Client) DescribeTopic(request *DescribeTopicRequest) (response *DescribeTopicResponse, err error)
DescribeTopic This API is used to query topic details. The Offset and Limit parameters are pagination parameters for consumer groups subscribing to this topic. The Filter parameter usage instructions are as follows:.
-The ConsumerGroup name can be obtained from the [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) in the API response of [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
This API is used to demonstrate Filters.
[{ "Name": "ConsumerGroup", "Values": ["test_group"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic"
func (*Client) DescribeTopicList ¶
func (c *Client) DescribeTopicList(request *DescribeTopicListRequest) (response *DescribeTopicListResponse, err error)
DescribeTopicList This API is used to search the topic list. Filter parameter usage instructions are as follows:.
-TopicName supports fuzzy search. Obtain it from the TopicItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) in the [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) API response or the console.
-Search by TopicType, support multiple selections. See the TopicType field in the [DescribeTopic](https://www.tencentcloud.comom/document/api/1493/97945?from_cn_redirect=1) API.
This API is used to demonstrate Filters.
[{ "Name": "TopicName", "Values": ["test_topic"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeTopicListByGroup ¶
func (c *Client) DescribeTopicListByGroup(request *DescribeTopicListByGroupRequest) (response *DescribeTopicListByGroupResponse, err error)
DescribeTopicListByGroup This API is used to get topic list by consumer group. Filter parameter usage instructions are as follows:.
-TopicName. It can be obtained from TopicItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
This API is used to demonstrate Filters.
[{ "Name": "TopicName", "Values": ["test_topic"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeTopicListByGroupWithContext ¶
func (c *Client) DescribeTopicListByGroupWithContext(ctx context.Context, request *DescribeTopicListByGroupRequest) (response *DescribeTopicListByGroupResponse, err error)
DescribeTopicListByGroup This API is used to get topic list by consumer group. Filter parameter usage instructions are as follows:.
-TopicName. It can be obtained from TopicItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
This API is used to demonstrate Filters.
[{ "Name": "TopicName", "Values": ["test_topic"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeTopicListWithContext ¶
func (c *Client) DescribeTopicListWithContext(ctx context.Context, request *DescribeTopicListRequest) (response *DescribeTopicListResponse, err error)
DescribeTopicList This API is used to search the topic list. Filter parameter usage instructions are as follows:.
-TopicName supports fuzzy search. Obtain it from the TopicItem(https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) in the [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) API response or the console.
-Search by TopicType, support multiple selections. See the TopicType field in the [DescribeTopic](https://www.tencentcloud.comom/document/api/1493/97945?from_cn_redirect=1) API.
This API is used to demonstrate Filters.
[{ "Name": "TopicName", "Values": ["test_topic"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DescribeTopicWithContext ¶
func (c *Client) DescribeTopicWithContext(ctx context.Context, request *DescribeTopicRequest) (response *DescribeTopicResponse, err error)
DescribeTopic This API is used to query topic details. The Offset and Limit parameters are pagination parameters for consumer groups subscribing to this topic. The Filter parameter usage instructions are as follows:.
-The ConsumerGroup name can be obtained from the [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) in the API response of [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
This API is used to demonstrate Filters.
[{ "Name": "ConsumerGroup", "Values": ["test_group"] }]
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_TOPIC = "ResourceNotFound.Topic"
func (*Client) DoHealthCheckOnMigratingTopic ¶
func (c *Client) DoHealthCheckOnMigratingTopic(request *DoHealthCheckOnMigratingTopicRequest) (response *DoHealthCheckOnMigratingTopicResponse, err error)
DoHealthCheckOnMigratingTopic This API is used to check whether the topics being migrated are in normal status. Only topics in normal status can enter the next migration stage.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) DoHealthCheckOnMigratingTopicWithContext ¶
func (c *Client) DoHealthCheckOnMigratingTopicWithContext(ctx context.Context, request *DoHealthCheckOnMigratingTopicRequest) (response *DoHealthCheckOnMigratingTopicResponse, err error)
DoHealthCheckOnMigratingTopic This API is used to check whether the topics being migrated are in normal status. Only topics in normal status can enter the next migration stage.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) ModifyConsumerGroup ¶
func (c *Client) ModifyConsumerGroup(request *ModifyConsumerGroupRequest) (response *ModifyConsumerGroupResponse, err error)
ModifyConsumerGroup Modify consumer group attributes.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) ModifyConsumerGroupWithContext ¶
func (c *Client) ModifyConsumerGroupWithContext(ctx context.Context, request *ModifyConsumerGroupRequest) (response *ModifyConsumerGroupResponse, err error)
ModifyConsumerGroup Modify consumer group attributes.
error code that may be returned:
RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance"
func (*Client) ModifyInstance ¶
func (c *Client) ModifyInstance(request *ModifyInstanceRequest) (response *ModifyInstanceResponse, err error)
ModifyInstance This API is used to modify attributes of a TDMQ RocketMQ 5.x cluster. Only running clusters support this operation.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNSUPPORTEDOPERATION_INSTANCETOPICNUMDOWNGRADE = "UnsupportedOperation.InstanceTopicNumDowngrade"
func (*Client) ModifyInstanceEndpoint ¶
func (c *Client) ModifyInstanceEndpoint(request *ModifyInstanceEndpointRequest) (response *ModifyInstanceEndpointResponse, err error)
ModifyInstanceEndpoint This API is used to modify access points of a TDMQ RocketMQ 5.x cluster. Make sure that the access points exist before the operation.
error code that may be returned:
OPERATIONDENIED = "OperationDenied" RESOURCENOTFOUND_ENDPOINT = "ResourceNotFound.Endpoint" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ModifyInstanceEndpointWithContext ¶
func (c *Client) ModifyInstanceEndpointWithContext(ctx context.Context, request *ModifyInstanceEndpointRequest) (response *ModifyInstanceEndpointResponse, err error)
ModifyInstanceEndpoint This API is used to modify access points of a TDMQ RocketMQ 5.x cluster. Make sure that the access points exist before the operation.
error code that may be returned:
OPERATIONDENIED = "OperationDenied" RESOURCENOTFOUND_ENDPOINT = "ResourceNotFound.Endpoint" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ModifyInstanceWithContext ¶
func (c *Client) ModifyInstanceWithContext(ctx context.Context, request *ModifyInstanceRequest) (response *ModifyInstanceResponse, err error)
ModifyInstance This API is used to modify attributes of a TDMQ RocketMQ 5.x cluster. Only running clusters support this operation.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INSTANCENOTREADY = "FailedOperation.InstanceNotReady" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNSUPPORTEDOPERATION_INSTANCETOPICNUMDOWNGRADE = "UnsupportedOperation.InstanceTopicNumDowngrade"
func (*Client) ModifyRole ¶
func (c *Client) ModifyRole(request *ModifyRoleRequest) (response *ModifyRoleResponse, err error)
ModifyRole This API is used to modify a role.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role"
func (*Client) ModifyRoleWithContext ¶
func (c *Client) ModifyRoleWithContext(ctx context.Context, request *ModifyRoleRequest) (response *ModifyRoleResponse, err error)
ModifyRole This API is used to modify a role.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" RESOURCENOTFOUND_INSTANCE = "ResourceNotFound.Instance" RESOURCENOTFOUND_ROLE = "ResourceNotFound.Role"
func (*Client) ModifyTopic ¶
func (c *Client) ModifyTopic(request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
ModifyTopic Modify topic attributes.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) ModifyTopicWithContext ¶
func (c *Client) ModifyTopicWithContext(ctx context.Context, request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
ModifyTopic Modify topic attributes.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) RemoveMigratingTopic ¶
func (c *Client) RemoveMigratingTopic(request *RemoveMigratingTopicRequest) (response *RemoveMigratingTopicResponse, err error)
RemoveMigratingTopic This API is used to remove a topic from the migration list. It is valid only when the topic is in the initial state.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) RemoveMigratingTopicWithContext ¶
func (c *Client) RemoveMigratingTopicWithContext(ctx context.Context, request *RemoveMigratingTopicRequest) (response *RemoveMigratingTopicResponse, err error)
RemoveMigratingTopic This API is used to remove a topic from the migration list. It is valid only when the topic is in the initial state.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) ResendDeadLetterMessage ¶
func (c *Client) ResendDeadLetterMessage(request *ResendDeadLetterMessageRequest) (response *ResendDeadLetterMessageResponse, err error)
ResendDeadLetterMessage This API is used to resend dead letter messages.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) ResendDeadLetterMessageWithContext ¶
func (c *Client) ResendDeadLetterMessageWithContext(ctx context.Context, request *ResendDeadLetterMessageRequest) (response *ResendDeadLetterMessageResponse, err error)
ResendDeadLetterMessage This API is used to resend dead letter messages.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) ResetConsumerGroupOffset ¶
func (c *Client) ResetConsumerGroupOffset(request *ResetConsumerGroupOffsetRequest) (response *ResetConsumerGroupOffsetResponse, err error)
ResetConsumerGroupOffset Reset the consumption position.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) ResetConsumerGroupOffsetWithContext ¶
func (c *Client) ResetConsumerGroupOffsetWithContext(ctx context.Context, request *ResetConsumerGroupOffsetRequest) (response *ResetConsumerGroupOffsetResponse, err error)
ResetConsumerGroupOffset Reset the consumption position.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) RollbackMigratingTopicStage ¶
func (c *Client) RollbackMigratingTopicStage(request *RollbackMigratingTopicStageRequest) (response *RollbackMigratingTopicStageResponse, err error)
RollbackMigratingTopicStage This API is used to roll back the topic that is undergoing migration to the previous stage.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
func (*Client) RollbackMigratingTopicStageWithContext ¶
func (c *Client) RollbackMigratingTopicStageWithContext(ctx context.Context, request *RollbackMigratingTopicStageRequest) (response *RollbackMigratingTopicStageResponse, err error)
RollbackMigratingTopicStage This API is used to roll back the topic that is undergoing migration to the previous stage.
error code that may be returned:
FAILEDOPERATION = "FailedOperation"
type ClientSubscriptionInfo ¶
type ClientSubscriptionInfo struct {
// Client ID
ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`
// Client ip address.
ClientAddr *string `json:"ClientAddr,omitnil,omitempty" name:"ClientAddr"`
// Specifies the subscribed topic.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Subscription expression.
SubString *string `json:"SubString,omitnil,omitempty" name:"SubString"`
// Specifies the subscription method.
ExpressionType *string `json:"ExpressionType,omitnil,omitempty" name:"ExpressionType"`
}
type ConsumerClient ¶
type ConsumerClient struct {
// Client ID
ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`
// Client address.
ClientAddr *string `json:"ClientAddr,omitnil,omitempty" name:"ClientAddr"`
// Client SDK language
Language *string `json:"Language,omitnil,omitempty" name:"Language"`
// Client SDK version
Version *string `json:"Version,omitnil,omitempty" name:"Version"`
// Client consumption heap
//
// Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLag *int64 `json:"ConsumerLag,omitnil,omitempty" name:"ConsumerLag"`
// Consumer client type. valid values:.
//
// -Specifies the grpc protocol.
// -remoting protocol.
// -http protocol.
// Note: This field may return null, indicating that no valid values can be obtained.
ChannelProtocol *string `json:"ChannelProtocol,omitnil,omitempty" name:"ChannelProtocol"`
}
type CreateConsumerGroupRequest ¶
type CreateConsumerGroupRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Maximum number of retries. Value range: 0 to 1000.
MaxRetryTimes *int64 `json:"MaxRetryTimes,omitnil,omitempty" name:"MaxRetryTimes"`
// Whether to enable consumption.
ConsumeEnable *bool `json:"ConsumeEnable,omitnil,omitempty" name:"ConsumeEnable"`
// Specifies whether to use ordered delivery. valid values: true.
// Concurrent delivery: false.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Tag list
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}
func NewCreateConsumerGroupRequest ¶
func NewCreateConsumerGroupRequest() (request *CreateConsumerGroupRequest)
func (*CreateConsumerGroupRequest) FromJsonString ¶
func (r *CreateConsumerGroupRequest) 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 (*CreateConsumerGroupRequest) ToJsonString ¶
func (r *CreateConsumerGroupRequest) ToJsonString() string
type CreateConsumerGroupRequestParams ¶
type CreateConsumerGroupRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Maximum number of retries. Value range: 0 to 1000.
MaxRetryTimes *int64 `json:"MaxRetryTimes,omitnil,omitempty" name:"MaxRetryTimes"`
// Whether to enable consumption.
ConsumeEnable *bool `json:"ConsumeEnable,omitnil,omitempty" name:"ConsumeEnable"`
// Specifies whether to use ordered delivery. valid values: true.
// Concurrent delivery: false.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Tag list
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}
Predefined struct for user
type CreateConsumerGroupResponse ¶
type CreateConsumerGroupResponse struct {
*tchttp.BaseResponse
Response *CreateConsumerGroupResponseParams `json:"Response"`
}
func NewCreateConsumerGroupResponse ¶
func NewCreateConsumerGroupResponse() (response *CreateConsumerGroupResponse)
func (*CreateConsumerGroupResponse) FromJsonString ¶
func (r *CreateConsumerGroupResponse) 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 (*CreateConsumerGroupResponse) ToJsonString ¶
func (r *CreateConsumerGroupResponse) ToJsonString() string
type CreateConsumerGroupResponseParams ¶
type CreateConsumerGroupResponseParams struct {
// Cluster ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Specifies the consumer group name.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type CreateInstanceRequest ¶
type CreateInstanceRequest struct {
*tchttp.BaseRequest
// Instance type. valid values are as follows:.
//
// -EXPERIMENT: specifies the trial version.
//
// - BASIC: BASIC edition.
//
// -PRO edition.
//
// -PLATINUM: platinum version.
InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`
// Cluster name. values cannot be empty. 3-64 characters, only comprised of digits, letters, "-", and "_".
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Product specification. It can be obtained from the output parameters of [ProductSKU](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU) of the API [DescribeProductSKUs](https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// Specifies the VPC information bound to the cluster.
VpcList []*VpcInfo `json:"VpcList,omitnil,omitempty" name:"VpcList"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Tag list
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
// Whether public network access is enabled. the default value of false means not enabled.
EnablePublic *bool `json:"EnablePublic,omitnil,omitempty" name:"EnablePublic"`
// Whether the public network is billed by traffic. the default value is false, which indicates that the public network is not billed by traffic.
BillingFlow *bool `json:"BillingFlow,omitnil,omitempty" name:"BillingFlow"`
// Public network bandwidth (unit: mbps). the default value is 0. if public network access is enabled, this field must be a positive integer above 0.
Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`
// Public network access allowlist. if left blank, it means deny all IP access.
IpRules []*IpRule `json:"IpRules,omitnil,omitempty" name:"IpRules"`
// Message retention time (unit: hr). value range refers to the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
//
// -Default value: DefaultRetention parameter.
// -Minimum value: specifies the RetentionLowerLimit parameter.
// -Specifies the maximum value of the RetentionUpperLimit parameter.
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Payment mode (0: postpaid; 1: prepaid). the default value is 0.
PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`
// Whether the prepaid cluster is automatically renewed (0: no auto-renewal; 1: auto-renewal). default value: 0.
RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
// Specifies the purchase duration (unit: month) for a prepaid cluster. value range: 1–60. default value: 1.
TimeSpan *int64 `json:"TimeSpan,omitnil,omitempty" name:"TimeSpan"`
// Specifies the maximum number of topics that can be created. obtained from the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1) (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU).
//
// -Default value and minimum value: specifies the TopicNumLimit parameter.
// -Maximum value of TopicNumUpperLimit parameter.
MaxTopicNum *int64 `json:"MaxTopicNum,omitnil,omitempty" name:"MaxTopicNum"`
// Deployment AZ list. obtain from the [ZoneInfo](https://www.tencentcloud.comom/document/api/1596/77932?from_cn_redirect=1#ZoneInfo) data structure returned by the api [DescribeZones](https://www.tencentcloud.comom/document/product/1596/77929?from_cn_redirect=1).
ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`
}
func NewCreateInstanceRequest ¶
func NewCreateInstanceRequest() (request *CreateInstanceRequest)
func (*CreateInstanceRequest) FromJsonString ¶
func (r *CreateInstanceRequest) 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 (*CreateInstanceRequest) ToJsonString ¶
func (r *CreateInstanceRequest) ToJsonString() string
type CreateInstanceRequestParams ¶
type CreateInstanceRequestParams struct {
// Instance type. valid values are as follows:.
//
// -EXPERIMENT: specifies the trial version.
//
// - BASIC: BASIC edition.
//
// -PRO edition.
//
// -PLATINUM: platinum version.
InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`
// Cluster name. values cannot be empty. 3-64 characters, only comprised of digits, letters, "-", and "_".
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Product specification. It can be obtained from the output parameters of [ProductSKU](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU) of the API [DescribeProductSKUs](https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// Specifies the VPC information bound to the cluster.
VpcList []*VpcInfo `json:"VpcList,omitnil,omitempty" name:"VpcList"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Tag list
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
// Whether public network access is enabled. the default value of false means not enabled.
EnablePublic *bool `json:"EnablePublic,omitnil,omitempty" name:"EnablePublic"`
// Whether the public network is billed by traffic. the default value is false, which indicates that the public network is not billed by traffic.
BillingFlow *bool `json:"BillingFlow,omitnil,omitempty" name:"BillingFlow"`
// Public network bandwidth (unit: mbps). the default value is 0. if public network access is enabled, this field must be a positive integer above 0.
Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`
// Public network access allowlist. if left blank, it means deny all IP access.
IpRules []*IpRule `json:"IpRules,omitnil,omitempty" name:"IpRules"`
// Message retention time (unit: hr). value range refers to the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
//
// -Default value: DefaultRetention parameter.
// -Minimum value: specifies the RetentionLowerLimit parameter.
// -Specifies the maximum value of the RetentionUpperLimit parameter.
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Payment mode (0: postpaid; 1: prepaid). the default value is 0.
PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`
// Whether the prepaid cluster is automatically renewed (0: no auto-renewal; 1: auto-renewal). default value: 0.
RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
// Specifies the purchase duration (unit: month) for a prepaid cluster. value range: 1–60. default value: 1.
TimeSpan *int64 `json:"TimeSpan,omitnil,omitempty" name:"TimeSpan"`
// Specifies the maximum number of topics that can be created. obtained from the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1) (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU).
//
// -Default value and minimum value: specifies the TopicNumLimit parameter.
// -Maximum value of TopicNumUpperLimit parameter.
MaxTopicNum *int64 `json:"MaxTopicNum,omitnil,omitempty" name:"MaxTopicNum"`
// Deployment AZ list. obtain from the [ZoneInfo](https://www.tencentcloud.comom/document/api/1596/77932?from_cn_redirect=1#ZoneInfo) data structure returned by the api [DescribeZones](https://www.tencentcloud.comom/document/product/1596/77929?from_cn_redirect=1).
ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`
}
Predefined struct for user
type CreateInstanceResponse ¶
type CreateInstanceResponse struct {
*tchttp.BaseResponse
Response *CreateInstanceResponseParams `json:"Response"`
}
func NewCreateInstanceResponse ¶
func NewCreateInstanceResponse() (response *CreateInstanceResponse)
func (*CreateInstanceResponse) FromJsonString ¶
func (r *CreateInstanceResponse) 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 (*CreateInstanceResponse) ToJsonString ¶
func (r *CreateInstanceResponse) ToJsonString() string
type CreateInstanceResponseParams ¶
type CreateInstanceResponseParams struct {
// Cluster ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type CreateRoleRequest ¶
type CreateRoleRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Role name. It cannot be left blank. Only digits, uppercase and lowercase letters, and separators (_ -) are supported. The name cannot exceed 32 characters.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
// Whether to enable production permission
PermWrite *bool `json:"PermWrite,omitnil,omitempty" name:"PermWrite"`
// Whether to enable consumption permission
PermRead *bool `json:"PermRead,omitnil,omitempty" name:"PermRead"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group level).
PermType *string `json:"PermType,omitnil,omitempty" name:"PermType"`
// Permission configuration in the topic/group dimension. It is required when the permission type parameter is set to TopicAndGroup.
DetailedPerms []*DetailedRolePerm `json:"DetailedPerms,omitnil,omitempty" name:"DetailedPerms"`
}
func NewCreateRoleRequest ¶
func NewCreateRoleRequest() (request *CreateRoleRequest)
func (*CreateRoleRequest) FromJsonString ¶
func (r *CreateRoleRequest) 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 (*CreateRoleRequest) ToJsonString ¶
func (r *CreateRoleRequest) ToJsonString() string
type CreateRoleRequestParams ¶
type CreateRoleRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Role name. It cannot be left blank. Only digits, uppercase and lowercase letters, and separators (_ -) are supported. The name cannot exceed 32 characters.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
// Whether to enable production permission
PermWrite *bool `json:"PermWrite,omitnil,omitempty" name:"PermWrite"`
// Whether to enable consumption permission
PermRead *bool `json:"PermRead,omitnil,omitempty" name:"PermRead"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group level).
PermType *string `json:"PermType,omitnil,omitempty" name:"PermType"`
// Permission configuration in the topic/group dimension. It is required when the permission type parameter is set to TopicAndGroup.
DetailedPerms []*DetailedRolePerm `json:"DetailedPerms,omitnil,omitempty" name:"DetailedPerms"`
}
Predefined struct for user
type CreateRoleResponse ¶
type CreateRoleResponse struct {
*tchttp.BaseResponse
Response *CreateRoleResponseParams `json:"Response"`
}
func NewCreateRoleResponse ¶
func NewCreateRoleResponse() (response *CreateRoleResponse)
func (*CreateRoleResponse) FromJsonString ¶
func (r *CreateRoleResponse) 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 (*CreateRoleResponse) ToJsonString ¶
func (r *CreateRoleResponse) ToJsonString() string
type CreateRoleResponseParams ¶
type CreateRoleResponseParams struct {
// Role name.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DeleteConsumerGroupRequest ¶
type DeleteConsumerGroupRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
func NewDeleteConsumerGroupRequest ¶
func NewDeleteConsumerGroupRequest() (request *DeleteConsumerGroupRequest)
func (*DeleteConsumerGroupRequest) FromJsonString ¶
func (r *DeleteConsumerGroupRequest) 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 (*DeleteConsumerGroupRequest) ToJsonString ¶
func (r *DeleteConsumerGroupRequest) ToJsonString() string
type DeleteConsumerGroupRequestParams ¶
type DeleteConsumerGroupRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
Predefined struct for user
type DeleteConsumerGroupResponse ¶
type DeleteConsumerGroupResponse struct {
*tchttp.BaseResponse
Response *DeleteConsumerGroupResponseParams `json:"Response"`
}
func NewDeleteConsumerGroupResponse ¶
func NewDeleteConsumerGroupResponse() (response *DeleteConsumerGroupResponse)
func (*DeleteConsumerGroupResponse) FromJsonString ¶
func (r *DeleteConsumerGroupResponse) 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 (*DeleteConsumerGroupResponse) ToJsonString ¶
func (r *DeleteConsumerGroupResponse) ToJsonString() string
type DeleteConsumerGroupResponseParams ¶
type DeleteConsumerGroupResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DeleteInstanceRequest ¶
type DeleteInstanceRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}
func NewDeleteInstanceRequest ¶
func NewDeleteInstanceRequest() (request *DeleteInstanceRequest)
func (*DeleteInstanceRequest) FromJsonString ¶
func (r *DeleteInstanceRequest) 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 (*DeleteInstanceRequest) ToJsonString ¶
func (r *DeleteInstanceRequest) ToJsonString() string
type DeleteInstanceRequestParams ¶
type DeleteInstanceRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}
Predefined struct for user
type DeleteInstanceResponse ¶
type DeleteInstanceResponse struct {
*tchttp.BaseResponse
Response *DeleteInstanceResponseParams `json:"Response"`
}
func NewDeleteInstanceResponse ¶
func NewDeleteInstanceResponse() (response *DeleteInstanceResponse)
func (*DeleteInstanceResponse) FromJsonString ¶
func (r *DeleteInstanceResponse) 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 (*DeleteInstanceResponse) ToJsonString ¶
func (r *DeleteInstanceResponse) ToJsonString() string
type DeleteInstanceResponseParams ¶
type DeleteInstanceResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DeleteRoleRequest ¶
type DeleteRoleRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Role name. It can be obtained from [RoleItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#RoleItem) returned by the API [DescribeRoleList](https://www.tencentcloud.comom/document/api/1493/98862?from_cn_redirect=1) or from the console.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
}
func NewDeleteRoleRequest ¶
func NewDeleteRoleRequest() (request *DeleteRoleRequest)
func (*DeleteRoleRequest) FromJsonString ¶
func (r *DeleteRoleRequest) 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 (*DeleteRoleRequest) ToJsonString ¶
func (r *DeleteRoleRequest) ToJsonString() string
type DeleteRoleRequestParams ¶
type DeleteRoleRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Role name. It can be obtained from [RoleItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#RoleItem) returned by the API [DescribeRoleList](https://www.tencentcloud.comom/document/api/1493/98862?from_cn_redirect=1) or from the console.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
}
Predefined struct for user
type DeleteRoleResponse ¶
type DeleteRoleResponse struct {
*tchttp.BaseResponse
Response *DeleteRoleResponseParams `json:"Response"`
}
func NewDeleteRoleResponse ¶
func NewDeleteRoleResponse() (response *DeleteRoleResponse)
func (*DeleteRoleResponse) FromJsonString ¶
func (r *DeleteRoleResponse) 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 (*DeleteRoleResponse) ToJsonString ¶
func (r *DeleteRoleResponse) ToJsonString() string
type DeleteRoleResponseParams ¶
type DeleteRoleResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DeleteSmoothMigrationTaskRequest ¶
type DeleteSmoothMigrationTaskRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}
func NewDeleteSmoothMigrationTaskRequest ¶
func NewDeleteSmoothMigrationTaskRequest() (request *DeleteSmoothMigrationTaskRequest)
func (*DeleteSmoothMigrationTaskRequest) FromJsonString ¶
func (r *DeleteSmoothMigrationTaskRequest) 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 (*DeleteSmoothMigrationTaskRequest) ToJsonString ¶
func (r *DeleteSmoothMigrationTaskRequest) ToJsonString() string
type DeleteSmoothMigrationTaskRequestParams ¶
type DeleteSmoothMigrationTaskRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
}
Predefined struct for user
type DeleteSmoothMigrationTaskResponse ¶
type DeleteSmoothMigrationTaskResponse struct {
*tchttp.BaseResponse
Response *DeleteSmoothMigrationTaskResponseParams `json:"Response"`
}
func NewDeleteSmoothMigrationTaskResponse ¶
func NewDeleteSmoothMigrationTaskResponse() (response *DeleteSmoothMigrationTaskResponse)
func (*DeleteSmoothMigrationTaskResponse) FromJsonString ¶
func (r *DeleteSmoothMigrationTaskResponse) 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 (*DeleteSmoothMigrationTaskResponse) ToJsonString ¶
func (r *DeleteSmoothMigrationTaskResponse) ToJsonString() string
type DeleteSmoothMigrationTaskResponseParams ¶
type DeleteSmoothMigrationTaskResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
}
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 {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
}
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 {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeConsumerClientListRequest ¶
type DescribeConsumerClientListRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
func NewDescribeConsumerClientListRequest ¶
func NewDescribeConsumerClientListRequest() (request *DescribeConsumerClientListRequest)
func (*DescribeConsumerClientListRequest) FromJsonString ¶
func (r *DescribeConsumerClientListRequest) 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 (*DescribeConsumerClientListRequest) ToJsonString ¶
func (r *DescribeConsumerClientListRequest) ToJsonString() string
type DescribeConsumerClientListRequestParams ¶
type DescribeConsumerClientListRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
Predefined struct for user
type DescribeConsumerClientListResponse ¶
type DescribeConsumerClientListResponse struct {
*tchttp.BaseResponse
Response *DescribeConsumerClientListResponseParams `json:"Response"`
}
func NewDescribeConsumerClientListResponse ¶
func NewDescribeConsumerClientListResponse() (response *DescribeConsumerClientListResponse)
func (*DescribeConsumerClientListResponse) FromJsonString ¶
func (r *DescribeConsumerClientListResponse) 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 (*DescribeConsumerClientListResponse) ToJsonString ¶
func (r *DescribeConsumerClientListResponse) ToJsonString() string
type DescribeConsumerClientListResponseParams ¶
type DescribeConsumerClientListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Consumer client
Data []*ConsumerClient `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeConsumerClientRequest ¶
type DescribeConsumerClientRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Client ID. It can be obtained from the output parameters of [ConsumerClient](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumerClient) of the API [DescribeConsumerClientList](https://www.tencentcloud.comom/document/api/1493/120140?from_cn_redirect=1).
ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
func NewDescribeConsumerClientRequest ¶
func NewDescribeConsumerClientRequest() (request *DescribeConsumerClientRequest)
func (*DescribeConsumerClientRequest) FromJsonString ¶
func (r *DescribeConsumerClientRequest) 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 (*DescribeConsumerClientRequest) ToJsonString ¶
func (r *DescribeConsumerClientRequest) ToJsonString() string
type DescribeConsumerClientRequestParams ¶
type DescribeConsumerClientRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Client ID. It can be obtained from the output parameters of [ConsumerClient](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumerClient) of the API [DescribeConsumerClientList](https://www.tencentcloud.comom/document/api/1493/120140?from_cn_redirect=1).
ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
Predefined struct for user
type DescribeConsumerClientResponse ¶
type DescribeConsumerClientResponse struct {
*tchttp.BaseResponse
Response *DescribeConsumerClientResponseParams `json:"Response"`
}
func NewDescribeConsumerClientResponse ¶
func NewDescribeConsumerClientResponse() (response *DescribeConsumerClientResponse)
func (*DescribeConsumerClientResponse) FromJsonString ¶
func (r *DescribeConsumerClientResponse) 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 (*DescribeConsumerClientResponse) ToJsonString ¶
func (r *DescribeConsumerClientResponse) ToJsonString() string
type DescribeConsumerClientResponseParams ¶
type DescribeConsumerClientResponseParams struct {
// Client details
//
// Note: This field may return null, indicating that no valid values can be obtained.
Client *ConsumerClient `json:"Client,omitnil,omitempty" name:"Client"`
// Topic consumption information
//
// Note: This field may return null, indicating that no valid values can be obtained.
TopicList []*TopicConsumeStats `json:"TopicList,omitnil,omitempty" name:"TopicList"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeConsumerGroupRequest ¶
type DescribeConsumerGroupRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
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 {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
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 {
// Number of online consumers.
ConsumerNum *int64 `json:"ConsumerNum,omitnil,omitempty" name:"ConsumerNum"`
// TPS
Tps *int64 `json:"Tps,omitnil,omitempty" name:"Tps"`
// Specifies the number of accumulated messages.
ConsumerLag *int64 `json:"ConsumerLag,omitnil,omitempty" name:"ConsumerLag"`
// Consumption type. valid values as follows:.
//
// -PULL: specifies the pull consumption type.
// -PUSH: specifies the push consumption type.
// -POP: specifies the pop consumption type.
ConsumeType *string `json:"ConsumeType,omitnil,omitempty" name:"ConsumeType"`
// Creation time. **It is a Unix timestamp (ms).**
CreatedTime *int64 `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`
// Specifies whether to use ordered delivery. valid values: true.
// Concurrent delivery: false.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
// Whether to enable consumption.
ConsumeEnable *bool `json:"ConsumeEnable,omitnil,omitempty" name:"ConsumeEnable"`
// Maximum number of retries.
MaxRetryTimes *int64 `json:"MaxRetryTimes,omitnil,omitempty" name:"MaxRetryTimes"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies the consumption mode.
// BROADCASTING.
// CLUSTERING cluster mode.
MessageModel *string `json:"MessageModel,omitnil,omitempty" name:"MessageModel"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeConsumerLagRequest ¶
type DescribeConsumerLagRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Namespace. It is required for 4.x clusters. The namespace can be obtained from [RocketMQNamespace](https://www.tencentcloud.comom/document/api/1179/46089?from_cn_redirect=1#RocketMQNamespace) returned by the API [DescribeRocketMQNamespaces](https://www.tencentcloud.comom/document/api/1179/63419?from_cn_redirect=1) or from the console.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
// Subscribed topic. If it is not left blank, query heaped messages of consumer groups subscribing to the topic. The topic can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
SubscribeTopic *string `json:"SubscribeTopic,omitnil,omitempty" name:"SubscribeTopic"`
}
func NewDescribeConsumerLagRequest ¶
func NewDescribeConsumerLagRequest() (request *DescribeConsumerLagRequest)
func (*DescribeConsumerLagRequest) FromJsonString ¶
func (r *DescribeConsumerLagRequest) 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 (*DescribeConsumerLagRequest) ToJsonString ¶
func (r *DescribeConsumerLagRequest) ToJsonString() string
type DescribeConsumerLagRequestParams ¶
type DescribeConsumerLagRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Namespace. It is required for 4.x clusters. The namespace can be obtained from [RocketMQNamespace](https://www.tencentcloud.comom/document/api/1179/46089?from_cn_redirect=1#RocketMQNamespace) returned by the API [DescribeRocketMQNamespaces](https://www.tencentcloud.comom/document/api/1179/63419?from_cn_redirect=1) or from the console.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
// Subscribed topic. If it is not left blank, query heaped messages of consumer groups subscribing to the topic. The topic can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
SubscribeTopic *string `json:"SubscribeTopic,omitnil,omitempty" name:"SubscribeTopic"`
}
Predefined struct for user
type DescribeConsumerLagResponse ¶
type DescribeConsumerLagResponse struct {
*tchttp.BaseResponse
Response *DescribeConsumerLagResponseParams `json:"Response"`
}
func NewDescribeConsumerLagResponse ¶
func NewDescribeConsumerLagResponse() (response *DescribeConsumerLagResponse)
func (*DescribeConsumerLagResponse) FromJsonString ¶
func (r *DescribeConsumerLagResponse) 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 (*DescribeConsumerLagResponse) ToJsonString ¶
func (r *DescribeConsumerLagResponse) ToJsonString() string
type DescribeConsumerLagResponseParams ¶
type DescribeConsumerLagResponseParams struct {
// Number of heaped messages.
ConsumerLag *int64 `json:"ConsumerLag,omitnil,omitempty" name:"ConsumerLag"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeFusionInstanceListRequest ¶
type DescribeFusionInstanceListRequest struct {
*tchttp.BaseRequest
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Tag filter
TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
}
func NewDescribeFusionInstanceListRequest ¶
func NewDescribeFusionInstanceListRequest() (request *DescribeFusionInstanceListRequest)
func (*DescribeFusionInstanceListRequest) FromJsonString ¶
func (r *DescribeFusionInstanceListRequest) 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 (*DescribeFusionInstanceListRequest) ToJsonString ¶
func (r *DescribeFusionInstanceListRequest) ToJsonString() string
type DescribeFusionInstanceListRequestParams ¶
type DescribeFusionInstanceListRequestParams struct {
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Tag filter
TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
}
Predefined struct for user
type DescribeFusionInstanceListResponse ¶
type DescribeFusionInstanceListResponse struct {
*tchttp.BaseResponse
Response *DescribeFusionInstanceListResponseParams `json:"Response"`
}
func NewDescribeFusionInstanceListResponse ¶
func NewDescribeFusionInstanceListResponse() (response *DescribeFusionInstanceListResponse)
func (*DescribeFusionInstanceListResponse) FromJsonString ¶
func (r *DescribeFusionInstanceListResponse) 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 (*DescribeFusionInstanceListResponse) ToJsonString ¶
func (r *DescribeFusionInstanceListResponse) ToJsonString() string
type DescribeFusionInstanceListResponseParams ¶
type DescribeFusionInstanceListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Instance list
Data []*FusionInstanceItem `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeInstanceListRequest ¶
type DescribeInstanceListRequest struct {
*tchttp.BaseRequest
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Tag filter
TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
func NewDescribeInstanceListRequest ¶
func NewDescribeInstanceListRequest() (request *DescribeInstanceListRequest)
func (*DescribeInstanceListRequest) FromJsonString ¶
func (r *DescribeInstanceListRequest) 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 (*DescribeInstanceListRequest) ToJsonString ¶
func (r *DescribeInstanceListRequest) ToJsonString() string
type DescribeInstanceListRequestParams ¶
type DescribeInstanceListRequestParams struct {
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Tag filter
TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
Predefined struct for user
type DescribeInstanceListResponse ¶
type DescribeInstanceListResponse struct {
*tchttp.BaseResponse
Response *DescribeInstanceListResponseParams `json:"Response"`
}
func NewDescribeInstanceListResponse ¶
func NewDescribeInstanceListResponse() (response *DescribeInstanceListResponse)
func (*DescribeInstanceListResponse) FromJsonString ¶
func (r *DescribeInstanceListResponse) 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 (*DescribeInstanceListResponse) ToJsonString ¶
func (r *DescribeInstanceListResponse) ToJsonString() string
type DescribeInstanceListResponseParams ¶
type DescribeInstanceListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Instance list
Data []*InstanceItem `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeInstanceRequest ¶
type DescribeInstanceRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}
func NewDescribeInstanceRequest ¶
func NewDescribeInstanceRequest() (request *DescribeInstanceRequest)
func (*DescribeInstanceRequest) FromJsonString ¶
func (r *DescribeInstanceRequest) 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 (*DescribeInstanceRequest) ToJsonString ¶
func (r *DescribeInstanceRequest) ToJsonString() string
type DescribeInstanceRequestParams ¶
type DescribeInstanceRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}
Predefined struct for user
type DescribeInstanceResponse ¶
type DescribeInstanceResponse struct {
*tchttp.BaseResponse
Response *DescribeInstanceResponseParams `json:"Response"`
}
func NewDescribeInstanceResponse ¶
func NewDescribeInstanceResponse() (response *DescribeInstanceResponse)
func (*DescribeInstanceResponse) FromJsonString ¶
func (r *DescribeInstanceResponse) 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 (*DescribeInstanceResponse) ToJsonString ¶
func (r *DescribeInstanceResponse) ToJsonString() string
type DescribeInstanceResponseParams ¶
type DescribeInstanceResponseParams struct {
// Instance type.
// Specifies the EXPERIMENT trial version.
// BASIC version.
// PRO edition.
// PLATINUM. platinum version.
InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`
// Instance ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Instance name
InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
// Number of topics
TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`
// Maximum number of topics per instance
TopicNumLimit *int64 `json:"TopicNumLimit,omitnil,omitempty" name:"TopicNumLimit"`
// Number of consumer groups
GroupNum *int64 `json:"GroupNum,omitnil,omitempty" name:"GroupNum"`
// Maximum number of consumer groups per instance
GroupNumLimit *int64 `json:"GroupNumLimit,omitnil,omitempty" name:"GroupNumLimit"`
// Message retention time, in hours
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Maximum adjustable message retention time, in hours
RetentionUpperLimit *int64 `json:"RetentionUpperLimit,omitnil,omitempty" name:"RetentionUpperLimit"`
// Minimum adjustable message retention time, in hours
RetentionLowerLimit *int64 `json:"RetentionLowerLimit,omitnil,omitempty" name:"RetentionLowerLimit"`
// TPS throttle value
TpsLimit *int64 `json:"TpsLimit,omitnil,omitempty" name:"TpsLimit"`
// Elastic TPS throttle value
ScaledTpsLimit *int64 `json:"ScaledTpsLimit,omitnil,omitempty" name:"ScaledTpsLimit"`
// Maximum delayed message time, in hours
MaxMessageDelay *int64 `json:"MaxMessageDelay,omitnil,omitempty" name:"MaxMessageDelay"`
// Creation time. **It is a Unix timestamp (ms).**
CreatedTime *int64 `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`
// Message sending and receiving ratio
SendReceiveRatio *float64 `json:"SendReceiveRatio,omitnil,omitempty" name:"SendReceiveRatio"`
// Tag.
// Note: This field may return null, indicating that no valid values can be obtained.
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
// Access point list
//
// Note: This field may return null, indicating that no valid values can be obtained.
EndpointList []*Endpoint `json:"EndpointList,omitnil,omitempty" name:"EndpointList"`
// Maximum number of topic queues
TopicQueueNumUpperLimit *int64 `json:"TopicQueueNumUpperLimit,omitnil,omitempty" name:"TopicQueueNumUpperLimit"`
// Minimum queue count for topic
TopicQueueNumLowerLimit *int64 `json:"TopicQueueNumLowerLimit,omitnil,omitempty" name:"TopicQueueNumLowerLimit"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Instance status. valid values are as follows:.
//
// - RUNNING: RUNNING.
// -ABNORMAL: indicates an abnormal status.
// -OVERDUE: isolated.
// -DESTROYED: specifies the terminated status.
// -CREATING: creating.
// -MODIFYING.
// -CREATE_FAILURE: creation failed.
// -MODIFY_FAILURE: configuration adjustment failure.
// -DELETING: deleting.
InstanceStatus *string `json:"InstanceStatus,omitnil,omitempty" name:"InstanceStatus"`
// Instance specification.
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// Billing mode. valid enumeration values are as follows:.
//
// - POSTPAID: POSTPAID pay-as-you-go billing.
// - PREPAID: PREPAID annual and monthly.
PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`
// Whether to enable elastic TPS.
ScaledTpsEnabled *bool `json:"ScaledTpsEnabled,omitnil,omitempty" name:"ScaledTpsEnabled"`
// Specifies whether the prepaid cluster is automatically renewed. valid values are as follows:.
//
// - 0: no automatic renewal.
// - 1: specifies automatic renewal.
RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
// Expiration time. **It is a Unix timestamp (ms).**
ExpiryTime *int64 `json:"ExpiryTime,omitnil,omitempty" name:"ExpiryTime"`
// Specifies the limit on the number of roles.
RoleNumLimit *int64 `json:"RoleNumLimit,omitnil,omitempty" name:"RoleNumLimit"`
// Whether ACL is enabled.
// Note: This field may return null, indicating that no valid values can be obtained.
AclEnabled *bool `json:"AclEnabled,omitnil,omitempty" name:"AclEnabled"`
// Number of topics within the free quota.
// Note: This field may return null, indicating that no valid values can be obtained.
TopicNumLowerLimit *int64 `json:"TopicNumLowerLimit,omitnil,omitempty" name:"TopicNumLowerLimit"`
// Maximum settable number of topics.
// Note: This field may return null, indicating that no valid values can be obtained.
TopicNumUpperLimit *int64 `json:"TopicNumUpperLimit,omitnil,omitempty" name:"TopicNumUpperLimit"`
// AZ list. See [ZoneInfo](https://www.tencentcloud.comom/document/api/1596/77932?from_cn_redirect=1#ZoneInfo) returned by the API [DescribeZones](https://www.tencentcloud.comom/document/product/1596/77929?from_cn_redirect=1) in Data Type.
ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`
// Number of proxy nodes.
// Note: This field may return null, indicating that no valid values can be obtained.
NodeCount *int64 `json:"NodeCount,omitnil,omitempty" name:"NodeCount"`
// Proxy scheduling details.
// Note: This field may return null, indicating that no valid values can be obtained.
ZoneScheduledList []*ZoneScheduledItem `json:"ZoneScheduledList,omitnil,omitempty" name:"ZoneScheduledList"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMessageListRequest ¶
type DescribeMessageListRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Start time for querying messages. **It is a Unix timestamp (ms).**
StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`
// End time for querying messages. **It is a Unix timestamp (ms).**
EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`
// Query identifier. For the first query, input a null string. If the query results involve pagination, use the TaskRequestId value in the previous request response as the value of this input parameter for requesting data on the next page.
TaskRequestId *string `json:"TaskRequestId,omitnil,omitempty" name:"TaskRequestId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Message ID. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from the workload logs.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Message key. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from workload logs.
MsgKey *string `json:"MsgKey,omitnil,omitempty" name:"MsgKey"`
// Query the last N messages. The value of N cannot exceed 1024. By default, -1 indicates other query conditions.
RecentMessageNum *int64 `json:"RecentMessageNum,omitnil,omitempty" name:"RecentMessageNum"`
// Whether to query dead letter messages. Default value: false.
QueryDeadLetterMessage *bool `json:"QueryDeadLetterMessage,omitnil,omitempty" name:"QueryDeadLetterMessage"`
// Message tag. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from workload logs.
Tag *string `json:"Tag,omitnil,omitempty" name:"Tag"`
}
func NewDescribeMessageListRequest ¶
func NewDescribeMessageListRequest() (request *DescribeMessageListRequest)
func (*DescribeMessageListRequest) FromJsonString ¶
func (r *DescribeMessageListRequest) 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 (*DescribeMessageListRequest) ToJsonString ¶
func (r *DescribeMessageListRequest) ToJsonString() string
type DescribeMessageListRequestParams ¶
type DescribeMessageListRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Start time for querying messages. **It is a Unix timestamp (ms).**
StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`
// End time for querying messages. **It is a Unix timestamp (ms).**
EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`
// Query identifier. For the first query, input a null string. If the query results involve pagination, use the TaskRequestId value in the previous request response as the value of this input parameter for requesting data on the next page.
TaskRequestId *string `json:"TaskRequestId,omitnil,omitempty" name:"TaskRequestId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Message ID. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from the workload logs.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Message key. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from workload logs.
MsgKey *string `json:"MsgKey,omitnil,omitempty" name:"MsgKey"`
// Query the last N messages. The value of N cannot exceed 1024. By default, -1 indicates other query conditions.
RecentMessageNum *int64 `json:"RecentMessageNum,omitnil,omitempty" name:"RecentMessageNum"`
// Whether to query dead letter messages. Default value: false.
QueryDeadLetterMessage *bool `json:"QueryDeadLetterMessage,omitnil,omitempty" name:"QueryDeadLetterMessage"`
// Message tag. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from workload logs.
Tag *string `json:"Tag,omitnil,omitempty" name:"Tag"`
}
Predefined struct for user
type DescribeMessageListResponse ¶
type DescribeMessageListResponse struct {
*tchttp.BaseResponse
Response *DescribeMessageListResponseParams `json:"Response"`
}
func NewDescribeMessageListResponse ¶
func NewDescribeMessageListResponse() (response *DescribeMessageListResponse)
func (*DescribeMessageListResponse) FromJsonString ¶
func (r *DescribeMessageListResponse) 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 (*DescribeMessageListResponse) ToJsonString ¶
func (r *DescribeMessageListResponse) ToJsonString() string
type DescribeMessageListResponseParams ¶
type DescribeMessageListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Message record list
//
// Note: This field may return null, indicating that no valid values can be obtained.
Data []*MessageItem `json:"Data,omitnil,omitempty" name:"Data"`
// One-time query ID
//
// Note: This field may return null, indicating that no valid values can be obtained.
TaskRequestId *string `json:"TaskRequestId,omitnil,omitempty" name:"TaskRequestId"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMessageRequest ¶
type DescribeMessageRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Message ID. It can be obtained from the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or workload logs.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Whether the message is dead letter message. Default value: false.
QueryDeadLetterMessage *bool `json:"QueryDeadLetterMessage,omitnil,omitempty" name:"QueryDeadLetterMessage"`
// Whether the message is delayed. Default value: false.
QueryDelayMessage *bool `json:"QueryDelayMessage,omitnil,omitempty" name:"QueryDelayMessage"`
}
func NewDescribeMessageRequest ¶
func NewDescribeMessageRequest() (request *DescribeMessageRequest)
func (*DescribeMessageRequest) FromJsonString ¶
func (r *DescribeMessageRequest) 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 (*DescribeMessageRequest) ToJsonString ¶
func (r *DescribeMessageRequest) ToJsonString() string
type DescribeMessageRequestParams ¶
type DescribeMessageRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Message ID. It can be obtained from the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or workload logs.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Whether the message is dead letter message. Default value: false.
QueryDeadLetterMessage *bool `json:"QueryDeadLetterMessage,omitnil,omitempty" name:"QueryDeadLetterMessage"`
// Whether the message is delayed. Default value: false.
QueryDelayMessage *bool `json:"QueryDelayMessage,omitnil,omitempty" name:"QueryDelayMessage"`
}
Predefined struct for user
type DescribeMessageResponse ¶
type DescribeMessageResponse struct {
*tchttp.BaseResponse
Response *DescribeMessageResponseParams `json:"Response"`
}
func NewDescribeMessageResponse ¶
func NewDescribeMessageResponse() (response *DescribeMessageResponse)
func (*DescribeMessageResponse) FromJsonString ¶
func (r *DescribeMessageResponse) 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 (*DescribeMessageResponse) ToJsonString ¶
func (r *DescribeMessageResponse) ToJsonString() string
type DescribeMessageResponseParams ¶
type DescribeMessageResponseParams struct {
// Message body.
Body *string `json:"Body,omitnil,omitempty" name:"Body"`
// Detailed parameters.
Properties *string `json:"Properties,omitnil,omitempty" name:"Properties"`
// Production time.
ProduceTime *string `json:"ProduceTime,omitnil,omitempty" name:"ProduceTime"`
// Message ID.
// Note: This field may return null, indicating that no valid values can be obtained.
MessageId *string `json:"MessageId,omitnil,omitempty" name:"MessageId"`
// Producer address.
ProducerAddr *string `json:"ProducerAddr,omitnil,omitempty" name:"ProducerAddr"`
// List of message consumption situations.
// Note: This field may return null, indicating that no valid values can be obtained.
MessageTracks []*MessageTrackItem `json:"MessageTracks,omitnil,omitempty" name:"MessageTracks"`
// Topic name
ShowTopicName *string `json:"ShowTopicName,omitnil,omitempty" name:"ShowTopicName"`
// Total number of items in the message consumption status list.
// Note: This field may return null, indicating that no valid values can be obtained.
MessageTracksCount *int64 `json:"MessageTracksCount,omitnil,omitempty" name:"MessageTracksCount"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMessageTraceRequest ¶
type DescribeMessageTraceRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Message ID. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from the workload logs.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Whether the message is dead letter message. Default value: false.
QueryDeadLetterMessage *bool `json:"QueryDeadLetterMessage,omitnil,omitempty" name:"QueryDeadLetterMessage"`
// Whether the message is delayed. Default value: false.
QueryDelayMessage *bool `json:"QueryDelayMessage,omitnil,omitempty" name:"QueryDelayMessage"`
}
func NewDescribeMessageTraceRequest ¶
func NewDescribeMessageTraceRequest() (request *DescribeMessageTraceRequest)
func (*DescribeMessageTraceRequest) FromJsonString ¶
func (r *DescribeMessageTraceRequest) 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 (*DescribeMessageTraceRequest) ToJsonString ¶
func (r *DescribeMessageTraceRequest) ToJsonString() string
type DescribeMessageTraceRequestParams ¶
type DescribeMessageTraceRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Message ID. It can be obtained from [MessageItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MessageItem) returned by the API [DescribeMessageList](https://www.tencentcloud.comom/document/api/1493/114593?from_cn_redirect=1) or from the workload logs.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Whether the message is dead letter message. Default value: false.
QueryDeadLetterMessage *bool `json:"QueryDeadLetterMessage,omitnil,omitempty" name:"QueryDeadLetterMessage"`
// Whether the message is delayed. Default value: false.
QueryDelayMessage *bool `json:"QueryDelayMessage,omitnil,omitempty" name:"QueryDelayMessage"`
}
Predefined struct for user
type DescribeMessageTraceResponse ¶
type DescribeMessageTraceResponse struct {
*tchttp.BaseResponse
Response *DescribeMessageTraceResponseParams `json:"Response"`
}
func NewDescribeMessageTraceResponse ¶
func NewDescribeMessageTraceResponse() (response *DescribeMessageTraceResponse)
func (*DescribeMessageTraceResponse) FromJsonString ¶
func (r *DescribeMessageTraceResponse) 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 (*DescribeMessageTraceResponse) ToJsonString ¶
func (r *DescribeMessageTraceResponse) ToJsonString() string
type DescribeMessageTraceResponseParams ¶
type DescribeMessageTraceResponseParams struct {
// Topic name
ShowTopicName *string `json:"ShowTopicName,omitnil,omitempty" name:"ShowTopicName"`
// Track details
//
// Note: This field may return null, indicating that no valid values can be obtained.
Data []*MessageTraceItem `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMigratingGroupStatsRequest ¶
type DescribeMigratingGroupStatsRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Specifies the consumer group name. it can be obtained from [SourceClusterGroupConfig](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) returned by the api [DescribeSourceClusterGroupList](https://www.tencentcloud.comom/document/api/1493/118006?from_cn_redirect=1) or in the console.
GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
// Namespace. it is valid only when migrated to 4.x clusters. the namespace can be obtained from [SourceClusterGroupConfig](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) returned by the api [DescribeSourceClusterGroupList](https://www.tencentcloud.comom/document/api/1493/118006?from_cn_redirect=1) or from the console.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
func NewDescribeMigratingGroupStatsRequest ¶
func NewDescribeMigratingGroupStatsRequest() (request *DescribeMigratingGroupStatsRequest)
func (*DescribeMigratingGroupStatsRequest) FromJsonString ¶
func (r *DescribeMigratingGroupStatsRequest) 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 (*DescribeMigratingGroupStatsRequest) ToJsonString ¶
func (r *DescribeMigratingGroupStatsRequest) ToJsonString() string
type DescribeMigratingGroupStatsRequestParams ¶
type DescribeMigratingGroupStatsRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Specifies the consumer group name. it can be obtained from [SourceClusterGroupConfig](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) returned by the api [DescribeSourceClusterGroupList](https://www.tencentcloud.comom/document/api/1493/118006?from_cn_redirect=1) or in the console.
GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
// Namespace. it is valid only when migrated to 4.x clusters. the namespace can be obtained from [SourceClusterGroupConfig](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) returned by the api [DescribeSourceClusterGroupList](https://www.tencentcloud.comom/document/api/1493/118006?from_cn_redirect=1) or from the console.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
Predefined struct for user
type DescribeMigratingGroupStatsResponse ¶
type DescribeMigratingGroupStatsResponse struct {
*tchttp.BaseResponse
Response *DescribeMigratingGroupStatsResponseParams `json:"Response"`
}
func NewDescribeMigratingGroupStatsResponse ¶
func NewDescribeMigratingGroupStatsResponse() (response *DescribeMigratingGroupStatsResponse)
func (*DescribeMigratingGroupStatsResponse) FromJsonString ¶
func (r *DescribeMigratingGroupStatsResponse) 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 (*DescribeMigratingGroupStatsResponse) ToJsonString ¶
func (r *DescribeMigratingGroupStatsResponse) ToJsonString() string
type DescribeMigratingGroupStatsResponseParams ¶
type DescribeMigratingGroupStatsResponseParams struct {
// Source cluster consumer group accumulation.
SourceConsumeLag *int64 `json:"SourceConsumeLag,omitnil,omitempty" name:"SourceConsumeLag"`
// Target cluster consumer group accumulation.
TargetConsumeLag *int64 `json:"TargetConsumeLag,omitnil,omitempty" name:"TargetConsumeLag"`
// Source cluster connection client list.
SourceConsumerClients []*ConsumerClient `json:"SourceConsumerClients,omitnil,omitempty" name:"SourceConsumerClients"`
// Target cluster connection client list.
TargetConsumerClients []*ConsumerClient `json:"TargetConsumerClients,omitnil,omitempty" name:"TargetConsumerClients"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMigratingTopicListRequest ¶
type DescribeMigratingTopicListRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
func NewDescribeMigratingTopicListRequest ¶
func NewDescribeMigratingTopicListRequest() (request *DescribeMigratingTopicListRequest)
func (*DescribeMigratingTopicListRequest) FromJsonString ¶
func (r *DescribeMigratingTopicListRequest) 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 (*DescribeMigratingTopicListRequest) ToJsonString ¶
func (r *DescribeMigratingTopicListRequest) ToJsonString() string
type DescribeMigratingTopicListRequestParams ¶
type DescribeMigratingTopicListRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
Predefined struct for user
type DescribeMigratingTopicListResponse ¶
type DescribeMigratingTopicListResponse struct {
*tchttp.BaseResponse
Response *DescribeMigratingTopicListResponseParams `json:"Response"`
}
func NewDescribeMigratingTopicListResponse ¶
func NewDescribeMigratingTopicListResponse() (response *DescribeMigratingTopicListResponse)
func (*DescribeMigratingTopicListResponse) FromJsonString ¶
func (r *DescribeMigratingTopicListResponse) 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 (*DescribeMigratingTopicListResponse) ToJsonString ¶
func (r *DescribeMigratingTopicListResponse) ToJsonString() string
type DescribeMigratingTopicListResponseParams ¶
type DescribeMigratingTopicListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Topic list.
MigrateTopics []*MigratingTopic `json:"MigrateTopics,omitnil,omitempty" name:"MigrateTopics"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMigratingTopicStatsRequest ¶
type DescribeMigratingTopicStatsRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
func NewDescribeMigratingTopicStatsRequest ¶
func NewDescribeMigratingTopicStatsRequest() (request *DescribeMigratingTopicStatsRequest)
func (*DescribeMigratingTopicStatsRequest) FromJsonString ¶
func (r *DescribeMigratingTopicStatsRequest) 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 (*DescribeMigratingTopicStatsRequest) ToJsonString ¶
func (r *DescribeMigratingTopicStatsRequest) ToJsonString() string
type DescribeMigratingTopicStatsRequestParams ¶
type DescribeMigratingTopicStatsRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
Predefined struct for user
type DescribeMigratingTopicStatsResponse ¶
type DescribeMigratingTopicStatsResponse struct {
*tchttp.BaseResponse
Response *DescribeMigratingTopicStatsResponseParams `json:"Response"`
}
func NewDescribeMigratingTopicStatsResponse ¶
func NewDescribeMigratingTopicStatsResponse() (response *DescribeMigratingTopicStatsResponse)
func (*DescribeMigratingTopicStatsResponse) FromJsonString ¶
func (r *DescribeMigratingTopicStatsResponse) 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 (*DescribeMigratingTopicStatsResponse) ToJsonString ¶
func (r *DescribeMigratingTopicStatsResponse) ToJsonString() string
type DescribeMigratingTopicStatsResponseParams ¶
type DescribeMigratingTopicStatsResponseParams struct {
// Number of consumers in the source cluster.
SourceClusterConsumerCount *int64 `json:"SourceClusterConsumerCount,omitnil,omitempty" name:"SourceClusterConsumerCount"`
// Number of consumers in the target cluster.
TargetClusterConsumerCount *int64 `json:"TargetClusterConsumerCount,omitnil,omitempty" name:"TargetClusterConsumerCount"`
// Source cluster consumer group list.
SourceClusterConsumerGroups []*string `json:"SourceClusterConsumerGroups,omitnil,omitempty" name:"SourceClusterConsumerGroups"`
// Target cluster consumer group list.
TargetClusterConsumerGroups []*string `json:"TargetClusterConsumerGroups,omitnil,omitempty" name:"TargetClusterConsumerGroups"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeMigrationTaskListRequest ¶
type DescribeMigrationTaskListRequest struct {
*tchttp.BaseRequest
// Query criteria list
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Query start position
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Query result limit count
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
func NewDescribeMigrationTaskListRequest ¶
func NewDescribeMigrationTaskListRequest() (request *DescribeMigrationTaskListRequest)
func (*DescribeMigrationTaskListRequest) FromJsonString ¶
func (r *DescribeMigrationTaskListRequest) 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 (*DescribeMigrationTaskListRequest) ToJsonString ¶
func (r *DescribeMigrationTaskListRequest) ToJsonString() string
type DescribeMigrationTaskListRequestParams ¶
type DescribeMigrationTaskListRequestParams struct {
// Query criteria list
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Query start position
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Query result limit count
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
Predefined struct for user
type DescribeMigrationTaskListResponse ¶
type DescribeMigrationTaskListResponse struct {
*tchttp.BaseResponse
Response *DescribeMigrationTaskListResponseParams `json:"Response"`
}
func NewDescribeMigrationTaskListResponse ¶
func NewDescribeMigrationTaskListResponse() (response *DescribeMigrationTaskListResponse)
func (*DescribeMigrationTaskListResponse) FromJsonString ¶
func (r *DescribeMigrationTaskListResponse) 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 (*DescribeMigrationTaskListResponse) ToJsonString ¶
func (r *DescribeMigrationTaskListResponse) ToJsonString() string
type DescribeMigrationTaskListResponseParams ¶
type DescribeMigrationTaskListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Migration Task List
// Note: This field may return null, indicating that no valid values can be obtained.
Tasks []*MigrationTaskItem `json:"Tasks,omitnil,omitempty" name:"Tasks"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeProducerListRequest ¶
type DescribeProducerListRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}
func NewDescribeProducerListRequest ¶
func NewDescribeProducerListRequest() (request *DescribeProducerListRequest)
func (*DescribeProducerListRequest) FromJsonString ¶
func (r *DescribeProducerListRequest) 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 (*DescribeProducerListRequest) ToJsonString ¶
func (r *DescribeProducerListRequest) ToJsonString() string
type DescribeProducerListRequestParams ¶
type DescribeProducerListRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}
Predefined struct for user
type DescribeProducerListResponse ¶
type DescribeProducerListResponse struct {
*tchttp.BaseResponse
Response *DescribeProducerListResponseParams `json:"Response"`
}
func NewDescribeProducerListResponse ¶
func NewDescribeProducerListResponse() (response *DescribeProducerListResponse)
func (*DescribeProducerListResponse) FromJsonString ¶
func (r *DescribeProducerListResponse) 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 (*DescribeProducerListResponse) ToJsonString ¶
func (r *DescribeProducerListResponse) ToJsonString() string
type DescribeProducerListResponseParams ¶
type DescribeProducerListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Producer information list.
ProducerList []*ProducerInfo `json:"ProducerList,omitnil,omitempty" name:"ProducerList"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeProductSKUsRequest ¶
type DescribeProductSKUsRequest struct {
*tchttp.BaseRequest
}
func NewDescribeProductSKUsRequest ¶
func NewDescribeProductSKUsRequest() (request *DescribeProductSKUsRequest)
func (*DescribeProductSKUsRequest) FromJsonString ¶
func (r *DescribeProductSKUsRequest) 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 (*DescribeProductSKUsRequest) ToJsonString ¶
func (r *DescribeProductSKUsRequest) ToJsonString() string
type DescribeProductSKUsRequestParams ¶
type DescribeProductSKUsRequestParams struct {
}
Predefined struct for user
type DescribeProductSKUsResponse ¶
type DescribeProductSKUsResponse struct {
*tchttp.BaseResponse
Response *DescribeProductSKUsResponseParams `json:"Response"`
}
func NewDescribeProductSKUsResponse ¶
func NewDescribeProductSKUsResponse() (response *DescribeProductSKUsResponse)
func (*DescribeProductSKUsResponse) FromJsonString ¶
func (r *DescribeProductSKUsResponse) 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 (*DescribeProductSKUsResponse) ToJsonString ¶
func (r *DescribeProductSKUsResponse) ToJsonString() string
type DescribeProductSKUsResponseParams ¶
type DescribeProductSKUsResponseParams struct {
// Product configuration information
//
// Note: This field may return null, indicating that no valid values can be obtained.
Data []*ProductSKU `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeRoleListRequest ¶
type DescribeRoleListRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
func NewDescribeRoleListRequest ¶
func NewDescribeRoleListRequest() (request *DescribeRoleListRequest)
func (*DescribeRoleListRequest) FromJsonString ¶
func (r *DescribeRoleListRequest) 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 (*DescribeRoleListRequest) ToJsonString ¶
func (r *DescribeRoleListRequest) ToJsonString() string
type DescribeRoleListRequestParams ¶
type DescribeRoleListRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
Predefined struct for user
type DescribeRoleListResponse ¶
type DescribeRoleListResponse struct {
*tchttp.BaseResponse
Response *DescribeRoleListResponseParams `json:"Response"`
}
func NewDescribeRoleListResponse ¶
func NewDescribeRoleListResponse() (response *DescribeRoleListResponse)
func (*DescribeRoleListResponse) FromJsonString ¶
func (r *DescribeRoleListResponse) 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 (*DescribeRoleListResponse) ToJsonString ¶
func (r *DescribeRoleListResponse) ToJsonString() string
type DescribeRoleListResponseParams ¶
type DescribeRoleListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Role information list
Data []*RoleItem `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeSmoothMigrationTaskListRequest ¶
type DescribeSmoothMigrationTaskListRequest struct {
*tchttp.BaseRequest
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
func NewDescribeSmoothMigrationTaskListRequest ¶
func NewDescribeSmoothMigrationTaskListRequest() (request *DescribeSmoothMigrationTaskListRequest)
func (*DescribeSmoothMigrationTaskListRequest) FromJsonString ¶
func (r *DescribeSmoothMigrationTaskListRequest) 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 (*DescribeSmoothMigrationTaskListRequest) ToJsonString ¶
func (r *DescribeSmoothMigrationTaskListRequest) ToJsonString() string
type DescribeSmoothMigrationTaskListRequestParams ¶
type DescribeSmoothMigrationTaskListRequestParams struct {
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
Predefined struct for user
type DescribeSmoothMigrationTaskListResponse ¶
type DescribeSmoothMigrationTaskListResponse struct {
*tchttp.BaseResponse
Response *DescribeSmoothMigrationTaskListResponseParams `json:"Response"`
}
func NewDescribeSmoothMigrationTaskListResponse ¶
func NewDescribeSmoothMigrationTaskListResponse() (response *DescribeSmoothMigrationTaskListResponse)
func (*DescribeSmoothMigrationTaskListResponse) FromJsonString ¶
func (r *DescribeSmoothMigrationTaskListResponse) 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 (*DescribeSmoothMigrationTaskListResponse) ToJsonString ¶
func (r *DescribeSmoothMigrationTaskListResponse) ToJsonString() string
type DescribeSmoothMigrationTaskListResponseParams ¶
type DescribeSmoothMigrationTaskListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Task list.
// Note: This field may return null, indicating that no valid values can be obtained.
Data []*SmoothMigrationTaskItem `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeSourceClusterGroupListRequest ¶
type DescribeSourceClusterGroupListRequest struct {
*tchttp.BaseRequest
// Specifies the task ID. it can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the api [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
func NewDescribeSourceClusterGroupListRequest ¶
func NewDescribeSourceClusterGroupListRequest() (request *DescribeSourceClusterGroupListRequest)
func (*DescribeSourceClusterGroupListRequest) FromJsonString ¶
func (r *DescribeSourceClusterGroupListRequest) 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 (*DescribeSourceClusterGroupListRequest) ToJsonString ¶
func (r *DescribeSourceClusterGroupListRequest) ToJsonString() string
type DescribeSourceClusterGroupListRequestParams ¶
type DescribeSourceClusterGroupListRequestParams struct {
// Specifies the task ID. it can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the api [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
Predefined struct for user
type DescribeSourceClusterGroupListResponse ¶
type DescribeSourceClusterGroupListResponse struct {
*tchttp.BaseResponse
Response *DescribeSourceClusterGroupListResponseParams `json:"Response"`
}
func NewDescribeSourceClusterGroupListResponse ¶
func NewDescribeSourceClusterGroupListResponse() (response *DescribeSourceClusterGroupListResponse)
func (*DescribeSourceClusterGroupListResponse) FromJsonString ¶
func (r *DescribeSourceClusterGroupListResponse) 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 (*DescribeSourceClusterGroupListResponse) ToJsonString ¶
func (r *DescribeSourceClusterGroupListResponse) ToJsonString() string
type DescribeSourceClusterGroupListResponseParams ¶
type DescribeSourceClusterGroupListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// List of consumption group configurations.
Groups []*SourceClusterGroupConfig `json:"Groups,omitnil,omitempty" name:"Groups"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeTopicListByGroupRequest ¶
type DescribeTopicListByGroupRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
func NewDescribeTopicListByGroupRequest ¶
func NewDescribeTopicListByGroupRequest() (request *DescribeTopicListByGroupRequest)
func (*DescribeTopicListByGroupRequest) FromJsonString ¶
func (r *DescribeTopicListByGroupRequest) 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 (*DescribeTopicListByGroupRequest) ToJsonString ¶
func (r *DescribeTopicListByGroupRequest) ToJsonString() string
type DescribeTopicListByGroupRequestParams ¶
type DescribeTopicListByGroupRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
}
Predefined struct for user
type DescribeTopicListByGroupResponse ¶
type DescribeTopicListByGroupResponse struct {
*tchttp.BaseResponse
Response *DescribeTopicListByGroupResponseParams `json:"Response"`
}
func NewDescribeTopicListByGroupResponse ¶
func NewDescribeTopicListByGroupResponse() (response *DescribeTopicListByGroupResponse)
func (*DescribeTopicListByGroupResponse) FromJsonString ¶
func (r *DescribeTopicListByGroupResponse) 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 (*DescribeTopicListByGroupResponse) ToJsonString ¶
func (r *DescribeTopicListByGroupResponse) ToJsonString() string
type DescribeTopicListByGroupResponseParams ¶
type DescribeTopicListByGroupResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Topic list.
Data []*SubscriptionData `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DescribeTopicListRequest ¶
type DescribeTopicListRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Tag filter
TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Queries subscribed topics by consumer group.
FromGroup *string `json:"FromGroup,omitnil,omitempty" name:"FromGroup"`
}
func NewDescribeTopicListRequest ¶
func NewDescribeTopicListRequest() (request *DescribeTopicListRequest)
func (*DescribeTopicListRequest) FromJsonString ¶
func (r *DescribeTopicListRequest) 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 (*DescribeTopicListRequest) ToJsonString ¶
func (r *DescribeTopicListRequest) ToJsonString() string
type DescribeTopicListRequestParams ¶
type DescribeTopicListRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Tag filter
TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Queries subscribed topics by consumer group.
FromGroup *string `json:"FromGroup,omitnil,omitempty" name:"FromGroup"`
}
Predefined struct for user
type DescribeTopicListResponse ¶
type DescribeTopicListResponse struct {
*tchttp.BaseResponse
Response *DescribeTopicListResponseParams `json:"Response"`
}
func NewDescribeTopicListResponse ¶
func NewDescribeTopicListResponse() (response *DescribeTopicListResponse)
func (*DescribeTopicListResponse) FromJsonString ¶
func (r *DescribeTopicListResponse) 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 (*DescribeTopicListResponse) ToJsonString ¶
func (r *DescribeTopicListResponse) ToJsonString() string
type DescribeTopicListResponseParams ¶
type DescribeTopicListResponseParams struct {
// Total query count
TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`
// Topic list.
Data []*TopicItem `json:"Data,omitnil,omitempty" name:"Data"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
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 {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Filtering condition list. See the description of the API using this parameter for the usage method.
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Starting position of the query. Default value: 0.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Maximum number of queried results. Default value: 20.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}
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 {
// Instance ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Topic type.
// UNSPECIFIED: not specified.
// NORMAL: normal message.
// FIFO: sequential message.
// DELAY: delayed message.
// TRANSACTION: transaction message.
TopicType *string `json:"TopicType,omitnil,omitempty" name:"TopicType"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Creation time. **It is a Unix timestamp (ms).**
CreatedTime *int64 `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`
// Last write time. **It is a Unix timestamp (ms).**
LastUpdateTime *int64 `json:"LastUpdateTime,omitnil,omitempty" name:"LastUpdateTime"`
// Number of Subscriptions
SubscriptionCount *int64 `json:"SubscriptionCount,omitnil,omitempty" name:"SubscriptionCount"`
// Subscribe to the relationship list.
SubscriptionData []*SubscriptionData `json:"SubscriptionData,omitnil,omitempty" name:"SubscriptionData"`
// Message retention period. Unit: hour.
MsgTTL *int64 `json:"MsgTTL,omitnil,omitempty" name:"MsgTTL"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type DetailedRolePerm ¶
type DetailedRolePerm struct {
// Resources corresponding to permissions.
// Specifies the topic name, which can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the api [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
// Specifies the consumer group name, which can be obtained from the api response of DescribeConsumerGroupList (https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or the console.
Resource *string `json:"Resource,omitnil,omitempty" name:"Resource"`
// Whether to enable production permission
PermWrite *bool `json:"PermWrite,omitnil,omitempty" name:"PermWrite"`
// Whether to enable consumption permission
PermRead *bool `json:"PermRead,omitnil,omitempty" name:"PermRead"`
// Authorize resource type (Topic: theme; Group: consumption Group).
ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Resource remark.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}
type DoHealthCheckOnMigratingTopicRequest ¶
type DoHealthCheckOnMigratingTopicRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Whether to ignore the current check.
IgnoreCheck *bool `json:"IgnoreCheck,omitnil,omitempty" name:"IgnoreCheck"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
func NewDoHealthCheckOnMigratingTopicRequest ¶
func NewDoHealthCheckOnMigratingTopicRequest() (request *DoHealthCheckOnMigratingTopicRequest)
func (*DoHealthCheckOnMigratingTopicRequest) FromJsonString ¶
func (r *DoHealthCheckOnMigratingTopicRequest) 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 (*DoHealthCheckOnMigratingTopicRequest) ToJsonString ¶
func (r *DoHealthCheckOnMigratingTopicRequest) ToJsonString() string
type DoHealthCheckOnMigratingTopicRequestParams ¶
type DoHealthCheckOnMigratingTopicRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Whether to ignore the current check.
IgnoreCheck *bool `json:"IgnoreCheck,omitnil,omitempty" name:"IgnoreCheck"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
Predefined struct for user
type DoHealthCheckOnMigratingTopicResponse ¶
type DoHealthCheckOnMigratingTopicResponse struct {
*tchttp.BaseResponse
Response *DoHealthCheckOnMigratingTopicResponseParams `json:"Response"`
}
func NewDoHealthCheckOnMigratingTopicResponse ¶
func NewDoHealthCheckOnMigratingTopicResponse() (response *DoHealthCheckOnMigratingTopicResponse)
func (*DoHealthCheckOnMigratingTopicResponse) FromJsonString ¶
func (r *DoHealthCheckOnMigratingTopicResponse) 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 (*DoHealthCheckOnMigratingTopicResponse) ToJsonString ¶
func (r *DoHealthCheckOnMigratingTopicResponse) ToJsonString() string
type DoHealthCheckOnMigratingTopicResponseParams ¶
type DoHealthCheckOnMigratingTopicResponseParams struct {
// Whether to Pass
Passed *bool `json:"Passed,omitnil,omitempty" name:"Passed"`
// Error information returned by health check.
// NotChecked indicates the check is not executed.
// Unknown error.
// TopicNotImported. specifies the topic is not imported.
// TopicNotExistsInSourceCluster specifies the topic does not exist in the source cluster.
// Topic does not exist in the target cluster.
// ConsumerConnectedOnTarget specifies whether consumer connections exist on the target cluster.
// SourceTopicHasNewMessagesIn5Minutes indicates that new messages were written to the source cluster topic in the last 5 minutes.
// TargetTopicHasNewMessagesIn5Minutes specifies whether new messages were written to the target cluster topic in the last 5 minutes.
// SourceTopicHasNoMessagesIn5Minutes specifies no new messages were written to the source cluster in the last 5 minutes.
// TargetTopicHasNoMessagesIn5Minutes specifies that no new messages were written to the source cluster in the last 5 minutes.
// Inconsistent number of subscription groups.
// SourceTopicHasUnconsumedMessages specifies that unconsumed messages exist in the source cluster topic.
// Note: This field may return null, indicating that no valid values can be obtained.
Reason *string `json:"Reason,omitnil,omitempty" name:"Reason"`
// List of error information returned by health check.
// Note: This field may return null, indicating that no valid values can be obtained.
ReasonList []*string `json:"ReasonList,omitnil,omitempty" name:"ReasonList"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type Endpoint ¶
type Endpoint struct {
// Access point type, with the enumerated values as follows:.
//
// - VPC: specifies the VPC network.
//
// -PUBLIC: public network.
//
// -INTERNAL: specifies the support network.
Type *string `json:"Type,omitnil,omitempty" name:"Type"`
// Status.
// OPEN: indicates to start or activate a function.
// CLOSE: indicates the closed state.
// PROCESSING: operation in progress.
Status *string `json:"Status,omitnil,omitempty" name:"Status"`
// Payment type, only public network.
// PREPAID: annual/monthly package.
// Pay-As-You-Go.
// Note: This field may return null, indicating that no valid values can be obtained.
PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`
// Access point address.
// Note: This field may return null, indicating that no valid values can be obtained.
EndpointUrl *string `json:"EndpointUrl,omitnil,omitempty" name:"EndpointUrl"`
// VPC ID
// Note: This field may return null, indicating that no valid values can be obtained.
VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`
// Specifies the subnet ID.
// Note: This field may return null, indicating that no valid values can be obtained.
SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`
// Public network bandwidth, in Mbps
//
// Note: This field may return null, indicating that no valid values can be obtained.
Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`
// Public network access rules
//
// Note: This field may return null, indicating that no valid values can be obtained.
IpRules []*IpRule `json:"IpRules,omitnil,omitempty" name:"IpRules"`
// Whether the public network is billed by traffic.
// Note: This field may return null, indicating that no valid values can be obtained.
BillingFlow *bool `json:"BillingFlow,omitnil,omitempty" name:"BillingFlow"`
}
type FusionInstanceItem ¶
type FusionInstanceItem struct {
// Instance ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Instance name
InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
// Instance version.
Version *string `json:"Version,omitnil,omitempty" name:"Version"`
// Instance type.
// Trial version.
// BASIC version.
// PRO, professional edition.
// PLATINUM edition.
InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`
// Instance status.
// RUNNING. specifies the running status.
// MAINTAINING.
// ABNORMAL.
// OVERDUE. specifies the state of arrears.
// `DESTROYED`: `deleted`.
// CREATING.
// MODIFYING.
// CREATE_FAILURE. specifies that the creation failed.
// MODIFY_FAILURE. indicates a configuration adjustment failure.
// Valid values: DELETING. indicates that the resource is being deleted.
InstanceStatus *string `json:"InstanceStatus,omitnil,omitempty" name:"InstanceStatus"`
// Maximum number of instance topics
TopicNumLimit *int64 `json:"TopicNumLimit,omitnil,omitempty" name:"TopicNumLimit"`
// Maximum number of instance consumer groups
GroupNumLimit *int64 `json:"GroupNumLimit,omitnil,omitempty" name:"GroupNumLimit"`
// Billing mode. valid enumeration values are as follows:.
//
// -POSTPAID: pay-as-you-go.
//
// - PREPAID: monthly subscription.
PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`
// Expiration time. **It is a Unix timestamp (ms).**
// Note: This field may return null, indicating that no valid values can be obtained.
ExpiryTime *int64 `json:"ExpiryTime,omitnil,omitempty" name:"ExpiryTime"`
// Remarks
//
// Note: This field may return null, indicating that no valid values can be obtained.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Number of topics
TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`
// Number of consumer groups
GroupNum *int64 `json:"GroupNum,omitnil,omitempty" name:"GroupNum"`
// Tag list
//
// Note: This field may return null, indicating that no valid values can be obtained.
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
// Specifies the product specification.
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// TPS throttle value
//
// Note: This field may return null, indicating that no valid values can be obtained.
TpsLimit *int64 `json:"TpsLimit,omitnil,omitempty" name:"TpsLimit"`
// Elastic TPS throttle value
ScaledTpsLimit *int64 `json:"ScaledTpsLimit,omitnil,omitempty" name:"ScaledTpsLimit"`
// Message retention time, in hours
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Maximum delayed message duration, in hours
MaxMessageDelay *int64 `json:"MaxMessageDelay,omitnil,omitempty" name:"MaxMessageDelay"`
// Specifies whether the prepaid cluster is automatically renewed. valid values are as follows:.
//
// - 0: no automatic renewal.
// - 1: specifies automatic renewal.
RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
// Data unique to version 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
InstanceItemExtraInfo *InstanceItemExtraInfo `json:"InstanceItemExtraInfo,omitnil,omitempty" name:"InstanceItemExtraInfo"`
// Expected termination time. **It is a Unix timestamp (ms).**
// Note: This field may return null, indicating that no valid values can be obtained.
DestroyTime *int64 `json:"DestroyTime,omitnil,omitempty" name:"DestroyTime"`
// AZ list. See [ZoneInfo](https://www.tencentcloud.comom/document/api/1596/77932?from_cn_redirect=1#ZoneInfo) returned by the API [DescribeZones](https://www.tencentcloud.comom/document/product/1596/77929?from_cn_redirect=1) in Data Type.
// Note: This field may return null, indicating that no valid values can be obtained.
ZoneIds []*int64 `json:"ZoneIds,omitnil,omitempty" name:"ZoneIds"`
// Whether to enable deletion protection
EnableDeletionProtection *bool `json:"EnableDeletionProtection,omitnil,omitempty" name:"EnableDeletionProtection"`
// Instance creation time
// Note: This field may return null, indicating that no valid values can be obtained.
CreateTime *int64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`
// Elastic TPS switch.
// Note: This field may return null, indicating that no valid values can be obtained.
ScaledTpsEnabled *bool `json:"ScaledTpsEnabled,omitnil,omitempty" name:"ScaledTpsEnabled"`
}
type InstanceItem ¶
type InstanceItem struct {
// Instance ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Instance name
InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`
// Instance version.
Version *string `json:"Version,omitnil,omitempty" name:"Version"`
// Instance type.
// Trial version.
// BASIC version.
// PRO, professional edition.
// PLATINUM edition.
InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`
// Instance status.
// RUNNING. specifies the running status.
// MAINTAINING.
// ABNORMAL.
// OVERDUE. specifies the state of arrears.
// `DESTROYED`: deleted.
// CREATING.
// MODIFYING.
// CREATE_FAILURE. specifies that the creation failed.
// MODIFY_FAILURE. indicates a configuration adjustment failure.
// DELETING.
InstanceStatus *string `json:"InstanceStatus,omitnil,omitempty" name:"InstanceStatus"`
// Maximum number of instance topics
TopicNumLimit *int64 `json:"TopicNumLimit,omitnil,omitempty" name:"TopicNumLimit"`
// Maximum number of instance consumer groups
GroupNumLimit *int64 `json:"GroupNumLimit,omitnil,omitempty" name:"GroupNumLimit"`
// Billing mode. valid enumeration values are as follows:.
//
// -POSTPAID: pay-as-you-go.
//
// - PREPAID: monthly subscription.
PayMode *string `json:"PayMode,omitnil,omitempty" name:"PayMode"`
// Expiration timestamp. **It is a Unix timestamp (ms).**
// Note: This field may return null, indicating that no valid values can be obtained.
ExpiryTime *int64 `json:"ExpiryTime,omitnil,omitempty" name:"ExpiryTime"`
// Remarks
//
// Note: This field may return null, indicating that no valid values can be obtained.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Number of topics
TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`
// Number of consumer groups
GroupNum *int64 `json:"GroupNum,omitnil,omitempty" name:"GroupNum"`
// Tag list
//
// Note: This field may return null, indicating that no valid values can be obtained.
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
// Specifies the product specification.
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// TPS throttle value
TpsLimit *int64 `json:"TpsLimit,omitnil,omitempty" name:"TpsLimit"`
// Elastic TPS throttle value
ScaledTpsLimit *int64 `json:"ScaledTpsLimit,omitnil,omitempty" name:"ScaledTpsLimit"`
// Message retention time, in hours
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Maximum delayed message duration, in hours
MaxMessageDelay *int64 `json:"MaxMessageDelay,omitnil,omitempty" name:"MaxMessageDelay"`
// Whether automatic renewal is enabled. This parameter is valid only for prepaid clusters. 0: automatic renewal disabled; 1: automatic renewal enabled.
RenewFlag *int64 `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
}
type InstanceItemExtraInfo ¶
type InstanceItemExtraInfo struct {
// Whether it is a vip.
// Note: This field may return null, indicating that no valid values can be obtained.
IsVip *bool `json:"IsVip,omitnil,omitempty" name:"IsVip"`
// Specifies the dedicated cluster status of version 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
VipInstanceStatus *int64 `json:"VipInstanceStatus,omitnil,omitempty" name:"VipInstanceStatus"`
// Specifies the peak bandwidth of the dedicated cluster.
// Note: This field may return null, indicating that no valid values can be obtained.
MaxBandWidth *int64 `json:"MaxBandWidth,omitnil,omitempty" name:"MaxBandWidth"`
// Exclusive cluster specification.
// Note: This field may return null, indicating that no valid values can be obtained.
SpecName *string `json:"SpecName,omitnil,omitempty" name:"SpecName"`
// Specifies the quantity of exclusive cluster nodes.
// Note: This field may return null, indicating that no valid values can be obtained.
NodeCount *int64 `json:"NodeCount,omitnil,omitempty" name:"NodeCount"`
// Specifies the maximum storage of the dedicated cluster.
// Note: This field may return null, indicating that no valid values can be obtained.
MaxStorage *int64 `json:"MaxStorage,omitnil,omitempty" name:"MaxStorage"`
// Specifies the maximum retention time of the dedicated cluster. the unit is hour.
// Note: This field may return null, indicating that no valid values can be obtained.
MaxRetention *int64 `json:"MaxRetention,omitnil,omitempty" name:"MaxRetention"`
// Special project cluster maximum retention time, unit: hr.
// Note: This field may return null, indicating that no valid values can be obtained.
MinRetention *int64 `json:"MinRetention,omitnil,omitempty" name:"MinRetention"`
// Status of 4.0 shared cluster.
// Note: This field may return null, indicating that no valid values can be obtained.
InstanceStatus *int64 `json:"InstanceStatus,omitnil,omitempty" name:"InstanceStatus"`
// Whether it is frozen.
IsFrozen *bool `json:"IsFrozen,omitnil,omitempty" name:"IsFrozen"`
}
type IpRule ¶
type IpRule struct {
// Specifies the IP address.
Ip *string `json:"Ip,omitnil,omitempty" name:"Ip"`
// Whether the IP address is allowed. Default value: false, indicating that the IP address is denied.
Allow *bool `json:"Allow,omitnil,omitempty" name:"Allow"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}
type MessageItem ¶
type MessageItem struct {
// Message ID.
// Note: This field may return null, indicating that no valid values can be obtained.
MsgId *string `json:"MsgId,omitnil,omitempty" name:"MsgId"`
// Message tag
//
// Note: This field may return null, indicating that no valid values can be obtained.
Tags *string `json:"Tags,omitnil,omitempty" name:"Tags"`
// Message key.
// Note: This field may return null, indicating that no valid values can be obtained.
Keys *string `json:"Keys,omitnil,omitempty" name:"Keys"`
// Client address.
// Note: This field may return null, indicating that no valid values can be obtained.
ProducerAddr *string `json:"ProducerAddr,omitnil,omitempty" name:"ProducerAddr"`
// Message Sending Time
//
// Note: This field may return null, indicating that no valid values can be obtained.
ProduceTime *string `json:"ProduceTime,omitnil,omitempty" name:"ProduceTime"`
// Dead-letter resend count
//
// Note: This field may return null, indicating that no valid values can be obtained.
DeadLetterResendTimes *int64 `json:"DeadLetterResendTimes,omitnil,omitempty" name:"DeadLetterResendTimes"`
// Dead Letter Resend Success Count
//
// Note: This field may return null, indicating that no valid values can be obtained.
DeadLetterResendSuccessTimes *int64 `json:"DeadLetterResendSuccessTimes,omitnil,omitempty" name:"DeadLetterResendSuccessTimes"`
}
type MessageTraceItem ¶
type MessageTraceItem struct {
// Message handling phase. valid values are as follows:.
//
// -Produces messages.
//
// -Persists message storage.
//
// -Consumes messages.
// Note: This field may return null, indicating that no valid values can be obtained.
Stage *string `json:"Stage,omitnil,omitempty" name:"Stage"`
// Track details
//
// Note: This field may return null, indicating that no valid values can be obtained.
Data *string `json:"Data,omitnil,omitempty" name:"Data"`
}
type MessageTrackItem ¶
type MessageTrackItem struct {
// Specifies the consumer group name.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Consumption status. CONSUMED: Consumed CONSUMED_BUT_FILTERED: Filtered NOT_CONSUME: Not consumed ENTER_RETRY: Enter retry queue. ENTER_DLQ: Enter dead letter queue. UNKNOWN: Consumption status unknown
ConsumeStatus *string `json:"ConsumeStatus,omitnil,omitempty" name:"ConsumeStatus"`
// Track type
TrackType *string `json:"TrackType,omitnil,omitempty" name:"TrackType"`
// Exception information.
// Note: This field may return null, indicating that no valid values can be obtained.
ExceptionDesc *string `json:"ExceptionDesc,omitnil,omitempty" name:"ExceptionDesc"`
}
type MigratingTopic ¶
type MigratingTopic struct {
// Topic name
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Migration status.
// S_RW_D_NA source cluster read/write.
// S_RW_D_R specifies read and write permissions for the source cluster and read permissions for the target cluster.
// S_RW_D_RW specifies read-write for the source cluster and read-write for the target cluster.
// SRDRW specifies source cluster read and destination cluster read/write.
// S_NA_D_RW specifies the read-write target cluster.
MigrationStatus *string `json:"MigrationStatus,omitnil,omitempty" name:"MigrationStatus"`
// Specifies whether the health check is completed.
HealthCheckPassed *bool `json:"HealthCheckPassed,omitnil,omitempty" name:"HealthCheckPassed"`
// Error information returned by the last health check is valid only when HealthCheckPassed is false. NotChecked: check not executed. Unknown: Unknown error. TopicNotImported: topic not imported. TopicNotExistsInSourceCluster: topic does not exist in the source cluster. TopicNotExistsInTargetCluster: topic does not exist in the target cluster. ConsumerConnectedOnTarget: consumer connections exist on the target cluster. SourceTopicHasNewMessagesIn5Minutes: new messages were written to the source cluster topic in the last 5 Minutes. TargetTopicHasNewMessagesIn5Minutes: new messages were written to the target cluster topic in the last 5 Minutes. SourceTopicHasNoMessagesIn5Minutes: no new messages were written to the source cluster in the last 5 Minutes. TargetTopicHasNoMessagesIn5Minutes: no new messages were written to the target cluster in the last 5 Minutes. ConsumerGroupCountNotMatch: inconsistent number of subscription groups. SourceTopicHasUnconsumedMessages: unconsumed messages exist in the source cluster topic.
HealthCheckError *string `json:"HealthCheckError,omitnil,omitempty" name:"HealthCheckError"`
// Namespace. specifies that it is only valid for 4.x clusters.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
// Namespace of 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
NamespaceV4 *string `json:"NamespaceV4,omitnil,omitempty" name:"NamespaceV4"`
// Topic name for version 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
TopicNameV4 *string `json:"TopicNameV4,omitnil,omitempty" name:"TopicNameV4"`
// Complete namespace for 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
FullNamespaceV4 *string `json:"FullNamespaceV4,omitnil,omitempty" name:"FullNamespaceV4"`
// Error list returned from the last health check.
HealthCheckErrorList []*string `json:"HealthCheckErrorList,omitnil,omitempty" name:"HealthCheckErrorList"`
}
type MigrationTaskItem ¶
type MigrationTaskItem struct {
// Task ID
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Instance ID.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// 0 - not specified (existing).
// Metadata import.
Type *int64 `json:"Type,omitnil,omitempty" name:"Type"`
// Total number of topics.
TopicNum *int64 `json:"TopicNum,omitnil,omitempty" name:"TopicNum"`
// Total Number of Consumer Groups
GroupNum *int64 `json:"GroupNum,omitnil,omitempty" name:"GroupNum"`
// Task status. 0: migrating; 1: migration successful; 2: migration completed, with only part of the data migrated.
Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`
// Creation time.
CreateTime *int64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`
}
type ModifyConsumerGroupRequest ¶
type ModifyConsumerGroupRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Whether to enable consumption.
ConsumeEnable *bool `json:"ConsumeEnable,omitnil,omitempty" name:"ConsumeEnable"`
// Specifies whether to use ordered delivery. valid values: true.
// Concurrent delivery: false.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
// Maximum number of retries. Value range: 0 to 1000.
MaxRetryTimes *int64 `json:"MaxRetryTimes,omitnil,omitempty" name:"MaxRetryTimes"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}
func NewModifyConsumerGroupRequest ¶
func NewModifyConsumerGroupRequest() (request *ModifyConsumerGroupRequest)
func (*ModifyConsumerGroupRequest) FromJsonString ¶
func (r *ModifyConsumerGroupRequest) 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 (*ModifyConsumerGroupRequest) ToJsonString ¶
func (r *ModifyConsumerGroupRequest) ToJsonString() string
type ModifyConsumerGroupRequestParams ¶
type ModifyConsumerGroupRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Whether to enable consumption.
ConsumeEnable *bool `json:"ConsumeEnable,omitnil,omitempty" name:"ConsumeEnable"`
// Specifies whether to use ordered delivery. valid values: true.
// Concurrent delivery: false.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
// Maximum number of retries. Value range: 0 to 1000.
MaxRetryTimes *int64 `json:"MaxRetryTimes,omitnil,omitempty" name:"MaxRetryTimes"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
}
Predefined struct for user
type ModifyConsumerGroupResponse ¶
type ModifyConsumerGroupResponse struct {
*tchttp.BaseResponse
Response *ModifyConsumerGroupResponseParams `json:"Response"`
}
func NewModifyConsumerGroupResponse ¶
func NewModifyConsumerGroupResponse() (response *ModifyConsumerGroupResponse)
func (*ModifyConsumerGroupResponse) FromJsonString ¶
func (r *ModifyConsumerGroupResponse) 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 (*ModifyConsumerGroupResponse) ToJsonString ¶
func (r *ModifyConsumerGroupResponse) ToJsonString() string
type ModifyConsumerGroupResponseParams ¶
type ModifyConsumerGroupResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ModifyInstanceEndpointRequest ¶
type ModifyInstanceEndpointRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Access point type.
// PUBLIC network.
Type *string `json:"Type,omitnil,omitempty" name:"Type"`
// Public network bandwidth, in Mbps
Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`
// Public network security group information
IpRules []*IpRule `json:"IpRules,omitnil,omitempty" name:"IpRules"`
// Whether the public network is billed by traffic.
BillingFlow *bool `json:"BillingFlow,omitnil,omitempty" name:"BillingFlow"`
}
func NewModifyInstanceEndpointRequest ¶
func NewModifyInstanceEndpointRequest() (request *ModifyInstanceEndpointRequest)
func (*ModifyInstanceEndpointRequest) FromJsonString ¶
func (r *ModifyInstanceEndpointRequest) 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 (*ModifyInstanceEndpointRequest) ToJsonString ¶
func (r *ModifyInstanceEndpointRequest) ToJsonString() string
type ModifyInstanceEndpointRequestParams ¶
type ModifyInstanceEndpointRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Access point type.
// PUBLIC network.
Type *string `json:"Type,omitnil,omitempty" name:"Type"`
// Public network bandwidth, in Mbps
Bandwidth *int64 `json:"Bandwidth,omitnil,omitempty" name:"Bandwidth"`
// Public network security group information
IpRules []*IpRule `json:"IpRules,omitnil,omitempty" name:"IpRules"`
// Whether the public network is billed by traffic.
BillingFlow *bool `json:"BillingFlow,omitnil,omitempty" name:"BillingFlow"`
}
Predefined struct for user
type ModifyInstanceEndpointResponse ¶
type ModifyInstanceEndpointResponse struct {
*tchttp.BaseResponse
Response *ModifyInstanceEndpointResponseParams `json:"Response"`
}
func NewModifyInstanceEndpointResponse ¶
func NewModifyInstanceEndpointResponse() (response *ModifyInstanceEndpointResponse)
func (*ModifyInstanceEndpointResponse) FromJsonString ¶
func (r *ModifyInstanceEndpointResponse) 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 (*ModifyInstanceEndpointResponse) ToJsonString ¶
func (r *ModifyInstanceEndpointResponse) ToJsonString() string
type ModifyInstanceEndpointResponseParams ¶
type ModifyInstanceEndpointResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ModifyInstanceRequest ¶
type ModifyInstanceRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Instance name. It cannot be left blank. It can contain 3 to 64 characters consisting of only digits, letters, hyphens (-), and underscores (_).
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Message sending and receiving ratio
SendReceiveRatio *float64 `json:"SendReceiveRatio,omitnil,omitempty" name:"SendReceiveRatio"`
// Product specification. It can be obtained from the output parameters of [ProductSKU](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU) of the API [DescribeProductSKUs](https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// Message retention time (unit: hr). value range refers to the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
//
// -Default value: DefaultRetention parameter.
// -Minimum value: specifies the RetentionLowerLimit parameter.
// -Specifies the maximum value of the RetentionUpperLimit parameter.
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Whether to enable elastic TPS.
ScaledTpsEnabled *bool `json:"ScaledTpsEnabled,omitnil,omitempty" name:"ScaledTpsEnabled"`
// Whether ACL is enabled.
AclEnabled *bool `json:"AclEnabled,omitnil,omitempty" name:"AclEnabled"`
// The maximum number of topics that can be created. value ranges from...to... refer to the ProductSKU output parameter in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1) (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU).
//
// -Minimum value and default value: TopicNumLimit parameter.
// -Maximum value of TopicNumUpperLimit parameter.
MaxTopicNum *int64 `json:"MaxTopicNum,omitnil,omitempty" name:"MaxTopicNum"`
// Number of topics not included in the free quota. For the free quota, see the TopicNumLimit parameter in the output parameters of [ProductSKU](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU) of the API [DescribeProductSKUs](https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
ExtraTopicNum *string `json:"ExtraTopicNum,omitnil,omitempty" name:"ExtraTopicNum"`
// Whether to enable deletion protection
EnableDeletionProtection *bool `json:"EnableDeletionProtection,omitnil,omitempty" name:"EnableDeletionProtection"`
}
func NewModifyInstanceRequest ¶
func NewModifyInstanceRequest() (request *ModifyInstanceRequest)
func (*ModifyInstanceRequest) FromJsonString ¶
func (r *ModifyInstanceRequest) 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 (*ModifyInstanceRequest) ToJsonString ¶
func (r *ModifyInstanceRequest) ToJsonString() string
type ModifyInstanceRequestParams ¶
type ModifyInstanceRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Instance name. It cannot be left blank. It can contain 3 to 64 characters consisting of only digits, letters, hyphens (-), and underscores (_).
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Message sending and receiving ratio
SendReceiveRatio *float64 `json:"SendReceiveRatio,omitnil,omitempty" name:"SendReceiveRatio"`
// Product specification. It can be obtained from the output parameters of [ProductSKU](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU) of the API [DescribeProductSKUs](https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// Message retention time (unit: hr). value range refers to the ProductSKU response parameters structure in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
//
// -Default value: DefaultRetention parameter.
// -Minimum value: specifies the RetentionLowerLimit parameter.
// -Specifies the maximum value of the RetentionUpperLimit parameter.
MessageRetention *int64 `json:"MessageRetention,omitnil,omitempty" name:"MessageRetention"`
// Whether to enable elastic TPS.
ScaledTpsEnabled *bool `json:"ScaledTpsEnabled,omitnil,omitempty" name:"ScaledTpsEnabled"`
// Whether ACL is enabled.
AclEnabled *bool `json:"AclEnabled,omitnil,omitempty" name:"AclEnabled"`
// The maximum number of topics that can be created. value ranges from...to... refer to the ProductSKU output parameter in the DescribeProductSKUs api (https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1) (https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU).
//
// -Minimum value and default value: TopicNumLimit parameter.
// -Maximum value of TopicNumUpperLimit parameter.
MaxTopicNum *int64 `json:"MaxTopicNum,omitnil,omitempty" name:"MaxTopicNum"`
// Number of topics not included in the free quota. For the free quota, see the TopicNumLimit parameter in the output parameters of [ProductSKU](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ProductSKU) of the API [DescribeProductSKUs](https://www.tencentcloud.comom/document/api/1493/107676?from_cn_redirect=1).
ExtraTopicNum *string `json:"ExtraTopicNum,omitnil,omitempty" name:"ExtraTopicNum"`
// Whether to enable deletion protection
EnableDeletionProtection *bool `json:"EnableDeletionProtection,omitnil,omitempty" name:"EnableDeletionProtection"`
}
Predefined struct for user
type ModifyInstanceResponse ¶
type ModifyInstanceResponse struct {
*tchttp.BaseResponse
Response *ModifyInstanceResponseParams `json:"Response"`
}
func NewModifyInstanceResponse ¶
func NewModifyInstanceResponse() (response *ModifyInstanceResponse)
func (*ModifyInstanceResponse) FromJsonString ¶
func (r *ModifyInstanceResponse) 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 (*ModifyInstanceResponse) ToJsonString ¶
func (r *ModifyInstanceResponse) ToJsonString() string
type ModifyInstanceResponseParams ¶
type ModifyInstanceResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ModifyRoleRequest ¶
type ModifyRoleRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Role name. It can be obtained from [RoleItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#RoleItem) returned by the API [DescribeRoleList](https://www.tencentcloud.comom/document/api/1493/98862?from_cn_redirect=1) or from the console.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
// Whether to enable consumption.
PermRead *bool `json:"PermRead,omitnil,omitempty" name:"PermRead"`
// Whether to enable production
PermWrite *bool `json:"PermWrite,omitnil,omitempty" name:"PermWrite"`
// Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group dimension).
PermType *string `json:"PermType,omitnil,omitempty" name:"PermType"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Permission configuration in the topic/group dimension. It is required when the permission type parameter is set to TopicAndGroup.
DetailedPerms []*DetailedRolePerm `json:"DetailedPerms,omitnil,omitempty" name:"DetailedPerms"`
}
func NewModifyRoleRequest ¶
func NewModifyRoleRequest() (request *ModifyRoleRequest)
func (*ModifyRoleRequest) FromJsonString ¶
func (r *ModifyRoleRequest) 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 (*ModifyRoleRequest) ToJsonString ¶
func (r *ModifyRoleRequest) ToJsonString() string
type ModifyRoleRequestParams ¶
type ModifyRoleRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Role name. It can be obtained from [RoleItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#RoleItem) returned by the API [DescribeRoleList](https://www.tencentcloud.comom/document/api/1493/98862?from_cn_redirect=1) or from the console.
Role *string `json:"Role,omitnil,omitempty" name:"Role"`
// Whether to enable consumption.
PermRead *bool `json:"PermRead,omitnil,omitempty" name:"PermRead"`
// Whether to enable production
PermWrite *bool `json:"PermWrite,omitnil,omitempty" name:"PermWrite"`
// Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group dimension).
PermType *string `json:"PermType,omitnil,omitempty" name:"PermType"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Permission configuration in the topic/group dimension. It is required when the permission type parameter is set to TopicAndGroup.
DetailedPerms []*DetailedRolePerm `json:"DetailedPerms,omitnil,omitempty" name:"DetailedPerms"`
}
Predefined struct for user
type ModifyRoleResponse ¶
type ModifyRoleResponse struct {
*tchttp.BaseResponse
Response *ModifyRoleResponseParams `json:"Response"`
}
func NewModifyRoleResponse ¶
func NewModifyRoleResponse() (response *ModifyRoleResponse)
func (*ModifyRoleResponse) FromJsonString ¶
func (r *ModifyRoleResponse) 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 (*ModifyRoleResponse) ToJsonString ¶
func (r *ModifyRoleResponse) ToJsonString() string
type ModifyRoleResponseParams ¶
type ModifyRoleResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ModifyTopicRequest ¶
type ModifyTopicRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Number of queues. Value range: 3 to 16.
QueueNum *int64 `json:"QueueNum,omitnil,omitempty" name:"QueueNum"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Message retention period (unit: hour).
MsgTTL *int64 `json:"MsgTTL,omitnil,omitempty" name:"MsgTTL"`
}
func NewModifyTopicRequest ¶
func NewModifyTopicRequest() (request *ModifyTopicRequest)
func (*ModifyTopicRequest) FromJsonString ¶
func (r *ModifyTopicRequest) 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 (*ModifyTopicRequest) ToJsonString ¶
func (r *ModifyTopicRequest) ToJsonString() string
type ModifyTopicRequestParams ¶
type ModifyTopicRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Number of queues. Value range: 3 to 16.
QueueNum *int64 `json:"QueueNum,omitnil,omitempty" name:"QueueNum"`
// Remarks. Up to 128 characters are allowed.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Message retention period (unit: hour).
MsgTTL *int64 `json:"MsgTTL,omitnil,omitempty" name:"MsgTTL"`
}
Predefined struct for user
type ModifyTopicResponse ¶
type ModifyTopicResponse struct {
*tchttp.BaseResponse
Response *ModifyTopicResponseParams `json:"Response"`
}
func NewModifyTopicResponse ¶
func NewModifyTopicResponse() (response *ModifyTopicResponse)
func (*ModifyTopicResponse) FromJsonString ¶
func (r *ModifyTopicResponse) 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 (*ModifyTopicResponse) ToJsonString ¶
func (r *ModifyTopicResponse) ToJsonString() string
type ModifyTopicResponseParams ¶
type ModifyTopicResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type PriceTag ¶
type PriceTag struct {
// Price name. Enumeration values: tps: basic price of TPS; stepTps: TPS step size.
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Step size corresponding to the billing item.
// Note: This field may return null, indicating that no valid values can be obtained.
Step *int64 `json:"Step,omitnil,omitempty" name:"Step"`
}
type ProducerInfo ¶
type ProducerInfo struct {
// Client ID
// Note: This field may return null, indicating that no valid values can be obtained.
ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`
// Client IP.
// Note: This field may return null, indicating that no valid values can be obtained.
ClientIp *string `json:"ClientIp,omitnil,omitempty" name:"ClientIp"`
// Client language.
// - JAVA((byte) 0)
// - CPP((byte) 1)
// - DOTNET((byte) 2)
// - PYTHON((byte) 3)
// - DELPHI((byte) 4)
// - ERLANG((byte) 5)
// - RUBY((byte) 6)
// - OTHER((byte) 7)
// - HTTP((byte) 8)
// - GO((byte) 9)
// - PHP((byte) 10)
// - OMS((byte) 11)
// Note: This field may return null, indicating that no valid values can be obtained.
Language *string `json:"Language,omitnil,omitempty" name:"Language"`
// Client version.
// Note: This field may return null, indicating that no valid values can be obtained.
Version *string `json:"Version,omitnil,omitempty" name:"Version"`
// Last production time, **Unix timestamp (seconds)**.
// Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTimestamp *uint64 `json:"LastUpdateTimestamp,omitnil,omitempty" name:"LastUpdateTimestamp"`
// Producer client protocol type. valid values: the following.
//
// -Specifies the grpc protocol.
// -remoting protocol.
// -http protocol.
// Note: This field may return null, indicating that no valid values can be obtained.
ChannelProtocol *string `json:"ChannelProtocol,omitnil,omitempty" name:"ChannelProtocol"`
}
type ProductSKU ¶
type ProductSKU struct {
// Specifies the product type.
// Trial version.
// BASIC version.
// PRO, professional edition.
// PLATINUM edition.
InstanceType *string `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`
// Specification code
SkuCode *string `json:"SkuCode,omitnil,omitempty" name:"SkuCode"`
// TPS limit
TpsLimit *int64 `json:"TpsLimit,omitnil,omitempty" name:"TpsLimit"`
// Elastic TPS upper limit
ScaledTpsLimit *int64 `json:"ScaledTpsLimit,omitnil,omitempty" name:"ScaledTpsLimit"`
// Default maximum number of topics.
TopicNumLimit *int64 `json:"TopicNumLimit,omitnil,omitempty" name:"TopicNumLimit"`
// Maximum number of consumer groups
GroupNumLimit *int64 `json:"GroupNumLimit,omitnil,omitempty" name:"GroupNumLimit"`
// Default message retention time, in hours
DefaultRetention *int64 `json:"DefaultRetention,omitnil,omitempty" name:"DefaultRetention"`
// Adjustable maximum message retention time, in hours
RetentionUpperLimit *int64 `json:"RetentionUpperLimit,omitnil,omitempty" name:"RetentionUpperLimit"`
// Adjustable minimum message retention time, in hours
RetentionLowerLimit *int64 `json:"RetentionLowerLimit,omitnil,omitempty" name:"RetentionLowerLimit"`
// Maximum delayed message duration, in hours
MaxMessageDelay *int64 `json:"MaxMessageDelay,omitnil,omitempty" name:"MaxMessageDelay"`
// Whether it is purchasable
OnSale *bool `json:"OnSale,omitnil,omitempty" name:"OnSale"`
// Billing item information
PriceTags []*PriceTag `json:"PriceTags,omitnil,omitempty" name:"PriceTags"`
// Default maximum number of topics.
TopicNumUpperLimit *int64 `json:"TopicNumUpperLimit,omitnil,omitempty" name:"TopicNumUpperLimit"`
}
type RemoveMigratingTopicRequest ¶
type RemoveMigratingTopicRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
func NewRemoveMigratingTopicRequest ¶
func NewRemoveMigratingTopicRequest() (request *RemoveMigratingTopicRequest)
func (*RemoveMigratingTopicRequest) FromJsonString ¶
func (r *RemoveMigratingTopicRequest) 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 (*RemoveMigratingTopicRequest) ToJsonString ¶
func (r *RemoveMigratingTopicRequest) ToJsonString() string
type RemoveMigratingTopicRequestParams ¶
type RemoveMigratingTopicRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
Predefined struct for user
type RemoveMigratingTopicResponse ¶
type RemoveMigratingTopicResponse struct {
*tchttp.BaseResponse
Response *RemoveMigratingTopicResponseParams `json:"Response"`
}
func NewRemoveMigratingTopicResponse ¶
func NewRemoveMigratingTopicResponse() (response *RemoveMigratingTopicResponse)
func (*RemoveMigratingTopicResponse) FromJsonString ¶
func (r *RemoveMigratingTopicResponse) 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 (*RemoveMigratingTopicResponse) ToJsonString ¶
func (r *RemoveMigratingTopicResponse) ToJsonString() string
type RemoveMigratingTopicResponseParams ¶
type RemoveMigratingTopicResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ResendDeadLetterMessageRequest ¶
type ResendDeadLetterMessageRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// List of dead letter message ids.
MessageIds []*string `json:"MessageIds,omitnil,omitempty" name:"MessageIds"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
func NewResendDeadLetterMessageRequest ¶
func NewResendDeadLetterMessageRequest() (request *ResendDeadLetterMessageRequest)
func (*ResendDeadLetterMessageRequest) FromJsonString ¶
func (r *ResendDeadLetterMessageRequest) 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 (*ResendDeadLetterMessageRequest) ToJsonString ¶
func (r *ResendDeadLetterMessageRequest) ToJsonString() string
type ResendDeadLetterMessageRequestParams ¶
type ResendDeadLetterMessageRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// List of dead letter message ids.
MessageIds []*string `json:"MessageIds,omitnil,omitempty" name:"MessageIds"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
Predefined struct for user
type ResendDeadLetterMessageResponse ¶
type ResendDeadLetterMessageResponse struct {
*tchttp.BaseResponse
Response *ResendDeadLetterMessageResponseParams `json:"Response"`
}
func NewResendDeadLetterMessageResponse ¶
func NewResendDeadLetterMessageResponse() (response *ResendDeadLetterMessageResponse)
func (*ResendDeadLetterMessageResponse) FromJsonString ¶
func (r *ResendDeadLetterMessageResponse) 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 (*ResendDeadLetterMessageResponse) ToJsonString ¶
func (r *ResendDeadLetterMessageResponse) ToJsonString() string
type ResendDeadLetterMessageResponseParams ¶
type ResendDeadLetterMessageResponseParams struct {
// Specifies the result of resending a message.
// Note: This field may return null, indicating that no valid values can be obtained.
ResendResult *bool `json:"ResendResult,omitnil,omitempty" name:"ResendResult"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ResetConsumerGroupOffsetRequest ¶
type ResetConsumerGroupOffsetRequest struct {
*tchttp.BaseRequest
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Timestamp (unit: millisecond) for resetting the offset. The value -1 indicates resetting to the latest offset.
ResetTimestamp *int64 `json:"ResetTimestamp,omitnil,omitempty" name:"ResetTimestamp"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
func NewResetConsumerGroupOffsetRequest ¶
func NewResetConsumerGroupOffsetRequest() (request *ResetConsumerGroupOffsetRequest)
func (*ResetConsumerGroupOffsetRequest) FromJsonString ¶
func (r *ResetConsumerGroupOffsetRequest) 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 (*ResetConsumerGroupOffsetRequest) ToJsonString ¶
func (r *ResetConsumerGroupOffsetRequest) ToJsonString() string
type ResetConsumerGroupOffsetRequestParams ¶
type ResetConsumerGroupOffsetRequestParams struct {
// TDMQ RocketMQ instance ID. It can be obtained from the API [DescribeFusionInstanceList](https://www.tencentcloud.comom/document/api/1493/106745?from_cn_redirect=1) or the console.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name. It can be obtained from [TopicItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#TopicItem) returned by the API [DescribeTopicList](https://www.tencentcloud.comom/document/api/1493/96030?from_cn_redirect=1) or from the console.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Timestamp (unit: millisecond) for resetting the offset. The value -1 indicates resetting to the latest offset.
ResetTimestamp *int64 `json:"ResetTimestamp,omitnil,omitempty" name:"ResetTimestamp"`
// Consumer group name. It can be obtained from [ConsumeGroupItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#ConsumeGroupItem) returned by the API [DescribeConsumerGroupList](https://www.tencentcloud.comom/document/api/1493/101535?from_cn_redirect=1) or from the console.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
}
Predefined struct for user
type ResetConsumerGroupOffsetResponse ¶
type ResetConsumerGroupOffsetResponse struct {
*tchttp.BaseResponse
Response *ResetConsumerGroupOffsetResponseParams `json:"Response"`
}
func NewResetConsumerGroupOffsetResponse ¶
func NewResetConsumerGroupOffsetResponse() (response *ResetConsumerGroupOffsetResponse)
func (*ResetConsumerGroupOffsetResponse) FromJsonString ¶
func (r *ResetConsumerGroupOffsetResponse) 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 (*ResetConsumerGroupOffsetResponse) ToJsonString ¶
func (r *ResetConsumerGroupOffsetResponse) ToJsonString() string
type ResetConsumerGroupOffsetResponseParams ¶
type ResetConsumerGroupOffsetResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type RoleItem ¶
type RoleItem struct {
// Role name.
RoleName *string `json:"RoleName,omitnil,omitempty" name:"RoleName"`
// Whether to enable consumption.
PermRead *bool `json:"PermRead,omitnil,omitempty" name:"PermRead"`
// Whether to enable production
PermWrite *bool `json:"PermWrite,omitnil,omitempty" name:"PermWrite"`
// Access Key
AccessKey *string `json:"AccessKey,omitnil,omitempty" name:"AccessKey"`
// Secret Key
SecretKey *string `json:"SecretKey,omitnil,omitempty" name:"SecretKey"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Role creation time. **It is a Unix timestamp (ms).**
CreatedTime *int64 `json:"CreatedTime,omitnil,omitempty" name:"CreatedTime"`
// Role update time. **It is a Unix timestamp (ms).**
ModifiedTime *int64 `json:"ModifiedTime,omitnil,omitempty" name:"ModifiedTime"`
// Specifies the types of permissions. the default is to authorize by Cluster (Cluster: at the Cluster level; TopicAndGroup: topic and consumer group level).
PermType *string `json:"PermType,omitnil,omitempty" name:"PermType"`
// Permission configuration in Topic and Group dimension.
// Note: This field may return null, indicating that no valid values can be obtained.
DetailedRolePerms []*DetailedRolePerm `json:"DetailedRolePerms,omitnil,omitempty" name:"DetailedRolePerms"`
}
type RollbackMigratingTopicStageRequest ¶
type RollbackMigratingTopicStageRequest struct {
*tchttp.BaseRequest
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
func NewRollbackMigratingTopicStageRequest ¶
func NewRollbackMigratingTopicStageRequest() (request *RollbackMigratingTopicStageRequest)
func (*RollbackMigratingTopicStageRequest) FromJsonString ¶
func (r *RollbackMigratingTopicStageRequest) 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 (*RollbackMigratingTopicStageRequest) ToJsonString ¶
func (r *RollbackMigratingTopicStageRequest) ToJsonString() string
type RollbackMigratingTopicStageRequestParams ¶
type RollbackMigratingTopicStageRequestParams struct {
// Task ID. It can be obtained from [SmoothMigrationTaskItem](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SmoothMigrationTaskItem) returned by the API [DescribeSmoothMigrationTaskList](https://www.tencentcloud.comom/document/api/1493/119997?from_cn_redirect=1) or from the console.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Topic name. It can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from [MigratingTopic](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#MigratingTopic) returned by the API [DescribeMigratingTopicList](https://www.tencentcloud.comom/document/api/1493/118007?from_cn_redirect=1) in Data Type.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
Predefined struct for user
type RollbackMigratingTopicStageResponse ¶
type RollbackMigratingTopicStageResponse struct {
*tchttp.BaseResponse
Response *RollbackMigratingTopicStageResponseParams `json:"Response"`
}
func NewRollbackMigratingTopicStageResponse ¶
func NewRollbackMigratingTopicStageResponse() (response *RollbackMigratingTopicStageResponse)
func (*RollbackMigratingTopicStageResponse) FromJsonString ¶
func (r *RollbackMigratingTopicStageResponse) 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 (*RollbackMigratingTopicStageResponse) ToJsonString ¶
func (r *RollbackMigratingTopicStageResponse) ToJsonString() string
type RollbackMigratingTopicStageResponseParams ¶
type RollbackMigratingTopicStageResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type SmoothMigrationTaskItem ¶
type SmoothMigrationTaskItem struct {
// Task ID
// Note: This field may return null, indicating that no valid values can be obtained.
TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`
// Task name.
// Note: This field may return null, indicating that no valid values can be obtained.
TaskName *string `json:"TaskName,omitnil,omitempty" name:"TaskName"`
// Source cluster name.
// Note: This field may return null, indicating that no valid values can be obtained.
SourceClusterName *string `json:"SourceClusterName,omitnil,omitempty" name:"SourceClusterName"`
// Destination cluster instance ID.
// Note: This field may return null, indicating that no valid values can be obtained.
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Specifies the network connection type.
// PUBLIC network.
// Specifies the VPC virtual private cloud.
// OTHER.
// Note: This field may return null, indicating that no valid values can be obtained.
ConnectionType *string `json:"ConnectionType,omitnil,omitempty" name:"ConnectionType"`
// Source cluster NameServer address.
// Note: This field may return null, indicating that no valid values can be obtained.
SourceNameServer *string `json:"SourceNameServer,omitnil,omitempty" name:"SourceNameServer"`
// Task status.
// Migration Configuration. specifies the migration Configuration.
// SourceConnecting specifies connecting to source cluster.
// MetaDataImport specifies metadata import.
// EndpointSetup specifies the access point switchover.
// Service migration is in progress.
// Completed.
// Cancelled: canceled.
// Note: This field may return null, indicating that no valid values can be obtained.
TaskStatus *string `json:"TaskStatus,omitnil,omitempty" name:"TaskStatus"`
// Specifies the target cluster instance version.
// 4 indicates version 4.x.
// 5 indicates version 5.x.
// Note: This field may return null, indicating that no valid values can be obtained.
InstanceVersion *string `json:"InstanceVersion,omitnil,omitempty" name:"InstanceVersion"`
}
type SourceClusterGroupConfig ¶
type SourceClusterGroupConfig struct {
// Consumer group name. It can be obtained from [SourceClusterGroupConfig](https://www.tencentcloud.comom/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) returned by the API [DescribeSourceClusterGroupList](https://www.tencentcloud.comom/document/api/1493/118006?from_cn_redirect=1).
// Note: This field may return null, indicating that no valid values can be obtained.
GroupName *string `json:"GroupName,omitnil,omitempty" name:"GroupName"`
// Remarks
//
// Note: This field may return null, indicating that no valid values can be obtained.
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Specifies whether it has been imported. it is unavailable when used as an input parameter.
// Note: This field may return null, indicating that no valid values can be obtained.
Imported *bool `json:"Imported,omitnil,omitempty" name:"Imported"`
// Namespace, valid for 4.x clusters only.
// Note: This field may return null, indicating that no valid values can be obtained.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
// Import status.
// Unknown. specifies an unknown status.
// Success.
// Failure.
// AlreadyExists. specifies the resource already exists.
//
// Used as an output parameter.
// Note: This field may return null, indicating that no valid values can be obtained.
ImportStatus *string `json:"ImportStatus,omitnil,omitempty" name:"ImportStatus"`
// Namespace of 4.x. output usage.
// Note: This field may return null, indicating that no valid values can be obtained.
NamespaceV4 *string `json:"NamespaceV4,omitnil,omitempty" name:"NamespaceV4"`
// Consumer group name for version 4.x. output usage.
// Note: This field may return null, indicating that no valid values can be obtained.
GroupNameV4 *string `json:"GroupNameV4,omitnil,omitempty" name:"GroupNameV4"`
// Complete namespace for version 4.x. output usage.
// Note: This field may return null, indicating that no valid values can be obtained.
FullNamespaceV4 *string `json:"FullNamespaceV4,omitnil,omitempty" name:"FullNamespaceV4"`
// Specifies whether it is ordered delivery. valid value: 5.0.
// Note: This field may return null, indicating that no valid values can be obtained.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
}
type SubscriptionData ¶
type SubscriptionData 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.
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Topic type.
// Note: This field may return null, indicating that no valid values can be obtained.
TopicType *string `json:"TopicType,omitnil,omitempty" name:"TopicType"`
// Number of topic queues on a single node
//
// Note: This field may return null, indicating that no valid values can be obtained.
TopicQueueNum *int64 `json:"TopicQueueNum,omitnil,omitempty" name:"TopicQueueNum"`
// Specifies the consumer group name.
// Note: This field may return null, indicating that no valid values can be obtained.
ConsumerGroup *string `json:"ConsumerGroup,omitnil,omitempty" name:"ConsumerGroup"`
// Online status
//
// Note: This field may return null, indicating that no valid values can be obtained.
IsOnline *bool `json:"IsOnline,omitnil,omitempty" name:"IsOnline"`
// Consumption type. valid values as follows:.
//
// -PULL: specifies the pull consumption type.
// -PUSH: specifies the push consumption type.
// -POP: specifies the pop consumption type.
// Note: This field may return null, indicating that no valid values can be obtained.
ConsumeType *string `json:"ConsumeType,omitnil,omitempty" name:"ConsumeType"`
// Subscription rule.
// Note: This field may return null, indicating that no valid values can be obtained.
SubString *string `json:"SubString,omitnil,omitempty" name:"SubString"`
// Filter type.
// Note: This field may return null, indicating that no valid values can be obtained.
ExpressionType *string `json:"ExpressionType,omitnil,omitempty" name:"ExpressionType"`
// Subscription consistency. enumerated as follows:.
//
// -Subscription consistency.
// -Subscription inconsistency.
// Note: This field may return null, indicating that no valid values can be obtained.
Consistency *int64 `json:"Consistency,omitnil,omitempty" name:"Consistency"`
// Consumption heap
//
// Note: This field may return null, indicating that no valid values can be obtained.
ConsumerLag *int64 `json:"ConsumerLag,omitnil,omitempty" name:"ConsumerLag"`
// Last consumption progress update time. **It is a Unix timestamp (ms).**
// Note: This field may return null, indicating that no valid values can be obtained.
LastUpdateTime *int64 `json:"LastUpdateTime,omitnil,omitempty" name:"LastUpdateTime"`
// Maximum number of retries.
// Note: This field may return null, indicating that no valid values can be obtained.
MaxRetryTimes *int64 `json:"MaxRetryTimes,omitnil,omitempty" name:"MaxRetryTimes"`
// Whether it is sequential consumption
//
// Note: This field may return null, indicating that no valid values can be obtained.
ConsumeMessageOrderly *bool `json:"ConsumeMessageOrderly,omitnil,omitempty" name:"ConsumeMessageOrderly"`
// Specifies the consumption mode.
// BROADCASTING mode.
// CLUSTERING: cluster mode.
// Note: This field may return null, indicating that no valid values can be obtained.
MessageModel *string `json:"MessageModel,omitnil,omitempty" name:"MessageModel"`
// List of clients with inconsistent subscriptions.
// Note: This field may return null, indicating that no valid values can be obtained.
ClientSubscriptionInfos []*ClientSubscriptionInfo `json:"ClientSubscriptionInfos,omitnil,omitempty" name:"ClientSubscriptionInfos"`
}
type Tag ¶
type Tag struct {
// Tag name.
// Note: This field may return null, indicating that no valid values can be obtained.
TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`
// Tag value
//
// Note: This field may return null, indicating that no valid values can be obtained.
TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}
type TopicConsumeStats ¶
type TopicConsumeStats struct {
// Topic name
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Topic type. valid values are as follows:.
//
// -UNSPECIFIED: unspecified.
// -NORMAL: standard message.
// -FIFO: specifies sequential messaging.
// -DELAY: specifies the delayed message.
// -Specifies the TRANSACTION message.
TopicType *string `json:"TopicType,omitnil,omitempty" name:"TopicType"`
// Number of topic queues per node
QueueNum *int64 `json:"QueueNum,omitnil,omitempty" name:"QueueNum"`
// Consumption heap
ConsumerLag *int64 `json:"ConsumerLag,omitnil,omitempty" name:"ConsumerLag"`
// Subscription rule. `*` indicates subscription to all topics.
SubString *string `json:"SubString,omitnil,omitempty" name:"SubString"`
// Last consumption progress update time. **It is a Unix timestamp (ms).**
LastUpdateTime *int64 `json:"LastUpdateTime,omitnil,omitempty" name:"LastUpdateTime"`
}
type TopicItem ¶
type TopicItem struct {
// Instance ID
InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
// Topic name
Topic *string `json:"Topic,omitnil,omitempty" name:"Topic"`
// Topic type.
// NORMAL: regular message.
// FIFO: sequential messaging.
// DELAY: delayed message.
// TRANSACTION message.
TopicType *string `json:"TopicType,omitnil,omitempty" name:"TopicType"`
// Number of queues
QueueNum *int64 `json:"QueueNum,omitnil,omitempty" name:"QueueNum"`
// Remarks
Remark *string `json:"Remark,omitnil,omitempty" name:"Remark"`
// Cluster id of version 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
ClusterIdV4 *string `json:"ClusterIdV4,omitnil,omitempty" name:"ClusterIdV4"`
// Namespace of 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
NamespaceV4 *string `json:"NamespaceV4,omitnil,omitempty" name:"NamespaceV4"`
// Topic name for version 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
TopicV4 *string `json:"TopicV4,omitnil,omitempty" name:"TopicV4"`
// Complete namespace for 4.x.
// Note: This field may return null, indicating that no valid values can be obtained.
FullNamespaceV4 *string `json:"FullNamespaceV4,omitnil,omitempty" name:"FullNamespaceV4"`
// Message retention time.
MsgTTL *int64 `json:"MsgTTL,omitnil,omitempty" name:"MsgTTL"`
// List of bound tags
TagList []*Tag `json:"TagList,omitnil,omitempty" name:"TagList"`
}
type TopicStageChangeResult ¶
type TopicStageChangeResult struct {
// Topic name
TopicName *string `json:"TopicName,omitnil,omitempty" name:"TopicName"`
// Success status
Success *bool `json:"Success,omitnil,omitempty" name:"Success"`
// Namespace. valid only for 4.x.
Namespace *string `json:"Namespace,omitnil,omitempty" name:"Namespace"`
}
type ZoneScheduledItem ¶
type ZoneScheduledItem struct {
// Availability zone ID.
ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`
// The value is true when there are scheduling tasks to be eliminated and no AZs for switchback; otherwise, it is false.
NodePermWipeFlag *bool `json:"NodePermWipeFlag,omitnil,omitempty" name:"NodePermWipeFlag"`
}