Use DeleteDataServiceApi to delete an API in DataService Studio - DataWorks - Alibaba Cloud - DataWorks

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
TenantId	integer	No	The tenant ID. You can log on to the DataWorks console, go to the DataStudio page, click the username in the upper-right corner, and choose Menu > User Info to obtain the tenant ID. You can also obtain the tenant ID from Data.Apis[].TenantId in the response of ListDataServiceApis.	10002
ProjectId	integer	Yes	The workspace ID. You can obtain the workspace ID from PageResult.ProjectList[].ProjectId in the response of ListProjects.	10001
ApiId	integer	Yes	The ID of the DataService API.	10000

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Data	boolean	Indicates whether the deletion was successful.	true
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. It is a unique identifier for the request.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the call was successful.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.