云服务器内容精选

  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"pagerank", "parameters":{ "alpha":0.85, "convergence":0.00001, "max_iterations":1000, "directed":true }, "output": { "format": "TXT", "mode": "FULL" } }
  • 响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,该字段为空。 说明: 可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API。
  • 请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 source 是 String 输入路径的起点ID。 directed 否 Boolean 是否考虑边的方向。取值为true或false。 说明: false当前版本在有权图上不支持。 当数据集不包含inedge时,若directed=true,选择一个不依赖于Inedge的算法实现版本计算输出,性能会下降;若directed=false,会报错。 weight 否 String 边上权重。取值为:空或字符串。 空:边上的权重、距离默认为1。 字符串:对应的边上的属性将作为权重,当某边没有对应属性时,权重将默认为1。
  • 响应参数 表4 响应Body参数 参数 类型 说明 errorMessage String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 errorCode String 系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 jobId String 执行算法任务ID。请求失败时,字段为空。 说明: 可以利用返回的jobId查看任务执行状态、获取算法返回结果,详情参考查询Job状态(1.0.0)。 jobType Integer 任务类型。请求失败时,字段为空。
  • 请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"sssp", "parameters":{ "source":"1", "directed":true, "weight": "" } } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应示例 状态码: 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" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 job_id String 执行该异步任务的jobId。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
  • 请求示例 增量导入图数据,边文件目录为testbucket/demo_movie/edges/,边数据集格式为csv,点文件目录为testbucket/demo_movie/vertices/,点数据集格式为csv。 POST http://Endpoint/v2/{project_id}/graphs/{graph_id}/import-graph { "edgeset_path" : "testbucket/demo_movie/edges/", "edgeset_format" : "csv", "vertexset_path" : "testbucket/demo_movie/vertices/", "vertexset_format" : "csv", "schema_path" : "testbucket/demo_movie/incremental_data_schema.xml", "log_dir" : "testbucket/importlogdir", "parallel_edge" : { "action" : "override", "ignore_label" : true }, "delimiter" : ",", "trim_quote" : "\"", "offline" : false }
  • 请求示例 POST https://Endpoint/v1.0/{project_id}/graphs { "graph":{ "name":"demo", "graphSizeTypeIndex": "1", "arch":"x86_64", "vpcId":"2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnetId":"dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "securityGroupId":"11d27338-8649-4076-8579-5ebc1a60f79e", "publicIp":{ "publicBindType":"bind_existing", "eipId":"30ef2d58-08a9-4481-b526-b2cbe67d020d" }, "enableMultiAz":false, "sys_tags": [{"key": "_sys_enterprise_project_id", "value": "54c0b33c-8627-462f-948e-bae08c0887b4"}], "encryption":{ "enable":true, "masterKeyId":"b00b9356-73fb-4d49-8f79-f0a5da5354d1" }, "enableRBAC":false, "enableFullTextIndex" : false, "cryptAlgorithm": "generalCipher", "enableHttps": "false" } }
  • 请求示例 创建一个图,图名称为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" }, "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 } }
  • 响应参数 状态码: 200 表11 响应Body参数 参数 参数类型 描述 id String 图ID。 name String 图名称。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。
  • 请求参数 表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 是否为动态图。 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 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。
  • 响应示例 状态码: 200 响应成功示例 { "graph" : { "id" : "1172f16c-63c7-4746-89b0-78972eddf706", "name" : "GES_UI_2_0_1", "created_by" : "ei_ges_j00356469_01", "is_multi_az" : "false", "region_code" : "cn-north-7", "az_code" : "cn-north-7c", "edgeset_format" : "", "edgeset_default_label" : "", "vertexset_format" : "", "vertexset_default_label" : "", "data_store_version" : "2.0.1", "sys_tags" : [ "0" ], "status" : "900", "graph_size_type_index" : "0", "vpc_id" : "0ac6e3c3-2c9b-4296-84f7-6883cebc7b41", "subnet_id" : "2b1755eb-d6d4-421f-88c0-cf6f0bc16801", "security_group_id" : "7aa7c8c9-7443-4a01-abf5-8064b586f8f5", "replication" : 0, "created" : "2022-04-26T02:10:52", "updated" : "2022-04-26T02:10:52", "private_ip" : "192.168.0.123", "encrypted" : false, "enable_rbac" : false, "enable_full_text_index" : false, "enable_hyg" : false, "traffic_ip_list" : [ "192.168.0.123" ], "crypt_algorithm" : "generalCipher", "enable_https" : false, "enable_multi_label":false, "origin_graph_size_type_index": "1", "expand_time": "2023-08-03T02:10:52", "resize_time": "2023-08-02T02:10:52" } } 状态码: 400 响应失败示例 { "error_code" : "GES.7006", "error_msg" : "An internal error occurs in the underlying service of the graph engine." }
  • 请求参数 表2 Body参数说明 参数 是否必选 类型 说明 graphName 是 String 图名称。输入长度在4位到32位之间,必须以字母开头,可以包含字母、数字或者下划线,不能包含其他的特殊字符。 idType 是 String id的类型, 可选值(hash,fixedLengthString,varString)。 idLength 否 Integer 当idType取值为fixedLengthString时必填,取值范围:1-128。 sortKeyType 是 String 必选,可选值如下: “int”:整数类型。 “string”:字符串类型,长度需要小于等于40。 “varString”:变长字符串,长度无限制。 全图sortKeyType类型统一。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [movie] already exists", "errorCode": "GES.8012", "result": "failed" }