DataWorks:View, manage, and perform batch operations on APIs

View an API

1. Log on to the DataWorks console. In the top navigation bar, select a region. In the left-side navigation pane, choose Data Analysis and Service > DataService Studio. Select a workspace from the drop-down list and click Go to DataService Studio.

2. On the Service Development page, expand the Business Flow > API folder where the target API is located.

3. Right-click the API name and select Details.

Clone an API

Cloning creates a copy of an API and saves it to a path you specify in the directory tree.

1. On the Service Development page, expand the Business Flow > API folder where the target API is located.

2. Right-click the API name and select Clone.

3. In the Clone API dialog box, configure the parameters.

   Parameter	Description
   API Name	The name can contain Chinese characters, letters, digits, and underscores (_). It must start with a Chinese character or a letter and be 4–50 characters in length.
   API Path	The path where the API is stored, such as /user. It can contain letters, digits, underscores (_), and hyphens (-), must start with a forward slash (/), and be no more than 200 characters in length.
   Description	A description for the cloned API.
   Destination Folder	The folder where the cloned API is stored.

   

4. Click Confirm.

Delete an API

1. Unpublish the API if it is published. If the API is not published, skip this step.

   1. On the Service Development page, click Service Management in the top menu bar. The API Management page appears.

   2. On the Published APIs tab, click Unpublish in the Management column for the API.

   3. Click Service Development in the top menu bar to return to the Service Development page.

2. On the Service Development page, expand the Business Flow > API folder where the target API is located.

3. Right-click the API and select Delete.

Move an API

1. Unpublish the API if it is published. If the API is not published, skip this step.

   1. On the Service Development page, click Service Management in the top menu bar. The API Management page appears.

   2. On the Published APIs tab, click Unpublish in the Management column for the API.

   3. Click Service Development in the top menu bar to return to the Service Development page.

2. On the Service Development page, expand the Business Flow > API folder where the target API is located.

3. Right-click the API and select Move.

4. In the Modify File Path dialog box, select a Destination Folder and click Confirm.

Run batch operations on APIs

DataService Studio supports batch operations — modifying service resource groups, submitting, and publishing — across multiple APIs at once. Use this to quickly switch resource groups for a set of APIs and republish them.

1. On the Service Development page, click the icon (batch operations) at the top of the directory tree on the left.

   

2. At the top of the batch operations page, filter APIs by conditions such as Business Flow and Owner.

3. From the filtered list, select the APIs you want to operate on.

4. At the bottom of the page, select a batch operation to apply. The following table shows which batch operations are available for each API status combination.

   Batch operation	Unpublished & unsubmitted	Unpublished & submitted	Published & unsubmitted	Published & submitted
   Modify service resource group	Supported	Supported	Supported	Supported
   Submit	Supported	Not supported. Discard the previously submitted version in Version Control on the API editing page before submitting again.	Supported	Not supported. Discard the previously submitted version in Version Control on the API editing page before submitting again.
   Publish	Not supported. Submit the API before publishing.	Supported	Not supported. Submit the API before publishing.	Supported

Search for APIs by code

Code search finds APIs by their code content. The search scope is limited to APIs created in the code editor of the current workspace.

1. In the left-side navigation pane, click the icon (code search) to open the code search page.

   

2. Enter a keyword in the search box. Supported keywords include API name, API path, API description, table name, and field name.

3. To narrow results further, click the icon to expand the filter panel. Filter by owner, business flow, or modification time.

4. Review the search results below the search box. Each result includes:

   • API name: Click to open the API configuration page in the right-side pane.

   • Code content: The matched keyword, its line number, and a brief context. You can copy the matched code.

   • Basic information: The API ID, owner, business flow, and last modification time.