jdcloud_sdk.services.jcq.apis package

Submodules

jdcloud_sdk.services.jcq.apis.AddPermissionRequest module

class jdcloud_sdk.services.jcq.apis.AddPermissionRequest.AddPermissionParameters(regionId, topicName, permission, targetUserId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • permission – 权限类型，[PUB,SUB,PUBSUB]
  • targetUserId – 目标用户UserId
class jdcloud_sdk.services.jcq.apis.AddPermissionRequest.AddPermissionRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

对当前topic授予目标用户特定权限

jdcloud_sdk.services.jcq.apis.CleanMessagesRequest module

class jdcloud_sdk.services.jcq.apis.CleanMessagesRequest.CleanMessagesParameters(regionId, topicName, consumerGroupId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
class jdcloud_sdk.services.jcq.apis.CleanMessagesRequest.CleanMessagesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

清除消息

jdcloud_sdk.services.jcq.apis.CreateSubscriptionRequest module

class jdcloud_sdk.services.jcq.apis.CreateSubscriptionRequest.CreateSubscriptionParameters(regionId, topicName, consumerGroupId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
setDlqEnable(dlqEnable)[source]
Parameters:dlqEnable – (Optional) 是否开启死信队列[true, false]
setMaxRetryTimes(maxRetryTimes)[source]
Parameters:maxRetryTimes – (Optional) 最大重试次数dlqEnable为true必填,范围[0,16]
setMessageInvisibleTimeInSeconds(messageInvisibleTimeInSeconds)[source]
Parameters:messageInvisibleTimeInSeconds – (Optional) 消息隐藏时间单位秒
class jdcloud_sdk.services.jcq.apis.CreateSubscriptionRequest.CreateSubscriptionRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建订阅

jdcloud_sdk.services.jcq.apis.CreateTopicRequest module

class jdcloud_sdk.services.jcq.apis.CreateTopicRequest.CreateTopicParameters(regionId, topicName, type)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic名称
  • type – 类型，[normal,global_order]
setDescription(description)[source]
Parameters:description – (Optional) 描述，长度不大于255
class jdcloud_sdk.services.jcq.apis.CreateTopicRequest.CreateTopicRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

创建一个指定名称的topic

jdcloud_sdk.services.jcq.apis.DeleteDeadLettersRequest module

class jdcloud_sdk.services.jcq.apis.DeleteDeadLettersRequest.DeleteDeadLettersParameters(regionId, topicName, consumerGroupId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
setMessageIds(messageIds)[source]
Parameters:messageIds – (Optional) messageIds,多个逗号隔开，不传该值就是删除所有的死信
class jdcloud_sdk.services.jcq.apis.DeleteDeadLettersRequest.DeleteDeadLettersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除死信消息

jdcloud_sdk.services.jcq.apis.DeleteSubscriptionRequest module

class jdcloud_sdk.services.jcq.apis.DeleteSubscriptionRequest.DeleteSubscriptionParameters(regionId, topicName, consumerGroupId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
class jdcloud_sdk.services.jcq.apis.DeleteSubscriptionRequest.DeleteSubscriptionRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除订阅

jdcloud_sdk.services.jcq.apis.DeleteTopicRequest module

class jdcloud_sdk.services.jcq.apis.DeleteTopicRequest.DeleteTopicParameters(regionId, topicName)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
class jdcloud_sdk.services.jcq.apis.DeleteTopicRequest.DeleteTopicRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除单个topic

jdcloud_sdk.services.jcq.apis.DescribeAccessPointRequest module

class jdcloud_sdk.services.jcq.apis.DescribeAccessPointRequest.DescribeAccessPointParameters(regionId, topicName)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
class jdcloud_sdk.services.jcq.apis.DescribeAccessPointRequest.DescribeAccessPointRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看接入点接口

jdcloud_sdk.services.jcq.apis.DescribeConsumerGroupIdsRequest module

class jdcloud_sdk.services.jcq.apis.DescribeConsumerGroupIdsRequest.DescribeConsumerGroupIdsParameters(regionId)[source]

Bases: object

Parameters:regionId – 所在区域的Region ID
class jdcloud_sdk.services.jcq.apis.DescribeConsumerGroupIdsRequest.DescribeConsumerGroupIdsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

consumerGroupId列表

jdcloud_sdk.services.jcq.apis.DescribeDeadLetterNumbersRequest module

class jdcloud_sdk.services.jcq.apis.DescribeDeadLetterNumbersRequest.DescribeDeadLetterNumbersParameters(regionId)[source]

Bases: object

Parameters:regionId – 所在区域的Region ID
setConsumerGroupId(consumerGroupId)[source]
Parameters:consumerGroupId – (Optional) consumerGroupId为空则显示该用户所有订阅关系里的死信数量
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；默认为10；取值范围[10, 100]
class jdcloud_sdk.services.jcq.apis.DescribeDeadLetterNumbersRequest.DescribeDeadLetterNumbersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

死信消息数(按照用户或者consumerGroupId)

jdcloud_sdk.services.jcq.apis.DescribeDeadLetterNumbersWithTopicRequest module

class jdcloud_sdk.services.jcq.apis.DescribeDeadLetterNumbersWithTopicRequest.DescribeDeadLetterNumbersWithTopicParameters(regionId, topicName)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
setConsumerGroupId(consumerGroupId)[source]
Parameters:consumerGroupId – (Optional) consumerGroupId为空则显示该Topic下所有订阅关系里的死信数量
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；默认为10；取值范围[10, 100]
class jdcloud_sdk.services.jcq.apis.DescribeDeadLetterNumbersWithTopicRequest.DescribeDeadLetterNumbersWithTopicRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

死信消息数

jdcloud_sdk.services.jcq.apis.DescribeMessageRequest module

class jdcloud_sdk.services.jcq.apis.DescribeMessageRequest.DescribeMessageParameters(regionId, topicName, messageId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • messageId – message Id
class jdcloud_sdk.services.jcq.apis.DescribeMessageRequest.DescribeMessageRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询message详情

jdcloud_sdk.services.jcq.apis.DescribeMessagesRequest module

class jdcloud_sdk.services.jcq.apis.DescribeMessagesRequest.DescribeMessagesParameters(regionId, topicName, startTime, endTime)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • startTime – 开始时间
  • endTime – 结束时间
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；默认为10；取值范围[10, 100]
class jdcloud_sdk.services.jcq.apis.DescribeMessagesRequest.DescribeMessagesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

消息列表

jdcloud_sdk.services.jcq.apis.DescribePermissionRequest module

class jdcloud_sdk.services.jcq.apis.DescribePermissionRequest.DescribePermissionParameters(regionId, topicName)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
class jdcloud_sdk.services.jcq.apis.DescribePermissionRequest.DescribePermissionRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查看当前topic授予了哪些用户哪些权限

jdcloud_sdk.services.jcq.apis.DescribeSubscriptionRequest module

class jdcloud_sdk.services.jcq.apis.DescribeSubscriptionRequest.DescribeSubscriptionParameters(regionId, topicName, consumerGroupId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
class jdcloud_sdk.services.jcq.apis.DescribeSubscriptionRequest.DescribeSubscriptionRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询订阅详情

jdcloud_sdk.services.jcq.apis.DescribeSubscriptionsRequest module

class jdcloud_sdk.services.jcq.apis.DescribeSubscriptionsRequest.DescribeSubscriptionsParameters(regionId, topicName)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
setConsumerGroupFilter(consumerGroupFilter)[source]
Parameters:consumerGroupFilter – (Optional) consumerGroupFilter，consumerGroupId的过滤条件
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；默认为10；取值范围[10, 100]
class jdcloud_sdk.services.jcq.apis.DescribeSubscriptionsRequest.DescribeSubscriptionsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

订阅列表

jdcloud_sdk.services.jcq.apis.DescribeTopicRequest module

class jdcloud_sdk.services.jcq.apis.DescribeTopicRequest.DescribeTopicParameters(regionId, topicName)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
class jdcloud_sdk.services.jcq.apis.DescribeTopicRequest.DescribeTopicRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询topic详情

jdcloud_sdk.services.jcq.apis.DescribeTopicsRequest module

class jdcloud_sdk.services.jcq.apis.DescribeTopicsRequest.DescribeTopicsParameters(regionId)[source]

Bases: object

Parameters:regionId – 所在区域的Region ID
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；默认为10；取值范围[10, 100]
setTagFilters(tagFilters)[source]
Parameters:tagFilters – (Optional) 标签过滤条件
setTopicFilter(topicFilter)[source]
Parameters:topicFilter – (Optional) topic名称的过滤条件，大小写不敏感
class jdcloud_sdk.services.jcq.apis.DescribeTopicsRequest.DescribeTopicsRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

查询topic列表

jdcloud_sdk.services.jcq.apis.ListDeadLettersRequest module

class jdcloud_sdk.services.jcq.apis.ListDeadLettersRequest.ListDeadLettersParameters(regionId, topicName, consumerGroupId, startTime, endTime)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
  • startTime – 开始时间
  • endTime – 结束时间
setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小；默认为10；取值范围[10, 100]
class jdcloud_sdk.services.jcq.apis.ListDeadLettersRequest.ListDeadLettersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

死信队列列表

jdcloud_sdk.services.jcq.apis.RemovePermissionRequest module

class jdcloud_sdk.services.jcq.apis.RemovePermissionRequest.RemovePermissionParameters(regionId, topicName, permission, targetUserId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • permission – 权限类型, [PUB, SUB, PUBSUB]
  • targetUserId – 目标用户UserId
class jdcloud_sdk.services.jcq.apis.RemovePermissionRequest.RemovePermissionRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

删除当前topic对目标用户授权的权限

jdcloud_sdk.services.jcq.apis.ResendDeadLettersRequest module

class jdcloud_sdk.services.jcq.apis.ResendDeadLettersRequest.ResendDeadLettersParameters(regionId, topicName, consumerGroupId)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
setMessageIds(messageIds)[source]
Parameters:messageIds – (Optional) messageIds,多个逗号隔开，不传该值就是重发所有死信
class jdcloud_sdk.services.jcq.apis.ResendDeadLettersRequest.ResendDeadLettersRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

重发死信消息

jdcloud_sdk.services.jcq.apis.ResetConsumeOffsetRequest module

class jdcloud_sdk.services.jcq.apis.ResetConsumeOffsetRequest.ResetConsumeOffsetParameters(regionId, topicName, consumerGroupId, time)[source]

Bases: object

Parameters:
  • regionId – 所在区域的Region ID
  • topicName – topic 名称
  • consumerGroupId – consumerGroupId
  • time – 时间
class jdcloud_sdk.services.jcq.apis.ResetConsumeOffsetRequest.ResetConsumeOffsetRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

重置消费位

Module contents