How to view and manage APIs - Dataphin - Alibaba Cloud Documentation Center

After you create an API, you can manage its versions, transfer ownership, and perform other management tasks.

Permissions

A super administrator can manage all APIs.
A project administrator can manage APIs in their projects.
An API owner can manage the APIs they own.

Access the API list

In the top navigation bar of the Dataphin homepage, choose Services > API Studio.
In the upper-left corner, select a service project. Then, in the left-side navigation pane, choose API Service > API to open the API list page.
You can search for an API by its name or ID. You can also use quick filters such as Submitted Today or My APIs. Alternatively, you can filter APIs by operation type, API type, data source, API group, last submission time, mode, invocation mode, current status, or owner.
My APIs: This filter shows the APIs you own. It does not include APIs for which you have only been granted usage permissions.
The API list displays your APIs and their details, including name and ID, API type, data source, invocation mode, mode (environment), operation type, current status, runtime environment, published version, release information, data update frequency, API group, owner, the number of applications associated with the API, permission information, and data volume.

In the Actions column for an API, you can perform these operations. For workflow APIs, only the Test and Version Management operations are supported.

Actions	Description
Publish	Click Publish in the Actions column, or select the APIs that you want to publish and click Batch Publish at the bottom. In the Publish API dialog box, select a submitted version to publish the API to the production environment. For more information, see Step 2: Publish the API. Note If a version is already published, the system validates the new version for breaking changes before publishing. This validation checks for changes such as adding a new required request parameter, removing a request parameter or response parameter, changing the data type of a request parameter, or changing the invocation type. The system then blocks or allows the release based on your configured policies. For more information, see Create service projects. APIs created from a logical table do not support batch publishing. During batch publishing, if you do not select a version for an API, that API is not published.
Edit	Click the Edit icon in the Actions column to open the API editing page. Note By default, the system opens the editing page for the latest version of the API. To edit a different version, you can switch versions in the upper-right corner of the page. When an API version is in the submitted state or draft state, you can switch to another API from the upper-left corner of the page. You can search for APIs by name or ID within the current service project. The system recommends the last nine APIs that you have recently accessed (viewed, edited, tested, or created) in the project. You cannot directly edit the latest published version of an API. Instead, the system automatically creates a new version based on it and suggests a version number. After you confirm the version details, click OK to proceed to the Create API Version page. If an API version is in the submitted state or draft state, you can directly open its editing page.
Test	Clicking the Test icon in the Actions column opens the Development > API > API Test page, which automatically loads the latest testable version of the API (a version in the submitted state or published state). Note In the testing environment, multiple API versions can coexist and be tested simultaneously. This allows you to compare the performance of different versions and publish the best-performing one. For more information, see Step 1: Test the API.
Version Management	Click the More icon in the Actions column and select Version Management. In the Version Management panel, you can edit, debug, compare versions, delete, and clone different API versions. Note If a downstream application cannot change the API ID it calls, you can use versioning to manage changes to the API's data source or query conditions. Develop and test a new version, and then publish it to the production environment to overwrite the old one. This process avoids client-side changes. For configuration details, see API multi-version management.
Modify API Properties	Click the More icon in the Actions column and select Modify API Properties. In the Modify API Properties dialog box, you can change the API's name, API group. The naming conventions for the API name are the same as when you create a new API.
Transfer Owner	Click the More icon in the Actions column and select Transfer Owner. In the Transfer Owner dialog box, select a Personal Account. You can transfer the API to another developer or a project administrator within the same project. Click OK to complete the transfer.
Clone API	Click the More icon in the Actions column and select Clone API. In the Clone API dialog box, select the version that you want to clone and click OK. This action opens the create API page, where you can modify more details. Note Cloning an API creates a new API with all the information from the selected version. Because API names must be unique within a project, you must change the name of the new API to avoid submission errors. By default, the system selects the latest submitted or published version. You can clone any version of the API, regardless of its state.
Delete	Click the More icon in the Actions column and select Delete. If the API has no dependencies, click OK in the Delete API dialog box to delete it. If an application has been granted permissions to the API or the API is referenced by a composite API, you must first revoke the permissions or remove the reference before you can delete it.

API version management

Creating an API version

Workflow APIs do not support creating new versions from this interface. To create a new version for a workflow API, go to R&D > Data Development > Workflow and select the target workflow.

On the API list page, click Version Management in the Actions column to open the Version Management panel.

In the Version Management panel, click Create Version and configure the following parameters.

Parameter	Description
Based on Existing Version	The latest version is selected by default. You can choose any existing version of the API, regardless of its state.
Version Number	The system suggests a version number, which you can change. Each API version must have a unique version number to enable comparison with previous versions. The version number can be up to 64 characters long and must be unique for the API.

Click Confirm to open the Create API Version page and configure the API parameters.
After you confirm that the information is correct, click Submit to create the new API version. You can then manage the API from the API list page.

Managing API versions

Area	Description
① API Name	Displays the name of the current API.
② List area	Displays the version number, version status, creator, and update time.
③ Actions area	The available actions depend on the version's state. For workflow APIs, only View, Test, and Version Comparison are supported. Draft: You can view details, edit, clone the API, or delete the version. Published (in use): You can view details, test, compare versions, or clone the API. Published (historical): You can view details, test, compare versions, clone the API, or delete the version. Submitted: You can view details, test, edit, compare versions, clone the API, or delete the version. The following actions are available: View Details: Click View in the Actions column to see the API's configuration details. You can switch between versions in the upper-right corner to view their respective details. You can switch to another API from the upper-left corner of the page. You can search for APIs by name or ID within the current service project. The system recommends the last nine APIs that you have recently accessed (viewed, edited, tested, or created) in the project. You can click the Edit API or Test API buttons at the bottom of the page. Testing is not supported for draft versions. For direct-connect data source APIs (query type) with row-level permission enabled, the row-level permission information is displayed. You can switch between environments and versions to view the associated row-level permissions for the API. Test: Click Test in the Actions column. You are redirected to the Development > API > API Test page, which defaults to the test page for the current version. The system automatically loads the latest testable version of the API (a version in the submitted or published state). You can switch to a different version for testing in the upper-right corner of the page. You can switch to another submitted or published API from the upper-left corner. You can search for APIs by name or ID within the current service project. The system recommends the last nine APIs that you have recently accessed (viewed, edited, tested, or created) in the project. In the testing environment, multiple API versions can coexist and be tested. This allows you to compare their performance and publish the best one. For more information, see Step 1: Test the API. Version Comparison: Click Version Comparison in the Actions column to view the differences between two versions. Note Only submitted and published versions can be compared. Version comparison is not available if there is only one submitted or published version. Draft versions cannot be compared. For direct-connect data source APIs, SQL-based APIs (service unit and logical table), and composite APIs, a script comparison view is available for comparing script content. When an API uses asynchronous invocation, cache settings, cache duration, and result pagination information are not displayed. For direct-connect data source APIs with row-level permission enabled, the comparison view includes a list of row-level permissions. You can switch between versions to see the associated permissions for each. Clone API: Click More > Clone API in the Actions column. In the Clone API dialog box, select the version that you want to clone and click OK. This action opens the create API page, where you can modify more details. Note Cloning an API creates a new API with all the information from the selected version. Because API names must be unique within a project, you must change the name of the new API to avoid submission errors. By default, the system selects the latest submitted or published version. You can clone any version of the API, regardless of its state. Edit: Click Edit in the Actions column to open the API editing page. Note By default, the system opens the editing page for the latest version of the API. To edit a different version, you can switch versions in the upper-right corner of the page. When an API version is in the submitted state or draft state, you can switch to another API from the upper-left corner of the page. You can search for APIs by name or ID within the current service project. The system recommends the last nine APIs that you have recently accessed (viewed, edited, tested, or created) in the project. You cannot directly edit the latest published version of an API. Instead, the system automatically creates a new version based on it and suggests a version number. After you confirm the version details, click OK to proceed to the Create API Version page. When an API version is in the submitted or draft state, you can go directly to the API editing page. Delete: Click More > Delete in the Actions column. If the API has no dependencies, click OK in the Delete API dialog box to delete it. If an application has permissions for the API or the API is referenced by a composite API, you must first revoke those permissions or remove the reference before you can delete it.