文档首页/ 图引擎服务 GES/ API参考/ 历史API/ 管理面API（V1）/ 图管理API/ 关闭图(1.0.0)
更新时间：2024-09-04 GMT+08:00
查看PDF
分享

关闭图(1.0.0)

功能介绍

关闭一个图。如果图创建好了，暂时不用可以先关闭，需要使用时再启用。

  • 处于关闭状态的图不计算实例费用。
  • 您最多可以停止7天，如果您在7天后未手动启动图实例，则图实例将自动启动。

调试

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

URI

POST /v1.0/{project_id}/graphs/{graph_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

graph_id

是

String

图ID。
表2 Query参数

参数

是否必选

参数类型

描述

action_id

是

String

图actionId。

枚举值：

  • stop

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

errorMessage

String

系统提示信息。

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

errorCode

String

系统提示信息。

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

jobId

String

关闭图任务ID。请求失败时为空。

说明：

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

请求示例

POST https://Endpoint//v1.0/{project_id}/graphs/{graph_id}/action?action_id=stop

响应示例

状态码： 200

OK

{
  "jobId" : "ff8080816025a0a1016025a5a2700007"
}

状态码： 400

Bad Request

{
  "errorCode" : "GES.7001",
  "errorMessage" : "The graph is not running."
}

状态码

状态码

说明

200

请求成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 图管理API

相关文档