更新时间:2022-02-22 GMT+08:00
启动图
功能介绍
启动一个图。暂时不用的图可以先关闭,需要使用时再启动。
URI
POST /v1.0/{project_id}/graphs/{graph_id}/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目编号,用于资源隔离。请参考获取项目ID。 |
graph_id |
是 |
String |
图ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_id |
是 |
String |
图actionId 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
graph_backup_id |
否 |
String |
启动图时关联的备份ID,设置此参数时,表示从备份进行启动;如果为空,表示从上次关闭图时的状态启动。可参考新增备份进行备份。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
errorMessage |
String |
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 |
errorCode |
String |
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 |
jobId |
String |
启动图任务ID。请求失败时字段为空。
说明:
可以查询jobId查看任务执行状态、获取返回结果,详情参考任务中心API。 |
请求示例
https://Endpoint/v1.0/{project_id}/graphs/{graph_id}/action?action_id=start { "graph_backup_id" : "08a898ae-3ff8-40e8-a7ed-03afe05aedbb" }
响应示例
状态码: 200
OK
{ "jobId" : "ff8080816025a0a1016025a5a2700007" }
状态码: 400
Bad Request
{ "errorCode" : "GES.7015", "errorMessage" : "The graph is not running or stopped." }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
父主题: 图管理API