DeleteProject-阿里云帮助中心

Deletes a data migration or data synchronization task.

Operation description

Important You cannot delete a subscription project via the API. To delete the project, you must submit a ticket to Alibaba Cloud to unsubscribe.

Try it now

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

Test

RAM authorization

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

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

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DeleteProject

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID of the data migration or synchronization task.	np_4w3a****

Response elements

Element	Type	Description	Example
	object	The response body.
Success	boolean	Indicates whether the request succeeded.	true
ErrorDetail	object	The error details.
Code	string	The new error code.	CM-RESOAT1111
Level	string	The error level. Valid values: FATAL, ERROR, WARNING, and CRITICAL.	ERROR
Message	string	The new error message.	A system error occurred.
ExtraContext	object	Contains key-value pairs for populating placeholders in the `Message` field.
	any	The value for a placeholder in the `Message` field.	null
MessageMcmsKey	string	The localization key for the error message.	null
MessageMcmsContext	object	Contains key-value pairs for placeholders in the message referenced by `MessageMcmsKey`.
	string	The value for a placeholder in the localized message.	null
Reason	string	The cause of the error.	null
ReasonMcmsKey	string	The localization key for the error cause.	null
ReasonMcmsContext	object	Contains key-value pairs for placeholders in the reason referenced by `ReasonMcmsKey`.
	string	The value for a placeholder in the localized reason.	null
Proposal	string	The new suggestion.	Contact the administrator.
ProposalMcmsKey	string	The localization key for the suggestion.	null
ProposalMcmsContext	object	Contains key-value pairs for placeholders in the suggestion referenced by `ProposalMcmsKey`.
	string	The value for a placeholder in the localized suggestion.	null
UpstreamErrorDetail	any	Details of upstream service errors.	null
Code	string	The legacy error code.	INNER_ERROR
Message	string	The legacy error message.	A system error occurred.
Advice	string	The legacy advice.	Contact the administrator.
RequestId	string	The unique identifier for the request. Include this ID when you submit a support ticket.	473469C7-XXXX-XXX-B3DB-A3DC0DE
PageNumber	integer	The page number of the returned results. This parameter is returned only for paginated queries.	1
PageSize	integer	The number of entries returned per page. This parameter is returned only for paginated queries.	10
TotalCount	integer	The total number of entries that match the query. This parameter is returned only for paginated queries.	24
Cost	string	The time elapsed to process the request, in seconds.	1
Data	any	The returned data. For this operation, the value is `null`.	null

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111\n",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "Contact the administrator. ",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator.",
  "RequestId": "473469C7-XXXX-XXX-B3DB-A3DC0DE",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 24,
  "Cost": "1",
  "Data": "null"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.