调用KillInstanceAllSession接口,结束指定实例上的全部会话。

使用说明

  • 本接口只适用于Redis引擎。
  • 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。
  • 使用DAS的SDK的版本为1.0.2或以上。
  • 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。

请求参数

名称 类型 是否必选 示例值 描述
Action String KillInstanceAllSession

系统规定参数。取值:KillInstanceAllSession

ConsoleContext String None

备用参数。

InstanceId String r-8vbcyr4sw0c4yc****

实例ID。

返回数据

名称 类型 示例值 描述
Code String 200

返回的状态码。

Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Data String None

备用参数。

RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。

Success String true

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=KillInstanceAllSession
&InstanceId=r-8vbcyr4sw0c4yc****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<KillInstanceAllSessionResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Success>true</Success>
</KillInstanceAllSessionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "200",
  "Message" : "Successful",
  "RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success" : "true"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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