API Explorer 介绍

API Explorer是华为云为开发者提供的一站式API解决方案统一平台,集成华为云服务开放API,支持全量快速检索、可视化调试、帮助文档、帮助开发者(包括基于华为云开放API管理云资）更方便快捷的使用华为云服务。

API Explorer提供以下功能

1. API检索
汇集了华为云多个产品的API，可以在此集中检索，快速找到您所需要的API。
2. API调用
无需编写代码，在调用页面中填写请求参数，便可调用API。
3.查看API请求
根据您填写的请求参数自动生成API请求，并打印到网页上，让您直观的查看到真实发送的API请求。
4.结构化输出返回结果
根据API请求，返回真实的API调用结果，结构化输出。

API Explorer在GaussDB(DWS) 中的使用

进入API Explorer概览页面，在“搜索API或产品”搜索框输入需要查询的API接口或者服务(这里输入“创建集群”或者DWS)，然后在下拉框列表中选中对应服务的API接口或者服务(数据仓库服务对应的接口或服务)点击，即可进入对应服务的DWS的API Explorer页面

以下为进入后的DWS的API Explorer页面，其中左侧第二栏为数据仓库服务的Open API接口，左侧第三栏为接口调用参数输入和接口的调试，最右侧包含了CLI示例、调试结果、文档、模拟数据、场景示例页签，功能分别为：

1. CLI示例

华为CLI命令行工具是基于华为云开放API构建工具，您可以在命令行中使用hcloud命令与华为云服务进行交互，管理您的华为云资源。华为云CLI提供了对华为云产品开放API的直接访问，您可以基于华为云CLI开发Shell脚本，来管理和维护自己的华为云资源。 CLI用户指南

2. 调试结果

接口调试的结果显示，发起调试后，APIExplorer会使用已登录账号的临时Token执行请求，部分接口调用涉及云产品计费，请谨慎操作

3. 文档

用于对于左侧接口的说明，包括URL格式、请求参数、请求示例、请求返回值的详细描述

4.模拟数据

提供API真实调用模拟数据，支持在开发环境中验证API请求结果，实现不同场景下API返回的逻辑处理。

5.场景示例

接口应用场景的列表，每行数据描述了当前接口实际的应用场景。

示例(查询DWS集群列表)

1.在接口列表中选中对应的接口；

2.选择服务需要执行接口的Region；

3.选择对应的项目ID；

4.如果有body参数，输入对应的body参数

5.点击调试按钮

经过以上步骤进行调试后，调试的结果会显示在右侧列表中，会把对应的请求数据的请求头，请求体，响应结果的响应头和响应体显示在页面。

对于参数疑问，也可以参考DWS接口文档