API使用-华为云

智能数据洞察 DataArts Insight-概述

概述欢迎使用智能数据洞察（DataArts Insight）。智能数据洞察（DataArts Insight）是一站式数据可视化 BI开发平台，提供可视，实时，易用，安全的企业智能分析服务。适配云上云下多种数据源，提供丰富多样的可视化组件，采用拖拽式自由布局，轻松实现数据分析和报表搭建，快速定制专属数据大屏。您可以使用本文档提供API对智能数据洞察探索进行相关操作，包括获取数据源、准备数据集、数据分析、数据大屏等。支持的全部操作请参见API概览。在调用数据湖探索 API之前，请确保已经充分了解DataArts Insight相关概念。详细信息请参见产品介绍。父主题： API使用前必读

智能数据洞察 DataArts Insight API使用前必读

图引擎服务 GES-Gremlin/Cypher查询是否支持几条命令一起执行？

Gremlin/Cypher查询是否支持几条命令一起执行？ Gremlin支持多条命令一起执行，命令之间用分号隔开。例如： graph = EywaGraph.open('ges_6715');g = graph.traversal();g.V().limit(1) Cypher暂时不支持多条命令一起执行。 Cypher查询的语法请参考Cypher查询。Gremlin查询的语法请参考Gremlin查询。父主题： API使用类

图引擎服务 GES API使用类

CODEARTS API-创建、管理项目:创建项目

创建项目拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。填写项目基本信息。表1 新建项目参数说明字段名称是否必填备注说明项目名称是项目名称，限制128个字符。项目描述否项目描述，限制1024个字符。单击“确定”，完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。

CODEARTS API 使用CodeArts API服务

视频直播 LIVE-为什么调用API时提示“APIG.0301”？

为什么调用API时提示“APIG.0301”？调用API时提示“APIG.0301”，可能有以下两个原因：提示"error_msg":"Incorrect IAM authentication information: decrypt token fail","error_code":"APIG.0301"，是因为token解密失败，请检查token是否完整、是否过期、获取token与调用服务的区域是否跨区、账号是否因欠费等原因导致权限被限制。具体请参见Token认证鉴权。提示"error_msg":"Incorrect IAM authentication information: verify aksk signature fail","error_code":"APIG.0301"，是因为AK/SK认证失败，请检查AK/SK是否正确、账号是否因欠费等原因导致权限被限制。具体请参见AK/SK认证鉴权。父主题： API使用

视频直播 LIVE API使用

API全生命周期管理 ROMA API-Token认证:调用API示例

调用API示例获取Token ，并设置成环境变量，Token用于后续调用其他接口鉴权。获取用户Token，请求内容示例如下： curl -X POST https://{iam_endpoint}/v3/auth/tokens -H 'content-type: application/json' -d '{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "{user_name}", "domain": { "name": "{user_name}" }, "password": "{password}" } } }, "scope": { "project": { "id": "{project_id}" } } } }' -vk 上述命令中，部分参数请参见以下说明进行修改，具体请参考《统一身份认证服务API参考》的获取用户Token接口： {iam_endpoint}请参见地区和终端节点获取。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 {project_id}为项目ID。在管理控制台，将鼠标移至用户名，在下拉列表中单击“我的凭证”，查看“项目ID”。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值，如下图所示：图1 从返回消息的Header中获取X-Subject-Token 使用如下命令将token设置为环境变量，方便后续事项。 export Token={X-Subject-Token} X-Subject-Token即为1.a获取到的token，命令示例如下： export Token=MIIDkg******BZQMEAgEwg 调用API，请参考认证前准备获取域名、请求方法和URL，并在请求消息头中增加“X-Auth-Token”，“X-Auth-Token”的取值为1中获取的Token。参数请根据实际情况填写。 curl -X 请求方法域名+URL -H "x-auth-token: $Token" -vk

API全生命周期管理 ROMA API 使用IAM认证调用API

API全生命周期管理 ROMA API-认证前准备

认证前准备 APP认证方式调用API，需要提前获取如下信息：访问服务前，首先需要得到API的请求方法和请求url。在 API服务详情中的“API运行”页面，查看对应API的请求方法和请求url。图1 API基础定义您必须将API发布到环境才能访问。在API服务详情中的“API运行”页面，查看已发布的环境。图2 运行环境信息对于APP认证的API，您必须提供有效的AppKey、AppSecret才能够生成认证签名。在凭据策略详情页面，查看“应用凭据”的Key和Secret，即为APP的AppKey和AppSecret。图3 查看Key和Secret Key：APP访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 Secret：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。发送API请求时，需要将当前时间置于请求消息头的X-Sdk-Date，将签名信息置于请求消息头的Authorization。客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。 ROMA API除了校验时间格式外，还会校验该时间值与ROMA API收到请求的时间差，如果时间差超过15分钟，ROMA API将拒绝请求。父主题：使用APP认证调用API

API全生命周期管理 ROMA API 使用APP认证调用API

API全生命周期管理 ROMA API-Token认证:接口调用示例

接口调用示例本小节介绍使用API的基本流程。获取相关信息。已获取IAM的Endpoint，具体请参见地区和终端节点。在管理控制台，将鼠标移至用户名，在下拉列表中单击“我的凭证”，查看“项目ID”。获取用户Token，并设置成环境变量，Token用于后续调用其他接口鉴权。执行以下命令，获取用户Token。 curl -X POST https://{iam_endpoint}/v3/auth/tokens -H 'content-type: application/json' -d '{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "{user_name}", "domain": { "name": "{user_name}" }, "password": "{password}" } } }, "scope": { "project": { "id": "{project_id}" } } } }' -vk 上述命令中，部分参数请参见以下说明进行修改（具体请参考《统一身份认证服务API参考》）： {iam_endpoint}替换为前提条件中获取的IAM的Endpoint。 {project_id}替换为前提条件中获取的项目ID。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。响应Header中“X-Subject-Token”的值即为Token： X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCAxxxxxx38CAQExDTALBglghkgBZQMEAgEwg 使用如下命令将token设置为环境变量，方便后续事项。 export Token={X-Subject-Token} X-Subject-Token即为3.a获取到的token，命令示例如下。 export Token=MIIDkgYJKoZIhvcNAQcCoIIDgzCCAxxxxxx38CAQExDTALBglghkgBZQMEAgEwg 调用API，请参考认证前准备获取域名、请求方法和URL。参数请根据实际情况填写。 curl -X 请求方法域名+URL -H "x-auth-token: $Token" -vk

API全生命周期管理 ROMA API 使用IAM认证调用API

内容审核 MODERATION-有哪些途径可以使用内容审核的API？

有哪些途径可以使用内容审核的API？共有三种方式可以基于已构建好的请求消息发起请求。 cURL cURL是一个命令行工具，用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端，可以发送HTTP请求给服务端，并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/。编码通过编码调用接口，组装请求消息，并发送处理请求消息。 REST客户端 Mozilla、Google都为REST提供了图形化的浏览器插件，发送处理请求消息。针对Firefox，请参见Firefox RESTClient。针对Chrome，请参见Postman。父主题： API使用类

内容审核 MODERATION API使用类

CODEARTS API-管理项目成员与角色:邀请其他企业用户

邀请其他企业用户可以通过邀请其他企业用户，对当前项目进行查看或编辑。单击“添加成员”旁的下拉框，选择“邀请其他企业用户”。弹出“邀请其他企业用户”对话框，在“企业用户”输入框中输入企业用户ID，在“用户名称”输入框中输入需要邀请的用户名称后，单击右侧“添加用户”，可一次性添加同一企业不同用户。单击“确定”导入其他企业成员，默认为“浏览者”身份权限。可通过设置项目成员角色修改成员角色与权限。

CODEARTS API 使用CodeArts API服务

数据湖探索 DLI-概述

概述欢迎使用数据湖探索。数据湖探索（Data Lake Insight，简称 DLI ）是完全兼容Apache Spark、Apache Flink、trino生态，提供一站式的流处理、批处理、交互式分析的Serverless融合处理分析服务。用户不需要管理任何服务器，即开即用。支持标准SQL/Spark SQL/Flink SQL，支持多种接入方式，并兼容主流数据格式。数据无需复杂的抽取、转换、加载，使用SQL或程序就可以对云上CloudTable、RDS、DWS、 CSS 、OBS、E CS 自建数据库以及线下数据库的异构数据进行探索。您可以使用本文档提供API对数据湖探索进行相关操作，包括队列、SQL作业、Flink作业、Spark作业和跨源连接等等。支持的全部操作请参见API概览。在调用数据湖探索API之前，请确保已经充分了解数据湖探索相关概念。详细信息请参见产品介绍。父主题： API使用前必读

数据湖探索 DLI API使用前必读

AI开发平台MODELARTS-构建学习器:基于learner.predict进行模型推理

基于learner.predict进行模型推理 learner.predict( img_path='your_local_path_of_image', checkpoint='your_local_path_of_pretrained_model', gpu_ids=None, save_dir='your_local_path_for_saving_output' ) 表4 learner.predict参数参数名称可选/必选参数类型参数描述 img_path 必选 string 图片路径，当前predict仅支持推理图片。 checkpoint 可选 string 预训练模型路径，默认为None。当基于learner.fit完成训练且该参数为None，则基于训练后的模型参数进行推理。如果指定checkpoint路径，则加载对应路径的模型参数进行推理。 gpu_ids 可选 int/list 推理时使用的GPU，默认为None（使用cpu进行推理）。 save_dir 可选 string 默认为初始化Learner时指定的work_dir，可指定其他本地路径。 model 可选 Model object 自定义Model对象，仅用于open-mmlab系列模型，默认为None。默认值时使用基于learner.fit训练好的模型进行推理。 score_thr 可选 float 推理时结果置信度阈值，默认为0.3，仅用于open-mmlab系列模型。 ret_vis 可选 boolean 是否可视化推理结果，默认为False，仅用于open-mmlab系列模型。