检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 SIS服务提供了两种接口,包含REST(Representational State Transfer)API,支持您通过HTTPS请求调用,请参见表1。也包含WebSocket接口,支持Websocket协议,请参见表2。 表1 REST API功能 接口 功能 API
调用业务接口时,在请求消息头中需增加Content-Type的消息体。 父主题: 附录
步骤2:Token认证 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在Postman界面上,单击左侧导航树“获取token”配置文件。 选中“Body”的配置项,添加华为云用户名、密码、帐号名。
响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。SIS服务响应消息头无特殊用途,可用于定位问题使用。 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。
APIG.0101报错 访问的API不存在或尚未在环境中发布。The API does not exist or has not been published in the environment. 请检查API的URL是否拼写正确,例如,URL中是否缺少project_id。
APIG.0201报错 如果调用API时返回错误信息与错误码:"error_msg":"Backend timeout.","error_code":"APIG.0201",表示请求超时。 您可以尝试以下方案进行解决。
APIG.0301报错 如果在调用API时返回错误信息与错误码: "error_msg":"Incorrect IAM authentication information: decrypt token fail","error_code":"APIG.0301",是因为token
请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
API使用类 如何查看接口调用量 为什么WebSocket一直连接不成功 为什么会出现识别结果非常差的情况 如何使用Websocket调用实时语音识别 有哪些途径可以使用语音交互的API 返回状态正常,但识别结果为空 Token消息体中user name,domain name和project
获取Token后,再调用SIS服务API接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。
则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 Content-Type: application/json X-Auth-Token: ABCDEFJ....
响应消息头中X-Subject-Token的值即为Token。 响应参数 状态码: 200 表3 响应Body参数 参数 是否必选 参数类型 描述 vocabulary_id 是 String 调用成功返回热词表ID,调用失败时无此字段。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 在控制台中,鼠标移动至右上角的用户名处,在下拉列表中选择“我的凭证”。 图1 我的凭证入口 在“我的凭证”页面的项目列表中查看账号
响应消息头中X-Subject-Token的值即为Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 热词表的表名,用于筛选热词表表名。
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 返回错误码 描述 处理措施 SIS.0001 连接错误,如连接obs错误或者连接redis错误。 请联系技术支持工程师。
响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 热词表名,不可重复。内容限制为字母,数字,下中划线和井号,长度不超过32字节。
响应消息头中X-Subject-Token的值即为Token。 响应参数 无响应消息,以http状态码200表示成功。 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。 调用成功时无此字段。
响应消息头中X-Subject-Token的值即为Token。 Enterprise-Project-Id 否 String 企业项目ID。SIS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
Token消息体中user name,domain name和project name分别指的是什么 user name指用户名称,domain name指用户所属的账号名称。如果是账号获取token,账号的user name和domain name相同。如果是IAM用户获取token