StopInstances - 批量停止实例_人工智能平台 PAI(PAI)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

paidsw:StopInstance

none

*全部资源

*

无

请求语法

PUT /api/v2/batch/instances/stop HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 body。
InstanceIds	array	是	需要停止的实例 ID 列表。
	string	否	需要停止的实例 ID。	['dsw-msq7tjk9kox7v26il3']

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	请求是否成功。	True
Message	string	返回信息。	"XXX"
Code	string	实例操作结果错误码。	PermissionError
HttpStatusCode	integer	HTTP 状态码	200
AccessDeniedDetail	object	访问被拒绝详细信息。
	string	访问被拒绝详细信息。	{}
InstanceIds	array	被停止的实例 ID 列表。
	string	被停止的实例 ID。	['dsw-fcbhy7b9nseilom7fw']

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "PermissionError",
  "HttpStatusCode": 200,
  "AccessDeniedDetail": {
    "key": "{}"
  },
  "InstanceIds": [
    "['dsw-fcbhy7b9nseilom7fw']"
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。