删除HTAP实例会话 - DeleteHtapProcessList
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
DELETE /v3/{project_id}/instances/{instance_id}/htap/process
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: HTAP标准版实例ID,严格匹配UUID规则。可通过调用查询HTAP实例列表接口获取。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认取值: application/json。 |
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| process_list | 是 | Array of strings | 参数解释: HTAP实例会话ID列表,可通过调用查询HTAP实例当前会话。 约束限制: 实例会话ID小于等于20个。 取值范围: 不涉及。 默认值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 响应返回结果。 取值范围: |
| msg | String | 参数解释: 响应错误信息。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
删除HTAP实例会话。
DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/htap/process
{
"process_list" : [ "id1", "id2" ]
} 响应示例
状态码:200
Success.
{
"status" : "success",
"msg" : "success"
} 状态码:400
Client error.
{
"error_code" : "DBS.200022",
"error_msg" : "实例不存在"
} 状态码
请参见状态码。
错误码
请参见错误码。