云服务器内容精选

  • 概念说明 GES基于属性图模型导入图数据,因此,您需要了解属性图(Property graph)的基本概念。 一个属性图是由点、边、标签(Label)和属性(Property)组成的有向图。 点又称作节点(Node),边又称作关系(Relationship),点和关系是最重要的实体。 元数据是用于描述点或边的属性信息,元数据由多个标签组成,每个标签由一个或多个属性组成。 为点或边设置标签,那么拥有相同标签的点属于一个分组,是一个集合。 点和边只能设置一个标签。 如下示例中,此图数据由3个点和3条边组成,Vivian、Eric和Lethal Weapon表示点,(Vivian,Eric)、(Vivian,Lethal Weapon)和(Eric、Lethal Weapon)表示边,user和movie表示点的类型(标签),rate和friends表示关系类型(标签)。 图1 图数据格式的示例
  • 点文件 点文件罗列了各个点的数据信息。一行为一个点的数据。格式如下所示,id是点数据的唯一标识。 id,label,property 1,property 2,property 3,… 点id的名称中不能包含中划线(-)。 点id的类型不需要设置,默认为string。 请注意label前后不要任意加空格,逗号表示分隔符,空格会被识别成label的一部分,可能会出现识别不了或提示label不存在的情况。 示例: Vivian,user,薇薇安,F,25-34,artist,98133 Eric,user,埃里克,M,18-24,college/grad student,40205
  • 响应参数 状态码: 200 表11 响应Body参数 参数 参数类型 描述 id String 图ID。 name String 图名称。 状态码: 400 表12 响应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, "encryption" : { "enable" : true, "master_key_id" : "b00b9356-73fb-4d49-8f79-f0a5da5354d1" }, "lts_operation_trace" : { "enable_audit" : true, "audit_log_group_name" : "test" }, "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "54c0b33c-8627-462f-948e-bae08c0887b4" } ], "enable_rbac" : true, "enable_full_text_index" : true, "enable_hyg" : true, "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,系统将会把图中的ECS建在两个可用区中。 如果创建图时,不加该参数,则会将图中的ECS都建在一个可用区中。 encryption 否 encryption object 图实例是否加密,默认不加密。 lts_operation_trace 否 lts_operation_trace object 图实例是否开启审计日志,默认不开启。 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,十亿增强版-规格版图支持全文索引,创建图时会创建云搜索服务集群。 说明: 开启全文索引功能。如果CSS服务已经部署,图实例会自动创建CSS集群,图创建时间较长。如果CSS服务没有部署则图创建失败。 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类型确定后,将无法更改,请用户谨慎选择! enable_multi_label 否 Boolean 是否启用多标签 。 capacity_ratio 否 Integer 图的容量倍率。该参数只有持久化版百亿规格图支持,且从2.3.18版本后开始支持。 is_dynamic_graph 否 Boolean 是否为动态图。 表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 encryption 参数 是否必选 参数类型 描述 enable 否 Boolean 是否启动加密特性。取值为“true”或者“false”。默认为“false”。 master_key_id 否 String 与建图对应的project下,华为云数据加密服务创建的用户主密钥ID。 表7 lts_operation_trace 参数 是否必选 参数类型 描述 enable_audit 否 Boolean 是否开启图审计,默认“false”。 audit_log_group_name 否 String LTS日志组名称。 表8 sys_tags 参数 是否必选 参数类型 描述 key 否 String 企业项目的key填:_sys_enterprise_project_id。 value 否 String 企业项目的id。可以从企业项目获取。 表9 tags 参数 是否必选 参数类型 描述 key 否 String 标签key value 否 String 标签value 表10 vertex_id_type 参数 是否必选 参数类型 描述 id_type 是 String id类型,目前支持固定长度fixedLengthString和hash。 fixedLengthString:固定长度String格式下,实际点ID直接用于内部存储与计算,用户需指定一长度,实际点ID不可超过此长度。长度过大,可能影响查询性能,建议用户根据数据集状态进行设置。 hash:哈希格式下,内部计算时将实际点ID转换成哈希码进行存储与计算,对实际点ID长度无限制,但是存在极低的概率(约10^(-43))出现点ID碰撞。若用户无法确定点ID的最大长度,建议选择哈希类型。 id_length 否 Integer 当id_type取值为fixedLengthString时必填,取值范围:1-128。
  • 点集最短路(shortest_path_of_vertex_sets) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources 是 起点ID集合 String 标准csv格式,ID之间以英文逗号分隔,例如:“Alice,Nana”。 个数不大于100000。 - targets 是 终点ID集合 String 标准csv格式,ID之间以英文逗号分隔,例如:“Alice,Nana”。 个数不大于100000。 - directed 否 是否考虑边的方向 Boolean 取值为true,不支持false。 true 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参数参考
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage": "can not find job to cancel, id is 9440a7ebXXXXXXXXXXXXXXXXXXXX2d079a67001679122", "errorCode": "GES.8303" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 删除图任务ID。请求失败时字段为空。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
  • URI DELETE /v2/{project_id}/graphs/{graph_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 keep_backup 否 Boolean 删除图后是否保留备份,默认保留1个自动备份和2个手动备份。该查询参数为空时,表示不保留。 delete_eip 否 Boolean 是否同时删除EIP。
  • 从控制台获取项目ID 在调用接口的时候,部分URI中需要填入项目编号,所以需要先在管理控制台上获取到项目编号。 项目编号获取步骤如下: 注册并登录管理控制台。 在页面右上角单击用户名,然后在下拉列表中单击“我的凭证”,进入“我的凭证”页面。 如果您登录的是华为云官网,而非管理控制台。在单击用户名后,选择下拉列表中的“账号中心”,然后单击“管理我的凭证”进入“我的凭证”页面。 在“API凭证”页面的项目列表中查看项目ID和名称(即“项目”)。 图1 查看项目ID 多项目时,展开“所属区域”,从“项目ID”列获取子项目ID。
  • 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。 接口的认证鉴权请参见管理面API构造请求。 响应示例如下,其中projects下的“id”即为项目ID。响应示例如下,例如图引擎服务部署的区域为"cn-north-4",相应消息体中查找“name”为"cn-north-4",其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 请求示例 导出图,图的导出OBS路径为demo_movie/,导出边文件名为set_edge.csv,导出点文件名为set_vertex.csv,导出元数据文件名为set_schema.xml。 POST http://Endpoint/v2/{project_id}/graphs{graph_id}/export-graph { "graph_export_path" : "demo_movie/", "edge_set_name" : "set_edge.csv", "vertex_set_name" : "set_vertex.csv", "schema_name" : "set_schema.xml" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 job_id String 执行该异步任务的jobId。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 graph_export_path 是 String 图的导出OBS路径。 edge_set_name 是 String 导出边的文件夹名称。 vertex_set_name 是 String 导出点的文件夹名称。 schema_name 是 String 导出元数据文件名。 paginate 否 paginate object 分页相关参数,内存版自2.3.11版本起导出图默认分页导出。 表4 paginate 参数 是否必选 参数类型 描述 enable 否 Boolean 是否开启分页,默认为true,不需要开启分页时,需显示声明为false。 说明: 持久化版暂不支持该参数。 row_count_per_file 否 Integer 按页导出时,每个文件最大行数,默认10000000。 num_thread 否 Integer 按页导出时,并行线程数,默认为8。
  • 功能介绍 导出图。 持久化版自2.3.14版本起支持导出图功能。 如果将导出的CSV文件下载到本地,默认会用系统的Excel软件打开(推荐使用文本编辑器打开)。如果数据中包含“+”、“-”、“=”、“@”等特殊字符,会被Excel解析为公式。为了保证系统安全,请打开文件时注意以下事项: 不要启用“启用动态数据交换服务器启动(不推荐)”配置。 打开CSV文件弹窗提醒安全问题时,不要选择“启用”或者“是”。