网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

Filtered-query V2(2.3.6)

更新时间:2024-07-26 GMT+08:00
分享

功能介绍

第二代filtered query。支持filtered query API和repeat query API共同的功能。

说明:

该接口支持对多跳过滤查询循环执行遍历查询进行加速。

例如以下gremlin语句:

g.V('node1').repeat(out('label_2')).emit()

URI

POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query
表1 路径参数

参数

是否必选

类型

说明

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

说明:

每层traversal的元素个数不超过1亿。

表2 Body参数说明

参数

是否必选

类型

默认值

说明

executionMode(2.2.22)

String

sync

sync:同步,async:异步。

vertices

Array of Json

查询的起始节点ID列表。

repeat

Array of Json

执行repeat的过滤条件列表,数组的每个元素分别对应每一层要做的查询和过滤条件。具体格式见表repeat元素格式

until(2.2.22)

Array of Json

while/do looping模式。用于终止遍历过滤条件列表,具体格式见表 until元素格式。2.2.22版本until仅支持一个终止条件。

times

int

2

用于限制最长步数。默认值为2,最大值为20。

emit

Boolean

false

是否返回所有元素。默认为false。在输出select-as或tree下,emit的值决定了是否输出不在最终完整路径上的点。

limit

int

10000

控制点/边/path输出个数。

queryType(2.2.22)

String

Default

可选:['Default', ‘Tree’] ,Default为默认模式,即用户路径的查询内容;Tree返回用户路径查询的路径信息,并以tree的形式组织。

select(2.2.21)

Array of String

用来控制输出字段,可选择as中定义的字段。可以在参数 by中定义输出内容。

select有times+1个隐含的选择字段,v0,v1,v2...vtimes。其分别表示:

  • v0:用户输入的点集第0层。
  • v1:K跳中的第1层。
  • v2:K跳中的第2层等。

select选择的结果路径是默认去重的。

by(2.2.21)

Array of Json

输出所有

用于控制输出字段具体内容。

  1. 当字段不存在时,默认为输出所有内容。
  2. 当选择select模式时,by的个数需与select的个数一致,且在select模式下,每个by只能输出一个元素。
  3. 当没有使用select选择输出元素时,by作用在最终的结果集上。详情查看表 by元素参数格式

statistics

Boolean

false

是否仅返回命中个数。默认为false。

mode

Boolean

强制指定traversal模式。可选:['Dense',Sparse']。默认策略会根据图结构自动切换。

strategy

String

ShortestPath

traversal策略,可选:['ShortestPath',Walk']。

restricted(2.2.28)

Boolean

true

是否对输入严格校验,默认为“true”。

  • 在true模式下,如果参数vertices中包含不存在的点,查询会直接退出并报错。
  • 在false模式下,系统会把vertices中不存在的点过滤掉再进行查询任务。
表3 by元素参数格式

参数

是否必选

类型

说明

id

Boolean

是否输出id。默认为false。

label

Boolean

是否输出label。默认为false。

properties

Boolean

是否输出properties。默认为false。

selectedProperties

Array of String

当properties字段为true时,可以选择输出的属性项。字段为空时输出所有属性字段。该字段默认为空。

表4 repeat元素格式

参数

是否必选

类型

说明

operator

String

表示要做的查询类型,可选的值有:inV(入点), outV(出点), bothV(入点和出点)。

vertex_filter

JSON String

作用在下一跳的点上。具体格式见表 property_filter元素格式

edge_filter

JSON String

作用在点到点之间的边。具体格式见表 property_filter元素格式

as

JSON String

为该层元素取别名。后续可以用于定义输出字段。

表5 until元素格式

参数

是否必选

类型

说明

vertex_filter

JSON String

在repeat 的operator为“ inV”或“outV”或“bothV”时可选,具体格式见表 property_filter元素格式

表6 property_filter元素格式

参数

是否必选

类型

说明

leftvalue

String

左值,具体格式见表 leftvalue元素格式

predicate

String

表示过滤类型,支持的操作如下:

比较运算符:

  • =:等于
  • !=:不等于
  • <:小于
  • <=:小于等于
  • >:大于
  • >=:大于等于

逻辑运算:

  • &:与
  • |:或

集合运算:

  • IN/NOTIN:左值与右值是否有交集
  • CONTAIN/NOTCONTAIN:属性值中是否含有右值
  • SUBSET:右值是属性值的子集

匹配运算符:

  • PREFIX:右值是左值的前缀
  • NOTPREFIX:右值不是左值的前缀
  • SUFFIX:右值是左值的后缀
  • NOTSUFFIX:右值不是左值的后缀
  • SUBSTRING:右值是左值的子字符串
  • NOTSUBSTRING:右值不是左值的子字符串
  • FUZZY:模糊匹配
  • REGEX:正则匹配
  • CISUBSTRING:忽略大小写的子字符串

HAS/HASNOT:是否有此属性,仅支持属性过滤,即左值仅支持property_name。

rightvalue

String

右值,具体格式见表 rightvalue元素格式

表7 leftvalue元素格式

参数

是否必选

类型

说明

label_name

String

若过滤“label”,可选“label_name”,值为“labelName”。rightvalue的value字段填具体的label的名称。

property_name

String

若过滤“property”,可选“property_name”,值为属性名称,rightvalue的value字段填属性的值。

id

String

若对节点ID做过滤,可选id,值可不填。

property_filter

JSON String

若“predicate”为“&”或者“|”,可在“leftvalue”和“rightvalue”中嵌套使用“property_filter”。

degree

String

可选["both","in","out"],代表点度数值过滤统计的方向。

表8 rightvalue元素格式

参数

是否必选

类型

说明

value

String

若过滤“label”,值为label的名称。若过滤“property”,值为属性名称。

property_filter

JSON String

若“predicate”为“&”或者“|”,可在“leftvalue”和“rightvalue”中嵌套使用“property_filter”。

表9 predicate使用场景

predicate

label_name

id

property_name

嵌套filter

&

|

HAS/HASNOT

=/!=/</<=/>/>=

响应参数

  • 同步返回
    表10 响应Body参数说明

    参数

    类型

    说明

    errorMessage

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误信息。

    errorCode

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误码。

    data

    Object

    查询结果。查询失败时,字段为空。

    表11 data参数说明

    参数

    类型

    说明

    vertices

    List

    点的结果集合。filters最后一层为点过滤时,data中将包含vertices。

    edges

    List

    边的结果集合。filters最后一层为边过滤时,data中将包含edges。

  • 异步返回
    表12 响应Body参数说明

    参数

    类型

    说明

    errorMessage

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误信息。

    errorCode

    String

    系统提示信息。

    • 执行成功时,字段可能为空。
    • 执行失败时,用于显示错误码。

    job_id

    String

    执行算法任务ID。请求失败时,该字段为空。

    jobType

    Integer

    任务类型。请求失败时,该字段为空。

请求示例

  • 请求样例1:列出满足过滤条件的第k跳节点或边,查询类型是出点,作用在下一跳的点上。
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query
     {
       "repeat":[
         {
           "operator":"outV",
           "vertex_filter":{
             "property_filter":{
               "leftvalue":{
                 "label_name":"labelName"
               },
               "predicate":"=",
               "rightvalue":{
                 "value":"rate"
               }
             }
           }
         }
       ],
       "times":2,
       "vertices":[
         "1","2"
       ]
     }
    说明:

    以上请求等价于gremlin语句:g.V('1','2').repeat(out().hasLabel('rate')).times(2).dedup()

  • 请求样例2:列出满足过滤条件的第k跳节点或边,查询类型是出点,作用在下一跳的点上。
    POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=path-query
     {
       "repeat":[
         {
           "operator":"outV",
           "vertex_filter":{
             "property_filter":{
               "leftvalue":{
                 "label_name":"labelName"
               },
               "predicate":"=",
               "rightvalue":{
                 "value":"rate"
               }
             }
           }
         }
       ],
       "until":[
         {
           "vertex_filter":{
             "property_filter":{
               "leftvalue":{
                 "property_name":"movieid"
               },
               "predicate":"=",
               "rightvalue":{
                 "value":"1"
               }
             }
           }
         }
       ],
       "vertices":[
         "v1","v2"
       ]
     }
    说明:

    以上请求等价于gremlin语句:

    g.V('v1','v2').repeat(out().hasLabel('rate')).until(has('movieid','1')).dedup()

响应示例

  • 同步返回

    状态码: 200

    成功响应示例

    {
         "data":{
             "vertices":[
                 {
                     "id":"51",
                     "label":"user",
                     "properties":{
                         "occupation":[
                             "homemaker"
                         ],
                         "gender":[
                             "F"
                         ],
                         "Zip-code":[
                             "46911"
                         ],
                         "userid":[
                             5
                         ],
                         "age":[
                             "56+"
                         ]
                     }
                 }
             ]
         }
     }

    状态码: 400

    失败响应示例

    Http Status Code: 400
    {
        "errorMessage": "graph [tesdt_117] is not found",
        "errorCode": "GES.8806"
    }
  • 异步返回

    状态码: 200

    成功响应示例

    Http Status Code: 200
    {
        "jobId": "6622f13c-4b88-45f5-89a9-eaa096647c4a",
        "jobType": 1
    }

    状态码: 400

    失败响应示例

    Http Status Code: 400
    {
        "errorMessage": "executionMode is not correct, it should be sync or async",
        "errorCode": "GES.8806"
    }

状态码

返回值

说明

400 Bad Request

请求错误。

401 Unauthorized

鉴权失败。

403 Forbidden

没有操作权限。

404 Not Found

找不到资源。

500 Internal Server Error

服务内部错误。

503 Service Unavailable

服务不可用。

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容