华为云用户手册

响应参数 响应类为AsrCustomLongResponse，详见表4。调用失败处理方法请参见错误码。 表4 AsrCustomLongResponse 参数名称 是否必选 参数类型 描述 status 是 String 描述返回状态。 WAITING 等待识别。 FINISHED识别已经完成。 ERROR 识别过程中发生错误。 createTime 否 String 任务创建时间。格式如2018-12-04T13:10:29.310Z。 startTime 否 String 开始识别时间。格式如2018-12-04T13:10:29.310Z。 finishTime 否 String 识别完成时间。格式如2018-12-04T13:10:29.310Z。 audioDuration 否 Integer 提交音频时长，单位ms。 segments 否 Array of objects 识别结果, 多句结果的数组。 数据结构参见表5。 表5 Segment 参数名 是否必选 参数类型 说明 start_time 是 Integer 一句的起始时间戳，单位ms。 end_time 是 Integer 一句的结束时间戳，单位ms。 result 是 Object 调用成功表示识别结果，调用失败时无此字段。数据结构参见表6。 表6 Result 参数名 是否必选 参数类型 说明 text 是 String 识别结果文本。 analysis_info 否 Object 每一句的质检分析结果对象。 仅在识别配置中的need_analysis_info不为null时存在该返回结果。数据结构参见表7。 word_info 否 Array of Object 分词输出列表。 表7 Analysisinfo 参数名 是否必选 参数类型 说明 role 否 String 角色类型，目前仅支持 AGENT（座席），USER（用户）。 emotion 否 String 情绪类型，目前仅支持NORMAL（正常），ANGRY（愤怒）。 在识别配置中emotion为true时存在。 speed 否 Float 语速信息，单位是每秒字数。 在识别配置中speed为true时存在。 表8 Word_info 数据结构 参数名 是否必选 参数类型 说明 start_time 否 Integer 起始时间 end_time 否 Integer 结束时间 word 否 String 分词

请求参数 请求类为AsrCustomLongRequest，详见表3。 表3 AsrCustomLongRequest 参数名称 是否必选 参数类型 描述 dataUrl 是 String 存放录音文件地址： 推荐使用华为云OBS：授权配置请参见OBS配置。 您也可以把录音文件放在自行搭建服务器上，提供下载文件的地址。URL不能使用IP地址，只能使用 域名 ，请尽量避免中文。 audioFormat 是 String 音频格式，具体信息请参见《API参考》中录音文件识别章节。 property 是 String 属性字符串，语言_采样率_模型，如chinese_8k_common。具体信息请参见《API参考》中录音文件识别章节。 addPunc 否 String 表示是否在识别结果中添加标点，取值为yes 、 no，默认no。 digitNorm 否 String 表示是否将语音中的数字识别为阿拉伯数字，取值为yes 、 no，默认为yes。 callbackUrl 否 String 表示回调 url，用户用于接收识别结果的服务器地址， 不支持ip方式调用，url长度小于2048字节。服务请求方法为Post方式，请求体为Json格式。 如果用户使用回调方式获取识别结果，需提交该参数，处理成功后用户服务器需返回状态码为200。 如果用户使用轮询方式获取识别结果，则无需提交该参数。 needAnalysisInfo 否 Boolean 是否选择分析信息。当前仅对8k模型有效。 如果选择false，则声道、话者分离、情绪检测、速度信息均无效。默认false。 diarization 否 Boolean 是否需要话者分离，表示识别结果会包含role项，默认true。 channel 否 String 语音文件声道信息，可以为MONO（缺省)、LEFT_AGENT、RIGHT_AGENT。 emotion 否 Boolean 是否需要做情绪检测，默认true。 speed 否 Boolean 是否需要输出语速信息，默认true。 vocabularyId 否 String 热词表id，不使用则不填写。 创建热词表请参考《API参考》中创建热词表章节。 needWordInfo 否 String 表示是否在识别结果中输出分词结果信息，取值为“yes”和“no”，默认为“no”。

初始化Client 初始化AsrCustomizationClient，其参数包括AuthInfo和SisConfig。 表1 AuthInfo 参数名称 是否必选 参数类型 描述 ak 是 String 用户的ak，可参考AK/SK认证。 sk 是 String 用户的sk，可参考AK/SK认证。 region 是 String 区域，如cn-north-4，参考终端节点。 projectId 是 String 项目ID，同region一一对应，参考获取项目ID。 endpoint 否 String 终端节点，参考地区和终端节点。一般使用默认即可。 表2 SisConfig 参数名称 是否必选 参数类型 描述 connectionTimeout 否 Integer 连接超时，默认10000，单位ms。 readTimeout 否 Integer 读取超时，默认10000，单位ms。

请求参数 请求类为RttsRequest，详见表 RttsRequest。 表2 RttsRequest 参数名称 是否必选 参数类型 描述 text 是 String 待合成文本。 通过set方法可以设置具体参数，详见表 RttsRequest设置参数 表3 RttsRequest设置参数 方法名称 是否必选 参数类型 描述 SetAudioFormat 否 String 设置语音格式，默认pcm。 SetAudioProperty 否 String 设置 语音合成 特征字符串，{language}_{speaker}_{domain}，即“语种_人员标识_领域”。默认chinese_xiaoyan_common 。详见API文档。 SetSampleRate 否 String 设置采样率：8000、16000，默认8000。 SetPitch 否 Integer 设置音高，-500~500，默认0。 SetVolume 否 Integer 设置音量，0~100，默认50。 SetSpeed 否 Integer 设置语速，-500~500，默认0。 SetSubtitle 否 String 设置字幕，部分发音人支持字幕时间戳，详见API文档。

编译脚本 以下编译脚本仅供参考，您可以根据实际业务需求，对RasrDemo.cpp进行定制修改。 cd ${project_dir} mkdir build && cd build mkdir logs cmake .. make -j ./RttsDemo --ak=yourAk --sk=yourSk --region=yourRegion --projectId=yourProjectId --isSaved=true --audioPath=test.pcm

初始化Client 初始化RttsClient，其参数包括AuthInfo 表1 AuthInfo 参数名称 是否必选 参数类型 描述 ak 是 String 用户的ak，可参考AK/SK认证。 sk 是 String 用户的sk，可参考AK/SK认证。 projectId 是 String 项目ID，同region一一对应，参考获取项目ID。 region 是 String 区域，如cn-north-4，参考终端节点。 endpoint 否 String 终端节点，参考地区和终端节点。一般使用默认即可。

响应参数 Python SDK响应结果为Json格式，详见表4。调用失败处理方法请参见错误码。 表4 响应结果 参数名称 是否必选 参数类型 描述 resp_type 是 String 参数值为RESULT，表示识别结果响应。 trace_id 是 String 服务内部的令牌，可用于在日志中追溯具体流程。 segments 是 Array of objects 多句结果。详见表5。 表5 Segment 参数名称 是否必选 参数类型 描述 start_time 是 Integer 一句的起始时间戳，单位为ms。 end_time 是 Integer 一句的结束时间戳，单位为ms。 is_final 是 Boolen true表示是最终结果， false表示为中间临时结果。 result 是 Object 调用成功表示识别结果，详见表6。 表6 Result 参数名称 是否必选 参数类型 描述 text 是 String 识别结果。 score 是 Float 识别结果的置信度（0-1之间）。此值仅会在最终结果时被赋值，在中间结果时统一置为“0.0”。 word_info 否 Array of objects 分词信息列表。 表7 Word_info 参数名 是否必选 参数类型 说明 start_time 否 Integer 起始时间 end_time 否 Integer 结束时间 word 否 String 分词

代码示例 如下示例仅供参考，最新代码请前往SDK（websocket）章节获取并运行。 # -*- coding: utf-8 -*- from huaweicloud_sis.client.rasr_client import RasrClient from huaweicloud_sis.bean.rasr_request import RasrRequest from huaweicloud_sis.bean.callback import RasrCallBack from huaweicloud_sis.bean.sis_config import SisConfig import json import os # 鉴权参数 # 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全； # 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SIS_AK/HUAWEICLOUD_SIS_SK ak = os.getenv("HUAWEICLOUD_SIS_AK") # 从环境变量获取ak 参考https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html assert ak is not None, "Please add ak in your develop environment" sk = os.getenv("HUAWEICLOUD_SIS_SK") # 从环境变量获取sk 参考https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html assert sk is not None, "Please add sk in your develop environment" project_id = "" # project id 同region一一对应，参考https://support.huaweicloud.com/api-sis/sis_03_0008.html region = 'cn-north-4' # region，如cn-north-4 """ todo 请正确填写音频格式和模型属性字符串 1. 音频格式一定要相匹配. 例如音频是pcm格式，并且采样率为8k，则格式填写pcm8k16bit。 如果返回audio_format is invalid 说明该文件格式不支持。具体支持哪些音频格式，需要参考一些api文档。 2. 音频采样率要与属性字符串的采样率要匹配。 例如格式选择pcm16k16bit，属性字符串却选择chinese_8k_common, 则会返回'audio_format' is not match model """ # 实时语音识别 参数 path = '' # 需要发送音频路径，如D:/test.pcm, 同时sdk也支持byte流发送数据。 audio_format = 'pcm16k16bit' # 音频支持格式，如pcm16k16bit，详见api文档 property = 'chinese_16k_general' # 属性字符串，language_sampleRate_domain, 如chinese_16k_general, 采样率要和音频一致。详见api文档 class MyCallback(RasrCallBack): """ 回调类，用户需要在对应方法中实现自己的逻辑，其中on_response必须重写 """ def on_open(self): """ websocket连接成功会回调此函数 """ print('websocket connect success') def on_start(self, message): """ websocket 开始识别回调此函数 :param message: 传入信息 :return: - """ print('webscoket start to recognize, %s' % message) def on_response(self, message): """ websockert返回响应结果会回调此函数 :param message: json格式 :return: - """ print(json.dumps(message, indent=2, ensure_ascii=False)) def on_end(self, message): """ websocket 结束识别回调此函数 :param message: 传入信息 :return: - """ print('websocket is ended, %s' % message) def on_close(self): """ websocket关闭会回调此函数 """ print('websocket is closed') def on_error(self, error): """ websocket出错回调此函数 :param error: 错误信息 :return: - """ print('websocket meets error, the error is %s' % error) def on_event(self, event): """ 出现事件的回调 :param event: 事件名称 :return: - """ print('receive event %s' % event) def rasr_example(): """ 实时 语音识别 demo """ # step1 初始化RasrClient, 暂不支持使用代理 my_callback = MyCallback() config = SisConfig() # 设置连接超时,默认是10 config.set_connect_timeout(10) # 设置读取超时, 默认是10 config.set_read_timeout(10) # 设置connect lost超时，一般在普通并发下，不需要设置此值。默认是10 config.set_connect_lost_timeout(10) # websocket暂时不支持使用代理 rasr_client = RasrClient(ak=ak, sk=sk, use_aksk=True, region=region, project_id=project_id, callback=my_callback, config=config) try: # step2 构造请求 request = RasrRequest(audio_format, property) # 所有参数均可不设置，使用默认值 request.set_add_punc('yes') # 设置是否添加标点， yes or no， 默认no request.set_vad_head(10000) # 设置有效头部， [0, 60000], 默认10000 request.set_vad_tail(500) # 设置有效尾部，[0, 3000]， 默认500 request.set_max_seconds(30) # 设置一句话最大长度，[1, 60], 默认30 request.set_interim_results('no') # 设置是否返回中间结果，yes or no，默认no request.set_digit_norm('no') # 设置是否将语音中数字转写为阿拉伯数字，yes or no，默认yes # request.set_vocabulary_id('') # 设置热词表id，若不存在则不填写，否则会报错 request.set_need_word_info('no') # 设置是否需要word_info，yes or no, 默认no # step3 选择连接模式 # rasr_client.short_stream_connect(request) # 流式一句话模式 # rasr_client.sentence_stream_connect(request) # 实时语音识别单句模式 rasr_client.continue_stream_connect(request) # 实时语音识别连续模式 # use enterprise_project_Id # headers = {'Enterprise-Project-Id': 'your enterprise project id'} # rasr_client.continue_stream_connect(request, headers) # step4 发送音频 rasr_client.send_start() # 连续模式下，可多次发送音频，发送格式为byte数组 with open(path, 'rb') as f: data = f.read() rasr_client.send_audio(data) # 可选byte_len和sleep_time参数，建议使用默认值 rasr_client.send_end() except Exception as e: print('rasr error', e) finally: # step5 关闭客户端，使用完毕后一定要关闭，否则服务端20s内没收到数据会报错并主动断开。 rasr_client.close() if __name__ == '__main__': rasr_example()

请求参数 请求类为RasrRequest，详见表3。 表3 RasrRequest 参数名称 是否必选 参数类型 描述 audio_format 是 String 音频格式，支持pcm，alaw，ulaw等，如pcm8k16bit，参见《API参考》中开始识别章节。 model_property 是 String 属性字符串，language_sampleRate_domain， 如chinese_16k_general，参见《API参考》中开始识别章节。 add_punc 否 String 表示是否在识别结果中添加标点，取值为yes 、 no，默认no。 digit_norm 否 String 表示是否将语音中的数字识别为阿拉伯数字，取值为yes 、 no，默认为yes。 vad_head 否 Integer 头部最大静音时间，[0, 60000]，默认10000ms。 vad_tail 否 Integer 尾部最大静音时间，[0, 3000]，默认500ms。 max_seconds 否 Integer 音频最长持续时间， [1, 60]，默认30s。 interim_results 否 String 是否显示中间结果，yes 或 no，默认no。例如分3次发送音频，选择no结果一次性返回，选择yes分三次返回。 vocabulary_id 否 String 热词表id，若没有则不填。 need_word_info 否 String 表示是否在识别结果中输出分词结果信息，取值为“yes”和“no”，默认为“no”。

初始化Client 初始化RasrClient详见表 RasrClient初始化参数。 表1 RasrClient初始化参数 参数名称 是否必选 参数类型 描述 ak 是 String 用户的ak，请参考AK/SK认证。 sk 是 String 用户的sk，请参考AK/SK认证。 use_aksk 是 Boolean 使用ak、sk要填写true。 region 是 String 区域，如：cn-north-4。具体请参考终端节点。 project_id 是 String 项目ID，同region一一对应，参考获取项目ID。 callback 是 Object 回调类RasrCallBack，用于监听Websocket连接、响应、断开、错误等。参考代码示例。 config 否 Object 详见表2。 service_endpoint 否 String 终端节点，一般使用默认即可。 表2 SisConfig 参数名称 是否必选 参数类型 描述 connect_timeout 否 Integer 连接超时，默认10，单位s。 read_timeout 否 Integer 读取超时，默认10，单位s。 connect_lost_timeout 否 Integer 连接失效超时，默认4，单位s。一般不要修改这个参数。

请求参数 请求类为FlashLasrRequest，详见表3。 表3 FlashLasrRequest 参数 是否必选 参数类型 描述 audio_format 是 String 支持语音的格式，请参考表4。 property 是 String 所使用的模型特征串，通常是 “语种_采样率_领域”的形式，采样率需要与音频采样率保持一致，取值范围请参考表5。 add_punc 否 String 表示是否在识别结果中添加标点，取值为“yes”和“no”，默认为“no”。 digit_norm 否 String 表示是否将语音中的数字识别为阿拉伯数字，取值为“yes” 和 “no”，默认为“yes”。 vocabulary_id 否 String 热词表id，不使用则不填写。 创建热词表信息请参考创建热词表。 need_word_info 否 String 表示是否在识别结果中输出分词结果信息，取值为“yes”和“no”，默认为“no”。 first_channel_only 否 String 表示是否在识别中只识别首个声道的音频数据，取值为“yes”和“no”，默认为“no”。 obs_bucket_name 否 String 表示在OBS对象桶名，使用前请先授权，操作方法请参见配置OBS访问权限。obs_bucket_name长度大于等于3个字符，小于64个字符，不需要进行urlencode编码，如果包含中文，直接输入中文即可。 示例 obs url为https://test.obs.cn-north-4.myhuaweicloud.com/data/0601/test.wav 则obs_bucket_name=test，obs_bucket_key=data/0601/test.wav obs_object_key 否 String 表示OBS对象桶中的对象的键值，长度小于1024个字符，不需要进行urlencode编码，如果包含中文，直接输入中文即可。 示例 obs url为https://test.obs.cn-north-4.myhuaweicloud.com/data/0601/test.wav 则obs_bucket_name=test，obs_bucket_key=data/0601/test.wav 表4 audio_format audio_format取值 描述 wav wav格式音频 mp3 mp3格式音频 m4a m4a格式音频 aac aac格式音频 opus ops格式音频。 表5 property property取值 描述 chinese_8k_common 支持采样率为8k的中文普通话语音识别。 chinese_16k_conversation 支持采样率为16k的会议场景的中文普通话语音识别。

初始化Client 初始化FlashLasrClient，其参数包括AuthInfo和SisConfig。 表1 AuthInfo 参数名称 是否必选 参数类型 描述 ak 是 String 用户的ak，可参考AK/SK认证。 sk 是 String 用户的sk，可参考AK/SK认证。 region 是 String 区域，如cn-north-4，参考终端节点。 projectId 是 String 项目ID，同region一一对应，参考获取项目ID。 endpoint 否 String 终端节点，参考地区和终端节点。一般使用默认即可。 表2 SisConfig 参数名称 是否必选 参数类型 描述 connectionTimeout 否 Integer 连接超时，默认10000，单位ms。 readTimeout 否 Integer 读取超时，默认10000，单位ms。

方案架构 中国大陆用户根据运营商类型配置不同的IP访问地址 联通：1.1.xx.xx 移动：2.2.xx.xx 电信：3.3.xx.xx 其他运营商（教育网、铁通、鹏博士等）：4.4.xx.xx 全球范围（不含中国大陆）用户根据所属地区配置不同的IP访问地址 亚太地区-中国香港：5.5.xx.xx 亚太地区-中国澳门：6.6.xx.xx 亚太地区-中国台湾：7.7.xx.xx 亚太地区-其他地区：8.8.xx.xx

步骤二：添加解析记录 在已添加公网域名的所在行，单击“管理解析”。 进入域名的解析记录列表页。 在域名解析记录列表页，单击“添加记录集”，配置子域名test.huawei-example.com的解析记录。 中国大陆跨运营商访问，按照表1配置，云解析服务将访问者的运营商类型返回对应的解析记录IP地址。 配置结果如图2所示。 表1 配置运营商解析 线路类型 运营商（访问者本地DNS出口IP来源） 解析记录值 运营商线路解析 联通 1.1.xx.xx 移动 2.2.xx.xx 电信 3.3.xx.xx 默认 其他（例如教育网、铁通、鹏博士等） 4.4.xx.xx 图2 运营商解析记录 全球（不含中国大陆）业务范围的智能访问，按照表2配置，云解析服务将访问者所在地区返回对应的解析记录IP地址。 配置结果如图3所示。 表2 配置地域解析 线路类型 地区（访问者本地DNS出口IP来源） 解析记录值 地域解析-全球-亚太地区 中国香港 5.5.xx.xx 中国澳门 6.6.xx.xx 中国台湾 7.7.xx.xx 地域解析-全球-默认 其他地区 8.8.xx.xx 图3 地域解析记录

应用场景 普通的域名解析只为用户返回解析结果，不会考虑访问者IP的来源和类型，这样，所有的访问者都被解析到同样的IP地址上，容易出现由跨运营商或者跨地域访问引起网络体验欠佳的问题。 云解析服务的智能线路解析功能支持按运营商、地域等维度区分访问者IP的来源和类型，对同一域名的访问请求做出不同的解析响应，指向不同服务器的IP地址。当联通用户访问时，域名解析服务器返回联通服务器的IP地址；当电信用户访问时，返回电信服务器的IP地址，解决了跨网访问慢的难题，从而实现高效解析。 除了按运营商线路及地域解析之外，云解析服务还支持按IP网段划分访问者的自定义线路解析，您可以更细粒度的设置解析线路，将访问者路由至不同的网站服务器。 对于部署了多台服务器的网站，如果想要实现解析的负载均衡，可以选择云解析服务的权重解析来实现。 本文指导用户通过华为云DNS服务智能解析配置以下业务场景： 中国大陆跨运营商访问：在中国大陆地区实现跨运营商进行访问，智能DNS解析可以配置多个运营商IP地址，智能判断用户访问来源，并返回最合适的IP地址，实现用户的就近访问。 全球业务范围的智能访问：对于需要在全球范围内进行访问的企业，智能DNS解析可以判断用户处于中国大陆或全球范围，并能够根据具体的国家或地区返回相应的IP地址，以快速响应用户的访问。

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 要查询的索引数据。 result String 查询结果，成功时为success。 indices List 查询结果，索引列表。 indexType String 查询结果，索引类别。 indexName String 查询结果，索引名称。 indexLabel List 查询结果，局部索引的label列表。 indexProperty List 查询结果，创建的索引属性列表。 hasLabel Boolean 查询结果，索引中是否包含label。 说明： 全文索引该参数默认值为false。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "data": { "indices": [ { "indexType": "GlobalCompositeVertexIndex", "indexName": "ageIndx", "indexProperty": [ "age" ], "hasLabel": true } ] }, "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8605" }

点集最短路（shortest_path_of_vertex_sets）(2.1.5) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources 是 起点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”。 个数不大于100000。 - targets 是 终点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”。 个数不大于100000。 - directed 否 是否考虑边的方向 Boolean true或false false timeWindow 否 用于进行时间过滤的时间窗 Object 具体请参见表2。 - 表2 timeWindow参数说明 参数 是否必选 说明 类型 取值范围 默认值 filterName 否 用于进行时间过滤的时间属性名称 String 字符串：对应的点/边上的属性作为时间 - filterType 否 在点或边上过滤 String V：点上 E：边上 BOTH：点和边上 BOTH startTime 否 起始时间 String Date型字符串或时间戳 - endTime 否 终止时间 String Date型字符串或时间戳 - 表3 response_data参数说明 参数 类型 说明 path List 最短路径，格式： [vertexId,...] 其中, vertexId：string类型 source String 起点ID target String 终点ID 父主题： 算法API参数参考

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"shortest_path_of_vertex_sets", "parameters":{ "sources: "145,78,77,76", "targets": "23,32", "directed": true } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 sources 是 String 起点ID集合，标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”，个数不大于100000。 targets 是 String 终点ID集合标准csv格式，ID之间以英文逗号分隔，例如：“Mike,Amy”，个数不大于100000。 directed 否 Boolean 是否考虑边的方向。取值为true或false。默认取值为false。 说明： 当数据集不包含inedge时，若directed=true，选择一个不依赖于Inedge的算法实现版本计算输出，性能会下降；若directed=false，会报错。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8402" }

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时，字段为空。

响应示例 状态码： 200 成功响应示例（同步任务） Http Status Code: 200 { "results": [ { "columns": ["n"], "data": [ { "row": [ { "occupation": "artist", "gender": "F", "Zip-code": "98133", "userid": 0, "age": "25-34" } ], "meta": [ { "id": "46", "type": "node", "labels": [ "user" ] } ] } ]， "stats": { "contains_updates": false, "edges_created": 0, "edges_deleted": 0, "labels_set": 0, "properties_set": 0, "vertices_created": 0, "vertices_deleted": 0 } } ], "errors": [] } 状态码： 200 成功响应示例（异步任务） Http Status Code: 200 { "results": [ { "columns": [ "jobId", "jobType" ], "jobId": "b64a5846-e306-4f87-b0f1-d595ee2a9910", "jobType": 1, "data": [ { "row": [ "b64a5846-e306-4f87-b0f1-d595ee2a9910", 1 ], "meta": [ null, null ] } ] } ], "errors": [] } 状态码： 400 失败响应示例 Http Status Code: 400 { "results": [], "errors": [ { "code": "GES.8904", "message": "Label index in vertices is not found." } ] }

请求示例 执行Cypher查询，Cypher语句为match (n) return n limit 1，返回的结果样式是每个元素对应该行的一个字段。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit} { "statements": [{ "statement": "match (n) return n limit 1", "parameters": {}, "resultDataContents": ["row"], "includeStats": false }] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 statements 是 List statements为一个语句组，包含一到多条语句。其中每个元素的格式如表 statements参数说明。 表3 statements参数说明 参数 是否必选 类型 说明 statement 是 String Cypher语句。 parameters 是 Object Cypher语句参数，在进行参数化查询时使用，默认为空。 如需使用，请参考参数化查询。 resultDataContents 否 String或List 返回的结果样式，样式可设置一个或多个。可选参数有“row”,”graph”, “raw”(2.2.27版本新增)。 includeStats 否 Boolean 控制返回结果是否携带增删改统计信息的开关，若不设置此字段，默认为不携带。 runtime 否 String 执行器类型，可选值为“map”、“slotted” 、“block”，默认为“map”。slotted执行器自2.3.15版本开始支持，block执行器自2.4.1版本开始支持。 executionMode（2.2.23） 否 String 执行模式。同步执行模式填写“sync”，异步执行填写“async”，不写默认同步执行。异步模式下，获取查询结果参见查询Job状态。 limit（2.2.23） 否 Int 该字段仅在异步模式下生效，表示对异步结果的最大结果数限制，默认值为100000。 在语句前可以添加explain和profile前缀，用于显示查询计划： explain只显示查询计划，不执行语句；profile显示查询计划，并执行语句。 runtime字段说明：与map执行器相比，slotted执行器在语句的计划生成阶段完成了更多的语句数据流分析，在大部分情况下执行速度更快，占用内存更少。 在异步模式（executionMode参数值为async）下，支持cypher查询结果以csv格式导出到文件（GES版本2.3.4及以上支持该功能），详情请参考导出job返回结果到文件(2.2.1)。目前支持下列对象的返回： 点边单值属性、点边id、分组计数结果等值类型。 对于对象类型，目前的版本暂不支持导出，csv中视作空值处理。 Cypher事务（仅持久化版规格有效）： 持久化版规格下Cypher支持事务，用户可以通过设置transactional为true来开启Cypher的事务功能，以保证单条Cypher语句的原子性。对于多条Cypher语句的事务暂不支持。事务的隔离级别为串行化（serializability）。 由于底层存储引擎存在5s的事务时间窗口限制，因此Cypher的事务不可超过5s。对于复杂的查询，比如说多跳，运行时间可能会超过5s，从而触发超时导致提交失败。 使用Cypher的dbms.killQuery过程可以终止Cypher事务（详见Cypher API-函数和过程）， 并回滚这条Cypher请求造成的所有改动。

响应参数 表4 响应Body参数说明 参数 类型 说明 results List 一个List，每个元素是一条Cypher语句的返回结果。 errors List 一个List，每个元素包含字符串形式的code和message信息。 表5 参数results中各要素说明 参数 类型 说明 columns List 返回的字段名。 data List 返回的数据值，每个元素代表一条记录。 stats Object 返回的增删改统计信息。 plan Object 如果cypher语句带explain或者profile前缀，则此字段输出查询计划，否则不显示该字段，正常执行查询。profile特性2.3.12版本开始支持。 jobId(2.3.10) String 请求为异步执行模式下，该字段用于输出异步任务id。 jobType(2.3.10) Integer 请求为异步执行模式下，该字段用于输出异步任务的类型。 表6 参数data中各要素说明： 参数 类型 说明 row List 表示具体一行的内容，每个元素对应该行的一个字段，仅当resultDataContents为空或者包含“row”类型时显示。 meta List 表示该行每个字段的类型信息，仅当resultDataContents为空或者包含“row”类型时显示。 graph Object 以“graph”样式返回该行信息，仅当resultDataContents包含“graph”类型时显示。 raw(2.2.27) List 以“raw”样式返回该行信息，仅当resultDataContents包含“raw”类型时显示。 表7 stats各要素响应参数： 参数 类型 说明 contains_updates Boolean 表示本次查询是否有数据修改。 edges_created Integer 创建的边数目。 edges_deleted Int 删除的边数目。 labels_set Integer 设置的label数目。 properties_set Integer 设置的属性数目。 vertices_created Integer 创建的点数目。 vertices_deleted Integer 删除的点数目。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 扩副本任务ID。请求失败时字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心API。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 expand 是 expand object expand是一个对象 表4 expand 参数 是否必选 参数类型 描述 replication 是 Integer 新扩副本数量。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8402" }

查询结果 请求示例 GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{jobId}/status?limit=limit 查询结果响应 表4 reponse_data参数说明 参数 类型 说明 min_code_length Double 对节点编码所需的最小编码长度。 community_num Integer 社团数量。 community List 各节点对应的社团(commmunity)，格式： [{vertexId:communityId},...], 其中, vertexId：string类型。 communityId：string类型。