DataArts DataService API Overview
|
Type |
Description |
|---|---|
|
API management APIs |
|
|
Application management APIs |
|
|
Message management APIs |
|
|
Authorization management APIs |
|
|
Service catalog management APIs |
|
|
Gateway management APIs |
|
|
App management APIs |
|
|
Overview APIs |
|
|
Cluster management APIs. |
API Management
|
API |
Description |
|---|---|
|
This API is used to create an API. |
|
|
This API is used to query the API list. |
|
|
This API is used to update an API. |
|
|
This API is used to query API information. |
|
|
This API is used to delete APIs. |
|
|
This API is used to publish an API. Only published APIs can be called. You can choose to publish an API to a specified gateway. |
|
|
This API is used to unpublish, stop, or recover an API. After the API is unpublished, its authorization will be canceled and the API cannot be called. |
|
|
An app cannot access any APIs after being created. To enable an app to access an API, authorize the API to the app. After the authorization is successful, the app can access the API within the validity period. |
|
|
This API is used to debug an API. |
|
|
The API reviewer can initiate a request to authorize an API. After the authorization is successful, the app can access the API within the validity period. API authorization includes authorization and renewal. |
|
|
Querying API Publishing Messages in DataArts DataService Exclusive |
This API is used to query the API publishing messages in different clusters. |
|
Querying Instances for API Operations in DataArts DataService Exclusive |
This API is used to query instances for API operations. |
|
Querying API Debugging Messages in DataArts DataService Exclusive |
This API is used to query the API debugging information in different clusters. |
|
This API is used to import an Excel file that contains APIs. |
|
|
This API is used to export an Excel file that contains APIs. |
|
|
This API is used to export a .zip file that contains all APIs. |
|
|
This API is used to download an Excel template. |
Application Management
|
API |
Description |
|---|---|
|
This API is used to query the application list. |
|
|
This API is used to review an application. |
|
|
This API is used to obtain the details of an application. |
Message Management
|
API |
Description |
|---|---|
|
This API is used to query the list of notification messages in the review center. Different from applications, notification messages cannot be rejected and can be processed only within a specified time period. |
|
|
This API is used to process received notification messages within a specified time period. |
|
|
This API is used to obtain the details of a message. This function is only used for displaying application details and not for processing. Therefore, background parameters such as the ID are not displayed. |
Authorization Management
|
API |
Description |
|---|---|
|
This API is used to query the apps that have been authorized to call an API. |
|
|
This API is used to query authorized APIs of an app. |
Service Catalog Management
|
API |
Description |
|---|---|
|
This API is used to obtain the list of APIs and catalogs in the current catalog. The list is displayed in the data format of the catalog. |
|
|
This API is used to obtain the list of APIs in a catalog. |
|
|
This API is used to obtain the list of sub-catalogs in a catalog. (The returned sub-catalogs are displayed on the same page. It is recommended that this API be used only in scenarios where pagination is not supported, for example, generating a catalog tree.) |
|
|
This API is used to update a service catalog. |
|
|
This API is used to query a service catalog. |
|
|
This API is used to create a service catalog. The ID of the root directory is 0. |
|
|
This API is used to delete service catalogs. |
|
|
This API is used to move a catalog to another catalog. |
|
|
This API is used to move APIs to another catalog. |
|
|
This API is used to obtain the ID through the path. |
|
|
This API is used to obtain the path through the ID. |
|
|
This API is used to obtain the path to a catalog through its ID. |
|
|
This API is used to query the service catalog API list. |
Gateway Management
|
API |
Description |
|---|---|
|
This API is used to obtain a gateway instance (exclusive edition). |
|
|
This API is used to obtain a gateway group. |
App Management
|
API |
Description |
|---|---|
|
This API is used to create an app. |
|
|
This API is used to query the app list. |
|
|
This API is used to update an app. |
|
|
This API is used to delete an app. |
|
|
This API is used to query the details of an app. |
Overview
|
API |
Description |
|---|---|
|
This API is used to query the API overview. |
|
|
This API is used to query the app overview. |
|
|
This API is used to query the top N APIs called. |
|
|
This API is used to query the top N apps used. |
|
|
This API is used to query API statistics details. |
|
|
This API is used to query app statistics details. |
|
|
This API is used to query API dashboard data details. |
|
|
This API is used to query details of a specified API dashboard. |
|
|
This API is used to query app dashboard data details. |
|
|
This API is used to query top N APIs called by a specified app. |
Cluster Management
|
API |
Description |
|---|---|
|
This API is used to query the cluster overview information list. |
|
|
This API is used to query the list of cluster details. |
|
|
This API is used to query the details of a cluster. |
|
|
Querying the Access Log List of a DataArts DataService Cluster |
This API is used to query the access log list of a DataArts DataService cluster. |
|
This API is used to enable log dump to OBS for DataArts DataService clusters. |
|
|
This API is used to enable log dump to LTS for DataArts DataService clusters. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
