关闭图(1.0.0) -StopGraph2
功能介绍
关闭一个图。如果图创建好了,暂时不用可以先关闭,需要使用时再启用。
- 持久化版图不支持调用接口进行关闭图操作。
- 处于关闭状态的图不计算实例费用。
- 您最多可以停止7天,如果您在7天后未手动启动图实例,则图实例将自动启动。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/graphs/{graph_id}/stop
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目编号。获取方法,请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及。 |
| graph_id | 是 | String | 参数解释: 图ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释: 关闭图任务ID。请求失败时为空。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
| error_code | String | 参数解释: 系统提示信息。
取值范围: 不涉及。 |
请求示例
关闭一个图。
POST https://{Endpoint}/v2/{project_id}/graphs/{graph_id}/stop
{ } 响应示例
状态码: 200
成功响应示例
{
"job_id" : "ff8080816025a0a1016025a5a2700007"
} 状态码: 400
失败响应示例
{
"error_code" : "GES.7001",
"error_msg" : "The graph is not running."
} 状态码
| 返回值 | 说明 |
|---|---|
| 400 Bad Request | 请求错误 |
| 401 Unauthorized | 鉴权失败 |
| 403 Forbidden | 没有操作权限 |
| 404 Not Found | 找不到资源 |
| 500 Internal Server Error | 服务内部错误 |
| 503 Service Unavailable | 服务不可用 |
错误码
请参见错误码。