How to add an OpenAPI data source in DataV-DataV(DataV)-阿里云帮助中心

Prerequisites

An OpenAPI data source is ready to be added.

Limits

This feature is available only in DataV Enterprise Edition and later versions.

Add an OpenAPI data source

Access the DataV console.
On the Workbench page, click Data Preparation > Data Source in the navigation pane on the left. On the Data Source page, click New Data Source.
From the Type drop-down list, select OpenAPI.

Enter the OpenAPI information.

Parameter	Description
Custom Data Source Name	The display name for the data source. You can use any name.
EndPoint	The service endpoint for the OpenAPI. Obtain this from the API documentation of the cloud product. For example, the endpoint for ECS is `ecs.aliyuncs.com`, and the service endpoint for Cloud Monitor in the China (Hangzhou) region is `metrics.cn-hangzhou.aliyuncs.com`.
APIVersion	The API version of the cloud product. Obtain this from the API documentation. For example, the API version for Cloud Monitor is `2017-03-01`.
AppKey	The AccessKey ID of the account used to call the OpenAPI.
AppSecret	The AccessKey secret of the account used to call the OpenAPI.
Request Style	Select RPC or ROA.

After you enter the information, click OK to add the data source.

The new data source is automatically added to the data source list.

Use an OpenAPI data source

Access the DataV console.
On the Workbench page, hover over the data dashboard you want to edit and click Edit.

Important
If you haven't created a data dashboard on your Workbench page, please see Create a PC Dashboard Using a Template for guidance on creating one.
On the canvas editing page, select a widget from the canvas.

If your canvas lacks widgets, please add them first. For more information, see Widget Canvas Operations.
In the widget configuration panel on the right, select Data Source.
Set Data Source Type to OpenAPI.
From the Select Existing Data Source drop-down list, select the OpenAPI data source that you configured.
From the Request Method drop-down list, select a request method. You can select GET or POST. For more information about these methods, see Common request methods.
Enter the API Operation Name.

The name of the API operation to call, which corresponds to the Action parameter. Obtain this from the API list of the cloud product. For example, the value for Cloud Monitor is DescribeMetricList.
(Optional) Enter the Response Path.

Specify a path to extract a specific part of the OpenAPI response.
For example, if the OpenAPI response is:
```
{
    "data": [
        {
            "x": 1,
            "y": 2
        },
        {
            "x": 2,
            "y": 4
        }
    ]
}
```
If you enter data in the Response Path field, the following data is returned:
```
[
    {
        "x": 1,
        "y": 2
    },
    {
        "x": 2,
        "y": 4
    }
]
```
Note
You can also perform this transformation by using a filter. You can leave this field empty.
In the editor, enter the query parameters.
- The query parameters are the request parameters of the API operation. Enter them in JSON object format.
- For parameter names, see the request parameter descriptions in the API documentation of the cloud product.
- Enter the callback ID as a value in the JSON object.
For example, the following code shows the query parameters for the DescribeMetricList API operation of Cloud Monitor.
```
{
  "MetricName": "cpu_idle",
  "Namespace": "acs_ecs_dashboard",
  "Dimensions": [
    {
      "instanceId": "i-j6c0kyh2qh7fi0r4k351"
    }
  ],
  "StartTime": "2021-01-27 14:00:00",
  "EndTime": "2021-01-27 15:00:00",
  "Period": "60"
}
```
Select Object to Array to automatically convert the returned object to an array.

For example:
```
// Raw data
{
  "name": "..."
}
 => 
// Transformed data
[{
  "name": "..."
}]
```
Note
This option is not frequently used. We recommend that you use a filter to transform the data format.
Click View Data Response to view the data response.

What to do next

To use the data source in your widgets, see Configure a widget data source.

FAQ

For more information, see FAQ about data source configuration and usage.