通过不同方式调用API-华为云

数据治理中心 DATAARTS STUDIO-通过浏览器调用无认证方式的API:调用API

调用API 打开Chrome浏览器，新建一个空白页签。参考获取API信息，在浏览器中输入API调用地址并直接访问。注意如果入参中包含Path和Query参数，则需要将调用地址中的{path}变量修改为Path参数具体取值，Query参数取值可以通过“?Query参数名=Query参数值”的形式添加到调用地址的最后，如本例中为“?query=1”。 https://xx.xx.xx.xx/getContestantInfo/2?query=1 如果您需要对调用结果进行自定义调整，则还可以配置如下Query参数，通过“&”连接多个参数：（可选）分页配置：默认情况下，对于配置方式和默认分页的脚本/MyBatis方式API，系统将默认赋值返回量。如果需要获取特定分页数据，您可以添加如下参数设置分页，其中pageSize表示分页后的页面大小，pageNum表示页码。 https://xx.xx.xx.xx/getContestantInfo/2?query=1&pageSize=100&pageNum=1 自定义分页的脚本/MyBatis方式API是在创建API时将分页逻辑写到取数SQL中，因此不支持在调用时修改分页设置。（可选）排序配置：默认情况下，系统会根据排序参数信息给出默认排序情况，自定义排序默认为升序。如果需要修改排序情况，您可以修改pre_order_by参数。其中排序参数描述pre_order_by的值填写形式为“排序参数参数名:ASC”或“排序参数参数名:DESC”，其中ASC表示升序，DESC表示降序，多个排序参数描述以“英文分号”进行分隔。 https://xx.xx.xx.xx/getContestantInfo/2?query=1&pre_order_by=id:ASC;age:ASC;score:DESC 对于pre_order_by的值，您可以进行如下修改：删掉某可选的排序参数，则此排序参数不再参与排序。修改自定义排序方式的排序参数为升序或降序方式，则此排序参数按照修改后的排序方式排序。 pre_order_by的值，不支持进行如下修改，否则会修改不生效或导致调用报错。删掉某必选的排序参数，则此排序参数依然会正常参与排序，删除不生效。调整排序参数的前后顺序，则排序依然以配置方式API配置排序参数时的排序参数顺序或脚本/MyBatis方式API SQL中的排序参数顺序为准，调整不生效。修改升序或降序的排序参数为其他排序方式，则会调用失败，不允许修改。（可选）“返回总条数”配置：在创建API时，如果已打开“返回总条数”开关，则当API对应的数据表数据量较大时，获取数据总条数将会比较耗时。此时，如果需要在调用时不计算并返回数据总条数，可以修改use_total_num参数。use_total_num参数用于控制是否计算并返回数据总条数，值为1返回数据总条数，值非1不返回数据总条数。 https://xx.xx.xx.xx/getContestantInfo/2?query=1&use_total_num=0 浏览器访问后可查看返回结果。返回"errCode":"DLM.0"即表示API调用成功。如果失败，则请根据保错信息进行修复。图2 使用浏览器调用API

数据治理中心 DATAARTS STUDIO 通过不同方式调用API

数据治理中心 DATAARTS STUDIO-通过浏览器调用无认证方式的API:获取API信息

获取API信息参考访问 DataArts Studio 实例控制台，登录DataArts Studio管理控制台。在DataArts Studio控制台首页，选择对应工作空间的“数据服务”模块，进入数据服务页面。在左侧导航栏选择服务版本（例如：专享版），进入总览页。获取待调用API的调用地址、请求方法和入参信息。在左侧导航栏中进入API管理，找到待调用的API，并单击API名称查看API的完整信息，保存调用地址、请求方法和入参信息。调用地址：专享版支持内网地址和外网地址（外网地址需要您在创建集群时绑定弹性IP），如果需要在本地调用专享版API，需要使用外网地址，确保网络互通。共享版使用APIG地址，可直接选择该地址进行调用。入参：本调用样例中创建了一个具备Query和Path入参位置的API，以便为您介绍入参应如何在调用时输入。图1 保存调用地址、请求方法和入参信息

数据治理中心 DATAARTS STUDIO 通过不同方式调用API

数据治理中心 DATAARTS STUDIO-通过浏览器调用无认证方式的API:约束与限制

约束与限制如需在本地调用专享版API，则需在创建专享版集群时绑定一个弹性公网IP，作为实例的公网入口。共享版API默认可通过公网访问。调用数据服务API时，如果查询及返回数据的总时长超过默认60秒则会报超时错误。此时可通过访问日志中的API调用时长信息，根据超时阶段进一步优化API配置。 ____________Duration information__________ duration: 60491ms //总耗时 url_duration: 0ms //URL匹配耗时 auth_duration: 70ms //鉴权耗时 befor_sql_duration: 402ms //执行SQL预处理耗时 sql_duration: 60001ms //SQL执行耗时 after_sql_duration:18ms //执行SQL后处理耗时

数据治理中心 DATAARTS STUDIO 通过不同方式调用API

数据治理中心 DATAARTS STUDIO-调用API方式简介

调用API方式简介创建API时，有三种认证方式可选，不同认证方式的API支持的调用方式也有所不同，详见表1。表1 API认证与调用方式说明认证方式安全级别授权与认证机制支持的调用方式调用方法示例使用说明（推荐）APP认证高通过APP应用将API授权给应用后，使用应用的密钥对（AppKey和AppSecret）进行安全认证。（推荐）SDK调用：支持Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等多种语言。 API工具调用：需要通过JavaScript SDK包中的demo.html手动生成签名后，再使用API工具调用。（推荐）通过SDK调用APP认证方式的API 通过API工具调用APP认证方式的API 推荐使用APP认证+SDK调用方式，帮助您简单、快速地通过数据API获取到开放数据。 IAM 认证中通过IAM应用或白名单将API授权给账号后，借助从IAM服务获取的用户Token进行安全认证。 API工具调用：需要调用IAM服务的获取用户Token接口获取Token ，再使用API工具调用。通过API工具调用IAM认证方式的API API工具调用场景可使用IAM认证方式。无认证低无需授权，所有用户均可访问。 API工具调用：直接调用，无需认证信息。浏览器调用：当API入参位置在Query和Path时，支持浏览器调用。如果入参位置在Header或Body，由于无法传参因此不支持浏览器调用。通过API工具调用无认证方式的API 通过浏览器调用无认证方式的API 无认证方式建议仅在测试接口时使用，不推荐正式使用。若调用方为不可信任用户，则存在数据库安全风险（如数据泄露、数据库高并发访问导致宕机、SQL注入等风险）。父主题：通过不同方式调用API

数据治理中心 DATAARTS STUDIO 通过不同方式调用API

云服务器内容精选

通过不同方式调用API

7*24

备案

专业服务

退订

建议反馈

售前咨询热线