All Products
Search

This Product

    ApsaraMQ for Kafka:StartInstance

    Document Center

    ApsaraMQ for Kafka:StartInstance

    Last Updated:Nov 14, 2024

    Deploys an ApsaraMQ for Kafka instance. You must purchase and deploy an ApsaraMQ for Kafka instance before you can use the instance to send and receive messages.

    Operation description

    Note You can call this operation up to twice per second.

    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:StartInstanceupdate
    *All Resources
    *
    • alikafka:DeployModule
    • alikafka:SpecType
    • alikafka:Acl
    • alikafka:DiskEncryption
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		alikafka_post-cn-v0h1fgs2****
    RegionIdstringYes

    The region ID of the instance.

    		cn-hangzhou
    VpcIdstringYes

    The ID of the virtual private cloud (VPC) in which you want to deploy the instance.

    		vpc-bp1r4eg3yrxmygv****
    VSwitchIdstringYes

    The ID of the vSwitch to which you want to connect the instance.

    		vsw-bp1j3sg5979fstnpl****
    DeployModulestringYes

    The deployment mode. If the instance is an ApsaraMQ for Kafka V2 instance, this parameter is required. If the instance is an ApsaraMQ for Kafka V3 instance or an ApsaraMQ for Confluent instance, this parameter is optional. Valid values:

    • vpc: deploys the instance in a virtual private cloud (VPC).
    • eip: deploys the instance over the Internet and in the VPC.

    The deployment mode of the ApsaraMQ for Kafka instance must be consistent with the instance type. If the instance is a VPC-connected instance, set this parameter to vpc. If the instance is an Internet- and VPC-connected instance, set this parameter to eip.

    		vpc
    ZoneIdstringNo

    The ID of the zone where you want to deploy the ApsaraMQ for Kafka instance.

    • The zone ID of the ApsaraMQ for Kafka instance must be the same as that of the vSwitch.
    • The value must be in the zoneX or Region ID-X format. Examples: zonea and cn-hangzhou-k.
    Note If resources in the specified zone is insufficient, the instance may be deployed in another zone.
    		cn-hangzhou-k
    IsEipInnerbooleanNo

    Specifies whether the instance supports elastic IP addresses (EIPs). Valid values:

    • true: supports EIPs and allows access from the Internet and a VPC.
    • false: does not support EIPs and allows access only from a VPC.

    The value of this parameter must match the type of the instance. For example, if the instance allows access only from a VPC, set this parameter to false.

    		false
    IsSetUserAndPasswordbooleanNo

    Specifies whether to set a new username and password. Valid values:

    • true: sets a new username and password.
    • false: does not set a new username or password.

    This parameter is available only if you deploy an instance that allows access from the Internet and a VPC.

    		false
    UsernamestringNo

    The instance username.

    • This parameter is available only for Internet- and VPC- connected ApsaraMQ for Kafka V2 and V3 instances.
    • If the instance is an ApsaraMQ for Confluent instance, set this parameter to root or leave this parameter empty.

    Default value for ApsaraMQ for Kafka V2 and V3 instances: username. Default value for ApsaraMQ for Confluent instances: root.

    		username
    PasswordstringNo

    The instance password.

    • This parameter is available only for Internet- and VPC- connected ApsaraMQ for Kafka V2 and V3 instances.
    • If the instance is an ApsaraMQ for Confluent instance, this parameter is required. The value of this parameter must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: ! @ # $ % ^ & * () _ + - =
    		password
    NamestringNo

    The name of the instance.

    Note If you specify a value for this parameter, make sure that the specified value is unique in the region of the instance.
    		newInstanceName
    CrossZonebooleanNo

    Specifies whether cross-zone deployment is required. Valid values:

    • true
    • false

    Default value: true.

    		false
    SecurityGroupstringNo

    The security group of the instance.

    If you do not specify this parameter, ApsaraMQ for Kafka automatically configures a security group for your instance. If you specify this parameter, you must create a security group in advance. For more information, see Create a security group.

    		sg-bp13wfx7kz9pko****
    ServiceVersionstringNo

    The version of the ApsaraMQ for Kafka instance. Valid values:

    • ApsaraMQ for Kafka V2 instances: 2.2.0 and 2.6.2.
    • ApsaraMQ for Kafka V3 instances: 3.3.1.
    • ApsaraMQ for Confluent instances: 7.4.0.

    Default value:

    • ApsaraMQ for Kafka V2 instances: 2.2.0.
    • ApsaraMQ for Kafka V3 instances: 3.3.1.
    • ApsaraMQ for Confluent instances: 7.4.0.
    		ApsaraMQ for Kafka V2 instances: 2.2.0 ApsaraMQ for Kafka V3 instances: 3.3.1 ApsaraMQ for Confluent instances: 7.4.0
    ConfigstringNo

    The initial configurations of the ApsaraMQ for Kafka instance. The values must be valid JSON strings. If you do not specify this parameter, it is left empty.

    Note
  • You cannot configure this parameter when you deploy an ApsaraMQ for Confluent instance.
  • You cannot configure enable.acl for instances whose versions are earlier than 2.2.0.
    •

    The Config parameter supports the following parameters:

    • enable.vpc_sasl_ssl: specifies whether to enable VPC transmission encryption. Valid values:

      • true: enables VPC transmission encryption. If you enable VPC transmission encryption, you must also enable access control list (ACL).
      • false: disables VPC transmission encryption. This is the default value.

    • enable.acl: specifies whether to enable ACL. Valid values:

      • true: enables ACL.
      • false: disables the ACL feature. This is the default value.

    • kafka.log.retention.hours: the maximum message retention period when the disk capacity is sufficient. Unit: hours. Valid values: 24 to 480. Default value: 72. When the disk usage reaches 85%, the disk capacity is insufficient. In this case, the system deletes the earliest stored messages to ensure service availability.

    • kafka.message.max.bytes: the maximum size of a message that can be sent and received by ApsaraMQ for Kafka. Unit: bytes. Valid values: 1048576 to 10485760. Default value: 1048576. Before you change the maximum message size to a new value, make sure that the new value matches the configurations of the producers and consumers.

    		{"kafka.log.retention.hours":"33"}
    KMSKeyIdstringNo

    The ID of the key that is used for disk encryption in the region where the instance is deployed. You can obtain the ID of the key in the Key Management Service (KMS) console or create a key. For more information, see Manage CMKs.

    If this parameter is configured, disk encryption is enabled for the instance. You cannot disable disk encryption after disk encryption is enabled. When you call this operation, the system checks whether the AliyunServiceRoleForAlikafkaInstanceEncryption service-linked role is created. If the role is not created, the system automatically creates the role. For more information, see Service-linked roles.

    Note When you deploy a serverless ApsaraMQ for Kafka V3 instance, you cannot configure this parameter.
    		0d24xxxx-da7b-4786-b981-9a164dxxxxxx
    NotifierstringNo

    The alert contact.

    		Mr. Wang
    UserPhoneNumstringNo

    The mobile phone number of the alert contact.

    		1581234****
    SelectedZonesstringNo

    The two-dimensional arrays that consist of the candidate set for primary zones and the candidate set for secondary zones. Custom code in the zone {zone} format and standard code in the cn-RegionID-{zone} format are supported.

    • If you set CrossZone to true and specify Zone H and Zone F as the candidate set for primary zones and Zone K as the candidate set for secondary zones, set this parameter to [["zoneh","zonef"],["zonek"]].
    Note If you specify multiple zones as the primary or secondary zones, the system deploys the instance in one of the zones without prioritizing them. For example, if you set this parameter to [["zoneh","zonef"],["zonek"]], the primary zone in which the instance is deployed can be Zone H or Zone F, and the secondary zone is Zone K.
    • If you set CrossZone to false and want to deploy the instance in Zone K, set this parameter to [["zonek"],[]]. In this case, the value of this parameter must still be two-dimensional arrays, but the array that specifies the candidate for secondary zones is left empty.
    		[[\"zonel\"],[\"zonek\"]]
    IsForceSelectedZonesbooleanNo

    Specifies whether to forcibly deploy the instance in the selected zones.

    		false
    VSwitchIdsarrayNo

    The IDs of the vSwitches with which the instance is associated. If the instance is an ApsaraMQ for Kafka V2 or V3 instance, this parameter is required. If the instance is an ApsaraMQ for Confluent instance, you must configure one of VSwitchIds and VSwitchId. If you configure both of the parameters, the value of VSwitchIds takes effect.

    stringNo

    The ID of the vSwitch with which the instance is associated.

    		vsw-gw8oeuz8kllbnb4m0qv5a

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codeinteger

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

    		200
    Messagestring

    The returned message.

    		operation success.
    RequestIdstring

    The ID of the request.

    		ABA4A7FD-E10F-45C7-9774-A5236015****
    Successboolean

    Indicates whether the request is successful.

    		true

    Examples

    Sample success responses

    JSONformat

    {
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015****",
  "Success": true
}

    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_RESOURCE_OWNER_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.-
    403NoPermissionNo permissions.-
    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-08-15API Description UpdateView Change Details
    2024-02-27The request parameters of the API has changedView Change Details
    2023-10-09The request parameters of the API has changedView Change Details