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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| alikafka:StartInstance | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance. | alikafka_post-cn-v0h1fgs2**** |
| RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
| VpcId | string | Yes | The ID of the virtual private cloud (VPC) in which you want to deploy the instance. | vpc-bp1r4eg3yrxmygv**** |
| VSwitchId | string | Yes | The ID of the vSwitch to which you want to connect the instance. | vsw-bp1j3sg5979fstnpl**** |
| DeployModule | string | Yes | 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:
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 |
| ZoneId | string | No | The ID of the zone where you want to deploy the ApsaraMQ for Kafka instance.
Note
If resources in the specified zone is insufficient, the instance may be deployed in another zone.
| cn-hangzhou-k |
| IsEipInner | boolean | No | Specifies whether the instance supports elastic IP addresses (EIPs). Valid values:
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 |
| IsSetUserAndPassword | boolean | No | Specifies whether to set a new username and password. Valid values:
This parameter is available only if you deploy an instance that allows access from the Internet and a VPC. | false |
| Username | string | No | The instance username.
Default value for ApsaraMQ for Kafka V2 and V3 instances: username. Default value for ApsaraMQ for Confluent instances: root. | username |
| Password | string | No | The instance password.
| password |
| Name | string | No | 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 |
| CrossZone | boolean | No | Specifies whether cross-zone deployment is required. Valid values:
Default value: true. | false |
| SecurityGroup | string | No | 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**** |
| ServiceVersion | string | No | The version of the ApsaraMQ for Kafka instance. Valid values:
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 |
| Config | string | No | 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
The Config parameter supports the following parameters:
| {"kafka.log.retention.hours":"33"} |
| KMSKeyId | string | No | 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 |
| Notifier | string | No | The alert contact. | Mr. Wang |
| UserPhoneNum | string | No | The mobile phone number of the alert contact. | 1581234**** |
| SelectedZones | string | No | The two-dimensional arrays that consist of the candidate set for primary zones and the candidate set for secondary zones. Custom code in the
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.
| [[\"zonel\"],[\"zonek\"]] |
| IsForceSelectedZones | boolean | No | Specifies whether to forcibly deploy the instance in the selected zones. | false |
| VSwitchIds | array | No | 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. | |
| string | No | The ID of the vSwitch with which the instance is associated. | vsw-gw8oeuz8kllbnb4m0qv5a |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": 200,
"Message": "operation success.",
"RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015****",
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 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 a user. Please refer to the document and try again. If in doubt, submit a work order. |
| 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. | - |
| 400 | ADMIN_UPDATE_BROKER_CONFIG_ERROR | %s. Please check and try again later. | - |
| 400 | ADMIN_UPDATE_SUB_PERM_ERROR | %s. Please check and try again later. | - |
| 400 | ADMIN_UPDATE_TOPIC_PERM_ERROR | %s. Please check and try again later. | - |
| 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 | AgentError | A system exception occurred. Please submit a ticket. | A system exception occurred. Please submit a ticket. |
| 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. | - |
| 400 | AsyncTask.ExecuteTimeNotSupport | The 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. |
| 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. | - |
| 400 | AUTH_CSRF_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_LOGIN_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_ONS_CHANNEL_INVALID | %s. Please check and try again later. | - |
| 400 | AUTH_PERMISSION_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_REQUEST_NOT_ALLOWED | %s. Please check and try again later. | - |
| 400 | AUTH_RESOURCE_EMPOWER_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_RESOURCE_OWNER_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_SERVICE_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_SIGNATURE_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_SYSTEM_PERMISSION_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_TOPIC_CREATE_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_USER_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | AUTH_USER_IN_BLACK_LIST | %s. Please check and try again later. | - |
| 400 | BIZ.GET.TOPIC.STATUS.ERROR | AccessKeyId is required to get topic status. | - |
| 400 | BIZ.INSTANCE.NOT.FOUND | %s. Please check and try again later. | - |
| 400 | BIZ.INSTANCE.STATUS.ERROR | %s. Please check and try again later. | - |
| 400 | BIZ.LIMIT.PUBNETWORK | EipMax is invalid. | - |
| 400 | BIZ.LIMIT.QUOTA.DOWN | Invalid.%s | - |
| 400 | BIZ.LIMIT.QUOTA.DOWN.1 | Invalid.%s | - |
| 400 | BIZ.LIMIT.QUOTA.DOWN.2 | Invalid.%s | - |
| 400 | BIZ.TagResource.NotSupported | %s. Please check and try again later. | - |
| 400 | BIZ_ACL_NOT_ENABLED | %s. Please check and try again later. | - |
| 400 | BIZ_AONE_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_BROADCASTING_PULL_UNSUPPORT | %s. Please check and try again later. | - |
| 400 | BIZ_BROKER_NOT_FOUND | %s. Please check and try again later. | - |
| 400 | BIZ_CAN_NOT_ENABLE_ACL | %s. Please check and try again later. | - |
| 400 | BIZ_CLUSTER_IS_EMPTY | %s. Please check and try again later. | - |
| 400 | BIZ_CONSUMER_GROUP_ACTIVE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_CONSUMER_ID_BELONG_TO_OTHER_USER | %s. Please check and try again later. | - |
| 400 | BIZ_CONSUMER_NEVER_RUNNING | %s. Please check and try again later. | - |
| 400 | BIZ_CONSUMER_NOT_ONLINE | %s. Please check and try again later. | - |
| 400 | BIZ_CREATE_ORDER_CONFIG_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_CREATE_PUBLISH_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_CREATE_SUBSCRIPTION_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_CREATE_TOPIC_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_CREATE_TOPIC_NUM_LESS_THAN_BEFORE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_DELETE_ORDER_CONFIG_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_DELETE_SUBSCRIPTION_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_DELETE_TOPIC_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_DOWNLOAD_MESSAGE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_FIELD_CHECK_INVALID | %s. Please check and try again later. | - |
| 400 | BIZ_FIND_CONSUMER_GROUP_INFO_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_APPKEY_LIST_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_CLUSTER_INFO_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_CONSUMER_CONNECTION_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_CONSUMER_RUNNING_INFO_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_CONSUME_ACCUMULATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_CONSUME_STATUS_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_TOPIC_ROUTE_INFO_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_GET_TOPIC_STATUS_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_ALREADY_EXISTS | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_BASIC_INFO_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_CREATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_CREATE_ORDER_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_DELETE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_LOCATION_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_NOT_FOUND | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_ONLY_PROFESSIONAL_SUPPORT | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_OWNER_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_PAIDTYPE_NOT_SUPPORT | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_PERMISSION_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_REFUND_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_RELEASE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_RELEASE_EXIST_CONSUMER_GROUP_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_RELEASE_EXIST_TOPIC_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_RELEASE_LESSHOUR_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_STATUS_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_UPDATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_INSTANCE_UPGRADE_ORDER_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_MESSAGE_TRACK_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_NO_MESSAGE | %s. Please check and try again later. | - |
| 400 | BIZ_PRODUCER_ID_BELONG_TO_OTHER_USER | %s. Please check and try again later. | - |
| 400 | BIZ_PUBLISHER_EXISTED | %s. Please check and try again later. | - |
| 400 | BIZ_PUBLISH_INFO_NOT_FOUND | %s. Please check and try again later. | - |
| 400 | BIZ_PUSH_MESSAGE_TO_CONSUMER_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_QUERY_CONSUME_TIMESPAN_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_QUERY_MESSAGE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_RESET_OFFSET_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_SASL_USER_NOT_EXIST | %s. Please check and try again later. | - |
| 400 | BIZ_SASL_USER_NUM_EXCEED | %s. Please check and try again later. | - |
| 400 | BIZ_SEND_MESSAGE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_SLR_CREATE_NO_PERMISSION | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_ALREADY_EXISTS | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_CREATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_DELETE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_EXISTED | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_NOT_FOUND | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_PERMISSION_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_STATUS_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_TOO_MUCH | %s. Please check and try again later. | - |
| 400 | BIZ_SUBSCRIPTION_UPDATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_DUPLICATE_TAG_KEY | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_ONLY_SERVICE_ACCOUNT_HAS_PERMISSION | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_REQUEST_RESOURCE_NUM_EXCEED | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_REQUEST_TAG_NUM_EXCEED | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_RESOURCE_NOT_EXIST | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_RESOURCE_NUM_EXCEED | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_TAGKEY_NOT_VALID | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_TAGVALUE_NOT_VALID | %s. Please check and try again later. | - |
| 400 | BIZ_TAG_TAG_NUM_EXCEED | %s. Please check and try again later. | - |
| 400 | BIZ_TIME_SPAN_EMPTY | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_ALREADY_EXISTS | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_COMPACT_TOPIC_NOT_SUPPORT | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_CREATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_CREATE_INTERNAL_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_DELETE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_EXISTED | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_LOCAL_TOPIC_NOT_SUPPORT | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_NOT_FOUND | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_OFFSET_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_PARTITION_ADD_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_PARTITION_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_PARTITION_NUM_EXCEED | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_STATUS_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_TOO_MUCH | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_UPDATE_CONFIG_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_TOPIC_UPDATE_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_UPDATE_ACL_FAILED | %s. Please check and try again later. | - |
| 400 | BIZ_UPDATE_SUBSCRIPTION_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_UPDATE_TOPIC_ERROR | %s. Please check and try again later. | - |
| 400 | BIZ_UPDATE_TOPIC_PERM_ERROR | %s. Please check and try again later. | - |
| 400 | DataExceedMaxLimit | The maximum number of %s is exceeded. | - |
| 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 | DeployPreCheckError | Deployment pre-check failed: %s. | - |
| 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. | - |
| 400 | GET.CONSUMER.MISSING.ACCESS.KEY.ID | AccessKeyId is required to get consumer group info. | - |
| 400 | Group.Active | Group is active and cannot perform this operation. | Group is active and cannot perform this operation. |
| 400 | Group.Active | The group is currently 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.Change.NotAllowed | This instance does not allow deployment operations. | - |
| 400 | Instance.ExceedMaxLimit | The maximum number of instance is exceeded. | - |
| 400 | Instance.ExceedMaxLimit | The 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. |
| 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.ResourceNotSufficient | Insufficient resources, unable to proceed with the operation. | - |
| 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.StatusNotRunning | The instance status is not running. | - |
| 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 | - |
| 400 | Invalid.Partition.%s | Invalid.%s | - |
| 400 | InvalidParameter | The %s parameter is invalid. | - |
| 400 | InvalidParameter.DataAlreadyExist | The data already exists for the %s parameter. | - |
| 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.Format | The %s format is invalid. | - |
| 400 | InvalidParameter.NotSupport | The %s parameter is not 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. | - |
| 400 | InvalidParameter.Size | The size of the %s parameter is not within the specified range. | - |
| 400 | InvalidParameter.VersionNotSupport | 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. | - |
| 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. | - |
| 400 | NotSupport.DataStatus | The current %s's data status does not support this operation. | - |
| 400 | ONS.LOGIN.CHECK.ERROR | %s. Please check and try again later. | - |
| 400 | ONS_INIT_ENV_ERROR | %s. Please check and try again later. | - |
| 400 | ONS_INTERNAL_ERROR | %s. Please check and try again later. | - |
| 400 | ONS_INVOKE_ERROR | %s. Please check and try again later. | - |
| 400 | ONS_LOGIN_CHECK_ERROR | %s. Please check and try again later. | - |
| 400 | ONS_SERVICE_UNSUPPORTED | %s. Please check and try again later. | - |
| 400 | ONS_SYSTEM_ERROR | %s. Please check and try again later. | - |
| 400 | ONS_SYSTEM_FLOW_CONTROL | %s. Please check and try again later. | - |
| 400 | Order.Create.Error | Failed to create order. | Failed to create order. |
| 400 | Order.Create.Error | Order creation failed, please submit a work order. | Order creation failed, please submit a work 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. | - |
| 400 | RAM_CREATE_RESOURCE_OWNER_ERROR | %s. Please check and try again later. | - |
| 400 | RAM_CREATE_RESOURCE_PERMISSION_ERROR | %s. Please check and try again later. | - |
| 400 | RAM_DELETE_RESOURCE_OWNER_ERROR | %s. Please check and try again later. | - |
| 400 | RAM_DELETE_RESOURCE_PERMISSION_ERROR | %s. Please check and try again later. | - |
| 400 | RAM_GET_USER_BY_AK_ERROR | %s. Please check and try again later. | - |
| 400 | RAM_USER_NOT_FOUND_BY_ACCESSKEY | %s. Please check and try again later. | - |
| 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.IntervalInvalid | The schedule policy execution plan range has duplicates or intervals smaller than the execution interval. | - |
| 400 | ServerlessPlan.IntervalInvalid | The 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. |
| 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 | ServerlessPlan.TaskStatusNotSupport | The 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. |
| 400 | Sls.Query.Error | Data query failed. Please try again later. | Data query failed. Please try again later. |
| 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. | - |
| 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 | Topic.StatusNotRunning | The topic status is not running. | - |
| 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. | - |
| 400 | VPC_VSW_ZONE_MAPPING_ERROR | %s. Please check and try again later. | - |
| 400 | WHITE.DELETE.ERROR | %s. Please check and try again later. | - |
| 400 | WHITE.IP.ALREADY.EXISTS.ERROR | %s. Please check and try again later. | - |
| 400 | WHITE.IP.ILLEGAL.ERROR | %s. Please check and try again later. | - |
| 400 | WHITE.IPLIST.OVERLONG.ERROR | %s. Please check and try again later. | - |
| 400 | WHITE.OVER.LENGTH.ERROR | %s. Please check and try again later. | - |
| 400 | WHITE.PARAM.ERROR | %s. Please check and try again later. | - |
| 403 | NoPermission | No permissions. | - |
| 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 | Group.NotFound | No group found for the %s parameter. | - |
| 404 | Instance.NotFound | No instance found for the %s parameter. | - |
| 404 | Instance.NotFound | The instance does not exist. Please verify the entry and try again. | The instance does not exist. Please verify the entry 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 | 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 | InvalidParameter.DataNotFound | No data found for the %s parameter. | - |
| 404 | Topic.NotFound | No topic found for the %s parameter. | - |
| 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. |
| 500 | GET.CONSUMER.PROGRESS.ERROR | An instance status error occurred. | - |
| 500 | INTERNAL.ERROR | An internal error occurred. Please try again later. | - |
| 500 | InternalError | A system exception occurred. Please submit a ticket. | - |
| 500 | InternalError | An internal error occurred. Please try again later. | - |
| 500 | InternalUnknownCodeError | Internal 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. |
| 500 | InternalUnknownCodeError | Internal 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. |
| 500 | ONS.GET.ALLOWEDIP.INTERNAL.ERROR | The request for obtaining the IP address whitelist timed out. Please try again later. | - |
| 500 | ONS.INTERNAL.ERROR | An internal error occurred. Please try again later. | - |
| 500 | ONS.UPDATE.ALLOWEDIP.INTERNAL.ERROR | The request for changing the IP address whitelist timed out. Please try again later. | - |
| 500 | RemoteCallError | An internal service invocation error occurred. Please try again later. | - |
| 500 | RmqClusterEmpty | A 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 time | Summary of changes | Operation |
|---|---|---|
| 2024-08-15 | API Description Update | View Change Details |
| 2024-02-27 | The request parameters of the API has changed | View Change Details |
| 2023-10-09 | The request parameters of the API has changed | View Change Details |