Use GetConsumerProgress to query consumer group consumption status - ApsaraMQ for Kafka - Alibaba Cloud - ApsaraMQ for Kafka

Queries the consumption status of a consumer group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alikafka:ListGroup

get

*Instance

acs:alikafka:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	alikafka_pre-cn-mp919o4v****
ConsumerId	string	Yes	The name of the consumer group.	kafka-test
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
HideLastTimestamp	boolean	No	Specifies whether to hide LastTimestamp. Default value: false. Set this parameter to true. Note If you set this parameter to true, LastTimestamp in the response is returned as -1. Otherwise, the actual value is returned. This is supported only for topics of the cloud storage type in reserved instances. This operation processes a large amount of data and is resource-intensive. Set this parameter to true to reduce processing time.	true

Response elements

Element	Type	Description	Example
	object
Code	integer	The status code. A value of 200 indicates success.	200
ConsumerProgress	object	The consumption status.
LastTimestamp	integer	The maximum storage time of the message data corresponding to all consumer offsets of the consumer group. Note This parameter is not supported for all topic types in serverless instances or for topics of the local storage type in reserved instances. The value is uniformly returned as -1. For topics of the cloud storage type in reserved instances, the creation timestamp of the corresponding message is returned only after a consumer group created through the console or API operations submits a consumer offset. If the corresponding message does not have a creation timestamp, -1 is returned.	1566874931649
RebalanceInfoList	object
RebalanceInfoList	array<object>	The rebalance details of the consumer group. Note This field is no longer returned by this operation. To query rebalance details, call the ListRebalanceInfo operation.
	object
Generation	integer	The number of rebalances.	100
GroupId	string	The ID of the consumer group.	falcon-uat
LastRebalanceTimestamp	integer	The time when the current rebalance occurred. Unit: seconds.	1709199270
Reason	string	The reason for the rebalance.	removing member consumer-1-cd14eb9c-379b-4b8e-9bbd-76f147f8536f on LeaveGroup
RebalanceSuccess	boolean	Indicates whether new members joined the consumer group during the current rebalance.	true
RebalanceTimeConsuming	integer	The duration of the current rebalance. Unit: milliseconds.	1
TopicList	object
TopicList	array<object>	The list of consumption progress for each topic subscribed by the consumer group.
	array<object>
LastTimestamp	integer	The maximum storage time of the message data corresponding to all consumer offsets of the topic subscribed by the consumer group. Note This parameter is not supported for all topic types in serverless instances or for topics of the local storage type in reserved instances. The value is uniformly returned as -1. For topics of the cloud storage type in reserved instances, the creation timestamp of the corresponding message is returned only after a consumer group created through the console or API operations submits a consumer offset. If the corresponding message does not have a creation timestamp, -1 is returned.	1566874931649
OffsetList	object
OffsetList	array<object>	The list of offsets.
	object
Accumulate	integer
BrokerOffset	integer	The latest offset.	9
ClientId	string	The client ID of the application.	client-id-KafkaConsumerDemo
ClientIp	string	The IP address of the client.	172.16.11.3
ConsumerOffset	integer	The consumer offset.	9
LastTimestamp	integer	The storage time of the message data corresponding to the consumer offset of the partition. Note This parameter is not supported for all topic types in serverless instances or for topics of the local storage type in reserved instances. The value is uniformly returned as -1. For topics of the cloud storage type in reserved instances, the creation timestamp of the corresponding message is returned only after a consumer group created through the console or API operations submits a consumer offset. If the corresponding message does not have a creation timestamp, -1 is returned.	1566874931649
MemberId	string	The member ID.	client-id-KafkaConsumerDemo-70b64883-a911-4882-8084-598b958848b4
Partition	integer	The partition ID.	0
Topic	string	The topic name.	kafka-test
TotalDiff	integer	The total number of unconsumed messages for the topic, which is the message accumulation.	0
TotalDiff	integer	The total number of unconsumed messages for all topics, which is the message accumulation.	0
state	string	The consumption status of the consumer group. Valid values: UNKNOWN PREPARING_REBALANCE COMPLETING_REBALANCE STABLE DEAD EMPTY	STABLE
Message	string	The returned message.	operation success.
RequestId	string	The request ID.	252820E1-A2E6-45F2-B4C9-1056B8CE****
Success	boolean	Indicates whether the call was successful.	true

Examples

Success response

JSON format

{
  "Code": 200,
  "ConsumerProgress": {
    "LastTimestamp": 1566874931649,
    "RebalanceInfoList": {
      "RebalanceInfoList": [
        {
          "Generation": 100,
          "GroupId": "falcon-uat",
          "LastRebalanceTimestamp": 1709199270,
          "Reason": "removing member consumer-1-cd14eb9c-379b-4b8e-9bbd-76f147f8536f on LeaveGroup",
          "RebalanceSuccess": true,
          "RebalanceTimeConsuming": 1
        }
      ]
    },
    "TopicList": {
      "TopicList": [
        {
          "LastTimestamp": 1566874931649,
          "OffsetList": {
            "OffsetList": [
              {
                "Accumulate": 0,
                "BrokerOffset": 9,
                "ClientId": "client-id-KafkaConsumerDemo",
                "ClientIp": "172.16.11.3",
                "ConsumerOffset": 9,
                "LastTimestamp": 1566874931649,
                "MemberId": "client-id-KafkaConsumerDemo-70b64883-a911-4882-8084-598b958848b4",
                "Partition": 0
              }
            ]
          },
          "Topic": "kafka-test",
          "TotalDiff": 0
        }
      ]
    },
    "TotalDiff": 0,
    "state": "STABLE"
  },
  "Message": "operation success.",
  "RequestId": "252820E1-A2E6-45F2-B4C9-1056B8CE****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Sls.Query.Error	Data query failed. Please try again later.	Data query failed. Please try again later.
400	AgentError	A system exception occurred. Please submit a ticket.	A system exception occurred. Please submit a ticket.
400	AgentBusinessError	Internal error, please try again, if invalid, please submit the work order.	Internal error, please try again, if invalid, please submit the work order.
400	InvalidParameter	The %s parameter is invalid.	The %s parameter failed validation.
400	Acl.AddSasl.Error	Failed to add a user. Please refer to the document and try again. If in doubt, submit a work order.	Failed to add the user. Refer to the documentation and try again. If you have any questions, submit a ticket.
400	Acl.DelSasl.Error	Failed to delete the user. Check the request parameters and try again.	Failed to delete the user. Check the request parameters and try again.
400	Acl.Disable.Error	The Acl function is disabled. Enable it by referring to the documentation and try again.	The Acl function is disabled. Enable it by referring to the documentation and try again.
400	Acl.DuplicatedAuth.Error	The authorization has already been granted, please do not repeat the authorization.	The authorization has already been granted, please do not repeat the authorization.
400	ADMIN_GET_BROKER_CONFIG_ERROR	%s. Please check and try again later.	Failed to obtain the broker configuration. Contact the administrator.
400	ADMIN_UPDATE_BROKER_CONFIG_ERROR	%s. Please check and try again later.	Failed to update the broker configuration. Contact the administrator.
400	ADMIN_UPDATE_SUB_PERM_ERROR	%s. Please check and try again later.	Failed to update the subscription permissions. Contact the administrator.
400	ADMIN_UPDATE_TOPIC_PERM_ERROR	%s. Please check and try again later.	Failed to update the read and write permissions. Contact the administrator.
400	AsyncTask.DeleteTopic	Topic has not been deleted. Please try again later.	Topic has not been deleted. Please try again later.
400	AsyncTask.ExecuteTimeNotSupport	The async task is approaching its execution time and modification is not allowed.	The task is approaching its execution time and cannot be modified. Adjust the time and try again.
400	AsyncTask.Ignored	The task is ignored.	The task is ignored.
400	AsyncTask.NotMeetCondition	The task does not meet the user-defined conditions.	The task does not meet the user-defined conditions.
400	AsyncTask.RetryLater	Task Please try again later.	Task Please try again later.
400	AsyncTask.TypeAlreadyExist	The task already exists.	The task already exists.
400	AsyncTaskSlave.NotCompleted	The task is not completed. Please check and try again.	The task is not completed. Please check and try again.
400	AUTH_CAL_SIGNATURE_ERROR	%s. Please check and try again later.	Failed to calculate the signature.
400	AUTH_CSRF_CHECK_ERROR	%s. Please check and try again later.	The page has expired. Refresh the page.
400	AUTH_LOGIN_CHECK_ERROR	%s. Please check and try again later.	Logon verification failed for the current user. Log on again.
400	AUTH_ONS_CHANNEL_INVALID	%s. Please check and try again later.	The ONS channel is invalid. Verify the channel and try again.
400	AUTH_PERMISSION_CHECK_ERROR	%s. Please check and try again later.	Resource permission verification failed. Verify the resource permission information and try again.
400	AUTH_REQUEST_NOT_ALLOWED	%s. Please check and try again later.	Access is denied for the current request. Do not try again.
400	AUTH_RESOURCE_EMPOWER_CHECK_ERROR	%s. Please check and try again later.	Authorized resource verification failed. Verify the resource ownership information and try again.
400	AUTH_SERVICE_CHECK_ERROR	%s. Please check and try again later.	The current user has not activated the MQ service. Activate the MQ service first.
400	AUTH_SIGNATURE_CHECK_ERROR	%s. Please check and try again later.	Resource request authentication failed. Verify the AccessKeyId and AccessKeySecret and try again.
400	AUTH_SYSTEM_PERMISSION_CHECK_ERROR	%s. Please check and try again later.	Permission verification for creating system resources failed.
400	AUTH_TOPIC_CREATE_ERROR	%s. Please check and try again later.	You do not have the permissions to create topics and consumer groups. Contact the Alibaba Cloud account for authorization.
400	AUTH_USER_IN_BLACK_LIST	%s. Please check and try again later.	Your request has been rejected. Do not try again.
400	BIZ.GET.TOPIC.STATUS.ERROR	AccessKeyId is required to get topic status.	An AccessKeyId is required to call GetTopicStatus.
400	BIZ.INSTANCE.NOT.FOUND	%s. Please check and try again later.	The specified instance ID does not exist.
400	BIZ.INSTANCE.STATUS.ERROR	%s. Please check and try again later.	This operation is not supported in the current instance status.
400	BIZ.LIMIT.PUBNETWORK	EipMax is invalid.	The Internet traffic parameter is invalid.
400	BIZ.LIMIT.QUOTA.DOWN	Invalid.%s	The configuration downgrade failed.
400	BIZ.LIMIT.QUOTA.DOWN.1	Invalid.%s	The configuration downgrade failed.
400	BIZ.LIMIT.QUOTA.DOWN.2	Invalid.%s	The configuration downgrade failed.
400	BIZ.TagResource.NotSupported	%s. Please check and try again later.	The resource does not support tag operations.
400	BIZ_ACL_NOT_ENABLED	%s. Please check and try again later.	The ACL feature is not enabled.
400	BIZ_AONE_CHECK_ERROR	%s. Please check and try again later.	The specified application name does not exist in the Aone system. Verify the name and try again.
400	BIZ_BROADCASTING_PULL_UNSUPPORT	%s. Please check and try again later.	Querying the consumption progress is not supported for PullConsumer or broadcast message subscriptions.
400	BIZ_BROKER_NOT_FOUND	%s. Please check and try again later.	The server node information does not exist.
400	BIZ_CAN_NOT_ENABLE_ACL	%s. Please check and try again later.	The ACL feature cannot be enabled. Verify the prerequisites for enabling ACL.
400	BIZ_CLUSTER_IS_EMPTY	%s. Please check and try again later.	The specified cluster information does not exist. Verify the information or contact the administrator.
400	BIZ_CONSUMER_GROUP_ACTIVE_ERROR	%s. Please check and try again later.	Active consumers exist in the current consumer group. Consume the messages before resetting the offset.
400	BIZ_CONSUMER_ID_BELONG_TO_OTHER_USER	%s. Please check and try again later.	The specified consumer ID is already in use. Use a different consumer ID.
400	BIZ_CONSUMER_NEVER_RUNNING	%s. Please check and try again later.	The specified consumer ID does not exist or has never subscribed to any messages. You cannot view the consumer status.
400	BIZ_CONSUMER_NOT_ONLINE	%s. Please check and try again later.	The current consumer ID is not online.
400	BIZ_CREATE_ORDER_CONFIG_ERROR	%s. Please check and try again later.	Failed to create the ordered message configuration. Try again later.
400	BIZ_CREATE_PUBLISH_ERROR	%s. Please check and try again later.	Failed to create the producer. Try again later.
400	BIZ_CREATE_SUBSCRIPTION_ERROR	%s. Please check and try again later.	Failed to create the consumer ID. Try again later.
400	BIZ_CREATE_TOPIC_ERROR	%s. Please check and try again later.	Failed to create the topic.
400	BIZ_CREATE_TOPIC_NUM_LESS_THAN_BEFORE_ERROR	%s. Please check and try again later.	The number of partitions cannot be less than the previously configured number of partitions.
400	BIZ_DELETE_ORDER_CONFIG_ERROR	%s. Please check and try again later.	Failed to delete the ordered message configuration. Try again later.
400	BIZ_DELETE_SUBSCRIPTION_ERROR	%s. Please check and try again later.	Failed to delete the consumer ID. Try again later.
400	BIZ_DELETE_TOPIC_ERROR	%s. Please check and try again later.	Failed to delete the topic.
400	BIZ_DOWNLOAD_MESSAGE_ERROR	%s. Please check and try again later.	Failed to download the message. Try again later.
400	BIZ_FIELD_CHECK_INVALID	%s. Please check and try again later.	The parameter is invalid.
400	BIZ_FIND_CONSUMER_GROUP_INFO_ERROR	%s. Please check and try again later.	Failed to query the consumer group.
400	BIZ_GET_APPKEY_LIST_ERROR	%s. Please check and try again later.	Failed to retrieve the list of applications for the current ISV. Try again later.
400	BIZ_GET_CLUSTER_INFO_ERROR	%s. Please check and try again later.	Failed to query the cluster information. Try again later.
400	BIZ_GET_CONSUMER_CONNECTION_ERROR	%s. Please check and try again later.	Failed to query the consumer connection. Try again later.
400	BIZ_GET_CONSUMER_RUNNING_INFO_ERROR	%s. Please check and try again later.	Failed to retrieve the running status of the consumer ID. Verify whether the subscription group is online.
400	BIZ_GET_CONSUME_ACCUMULATE_ERROR	%s. Please check and try again later.	Failed to query the message accumulation. Try again later.
400	BIZ_GET_CONSUME_STATUS_ERROR	%s. Please check and try again later.	Failed to query the consumer status. Try again later.
400	BIZ_GET_TOPIC_ROUTE_INFO_ERROR	%s. Please check and try again later.	Failed to retrieve the routing information of the topic. Try again later.
400	BIZ_GET_TOPIC_STATUS_ERROR	%s. Please check and try again later.	Failed to query the topic status. Try again later.
400	BIZ_INSTANCE_ALREADY_EXISTS	%s. Please check and try again later.	The instance already exists.
400	BIZ_INSTANCE_BASIC_INFO_ERROR	%s. Please check and try again later.	The instance information is incorrect.
400	BIZ_INSTANCE_CREATE_ERROR	%s. Please check and try again later.	Failed to create the instance.
400	BIZ_INSTANCE_CREATE_ORDER_ERROR	%s. Please check and try again later.	Failed to create the instance purchase order.
400	BIZ_INSTANCE_DELETE_ERROR	%s. Please check and try again later.	Failed to delete the instance.
400	BIZ_INSTANCE_LOCATION_ERROR	%s. Please check and try again later.	The region ID of the instance is incorrect.
400	BIZ_INSTANCE_NOT_FOUND	%s. Please check and try again later.	The instance does not exist.
400	BIZ_INSTANCE_ONLY_PROFESSIONAL_SUPPORT	%s. Please check and try again later.	This feature is not supported in the non-Professional Edition.
400	BIZ_INSTANCE_OWNER_ERROR	%s. Please check and try again later.	The instance does not belong to the user.
400	BIZ_INSTANCE_PAIDTYPE_NOT_SUPPORT	%s. Please check and try again later.	The instance does not support the specified payment method.
400	BIZ_INSTANCE_PERMISSION_CHECK_ERROR	%s. Please check and try again later.	Failed to verify the permissions on the instance.
400	BIZ_INSTANCE_REFUND_ERROR	%s. Please check and try again later.	Failed to refund the instance.
400	BIZ_INSTANCE_RELEASE_ERROR	%s. Please check and try again later.	Failed to release the instance.
400	BIZ_INSTANCE_RELEASE_EXIST_CONSUMER_GROUP_ERROR	%s. Please check and try again later.	The instance cannot be released because it contains consumer groups.
400	BIZ_INSTANCE_RELEASE_EXIST_TOPIC_ERROR	%s. Please check and try again later.	The instance cannot be released because it contains topics.
400	BIZ_INSTANCE_RELEASE_LESSHOUR_ERROR	%s. Please check and try again later.	An instance can be released only 1 hour after it is created.
400	BIZ_INSTANCE_STATUS_ERROR	%s. Please check and try again later.	The instance status is incorrect.
400	BIZ_INSTANCE_UPDATE_ERROR	%s. Please check and try again later.	Failed to update the instance.
400	BIZ_INSTANCE_UPGRADE_ORDER_ERROR	%s. Please check and try again later.	Failed to create the instance upgrade order.
400	BIZ_MESSAGE_TRACK_ERROR	%s. Please check and try again later.	Failed to query the message trace. Try again later.
400	BIZ_NO_MESSAGE	%s. Please check and try again later.	The message does not exist.
400	BIZ_PRODUCER_ID_BELONG_TO_OTHER_USER	%s. Please check and try again later.	The specified ProducerId is already in use. Use a different ProducerId.
400	BIZ_PUBLISHER_EXISTED	%s. Please check and try again later.	The topic you requested to create already has a producer. Verify the configuration.
400	BIZ_PUBLISH_INFO_NOT_FOUND	%s. Please check and try again later.	The producer information does not exist. Verify the information and try again.
400	BIZ_PUSH_MESSAGE_TO_CONSUMER_ERROR	%s. Please check and try again later.	Failed to verify consumption. Try again later.
400	BIZ_QUERY_CONSUME_TIMESPAN_ERROR	%s. Please check and try again later.	Failed to query the consumer time range. Try again later.
400	BIZ_QUERY_MESSAGE_ERROR	%s. Please check and try again later.	Failed to query the message. Try again later.
400	BIZ_RESET_OFFSET_ERROR	%s. Please check and try again later.	Failed to reset the consumer offset. Try again later.
400	BIZ_SASL_USER_NOT_EXIST	%s. Please check and try again later.	The specified user does not exist.
400	BIZ_SASL_USER_NUM_EXCEED	%s. Please check and try again later.	The number of SASL users exceeds the limit.
400	BIZ_SEND_MESSAGE_ERROR	%s. Please check and try again later.	Failed to send the message. Try again later.
400	BIZ_SLR_CREATE_NO_PERMISSION	%s. Please check and try again later.	The current user does not have the permissions to create a service-linked role.
400	BIZ_SUBSCRIPTION_ALREADY_EXISTS	%s. Please check and try again later.	The consumer group already exists. Try to create a consumer group with a different name.
400	BIZ_SUBSCRIPTION_CREATE_ERROR	%s. Please check and try again later.	Failed to create the consumer group.
400	BIZ_SUBSCRIPTION_DELETE_ERROR	%s. Please check and try again later.	Failed to delete the consumer group.
400	BIZ_SUBSCRIPTION_EXISTED	%s. Please check and try again later.	The consumer you requested to create already exists. Please verify.
400	BIZ_SUBSCRIPTION_NOT_FOUND	%s. Please check and try again later.	The consumer group does not exist.
400	BIZ_SUBSCRIPTION_PERMISSION_CHECK_ERROR	%s. Please check and try again later.	Failed to validate the consumer group.
400	BIZ_SUBSCRIPTION_STATUS_ERROR	%s. Please check and try again later.	Failed to retrieve the consumer group status.
400	BIZ_SUBSCRIPTION_TOO_MUCH	%s. Please check and try again later.	The number of consumer groups exceeds the limit.
400	BIZ_SUBSCRIPTION_UPDATE_ERROR	%s. Please check and try again later.	Failed to update the consumer group.
400	BIZ_TAG_DUPLICATE_TAG_KEY	%s. Please check and try again later.	The tag key is duplicated.
400	BIZ_TAG_ONLY_SERVICE_ACCOUNT_HAS_PERMISSION	%s. Please check and try again later.	Only service accounts have the permission to manage operating system tags.
400	BIZ_TAG_REQUEST_RESOURCE_NUM_EXCEED	%s. Please check and try again later.	The number of resources per request exceeds the limit.
400	BIZ_TAG_REQUEST_TAG_NUM_EXCEED	%s. Please check and try again later.	The number of tags per request exceeds the limit.
400	BIZ_TAG_RESOURCE_NOT_EXIST	%s. Please check and try again later.	The resource does not exist.
400	BIZ_TAG_RESOURCE_NUM_EXCEED	%s. Please check and try again later.	The number of resources bound to the tag exceeds the limit.
400	BIZ_TAG_TAGKEY_NOT_VALID	%s. Please check and try again later.	The format of the tag key is invalid.
400	BIZ_TAG_TAGVALUE_NOT_VALID	%s. Please check and try again later.	The format of the tag value is invalid.
400	BIZ_TAG_TAG_NUM_EXCEED	%s. Please check and try again later.	The number of tags bound to the resource exceeds the limit.
400	BIZ_TIME_SPAN_EMPTY	%s. Please check and try again later.	No messages have been written to the topic subscribed to by the consumer ID. No reset is required.
400	BIZ_TOPIC_ALREADY_EXISTS	%s. Please check and try again later.	The topic already exists. Try to create a topic with a different name.
400	BIZ_TOPIC_COMPACT_TOPIC_NOT_SUPPORT	%s. Please check and try again later.	Creating compact topics is not supported.
400	BIZ_TOPIC_CREATE_ERROR	%s. Please check and try again later.	Failed to create the topic.
400	BIZ_TOPIC_CREATE_INTERNAL_ERROR	%s. Please check and try again later.	The topic name cannot start with "__".
400	BIZ_TOPIC_DELETE_ERROR	%s. Please check and try again later.	Failed to delete the topic.
400	BIZ_TOPIC_EXISTED	%s. Please check and try again later.	The specified topic already exists.
400	BIZ_TOPIC_LOCAL_TOPIC_NOT_SUPPORT	%s. Please check and try again later.	Creating local topics is not supported.
400	BIZ_TOPIC_NOT_FOUND	%s. Please check and try again later.	The topic does not exist.
400	BIZ_TOPIC_OFFSET_ERROR	%s. Please check and try again later.	Failed to query the offset.
400	BIZ_TOPIC_PARTITION_ADD_ERROR	%s. Please check and try again later.	Failed to add the partition.
400	BIZ_TOPIC_PARTITION_ERROR	%s. Please check and try again later.	The partition does not exist.
400	BIZ_TOPIC_PARTITION_NUM_EXCEED	%s. Please check and try again later.	The number of partitions exceeds the limit.
400	BIZ_TOPIC_STATUS_ERROR	%s. Please check and try again later.	Failed to retrieve the topic status.
400	BIZ_TOPIC_TOO_MUCH	%s. Please check and try again later.	The number of topics exceeds the limit.
400	BIZ_TOPIC_UPDATE_CONFIG_ERROR	%s. Please check and try again later.	Failed to update the topic configuration.
400	BIZ_TOPIC_UPDATE_ERROR	%s. Please check and try again later.	The topic update failed.
400	BIZ_UPDATE_ACL_FAILED	%s. Please check and try again later.	The ACL modification failed. Try again later.
400	BIZ_UPDATE_SUBSCRIPTION_ERROR	%s. Please check and try again later.	The consumer ID update failed. Try again later.
400	BIZ_UPDATE_TOPIC_ERROR	%s. Please check and try again later.	The topic update failed. Try again later.
400	BIZ_UPDATE_TOPIC_PERM_ERROR	%s. Please check and try again later.	The permission information update for the topic failed.
400	DataExceedMaxLimit	The maximum number of %s is exceeded.	The number of %s exceeds the limit.
400	DB.Update.Failed	Failed to update data, please try again, if invalid, please submit a work order.	Failed to update data, please try again, if invalid, please submit a work order.
400	Deploy.Callback.Illegal	Message data does not match, please submit work order.	Message data does not match, please submit work order.
400	Deploy.NotRetriableError	Deployment error, please submit work order.	Deployment error, please submit work order.
400	Deploy.ResourceNotEnough	Insufficient resources, please submit work order.	Insufficient resources, please submit work order.
400	Deploy.RetriableError	A retry error occurred during deployment. If the retry still fails, submit a work order.	A retry error occurred during deployment. If the retry still fails, submit a work order.
400	DeployError	Deployment error, please try again, if invalid, please submit a work order.	Deployment error, please try again, if invalid, please submit a work order.
400	DeployPreCheckError	Deployment pre-check failed. Please submit work order.	The deployment pre-check failed. Please try again. If the retry still fails, please submit a ticket.
400	DeployType.NotSupport	deployType is not supported. Refer to the document and retry. If in doubt, submit a work order.	deployType is not supported. Refer to the document and retry. If in doubt, submit a work order.
400	FlowControl	Request was denied due to flow control.	The resource is throttled. Try again later.
400	GET.CONSUMER.MISSING.ACCESS.KEY.ID	AccessKeyId is required to get consumer group info.	An AccessKey ID is required to obtain consumer group information.
400	Group.Active	Group is active and cannot perform this operation.	Group is active and cannot perform this operation.
400	Instance.CaclulateChange.time	Example Failed to obtain the expected change time. Please try again later.	Example Failed to obtain the expected change time. Please try again later.
400	Instance.Change.NotAllowed	This instance does not allow change operations.	This instance does not allow change operations.
400	Instance.ExceedMaxLimit	The maximum number of instance is exceeded.	The number of instances for a single account exceeds the limit. To increase the quota, submit a ticket.
400	Instance.InsertComponent.fail	Failed to insert the instance component, please try again later.	Failed to insert the instance component, please try again later.
400	Instance.ResourceNotSufficient	Insufficient resources, unable to operate, please submit a work order.	Insufficient resources, unable to operate, please submit a work order.
400	Instance.StatusNotRunning	The instance is not running and cannot operate this function. Please try again later.	The instance is not running and cannot operate this function. Please try again later.
400	Instance.UpdateComponent.fail	Failed to update the instance component, please try again later.	Failed to update the instance component, please try again later.
400	Instance.UpgradeService.version	Upgrade version failed, please try again later.	Upgrade version failed, please try again later.
400	InstanceStatus.Change.NotAllowed	There was an error in the instance status switch verification. Please try again. If you have any questions, please submit the work order.	There was an error in the instance status switch verification. Please try again. If you have any questions, please submit the work order.
400	InstanceStatus.NotAllowed	The current status of the instance cannot be changed. This function cannot be performed. Please try again later.	The current status of the instance cannot be changed. This function cannot be performed. Please try again later.
400	InstanceStatus.NotReleased	The instance is not in the released state and cannot perform this function. Please try again later.	The instance is not in the released state and cannot perform this function. Please try again later.
400	InstanceStatus.NotWaitChange	The instance is not waiting for change status, cannot operate this function, please try again later.	The instance is not waiting for change status, cannot operate this function, please try again later.
400	InstanceStatus.NotWaitDeploy	This function cannot be performed because the instance is not in the state to be deployed. Please try again later.	This function cannot be performed because the instance is not in the state to be deployed. Please try again later.
400	InstanceStatus.Released	The instance has been released.	The instance has been released.
400	InstanceStatus.Stopped	Instance stopped serving.	Instance stopped serving.
400	Invalid.%s	Invalid.%s	The parameter is invalid.
400	Invalid.Partition.%s	Invalid.%s	The number of partitions does not match the topic.
400	InvalidParameter.DataAlreadyExist	The data already exists for the %s parameter.	The data corresponding to the %s parameter already exists.
400	InvalidParameter.DataNotChange	There is no change in the parameters. Please adjust and try again.	There is no change in the parameters. Please adjust and try again.
400	InvalidParameter.NotSupport	The %s parameter is not supported.	The %s parameter is not currently supported.
400	InvalidParameter.OtherParam	Parameter %s is incorrect because %s.	Parameter %s is incorrect because %s.
400	InvalidParameter.Range	The value of the %s parameter is not within the specified range.	The value of the %s parameter is out of range. It must be between %s and %s.
400	InvalidParameter.Size	The size of the %s parameter is not within the specified range.	The length of the %s parameter failed validation.
400	InvalidParameter.VersionNotSupport	Current version does not support the %s parameter.	The current version does not support the %s parameter.
400	Ldap.CreateAdminError	Administrative accounts cannot be added or modified.	Administrative accounts cannot be added or modified.
400	Ldap.DeleteAdminError	The management account cannot be deleted.	The management account cannot be deleted.
400	Manager.configRuleExistError	Manager an existing configuration rule is inserted, adjust and try again.	Manager an existing configuration rule is inserted, adjust and try again.
400	Manager.configRuleNotExistError	Manager a configuration rule that does not exist is changed, please adjust it and try again.	Manager a configuration rule that does not exist is changed, please adjust it and try again.
400	Manager.NotCommit	Manager operation is not submitted, please adjust and try again.	Manager operation is not submitted, please adjust and try again.
400	Manager.recoverTaskNotFound	Manager the resumed scheduling task does not exist, please adjust and try again.	Manager the resumed scheduling task does not exist, please adjust and try again.
400	Manager.recoverTaskNotMatch	The id of the restored scheduling task does not match that of the instance.	Manager the resumed scheduling task does not match the instance ID, adjust the task and try again.
400	Manager.scheduledTaskStatusError	Manager the status of the asynchronous task fails to be changed, check whether the source status is consistent with the current status, and then try again.	Manager the status of the asynchronous task fails to be changed, check whether the source status is consistent with the current status, and then try again.
400	Manager.scheduledTaskStatusNotSupport	The manager operation task status is unknown.	Manager action task status is unknown.
400	MissingParameter	The %s parameter is required.	The parameter %s is missing.
400	NotSupport	The current operation is not supported, please check and try again later.	The current operation is not supported, please check and try again later.
400	NotSupport.DataStatus	Current status %s does not support this operation.	This operation is not supported when the data is in the %s state.
400	ONS.LOGIN.CHECK.ERROR	%s. Please check and try again later.	Your logon session has expired. Log on again.
400	ONS_INIT_ENV_ERROR	%s. Please check and try again later.	A fault occurred during the initialization of the environment context. Contact the system administrator.
400	ONS_INTERNAL_ERROR	%s. Please check and try again later.	Network connectivity failed. Contact the system administrator.
400	ONS_INVOKE_ERROR	%s. Please check and try again later.	Failed to invoke the API. Contact the system administrator.
400	ONS_LOGIN_CHECK_ERROR	%s. Please check and try again later.	Your logon session has expired. Log on again.
400	ONS_SERVICE_UNSUPPORTED	%s. Please check and try again later.	This request is not currently supported. Contact the system administrator.
400	ONS_SYSTEM_ERROR	%s. Please check and try again later.	A system processing fault occurred. Contact the system administrator.
400	ONS_SYSTEM_FLOW_CONTROL	%s. Please check and try again later.	Too many requests are being processed. Try again later.
400	Order.Create.Error	Failed to create order.	Failed to create order.
400	Order.Insufficient.balance	The available gold is not enough, please recharge and try again.	The available gold is not enough, please recharge and try again.
400	Oss.NotFound	Failed to download message, please try again later.	Failed to download message, please try again later.
400	Oss.PublishFailed	Failed to download message, please try again later.	Failed to download message, please try again later.
400	RAM.USER.NOT.FOUND.BY.ACCESSKEY	The specified access key is not found.	The AccessKey ID does not exist.
400	RAM_CREATE_RESOURCE_OWNER_ERROR	%s. Please check and try again later.	Failed to create the resource ownership information. Try again later.
400	RAM_CREATE_RESOURCE_PERMISSION_ERROR	%s. Please check and try again later.	Failed to create the resource permission information. Try again later.
400	RAM_DELETE_RESOURCE_OWNER_ERROR	%s. Please check and try again later.	Failed to delete the resource ownership information. Try again later.
400	RAM_DELETE_RESOURCE_PERMISSION_ERROR	%s. Please check and try again later.	Failed to delete the resource permission information. Try again later.
400	RAM_GET_USER_BY_AK_ERROR	%s. Please check and try again later.	Failed to obtain the user AccessKey information. Try again later.
400	RAM_USER_NOT_FOUND_BY_ACCESSKEY	%s. Please check and try again later.	The user information does not exist. Verify the AccessKey.
400	ScheduledTask.AlreadyHasSameTaskType	has same task waiting for schedule.	The same task is waiting to be scheduled, please try again later.
400	ScheduledTask.ExecuteTimeGapTooShort	execute time gap too close to an existed task.	The execution time interval is too close to the existing task. Please adjust and try again.
400	ServerlessPlan.InstanceNotMatch	The timing policy execution plan does not match the instance ID.	The timing policy execution plan does not match the instance ID.
400	ServerlessPlan.IntervalInvalid	If a periodic policy execution plan is smaller than the target size, delete it.	If a periodic policy execution plan is smaller than the target size, delete it.
400	ServerlessPlan.NameExist	The name of the periodic policy execution plan is the same. Please modify the name and try again.	The name of the periodic policy execution plan is the same. Please modify the name and try again.
400	ServerlessPlan.NotSupport.EnabledRuleExist	If a periodic policy is in effect, it does not support the current operation. Set all periodic policies to invalid.	If a periodic policy is in effect, it does not support the current operation. Set all periodic policies to invalid.
400	ServerlessPlan.NotSupport.StatusEnabled	A periodic policy can be deleted only after it is disabled.	A periodic policy can be deleted only after it is disabled.
400	ServerlessPlan.TaskStatusNotSupport	A periodic policy task cannot be modified or cancelled when it is being executed or when a single execution is completed.	A scheduled policy task cannot be modified or canceled when it is being executed or a single execution is completed.
400	Sts.NotFound	Unable to find the whitelist information, please try again later, if in doubt, please submit the work order.	Unable to find the whitelist information, please try again later, if in doubt, please submit the work order.
400	Topic.DownloadMessageFail	Failed to download message, please try again later.	Failed to download message, please try again later.
400	Topic.Exist	The topic already exists.	The topic already exists.
400	Topic.NotFound	The Topic does not exist. Please check and try again.	The Topic does not exist. Please check and try again.
400	Topic.QueryMessageFail	Failed to query the message, please try again later.	Failed to query the message, please try again later.
400	Topic.SendFail	Topic failed to send a message. Please try again later.	Topic failed to send a message. Please try again later.
400	Topic.StatusNotRunning	The Topic status is not in the service and cannot be operated. Please try again later. If in doubt, please submit the work order.	The Topic status is not in the service and cannot be operated. Please try again later. If in doubt, please submit the work order.
400	TopicStatus.NotAllowed	The current status of the Topic cannot be changed.	The current status of the Topic cannot be changed.
400	VPC_ASSUMEROLE_ERROR	%s. Please check and try again later.	You are not authorized.
400	VPC_VSW_ZONE_MAPPING_ERROR	%s. Please check and try again later.	The vSwitch or security group failed validation.
400	WHITE.DELETE.ERROR	%s. Please check and try again later.	Only one allowed IP address can be specified for deletion.
400	WHITE.IP.ALREADY.EXISTS.ERROR	%s. Please check and try again later.	The specified IP address already exists.
400	WHITE.IP.ILLEGAL.ERROR	%s. Please check and try again later.	The specified allowed IP address is invalid.
400	WHITE.IPLIST.OVERLONG.ERROR	%s. Please check and try again later.	The total number of IP addresses in the list exceeds the maximum limit of 200.
400	WHITE.OVER.LENGTH.ERROR	%s. Please check and try again later.	The number of allowed IP addresses exceeds the maximum limit of 10.
400	WHITE.PARAM.ERROR	%s. Please check and try again later.	The specified parameter is invalid.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the resource you selected, please pay or void it before placing the order.	There is an unpaid order for the resource you selected, please pay or void it before placing the order!
400	Topic.RebalanceOperationForbidden	This operation is not allowed during instance drainage. Please try again after the drainage is completed.	This operation is not allowed during instance drainage. Please try again after the drainage is completed.
400	AUTH_USER_CHECK_ERROR	Network jitter timed out, try refreshing and retry.	Network jitter timed out, try refreshing and retry.
400	WHITE_IP_LIST_OVERLONG_ERROR	KafkaInstanceBiz updateWhiteList allIpList is overlong.	Update whitelist list too long
400	BIZ_GET_TOPIC_OFFSET_ERROR	getTopicOffset error.	Error obtaining topic partition site
400	BIZ_PARAM_EMPTY	param is blank.	The input parameter cannot be empty.
400	BIZ_INSTANCE_CANNOT_OPERATE	Unable to operate during instance maintenance.	Unable to operate during instance maintenance. Please try again later.
400	RemoteCallError	An internal service invocation error occurred. Please try again later.	A remote call error occurred.
400	InvalidParameter.Format	The %s format is invalid.	The format of the %s parameter failed validation.
400	Inner.Owner.notAllowed	inner account not allowed.	Internal users cannot purchase
400	Topic.Inner.NotAllowOperate	Internal topics do not allow operations.	Operation not allowed for internal topic
400	BIZ_INSTANCE_DEPLOY_ERROR	Unknown error occurred %s.	An unknown error has occurred
400	Deploy.IpNotEnough.Error	User VSwitch available ip not enough. You can try to select other VSwitch when deploy new instance.	The user VSwitch has insufficient Ip available, and you can try to choose a different VSwitch when deploying a new instance.
400	Deploy.InvalidPreCheckConditionCpuUsage.Error	The CPU load is high, and the pre-check fails.	The CPU water level is high, and the pre-inspection is not passed.
400	BIZ_INSTANCE_IP_NOT_ENOUGH	User VSwitch available ip not enough. You can try to select other VSwitch when deploy new instance.	Insufficient IP available for user VSwitch. You can try to choose a different VSwitch when deploying a new instance.
400	BIZ_INSTANCE_INVALID_PRE_CHECK_CONDITION_CPU_USAGE	The CPU load is high, and the pre-check fails.	CPU load too high, precheck failed.
400	InternalError	A system exception occurred. Please submit a ticket.	An internal error occurred.
400	BIZ_INSTANCE_DEPLOY_TIMEOUT	%s Please try again later.	Please try again later.
400	BIZ_INSTANCE_DEPLOY_CAPACITY_RESERVATION_ERROR	%s Please try again later.	Insufficient stock, please try again later or submit a work order
403	NoPermission	No permissions.	You do not have the required permissions.
403	AUTH_RESOURCE_OWNER_ERROR	%s. Please check and try again later.	Resource ownership verification failed. Verify the resource ownership information and try again.
404	InstanceAgent.NotFound	Instance does not exist. Please check the entry and try again.	Instance does not exist. Please check the entry and try again.
404	InvalidParameter.DataNotFound	No data found for the %s parameter.	No data was found for the %s parameter.
404	AsyncTaskGroup.NotFound	The task group does not exist. Please check and try again.	The task group does not exist. Please check and try again.
404	AsyncTaskHandler.NotFound	The task does not exist. Please check and try again.	The task does not exist. Please check and try again.
404	AsyncTaskType.NotFound	The task type does not exist. Please check and try again.	The task type does not exist. Please check and try again.
404	Group.NotFound	GroupId does not exist. Please check and try again.	GroupId does not exist. Please check and try again.
404	Instance.NotFound	No instance found for the %s parameter.	The instance does not exist. Verify the input parameters and try again.
404	InvalidData.FieldsIncomplete	Data is incomplete, %s data is missing, please check and try again later.	Data is incomplete, %s data is missing, please check and try again later.
404	Topic.NotFound	No topic found for the %s parameter.	The topic does not exist. Check the topic and try again.
404	VpcVSwitch.NotFound	The private network and switch do not exist. Please refer to the document and try again. If in doubt, submit a work order.	The private network and switch do not exist. Please refer to the document and try again. If in doubt, submit a work order.
404	SG_ERROR	find sgInfo error, please retry later.	Failed to find the security group. Make sure that the information is correct and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.