文档

StopInstance - 终止实例

更新时间:

调用StopInstance终止实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Write
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdlong

实例的 ID。您可以调用 ListInstances 获取。

1234
ProjectEnvstring

工作空间的环境,包括 PROD 和 DEV。

PROD

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
Databoolean

调用停止实例接口后,返回的结果详情。

true
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

请求的 ID。用于定位日志,排查问题。

E6F0DBDD-5AD****
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)