ListDataServiceApplications-DataWorks(DataWorks)-阿里云帮助中心

Queries basic information about Data Service applications in specified workspaces.

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
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
ProjectIdList	string	Yes	The workspace IDs to query, separated by commas (,). At least one ID is required. Maximum: 50.	10000,100001
TenantId	integer	No	The tenant ID. To obtain your tenant ID, log on to the DataWorks console, go to the DataStudio page, click your username in the upper-right corner, and then click User Info.	100002

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0000-ABCD-EFG***
ErrorMessage	string	The error message.	Normal
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	0
Data	object	The returned data.
PageNumber	integer	The page number. Matches the PageNumber parameter in the request.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of entries returned.	100
Applications	array<object>	Basic information about the applications.
	object
ApplicationName	string	The name of the application.	My application
ApplicationId	integer	The application ID.	20000
ProjectId	integer	The workspace ID.	10000

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG***",
  "ErrorMessage": "Normal",
  "Success": true,
  "ErrorCode": "0",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Applications": [
      {
        "ApplicationName": "My application",
        "ApplicationId": 20000,
        "ProjectId": 10000
      }
    ]
  }
}

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.