云服务器内容精选

  • 响应参数 表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使用限制。
  • 请求示例 更新label,label的名称为book,label有一个待更新的属性。 POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema?label={labelName} { "type": "vertex", "properties": [ { "property": { "name": "Title", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Version", "cardinality": "single", "dataType": "string" } } ] } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 操作步骤 在“元数据管理”页面,复制元数据有两个入口: 单击对应元数据文件名称,进入元数据详情页,在页面底端单击“复制”。 在对应的元数据文件的“操作”列,单击“复制”。 定义元数据文件名称以及存储路径。 “名称”:复制后的元数据文件名称,仅需要设置名称,文件格式默认为xml。 “存储路径”:存储元数据文件的OBS路径。 “加密元数据”:默认关闭状态,是否对复制后的元数据进行加密。“密钥源”默认为“KMS”。“密钥名称”用于选择对应的密钥。 图1 复制元数据 单击“确定”,完成复制元数据。 元数据文件复制成功后,新的元数据文件将在“元数据管理”页面呈现。
  • 响应示例 状态码: 200 成功响应示例,有以下几种情况: 从未生成过。 Http Status Code: 200 { } 从未生成过,并正在生成。 Http Status Code: 200 { "progress":"10.05%", "generating": true } 生成过,并正在生成最新的。 Http Status Code: 200 { "last_generate_time": "2022-1-3 12:34:12", "data_assets": { "vertex": { "label1": 3, "label2": 14 }, "edge": { "label3":123, "label4":435 } }, "progress":"10.05%", "generating": true } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorCode": "GES.8818", "errorMessage": "graph [demo] is not found" }
  • 响应参数 表2 响应Body参数说明 参数 类型 说明 generating Boolean 是否正在生成数据资产。 progress String 正在生成数据资产时的生成进度。 last_generate_time String 上一次生成数据资产的时间。 data_assets Object 包含不同标签下点和边的个数。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 表3 data_assets参数说明 参数 类型 说明 vertex Object 包含不同标签下点的个数。 edge Object 包含不同标签下边的个数。
  • URI POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 label_name 是 String Label名称。
  • 请求示例 更新label,label的名称为book,label一共有三个待更新的属性。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/{label_name}/properties { "properties": [ { "property": { "name": "Title", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Version", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Category", "typeName1": "science", "typeName2": "literature", "typeNameCount": "2", "dataType": "enum" } } ] } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应参数 表2 响应要素说明 参数 类型 说明 data data Object 查询结果。请求失败时字段为空。 result String 响应结果。成功时result值为success,失败时值为failed。 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 表3 data 参数 类型 说明 properties Object 属性数组。 type String Label类型,表示此label用于点或边。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "data": { "type": "vertex", "properties": [ { "name": "Rating", "type": "int", "cardinality": "single" }, { "name": "Datetime", "type": "string", "cardinality": "single" } ] }, "result": "success" } 状态码: 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8204" }
  • 响应示例 状态码: 200 成功响应示例 { "schema": { "vertices": [ { "vertex": "user", "weight": 100 }, { "vertex": "movie", "weight": 46 } ], "edges": [ { "weight": 1209, "source": "user", "target": "movie", "relation": "rate" }, { "weight": 450, "source": "user", "target": "user", "relation": "default" } ] }} 状态码: 400 失败响应示例 Http Status Code: 400{ "errorMessage": "Bad Request, parameter [detail] cannot be null.", "errorCode": "GES.8813"}
  • URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure?detail={details} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 details 否 String 可为SIMPLE或FULL,SIMPLE模式表示只返回点或边的label,FULL模式表示除点或边的label外,还有点或边的数量。若该字段不填,则默认为SIMPLE。
  • 响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 schema Object schema结构查询结果。详情请参见schema参数说明。 表3 schema参数说明 参数 类型 说明 vertices String 点的结果集合。图为空时,vertices内容为空。详情请参见vertices参数说明。 edges String 边的结果集合。图为空时,edges内容为空。详情请参见edges参数说明。 表4 vertices参数说明 参数 类型 说明 vertex String label名。 weight String 具有该label的点的数量。 表5 edges参数说明 参数 类型 说明 source String 起始点label名。 target String 终点label名。 relation String 关系label名 weight String 具有该label的边的数量。