更新时间:2025-12-18 GMT+08:00
分享

扩副本(2.2.23) -ExpandGraph2

功能介绍

扩副本能力允许动态变更多个从节点,变更的从节点可以处理读请求,从而提高读请求性能。

  • 一万边和百亿边规格的图暂不支持扩副本。
  • 进行扩副本操作后,不支持变更图规格操作。
  • 如果要对图进行变更规格和扩副本两个操作,需要您先进行变更图规格操作,再进行扩副本操作。
  • 持久化版图不支持调用接口进行扩副本操作。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/graphs/{graph_id}/expand

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目编号。获取方法,请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及。

graph_id

String

参数解释:

图ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

expand

expand object

参数解释

expand是一个对象。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 expand

参数

是否必选

参数类型

描述

replication

Integer

参数解释

新扩副本数量。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

扩副本任务ID。请求失败时字段为空。

取值范围

不涉及。

说明:

可以查询jobId查看任务执行状态、获取返回结果,详情参考任务中心API

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误码。

取值范围

不涉及。

error_msg

String

参数解释

系统提示信息。

  • 执行成功时,字段可能为空。
  • 执行失败时,用于显示错误信息。

取值范围

不涉及。

请求示例

进行扩副本操作,新扩副本数量为1。

POST https://{Endpoint}/v2/{project_id}/graphs/{graph_id}/expand

{
    "expand":{
    "replication": 1
  }
}

响应示例

状态码: 200

成功响应示例

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

状态码: 400

失败响应示例

{
  "error_code" : "GES.7015",
  "error_msg" : "The graph is not running or stopped."
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码

相关文档