You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,8 @@ The OpenAPI plugin is an extension tool designed specifically for Grafana, aimed
17
17
- Data driven insights: Gain an immediate understanding of your cloud environment, helping you make wise decisions for optimization and troubleshooting.
18
18
19
19
## Getting Started
20
-
1. Configuration: In the data source management panel, add a Pop data source. In the settings panel, set the Access Id and Access KeySecret of the Alibaba Cloud account that calls the API. It is best to configure it as the AK of the sub account. Calling may initiate online resource operations on the account. Please be careful and ensure that the account has the corresponding operation permissions. To ensure data security, AK is cleared after saving and will not echo. The data source provides some default products and parameter configurations. If you want to use products that do not provide default configurations, please refer to the corresponding product's OpenAPI documentation https://next.api.aliyun.com/document
21
-
2. Create a dashboard: You can start building your dashboard by adding a POP plugin panel and configuring the product, API name, action, and query parameters.
20
+
1. Configuration: In the data source management panel, add an OpenAPI data source. In the settings panel, set the Access Id and Access KeySecret of the Alibaba Cloud account that calls the API. It is best to configure it as the AK of the sub account. Calling may initiate online resource operations on the account. Please be careful and ensure that the account has the corresponding operation permissions. To ensure data security, AK is cleared after saving and will not echo. The data source provides some default products and parameter configurations. If you want to use products that do not provide default configurations, please refer to the corresponding product's OpenAPI documentation https://next.api.aliyun.com/document
21
+
2. Create a dashboard: You can start building your dashboard by adding an OpenAPI plugin panel and configuring the product, API name, action, and query parameters.
22
22
3. Data visualization: Customize the way plugins parse and display data, ensuring that relevant information can always be quickly obtained.
<!-- This README file is going to be the one displayed on the Grafana.com website for your plugin. Uncomment and replace the content here before publishing.
2
-
3
-
Remove any remaining comments before publishing as these may be displayed on Grafana.com -->
Badges convey useful information at a glance for users whether in the Catalog or viewing the source code. You can use the generator on [Shields.io](https://shields.io/badges/dynamic-json-badge) together with the Grafana.com API
39
-
to create dynamic badges that update automatically when you publish a new version to the marketplace.
40
22
41
-
- For the logo field use 'grafana'.
42
-
- Examples (label: query)
43
-
- Downloads: $.downloads
44
-
- Catalog Version: $.version
45
-
- Grafana Dependency: $.grafanaDependency
46
-
- Signature Type: $.versionSignatureType
23
+
---
47
24
48
-
Full example: 
49
-
50
-
Consider other [badges](https://shields.io/badges) as you feel appropriate for your project.
51
-
52
-
## Overview / Introduction
53
-
Provide one or more paragraphs as an introduction to your plugin to help users understand why they should use it.
54
-
55
-
Consider including screenshots:
56
-
- in [plugin.json](https://grafana.com/developers/plugin-tools/reference-plugin-json#info) include them as relative links.
57
-
- in the README ensure they are absolute URLs.
25
+
# OpenAPI
26
+
The OpenAPI plugin is an extension tool designed specifically for Grafana, aimed at enhancing the experience of the Grafana dashboard by visualizing JSON data returned from Alibaba Cloud OpenAPI. It seamlessly integrates with Grafana, allowing you to make API calls to Alibaba Cloud services directly from the Grafana dashboard and visualize JSON responses.
58
27
59
28
## Requirements
60
-
List any requirements or dependencies they may need to run the plugin.
29
+
- Grafana version 9.0. x or higher.
30
+
- Access Alibaba Cloud accounts and keys through APIs with applicable permission settings.
31
+
32
+
## Featues
33
+
- Easy integration: Easily integrate within your existing Grafana instance with minimal configuration.
34
+
- Real time visualization: Convert JSON responses from Alibaba Cloud OpenAPI into interactive charts and graphics in real time.
35
+
- Customizable dashboard: Effectively create customized visual representations to monitor and analyze your Alibaba Cloud resources.
36
+
- User friendly interface: Easy navigation and plugin configuration, bringing powerful analysis functions to users.
37
+
- Data driven insights: Gain an immediate understanding of your cloud environment, helping you make wise decisions for optimization and troubleshooting.
61
38
62
39
## Getting Started
63
-
Provide a quick start on how to configure and use the plugin.
40
+
1. Configuration: In the data source management panel, add an OpenAPI data source. In the settings panel, set the Access Id and Access KeySecret of the Alibaba Cloud account that calls the API. It is best to configure it as the AK of the sub account. Calling may initiate online resource operations on the account. Please be careful and ensure that the account has the corresponding operation permissions. To ensure data security, AK is cleared after saving and will not echo. The data source provides some default products and parameter configurations. If you want to use products that do not provide default configurations, please refer to the corresponding product's OpenAPI documentation https://next.api.aliyun.com/document
41
+
2. Create a dashboard: You can start building your dashboard by adding an OpenAPI plugin panel and configuring the product, API name, action, and query parameters.
42
+
3. Data visualization: Customize the way plugins parse and display data, ensuring that relevant information can always be quickly obtained.
43
+
44
+
## Support
45
+
If you encounter any problems or need help, please join the DingTalk group 34785590.
64
46
65
-
## Documentation
66
-
If your project has dedicated documentation available for users, provide links here. For help in following Grafana's style recommendations for technical documentation, refer to our [Writer's Toolkit](https://grafana.com/docs/writers-toolkit/).
0 commit comments