文档首页/ 图引擎服务 GES/ API参考/ 管理面API（V2）/ 图管理API/ 创建图(2.2.2)
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

创建图(2.2.2)

功能介绍

创建一个图。

URI

POST /v2/{project_id}/graphs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表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

表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"
    },
    "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

成功响应示例

{
  "id" : "f1529b88-c958-493e-8452-fccfe932cde1",
  "name" : "demo"
}

状态码： 400

失败响应示例

{
  "error_code" : "GES.7016",
  "error_msg" : "The parameter [subnetId] is not exist."
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题： 图管理API