Create and manage tags for an API-DataWorks(DataWorks)-阿里云帮助中心

Learn how to create, add, view, and delete tags for your APIs.

Background information

In DataService Studio, you can add tags when you generate, register, or deploy APIs and manage workflows to categorize and search for them efficiently. Tags are specific to a workspace and are not shared between them.

Note

You can add up to five optional tags to each API.
Each tag can be up to 20 characters long and can contain Chinese characters, letters, digits, and underscores (_).

Create an API tag

Go to the DataService Studio page.
On the Service Development page, hover over the icon and click API > Generate API.
In the Generate API dialog box, enter a tag name in the Tag section.
If the tag does not exist in the workspace, Add <tag name> appears in the drop-down list. Click Add <tag name> to add the new tag to the API. You can add a maximum of five tags to each API.
After you configure the other parameters, click Confirm. The new tag is added to the workspace's tag list. For more information about the other parameters, see Generate an API from a data source (API Gateway).

Add an API tag

On the Service Development page, hover over the icon and click API > Generate API.
In the Generate API dialog box, click the blank area or the drop-down arrow in the Tag section to display the existing tags in the current workspace.
Click the tag that you want to add, configure the other parameters, and then click Confirm. For more information about the other parameters, see Generate an API from a data source (API Gateway).

View API tags

On the Service Development page, double-click the name of the desired API in the API list.
In the panel on the right, click Property.
In the Tag section, view the tags of the current API.

Note You can also create, add, or delete tags for the current API in this section.

For published APIs, you can also view tags as follows:
1. In the upper-right corner of the page, click Service Management.
2. On the Manage APIs > Published APIs page, click the name of the desired API to go to the API Details page.
3. In the API Basic Information > Tag section, view the tags of the API.

Delete an API tag

On the Service Development page, double-click the name of the desired API in the API list.
In the panel on the right, click Property.
In the Tag section, view the tags of the current API.
Click the icon next to the tag that you want to delete.
On the API editing page, click the icon in the toolbar.
In the upper-right corner of the page, click Publish. This action removes the tag from the published API.

Search for APIs by tag

On the Service Development page, click Service Management in the upper-right corner.
The Manage APIs > Published APIs page shows the tags for each API in the Tag column.
If an API has multiple tags, click ... to display all tags.
On the Published APIs page, click Advanced Search.
In the Tag section, enter a tag name to find all APIs with that tag.

Note You can search for APIs by multiple tags.