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服务

文字识别 OCR-如何获取图片base64编码

如何获取图片base64编码 OCR服务的输入图片参数是图片的base64编码，本节以Python为例，介绍如何将本地图片，转换为base64编码。您也可以使用在线的图片转base64工具。使用时，需要将代码的d:\demo.jpg替换为实际图片路径。 import base64 with open("d:/demo.jpg", "rb") as image_file: encoded_string = base64.b64encode(image_file.read()).decode() print(encoded_string) 父主题： API使用类

文字识别 OCR 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使用前必读

人脸识别服务 FRS-如何通过Postman获取用户Token:操作步骤

操作步骤编辑获取用户Token接口的Request URL、Header、Body，进行具体的API调用。 Request URL 格式为：https://IAM地区与终端节点地址/API接口URI 访问网址：地区与终端节点，获取IAM区域与终端节点地址。图1 IAM区域与终端节点访问网址：获取用户Token，获取API接口的URI。以cn-north-1为例，则Request URL为：https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 选择API接口获取方式，并将Request URL填写至postman中。图2 Request URL示例 Request Header key：Content-Type，value：application/json;charset=utf8 图3 Headers参数示例 Request Body 修改Request Body样例中参数。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "domain": { "name": "账号名" }, "name": "IAM用户名", "password": "IAM用户密码" } } }, "scope": { "project": { "name": " 人脸识别服务部署的区域，如cn-nouth-4" } } } } 登录获取Token的IAM用户，并获取账号名、IAM用户名，方法请参见：获取账号、IAM用户、项目名称和ID。单击“Send”，发送API请求。图4 发送API请求在返回的响应头中查看获取的用户Token，用户调用IAM其他API接口时，可以使用该Token进行鉴权。图5 获取Token 如果返回值为401，表示认证失败，请确认Request Body中请求参数填写正确后重新发送请求。如果返回值为400，表示body体格式错误，请检查body体格式是否满足json语法。详细错误请参考获取token返回值。如果您的调试结果异常，提示“Header Overflow”，可以参考故障处理解决Header溢出问题。

人脸识别服务 FRS API使用类

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

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

CODEARTS API 使用CodeArts API服务

智能数据洞察 DATAARTS INSIGHT-基本概念:项目

项目区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。在我的凭证下，您可以查看项目ID。图1 项目隔离模型

智能数据洞察 DATAARTS INSIGHT API使用前必读

图像搜索 IMAGESEARCH-有哪些途径可以使用图像搜索的API？

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

图像搜索 IMAGESEARCH API使用类

语音交互服务 SIS-Token消息体中user name，domain name和project name分别指的是什么

Token消息体中user name，domain name和project name分别指的是什么 user name指用户名称，domain name指用户所属的账号名称。如果是账号获取token，账号的user name和domain name相同。如果是IAM用户获取token（账号可以创建多个IAM用户），user name和domain name不相同，user name为实际的用户名称。 project name指项目名称，如“cn-north-4”。。父主题： API使用类

语音交互服务 SIS 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系列模型。

AI开发平台MODELARTS 通过Python API使用算法套件

AI开发平台MODELARTS-构建学习器:基于learner进行模型评估

基于learner进行模型评估 learner.validate( data=db, checkpoint="your_local_path_of_pretrained_model", gpu_ids=[0] ) 表3 learner.validate参数参数名称可选/必选参数类型参数描述 data 可选 DataBlock object 数据集对象，默认为None，初始化方法参考DataBlock模块。默认值时会基于构建好的DataBlock对象中的validation data进行模型评估。 checkpoint 可选 string 预训练模型路径，默认为None。当基于learner.fit完成训练且该参数为None，则基于训练后的模型参数进行评估。如果指定checkpoint路径，则加载对应路径的模型参数进行评估。 gpu_ids 可选 int/list 模型评估时使用的GPU序号。open-mmlab系列模型默认使用0号卡。ivg系列可指定，如0或者[0, 1]。 show_score_thr 可选 float 评估时预测结果置信度阈值，默认为0.5，仅用于open-mmlab系列模型。 out 可选 string 评估结果pkl文件保存路径，默认为None，仅用于open-mmlab系列模型。

AI开发平台MODELARTS 通过Python API使用算法套件

AI开发平台MODELARTS-构建学习器:基于learner进行模型训练

基于learner进行模型训练 learner.fit( lr=0.001, max_epochs=5, weight_decay=0.005, seed=None, checkpoint=None, gpu_ids=[0], world_size=1, local_size=1, launch_remote=False ) 表2 learner.fit参数参数名称可选/必选参数类型参数描述 lr 可选 float 学习率参数，默认为0.001。 max_epochs 可选 int/float 最大训练epoch数，默认为5。 weight_decay 可选 float 权重衰减，默认为0.005。 seed 可选 int 训练随机数，默认为None。 checkpoint 可选 string 预训练模型路径，优先级高于初始化Learner和Model时的路径参数，指定checkpoint入参后会覆盖初始化Learner或Model时对应checkpoint的模型参数。 gpu_ids 可选 int / list open-mmlab系列默认使用0号卡进行训练。ivg系列可指定，如0或者[0]或者[0,1]。 world_size 可选 int 分布式训练节点数量，默认为1，暂不支持分布式训练。 local_size 可选 int 单个节点中的GPU数量，默认为1，暂不支持分布式训练。 launch_remote 可选 boolean 提交训练作业，默认为False，暂不支持基于API提交训练作业。

AI开发平台MODELARTS 通过Python API使用算法套件

云服务器内容精选

API使用

7*24

备案

专业服务

退订

建议反馈

售前咨询热线