华为云用户手册

响应示例 状态码： 200 成功响应样例 { "data": { "edges": [ { "source": "46", "target": "39", "label": "rate", "sortKey": 5, "properties": { "Rating": [ 5 ], "Datetime": [ "2018-01-0120:30:05" ] } } ] }, "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Graph [31dc8f201e6246768fde20492d4a9875-demo] does not exist, please check projectId and graphName.", "errorCode": "GES.8000", "result": "failed" }

响应参数 表2 响应Body参数 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询结果。查询成功时显示结果，若查询失败时，字段为空。 result String 查询成功时值为success，失败时值为failed。 表3 data参数说明 参数 是否必选 类型 说明 edges 是 List 边的结果集合。没有查询到对应边时，edges内容为空。

请求示例 批量删除边，边的起点分别为39631050_景观和27803870_地标建筑，边的终点分别为27803870_地标建筑和27661363_山庄温泉。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete { "edges": [ { "source": "39631050_景观", "target": "27803870_地标建筑" }, { "label": "road", "source": "27803870_地标建筑", "target": "27661363_山庄温泉" } ], "ignoreError": true } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应参数 同步模式 表4 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 响应结果。成功时result值为success，失败时值为failed。 异步模式（2.2.14） 表5 响应Body参数说明 参数 是否必选 类型 说明 errorMessage 否 String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode 否 String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId 否 String 执行删除任务ID。 请求失败时，该字段为空。后续可以用此ID作为参数通过“查询Job状态”接口获取删除结果。 jobType 否 Integer 任务类型。 请求失败时，该字段为空。

响应示例 同步模式 状态码： 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "parameter does not contain source", "errorCode": "GES.8000", "result": "failed" } 异步模式 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "500dea8f-9651-41fe-8299-c20f13a032ea", "jobType": 3 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Not found. Please check the input parameters.", "errorCode": "GES.8000" }

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 edges 是 List 待删除的边数组。 executionMode 否 String sync表示同步，async表示异步，默认为“sync”同步模式。 ignoreError 否 Boolean 是否忽略错误，比如待删除的边不存在；默认值为false，不忽略；设置true时，Json格式错误也不会忽略。 表3 edges参数说明 参数 是否必选 类型 说明 source 是 String 边的source节点。 target 是 String 边的target节点。 label 否 String 边的label，当存在index参数时会被忽略，当index不存在时会尝试删除同时满足source/target/label条件的一条边。label不存在于schema中或同label的边不存在时不会删除任何边。 sortKey 否 String 重复边的sortKey，支持Integer/String/varString类型，查询时给出sortKey必须给出label，类型与创建图时的sortKey类型需一致，赋值为null时除外。

请求示例 根据批量节点ID删除节点，待删除的点ID数组为Vivian和46。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete { "vertices": [ "Vivian", "46" ], "ignoreError": true } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": " Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214" }

响应参数 状态码： 200 表9 响应Body参数 参数 参数类型 描述 id String 图ID。 name String 图名称。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。

请求示例 创建一个图，图名称为demo，图规模类型索引为百万边，图实例CPU架构类型为X86 64位架构 ，虚拟私有云ID为2d8af840-fd57-4e3b-a8f1-cda0f55ccd99，子网ID为dc018ec3-67d1-46c9-b2fc-19d83367f4e2，安全组ID为11d27338-8649-4076-8579-5ebc1a60f79e。 POST https://{Endpoint}/v2/{project_id}/graphs { "graph" : { "name" : "demo", "graph_size_type_index" : "1", "arch" : "x86_64", "vpc_id" : "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnet_id" : "dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "security_group_id" : "11d27338-8649-4076-8579-5ebc1a60f79e", "public_ip" : { "public_bind_type" : "bind_existing", "eip_id" : "30ef2d58-08a9-4481-b526-b2cbe67d020d" }, "enable_multi_az" : false, "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "54c0b33c-8627-462f-948e-bae08c0887b4" } ], "crypt_algorithm" : "generalCipher", "enable_https" : false } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 graph 是 graph object 图类型。 表4 graph 参数 是否必选 参数类型 描述 name 是 String 图名称（输入长度在4位到50位之间，必须以字母开头，可以包含字母、数字或者下划线，不能包含其他的特殊字符）。 graph_size_type_index 是 String 图规模类型索引。 0：一万边 1：百万边 2：千万边 3：一亿边 4：十亿边 5：百亿边 6：持久化版 401：十亿增强边 arch 否 String 图实例CPU架构类型，取值为x86_64和aarch64。默认取x86_64。 x86_64：X86 64位架构。 aarch64：ARM 64位架构。 vpc_id 是 String 虚拟私有云ID。 subnet_id 是 String 指定虚拟私有云下的子网ID。 security_group_id 是 String 安全组ID。 public_ip 否 public_ip object 公网IP地址，如果未指定，则默认不使用公网连接。 enable_multi_az 否 Boolean 创建的图是否支持跨可用区（AZ），默认值是false，如果设置为true，系统将会把图中的E CS 建在两个可用区中。 如果创建图时，不加该参数，则会将图中的ECS都建在一个可用区中。 sys_tags 否 Array of sys_tags objects 企业项目信息，如果未指定则不开启，默认不开启。 tags 否 Array of tags objects 支持标签TMS，做费用归集，默认不开启。 enable_rbac 否 Boolean 创建的图是否启用细粒度权限控制，默认不启用，值为false。如果设置为true，创建的图所有用户都没有权限，需要调用业务面细粒度权限控制API进行授权操作才可以访问图。 enable_full_text_index 否 Boolean 创建的图是否开启全文索引控制，默认不启用，值为false。 如果设置为true，十亿增强版-规格版图支持全文索引，创建图时会创建 云搜索服务 集群。 enable_hyg 否 Boolean 该参数只对持久化版规格图生效。 crypt_algorithm 否 String 图实例加密算法，取值为： generalCipher：国密算法 SMcompatible：商密算法（兼容国际） enable_https 否 Boolean 是否开启安全模式，开启安全模式会对性能有较大影响 product_type 否 String 图产品类型，取值为InMemory和Persistence，默认为InMemory，当graph_size_type_index取值为"6"时，默认为Persistence。 InMemory：内存版 Persistence：持久化版 vertex_id_type 否 vertex_id_type object 点的id类型，仅持久化图需要填写。 说明： 点ID类型确定后，将无法更改，请用户谨慎选择! capacity_ratio 否 Integer 图的容量倍率。该参数只有持久化版百亿规格图支持，且从2.3.18版本后开始支持。 is_dynamic_graph 否 Boolean 是否为动态图。 sort_key_type 否 String 持久化版图数据的sortKey的类型，通过配置不同SortKey的值来区分重复边（源点，终点，Label三者都相同的边），仅持久化图需要填写。取值为： "int"：整型。 "string"：字节长度小于40的字符串。 "varString"：不限长度字符串，过长会影响读写性能，建议长度控制在1K字节以内，最大不要超过2K字节。 表5 public_ip 参数 是否必选 参数类型 描述 public_bind_type 否 String 弹性IP绑定类型，取值如下。 auto_assign：自动绑定。 bind_existing：使用已有。 eip_id 否 String 弹性IP的id，当publicBindType设置为bind_existing时，该值为用户某个已创建但尚未绑定的EIP的ID；当publicBindType设置为auto_assign时，该值设置为空。 表6 sys_tags 参数 是否必选 参数类型 描述 key 否 String 企业项目的key填：_sys_enterprise_project_id。 value 否 String 企业项目的id。可以从企业项目获取。 表7 tags 参数 是否必选 参数类型 描述 key 否 String 标签key。 value 否 String 标签value。 表8 vertex_id_type 参数 是否必选 参数类型 描述 id_type 是 String id类型，目前支持固定长度fixedLengthString、varString和hash三种点ID类型。 fixedLengthString：固定长度String格式下，实际点ID直接用于内部存储与计算，用户需指定一长度，实际点ID不可超过此长度。长度过大，可能影响查询性能，建议用户根据数据集状态进行设置。 varString：可变长度String格式下，用户写入的点ID无长度限制，但是ID过长会影响读写性能，建议长度控制在1K字节以内，最大不要超过4K字节。 hash：哈希格式下，内部计算时将实际点ID转换成哈希码进行存储与计算，对实际点ID长度无限制，但是存在极低的概率(约10^(-43))出现点ID碰撞。若用户无法确定点ID的最大长度，建议选择哈希类型。 说明： 当创建HyG图时，id_type只支持fixedLengthString。 id_length 否 Integer 当id_type取值为fixedLengthString时必填，取值范围：1-128。

持久化版 持久化版业务面API包括点操作、边操作、元数据操作、索引操作、HyG数据集管理、HyG算法、算法、图统计、图操作、Job管理、Cypher操作API。 表1 点操作API 名称 起始版本 URL 功能描述 查询点详情 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids} 给定一个点或者一组点的集合，查询这些点的详情，包括Label信息。 批量点查询 1.1.9 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-query 批量查询点的详情。 批量添加点 2.1.16 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add 批量添加点的操作。 批量删除点 2.1.9 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete 根据批量节点ID删除节点。 批量更新点属性 2.1.10 POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId} 批量更新点的属性。 表2 边操作API 名称 起始版本 URL 功能描述 查询边详情 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&label={label}&sortKey={sortKey}&sortKeyType={sortKeyType} 根据边的起点、终点以及索引，查询边的详细信息，返回边上的标签和属性等。 批量边查询 1.1.6 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query 批量查询边的详情。 批量添加边 2.1.16 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-add 批量添加边的操作。 批量删除边 2.1.9 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete 根据批量边的起点、终点以及索引，删除这些边。 批量更新边属性 2.1.10 POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId} 批量更新边属性。 表3 元数据操作API 名称 起始版本 URL 功能描述 添加label 1.1.6 POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels 添加label。 更新label 1.1.7 POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties 更新label。 查询图元数据详情 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema 查询元数据详情。 查询label 2.2.18 GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName} 查询label。 表4 索引操作API 名称 起始版本 URL 功能描述 新建索引 1.1.6 POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices 新建索引。 删除索引 1.1.6 DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/indices/{indexName} 删除索引。 查询索引 1.1.6 GET /ges/v1.0/{project_id}/graphs/{graph_name}/indices 查询索引。 表5 原生算法API 名称 起始版本 URL 功能描述 执行算法 1.0.0 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm 执行原生算法。 表6 图统计API 名称 起始版本 URL 功能描述 查询图概要信息 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/summary?label_details={labelDetails} 查询图概要信息。 查询图版本 2.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/version 查询图版本。 表7 图操作API 名称 起始版本 URL 功能描述 导入图 2.1.14 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id= import-graph 导入图数据 。 清空图 2.1.2 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=clear-graph 清空图数据。 表8 Job管理API 名称 起始版本 URL 功能描述 查询Job状态 1.0.0 GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit 查询Job状态。 查询job列表 2.2.13 GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset} 用于查询engine中保存的所有异步任务，返回每个任务的jobId、job状态、原始请求。 表9 Cypher操作API 名称 起始版本 URL 功能描述 Cypher操作API 2.2.16 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-cypher-query 使用Cypher语句可以查询GES中的数据，并返回结果 表10 交互式事务API 名称 URL 功能描述 创建事务 POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction 创建事务。 执行事务Cypher POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit} 执行事务Cypher。 提交事务 POST /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit}/commit 提交事务。 回滚事务 DELETE /ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit} 回滚事务。 表11 运维监控API 名称 URL 功能描述 查看监控指标 GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit 查询Job状态。 查看实时请求 GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset} 用于查询engine中保存的所有异步任务，返回每个任务的jobId、job状态、原始请求。 父主题： 业务面API概览

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

响应示例 状态码： 200 成功响应示例 { "job_id" : "ff8080815f9a3c84015f9a438ff70001" "backup_id":"0000b54f-2f1d-47a5-94bc-04f0d8a2e2db" } 状态码： 404 失败响应示例 { "error_msg": "Cluster does not exist or has been deleted.", "error_code": "GES.0047" }

标签传播（Label Propagation）(1.0.0) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 convergence 否 收敛精度。 Double 0~1，不包括0和1。 0.00001 max_iterations 否 最大迭代次数。 Integer 1~2000。 1000 表2 response_data参数说明 参数 类型 说明 community List 各节点对应的社团(community)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题： 算法API

请求示例 批量删除边，边的起点分别为39631050_景观和27803870_地标建筑，边的终点分别为27803870_地标建筑和27661363_山庄温泉。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-delete { "edges": [ { "source": "39631050_景观", "target": "27803870_地标建筑" }, { "index": "0", "source": "27803870_地标建筑", "target": "27661363_山庄温泉" } ], "ignoreError": true } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应参数 同步模式 表4 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 响应结果。成功时result值为success。 异步模式（2.2.14） 表5 响应Body参数说明 参数 是否必选 类型 说明 errorMessage 否 String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode 否 String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId 否 String 执行删除任务ID。 请求失败时，该字段为空。后续可以用此ID作为参数通过“查询Job状态”接口获取删除结果。 jobType 否 Integer 任务类型。请求失败时，该字段为空。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 edges 是 Object 待删除的边数组。 executionMode（2.2.14） 否 String sync表示同步，async表示异步，默认为“sync”同步模式。 ignoreError（2.2.17） 否 Boolean 是否忽略错误，比如待删除的边不存在；默认值为false，不忽略；设置true时，Json格式错误也不会忽略。 表3 edges参数说明 参数 是否必选 类型 说明 source 是 String 边的source节点。 target 是 String 边的target节点。 index 否 String 边的index。 label（2.2.17） 否 String 边的label，当存在index参数时会被忽略，当index不存在时会尝试删除同时满足source/target/label条件的一条边。label不存在于schema中或同label的边不存在时不会删除任何边。

响应示例 同步模式 状态码： 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"Parameter does not contain 'source'", "errorCode":"GES.8000" } 异步模式 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "500dea8f-9651-41fe-8299-c20f13a032ea", "jobType": 3 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Not found. Please check the input parameters.", "errorCode": "GES.8000" }

响应示例 请求成功样例 状态码：200 { "data":{ "vertices":[ { "id":"1", "label":"movie", "properties":{ "genres":[ "Comedy" ], "movieid":[ 1 ], "title":[ "Airplane! (1980)" ] } } ], "runtime":0.126476598 } } 状态码： 400 失败响应示例 { "errorCode":"GES.8814", "errorMessage":"Unsupported API." }

响应参数 表5 要素说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 响应结果。成功时result值为success，失败时值为failed。 cause String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。

请求示例 添加label，label的名称为book，label有一个待添加的属性。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels { "name": "book", "type": "vertex", "properties": [ { "property": { "name": "Title", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Version", "cardinality": "single", "dataType": "string" } } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "label : book has exist", "errorCode": "GES.8701", "result": "failed" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 upgrade_version 是 String 升级到的版本，必须大于当前图版本。 force_upgrade 否 Boolean 是否强制升级。取值为true或false，默认为false。 true：强制升级，会中断升级时已经在处理的任务，比如运行算法长任务，可能会造成少量请求失败。 false：非强制升级，会等待已经运行的业务，升级过程可能较慢。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 执行该异步任务的jobId。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

响应参数 表3 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行该异步任务的jobId。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。 jobType String 执行该异步任务的jobType。 result String 成功时result值为success。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232", "jobType": 8 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Graph [854d9316e71d4dc599c5f27ea323d445-ges_fdb1] does not exist, please check projectId and graphName.", "errorCode": "GES.8000", "result": "failed" }

请求示例 创建复合索引，索引名称为ageIndex，索引类型为全局点索引。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName":"ageIndex", "indexType": "GlobalCompositeVertexIndex", "hasLabel": true, "indexProperty": ["age"] }

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 indexName 是 String 索引名称。只能包含字母,数字,-和_。不能包含其他字符。索引名称的长度需在63字符以内。 说明： indexType 是 String 索引的类型，区分大小写。 “GlobalCompositeVertexIndex”为全局的Composite类型的点索引。 “GlobalCompositeEdgeIndex”为全局的Composite类型的边索引。 “CompositeVertexIndex”为局部的Composite类型的点索引。 “CompositeEdgeIndex”为局部的Composite类型的边索引。 “FullTextIndex”为全文索引。 hasLabel 否 Boolean 是否有label，默认为false。 true false indexLabel 否 List Label列表，仅在indexType为CompositeVertexIndex或CompositeEdgeIndex时有效，而且为必填项，用来指定在哪些label上建立索引。 indexProperty 否（若hasLabel为false或null，则该项为必选） List 索引的属性列表。 可以创建的属性类型有： integer、 float、 double、 long、 enum、 string、 date。 索引类型为复合类型时，仅支持属性类型为single。 strLength 否 Integer String类型的属性在编码索引时会按照一固定长度来截断，strLength用于指定此截断长度。未指定时默认值为40字节，用户可指定范围为[1, 256]。 通常用户不需要手动指定此参数，即使有些属性超过此长度，索引编码时被截断。一般也不会有明显的性能劣化。除非绝大多数属性均超过默认长度，可以考虑适当增大strLength，但是会带来索引修改的性能下降。 如果属性类型为string，属性长度建议不要超过40个字节，超出的部分会被截断。 Cypher查询可以借助hasLabel为True的索引来加速。 indexProperty为空时，建立的索引为label索引，可以加速label过滤。 indexProperty不为空时，建立的索引为属性索引，可以加速对应的属性过滤。

功能介绍 根据给定的indexName，IndexType等信息创建索引。目前支持两种索引：复合索引和全文索引。 复合索引有全局点索引（GlobalCompositeVertexIndex），全局边索引（GlobalCompositeEdgeIndex）以及局部点索引（CompositeVertexIndex），和局部边索引（CompositeEdgeIndex）。复合索引是针对固定组合的属性建立的，其中局部索引可以在指定的label上建立索引。而全局索引复合索引不需要指定label，只要某个label包含指定属性，就会自动在此label上建立索引。使用索引查询可以加快速度。 全文索引（FullTextIndex）可以实现全文搜索、模糊搜索等功能。由于全文索引的刷新机制，更新数据后立即查询可能查到的是旧数据，建议更新后间隔60秒以上再进行查询。全文索引的使用请查看点过滤查询和边过滤查询。您也可以使用cypher语句来执行全文索引，具体请查看cypher操作相关章节。 目前全文索引特性只在持久化版规格版本中支持。 索引创建后需要等待30秒索引同步时间，同步完成后Cypher查询才可以利用索引进行加速。