how to view and manage apis - Dataphin - Alibaba Cloud Documentation Center

Permission description

Super administrators can manage all APIs.
Project administrators can manage APIs in the projects they own.
API owners can manage the APIs they own.

API list entry

In the top navigation bar of the Dataphin homepage, choose Service > API Development.
In the upper-left corner, select a service project. Then, in the navigation pane on the left, choose API Service > API to go to the API list page.
You can search for an API by its name or ID. You can also use the quick filters APIs Submitted Today or My APIs, or filter by operation type, API type, data source, API group, last submission time, pattern, invocation mode, current status, or owner.

My APIs: APIs that you own. This does not include APIs for which you have requested permissions.
The API list displays all created APIs with details such as name, ID, API type, data source, invocation mode, pattern (environment), operation type, status, runtime environment, published version, publication information, data update frequency, API group, owner, associated applications, permission information, and data volume.

You can perform the following operations in the operation column of a target API.

Operation	Description
Publish	Click Publish in the operation column or select the APIs to be published and click Batch Publish at the bottom. In the API Publication dialog box, select the submitted version to be published to publish the API to the production environment. For more information, see Step 2: Publish an API. Note If a version is already published, the system verifies parameters when a new version is published. Verification checks include adding required request parameters, removing request parameters, removing response parameters, changing request parameter data types, and changing the invocation type. Publishing a new version affects API invocation. You can configure publication control mechanisms for a project. The system blocks or publishes the API based on the project configuration. For more information, see Create service projects. APIs created based on logical tables do not support batch publishing. During batch publishing, if no version is selected, the API is not published.
Edit	Click the Edit icon in the operation column to go to the Edit API page. Note The system opens the edit page of the latest API version by default. To modify a different version, switch the API version in the upper-right corner of the edit page. When the API version is in the submitted or draft state, you can switch APIs in the upper-left corner of the page. Use fuzzy search by name or ID to switch between APIs you can access in the current service project. The system recommends the last nine APIs you accessed in the current project. If the latest version is in the published state, you cannot edit it directly. The system automatically creates a new version based on the latest published version and fills in the version number. Confirm the version details and click OK to go to the Add API Version page. When the API version is in the submitted or draft state, you can go directly to the API edit page.
Test	Click the Test icon in the operation column to go to the Developer > API > API Test page. The system automatically loads the latest testable version (submitted or published) of the current API. Note In the test environment, multiple API versions can coexist. Based on the test results, you can publish the version with better feedback to online applications. For more information, see Step 1: Test an API.
Version Management	Click the More icon in the operation column and select Version Management. In the Version Management panel, you can edit, test, compare, delete, and clone different versions of the API. Note If downstream applications cannot modify the API_ID when invoking the API and the data source or query conditions change, you can develop and test multiple versions, then publish the new version to the production environment to overwrite the original. This avoids adjustments on the downstream side. For more information, see API multi-version management.
Modify API properties	Click the More icon in the operation column and select Modify API properties . In the Modify API properties dialog box, you can modify the API name, API group . The naming conventions for the name are the same as those for creating a new API.
Change Owner	Click the More icon in the operation column and select Change Owner. In the Change Owner dialog box, select User Account. You can transfer the API to another developer or project administrator in the project. Click OK to change the owner.
Clone API	Click the More icon in the operation column and select Clone API. In the Clone API dialog box, select the version to be cloned and click OK to go to the Create API page where you can modify more information. Note Cloning an API clones all information of the selected version of the API and creates a new API. Because API names must be unique within a project, modify the name of the new API to avoid submission failures. The system selects the latest submitted (including published) version by default. You can clone any version of the current API regardless of its state.
Delete	Click the More icon in the operation column and select Delete. If the API has no dependencies, click OK in the API Delete dialog box to delete it. If the API permissions have been granted to applications or the API is referenced by a composite API, you must revoke the permissions granted to applications or remove the reference from the composite API before you can delete the API.

API multi-version management

Add an API version

On the API list page, click Version Management in the operation column to go to the Version Management panel.

In the Version Management panel, click Add Version and configure the parameters.

Parameter	Description
Based On Existing Version	The most recent version is filled in by default. You can select any version of the current API regardless of its state.
Version Number	The system fills in a default version number, which you can modify. The version number must be unique for the API, limited to 64 characters.

Click OK to go to the Add API Version page and configure the parameters.
After you confirm the information, click Submit to create the new API version. You can then manage the API on the API list page.

Manage API versions

Area	Description
①API name	The name of the current API.
②List area	Shows the version number, status, creator, and update time.
③Operation area	Different operations are supported for versions in different states. Draft state: View details, edit, clone API, and delete. Published state (version currently in use online): View details, test, compare versions, and clone API. Published state (historical published version): View details, test, compare versions, clone API, and delete. Submitted state: View details, test, edit, compare versions, clone API, and delete. The available operations: View Details: Click View in the operation column to view the API configuration details. You can switch versions in the upper-right corner of the page to view configuration details. You can switch APIs in the upper-left corner of the page. Use fuzzy search by name or ID to switch between APIs you can access in the current service project. The system recommends the last nine APIs you accessed in the current project. You can click the Edit API or Test API button at the bottom to quickly edit or test the API. When the API is in the draft state, the Test API operation is not supported. When the API is a direct-connect data source API (query type) and row-level permissions are enabled, row-level permission information is displayed. You can switch to view the row-level permission information associated with the API for the corresponding environment and version. Test: Click Test in the operation column to go to the Developer > API > API Test page. The system opens the current version's test page by default, loading the latest testable version (submitted or published). You can switch versions in the upper-right corner of the page to test different versions. You can switch submitted or published APIs in the upper-left corner of the page. Use fuzzy search by name or ID to switch between APIs you can access in the current service project. The system recommends the last nine APIs you accessed in the current project. In the test environment, multiple API versions can coexist. Based on the test results, you can publish the version with better feedback to online applications. For more information, see Step 1: Test an API. Version Comparison: Click Version Comparison in the operation column to switch and view the differences between two versions. Note Only submitted and published versions can be compared. Version comparison requires at least two such versions. Draft versions cannot be compared. Direct connection data source APIs, SQL mode APIs (service units and logical tables), and composite APIs support script comparison for viewing and comparing script content. When the API uses asynchronous invocation, cache settings, cache duration, and result paging information are not displayed. When the API type is direct connection data source API and row-level permissions are enabled, row-level permission list comparison information is displayed. You can switch to view the row-level permission information associated with the API under the corresponding version. Clone API: Click More-Clone API in the operation column. In the Clone API dialog box, select the version to be cloned and click OK to go to the Create API page where you can modify more information. Note Cloning an API clones all information of the selected version of the API and creates a new API. Because API names must be unique within a project, modify the name of the new API to avoid submission failures. The system selects the latest submitted (including published) version by default. You can clone any version of the current API regardless of its state. Edit: Click Edit in the operation column to go to the Edit API page. Note The system opens the edit page of the latest API version by default. To modify a different version, switch the API version in the upper-right corner of the edit page. When the API version is in the submitted or draft state, you can switch APIs in the upper-left corner of the page. Use fuzzy search by name or ID to switch between APIs you can access in the current service project. The system recommends the last nine APIs you accessed in the current project. If the latest version is in the published state, you cannot edit it directly. The system automatically creates a new version based on the latest published version and fills in the version number. Confirm the version details and click OK to go to the Add API Version page. When the API version is in the submitted or draft state, you can go directly to the API edit page. Delete: Click More-Delete in the operation column. If the API has no dependencies, click OK in the API Delete dialog box to delete it. If the API permissions have been granted to applications or the API is referenced by a composite API, you must revoke the permissions granted to applications or remove the reference from the composite API before you can delete the API.