All Products
Search
Document Center

ApsaraMQ for Kafka:GetInstanceList

Last Updated:Dec 18, 2024

Queries the information about instances in a specified region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
alikafka:ListInstanceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the instance resides.

cn-hangzhou
OrderIdstringNo

The ID of the order. You can obtain the order ID on the Orders page in Alibaba Cloud User Center.

6072673****
InstanceIdarrayNo

The IDs of instances.

stringNo

The ID of the instance.

alikafka_post-cn-mp91gnw0****
Tagarray<object>No

The tags.

objectNo
KeystringNo

The tag key.

  • If you leave this parameter empty, the keys of all tags are matched.
  • The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.
test
ValuestringNo

The tag value.

  • If you leave Key empty, you must also leave this parameter empty. If you leave this parameter empty, the values of all tags are matched.
  • The tag value can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.
test
ResourceGroupIdstringNo

The ID of the resource group. You can obtain this ID on the Resource Group page in the Resource Management console.

rg-ac***********7q
SeriesstringNo

The instance version. You can use instance versions to filter different versions of instances. Valid values:

  • v2
  • v3
  • confluent
v3

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code returned. The HTTP status code 200 indicates that the call is successful.

200
Messagestring

The message returned.

operation success.
RequestIdstring

The ID of the region.

4B6D821D-7F67-4CAA-9E13-A5A997C3****
Successboolean

Indicates whether the call was successful.

true
InstanceListarray<object>

The instances.

InstanceVOobject
VpcIdstring

The virtual private cloud (VPC) ID.

vpc-bp1ojac7bv448nifj****
SpecTypestring

The instance edition. Valid values:

  • professional: Professional Edition (High Write)
  • professionalForHighRead: Professional Edition (High Read)
  • normal: Standard Edition
professional
DeployTypeinteger

The type of the network in which the instance is deployed. Valid values:

  • 4: Internet and VPC
  • 5: VPC
5
CreateTimelong

The time when the instance was created. Unit: milliseconds.

1577961819000
DiskSizeinteger

The disk size. Unit: GB

3600
DiskTypeinteger

The disk type of the instance. Valid values:

  • 0: ultra disk
  • 1: standard SSD
1
SecurityGroupstring

The security group to which the instance belongs.

  • If the instance is deployed in the ApsaraMQ for Kafka console or by calling the StartInstance operation without a security group configured, no value is returned.
  • If the instance is deployed by calling the StartInstance operation with a security group configured, the returned value is the configured security group.
sg-bp13wfx7kz9pkow****
SslEndPointstring

The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
192.0.XX.XX:9093,198.51.XX.XX:9093,203.0.XX.XX:9093
InstanceIdstring

The instance ID.

alikafka_pre-cn-mp919o4v****
AllConfigstring

The configurations of the deployed ApsaraMQ for Kafka instance.

{\"enable.vpc_sasl_ssl\":\"false\",\"kafka.log.retention.hours\":\"66\",\"enable.acl\":\"false\",\"kafka.message.max.bytes\":\"6291456\"}
ServiceStatusinteger
Note This parameter is out of date. We recommend that you refer to the ViewInstanceStatusCode parameter.

The instance status. Valid values:

  • 0: pending
  • 1: preparing hardware resources
  • 2: initializing
  • 3: starting
  • 5: running
  • 6: migrating
  • 7: ready for upgrade
  • 8: upgrading
  • 9: ready for change
  • 10: released
  • 11: changing
  • 15: expired
  • 30: scaling
5
EipMaxinteger

The maximum Internet traffic in the instance.

20
RegionIdstring

The ID of the region where the instance resides.

cn-hangzhou
MsgRetaininteger

The retention period of messages in the instance. Unit: hours.

72
VSwitchIdstring

The ID of the vSwitch to which the instance belongs.

vsw-bp1fvuw0ljd7vzmo3****
ExpiredTimelong

The time when the instance expires. Unit: milliseconds.

1893581018000
TopicNumLimitinteger

The maximum number of topics on the instance.

180
ZoneIdstring

The zone ID.

zonei
IoMaxReadinteger

The maximum read traffic in the instance. Unit: Mbit/s.

1000
IoMaxWriteinteger

The maximum write traffic. Unit: Mbit/s.

1000
IoMaxinteger

The maximum traffic in the instance.

20
PaidTypeinteger

The billing method of the instance. Valid values:

  • 0: the subscription billing method
  • 1: the pay-as-you-go billing method
  • 3: the pay-as-you-go billing method for serverless ApsaraMQ for Kafka V3 instances
  • 4: the pay-as-you-go billing method for ApsaraMQ for Confluent instances
1
Namestring

The instance name.

alikafka_post-cn-mp91gnw0****
EndPointstring

The default endpoint of the instance in IP address mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092
Tagsarray<object>

The tags.

TagVOobject
Keystring

The tag key.

test
Valuestring

The tag value.

test
UpgradeServiceDetailInfoobject

The upgrade information about the instance.

Current2OpenSourceVersionstring

The open source Apache Kafka version that corresponds to the instance.

2.2.0
DomainEndpointstring

The default endpoint of the instance in domain name mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9092
VpcSaslEndPointstring

The Secure Sockets Layer (SSL) endpoint of the instance in IP address mode. You can use the endpoint to access the instance only in virtual private clouds (VPCs). ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
172.16.3.XX:9095,172.16.3.XX:9095,172.16.3.XX:9095
SaslEndPointstring

The Simple Authentication and Security Layer (SASL) endpoint of the instance in IP address mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
172.16.3.XX:9094,172.16.3.XX:9094,172.16.3.XX:9094
SslDomainEndpointstring

The SSL endpoint of the instance in domain name mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
alikafka-pre-cn-zv**********-1.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-2.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-3.alikafka.aliyuncs.com:9093
SaslDomainEndpointstring

The Simple Authentication and Security Layer (SASL) endpoint of the instance in domain name mode. ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9094
VpcSaslDomainEndpointstring

The SSL endpoint of the instance in domain name mode. You can use the endpoint to access the instance only in virtual private clouds (VPCs). ApsaraMQ for Kafka instances support endpoints in domain name mode and IP address mode.

  • Endpoints in domain name mode: An endpoint in this mode consists of the domain name of the instance and a port number. The format of an endpoint in this mode is {Instance domain name}:{Port number}.
  • Endpoints in IP address mode: An endpoint in this mode consists of the IP address of the broker and a port number. The format of an endpoint in this mode is {Broker IP address}:{Port number}.
alikafka-post-cn-******-1-vpc.alikafka.aliyuncs.com:9095,alikafka-post-cn-******-2-vpc.alikafka.aliyuncs.com:9095,alikafka-post-cn-******-3-vpc.alikafka.aliyuncs.com:9095
ResourceGroupIdstring

The ID of the resource group.

rg-ac***********7q
UsedTopicCountinteger

The number of used topics.

3
UsedGroupCountinteger

The number of used groups.

10
UsedPartitionCountinteger

The number of used partitions.

25
KmsKeyIdstring

The ID of the key that is used for disk encryption in the region where the instance is deployed.

0d24xxxx-da7b-4786-b981-9a164dxxxxxx
StandardZoneIdstring

The zone ID.

cn-hangzhou-k
IoMaxSpecstring

The traffic specification.

alikafka.hw.2xlarge
ReservedPublishCapacityinteger

The traffic reserved for message publishing. Unit: MB/s.

Note This parameter is returned only if the instance is a serverless ApsaraMQ for Kafka V3 instance.
60
ReservedSubscribeCapacityinteger

The traffic reserved for message subscription. Unit: MB/s.

Note This parameter is returned only if the instance is a serverless ApsaraMQ for Kafka V3 instance.
60
ViewInstanceStatusCodeinteger

The instance status. The valid values are consistent with the values displayed in the ApsaraMQ for Kafka console. This parameter is used in the new version of ApsaraMQ for Kafka.

Valid values:

  • 0: pending
  • 1: deploying
  • 2: running
  • 3: stopped
  • 4: expiring
  • 5: expired
  • 6: released
  • 7: upgrading
  • 8: migrating
  • 21: stopping
  • 22: starting
  • 23: releasing
  • 30: auto scaling
  • 101: deployment failed
  • 102: upgrade failed
  • 103: migration failed
2
ConfluentConfigobject

The parameters that are returned for the ApsaraMQ for Confluent instance.

KafkaCUinteger

The number of CPU cores of the Kafka broker.

4
KafkaStorageinteger

The disk capacity of the Kafka broker. Unit: GB.

800
KafkaReplicainteger

The number of replicas of the Kafka broker.

3
ZooKeeperCUinteger

The number of CPU cores of ZooKeeper.

2
ZooKeeperStorageinteger

The disk capacity of ZooKeeper. Unit: GB.

100
ZooKeeperReplicainteger

The number of replicas of ZooKeeper.

3
ControlCenterCUinteger

The number of CPU cores of Control Center.

4
ControlCenterStorageinteger

The disk capacity of Control Center. Unit: GB.

300
ControlCenterReplicainteger

The number of replicas of Control Center.

1
SchemaRegistryCUinteger

The number of CPU cores of Schema Registry.

4
SchemaRegistryReplicainteger

The number of replicas of Schema Registry.

2
ConnectCUinteger

The number of CPU cores of Connect.

4
ConnectReplicainteger

The number of replicas of Connect.

2
KsqlCUinteger

The number of CPU cores of ksqlDB.

2
KsqlStorageinteger

The disk capacity of ksqlDB. Unit: GB.

100
KsqlReplicainteger

The number of replicas of ksqlDB.

2
KafkaRestProxyCUinteger

The number of CPU cores of Kafka Rest Proxy.

4
KafkaRestProxyReplicainteger

The number of replicas of Kafka Rest Proxy.

2
Seriesstring

The instance version. Valid values: v2, v3, and confluent.

v3
AutoCreateGroupEnableboolean

Indicates whether the flexible group creation feature is enabled.

true
AutoCreateTopicEnableboolean

Indicates whether the automatic topic creation feature is enabled.

true
VSwitchIdsarray

The vSwitch IDs.

VSwitchIdsstring

The vSwitch ID.

vsw-2zeiaqw75olqygldpcjst
DefaultPartitionNuminteger

The number of partitions in a topic that is automatically created.

12
BackupZoneIdstring

The ID of the secondary zone.

cn-hangzhou-a

AllConfig parameters

ParameterTypeValid valueExampleDescription
enable.vpc_sasl_sslBoolean- true- falsefalseSpecifies whether to enable the virtual private cloud (VPC) transmission encryption feature. If the VPC transmission encryption feature is enabled, you must also enable the access control list (ACL) feature.
kafka.log.retention.hoursInteger24 to 48066The retention period of messages. Unit: hours.
enable.aclBoolean- true- falsefalseSpecifies whether to enable the ACL feature.
kafka.message.max.bytesInteger1048576 to 104857606291456The maximum size of a message. Unit: bytes.

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "4B6D821D-7F67-4CAA-9E13-A5A997C3****",
  "Success": true,
  "InstanceList": {
    "InstanceVO": [
      {
        "VpcId": "vpc-bp1ojac7bv448nifj****",
        "SpecType": "professional",
        "DeployType": 5,
        "CreateTime": 1577961819000,
        "DiskSize": 3600,
        "DiskType": 1,
        "SecurityGroup": "sg-bp13wfx7kz9pkow****",
        "SslEndPoint": "192.0.XX.XX:9093,198.51.XX.XX:9093,203.0.XX.XX:9093",
        "InstanceId": "alikafka_pre-cn-mp919o4v****",
        "AllConfig": "{\\\"enable.vpc_sasl_ssl\\\":\\\"false\\\",\\\"kafka.log.retention.hours\\\":\\\"66\\\",\\\"enable.acl\\\":\\\"false\\\",\\\"kafka.message.max.bytes\\\":\\\"6291456\\\"}",
        "ServiceStatus": 5,
        "EipMax": 20,
        "RegionId": "cn-hangzhou",
        "MsgRetain": 72,
        "VSwitchId": "vsw-bp1fvuw0ljd7vzmo3****",
        "ExpiredTime": 1893581018000,
        "TopicNumLimit": 180,
        "ZoneId": "zonei",
        "IoMaxRead": 1000,
        "IoMaxWrite": 1000,
        "IoMax": 20,
        "PaidType": 1,
        "Name": "alikafka_post-cn-mp91gnw0****",
        "EndPoint": "192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092",
        "Tags": {
          "TagVO": [
            {
              "Key": "test",
              "Value": "test"
            }
          ]
        },
        "UpgradeServiceDetailInfo": {
          "Current2OpenSourceVersion": "2.2.0"
        },
        "DomainEndpoint": "alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9092",
        "VpcSaslEndPoint": "172.16.3.XX:9095,172.16.3.XX:9095,172.16.3.XX:9095",
        "SaslEndPoint": "172.16.3.XX:9094,172.16.3.XX:9094,172.16.3.XX:9094",
        "SslDomainEndpoint": "alikafka-pre-cn-zv**********-1.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-2.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-3.alikafka.aliyuncs.com:9093",
        "SaslDomainEndpoint": "alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9094",
        "VpcSaslDomainEndpoint": "alikafka-post-cn-******-1-vpc.alikafka.aliyuncs.com:9095,alikafka-post-cn-******-2-vpc.alikafka.aliyuncs.com:9095,alikafka-post-cn-******-3-vpc.alikafka.aliyuncs.com:9095",
        "ResourceGroupId": "rg-ac***********7q\n",
        "UsedTopicCount": 3,
        "UsedGroupCount": 10,
        "UsedPartitionCount": 25,
        "KmsKeyId": "0d24xxxx-da7b-4786-b981-9a164dxxxxxx",
        "StandardZoneId": "cn-hangzhou-k",
        "IoMaxSpec": "alikafka.hw.2xlarge",
        "ReservedPublishCapacity": 60,
        "ReservedSubscribeCapacity": 60,
        "ViewInstanceStatusCode": 2,
        "ConfluentConfig": {
          "KafkaCU": 4,
          "KafkaStorage": 800,
          "KafkaReplica": 3,
          "ZooKeeperCU": 2,
          "ZooKeeperStorage": 100,
          "ZooKeeperReplica": 3,
          "ControlCenterCU": 4,
          "ControlCenterStorage": 300,
          "ControlCenterReplica": 1,
          "SchemaRegistryCU": 4,
          "SchemaRegistryReplica": 2,
          "ConnectCU": 4,
          "ConnectReplica": 2,
          "KsqlCU": 2,
          "KsqlStorage": 100,
          "KsqlReplica": 2,
          "KafkaRestProxyCU": 4,
          "KafkaRestProxyReplica": 2
        },
        "Series": "v3",
        "AutoCreateGroupEnable": true,
        "AutoCreateTopicEnable": true,
        "VSwitchIds": {
          "VSwitchIds": [
            "vsw-2zeiaqw75olqygldpcjst"
          ]
        },
        "DefaultPartitionNum": 12,
        "BackupZoneId": "cn-hangzhou-a"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Acl.AddSasl.ErrorFailed to add a user. Please refer to the document and try again. If in doubt, submit a work order.Failed to add a user. Please refer to the document and try again. If in doubt, submit a work order.
400Acl.DelSasl.ErrorFailed to delete the user. Check the request parameters and try again.Failed to delete the user. Check the request parameters and try again.
400Acl.Disable.ErrorThe 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.
400Acl.DuplicatedAuth.ErrorThe authorization has already been granted, please do not repeat the authorization.The authorization has already been granted, please do not repeat the authorization.
400ADMIN_GET_BROKER_CONFIG_ERROR%s. Please check and try again later.-
400ADMIN_UPDATE_BROKER_CONFIG_ERROR%s. Please check and try again later.-
400ADMIN_UPDATE_SUB_PERM_ERROR%s. Please check and try again later.-
400ADMIN_UPDATE_TOPIC_PERM_ERROR%s. Please check and try again later.-
400AgentBusinessErrorInternal error, please try again, if invalid, please submit the work order.Internal error, please try again, if invalid, please submit the work order.
400AgentErrorA system exception occurred. Please submit a ticket.A system exception occurred. Please submit a ticket.
400AsyncTask.DeleteTopicTopic has not been deleted. Please try again later.Topic has not been deleted. Please try again later.
400AsyncTask.ExecuteTimeNotSupportThe async task is approaching its execution time and modification is not allowed.-
400AsyncTask.ExecuteTimeNotSupportThe task cannot be modified because it is close to its execution time. Please adjust and try again.The task cannot be modified because it is close to its execution time. Please adjust and try again.
400AsyncTask.IgnoredThe task is ignored.The task is ignored.
400AsyncTask.NotMeetConditionThe task does not meet the user-defined conditions.The task does not meet the user-defined conditions.
400AsyncTask.RetryLaterTask Please try again later.Task Please try again later.
400AsyncTask.TypeAlreadyExistThe task already exists.The task already exists.
400AsyncTaskSlave.NotCompletedThe task is not completed. Please check and try again.The task is not completed. Please check and try again.
400AUTH_CAL_SIGNATURE_ERROR%s. Please check and try again later.-
400AUTH_CSRF_CHECK_ERROR%s. Please check and try again later.-
400AUTH_LOGIN_CHECK_ERROR%s. Please check and try again later.-
400AUTH_ONS_CHANNEL_INVALID%s. Please check and try again later.-
400AUTH_PERMISSION_CHECK_ERROR%s. Please check and try again later.-
400AUTH_REQUEST_NOT_ALLOWED%s. Please check and try again later.-
400AUTH_RESOURCE_EMPOWER_CHECK_ERROR%s. Please check and try again later.-
400AUTH_SERVICE_CHECK_ERROR%s. Please check and try again later.-
400AUTH_SIGNATURE_CHECK_ERROR%s. Please check and try again later.-
400AUTH_SYSTEM_PERMISSION_CHECK_ERROR%s. Please check and try again later.-
400AUTH_TOPIC_CREATE_ERROR%s. Please check and try again later.-
400AUTH_USER_CHECK_ERROR%s. Please check and try again later.-
400AUTH_USER_IN_BLACK_LIST%s. Please check and try again later.-
400BIZ.GET.TOPIC.STATUS.ERRORAccessKeyId is required to get topic status.-
400BIZ.INSTANCE.NOT.FOUND%s. Please check and try again later.-
400BIZ.INSTANCE.STATUS.ERROR%s. Please check and try again later.-
400BIZ.LIMIT.PUBNETWORKEipMax is invalid.-
400BIZ.LIMIT.QUOTA.DOWNInvalid.%s-
400BIZ.LIMIT.QUOTA.DOWN.1Invalid.%s-
400BIZ.LIMIT.QUOTA.DOWN.2Invalid.%s-
400BIZ.TagResource.NotSupported%s. Please check and try again later.-
400BIZ_ACL_NOT_ENABLED%s. Please check and try again later.-
400BIZ_AONE_CHECK_ERROR%s. Please check and try again later.-
400BIZ_BROADCASTING_PULL_UNSUPPORT%s. Please check and try again later.-
400BIZ_BROKER_NOT_FOUND%s. Please check and try again later.-
400BIZ_CAN_NOT_ENABLE_ACL%s. Please check and try again later.-
400BIZ_CLUSTER_IS_EMPTY%s. Please check and try again later.-
400BIZ_CONSUMER_GROUP_ACTIVE_ERROR%s. Please check and try again later.-
400BIZ_CONSUMER_ID_BELONG_TO_OTHER_USER%s. Please check and try again later.-
400BIZ_CONSUMER_NEVER_RUNNING%s. Please check and try again later.-
400BIZ_CONSUMER_NOT_ONLINE%s. Please check and try again later.-
400BIZ_CREATE_ORDER_CONFIG_ERROR%s. Please check and try again later.-
400BIZ_CREATE_PUBLISH_ERROR%s. Please check and try again later.-
400BIZ_CREATE_SUBSCRIPTION_ERROR%s. Please check and try again later.-
400BIZ_CREATE_TOPIC_ERROR%s. Please check and try again later.-
400BIZ_CREATE_TOPIC_NUM_LESS_THAN_BEFORE_ERROR%s. Please check and try again later.-
400BIZ_DELETE_ORDER_CONFIG_ERROR%s. Please check and try again later.-
400BIZ_DELETE_SUBSCRIPTION_ERROR%s. Please check and try again later.-
400BIZ_DELETE_TOPIC_ERROR%s. Please check and try again later.-
400BIZ_DOWNLOAD_MESSAGE_ERROR%s. Please check and try again later.-
400BIZ_FIELD_CHECK_INVALID%s. Please check and try again later.-
400BIZ_FIND_CONSUMER_GROUP_INFO_ERROR%s. Please check and try again later.-
400BIZ_GET_APPKEY_LIST_ERROR%s. Please check and try again later.-
400BIZ_GET_CLUSTER_INFO_ERROR%s. Please check and try again later.-
400BIZ_GET_CONSUMER_CONNECTION_ERROR%s. Please check and try again later.-
400BIZ_GET_CONSUMER_RUNNING_INFO_ERROR%s. Please check and try again later.-
400BIZ_GET_CONSUME_ACCUMULATE_ERROR%s. Please check and try again later.-
400BIZ_GET_CONSUME_STATUS_ERROR%s. Please check and try again later.-
400BIZ_GET_TOPIC_ROUTE_INFO_ERROR%s. Please check and try again later.-
400BIZ_GET_TOPIC_STATUS_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_ALREADY_EXISTS%s. Please check and try again later.-
400BIZ_INSTANCE_BASIC_INFO_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_CREATE_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_CREATE_ORDER_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_DELETE_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_LOCATION_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_NOT_FOUND%s. Please check and try again later.-
400BIZ_INSTANCE_ONLY_PROFESSIONAL_SUPPORT%s. Please check and try again later.-
400BIZ_INSTANCE_OWNER_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_PAIDTYPE_NOT_SUPPORT%s. Please check and try again later.-
400BIZ_INSTANCE_PERMISSION_CHECK_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_REFUND_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_RELEASE_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_RELEASE_EXIST_CONSUMER_GROUP_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_RELEASE_EXIST_TOPIC_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_RELEASE_LESSHOUR_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_STATUS_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_UPDATE_ERROR%s. Please check and try again later.-
400BIZ_INSTANCE_UPGRADE_ORDER_ERROR%s. Please check and try again later.-
400BIZ_MESSAGE_TRACK_ERROR%s. Please check and try again later.-
400BIZ_NO_MESSAGE%s. Please check and try again later.-
400BIZ_PRODUCER_ID_BELONG_TO_OTHER_USER%s. Please check and try again later.-
400BIZ_PUBLISHER_EXISTED%s. Please check and try again later.-
400BIZ_PUBLISH_INFO_NOT_FOUND%s. Please check and try again later.-
400BIZ_PUSH_MESSAGE_TO_CONSUMER_ERROR%s. Please check and try again later.-
400BIZ_QUERY_CONSUME_TIMESPAN_ERROR%s. Please check and try again later.-
400BIZ_QUERY_MESSAGE_ERROR%s. Please check and try again later.-
400BIZ_RESET_OFFSET_ERROR%s. Please check and try again later.-
400BIZ_SASL_USER_NOT_EXIST%s. Please check and try again later.-
400BIZ_SASL_USER_NUM_EXCEED%s. Please check and try again later.-
400BIZ_SEND_MESSAGE_ERROR%s. Please check and try again later.-
400BIZ_SLR_CREATE_NO_PERMISSION%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_ALREADY_EXISTS%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_CREATE_ERROR%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_DELETE_ERROR%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_EXISTED%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_NOT_FOUND%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_PERMISSION_CHECK_ERROR%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_STATUS_ERROR%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_TOO_MUCH%s. Please check and try again later.-
400BIZ_SUBSCRIPTION_UPDATE_ERROR%s. Please check and try again later.-
400BIZ_TAG_DUPLICATE_TAG_KEY%s. Please check and try again later.-
400BIZ_TAG_ONLY_SERVICE_ACCOUNT_HAS_PERMISSION%s. Please check and try again later.-
400BIZ_TAG_REQUEST_RESOURCE_NUM_EXCEED%s. Please check and try again later.-
400BIZ_TAG_REQUEST_TAG_NUM_EXCEED%s. Please check and try again later.-
400BIZ_TAG_RESOURCE_NOT_EXIST%s. Please check and try again later.-
400BIZ_TAG_RESOURCE_NUM_EXCEED%s. Please check and try again later.-
400BIZ_TAG_TAGKEY_NOT_VALID%s. Please check and try again later.-
400BIZ_TAG_TAGVALUE_NOT_VALID%s. Please check and try again later.-
400BIZ_TAG_TAG_NUM_EXCEED%s. Please check and try again later.-
400BIZ_TIME_SPAN_EMPTY%s. Please check and try again later.-
400BIZ_TOPIC_ALREADY_EXISTS%s. Please check and try again later.-
400BIZ_TOPIC_COMPACT_TOPIC_NOT_SUPPORT%s. Please check and try again later.-
400BIZ_TOPIC_CREATE_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_CREATE_INTERNAL_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_DELETE_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_EXISTED%s. Please check and try again later.-
400BIZ_TOPIC_LOCAL_TOPIC_NOT_SUPPORT%s. Please check and try again later.-
400BIZ_TOPIC_NOT_FOUND%s. Please check and try again later.-
400BIZ_TOPIC_OFFSET_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_PARTITION_ADD_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_PARTITION_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_PARTITION_NUM_EXCEED%s. Please check and try again later.-
400BIZ_TOPIC_STATUS_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_TOO_MUCH%s. Please check and try again later.-
400BIZ_TOPIC_UPDATE_CONFIG_ERROR%s. Please check and try again later.-
400BIZ_TOPIC_UPDATE_ERROR%s. Please check and try again later.-
400BIZ_UPDATE_ACL_FAILED%s. Please check and try again later.-
400BIZ_UPDATE_SUBSCRIPTION_ERROR%s. Please check and try again later.-
400BIZ_UPDATE_TOPIC_ERROR%s. Please check and try again later.-
400BIZ_UPDATE_TOPIC_PERM_ERROR%s. Please check and try again later.-
400DataExceedMaxLimitThe maximum number of %s is exceeded.-
400DB.Update.FailedFailed 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.
400Deploy.Callback.IllegalMessage data does not match, please submit work order.Message data does not match, please submit work order.
400Deploy.NotRetriableErrorDeployment error, please submit work order.Deployment error, please submit work order.
400Deploy.ResourceNotEnoughInsufficient resources, please submit work order.Insufficient resources, please submit work order.
400Deploy.RetriableErrorA 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.
400DeployErrorDeployment error, please try again, if invalid, please submit a work order.Deployment error, please try again, if invalid, please submit a work order.
400DeployPreCheckErrorDeployment pre-check failed. Please submit work order.The deployment pre-check failed. Please try again. If the retry still fails, please submit a ticket.
400DeployPreCheckErrorDeployment pre-check failed: %s.-
400DeployType.NotSupportdeployType 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.
400FlowControlRequest was denied due to flow control.-
400GET.CONSUMER.MISSING.ACCESS.KEY.IDAccessKeyId is required to get consumer group info.-
400Group.ActiveGroup is active and cannot perform this operation.Group is active and cannot perform this operation.
400Group.ActiveThe group is currently active and cannot perform this operation.-
400Instance.CaclulateChange.timeExample Failed to obtain the expected change time. Please try again later.Example Failed to obtain the expected change time. Please try again later.
400Instance.Change.NotAllowedThis instance does not allow change operations.This instance does not allow change operations.
400Instance.Change.NotAllowedThis instance does not allow deployment operations.-
400Instance.ExceedMaxLimitThe maximum number of instance is exceeded.-
400Instance.ExceedMaxLimitThe number of instances of a single account exceeds the limit. If you need to increase the limit, please submit a work order.The number of instances of a single account exceeds the limit. If you need to increase the limit, please submit a work order.
400Instance.InsertComponent.failFailed to insert the instance component, please try again later.Failed to insert the instance component, please try again later.
400Instance.ResourceNotSufficientInsufficient resources, unable to operate, please submit a work order.Insufficient resources, unable to operate, please submit a work order.
400Instance.ResourceNotSufficientInsufficient resources, unable to proceed with the operation.-
400Instance.StatusNotRunningThe 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.
400Instance.StatusNotRunningThe instance status is not running.-
400Instance.UpdateComponent.failFailed to update the instance component, please try again later.Failed to update the instance component, please try again later.
400Instance.UpgradeService.versionUpgrade version failed, please try again later.Upgrade version failed, please try again later.
400InstanceStatus.Change.NotAllowedThere 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.
400InstanceStatus.NotAllowedThe 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.
400InstanceStatus.NotReleasedThe 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.
400InstanceStatus.NotWaitChangeThe 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.
400InstanceStatus.NotWaitDeployThis 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.
400InstanceStatus.ReleasedThe instance has been released.The instance has been released.
400InstanceStatus.StoppedInstance stopped serving.Instance stopped serving.
400Invalid.%sInvalid.%s-
400Invalid.Partition.%sInvalid.%s-
400InvalidParameterThe %s parameter is invalid.-
400InvalidParameter.DataAlreadyExistThe data already exists for the %s parameter.-
400InvalidParameter.DataNotChangeThere is no change in the parameters. Please adjust and try again.There is no change in the parameters. Please adjust and try again.
400InvalidParameter.FormatThe %s format is invalid.-
400InvalidParameter.NotSupportThe %s parameter is not supported.-
400InvalidParameter.OtherParamParameter %s is incorrect because %s.Parameter %s is incorrect because %s.
400InvalidParameter.RangeThe value of the %s parameter is not within the specified range.-
400InvalidParameter.SizeThe size of the %s parameter is not within the specified range.-
400InvalidParameter.VersionNotSupportCurrent version does not support the %s parameter.-
400Ldap.CreateAdminErrorAdministrative accounts cannot be added or modified.Administrative accounts cannot be added or modified.
400Ldap.DeleteAdminErrorThe management account cannot be deleted.The management account cannot be deleted.
400Manager.configRuleExistErrorManager an existing configuration rule is inserted, adjust and try again.Manager an existing configuration rule is inserted, adjust and try again.
400Manager.configRuleNotExistErrorManager 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.
400Manager.NotCommitManager operation is not submitted, please adjust and try again.Manager operation is not submitted, please adjust and try again.
400Manager.recoverTaskNotFoundManager 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.
400Manager.recoverTaskNotMatchThe 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.
400Manager.scheduledTaskStatusErrorManager 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.
400Manager.scheduledTaskStatusNotSupportThe manager operation task status is unknown.Manager action task status is unknown.
400MissingParameterThe %s parameter is required.-
400NotSupportThe current operation is not supported, please check and try again later.The current operation is not supported, please check and try again later.
400NotSupport.DataStatusCurrent status %s does not support this operation.-
400NotSupport.DataStatusThe current %s's data status does not support this operation.-
400ONS.LOGIN.CHECK.ERROR%s. Please check and try again later.-
400ONS_INIT_ENV_ERROR%s. Please check and try again later.-
400ONS_INTERNAL_ERROR%s. Please check and try again later.-
400ONS_INVOKE_ERROR%s. Please check and try again later.-
400ONS_LOGIN_CHECK_ERROR%s. Please check and try again later.-
400ONS_SERVICE_UNSUPPORTED%s. Please check and try again later.-
400ONS_SYSTEM_ERROR%s. Please check and try again later.-
400ONS_SYSTEM_FLOW_CONTROL%s. Please check and try again later.-
400Order.Create.ErrorFailed to create order.Failed to create order.
400Order.Create.ErrorOrder creation failed, please submit a work order.Order creation failed, please submit a work order.
400Order.Insufficient.balanceThe available gold is not enough, please recharge and try again.The available gold is not enough, please recharge and try again.
400Oss.NotFoundFailed to download message, please try again later.Failed to download message, please try again later.
400Oss.PublishFailedFailed to download message, please try again later.Failed to download message, please try again later.
400RAM.USER.NOT.FOUND.BY.ACCESSKEYThe specified access key is not found.-
400RAM_CREATE_RESOURCE_OWNER_ERROR%s. Please check and try again later.-
400RAM_CREATE_RESOURCE_PERMISSION_ERROR%s. Please check and try again later.-
400RAM_DELETE_RESOURCE_OWNER_ERROR%s. Please check and try again later.-
400RAM_DELETE_RESOURCE_PERMISSION_ERROR%s. Please check and try again later.-
400RAM_GET_USER_BY_AK_ERROR%s. Please check and try again later.-
400RAM_USER_NOT_FOUND_BY_ACCESSKEY%s. Please check and try again later.-
400ScheduledTask.AlreadyHasSameTaskTypehas same task waiting for schedule.The same task is waiting to be scheduled, please try again later.
400ScheduledTask.ExecuteTimeGapTooShortexecute time gap too close to an existed task.The execution time interval is too close to the existing task. Please adjust and try again.
400ServerlessPlan.InstanceNotMatchThe timing policy execution plan does not match the instance ID.The timing policy execution plan does not match the instance ID.
400ServerlessPlan.IntervalInvalidIf 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.
400ServerlessPlan.IntervalInvalidThe schedule policy execution plan range has duplicates or intervals smaller than the execution interval.-
400ServerlessPlan.IntervalInvalidThe timing policy execution plan interval is repeated or smaller than the execution interval.The timing policy execution plan interval is repeated or smaller than the execution interval.
400ServerlessPlan.NameExistThe 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.
400ServerlessPlan.NotSupport.EnabledRuleExistIf 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.
400ServerlessPlan.NotSupport.StatusEnabledA periodic policy can be deleted only after it is disabled.A periodic policy can be deleted only after it is disabled.
400ServerlessPlan.TaskStatusNotSupportA 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.
400ServerlessPlan.TaskStatusNotSupportThe scheduled policy task is currently executing or has been completed, and cannot be modified or canceled.The scheduled policy task is being executed or completed in a single execution, and cannot be modified or canceled.
400Sls.Query.ErrorData query failed. Please try again later.Data query failed. Please try again later.
400Sts.NotFoundUnable 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.
400Topic.DownloadMessageFailFailed to download message, please try again later.Failed to download message, please try again later.
400Topic.ExistThe topic already exists.-
400Topic.NotFoundThe Topic does not exist. Please check and try again.The Topic does not exist. Please check and try again.
400Topic.QueryMessageFailFailed to query the message, please try again later.Failed to query the message, please try again later.
400Topic.SendFailTopic failed to send a message. Please try again later.Topic failed to send a message. Please try again later.
400Topic.StatusNotRunningThe 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.
400Topic.StatusNotRunningThe topic status is not running.-
400TopicStatus.NotAllowedThe current status of the Topic cannot be changed.The current status of the Topic cannot be changed.
400VPC_ASSUMEROLE_ERROR%s. Please check and try again later.-
400VPC_VSW_ZONE_MAPPING_ERROR%s. Please check and try again later.-
400WHITE.DELETE.ERROR%s. Please check and try again later.-
400WHITE.IP.ALREADY.EXISTS.ERROR%s. Please check and try again later.-
400WHITE.IP.ILLEGAL.ERROR%s. Please check and try again later.-
400WHITE.IPLIST.OVERLONG.ERROR%s. Please check and try again later.-
400WHITE.OVER.LENGTH.ERROR%s. Please check and try again later.-
400WHITE.PARAM.ERROR%s. Please check and try again later.-
400Order.InstHasUnpaidOrderThere 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!
400Topic.RebalanceOperationForbiddenThis 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.
403NoPermissionNo permissions.-
403AUTH_RESOURCE_OWNER_ERROR%s. Please check and try again later.-
404AsyncTaskGroup.NotFoundThe task group does not exist. Please check and try again.The task group does not exist. Please check and try again.
404AsyncTaskHandler.NotFoundThe task does not exist. Please check and try again.The task does not exist. Please check and try again.
404AsyncTaskType.NotFoundThe task type does not exist. Please check and try again.The task type does not exist. Please check and try again.
404Group.NotFoundGroupId does not exist. Please check and try again.GroupId does not exist. Please check and try again.
404Group.NotFoundNo group found for the %s parameter.-
404Instance.NotFoundNo instance found for the %s parameter.-
404Instance.NotFoundThe instance does not exist. Please verify the entry and try again.The instance does not exist. Please verify the entry and try again.
404InstanceAgent.NotFoundInstance does not exist. Please check the entry and try again.Instance does not exist. Please check the entry and try again.
404InvalidData.FieldsIncompleteData 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.
404InvalidParameter.DataNotFoundNo data found for the %s parameter.-
404Topic.NotFoundNo topic found for the %s parameter.-
404VpcVSwitch.NotFoundThe 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.
500GET.CONSUMER.PROGRESS.ERRORAn instance status error occurred.-
500INTERNAL.ERRORAn internal error occurred. Please try again later.-
500InternalErrorA system exception occurred. Please submit a ticket.-
500InternalErrorAn internal error occurred. Please try again later.-
500InternalUnknownCodeErrorInternal error, please try again, if still failed, please submit a work order to contact us.Internal error, please try again, if still failed, please submit a work order to contact us.
500InternalUnknownCodeErrorInternal error, please try again. If it still fails, please submit a work order and contact us.Internal error, please try again. If it still fails, please submit a work order and contact us.
500ONS.GET.ALLOWEDIP.INTERNAL.ERRORThe request for obtaining the IP address whitelist timed out. Please try again later.-
500ONS.INTERNAL.ERRORAn internal error occurred. Please try again later.-
500ONS.UPDATE.ALLOWEDIP.INTERNAL.ERRORThe request for changing the IP address whitelist timed out. Please try again later.-
500RemoteCallErrorAn internal service invocation error occurred. Please try again later.-
500RmqClusterEmptyA system exception occurred. Please submit a ticket.A system exception occurred. Please submit a ticket.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-06The response structure of the API has changedView Change Details
2024-11-25The response structure of the API has changedView Change Details
2024-11-14The response structure of the API has changedView Change Details
2024-08-16API Description UpdateView Change Details
2024-04-23The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-04-11The response structure of the API has changedView Change Details
2024-03-25The response structure of the API has changedView Change Details
2024-03-13The response structure of the API has changedView Change Details
2024-02-27The response structure of the API has changedView Change Details
2022-08-03The response structure of the API has changedView Change Details
2022-08-02The response structure of the API has changedView Change Details
2021-12-20The response structure of the API has changedView Change Details